SetBlipColor

From Multi Theft Auto: Wiki
Revision as of 18:39, 18 May 2006 by EAi (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This function will let you change the color of a blip. This color is only applicable to the default blip icon. All other icons will ignore this.

Syntax

bool setBlipColor ( blip theBlip, int red, int green, int blue, int alpha )

Required Arguments

  • theBlip: The blip who's color you wish to get.
  • red: The amount of red in the blip's color (0 - 255).
  • green: The amount of green in the blip's color (0 - 255).
  • blue: The amount of blue in the blip's color (0 - 255).
  • alpha: The amount of alpha in the blip's color (0 - 255).

Returns

Returns true if the blip's color was set successfully. Returns false if the blip passed to the function is invalid, or any of the colors are out of the valid range.

Example

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
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 colors into the variables red, green, blue and alpha
	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

See Also

Template:Blip Functions