IsElementAttached - Revision history

Luxy.c: /* Returns */

2018-09-27T23:10:24Z

Returns

← Older revision		Revision as of 23:10, 27 September 2018
Line 17:		Line 17:
	===Returns===		===Returns===
	<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->		<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
	Returns ''true'' if the specified element is attached to another element, ''false'' if it is not attached or ''nil'' if an improper argument is passed.		Returns ''true'' if the specified element is attached to another element, ''false'' if it is not attached or ''nil'' if an improper argument was passed.

	==Example==		==Example==

Luxy.c: /* Returns */

2018-09-27T23:09:38Z

Returns

← Older revision		Revision as of 23:09, 27 September 2018
Line 17:		Line 17:
	===Returns===		===Returns===
	<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->		<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
	Returns ''true'' if the specified element is attached to another element, ''false'' if it is not attached or if an improper argument is passed.		Returns ''true'' if the specified element is attached to another element, ''false'' if it is not attached or ''nil'' if an improper argument is passed.

	==Example==		==Example==

Qaisjp: fix oop syntax

2015-01-01T22:53:41Z

fix oop syntax

← Older revision		Revision as of 22:53, 1 January 2015
Line 9:		Line 9:
	bool isElementAttached ( element theElement )		bool isElementAttached ( element theElement )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|~~This function is also a static function underneath the Element class.~~\|[[element]]:isAttached\|attached\|}}		{{OOP\|\|[[element]]:isAttached\|attached\|}}

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

Jaysds: /* Syntax */ OOP

2014-08-16T16:27:00Z

Syntax: OOP

← Older revision		Revision as of 16:27, 16 August 2014
Line 9:		Line 9:
	bool isElementAttached ( element theElement )		bool isElementAttached ( element theElement )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|This function is also a static function underneath the Element class.\|[[element]]:isAttached\|attached\|}}

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

Arc at 14:29, 17 August 2007

2007-08-17T14:29:11Z

← Older revision		Revision as of 14:29, 17 August 2007
Line 1:		Line 1:
	__NOTOC__		{{Server client function}}
			__NOTOC__
	<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->		<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
	This functions checks whether or not an element is attached to another element.		This functions checks whether or not an element is attached to another element.
Line 6:		Line 7:
	<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->		<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool isElementAttached ( theElement )		bool isElementAttached ( element theElement )
	</syntaxhighlight>		</syntaxhighlight>

Line 23:		Line 24:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	-- add a command handler for 'amiattached' to call the function 'consoleIsPlayerAttached':		-- add a command handler for 'amiattached' to call the function 'consoleIsPlayerAttached':
	function consoleIsPlayerAttached ( ~~player~~, command )		function consoleIsPlayerAttached ( thePlayer, command )
	if ( ~~player~~ ) then -- if a player triggered this command		if ( thePlayer ) then -- if a player triggered this command
	local status = isElementAttached ( ~~player~~ ) -- call the function and store it's result in the 'status' variable		local status = isElementAttached ( thePlayer ) -- call the function and store it's result in the 'status' variable
	if ( status ) then -- if the function returned true, tell the player he is attached to something		if ( status ) then -- if the function returned true, tell the player he is attached to something
	outputConsole ( "You are attached to an element!", ~~player~~ )		outputConsole ( "You are attached to an element!", thePlayer )
	else -- if the function returned false, tell the player he is not attached to anything		else -- if the function returned false, tell the player he is not attached to anything
	outputConsole ( "You are not attached to an element.", ~~player~~ )		outputConsole ( "You are not attached to an element.", thePlayer )
	end		end
	end		end

Arc at 15:10, 15 August 2007

2007-08-15T15:10:33Z

← Older revision		Revision as of 15:10, 15 August 2007
Line 23:		Line 23:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	-- add a command handler for 'amiattached' to call the function 'consoleIsPlayerAttached':		-- add a command handler for 'amiattached' to call the function 'consoleIsPlayerAttached':
	~~addCommandHandler ( "amiattached", "consoleIsPlayerAttached" )~~
	function consoleIsPlayerAttached ( player, command )		function consoleIsPlayerAttached ( player, command )
	if ( player ) then -- if a player triggered this command		if ( player ) then -- if a player triggered this command
Line 34:		Line 33:
	end		end
	end		end
			addCommandHandler ( "amiattached", consoleIsPlayerAttached )
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{Element_functions}}		{{Element_functions}}

Black Dragon at 14:44, 20 June 2007

2007-06-20T14:44:53Z

← Older revision		Revision as of 14:44, 20 June 2007
Line 37:		Line 37:

	==See Also==		==See Also==
	~~<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->~~
	{{Element_functions}}		{{Element_functions}}
	~~[[Category:Incomplete]] -- leave this unless you complete the function~~

Erorr404 at 00:57, 30 December 2006

2006-12-30T00:57:33Z

New page

__NOTOC__

This functions checks whether or not an element is attached to another element.

==Syntax==

<syntaxhighlight lang="lua">
bool isElementAttached ( theElement )
</syntaxhighlight>

===Required Arguments===

*'''theElement:''' The element to check for attachment.

===Returns===

Returns ''true'' if the specified element is attached to another element, ''false'' if it is not attached or if an improper argument is passed.

==Example==

This examples checks if a player is attached to anything when they enter a console command:

<syntaxhighlight lang="lua">
-- add a command handler for 'amiattached' to call the function 'consoleIsPlayerAttached':
addCommandHandler ( "amiattached", "consoleIsPlayerAttached" )
function consoleIsPlayerAttached ( player, command )
if ( player ) then -- if a player triggered this command
local status = isElementAttached ( player ) -- call the function and store it's result in the 'status' variable
if ( status ) then -- if the function returned true, tell the player he is attached to something
outputConsole ( "You are attached to an element!", player )
else -- if the function returned false, tell the player he is not attached to anything
outputConsole ( "You are not attached to an element.", player )
end
end
end
</syntaxhighlight>

==See Also==

{{Element_functions}}
[[Category:Incomplete]] -- leave this unless you complete the function