Marker

@vimp-mp/types 2.0.1

Interface · Client API

Server-known marker. Markers are drawn by VIMP and do not expose a GTA entity handle.

interface Marker

Members

color

readonly color: { a: number; b: number; g: number; r: number }

Cached RGBA marker colour.

dimension

readonly dimension: number

Client-side dimension value associated with this wrapper.

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 marker exists in multiplayer state.

isExists

readonly isExists: boolean

Alias of isAlive for marker lifecycle checks.

isRemote

readonly isRemote: boolean

Whether this wrapper represents a server-owned marker.

isStreamed

readonly isStreamed: boolean

True while a local marker exists, or while a remote marker is streamed in.

markerType

readonly markerType: number

GTA marker type identifier.

position

readonly position: Vec3

Cached world position.

remoteId

readonly remoteId: number | null

Server marker id for remote markers; null for local-only markers. Zero is a valid remote id.

rotation

readonly rotation: Vec3

Cached marker rotation in degrees.

scale

readonly scale: number

Uniform marker scale.

type

readonly type: number

Alias of markerType.

visible

readonly visible: boolean

Whether the marker is currently configured to draw.

destroy

destroy(): boolean

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

setColor

setColor(color: { a: number; b: number; g: number; r: number }): boolean

Sets color of local-only markers. Returns false for remote markers or destroyed wrappers.

setDimension

setDimension(dimension: number): boolean

Sets the local-only virtual dimension (metadata-only, like MarkerCreateOptions.dimension). Returns false for remote markers or destroyed wrappers.

setPosition

setPosition(position: Vec3): boolean

Moves local-only markers. Returns false for remote markers or destroyed wrappers.

setRotation

setRotation(rotation: Vec3): boolean

Rotates local-only markers (degrees, normalized to [0, 360)). Returns false for remote markers or destroyed wrappers.

setScale

setScale(scale: number): boolean

Sets uniform scale of local-only markers. Returns false for remote markers or destroyed wrappers.

setVisible

setVisible(visible: boolean): boolean

Shows/hides local-only markers. Returns false for remote markers or destroyed wrappers.