GetElementRadius - Revision history

AlexTMjugador: Added OOP syntax introduced in r6987 and improved the page

2014-12-31T13:53:25Z

Added OOP syntax introduced in r6987 and improved the page

← Older revision		Revision as of 13:53, 31 December 2014
Line 1:		Line 1:
	{{Client function}}		{{Client function}}
	__NOTOC__		__NOTOC__
	This function gets the radius ~~from a element. Depending on the shape~~ of ~~the element this may be~~ an ~~accurate or very inaccurate way to detect if the player is near or within the~~ element.		This function gets the radius of an [[element]]. Normally, sphere or circle-shaped elements tend to return a more accurate and expected radius than others with another shapes.

	<!-~~- This could really do with saying what~~ elements ~~it affects,~~ and ~~what you'd expect to get back from them -->~~

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	float getElementRadius ( element theElement )		float getElementRadius ( element theElement )
	</syntaxhighlight>		</syntaxhighlight>
			{{New feature/item\|3.0141\|1.4.0\|6987\|{{OOP\|\|[[element]]:getRadius\|radius}}}}

	===Required Arguments===		===Required Arguments===
	*'''theElement:''' The element. ~~The Elements it checks~~: ~~(Still Checking)~~		*'''theElement:''' The element to get the radius of. It can be any entity type, such as:
	** '''~~Player~~'''		** '''[[player\|Players]]'''.
	** '''~~Ped~~'''		** '''[[ped\|Peds]]'''.
	** '''~~Vehicle~~'''		** '''[[vehicle\|Vehicles]]'''.
			** '''[[object\|Objects]]'''.

	===Returns===		===Returns===
	Returns ''float'' as radius, ''false'' otherwise.		Returns a ''float'' containing the radius if the element is valid, ''false'' otherwise.

	==Example==		==Example==
	This example shows how to get the radius of a player		This example shows how to get and output the radius of every player who types the ''/getmyradius'' command (which will always be ''1'').
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function ~~myCommandHandler(command)~~		local function outputLocalPlayerRadius()
	~~local myradius = getElementRadius ( getLocalPlayer() )~~		outputChatBox("Your radius is " .. getElementRadius(localPlayer))
	if (~~myradius~~) ~~then~~
	outputChatBox("~~Radius of my player~~ is: " .. ~~myradius~~)
	~~else~~
	~~outputChatBox("Error"~~)
	~~end~~
	end		end
			addCommandHandler("getmyradius", outputLocalPlayerRadius)
	addCommandHandler("getmyradius", ~~myCommandHandler~~)
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{Client element functions}}		{{Client element functions}}

Jaysds1 at 21:27, 31 August 2012

2012-08-31T21:27:41Z

← Older revision		Revision as of 21:27, 31 August 2012
Line 1:		Line 1:
	{{Client function}}		{{Client function}}
	~~{{Needs Checking\|Is this function still incomplete? --[[User:Winky-\|Winky-]] 16:34, 23 December 2011 (CET)}}~~
	__NOTOC__		__NOTOC__
	This function gets the radius from a element. Depending on the shape of the element this may be an accurate or very inaccurate way to detect if the player is near or within the element.		This function gets the radius from a element. Depending on the shape of the element this may be an accurate or very inaccurate way to detect if the player is near or within the element.

	<!-- This could really do with saying what elements it affects, and what you'd expect to get back from them -->		<!-- This could really do with saying what elements it affects, and what you'd expect to get back from them -->
	~~[[Category:Incomplete]] <!-- Do not remove unless you finish the documentation. -->~~

	==Syntax==		==Syntax==
Line 13:		Line 11:

	===Required Arguments===		===Required Arguments===
	*'''theElement:''' The element.		*'''theElement:''' The element. The Elements it checks: (Still Checking)
			** '''Player'''
			** '''Ped'''
			** '''Vehicle'''

	===Returns===		===Returns===

Winky- at 15:34, 23 December 2011

2011-12-23T15:34:49Z

← Older revision		Revision as of 15:34, 23 December 2011
Line 1:		Line 1:
	{{Client function}}		{{Client function}}
			{{Needs Checking\|Is this function still incomplete? --[[User:Winky-\|Winky-]] 16:34, 23 December 2011 (CET)}}
	__NOTOC__		__NOTOC__
	This function gets the radius from a element. Depending on the shape of the element this may be an accurate or very inaccurate way to detect if the player is near or within the element.		This function gets the radius from a element. Depending on the shape of the element this may be an accurate or very inaccurate way to detect if the player is near or within the element.

EAi at 14:01, 4 August 2011

2011-08-04T14:01:37Z

← Older revision		Revision as of 14:01, 4 August 2011
Line 1:		Line 1:
	{{Client function}}		{{Client function}}
	__NOTOC__		__NOTOC__
	This function gets the radius from a element. Depending on the shape of the element this may be an accurate or very inaccurate way to detect if the player is near or within the ~~object~~.		This function gets the radius from a element. Depending on the shape of the element this may be an accurate or very inaccurate way to detect if the player is near or within the element.

	<!-- This could really do with saying what elements it affects, and what you'd expect to get back from them -->		<!-- This could really do with saying what elements it affects, and what you'd expect to get back from them -->

EAi at 14:01, 4 August 2011

2011-08-04T14:01:26Z

← Older revision		Revision as of 14:01, 4 August 2011
Line 1:		Line 1:
	{{Client function}}		{{Client function}}
	__NOTOC__		__NOTOC__
	This function gets the radius from a element.		This function gets the radius from a element. Depending on the shape of the element this may be an accurate or very inaccurate way to detect if the player is near or within the object.

	<!-- This could really do with saying what elements it affects, and what you'd expect to get back from them -->		<!-- This could really do with saying what elements it affects, and what you'd expect to get back from them -->

Gamesnert at 12:47, 25 May 2010

2010-05-25T12:47:00Z

← Older revision		Revision as of 12:47, 25 May 2010
Line 20:		Line 20:
	This example shows how to get the radius of a player		This example shows how to get the radius of a player
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function myCommandHandler(~~source,~~ command)		function myCommandHandler(command)
	local myradius = getElementRadius ( ~~source~~ )		local myradius = getElementRadius ( getLocalPlayer() )
	if (myradius) then		if (myradius) then
	outputChatBox("Radius of my player is: " .. myradius)		outputChatBox("Radius of my player is: " .. myradius)

EAi at 12:14, 25 May 2010

2010-05-25T12:14:05Z

← Older revision		Revision as of 12:14, 25 May 2010
Line 18:		Line 18:

	==Example==		==Example==
	~~Example of~~ how to ~~derive~~ the radius of a player:		This example shows how to get the radius of a player
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function myCommandHandler(source, command)		function myCommandHandler(source, command)

EAi at 12:13, 25 May 2010

2010-05-25T12:13:29Z

← Older revision		Revision as of 12:13, 25 May 2010
Line 18:		Line 18:

	==Example==		==Example==
	~~<section name="Client" class="client" show="true">~~
	Example of how to derive the radius of a player:		Example of how to derive the radius of a player:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 32:		Line 31:
	addCommandHandler("getmyradius", myCommandHandler)		addCommandHandler("getmyradius", myCommandHandler)
	</syntaxhighlight>		</syntaxhighlight>
	~~</section>~~

	==See Also==		==See Also==
	{{Client element functions}}		{{Client element functions}}

Extrike at 10:23, 24 May 2010

2010-05-24T10:23:25Z

← Older revision		Revision as of 10:23, 24 May 2010
Line 36:		Line 36:
	==See Also==		==See Also==
	{{Client element functions}}		{{Client element functions}}
	~~[[Category:Needs Example]]~~

Extrike: /* Example */

2010-05-24T10:22:31Z

Example

← Older revision		Revision as of 10:22, 24 May 2010
Line 18:		Line 18:

	==Example==		==Example==
			<section name="Client" class="client" show="true">
			Example of how to derive the radius of a player:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~-- Add example~~..		function myCommandHandler(source, command)
			local myradius = getElementRadius ( source )
			if (myradius) then
			outputChatBox("Radius of my player is: " .. myradius)
			else
			outputChatBox("Error")
			end
			end

			addCommandHandler("getmyradius", myCommandHandler)
	</syntaxhighlight>		</syntaxhighlight>
			</section>

	==See Also==		==See Also==
	{{Client element functions}}		{{Client element functions}}
	[[Category:Needs Example]]		[[Category:Needs Example]]