Blip

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

Replicated compass and map-screen blip handle.

Extends

• Entity

Constructors

Constructor

new Blip(id): Blip

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

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

Parameters

id

number

Network entity identifier.

Returns

Blip

Inherited from

Entity.constructor

Methods

remove()

remove(): void

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

Takes this blip off every compass and map screen that shows it.

Returns

void

---

setVirtualWorld()

setVirtualWorld(world): void

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

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:8803

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:4234

Formats this blip handle for logging and debugging.

Returns

string

The blip ID, its type and its label.

Inherited from

Entity.toString

---

all()

static all(virtualWorld?): Blip[]

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

Lists every blip the server currently has.

Parameters

virtualWorld?

number

Optional virtual world to list; omitted lists every one of them.

Returns

Blip[]

One handle per live blip, in no particular order.

---

create()

static create(options): Blip

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

Puts a blip on the compass and map screen of every player in its virtual world, or of the one player it is private to. It is a replicated entity that is never culled by distance – a blip is for finding something far away – so it reaches players however far they are and whenever they join, and assigning position moves it for all of them. setVisibleTo works on it like on any entity.

Parameters

options

Where the blip goes, which icon it draws with – one of Blip.types(), GeneralPoi by default – its mark state, its name on the map screen, and whether it shows on the compass and the map screen, both by default. player makes it private to that player from the start; virtualWorld puts a public one in that world, the global one by default.

compass?

boolean

label?

string

map?

boolean

markState?

number

player?

Player

position

Vector3

type?

string

virtualWorld?

number

Returns

Blip

The new blip handle.

---

getById()

static getById(id): Blip | null

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

Looks a blip up by its network entity ID.

Parameters

id

number

Network entity identifier.

Returns

Blip | null

The blip’s handle, or null when no live blip has that ID.

---

removeAll()

static removeAll(virtualWorld?): number

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

Removes blips.

Parameters

virtualWorld?

number

Optional virtual world to clear; omitted clears every one of them.

Returns

number

How many blips were removed.

---

types()

static types(): string[]

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

Every icon a blip can draw with, by the game’s own name for it, misspellings included.

Returns

string[]

The names, in the game’s own order.

Properties

compass

compass: boolean

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

Whether the blip is drawn on players’ HUD compasses.

---

id

readonly id: number

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

Immutable network entity identifier.

Inherited from

Entity.id

---

label

label: string

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

The blip’s name on the map screen, shown verbatim in place of the name the game gives its icon type; empty keeps that name. Cut to 64 bytes. The compass has no text, so it never shows this.

---

map

map: boolean

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

Whether the blip is drawn on players’ map screens, for an icon the map has art for: Main, Side, Micro, Checkpoint, Dlcs, Bailiff, FistFight and Racing have none and stay on the compass. The map legend’s switch for the blip’s icon type hides it like one of the game’s own.

---

markState

markState: number

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

The mark’s state, forwarded to the compass and map movies as-is – what the client Blip calls state, renamed here because every entity’s state is its StateBag. What a given value draws is undocumented; 0 is what a fresh game mark carries.

---

position

position: Vector3

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

Authoritative world-space position; assignment forces replicated state.

Inherited from

Entity.position

---

rotation

rotation: Vector3 | Quaternion

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

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:8785

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

---

type

type: string

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

Which of the game’s own compass icons the blip draws as, by the game’s own name for it – Blip.types() lists them. Assigning a name the game does not know leaves the blip as it was.

---

virtualWorld

readonly virtualWorld: number

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

Current virtual-world identifier.

Inherited from

Entity.virtualWorld