fivem.client.core.Blip

A map or radar marker.

var shop = Blip.atCoords(shopPosition, 52, 2);
shop.label = "Hardware Store";
shop.shortRange = true;

Blips are client-side and are not cleaned up when your resource stops — restarting a resource that creates blips without removing them leaves duplicates on the map. Remove them in a stop handler:

Resource.onStop(() -> shop.remove());

Static methods

`@:value({ colour : 0, sprite : 1 })staticatCoords(position:Vector3, sprite:Int = 1, colour:Int = 0, ?label:String):Blip`

Creates a blip at a fixed position.

Parameters:

`sprite`	The icon index — 1 is the default circle, 52 a shop, 161 a garage. The FiveM docs list them all.
`colour`	The palette index, not an RGB value — 1 red, 2 green, 3 blue, 5 yellow.

`@:value({ colour : 0, sprite : 1 })staticforEntity(entity:Entity, sprite:Int = 1, colour:Int = 0, ?label:String):Blip`

Creates a blip that follows an entity. It disappears on its own when the entity does.

`@:value({ alpha : 128, colour : 0 })staticforRadius(position:Vector3, radius:Float, colour:Int = 0, alpha:Int = 128):Blip`

Creates a shaded circle on the map — a zone or search area.

Constructor

`new(handle:Int)`

Variables

`write onlyalpha:Int`

`write onlycolour:Int`

Palette colour index, not RGB.

`coords:Vector3`

`write onlydisplay:BlipDisplay`

`read onlyexists:Bool`

`write onlyflashing:Bool`

`finalhandle:Int`

The raw blip handle.

`write onlylabel:String`

The name shown in the pause-menu map legend.

Setting one runs a small text-command sequence rather than a single native, which is why it's a property here instead of a constructor argument you might forget.

`write onlyscale:Float`

`write onlyshortRange:Bool`

Whether the blip only appears once the player is nearby.

`write onlysprite:Int`

Methods

`remove():Void`

Removes the blip from the map.

`@:value({ colour : 5 })setRoute(enabled:Bool, colour:Int = 5):Void`

Sets or clears a GPS route to this blip.

class Blip

package fivem.client.core