Marker

@vimp-mp/types 2.0.1

Interface · Server API

World marker handle returned by vimp.markers.create.

Mutating type, position, scale, color, rotation, visible or dimension updates the authoritative server state and is synchronized to clients streaming the marker.

interface Marker extends StreamSyncedMeta

Members

color

color: MarkerColor

RGBA marker colour.

dimension

dimension: number

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

id

readonly id: number

Server-assigned marker identifier.

isExists

readonly isExists: boolean

Whether the marker is still registered with the server runtime.

position

position: Vec3

Authoritative world position.

rotation

rotation: Vec3

Marker rotation in degrees.

scale

scale: number

Uniform marker scale passed to streaming clients.

type

type: number

GTA marker type identifier.

visible

visible: boolean

Whether streaming clients should draw the marker.

deleteStreamSyncedMeta

deleteStreamSyncedMeta(key: string): void

Deletes key and propagates the removal to streaming clients.

destroy

destroy(): boolean

Destroy the marker and unregister it from vimp.markers.

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.