GetElementByIndex: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
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 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.}}
{{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.  


Revision as of 21:45, 4 August 2007

This template is no longer in use as it results in poor readability. This function returns an element of the specified type with the specified index.

Syntax

element getElementByIndex ( string type, int index )

Required Arguments

  • type: 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).

Returns

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

Example

This example outputs the name of the specified vehicle currently existant in the XML tree. For example: 'vehicle 0' would return the first vehicle. 

function showVehicle(player,command,index)
	if (
	local vehicle = getElementByIndex("vehicle",tonumber(index))
	if (vehicle ~= false) then
		outputChatBox("Vehicle "..index.." is a: "..tostring(getVehicleName(vehicle)),player)
	else
		outputChatBox("Vehicle not found.",player)
	end
end
addCommandHandler("vehicle",showVehicle)

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetElementByIndex?oldid=9815"