GetRootElement: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Updated description, replaced example)
No edit summary
Line 1: Line 1:
{{Server client function}}
__NOTOC__
__NOTOC__
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]].
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]].
Line 25: Line 26:
end
end


outputChatBox( "There are "..resourceCount.." loaded resources." )
outputChatBox( "There are " .. resourceCount .. " loaded resources." )
</syntaxhighlight>
</syntaxhighlight>


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

Revision as of 19:42, 17 August 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


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