GetElementByIndex: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Add class to example)
(Fix class)
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))

Revision as of 19:23, 29 October 2023

[[{{{image}}}|link=|]] Important Note: If you wish to retrieve more than one element at a time, it is more efficient to use getElementsByType instead.

This function returns an element of the specified type with the specified index.

Syntax

element getElementByIndex ( string theType, int index )

OOP Syntax Help! I don't understand this!

Note: This function is a static function inside the Element class.
Method: Element.getByIndex(...)


Required Arguments

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

Returns

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

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. 

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

See Also


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