Pair: getBlipIcon

This function sets the icon for an existing blip element.

OOP Syntax Help! I don't understand this!

• Method:blip:setIcon(...)
• Variable: .icon

Syntax

​bool setBlipIcon ( ​blip theBlip, ​int icon )

Required arguments

• theBlip: The blip you wish to set the icon of.
• icon: A number indicating the icon you wish to change it do. Valid values are listed on the Radar Blips page.

Returns

Returns true if the icon was successfully set, false if the element passed was not a valid blip or the icon value was not a valid icon number.

• bool: result

Code Examples

Example 1 Example 2 (OOP)

shared

This example resets all blip icons to the default blip icon, 0.

-- Retrieve a table containing all the blips that exist
local blips = getElementsByType("blip")
-- Loop through the list, storing the blip from the table in the variable blipValue
for blipKey, blipValue in blips do
    -- Retrieve the blip's icon into the variable 'blipIcon'
    local blipIcon = getBlipIcon(blipValue)
    -- If the blip's icon wasn't the default already
    if (blipIcon ~= 0) then
        -- Set the blip's icon to the default
        setBlipIcon(blipValue, 0)
    end
end

shared

OOP Required

This example resets all blip icons to the default blip icon, 0.

-- Retrieve a table containing all the blips that exist
local blips = Element.getAllByType("blip")
-- Loop through the list, storing the blip from the table in the variable blipValue
for blipKey, blipValue in blips do
    -- Retrieve the blip's icon into the variable 'blipIcon'
    local blipIcon = blipValue.icon
    -- If the blip's icon wasn't the default already
    if (blipIcon ~= 0) then
        -- Set the blip's icon to the default
        blipValue.icon = 0
    end
end

See Also

Blip Functions

• createBlip
• createBlipAttachedTo
• getBlipColor
• getBlipIcon
• getBlipOrdering
• getBlipSize
• getBlipVisibleDistance
• setBlipColor
• setBlipIcon
• setBlipOrdering
• setBlipSize
• setBlipVisibleDistance

Reference

• Scripting Functions