Blip

Defined in: server/api.d.ts:1138

Replicated map icon that can be positioned in the world or attached to an entity.

Extends

• Entity

Constructors

Constructor

new Blip(id): Blip

Defined in: server/api.d.ts:1143

Creates a script wrapper for an existing blip with this ID; use Blip.create() to create a blip.

Parameters

id

number

Network entity identifier.

Returns

Blip

Inherited from

Entity.constructor

Methods

attachToPlayer()

attachToPlayer(player): void

Defined in: server/api.d.ts:1215

Attaches this blip to a player so its position follows that entity.

Parameters

player

number | Player

Player handle or network entity ID to follow.

Returns

void

---

attachToVehicle()

attachToVehicle(vehicle): void

Defined in: server/api.d.ts:1221

Attaches this blip to a vehicle so its position follows that entity.

Parameters

vehicle

number | Vehicle

Vehicle handle or network entity ID to follow.

Returns

void

---

destroy()

destroy(): void

Defined in: server/api.d.ts:1184

Destroys this replicated blip and removes it from connected clients.

Returns

void

---

setDisplay()

setDisplay(display): void

Defined in: server/api.d.ts:1209

Chooses whether the blip appears on the minimap, the fullscreen map, or both.

Parameters

display

"map" | "both" | "minimap"

Map views that draw the blip.

Returns

void

---

setIcon()

setIcon(library, iconId): void

Defined in: server/api.d.ts:1191

Changes the icon displayed by this blip.

Parameters

library

number

Icon-library identifier.

iconId

number

Icon identifier within the selected library.

Returns

void

---

setRange()

setRange(meters): void

Defined in: server/api.d.ts:1203

Limits the blip to players near it. Evaluated on each client, so players moving around costs no server traffic.

Parameters

meters

number

Horizontal distance from each player within which the blip is shown; 0 shows it on the whole map. Capped at 10000.

Returns

void

---

setText()

setText(text): void

Defined in: server/api.d.ts:1197

Sets the tooltip text displayed when a player hovers this blip on the fullscreen map.

Parameters

text

string

Tooltip shown while the cursor hovers this blip on the fullscreen map; empty removes it. Truncated to 48 characters.

Returns

void

---

setVirtualWorld()

setVirtualWorld(world): void

Defined in: server/api.d.ts:4154

Moves this entity into another virtual world.

Parameters

world

number

Virtual-world identifier used to partition replication and visibility.

Returns

void

Inherited from

Entity.setVirtualWorld

---

setVisibleTo()

setVisibleTo(player): void

Defined in: server/api.d.ts:4160

Restricts replication of this entity to one owning connection while preserving normal range and visibility checks.

Parameters

player

Entity | null

Player-owned entity whose connection should exclusively receive this entity, or null to clear the restriction.

Returns

void

Inherited from

Entity.setVisibleTo

---

toString()

toString(): string

Defined in: server/api.d.ts:1179

Returns a readable representation of this blip.

Returns

string

The blip ID formatted for logging or debugging.

Inherited from

Entity.toString

---

create()

static create(x, y, z, library, iconId, color?, virtualWorld?, text?, range?): Blip

Defined in: server/api.d.ts:1236

Creates and replicates a world-map blip.

Parameters

x

number

Initial world-space X coordinate.

y

number

Initial world-space Y coordinate.

z

number

Initial world-space Z coordinate.

library

number

Icon-library identifier.

iconId

number

Icon identifier within the selected library.

color?

number

Optional game palette color identifier.

virtualWorld?

number

Optional virtual-world ID used for visibility filtering.

text?

string

Optional tooltip shown while the cursor hovers the blip on the fullscreen map. Truncated to 48 characters.

range?

number

Optional visibility range in meters from each player; 0 or omitted shows it on the whole map.

Returns

Blip

The newly created blip handle.

Properties

color

readonly color: number

Defined in: server/api.d.ts:1158

Current game palette color identifier.

---

display

readonly display: "map" | "both" | "minimap"

Defined in: server/api.d.ts:1173

Map views that draw the blip.

---

iconId

readonly iconId: number

Defined in: server/api.d.ts:1153

Current icon identifier within iconLibrary.

---

iconLibrary

readonly iconLibrary: number

Defined in: server/api.d.ts:1148

Current icon-library identifier.

---

id

readonly id: number

Defined in: server/api.d.ts:4122

Immutable network entity identifier.

Inherited from

Entity.id

---

position

position: Vector3

Defined in: server/api.d.ts:4132

Authoritative world-space position; assignment forces replicated state.

Inherited from

Entity.position

---

range

readonly range: number

Defined in: server/api.d.ts:1168

Visibility range in meters; 0 when the blip shows on the whole map.

---

rotation

rotation: Vector3 | Quaternion

Defined in: server/api.d.ts:4137

Authoritative rotation; reads return a quaternion and assignments accept a quaternion or Euler angles in degrees.

Inherited from

Entity.rotation

---

state

readonly state: StateBag

Defined in: server/api.d.ts:4142

Arbitrary key/value state carried by this entity. The server writes it and every client that can see the entity receives it; see StateBag.

Inherited from

Entity.state

---

text

readonly text: string

Defined in: server/api.d.ts:1163

Current fullscreen-map hover tooltip; empty when the blip has none.

---

virtualWorld

readonly virtualWorld: number

Defined in: server/api.d.ts:4127

Current virtual-world identifier.

Inherited from

Entity.virtualWorld