Pair: setBlipColor

This function will tell you what color a blip is. This color is only applicable to the marker blip icon (ID 0). All other icons will ignore this.

OOP Syntax Help! I don't understand this!

• Method: blip:getColor(...)

Syntax

int|false,​ int,​ int,​ int getBlipColor ( blip theBlip )

Required Arguments

• theBlip: The blip whose color you wish to get.

Returns

• int|false: r
• int: g
• int: b
• int: a

Returns four integers in RGBA format, with a maximum value of 255 for each. The values are, in order, red, green, blue, and alpha. Alpha decides the transparancy where 255 is opaque and 0 is fully transparent. false is returned if the blip is invalid.

Code Examples

Example 1 Example 2 (OOP)

shared

This example will find all the blips that exist and set them all to white if they aren't white already.

-- 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 colors into the variables red, green, blue and alpha
  local red, green, blue, alpha = getBlipColor ( blipValue )
  -- If the blip's icon isn't white already
  if ( red ~= 255 or green ~= 255 or blue ~= 255 or alpha ~= 255 ) then
    -- Set the blip's color to white
    setBlipColor ( blipValue, 255, 255, 255, 255 )
  end
end

shared

OOP Required

This example will find all the blips that exist and set them all to white if they aren't white already.

-- 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 colors into the variables red, green, blue and alpha
  local red, green, blue, alpha = blipValue:getColor()
  -- If the blip's icon isn't white already
  if ( red ~= 255 or green ~= 255 or blue ~= 255 or alpha ~= 255 ) then
    -- Set the blip's color to white
    blipValue:setColor( 255, 255, 255, 255 )
  end
end

See Also

Blip Functions

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

Reference

• Scripting Functions