GetRootElement: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 17: Line 17:
This example will output the number of loaded resources by counting ''resource'' elements that are children of the ''root'' node.
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">
local root = getRootElement()
--By default, predefined variable 'root' is getRootElement()
local rootChildren = getElementChildren( root )
local rootChildren = getElementChildren( root )


Revision as of 16:19, 19 August 2015

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.

[[{{{image}}}|link=|]] Note: All resources have a predefined global variable called root that has the root element as value. The variable exists server side as well as client side.

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. 

--By default, predefined variable 'root' is 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

Retrieved from "https://wiki.multitheftauto.com/wiki/GetRootElement?oldid=45757"