GetElementChildren: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 14: Line 14:


==Example==  
==Example==  
In a blank map with nothing but players, using this function will return a table with all the players in it.
With this map file:
<syntaxhighlight lang="xml">
<team1 id="red">
<base name="Mountain Top" />
<base name="Docks" />
<base name="Airport" />
<anything name="no base" />
</team1>
</syntaxhighlight>
This example outputs the child elements of the element with id 'red', when the player enters the 'teamElements' command.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--Get root element
function showTeamElements(player,command)
root = getRootElement()
local team = getElementByID("red") -- get the team element
--Get ALL of root's children
local elements = getElementChildren(team) -- the the child elements
mytable = getElementChildren(root)
for k,v in ipairs(elements) do
outputChatBox(getElementType(v)..": "..getElementData(v,"name")) -- output text
end
end
addCommandHandler("teamElements",showTeamElements)
</syntaxhighlight>
</syntaxhighlight>
At a later point you could loop through all the elements and process thier contents any way you wish. Remember to make sure you have the CURRENT list of elements though. If you get the root element children, then wait a while for things to change, this list won't be up to date unless you use [[getElementChildren]] again.
At a later point you could loop through all the elements and process their contents any way you wish. Remember to make sure you have the CURRENT list of elements though. If you get the root element children, then wait a while for things to change, this list won't be up to date unless you use [[getElementChildren]] again.
==See Also==
==See Also==
{{Element_functions}}
{{Element_functions}}

Revision as of 12:36, 29 July 2007

This function is used to retreive a list of child elements as they appear in the element table. Without passing each element in the table through getElementType, you wont know what you have though.

Syntax

table getElementChildren ( element parent )

Required Arguments

  • parent: Supply this argument with the parent of the children you want returned.

Returns

This function returns a table that contains a list of elements that the parent has. If the element has no children, it will return an empy table. It will return false if the parent element does not exist.

Example

With this map file: 

<team1 id="red">
		<base name="Mountain Top" />
		<base name="Docks" />
		<base name="Airport" />
		<anything name="no base" />
 	</team1>

This example outputs the child elements of the element with id 'red', when the player enters the 'teamElements' command. 

function showTeamElements(player,command)
	local team = getElementByID("red") -- get the team element
	local elements = getElementChildren(team) -- the the child elements
	for k,v in ipairs(elements) do
		outputChatBox(getElementType(v)..": "..getElementData(v,"name")) -- output text
	end
end
addCommandHandler("teamElements",showTeamElements)

At a later point you could loop through all the elements and process their contents any way you wish. Remember to make sure you have the CURRENT list of elements though. If you get the root element children, then wait a while for things to change, this list won't be up to date unless you use getElementChildren again.

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetElementChildren?oldid=9287"