GetElementByIndex: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 17: | Line 17: | ||
==Example== | ==Example== | ||
This example | This example loops through each player and sends them a message. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
totalplayers = getPlayerCount () -- get the amount of players in the server | totalplayers = getPlayerCount () -- get the amount of players in the server | ||
local i = 0 | local i = 0 | ||
while ( i < totalplayers ) do -- step through | 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 | pyr = getElementByIndex ( "player", i ) -- get a player element from index and assign it to variable pyr | ||
outputChatBox ( "Hello " .. getPlayerName ( pyr ) .. "!", pyr ) | outputChatBox ( "Hello " .. getPlayerName ( pyr ) .. "!", pyr ) -- send player pyr a message | ||
i = i + 1 | i = i + 1 | ||
end | end | ||
Revision as of 11:35, 2 June 2006
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.
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 " .. getPlayerName ( pyr ) .. "!", pyr ) -- send player pyr a message i = i + 1 end