GetElementChild: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 36: Line 36:
</syntaxhighlight>
</syntaxhighlight>


Note that if there are other child elements, you'd have to check whether the element is a base with the getElementType function. For example: 'teamBase 3' would output 'Team Base 3: Factory' with the .map file below, even though it's no base.
Note that if there are other child elements, you'd have to check whether the element is a base with the [[getElementType]] function. For example: 'teamBase 3' would output 'Team Base 3: Factory' with the .map file below, even though it's no base.


<syntaxhighlight lang="xml">
<syntaxhighlight lang="xml">

Revision as of 14:50, 15 August 2007

This function returns an element based on it's parent. Without passing it to getElementType you won't know what type of element do you have though.

Syntax

element getElementChild ( element parent, int index ) 

Required Arguments

  • parent: the element above the one to be returned in the hierarchy.
  • index: the element's index (0 for the first element, 1 for the second, etc).

Returns

Returns the requested element if it exists, or false if it doesn't.

Example

If the .map file containts:

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

This outputs the name of the specified base. For example: 'teamBase 0' for the first base.

function showTeamBase(player,command,index)
	local team = getElementByID("red") -- get the team element
	local base = getElementChild(team,tonumber(index)) -- get the Child of the element, based on the 'index' the player specified.
	if (base ~= false) then -- if a base exists
		outputChatBox("Team base "..index..": "..getElementData(base,"name"),player) -- output it to the player
	else
		outputChatBox("Base not found.",player)
	end
end
addCommandHandler("teamBase",showTeamBase)

Note that if there are other child elements, you'd have to check whether the element is a base with the getElementType function. For example: 'teamBase 3' would output 'Team Base 3: Factory' with the .map file below, even though it's no base.

<team1 id="red">
	<base name="Mountain Top" />
	<base name="Docks" />
	<base name="Airport" />
	<target name="Factory" />
</team1>

See Also