Blip

@vimp-mp/types 2.0.1

Interface · Server API

World blip handle returned by vimp.blips.create.

Mutating sprite, position, color, scale, name, alpha, global, shortRange, rotation or dimension updates the authoritative server state and is synchronized to clients streaming the blip. drawDistance is stored as server-side API state and does not affect streaming or rendering.

interface Blip extends StreamSyncedMeta

Members

alpha

alpha: number

Opacity, clamped by the runtime to 0–255.

color

color: number

GTA blip palette colour identifier.

dimension

dimension: number

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

drawDistance

drawDistance: number

Server-side stored draw distance value. Default: 0.

global

global: boolean

Whether the blip streams to every player in the same dimension. Default: false.

id

readonly id: number

Server-assigned blip identifier.

isExists

readonly isExists: boolean

Whether the blip is still registered with the server runtime.

name

name: string

Label shown for the blip in the map UI.

position

position: Vec3

Authoritative world position.

rotation

rotation: number

Blip heading in degrees.

scale

scale: number

Blip scale, clamped by the runtime to 0–255.

shortRange

shortRange: boolean

Whether the blip is hidden outside the local minimap range.

sprite

sprite: number

GTA blip sprite identifier.

deleteStreamSyncedMeta

deleteStreamSyncedMeta(key: string): void

Deletes key and propagates the removal to streaming clients.

destroy

destroy(): boolean

Destroy the blip and unregister it from vimp.blips.

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.