Skip to content
KCKingdoms Connected Scripting APIScripting guides and API
Data shapeServer APIGenerated

NearestDoor

Defined in: server/api.d.ts:5509

distance: number | undefined

Defined in: server/api.d.ts:5538

How far the player is from it, in metres. Present only when one was found.


door: Door | null

Defined in: server/api.d.ts:5523

The door handle. Null whenever found is false.


found: boolean

Defined in: server/api.d.ts:5513

Whether the client had a door in sight and it belongs to this level.


guid: string | undefined

Defined in: server/api.d.ts:5528

The door’s level EntityGuid as hex, present only when one was found.


locked: boolean | undefined

Defined in: server/api.d.ts:5548

Whether it is locked, as the client at it sees right now. Present only when one was found.


name: string | undefined

Defined in: server/api.d.ts:5533

The name the level gives the door, often empty. Present only when one was found.


open: boolean | undefined

Defined in: server/api.d.ts:5543

Whether it is standing open, as the client at it sees right now. Present only when one was found.


reason: string

Defined in: server/api.d.ts:5518

Why there is no door: nothing in sight, another level, no answer, or a caller who left. Empty when one was found.