Blip

@vimp-mp/types 2.0.1

Interface · Client API

Server-known blip. It may be known before/after streaming into a local map blip handle.

interface Blip

Members

alpha

readonly alpha: number

Cached opacity in the 0–255 range.

color

readonly color: number

GTA blip palette colour identifier.

dimension

readonly dimension: number

Client-side dimension value associated with this wrapper.

drawDistance

readonly drawDistance: number

Server or wrapper draw-distance metadata.

global

readonly global: boolean

Whether a remote blip streams globally within its dimension.

handle

readonly handle: number

Native map blip handle, or 0 while known but not streamed.

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

isExists

readonly isExists: boolean

Alias of isAlive for blip lifecycle checks.

isRemote

readonly isRemote: boolean

Whether this wrapper represents a server-owned blip.

isStreamed

readonly isStreamed: boolean

Whether the blip currently has a native map handle.

name

readonly name: string

Label shown for the blip in the map UI.

position

readonly position: Vec3

Cached world position.

remoteId

readonly remoteId: number | null

Server blip id for remote blips; null for local-only blips. Zero is a valid remote id.

rotation

readonly rotation: number

Cached blip heading in degrees.

scale

readonly scale: number

Cached blip scale.

shortRange

readonly shortRange: boolean

Whether the blip is hidden outside the local minimap range.

sprite

readonly sprite: number

GTA blip sprite identifier.

destroy

destroy(): boolean

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