GetRadarAreaSize - Revision history

AlexTMjugador: Added OOP syntax

2014-11-26T17:35:28Z

Added OOP syntax

← Older revision		Revision as of 17:35, 26 November 2014
Line 7:		Line 7:
	float, float getRadarAreaSize ( radararea theRadararea )		float, float getRadarAreaSize ( radararea theRadararea )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[radararea]]:getSize}}

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

Arc at 17:13, 17 May 2008

2008-05-17T17:13:34Z

← Older revision		Revision as of 17:13, 17 May 2008
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server function}}		{{Server client function}}
	This function is used for getting the X and Y size of an existing [[radararea\|radar area]].		This function is used for getting the X and Y size of an existing [[radararea\|radar area]].

Jbeta: Removed trivial example, minor changes

2007-08-13T11:49:44Z

Removed trivial example, minor changes

← Older revision		Revision as of 11:49, 13 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{~~server~~ function}}		{{Server function}}
	~~Used~~ for getting the X and Y size of an existing radar area.		This function is used for getting the X and Y size of an existing [[radararea\|radar area]].

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	float float getRadarAreaSize ( radararea theRadararea )		float, float getRadarAreaSize ( radararea theRadararea )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''theRadararea:''' The radararea element whose size you wish to get.		*'''theRadararea:''' The [[radararea\|radar area]] element whose size you wish to get.

	===Returns===		===Returns===
	Returns two ''floats'' indicating the X and Y length of the radar area respectively, ''false'' if the radar area ~~doesn't exist~~.		Returns two ''floats'' indicating the X and Y length of the radar area respectively, ''false'' if the radar area is invalid.

	==Example==		==Example==
	The following example looks for radar areas whose size is smaller than 100 by 100:		The following example looks for radar areas whose size is smaller than 100 by 100:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	radarareas = getElementsByType ( "radararea" ) -- get a ~~tabele~~ of radararea elements		local radarareas = getElementsByType ( "radararea" ) -- get a table of radararea elements
	for k,v in ipairs(radarareas) do -- use a generic for loop to step through each of the elements		for k, theArea in ipairs(radarareas) do -- use a generic for loop to step through each of the elements
	local sizeX, sizeY = getRadarAreaSize ( v ) -- get the size of the radar area		local sizeX, sizeY = getRadarAreaSize ( theArea ) -- get the size of the radar area
	if ( sizeX < 100 and sizeY < 100 ) then -- check if it's smaller than 100 by 100		if ( sizeX < 100 and sizeY < 100 ) then -- check if it's smaller than 100 by 100
	outputChatBox ( "A small radar area was found!" )		outputChatBox ( "A small radar area was found!" )
	end		end
	end		end
	~~</syntaxhighlight>~~
	~~This example creates a radar area and stores it's size in variables x and y:~~
	~~<syntaxhighlight lang="lua">~~
	~~greenArea = createRadarArea ( 1024, 1024, 50, 120, 0, 220, 0, 85 )~~
	~~local x, y = getRadarAreaSize ( greenArea )~~
	</syntaxhighlight>		</syntaxhighlight>

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

Black Dragon at 11:27, 11 August 2007

2007-08-11T11:27:34Z

← Older revision		Revision as of 11:27, 11 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
			{{server function}}
	Used for getting the X and Y size of an existing radar area.		Used for getting the X and Y size of an existing radar area.

Black Dragon at 09:12, 30 July 2007

2007-07-30T09:12:45Z

← Older revision		Revision as of 09:12, 30 July 2007
Line 17:		Line 17:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	radarareas = getElementsByType ( "radararea" ) -- get a tabele of radararea elements		radarareas = getElementsByType ( "radararea" ) -- get a tabele of radararea elements
	for k,v in radarareas do -- use a generic for loop to step through each of the elements		for k,v in ipairs(radarareas) do -- use a generic for loop to step through each of the elements
	local sizeX, sizeY = getRadarAreaSize ( v ) -- get the size of the radar area		local sizeX, sizeY = getRadarAreaSize ( v ) -- get the size of the radar area
	if ( sizeX < 100 and sizeY < 100 ) then -- check if it's smaller than 100 by 100		if ( sizeX < 100 and sizeY < 100 ) then -- check if it's smaller than 100 by 100

Erorr404 at 00:39, 11 September 2006

2006-09-11T00:39:54Z

← Older revision		Revision as of 00:39, 11 September 2006
Line 1:		Line 1:
	~~{{Needs_Checking\|Need confirmnation on what exactly size means. [[User:Erorr404\|Erorr404]]}}~~

	__NOTOC__		__NOTOC__
	Used for getting the X and Y size of an existing radar area.		Used for getting the X and Y size of an existing radar area.

Erorr404: /* Example */

2006-09-10T22:41:02Z

Example

← Older revision		Revision as of 22:41, 10 September 2006
Line 29:		Line 29:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	greenArea = createRadarArea ( 1024, 1024, 50, 120, 0, 220, 0, 85 )		greenArea = createRadarArea ( 1024, 1024, 50, 120, 0, 220, 0, 85 )
	local x, y = getRadarAreaSize ( ~~areaA~~ )		local x, y = getRadarAreaSize ( greenArea )
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{Radar area_functions}}		{{Radar area_functions}}

Erorr404: /* Example */

2006-09-10T22:40:33Z

Example

← Older revision		Revision as of 22:40, 10 September 2006
Line 25:		Line 25:
	end		end
	end		end
			</syntaxhighlight>
			This example creates a radar area and stores it's size in variables x and y:
			<syntaxhighlight lang="lua">
			greenArea = createRadarArea ( 1024, 1024, 50, 120, 0, 220, 0, 85 )
			local x, y = getRadarAreaSize ( areaA )
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{Radar area_functions}}		{{Radar area_functions}}

Erorr404 at 22:35, 10 September 2006

2006-09-10T22:35:46Z

← Older revision		Revision as of 22:35, 10 September 2006
Line 1:		Line 1:
	[[~~Category~~:~~Incomplete~~]]		{{Needs_Checking\|Need confirmnation on what exactly size means. [[User:Erorr404\|Erorr404]]}}

	__NOTOC__		__NOTOC__
	~~This fake function is~~ for ~~use with blah & blah~~ and ~~does blahblahblabhalbhl~~		Used for getting the X and Y size of an existing radar area.

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	float float getRadarAreaSize ( radararea ~~radararea~~ )		float float getRadarAreaSize ( radararea theRadararea )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''~~argumentName~~:''' ~~description~~		*'''theRadararea:''' The radararea element whose size you wish to get.

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

	===Returns===		===Returns===
	Returns ''~~true~~'' ~~if blah~~, ''false'' ~~otherwise~~.		Returns two ''floats'' indicating the X and Y length of the radar area respectively, ''false'' if the radar area doesn't exist.

	==Example==		==Example==
	~~This~~ example ~~does...~~		The following example looks for radar areas whose size is smaller than 100 by 100:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	--~~This line does...~~		radarareas = getElementsByType ( "radararea" ) -- get a tabele of radararea elements
	~~blabhalbalhb~~ --~~abababa~~		for k,v in radarareas do -- use a generic for loop to step through each of the elements
	--~~This line does this...~~		local sizeX, sizeY = getRadarAreaSize ( v ) -- get the size of the radar area
	~~mooo~~		if ( sizeX < 100 and sizeY < 100 ) then -- check if it's smaller than 100 by 100
			outputChatBox ( "A small radar area was found!" )
			end
			end
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{~~FunctionArea_Functions~~}}		{{Radar area_functions}}

Ransom at 22:31, 20 May 2006

2006-05-20T22:31:00Z

New page

[[Category:Incomplete]]

__NOTOC__
This fake function is for use with blah & blah and does blahblahblabhalbhl

==Syntax==
<syntaxhighlight lang="lua">
float float getRadarAreaSize ( radararea radararea )
</syntaxhighlight>

===Required Arguments===
*'''argumentName:''' description

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

===Returns===
Returns ''true'' if blah, ''false'' otherwise.

==Example==
This example does...
<syntaxhighlight lang="lua">
--This line does...
blabhalbalhb --abababa
--This line does this...
mooo
</syntaxhighlight>

==See Also==
{{FunctionArea_Functions}}