getElementByIndex | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

getElementByIndex

Client-side
Server-side
Shared

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

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

Important

If you wish to retrieve more than one element at a time, it is more efficient to use getElementsByType instead.

OOP Syntax Help! I don't understand this!

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

Syntax 

element getElementByIndex ( string theType, int index )
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

  • element: value

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

Code Examples

shared

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.

function showPlayer(command, index)
  local thePlayer = getElementByIndex("player", tonumber(index))
  if thePlayer then
    outputChatBox("Player " .. index .. " is a: " .. getPlayerName(thePlayer))
  else
    outputChatBox("Player not found.")
  end
end
addCommandHandler("player", showPlayer)

See Also

Element Functions
Element Events
Reference