GetElementByIndex - Revision history

Blond6: Change example

2023-10-29T19:26:56Z

Change example

← Older revision		Revision as of 19:26, 29 October 2023
Line 17:		Line 17:

	==Example==		==Example==
	This example ~~outputs~~ the name of the specified ~~vehicle currently existent in~~ the ~~XML tree~~. For example: '~~vehicle~~ 0' would return the first ~~vehicle~~.		This example generates the name of the specified player that is on the server. For example: 'player 0' would return the name of the first player on the server.
	<syntaxhighlight lang="lua~~" class="server~~">		<syntaxhighlight lang="lua">
	function ~~showVehicle~~(~~thePlayer,~~ command, index)		function showPlayer(command, index)
	local ~~theVehicle~~ = getElementByIndex("~~vehicle~~", tonumber(index))		local thePlayer = getElementByIndex("player", tonumber(index))
	if ~~theVehicle~~ then		if thePlayer then
	outputChatBox("~~Vehicle~~ " .. index .. " is a: " .. ~~getVehicleName~~(~~theVehicle~~)~~, thePlayer~~)		outputChatBox("Player " .. index .. " is a: " .. getPlayerName(thePlayer))
	else		else
	outputChatBox("~~Vehicle~~ not found."~~, thePlayer~~)		outputChatBox("Player not found.")
	end		end
	end		end
	addCommandHandler("~~vehicle~~", ~~showVehicle~~)		addCommandHandler("player", showPlayer)
	</syntaxhighlight>		</syntaxhighlight>

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

2023-10-29T19:23:39Z

Fix class

← Older revision		Revision as of 19:23, 29 October 2023
Line 18:		Line 18:
	==Example==		==Example==
	This example outputs the name of the specified vehicle currently existent in the XML tree. For example: 'vehicle 0' would return the first vehicle.		This example outputs the name of the specified vehicle currently existent in the XML tree. For example: 'vehicle 0' would return the first vehicle.
	<syntaxhighlight lang="lua" class="server>		<syntaxhighlight lang="lua" class="server">
	function showVehicle(thePlayer, command, index)		function showVehicle(thePlayer, command, index)
	local theVehicle = getElementByIndex("vehicle", tonumber(index))		local theVehicle = getElementByIndex("vehicle", tonumber(index))

2023-10-29T19:22:47Z

Add class to example

← Older revision		Revision as of 19:22, 29 October 2023
Line 18:		Line 18:
	==Example==		==Example==
	This example outputs the name of the specified vehicle currently existent in the XML tree. For example: 'vehicle 0' would return the first vehicle.		This example outputs the name of the specified vehicle currently existent in the XML tree. For example: 'vehicle 0' would return the first vehicle.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua" class="server>
	function showVehicle(thePlayer, command, index)		function showVehicle(thePlayer, command, index)
	local theVehicle = getElementByIndex("vehicle", tonumber(index))		local theVehicle = getElementByIndex("vehicle", tonumber(index))

2023-10-29T19:19:35Z

Change type function

← Older revision		Revision as of 19:19, 29 October 2023
Line 1:		Line 1:
	__NOTOC__ {{Important Note\|If you wish to retrieve more than one element at a time, it is more efficient to use [[getElementsByType]] instead.}}		__NOTOC__ {{Important Note\|If you wish to retrieve more than one element at a time, it is more efficient to use [[getElementsByType]] instead.}}
	{{Server function}}		{{Server client function}}
	This function returns an element of the specified type with the specified index.		This function returns an element of the specified type with the specified index.

2019-09-07T08:32:06Z

improve note

← Older revision		Revision as of 08:32, 7 September 2019
Line 1:		Line 1:
	__NOTOC__ {{Note\|~~It is important to note that if~~ you wish to retrieve more than one element at a time, it is more efficient to use [[getElementsByType]] instead.}}		__NOTOC__ {{Important Note\|If you wish to retrieve more than one element at a time, it is more efficient to use [[getElementsByType]] instead.}}
	{{Server function}}		{{Server function}}
	This function returns an element of the specified type with the specified index.		This function returns an element of the specified type with the specified index.

2019-09-07T08:31:17Z

← Older revision		Revision as of 08:31, 7 September 2019
Line 1:		Line 1:
	__NOTOC__		__NOTOC__ {{Note\|It is important to note that if you wish to retrieve more than one element at a time, it is more efficient to use [[getElementsByType]] instead.}}
	{{Note\|It is important to note that if you wish to retrieve more than one element at a time, it is more efficient to use [[getElementsByType]] instead.}}
	{{Server function}}		{{Server function}}
	This function returns an element of the specified type with the specified index.		This function returns an element of the specified type with the specified index.

2019-09-07T08:31:10Z

prefer normal note

← Older revision		Revision as of 08:31, 7 September 2019
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Note ~~box~~\|It is important to note that if you wish to retrieve more than one element at a time, it is more efficient to use [[getElementsByType]] instead.}}		{{Note\|It is important to note that if you wish to retrieve more than one element at a time, it is more efficient to use [[getElementsByType]] instead.}}
	{{Server function}}		{{Server function}}
	This function returns an element of the specified type with the specified index.		This function returns an element of the specified type with the specified index.

2014-09-13T11:19:15Z

fix oop

← Older revision		Revision as of 11:19, 13 September 2014
Line 8:		Line 8:
	element getElementByIndex ( string theType, int index )		element getElementByIndex ( string theType, int index )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|This function is ~~also~~ a static function ~~underneath~~ the Element class.\|[[~~element~~]]:getByIndex\|\|}}		{{OOP\|This function is a static function inside the Element class.\|[[Element]].getByIndex\|\|}}

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

2014-08-16T16:09:42Z

Syntax: OOP

← Older revision		Revision as of 16:09, 16 August 2014
Line 8:		Line 8:
	element getElementByIndex ( string theType, int index )		element getElementByIndex ( string theType, int index )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|This function is also a static function underneath the Element class.\|[[element]]:getByIndex\|\|}}

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

2012-10-04T19:53:59Z

← Older revision		Revision as of 19:53, 4 October 2012
Line 6:		Line 6:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	element getElementByIndex ( string ~~type~~, int index )		element getElementByIndex ( string theType, int index )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''~~type~~:''' the type of the element to be returned. Examples include "player", "vehicle", or a custom type.		*'''theType:''' the type of the element to be returned. Examples include "player", "vehicle", or a custom type.
	*'''index:''' the element's index (0 for the first element, 1 for the second, etc).		*'''index:''' the element's index (0 for the first element, 1 for the second, etc).