CheckpointManager

@vimp-mp/types 2.0.1

Interface · Server API

Manages checkpoint instances in this scripting context.

interface CheckpointManager

Members

all

readonly all: Array<Checkpoint>

Snapshot of all currently alive checkpoints.

create

create(type: number, x: number, y: number, z: number, nextX: number, nextY: number, nextZ: number, radius: number, r: number, g: number, b: number, a: number, extras?: CheckpointExtras): Checkpoint | null

Create a checkpoint. next* coordinates point the arrow to the next checkpoint (same values as the main point for a terminal checkpoint). r, g, b, a are 0-255. Returns null if the server is full.

destroy

destroy(id: number): boolean

Destroys the checkpoint with id.

getById

getById(id: number): Checkpoint | null

Returns the checkpoint with id, or null when it does not exist.