Colshape

@vimp-mp/types 2.0.1

Interface · Client API

Server-known colshape trigger volume. Colshapes do not expose a GTA entity handle.

interface Colshape

Members

a

readonly a: number

First raw geometry parameter supplied by the runtime.

b

readonly b: number

Second raw geometry parameter supplied by the runtime.

c

readonly c: number

Third raw geometry parameter supplied by the runtime.

d

readonly d: number

Fourth raw geometry parameter supplied by the runtime.

dimension

readonly dimension: number

Virtual world associated with the colshape.

handle

readonly handle: 0

Always 0; colshapes are pure multiplayer/runtime state, not GTA entities.

height

readonly height: number

Height for cylinder shapes.

id

readonly id: number

Client-local 0-based wrapper id, unique per entity type and reused after destroy. Use remoteId for server/network state.

isAlive

readonly isAlive: boolean

True while the remote colshape exists in multiplayer state.

isExists

readonly isExists: boolean

Alias of isAlive for colshape lifecycle checks.

isRemote

readonly isRemote: boolean

Whether this wrapper represents a server-owned colshape.

isStreamed

readonly isStreamed: boolean

Whether a remote colshape is currently inside the streaming range.

key

readonly key: string | undefined

Application key supplied at creation and retained outside the streaming radius.

kind

readonly kind: number

Numeric runtime discriminant for the colshape geometry.

position

readonly position: Vec3

Centre of the trigger volume in world coordinates.

radius

readonly radius: number

Radius for sphere, circle and cylinder shapes.

remoteId

readonly remoteId: number | null

Server colshape id for remote colshapes; null for local-only colshapes. Zero is a valid remote id.

size

readonly size: Vec3

Full size vector for cuboid shapes.

type

readonly type: ColshapeType

Stable string name for the colshape geometry.

destroy

destroy(): boolean

Destroys local-only colshapes. Returns false for remote colshapes or already-destroyed wrappers.