Exports

All exports are client only.

createBlip

---

Creates a new blip

exports['elysium_blips']:createBlip(parameters)

• parameters: table

  • group: string

  • coords: vector3

  • text: string

  • sprite: number

  • color?: number

  • scale?: number

  • shortrange?: boolean

  • category?: number

  • disableText?: boolean

  • defaultDisabled?: boolean

  • onCreate?: function(blip: integer)

Return:

• id: number

Parameters Explained

• group: This is the group name to categorize the blip, this must be provided to categorize the blips.

• coords: Coordinates of the blip

• text: This is the label of the blip and also the identifier, blips with unique names/text will be individual blips that can be toggled. Blips with the same text such as "General Store", will all be grouped into a subcategory called "General Store" and all toggled on/off at once.

• sprite: https://docs.fivem.net/docs/game-references/blips/#blips
• color: https://docs.fivem.net/docs/game-references/blips/#blip-colors
• scale: https://docs.fivem.net/natives/?_0xD38744167B2FA257
• Shortrange: https://docs.fivem.net/natives/?_0xBE8BE4FE60E27B72
• category: https://docs.fivem.net/natives/?_0x234CDD44D996FD9A
• disableText: This stops AddTextEntry from running as some scripts such as ox_inventory set the text themselves

• defaultDisabled: The first time this blip is created it will be disabled by default

• onCreate: This function will run every time a blip is created/made visable and return the blip id

addTextEntry

---

Adds text entry to a blip by ID and matching text

exports['elysium_blips']:addTextEntry(name, text)

• name: string

• text: string

removeBlipById

---

Remove a blip by its ID

exports['elysium_blips']:removeBlipById(id)

• id: number

removeBlipByName

---

Remove a blip by its name/label/text, if its a subgroup (name used more than once) then all blips with the matching name will be removed

exports['elysium_blips']:removeBlipByName(name)

• name: string

openBlipsMenu

---

Opens the blip menu UI.

exports['elysium_blips']:openBlipsMenu()