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

WorldNearbyEntity

Defined in: client/api.d.ts:1722

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

class: string

Defined in: client/api.d.ts:1746

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


distance: number

Defined in: client/api.d.ts:1731

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


entityId: number

Defined in: client/api.d.ts:1756

This machine’s own handle for it. Local to this client and to this session – it is not the network ID and it is not portable, so store guid instead.


guid: string | null

Defined in: client/api.d.ts:1736

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: client/api.d.ts:1741

The name the level gives it, often empty.


physicalized: boolean

Defined in: client/api.d.ts:1751

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


position: Vector3

Defined in: client/api.d.ts:1726

Where it is, in world-space metres.