GetElementsByType: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 25: Line 25:


==Example==  
==Example==  
TODO: add an example here.
This example retrieves a table of the players in the server, and checks whether or not each one is in a vehicle:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
Add example here...
local players = getElementsByType ( "player" ) -- get a table of all the players in the server
for theKey,thePlayer in players do -- use a generic for loop to step through each player
  if ( isPlayerInVehicle ( thePlayer ) ) then -- if the player is in a vehicle, announce it
      outputChatBox ( getClientName ( thePlayer ) .. " is in a vehicle" )
  else -- if the player isn't in a vehicle, announce that he/she is on foot
      outputChatBox ( getClientName ( thePlayer ) .. " is on foot" )
  end
end
</syntaxhighlight>
</syntaxhighlight>


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

Revision as of 04:10, 2 September 2006


This function is used to retreive a list of all elemets of the specified type. This can be useful, as it disregards where in the element table it is in the element heirarchy.

Syntax

table getElementsByType ( string type )

Required Arguments

  • type: The type of element you want a list of. This can be any one of the following ten things MTA is programmed to understand:
    • "player": A player connected to the server
    • "vehicle":: A vehicle
    • "object": An object
    • "pickup": A pickup
    • "blip": A blip
    • "marker": A marker
    • "spawnpoint": A spawnpoint
    • "remoteclient": A remote client connected to the server
    • "console": The server Console
    • "unknown": Unknown element type

Returns

Returns a table containing all the elements of the specified type. Returns an empty table if there are no elements of the specified type. Returns false if the string specified is invalid (or not a string).

Example

This example retrieves a table of the players in the server, and checks whether or not each one is in a vehicle: 

local players = getElementsByType ( "player" ) -- get a table of all the players in the server
for theKey,thePlayer in players do -- use a generic for loop to step through each player
   if ( isPlayerInVehicle ( thePlayer ) ) then -- if the player is in a vehicle, announce it
      outputChatBox ( getClientName ( thePlayer ) .. " is in a vehicle" )
   else -- if the player isn't in a vehicle, announce that he/she is on foot
      outputChatBox ( getClientName ( thePlayer ) .. " is on foot" )
   end
end

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetElementsByType?oldid=4613"