SetBlipColor: Difference between revisions
Jump to navigation
Jump to search
m (Link to the Romanian translation of this page added.) |
|||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 7: | Line 7: | ||
{{OOP||[[blip]]:setColor||getBlipColor|}} | {{OOP||[[blip]]:setColor||getBlipColor|}} | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''theBlip:''' | *'''theBlip:''' The blip who's color you wish to set. | ||
*'''red:''' (0 - 255) | *'''red:''' The amount of red in the blip's color (0 - 255). | ||
*'''green:''' (0 - 255) | *'''green:''' The amount of green in the blip's color (0 - 255). | ||
*'''blue:''' (0 - 255) | *'''blue:''' The amount of blue in the blip's color (0 - 255). | ||
*'''alpha:''' | *'''alpha:''' The amount of alpha in the blip's color (0 - 255). Alpha decides transparancy where 255 is opaque and 0 is transparent. | ||
===Returns=== | ===Returns=== | ||
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. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- Retrieve a table containing all the blips that exist | |||
local blips = getElementsByType ( "blip" ) | 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 | 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 ) | 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 | 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 ) | setBlipColor ( blipValue, 255, 255, 255, 255 ) | ||
end | end | ||
| Line 30: | Line 35: | ||
==See Also== | ==See Also== | ||
{{Blip_functions}} | {{Blip_functions}} | ||
[[hu:setBlipColor]] | |||
[[RO:setBlipColor]] | |||
Latest revision as of 19:39, 20 July 2019
This function will let you change the color of a blip. This color is only applicable to the default blip icon (
, 
or 
). All other icons will ignore this.
Syntax
bool setBlipColor ( blip theBlip, int red, int green, int blue, int alpha )
OOP Syntax Help! I don't understand this!
- Method: blip:setColor(...)
- Counterpart: getBlipColor
Required Arguments
- theBlip: The blip who's color you wish to set.
- 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). Alpha decides transparancy where 255 is opaque and 0 is transparent.
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 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