GetElementChild: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (|)
 
(9 intermediate revisions by 4 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
This function returns an element based on it's parent.
{{Server client function}}
 
This function returns one of the child elements of a given parent element. The child element is selected by its index (0 for the first child, 1 for the second and so on).
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
element getElementChild ( element parent, int index )  
element getElementChild ( element parent, int index )  
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP||[[element]]:getChild||}}


===Required Arguments===  
===Required Arguments===  
Line 12: Line 13:


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


==Example==
==Example==
To spawn a player at the red team's third spawnpoint:
If the .map file contains:
<syntaxhighlight lang="xml">
<team1 id="red">
<base name="Mountain Top" />
<base name="Docks" />
<base name="Airport" />
</team1>
</syntaxhighlight>
This outputs the name of the specified base. For example: 'teamBase 0' for the first base.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function showTeamBase(thePlayer, command, index)
local theTeam = getElementByID("red")                  -- get the team element
local base = getElementChild(theTeam, tonumber(index))  -- get the Child of the element, based on the 'index' the player specified.
if (base ~= false) then                                -- if the base exists
outputChatBox("Team base " .. index .. ": " .. getElementData(base, "name"), thePlayer)  -- output it to the player
else
outputChatBox("Base not found.", thePlayer)
end
end
addCommandHandler("teamBase", showTeamBase)
</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.
<syntaxhighlight lang="xml">
<team1 id="red">
<team1 id="red">
    <spawnpoint id="spawnpoint_0" posX="2507.8715820313" posY="2772.6071777344" posZ="10.8203125" rot="270" skin="285"/>
<base name="Mountain Top" />
    <spawnpoint id="spawnpoint_1" posX="2508.060546875" posY="2780.3647460938" posZ="10.8203125" rot="270" skin="285"/>
<base name="Docks" />
    <spawnpoint id="spawnpoint_2" posX="2508.0053710938" posY="2776.2897949219" posZ="10.8203125" rot="270" skin="285"/>
<base name="Airport" />
    <spawnpoint id="spawnpoint_3" posX="2510.6899414063" posY="2778.3745117188" posZ="10.8203125" rot="270" skin="285"/>
<target name="Factory" />
</team1></syntaxhighlight>
</team1>
 
You could use the following code:
<syntaxhighlight lang="lua">
teamRed = getElementByID ( "red" ) -- find the parent element by it's ID and assign it to teamRed variable
teamRedSpawn = getElementChild ( teamRed, 2 ) -- find teamRed's third child element (which happens to be a spawnpoint)
spawnPlayer ( somePlayer, teamRedSpawn ) -- spawn a player at the spawnpoint
</syntaxhighlight>
</syntaxhighlight>


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

Latest revision as of 03:29, 1 January 2015

This function returns one of the child elements of a given parent element. The child element is selected by its index (0 for the first child, 1 for the second and so on).

Syntax

element getElementChild ( element parent, int index )

OOP Syntax Help! I don't understand this!

Method: element:getChild(...)


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 contains: 

<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(thePlayer, command, index)
	local theTeam = getElementByID("red")                   -- get the team element
	local base = getElementChild(theTeam, tonumber(index))  -- get the Child of the element, based on the 'index' the player specified.
	if (base ~= false) then                                 -- if the base exists
		outputChatBox("Team base " .. index .. ": " .. getElementData(base, "name"), thePlayer)  -- output it to the player
	else
		outputChatBox("Base not found.", thePlayer)
	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


Retrieved from "https://wiki.multitheftauto.com/wiki/GetElementChild?oldid=43625"