Module cl_blips

Blip System

Functions

GetBlips () GetBlips function.
CreateBlip (identifier, name, coords, blipsprite, blipscolour, displayid, scale, shortrange, heading, flash, radius, radiusColour) CreateBlip function.
DeleteBlip (identifier) DeleteBlip function.
UpdateBlip (identifier, coords, heading) UpdateBlip function.
SetWaypoint (coords) SetWaypoint function.


Functions

GetBlips ()
GetBlips function. This function returns the 'mapblips' table which contains all the blips on the map. Each blip in the 'mapblips' table is a table itself containing the blip's properties such as its coordinates, color, icon, etc. This will return the 'mapblips' table containing all the blips on the map.

Returns:

    table

Usage:

    local blips = exports.jones_util:GetBlips()
CreateBlip (identifier, name, coords, blipsprite, blipscolour, displayid, scale, shortrange, heading, flash, radius, radiusColour)
CreateBlip function. This function creates a blip on the map.

Parameters:

  • identifier The blip identifier. string
  • name The blip name. string
  • coords The blip coordinates. vector3
  • blipsprite The blip sprite. number
  • blipscolour The blip color. number
  • displayid The blip display id. number
  • scale The blip scale. number
  • shortrange The blip short range. boolean
  • heading The blip heading. boolean
  • flash The blip flash. boolean
  • radius The blip radius. number
  • radiusColour The blip radius color. number

Usage:

    exports.jones_util:CreateBlip("blip", "Blip", vector3(0.0, 0.0, 0.0), 1, 1, 0, 1.0, false, false, false, 10, 1)
DeleteBlip (identifier)
DeleteBlip function. This function deletes a blip on the map.

Parameters:

  • identifier The blip identifier. string

Usage:

    exports.jones_util:DeleteBlip("blip")
UpdateBlip (identifier, coords, heading)
UpdateBlip function. This function updates a blip on the map.

Parameters:

  • identifier The blip identifier. string
  • coords The blip coordinates. vector3
  • heading The blip heading. number

Usage:

    exports.jones_util:UpdateBlip("blip", vector3(0.0, 0.0, 0.0), 0.0)
SetWaypoint (coords)
SetWaypoint function. This function sets a waypoint on the map.

Parameters:

  • coords The waypoint coordinates. vector3

Usage:

    exports.jones_util:SetWaypoint(vector3(0.0, 0.0, 0.0))
generated by LDoc 1.5.0 Last updated 2024-05-13 19:05:24