GetElementChildrenCount: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (Grammar fixes)
Line 26: Line 26:
You could use the following code:
You could use the following code:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
local teamRed = getElementByID("red") -- find the parent element by it's ID
local teamRed = getElementByID("red") -- find the parent element by its ID
local count = getElementChildrenCount (teamRed) -- get the total number of children
local count = getElementChildrenCount (teamRed) -- get the total number of children
outputChatBox("Team red has " .. count .. " spawnpoints") -- output: Team red has 4 spawnpoints
outputChatBox("Team red has " .. count .. " spawnpoints") -- output: Team red has 4 spawnpoints
</syntaxhighlight>
</syntaxhighlight>


Note that this does not only counts spawnpoint elements, but all child elements. Thus if you would have other child elements, the message would be wrong.
Note that this does not only count spawnpoint elements, but all child elements. Thus if there would be child elements of other types, the message would be wrong and you'd have to loop through the children manually, checking the type of each.


==See Also==
==See Also==
{{Element_functions}}
{{Element_functions}}

Revision as of 14:52, 15 August 2007

This function returns the number of children an element has.

Syntax

int getElementChildrenCount ( element parent )

Required Arguments

  • parent: the parent element

Returns

Returns an int with the number of child elements, or false if the parent element does not exist.

Example

To get the number of children the 'team1' element has:

<team1 id="red">
    <spawnpoint id="spawnpoint_0" posX="2507.8715820313" posY="2772.6071777344" posZ="10.8203125" rot="270" skin="285"/>
    <spawnpoint id="spawnpoint_1" posX="2508.060546875" posY="2780.3647460938" posZ="10.8203125" rot="270" skin="285"/>
    <spawnpoint id="spawnpoint_2" posX="2508.0053710938" posY="2776.2897949219" posZ="10.8203125" rot="270" skin="285"/>
    <spawnpoint id="spawnpoint_3" posX="2510.6899414063" posY="2778.3745117188" posZ="10.8203125" rot="270" skin="285"/>
</team1>

You could use the following code:

local teamRed = getElementByID("red") -- find the parent element by its ID
local count = getElementChildrenCount (teamRed) -- get the total number of children
outputChatBox("Team red has " .. count .. " spawnpoints") -- output: Team red has 4 spawnpoints

Note that this does not only count spawnpoint elements, but all child elements. Thus if there would be child elements of other types, the message would be wrong and you'd have to loop through the children manually, checking the type of each.

See Also