GetColorFromString: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | {{Server function}} | ||
__NOTOC__ | |||
This function will extract Red, Green, Blue and Alpha values from a hex string you provide it. These strings follow the same format as used in HTML, with addition of the Alpha values. | This function will extract Red, Green, Blue and Alpha values from a hex string you provide it. These strings follow the same format as used in HTML, with addition of the Alpha values. | ||
| Line 27: | Line 28: | ||
This example will set the blip attached to a player to a color they specify by typing ''set_my_color [color]'' in the console. | This example will set the blip attached to a player to a color they specify by typing ''set_my_color [color]'' in the console. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function setPlayerBlipColor ( playerSource, commandName, colorString ) | function setPlayerBlipColor ( playerSource, commandName, colorString ) | ||
red, green, blue, alpha = getColorFromString ( colorString ) -- convert the color to numbers | local red, green, blue, alpha = getColorFromString ( colorString ) -- convert the color string to numbers | ||
playerBlip = getBlipAttachedTo ( playerSource ) -- find the blip attached to the player | local playerBlip = getBlipAttachedTo ( playerSource ) -- find the blip attached to the player | ||
if ( playerBlip and red | if ( playerBlip and red ) then -- check a blip is attached to the player and that a valid color was specified | ||
setBlipColor ( playerBlip, red, green, blue, alpha ) -- set the player's blip color | setBlipColor ( playerBlip, red, green, blue, alpha ) -- set the player's blip color | ||
end | end | ||
end | end | ||
addCommandHandler ( "set_my_color", setPlayerBlipColor ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Blip_functions}} | {{Blip_functions}} | ||
Revision as of 20:14, 19 August 2007
This function will extract Red, Green, Blue and Alpha values from a hex string you provide it. These strings follow the same format as used in HTML, with addition of the Alpha values.
Syntax
int int int int getColorFromString ( string theColor )
Required Arguments
- theColor: A string containing a valid color code.
- Valid strings are:
- #RRGGBB: Colors specified, Alpha assumed to be 255.
- #RRGGBBAA: All values specified.
- #RGB: Shortened form, will be expanded internally to RRGGBB, as such it provides a smaller number of colors.
- #RGBA: As above, shortened - each character is duplicated.
- For example:
- #FF00FF is Red: 255, Green: 0, Blue: 255, Alpha: 255
- #F0F is Red: 255, Green: 0, Blue: 255, Alpha: 255 (the same as the example above)
- #34455699 is Red: 52, Green: 69, Blue: 86, Alpha: 153
All colors used must begin with a # sign.
Returns
Returns four integers in RGBA format, with a maximum value of 255 for each. Each stands for red, green, blue, and alpha. Alpha decides transparancy where 255 is opaque and 0 is transparent. false is returned if the string passed is invalid (for example, is missing the preceeding # sign).
Example
This example will set the blip attached to a player to a color they specify by typing set_my_color [color] in the console.
function setPlayerBlipColor ( playerSource, commandName, colorString )
local red, green, blue, alpha = getColorFromString ( colorString ) -- convert the color string to numbers
local playerBlip = getBlipAttachedTo ( playerSource ) -- find the blip attached to the player
if ( playerBlip and red ) then -- check a blip is attached to the player and that a valid color was specified
setBlipColor ( playerBlip, red, green, blue, alpha ) -- set the player's blip color
end
end
addCommandHandler ( "set_my_color", setPlayerBlipColor )
See Also
- createBlip
- createBlipAttachedTo
- getBlipColor
- getBlipIcon
- getBlipOrdering
- getBlipSize
- getBlipVisibleDistance
- setBlipColor
- setBlipIcon
- setBlipOrdering
- setBlipSize
- setBlipVisibleDistance