GetElementByIndex

From Multi Theft Auto: Wiki
Revision as of 00:37, 30 August 2006 by EAi (talk | contribs) (→‎Example)
Jump to navigation Jump to search

This function returns an element of the specified type from 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 loops through each player and sends them a message. A more efficient method would be to use getElementsByType.

totalplayers = getPlayerCount () -- get the amount of players in the server
local i = 0
while ( i < totalplayers ) do -- step through each player, from 0 to total
  pyr = getElementByIndex ( "player", i ) -- get a player element from index and assign it to variable pyr
  outputChatBox ( "Hello " .. getClientName ( pyr ) .. "!", pyr ) -- send player pyr a message
  i = i + 1
end

See Also