GetRootElement: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(17 intermediate revisions by 10 users not shown)
Line 1: Line 1:
This function returns the root node for the element tree, called ''map''. This represents the ''map'' node at the root of the XML document that contains map data.
{{Server client function}}
__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]].
 
It is often used to attach handler functions to events triggered for any element, or also to make a scripting function affect all elements.
{{Note|All resources have a [[Predefined_variables_list|predefined global variable]] called ''root'' that has the root element as value. The variable exists server side as well as client side.}}


==Syntax==
==Syntax==
[[element]] [[getRootElement]] ()
<syntaxhighlight lang="lua">
element getRootElement ( )
</syntaxhighlight>
 
===Returns===
Returns the root [[element]].


==Example==
==Example==
root = [[getRootElement]] ()
This example will output the number of loaded resources by counting ''resource'' elements that are children of the ''root'' node.
version = [[getElementData]] ( root, "version" )
<syntaxhighlight lang="lua">
--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." )
</syntaxhighlight>
 
==See Also==
{{Element functions}}
[[hu:getRootElement]]
[[ru:getRootElement]]

Latest revision as of 16:52, 18 July 2018

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

Shared

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