GetElementChildren - Revision history

Qaisjp: f

2015-01-01T03:29:15Z

← Older revision		Revision as of 03:29, 1 January 2015
Line 7:		Line 7:
	table getElementChildren ( element parent [, string theType = nil ] )		table getElementChildren ( element parent [, string theType = nil ] )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|~~This function is also a static function underneath the Element class.~~\|[[element]]:getChildren\|\|}}		{{OOP\|\|[[element]]:getChildren\|\|}}

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

Jaysds: /* Syntax */

2014-08-16T16:10:37Z

Syntax

← Older revision		Revision as of 16:10, 16 August 2014
Line 7:		Line 7:
	table getElementChildren ( element parent [, string theType = nil ] )		table getElementChildren ( element parent [, string theType = nil ] )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|This function is also a static function underneath the Element class.\|[[element]]:getChildren\|\|}}

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

Miki785: Cosmetic syntax change

2014-07-07T10:24:45Z

Cosmetic syntax change

← Older revision		Revision as of 10:24, 7 July 2014
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	table getElementChildren ( element parent, [ string theType = nil ] )		table getElementChildren ( element parent [, string theType = nil ] )
	</syntaxhighlight>		</syntaxhighlight>

Ccw at 04:01, 6 November 2013

2013-11-06T04:01:12Z

← Older revision		Revision as of 04:01, 6 November 2013
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	This function is used to retrieve a list of the child elements of a given parent element. Note that it will only return direct children and not elements that are further down the element tree.		This function is used to retrieve a list of the child elements of a given parent element. Note that it will only return direct children and not elements that are further down the [[element tree]].

	==Syntax==		==Syntax==

Ccw at 19:22, 19 August 2012

2012-08-19T19:22:07Z

← Older revision		Revision as of 19:22, 19 August 2012
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	This function is used to retrieve a list of the child elements of a given parent element.		This function is used to retrieve a list of the child elements of a given parent element. Note that it will only return direct children and not elements that are further down the element tree.

	==Syntax==		==Syntax==

Kevin whiteside: edit for bug 5051 to add optional argument

2012-01-26T17:57:08Z

edit for bug 5051 to add optional argument

← Older revision		Revision as of 17:57, 26 January 2012
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	table getElementChildren ( element parent )		table getElementChildren ( element parent, [ string theType = nil ] )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''parent:''' Supply this argument with the parent of the children you want returned.		*'''parent:''' Supply this argument with the parent of the children you want returned.

			===Optional Arguments===
			*'''theType:''' The type of element you want a list of. This is the same as the tag name in the .map file, so this can be used with a custom element type if desired. Built in types are:
			**'''"player":''' A player connected to the server
			**'''"ped":''' A ped
			**'''"water":''' A water polygon
			**'''"sound":''' A playing sound
			**'''"vehicle":''' A vehicle
			**'''"object":''' An object
			**'''"pickup":''' A pickup
			**'''"marker":''' A marker
			**'''"colshape":''' A collision shape
			**'''"blip":''' A blip
			**'''"radararea":''' A radar area
			**'''"team":''' A team
			**'''"spawnpoint":''' A spawnpoint
			**'''"remoteclient":''' A remote client connected to the server
			**'''"console":''' The server Console

	===Returns===		===Returns===

Arc at 19:50, 19 August 2007

2007-08-19T19:50:08Z

← Older revision		Revision as of 19:50, 19 August 2007
Line 26:		Line 26:
	This example outputs the child elements of the element with id 'red', when the player enters the 'teamElements' command.		This example outputs the child elements of the element with id 'red', when the player enters the 'teamElements' command.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function showTeamElements(~~player~~,command)		function showTeamElements(thePlayer, command)
	local ~~team~~ = getElementByID("red") -- get the team element		local theTeam = getElementByID("red") -- get the team element
	local elements = getElementChildren(~~team~~) -- the child elements		local elements = getElementChildren(theTeam) -- the child elements
	for k,v in ipairs(elements) do		for k,v in ipairs(elements) do
	outputChatBox(getElementType(v)..": "..getElementData(v, "name")) -- print the type and name of each child		outputChatBox(getElementType(v)..": "..getElementData(v, "name")) -- print the type and name of each child

Arc at 19:49, 19 August 2007

2007-08-19T19:49:32Z

← Older revision		Revision as of 19:49, 19 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	This function is used to retrieve a list of child elements ~~as they appear in the element table. Without passing each~~ element ~~in the table through [[getElementType]], you won't know what you have though~~.		This function is used to retrieve a list of the child elements of a given parent element.

	==Syntax==		==Syntax==
Line 27:		Line 27:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function showTeamElements(player,command)		function showTeamElements(player,command)
	local team = getElementByID("red") -- get the team element		local team = getElementByID("red") -- get the team element
	local elements = getElementChildren(team) -- the child elements		local elements = getElementChildren(team) -- the child elements
	for k,v in ipairs(elements) do		for k,v in ipairs(elements) do
	outputChatBox(getElementType(v)..": "..getElementData(v,"name")) -- print the type and name of each child		outputChatBox(getElementType(v)..": "..getElementData(v, "name")) -- print the type and name of each child
	end		end
	end		end
	addCommandHandler("teamElements",showTeamElements)		addCommandHandler("teamElements", showTeamElements)
	</syntaxhighlight>		</syntaxhighlight>
	At a later point you could loop through all the elements and process their 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.		At a later point you could loop through all the elements and process their contents any way you wish. Remember to make sure you only 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==		==See Also==
	{{Element_functions}}		{{Element_functions}}

Arc at 14:49, 15 August 2007

2007-08-15T14:49:22Z

← Older revision		Revision as of 14:49, 15 August 2007
Line 22:		Line 22:
	<base name="Airport" />		<base name="Airport" />
	<anything name="no base" />		<anything name="no base" />
	</team1>		</team1>
	</syntaxhighlight>		</syntaxhighlight>
	This example outputs the child elements of the element with id 'red', when the player enters the 'teamElements' command.		This example outputs the child elements of the element with id 'red', when the player enters the 'teamElements' command.

Arc at 14:49, 15 August 2007

2007-08-15T14:49:07Z

← Older revision		Revision as of 14:49, 15 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	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.		This function is used to retrieve a list of child elements as they appear in the element table. Without passing each element in the table through [[getElementType]], you won't know what you have though.

	==Syntax==		==Syntax==
Line 18:		Line 18:
	<syntaxhighlight lang="xml">		<syntaxhighlight lang="xml">
	<team1 id="red">		<team1 id="red">
	<base name="Mountain Top" />		<base name="Mountain Top" />
	<base name="Docks" />		<base name="Docks" />
	<base name="Airport" />		<base name="Airport" />
	<anything name="no base" />		<anything name="no base" />
	</team1>		</team1>
	</syntaxhighlight>		</syntaxhighlight>
	This example outputs the child elements of the element with id 'red', when the player enters the 'teamElements' command.		This example outputs the child elements of the element with id 'red', when the player enters the 'teamElements' command.
Line 28:		Line 28:
	function showTeamElements(player,command)		function showTeamElements(player,command)
	local team = getElementByID("red") -- get the team element		local team = getElementByID("red") -- get the team element
	local elements = getElementChildren(team) -- ~~the~~ the child elements		local elements = getElementChildren(team) -- the child elements
	for k,v in ipairs(elements) do		for k,v in ipairs(elements) do
	outputChatBox(getElementType(v)..": "..getElementData(v,"name")) -- ~~output text~~		outputChatBox(getElementType(v)..": "..getElementData(v,"name")) -- print the type and name of each child
	end		end
	end		end