GetElementChild - Revision history

Qaisjp: |

2015-01-01T03:29:29Z

← Older revision		Revision as of 03:29, 1 January 2015
Line 6:		Line 6:
	element getElementChild ( element parent, int index )		element getElementChild ( element parent, int index )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|~~This function is also a static function underneath the Element class.~~\|[[element]]:getChild\|\|}}		{{OOP\|\|[[element]]:getChild\|\|}}

	===Required Arguments===		===Required Arguments===

Jaysds: /* Syntax */ OOP

2014-08-16T16:10:11Z

Syntax: OOP

← Older revision		Revision as of 16:10, 16 August 2014
Line 6:		Line 6:
	element getElementChild ( element parent, int index )		element getElementChild ( element parent, int index )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|This function is also a static function underneath the Element class.\|[[element]]:getChild\|\|}}

	===Required Arguments===		===Required Arguments===

Arc at 19:45, 19 August 2007

2007-08-19T19:45:56Z

← Older revision		Revision as of 19:45, 19 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}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~~.		{{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">
Line 11:		Line 12:

	===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==
	If the .map file ~~containts~~:		If the .map file contains:
	<syntaxhighlight lang="xml">		<syntaxhighlight lang="xml">
	<team1 id="red">		<team1 id="red">
Line 24:		Line 25:
	This outputs the name of the specified base. For example: 'teamBase 0' for the first base.		This outputs the name of the specified base. For example: 'teamBase 0' for the first base.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function showTeamBase(~~player~~,command,index)		function showTeamBase(thePlayer, command, index)
	local ~~team~~ = getElementByID("red") -- get the team element		local theTeam = 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.		local base = getElementChild(theTeam, tonumber(index)) -- get the Child of the element, based on the 'index' the player specified.
	if (base ~= false) then -- if a base exists		if (base ~= false) then -- if the base exists
	outputChatBox("Team base "..index..": "..getElementData(base,"name"),~~player~~) -- output it to the player		outputChatBox("Team base " .. index .. ": " .. getElementData(base, "name"), thePlayer) -- output it to the player
	else		else
	outputChatBox("Base not found.",~~player~~)		outputChatBox("Base not found.", thePlayer)
	end		end
	end		end
	addCommandHandler("teamBase",showTeamBase)		addCommandHandler("teamBase", showTeamBase)
	</syntaxhighlight>		</syntaxhighlight>

Arc at 14:50, 15 August 2007

2007-08-15T14:50:13Z

← Older revision		Revision as of 14:50, 15 August 2007
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">

Arc at 14:43, 15 August 2007

2007-08-15T14:43:33Z

← Older revision		Revision as of 14:43, 15 August 2007
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. For example: 'teamBase 3' would output 'Team Base 3: Factory' with the .map file below, 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">

Driver2 at 12:05, 29 July 2007

2007-07-29T12:05:57Z

← Older revision		Revision as of 12:05, 29 July 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}This function returns an element based on it's parent.		{{Server client function}}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==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 14:		Line 14:

	==Example==		==Example==
	~~To spawn a player at~~ the ~~red team's third spawnpoint~~:		If the .map file containts:
	<syntaxhighlight lang="xml">		<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~~"/>		</team1>
	~~</team1>~~</syntaxhighlight>		</syntaxhighlight>
			This outputs the name of the specified base. For example: 'teamBase 0' for the first base.
			<syntaxhighlight lang="lua">
			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)
			</syntaxhighlight>

	~~You could use~~ the ~~following code~~:		Note that if there are other child elements, you'd have to check whether the element is a base. For example: 'teamBase 3' would output 'Team Base 3: Factory' with the .map file below, though it's no base.
	<syntaxhighlight lang="~~lua~~">
	~~teamRed~~ = ~~getElementByID (~~ "red" ~~) -- find the parent element by it's ID and assign it to teamRed variable~~		<syntaxhighlight lang="xml">
	~~teamRedSpawn~~ = ~~getElementChild ( teamRed, 2 ) -- find teamRed's third child element (which happens to be a spawnpoint)~~		<team1 id="red">
	~~spawnPlayer ( somePlayer, teamRedSpawn ) -- spawn a player at the spawnpoint~~		<base name="Mountain Top" />
			<base name="Docks" />
			<base name="Airport" />
			<target name="Factory" />
			</team1>
	</syntaxhighlight>		</syntaxhighlight>

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

EAi at 00:04, 9 March 2007

2007-03-09T00:04:58Z

← Older revision		Revision as of 00:04, 9 March 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}This function returns an element based on it's parent.		{{Server client function}}This function returns an element based on it's parent.




	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

EAi at 00:02, 9 March 2007

2007-03-09T00:02:01Z

← Older revision		Revision as of 00:02, 9 March 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}This function returns an element based on it's parent.		{{Server client function}}This function returns an element based on it's parent.




	==Syntax==		==Syntax==

EAi at 00:01, 9 March 2007

2007-03-09T00:01:12Z

← Older revision		Revision as of 00:01, 9 March 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	This function returns an element based on it's parent.		{{Server client function}}This function returns an element based on it's parent.

	==Syntax==		==Syntax==

EAi at 02:05, 4 September 2006

2006-09-04T02:05:46Z

← Older revision		Revision as of 02:05, 4 September 2006
Line 16:		Line 16:
	==Example==		==Example==
	To spawn a player at the red team's third spawnpoint:		To spawn a player at the red team's third spawnpoint:
	<syntaxhighlight lang="~~lua~~">		<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"/>		<spawnpoint id="spawnpoint_0" posX="2507.8715820313" posY="2772.6071777344" posZ="10.8203125" rot="270" skin="285"/>