Client
Manages blips on the map, allowing creation, modification, and removal of blips.
core.blips.new
Creates a new blip on the map.
core.blips.new(data)- data:
CreateBlipData- id:
string - type:
BlipType("COORDS" | "ENTITY" | "AREA" | "RADIUS") - coords?:
vector3 - entity?:
number - radius?:
number - area?:
{width:number, height:number} - colour?:
number - sprite?:
number - scale?:
number - shortRange?:
boolean - rotation?:
number - alpha?:
number - display?:
number - flash?:
boolean - category?:
string - disabled?:
boolean - headingIndicator?:
boolean - group?:
1 | 2 | 7 | 10 | 11
- id:
core.blips.get
Gets a blip by its ID.
core.blips.get(id)- id:
string - Returns:
Blip | nil
core.blips.getAll
Gets all active blips.
core.blips.getAll()- Returns:
Blip[]
core.blips.getByCategory
Gets all blips within a specific category.
core.blips.getByCategory(category)- category:
string - Returns:
Blip[]
core.blips.remove
Removes a blip by its ID.
core.blips.remove(id)- id:
string - Returns:
boolean(success)
core.blips.update
Updates an existing blip with new data.
core.blips.update(id, data)- id:
string - data:
BlipData - Returns:
boolean(success)
core.blips.disable
Disables a blip, making it invisible on the map.
core.blips.disable(id)- id:
string
core.blips.enable
Enables a previously disabled blip.
core.blips.enable(id)- id:
string
core.blips.toggle
Toggles a blip between enabled and disabled states.
core.blips.toggle(id)- id:
string
core.blips.disableCategory
Disables all blips in a specific category.
core.blips.disableCategory(category)- category:
string
core.blips.enableCategory
Enables all blips in a specific category.
core.blips.enableCategory(category)- category:
string
core.blips.toggleCategory
Toggles all blips in a category between enabled and disabled states.
core.blips.toggleCategory(category)- category:
string
core.blips.isActive
Checks if a blip is currently active (enabled and visible on the map).
core.blips.isActive(id)- id:
string - Returns:
boolean