ColshapeManager

@vimp-mp/types 2.0.1

Interface · Client API

Creates client-local colshapes and tracks server-owned trigger volumes.

interface ColshapeManager

Members

readonly all: Array<Colshape>

All known non-destroyed colshapes.

readonly count: number

Number of known non-destroyed colshapes.

createCircle(position: Vec3 | Vec2, radius: number, options?: ColshapeCreateOptions): Colshape

Creates a client-local two-dimensional circular trigger volume.

createCuboid(position: Vec3, size: Vec3, options?: ColshapeCreateOptions): Colshape

Creates a client-local axis-aligned cuboid trigger volume.

createCylinder(position: Vec3, radius: number, height: number, options?: ColshapeCreateOptions): Colshape

Creates a client-local vertical cylindrical trigger volume.

createSphere(position: Vec3, radius: number, options?: ColshapeCreateOptions): Colshape

Creates a client-local spherical trigger volume.

destroy(id: number): boolean

Destroys the client-local colshape identified by its wrapper id.

getById(id: number): Colshape | null

Returns a known colshape by client-local wrapper id.

getByRemoteId(remoteId: number): Colshape | null

Returns a remote colshape by server/network id.