GetRootElement: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
(Updated description, replaced example) |
||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
This function returns the root node | This function returns the root node of the [[element tree]], called ''root''. This node contains every other element: all resource root elements, players and remote clients. It is never destroyed and cannot be destroyed using [[destroyElement]]. | ||
It is often used to attach handler functions to events triggered for any element, or also to make a scripting function affect all elements. | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
element getRootElement ( | element getRootElement ( ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===Returns=== | ===Returns=== | ||
Returns the root [[element]] | Returns the root [[element]]. | ||
==Example== | ==Example== | ||
This example will | This example will output the number of loaded resources by counting ''resource'' elements that are children of the ''root'' node. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
root = getRootElement () | local root = getRootElement() | ||
local rootChildren = getElementChildren( root ) | |||
local resourceCount = 0 | |||
for k, child in ipairs( rootChildren ) do | |||
if getElementType( child ) == "resource" then | |||
resourceCount = resourceCount + 1 | |||
end | |||
end | |||
outputChatBox( "There are "..resourceCount.." loaded resources." ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Element functions}} | {{Element functions}} |
Revision as of 16:16, 31 July 2007
This function returns the root node of the element tree, called root. This node contains every other element: all resource root elements, players and remote clients. It is never destroyed and cannot be destroyed using destroyElement.
It is often used to attach handler functions to events triggered for any element, or also to make a scripting function affect all elements.
Syntax
element getRootElement ( )
Returns
Returns the root element.
Example
This example will output the number of loaded resources by counting resource elements that are children of the root node.
local root = getRootElement() local rootChildren = getElementChildren( root ) local resourceCount = 0 for k, child in ipairs( rootChildren ) do if getElementType( child ) == "resource" then resourceCount = resourceCount + 1 end end outputChatBox( "There are "..resourceCount.." loaded resources." )
See Also
- attachElements
- createElement
- destroyElement
- detachElements
- getAttachedElements
- getElementAlpha
- getElementAttachedOffsets
- getElementAttachedTo
- getElementByIndex
- getElementByID
- getElementChild
- getElementChildren
- getElementChildrenCount
- getElementCollisionsEnabled
- getElementColShape
- getElementData
- getAllElementData
- hasElementData
- getElementDimension
- getElementHealth
- getElementID
- getElementInterior
- getElementMatrix
- getElementModel
- getElementParent
- getElementPosition
- getElementRotation
- getElementsByType
- getElementsWithinColShape
- getElementsWithinRange
- getElementType
- getElementVelocity
- getLowLODElement
- getRootElement
- isElement
- isElementAttached
- isElementCallPropagationEnabled
- isElementDoubleSided
- isElementFrozen
- isElementInWater
- isElementLowLOD
- isElementWithinColShape
- isElementWithinMarker
- setElementAlpha
- setElementAngularVelocity
- getElementAngularVelocity
- setElementAttachedOffsets
- setElementCallPropagationEnabled
- setElementCollisionsEnabled
- setElementData
- setElementDimension
- setElementDoubleSided
- setElementFrozen
- setElementHealth
- setElementID
- setElementInterior
- setElementModel
- setElementParent
- setElementPosition
- setElementRotation
- setElementVelocity
- setLowLODElement
- getPedContactElement
- getResourceDynamicElementRoot
- getResourceRootElement