GetElementChildren: Difference between revisions

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


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


==Example==  
==Example==  

Revision as of 17:09, 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. If the element has no children, it will return false. It will also return false if the parent element does not exist.

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