GetElementChildren: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
[[Category:Incomplete]]
__NOTOC__  
__NOTOC__  
This fake function is for use with blah & blah and does blahblahblabhalbhl
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==  
==Syntax==  
Line 10: Line 8:


===Required Arguments===  
===Required Arguments===  
*'''argumentName:''' description
*'''parent:''' Supply this argument with the parent of the children you want returned.
 
===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' description
*'''argumentName3:''' description


===Returns===
===Returns===
Returns ''true'' if blah, ''false'' otherwise.
This function returns a ''table'' that contains a list of elements that the parent has.


==Example==  
==Example==  
This example does...
In a blank map with nothing but players, using this function will return a table with all the players in it.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
--Get root element
blabhalbalhb --abababa
root = getRootElement()
--This line does this...
--Get ALL of root's children
mooo
mytable = getElementChildren(root)
</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.
==See Also==
==See Also==
{{FunctionArea_Functions}}
{{Element_functions}}

Revision as of 17:02, 21 August 2006

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.

Example

In a blank map with nothing but players, using this function will return a table with all the players in it. 

--Get root element
root = getRootElement()
--Get ALL of root's children
mytable = getElementChildren(root)

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.

See Also


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