Pair: setBlipIcon

This function returns the icon a blip currently has. See Radar Blips.

OOP Syntax Help! I don't understand this!

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

Syntax

int|false getBlipIcon ( blip theBlip )

Required Arguments

• theBlip: The blip we're getting the icon number of.

Returns

• int|false: icon

Returns an int indicating which icon the blip has. false if blip element is invalid.

Code Examples

Example 1 Example 2 (OOP)

shared

This example will find all the blips that exist and set them all to the default blip icon.

-- 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 ipairs(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 will find all the blips that exist and set them all to the default blip icon.

-- 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 ipairs(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