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

WorldNearbyEntity

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

One entity a sphere reported, and where it stood when it did.

class: string

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

The engine class it belongs to – AnimDoor, NPC_NAI, GeomEntity.


distance: number

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

How far it is from the centre of the sphere, in metres.


guid: string | null

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

The level’s own identity for it, as sixteen lowercase hex digits. Null for anything the session spawned, which the level does not name.


name: string

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

The name the level gives it, often empty.


physicalized: boolean

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

Whether the engine has built physics for it, which is what makes it something a trace could also find.


position: Vector3

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

Where it is, in world-space metres.