DetachElements - Revision history

Walid: Fix oop syntax

2016-08-06T13:49:57Z

Fix oop syntax

← Older revision		Revision as of 13:49, 6 August 2016
Line 7:		Line 7:
	bool detachElements ( element theElement, [ element theAttachToElement ] )		bool detachElements ( element theElement, [ element theAttachToElement ] )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[element]]:detach\|\|}}		{{OOP\|\|[[element]]:detach\|\|attachElements}}

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

Qaisjp: fix oop syntax

2015-01-01T22:42:23Z

fix oop syntax

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

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

Jaysds: /* Syntax */

2014-08-16T16:04:03Z

Syntax

← Older revision		Revision as of 16:04, 16 August 2014
Line 7:		Line 7:
	bool detachElements ( element theElement, [ element theAttachToElement ] )		bool detachElements ( element theElement, [ element theAttachToElement ] )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|This function is also a static function underneath the Element class.\|[[element]]:detach\|\|}}

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

Awwu: New page: NOTOC {{Server client function}} This function detaches attached elements from one another. ==Syntax== bool detachElements ( element theElement, [ element theAttachToEl...

2009-03-26T18:50:28Z

New page: __NOTOC__ {{Server client function}} This function detaches attached elements from one another. ==Syntax== <syntaxhighlight lang="lua"> bool detachElements ( element theElement, [ element theAttachToEl...

New page

__NOTOC__
{{Server client function}}
This function detaches attached elements from one another.

==Syntax==
<syntaxhighlight lang="lua">
bool detachElements ( element theElement, [ element theAttachToElement ] )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The element to be detached (the "child")

===Optional Arguments===
{{OptionalArg}}
*'''theAttachToElement:''' The element you wish to detach from, will detach from the attached element if this isn't specified.

===Returns===
Returns ''true'' if the detaching was successful, ''false'' otherwise.

==Example==
'''Example 1:''' This example attaches a marker to a vehicle, and detaches it when it blows up:
<syntaxhighlight lang="lua">
function attachMarkerToVehicle ( theVehicle )
-- create the marker to attach
local arrowMarker = createMarker ( 0, 0, 0, "arrow", 1.5, 0, 0, 255, 255 )
-- attach the marker above the vehicle
attachElements ( arrowMarker, theVehicle, 0, 0, 2 )
-- add an event handler for when the vehicle blows up
addEventHandler ( "onVehicleExplode", theVehicle, onMarkedCarExplode )
end

function onMarkedCarExplode ()
-- get the elements attached to the vehicle
local attachedElements = getAttachedElements ( source )
-- loop through the table of elements
for i,v in ipairs ( attachedElements ) do
-- detach the element from the vehicle
detachElements ( v, source )
end
-- remove the event handler
removeEventHandler ( "onVehicleExplode", source, onMarkedCarExplode )
end
</syntaxhighlight>
'''Example 2:''' This function will detach any elements that might have been attached to the passed element:
<syntaxhighlight lang="lua">
function freeElement( theElement )
if ( isElementAttached( theElement ) ) then -- If the specified element is attached to something
detachElements ( theElement ) -- Detach it.
else
outputChatBox( "Element is not attached" ) -- If not, say it wasn't attached in the first place.
end
end
</syntaxhighlight>

==See Also==
{{Element functions}}

DetachElements - Revision history

Walid: Fix oop syntax

Qaisjp: fix oop syntax

Jaysds: /* Syntax */

Awwu: New page: __NOTOC__ {{Server client function}} This function detaches attached elements from one another. ==Syntax== bool detachElements ( element theElement, [ element theAttachToEl...

Awwu: New page: NOTOC {{Server client function}} This function detaches attached elements from one another. ==Syntax== bool detachElements ( element theElement, [ element theAttachToEl...