Blip
Defined in: server/api.d.ts:863
Replicated map icon that can be positioned in the world or attached to an entity.
Extends
Section titled “Extends”Entity
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Blip(
id):Blip
Defined in: server/api.d.ts:868
Creates a script wrapper for an existing blip with this ID; use Blip.create() to create a blip.
Parameters
Section titled “Parameters”number
Network entity identifier.
Returns
Section titled “Returns”Blip
Methods
Section titled “Methods”attachToPlayer()
Section titled “attachToPlayer()”attachToPlayer(
player):void
Defined in: server/api.d.ts:907
Attaches this blip to a player so its position follows that entity.
Parameters
Section titled “Parameters”player
Section titled “player”number | Player
Player handle or network entity ID to follow.
Returns
Section titled “Returns”void
attachToVehicle()
Section titled “attachToVehicle()”attachToVehicle(
vehicle):void
Defined in: server/api.d.ts:913
Attaches this blip to a vehicle so its position follows that entity.
Parameters
Section titled “Parameters”vehicle
Section titled “vehicle”number | Vehicle
Vehicle handle or network entity ID to follow.
Returns
Section titled “Returns”void
destroy()
Section titled “destroy()”destroy():
void
Defined in: server/api.d.ts:894
Destroys this replicated blip and removes it from connected clients.
Returns
Section titled “Returns”void
setIcon()
Section titled “setIcon()”setIcon(
library,iconId):void
Defined in: server/api.d.ts:901
Changes the icon displayed by this blip.
Parameters
Section titled “Parameters”library
Section titled “library”number
Icon-library identifier.
iconId
Section titled “iconId”number
Icon identifier within the selected library.
Returns
Section titled “Returns”void
setVirtualWorld()
Section titled “setVirtualWorld()”setVirtualWorld(
world):void
Defined in: shared.d.ts:83
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
setVisibleTo()
Section titled “setVisibleTo()”setVisibleTo(
player):void
Defined in: shared.d.ts:84
Parameters
Section titled “Parameters”player
Section titled “player”Entity | null
Returns
Section titled “Returns”void
toString()
Section titled “toString()”toString():
string
Defined in: server/api.d.ts:889
Returns a readable representation of this blip.
Returns
Section titled “Returns”string
The blip ID formatted for logging or debugging.
create()
Section titled “create()”
staticcreate(x,y,z,library,iconId,color?,virtualWorld?):Blip
Defined in: server/api.d.ts:926
Creates and replicates a world-map blip.
Parameters
Section titled “Parameters”number
Initial world-space X coordinate.
number
Initial world-space Y coordinate.
number
Initial world-space Z coordinate.
library
Section titled “library”number
Icon-library identifier.
iconId
Section titled “iconId”number
Icon identifier within the selected library.
color?
Section titled “color?”number
Optional game palette color identifier.
virtualWorld?
Section titled “virtualWorld?”number
Optional virtual-world ID used for visibility filtering.
Returns
Section titled “Returns”Blip
The newly created blip handle.
Properties
Section titled “Properties”
readonlycolor:number
Defined in: server/api.d.ts:883
Current game palette color identifier.
iconId
Section titled “iconId”
readonlyiconId:number
Defined in: server/api.d.ts:878
Current icon identifier within iconLibrary.
iconLibrary
Section titled “iconLibrary”
readonlyiconLibrary:number
Defined in: server/api.d.ts:873
Current icon-library identifier.
readonlyid:number
Defined in: shared.d.ts:79
position
Section titled “position”position:
Vector3
Defined in: shared.d.ts:81
rotation
Section titled “rotation”rotation:
Vector3|Quaternion
Defined in: shared.d.ts:82
virtualWorld
Section titled “virtualWorld”
readonlyvirtualWorld:number
Defined in: shared.d.ts:80