nss_libs - Blip

Easy to create blips for your REDM resource.

Example

Coords & Entity Blip

------------------------------------------------------------------------------
-- Step 1: Get API
------------------------------------------------------------------------------

---@type NssLibsBlipsApi
local blip_api = exports.nss_libs:getBlipsApi(GetCurrentResourceName())

------------------------------------------------------------------------------
-- Step 2: Create blip object and show it
------------------------------------------------------------------------------

-- Create blip at coords
local icon = 'blip_ambient_vip'
local title = 'Treasure'
local color_hash = 0x1DD3A06B
local x = -760.56
local y = -1251.08
local z = 43.41

---@type NssLibsBlipApi
local coords_blip = blip_api.createAtCoords(x, y, z, icon, color_hash, title)

coords_blip.setMedium()
coords_blip.addModifier('BLIP_MODIFIER_MP_SUPPLIES_OUTLINE_COLOR_2') -- Adds red outline
coords_blip.show()

-- Create blip at entity
local entity = GetPlayerPed(-1)
local color_name = 'BLIP_MODIFIER_MP_COLOR_4' -- names working, too

---@type NssLibsBlipApi
local entity_blip = blip_api.createAttachedToEntity(entity, icon, color_name, title)
entity_blip.setSmall()
entity_blip.show()

Dynamic Changes & Hiding

------------------------------------------------------------------------------
-- Optional: Dynamic changes
------------------------------------------------------------------------------

entity_blip.setColor(0x6F85C3CE) -- blip will be reassembled with new color.

------------------------------------------------------------------------------
-- Step 3: Hide blip
------------------------------------------------------------------------------

-- If you want to remove the blip completely, use destroy() instead of hide().
coords_blip.hide()
entity_blip.hide()

---

Methods

exports.nss_libs:getBlipsApi(resource_name)

Returns the NPC api NssLibsBlipsApi for the given resource.

Param	Type	Default	Description
resource_name	string	—	The name of the resource that wants to use the API

---

NssLibsBlipsApi

create(icon, title, color)

Param	Type	Default	Description
icon	number | string	—	The icon of the blip entity. See multiplayer blip textures or single player blip textures for a list of available icons
title	string?	—	The title of the blip entity (optional)
color	number | string	—	The color of the blip entity. See blip colors and modifiers for a list of available colors

Returns NssLibsBlipApi — A blip entity api.

createAtCoords(x, y, z, icon, color, title)

Param	Type	Default	Description
x	number	—	The x position of the blip
y	number	—	The y position of the blip
z	number	—	The z position of the blip
icon	number | string	—	See create for details
color	number | string	—	See create for details
title	string?	—	See create for details

Returns NssLibsBlipApi — A blip entity api.

createAttachedToEntity(entity, icon, color, title)

Param	Type	Default	Description
entity	number	—	The entity handle of the blip
icon	number | string	—	See create for details
color	number | string	—	See create for details
title	string?	—	See create for details

Returns NssLibsBlipApi — A blip entity api.

createRadiusAtCoords(x, y, z, range, color)

Param	Type	Default	Description
x	number	—	The x position of the blip
y	number	—	The y position of the blip
z	number	—	The z position of the blip
range	number	—	The range in meters (radius) of the blip
color	number | string	—	See create for details

INFO

Radius blips have no icon or title.

Returns NssLibsBlipApi — A blip entity api.

---

NssLibsBlipApi

destroy()

Removes the blip completely.

show()

Shows the blip.

Returns NssLibsBlipApi — Self for chaining.

hide()

Hides the blip.

Returns NssLibsBlipApi — Self for chaining.

setCoords(x, y, z)

Sets the coordinates of the blip.

Resets the entity of the blip if set before.

Param	Type	Default	Description
x	number	—	The x position of the blip
y	number	—	The y position of the blip
z	number	—	The z position of the blip

Returns NssLibsBlipApi — Self for chaining.

setEntity(entity)

Attach the blip to an entity.

Resets the coordinates of the blip if set before.

Param	Type	Default	Description
entity	number	—	The entity handle of the blip

Returns NssLibsBlipApi — Self for chaining.

setRadius(x, y, z, range)

Sets the coordinates and the range (size) of the blip.

Resets the entity of the blip if set before.

Param	Type	Default	Description
x	number	—	The x position of the blip
y	number	—	The y position of the blip
z	number	—	The z position of the blip
range	number	—	The range in meters (radius) of the blip

Returns NssLibsBlipApi — Self for chaining.

setColor(color)

Sets the color of the blip.

Param	Type	Default	Description
color	number | string	—	The color of the blip entity. See blip colors and modifiers for a list of available colors

Returns NssLibsBlipApi — Self for chaining.

setTitle(title)

Sets the title of the blip.

Param	Type	Default	Description
title	string	—	The title of the blip entity. If empty no title will be shown

Returns NssLibsBlipApi — Self for chaining.

setIcon(icon)

Sets the icon of the blip.

Param	Type	Default	Description
icon	number | string	—	The icon of the blip entity. See multiplayer blip textures or single player blip textures for a list of available icons

Returns NssLibsBlipApi — Self for chaining.

setSmall()

Sets the size of the blip to small.

Returns NssLibsBlipApi — Self for chaining.

setMedium()

Sets the size of the blip to medium.

Returns NssLibsBlipApi — Self for chaining.

setBig()

Sets the size of the blip to large.

Returns NssLibsBlipApi — Self for chaining.

isVisible()

Returns boolean — true if the blip is visible, otherwise false.

addModifier(modifier)

Adds a modifier to the blip.

Param	Type	Default	Description
modifier	number | string	—	The modifier of the blip entity. See blip colors and modifiers for a list of available modifiers

Returns NssLibsBlipApi — Self for chaining.

---

Todo

• Remove blip if entity is dead, offline or removed.