Colshape

@vimp-mp/types 2.0.1

Interface · Server API

Server-side trigger volume returned by vimp.colshapes.create*.

Detection (player enter/exit) is performed authoritatively by the server on each player position update; scripts only observe the results via playerEnterColshape / playerExitColshape events.

playersInside is a live JS-side cache updated by those same events; reading it never round-trips to the server.

interface Colshape extends StreamSyncedMeta

Members

dimension

dimension: number

Virtual world. Detection (playerEnterColshape/playerExitColshape) runs only for players in the same dimension. A player in another dimension does not generate an event even while physically inside.

id

readonly id: number

Server-assigned colshape identifier.

isExists

readonly isExists: boolean

Whether the colshape is still registered with the server runtime.

key

readonly key: string | undefined

Application key supplied at creation.

playersInside

readonly playersInside: readonly Array<Player>

Players currently inside this volume (server-authoritative).

position

position: Vec3

Trigger volume centre. Writing it moves the colshape server-side and re-streams the new geometry to every client.

type

readonly type: ColshapeType

Geometric shape selected by the creation method.

deleteStreamSyncedMeta

deleteStreamSyncedMeta(key: string): void

Deletes key and propagates the removal to streaming clients.

destroy

destroy(): boolean

Destroys this colshape instance.

getStreamSyncedMeta

getStreamSyncedMeta<T = unknown>(key: string): T | undefined

Returns undefined if the key is unset.

getStreamSyncedMetaKeys

getStreamSyncedMetaKeys(): Array<string>

Returns all stream-synced metadata keys stored on the entity.

hasStreamSyncedMeta

hasStreamSyncedMeta(key: string): boolean

Returns whether the entity has a value for key.

isPointInside

isPointInside(x: number, y: number, z: number): boolean

Local geometric check using the cached shape parameters. Useful for ad-hoc queries; the server runs the same check on every UDP position packet.

setStreamSyncedMeta

setStreamSyncedMeta(key: string, value: unknown): void

Set or replace one key. The value is forwarded to every player currently streaming this entity, plus included in the snapshot for any future stream-in. Use deleteStreamSyncedMeta rather than undefined when the key must be removed.