GetElementByIndex: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Removed a line of example code that just said "if (". Removed tostring() around getVehicleName())
No edit summary
Line 17: Line 17:


==Example==  
==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.
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">
function showVehicle(player,command,index)
function showVehicle(thePlayer, command, index)
local vehicle = getElementByIndex("vehicle",tonumber(index))
local theVehicle = getElementByIndex("vehicle", tonumber(index))
if (vehicle ~= false) then
if theVehicle then
outputChatBox("Vehicle " .. index .. " is a: " .. getVehicleName(vehicle),player)
outputChatBox("Vehicle " .. index .. " is a: " .. getVehicleName(theVehicle), thePlayer)
else
else
outputChatBox("Vehicle not found.",player)
outputChatBox("Vehicle not found.", thePlayer)
end
end
end
end
addCommandHandler("vehicle",showVehicle)
addCommandHandler("vehicle", showVehicle)
</syntaxhighlight>
</syntaxhighlight>


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

Revision as of 19:36, 19 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 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=10738"