GetColorFromString - Revision history

Myonlake: /* Syntax */

2019-08-25T17:43:25Z

Syntax

← Older revision		Revision as of 17:43, 25 August 2019
Line 4:		Line 4:

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">int int int int getColorFromString ( string theColor )</syntaxhighlight>		<syntaxhighlight lang="lua">int, int, int, int getColorFromString ( string theColor )</syntaxhighlight>

	===Required Arguments===		===Required Arguments===

Miki785 at 22:27, 5 July 2014

2014-07-05T22:27:31Z

← Older revision		Revision as of 22:27, 5 July 2014
Line 2:		Line 2:
	__NOTOC__		__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.

	~~{{New feature\|3\|1.0\|From 1.0, this will be supported client-side as well as server-side. Lowercase strings will also be accepted}}~~

	==Syntax==		==Syntax==
Line 27:		Line 25:
	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).		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==		==Example==
			<section class="server" name="Server" show="true">
	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.

Line 51:		Line 50:
	end		end
	</syntaxhighlight>		</syntaxhighlight>
			</section>

	==See Also==		==See Also==
	{{Utility_functions}}		{{Utility_functions}}

Robhol at 12:02, 30 March 2009

2009-03-30T12:02:46Z

← Older revision		Revision as of 12:02, 30 March 2009
Line 1:		Line 1:
	{{Server function}}		{{Server client function}}
	__NOTOC__		__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.

Talidan at 01:09, 25 November 2008

2008-11-25T01:09:43Z

← Older revision		Revision as of 01:09, 25 November 2008
Line 3:		Line 3:
	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.

	{{New feature\|3\|~~DP3~~\|From ~~DP3~~, this will be supported client-side as well as server-side. Lowercase strings will also be accepted}}		{{New feature\|3\|1.0\|From 1.0, this will be supported client-side as well as server-side. Lowercase strings will also be accepted}}

	==Syntax==		==Syntax==

EAi at 01:02, 14 May 2008

2008-05-14T01:02:42Z

← Older revision		Revision as of 01:02, 14 May 2008
Line 2:		Line 2:
	__NOTOC__		__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.

			{{New feature\|3\|DP3\|From DP3, this will be supported client-side as well as server-side. Lowercase strings will also be accepted}}

	==Syntax==		==Syntax==

Awwu: /* Example */

2008-04-03T11:15:47Z

Example

← Older revision		Revision as of 11:15, 3 April 2008
Line 27:		Line 27:
	==Example==		==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.		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 is out of date, getBlipAttachedTo no longer exists'''~~

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 39:		Line 37:
	end		end
	addCommandHandler ( "set_my_color", setPlayerBlipColor )		addCommandHandler ( "set_my_color", setPlayerBlipColor )

			-- specify the getBlipAttachedTo function
			function getBlipAttachedTo( thePlayer )
			local blips = getElementsByType( "blip" )
			for k, theBlip in ipairs( blips ) do
			if getElementAttachedTo( theBlip ) == thePlayer then
			return theBlip
			end
			end
			return false
			end
	</syntaxhighlight>		</syntaxhighlight>
	~~[[Category:Needs Example]]~~

	==See Also==		==See Also==
	{{Utility_functions}}		{{Utility_functions}}

EAi: /* Example */

2008-01-19T02:13:55Z

Example

← Older revision		Revision as of 02:13, 19 January 2008
Line 27:		Line 27:
	==Example==		==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.		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 is out of date, getBlipAttachedTo no longer exists'''

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function setPlayerBlipColor ( playerSource, commandName, colorString )		function setPlayerBlipColor ( playerSource, commandName, colorString )
Line 37:		Line 40:
	addCommandHandler ( "set_my_color", setPlayerBlipColor )		addCommandHandler ( "set_my_color", setPlayerBlipColor )
	</syntaxhighlight>		</syntaxhighlight>
			[[Category:Needs Example]]

	==See Also==		==See Also==
	{{Utility_functions}}		{{Utility_functions}}

Upstream at 18:22, 17 January 2008

2008-01-17T18:22:40Z

← Older revision		Revision as of 18:22, 17 January 2008
Line 39:		Line 39:

	==See Also==		==See Also==
	{{~~Blip_functions~~}}		{{Utility_functions}}

Arc at 20:14, 19 August 2007

2007-08-19T20:14:33Z

← Older revision		Revision as of 20:14, 19 August 2007
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">
	~~addCommandHandler ( "set_my_color", "setPlayerBlipColor" )~~
	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 ~~!= false~~ ) -- check a blip is attached to the player and that a valid color was specified		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}}

EAi at 19:19, 17 August 2006

2006-08-17T19:19:56Z

← Older revision		Revision as of 19:19, 17 August 2006
Line 17:		Line 17:
	:* '''#FF00FF''' is Red: 255, Green: 0, Blue: 255, Alpha: 255		:* '''#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)		:* '''#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		:* '''#34455699''' is Red: 52, Green: 69, Blue: 86, Alpha: 153

	All colors used must begin with a # sign.		All colors used must begin with a # sign.