Checkpoint

@vimp-mp/types 2.0.1

Interface · Server API

World checkpoint handle returned by vimp.checkpoints.create.

Mutating type, position, nextPosition, radius, color, visible or dimension updates the authoritative server state and is synchronized to clients streaming the checkpoint.

interface Checkpoint extends StreamSyncedMeta

Members

color

color: MarkerColor

RGBA checkpoint colour.

dimension

dimension: number

Virtual world; the checkpoint is visible only to players in the same dimension.

id

readonly id: number

Server-assigned checkpoint identifier.

isExists

readonly isExists: boolean

Whether the checkpoint is still registered with the server runtime.

nextPosition

nextPosition: Vec3

World position toward which the checkpoint arrow points.

position

position: Vec3

Authoritative world position.

radius

radius: number

Checkpoint radius in world units.

type

type: number

GTA checkpoint type identifier.

visible

visible: boolean

Whether streaming clients should draw the checkpoint.

deleteStreamSyncedMeta

deleteStreamSyncedMeta(key: string): void

Deletes key and propagates the removal to streaming clients.

destroy

destroy(): boolean

Destroys this checkpoint 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.

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.