Documentation
Blips

Blips

All Lua functions and events in the Blips category, on the server and the client.

Server functions 4

addMapBlipNameGives a blip icon a name. The name shows in the map legend (ESC) and in the tooltip when hovering over the icon.
addMapZoneNamePlaces your own place name on the map (ESC), like the district names in the game.
removeMapBlipNameRemoves an icon's name from the map legend.
removeMapZoneNameRemoves a place label added with addMapZoneName.

Client functions 1

getPlayerWaypointRouteReturns the game's GPS route to the waypoint, the line shown on the radar, as a list of points and a length in metres. The game computes a road route only while the player is in a vehicle.

Shared functions 28

arePlayerBlipsVisibleChecks whether player icons on the map are turned on.
createBlipCreates a blip, an icon on the radar and map, at the given point.
createBlipAttachedToCreates a blip attached to an element. The blip moves with it, for example with a vehicle or player.
getBlipColorReturns the blip's colour.
getBlipIconReturns the blip's icon number.
getBlipNameNewReturns the blip name set by setBlipName, or false when the blip has no name of its own.
getBlipOrderingReturns the blip's draw order. Blips with a higher value are drawn on top.
getBlipSizeReturns the blip's size.
getBlipVisibleDistanceReturns the range from which the blip shows on the radar.
getMapBlipNameReturns an icon's name from the map legend.
getMapBlipNamesReturns the whole map legend: every icon name set by scripts.
getMapZoneNamesReturns every place label scripts have added to the map.
getPlayerBlipColorReturns the colour of a player's map icon.
getPlayerBlipSizeReturns the size of a player's map icon (0-25).
getPlayerWaypointReturns the player's GPS waypoint, the target they marked on the map or a script set. On the server it is the last point confirmed by the player's game.
isPlayerBlipVisibleChecks whether a player's map icon is visible.
removePlayerWaypointRemoves the player's GPS waypoint.
setBlipColorChanges the blip's colour. The colour shows on the plain square (icon 0).
setBlipIconChanges the blip's icon.
setBlipNameNewSets the name of a single blip, shown in the tooltip when you hover it on the ESC map. An empty name (or nil) goes back to the icon name from addMapBlipName. At most 64 bytes.
setBlipOrderingSets the blip's draw order. A blip with a higher value covers the others.
setBlipSizeChanges the blip size (the square, icon 0).
setBlipVisibleDistanceSets how far away the blip shows on the radar.
setPlayerBlipColorChanges the colour of a player's map icon (red by default). On the server everyone sees it, on the client the change is local to that player.
setPlayerBlipSizeChanges the size of a player's map icon. 0 hides it.
setPlayerBlipsVisibleTurns the icons of all players on the map on or off. They are on by default.
setPlayerBlipVisibleShows or hides one player's map icon.
setPlayerWaypointSets the game's GPS waypoint for a player: a target on the radar and map, and a road route while in a vehicle. The game confirms it with onPlayerWaypointSet.