GetRadarAreaColor - Revision history

AlexTMjugador: Added OOP syntax

2014-11-26T17:35:00Z

Added OOP syntax

← Older revision		Revision as of 17:35, 26 November 2014
Line 6:		Line 6:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	int, int, int, int getRadarAreaColor ( radararea theRadararea )		int, int, int, int getRadarAreaColor ( radararea theRadararea )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[radararea]]:getColor}}

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

Arc at 17:11, 17 May 2008

2008-05-17T17:11:45Z

← Older revision		Revision as of 17:11, 17 May 2008
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server function}}		{{Server client function}}
	This function can be used to retrieve the current color of a [[radararea\|radar area]].		This function can be used to retrieve the current color of a [[radararea\|radar area]].

Arc at 13:29, 19 August 2007

2007-08-19T13:29:42Z

← Older revision		Revision as of 13:29, 19 August 2007
Line 15:		Line 15:

	==Example==		==Example==
	This example checks the color of a radararea defined as 'area' and announces if it is ~~ballas~~ or ~~grove street~~.		This example checks the color of a radararea defined as 'area' and announces if it is Ballas or Grove Street territory.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local r,g,b,a = getRadarAreaColor ( area ) --get the color of 'area' and store it in 'r', 'g', 'b' and 'a'		local r,g,b,a = getRadarAreaColor ( area ) -- get the color of 'area' and store it in 'r', 'g', 'b' and 'a'
	if r == 0 and g == 255 and b == 0 then --if the radar area is fully green		if r == 0 and g == 255 and b == 0 then -- if the radar area is fully green
	outputChatBox ( "This is Grove Street turf!" ) --announce it as grove street area		outputChatBox ( "This is Grove Street turf!" ) -- announce it as grove street area
	elseif r == 255 and g == 0 and b == 255 then --if it is purple however		elseif r == 255 and g == 0 and b == 255 then -- if it is purple however
	outputChatBox ( "This is Ballas turf!" ) --announce it as ballas area		outputChatBox ( "This is Ballas turf!" ) -- announce it as ballas area
	end		end
	</syntaxhighlight>		</syntaxhighlight>

Jbeta: Fixed example, minor changes

2007-08-13T11:46:18Z

Fixed example, minor changes

← Older revision		Revision as of 11:46, 13 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{~~server~~ function}}		{{Server function}}
	This function can be used to retrieve the current color of a ~~Radar Area~~.		This function can be used to retrieve the current color of a [[radararea\|radar area]].

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	int int int int getRadarAreaColor ( radararea theRadararea )		int, int, int, int getRadarAreaColor ( radararea theRadararea )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''theRadararea:''' The radar area you wish to retrieve the colour of		*'''theRadararea:''' The [[radararea\|radar area]] you wish to retrieve the colour of.

	===Returns===		===Returns===
	Returns four integers in RGBA format (''red'', ''green'', ''blue'', ''alpha''), with a maximum value of 255 for each. Alpha decides ~~transparancy~~ where 255 is opaque and 0 is transparent. Returns ''false'' if the radararea is invalid.		Returns four integers in RGBA format (''red'', ''green'', ''blue'', ''alpha''), with a maximum value of 255 for each. Alpha decides transparency where 255 is opaque and 0 is transparent. Returns ''false'' if the radararea is invalid.

	==Example==		==Example==
	This example checks the color of a radararea defined as 'area' and announces if it is ballas or grove street.		This example checks the color of a radararea defined as 'area' and announces if it is ballas or grove street.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local r,g,b,a = getRadarAreaColor ( area ) --get the color of 'area' and ~~define~~ it as 'r', 'g', 'b' and 'a'		local r,g,b,a = getRadarAreaColor ( area ) --get the color of 'area' and store it in 'r', 'g', 'b' and 'a'
	if g == 255 then --if the radar area is fully green		if r == 0 and g == 255 and b == 0 then --if the radar area is fully green
	outputChatBox ( "This is Grove Street turf!" ) --announce it as grove street area		outputChatBox ( "This is Grove Street turf!" ) --announce it as grove street area
	elseif r == 255 then --if it is ~~fully red~~ however		elseif r == 255 and g == 0 and b == 255 then --if it is purple however
	outputChatBox ( "This is Ballas turf!" ) --announce it as ballas area		outputChatBox ( "This is Ballas turf!" ) --announce it as ballas area
	end		end

Black Dragon at 11:27, 11 August 2007

2007-08-11T11:27:08Z

← Older revision		Revision as of 11:27, 11 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
			{{server function}}
	This function can be used to retrieve the current color of a Radar Area.		This function can be used to retrieve the current color of a Radar Area.

Erorr404 at 22:47, 10 September 2006

2006-09-10T22:47:51Z

← Older revision		Revision as of 22:47, 10 September 2006
Line 4:		Line 4:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	int int int int getRadarAreaColor ( radararea ~~radararea~~ )		int int int int getRadarAreaColor ( radararea theRadararea )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''~~radararea~~:''' The radar area you wish to retrieve the colour of		*'''theRadararea:''' The radar area you wish to retrieve the colour of

	===Returns===		===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 ~~blip~~ is invalid.		Returns four integers in RGBA format (''red'', ''green'', ''blue'', ''alpha''), with a maximum value of 255 for each. Alpha decides transparancy where 255 is opaque and 0 is transparent. Returns ''false'' if the radararea is invalid.

	==Example==		==Example==

Talidan at 15:13, 16 August 2006

2006-08-16T15:13:46Z

← Older revision		Revision as of 15:13, 16 August 2006
Line 11:		Line 11:

	===Returns===		===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 blip is invalid.		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 blip is invalid.

	==Example==		==Example==

Talidan at 15:13, 16 August 2006

2006-08-16T15:13:00Z

← Older revision		Revision as of 15:13, 16 August 2006
Line 11:		Line 11:

	===Returns===		===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.		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 blip is invalid.

	==Example==		==Example==

EAi: /* Example */

2006-08-13T21:30:56Z

Example

← Older revision		Revision as of 21:30, 13 August 2006
Line 16:		Line 16:
	This example checks the color of a radararea defined as 'area' and announces if it is ballas or grove street.		This example checks the color of a radararea defined as 'area' and announces if it is ballas or grove street.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local r,g,b,a getRadarAreaColor ( area ) --get the color of 'area' and define it as 'r', 'g', 'b' and 'a'		local r,g,b,a = getRadarAreaColor ( area ) --get the color of 'area' and define it as 'r', 'g', 'b' and 'a'
	if g == 255 then --if the radar area is fully green		if g == 255 then --if the radar area is fully green
	outputChatBox ( "This is Grove Street turf!" ) --announce it as grove street area		outputChatBox ( "This is Grove Street turf!" ) --announce it as grove street area

Talidan at 17:57, 13 August 2006

2006-08-13T17:57:24Z

← Older revision		Revision as of 17:57, 13 August 2006
Line 1:		Line 1:
	~~[[Category:Incomplete]]~~

	__NOTOC__		__NOTOC__
	This ~~fake~~ function ~~is for use with blah & blah and does blahblahblabhalbhl~~		This function can be used to retrieve the current color of a Radar Area.

	==Syntax==		==Syntax==
Line 10:		Line 8:

	===Required Arguments===		===Required Arguments===
	*'''~~argumentName~~:''' ~~description~~		*'''radararea:''' The radar area you wish to retrieve the colour of

	~~===Optional Arguments===~~
	~~{{OptionalArg}}~~
	*'''argumentName2:''' descriptiona
	*'''argumentName3:''' description

	===Returns===		===Returns===
	Returns ''~~true~~'' ~~if blah~~, ''~~false~~'' ~~otherwise~~.		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.

	==Example==		==Example==
	This example ~~does..~~.		This example checks the color of a radararea defined as 'area' and announces if it is ballas or grove street.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	--This ~~line does...~~		local r,g,b,a getRadarAreaColor ( area ) --get the color of 'area' and define it as 'r', 'g', 'b' and 'a'
	~~blabhalbalhb~~ --~~abababa~~		if g == 255 then --if the radar area is fully green
	--~~This line does this...~~		outputChatBox ( "This is Grove Street turf!" ) --announce it as grove street area
	~~mooo~~		elseif r == 255 then --if it is fully red however
			outputChatBox ( "This is Ballas turf!" ) --announce it as ballas area
			end
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{~~FunctionArea_Functions~~}}		{{Radar area functions}}