GetElementsByType

From Multi Theft Auto: Wiki
Revision as of 06:47, 11 December 2006 by Erorr404 (talk | contribs) (→‎Syntax: added element type)
Jump to navigation Jump to search
Dialog-information.png This article needs checking.
Reason(s): Is it compatible with colshape, textdisplay, and textitem elements? Erorr404


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 things MTA is programmed to understand:
    • "player": A player connected to the server
    • "vehicle":: A vehicle
    • "object": An object
    • "pickup": A pickup
    • "marker": A marker
    • "colcube": A cube collision shape
    • "blip": A blip
    • "radararea": A radar area
    • "team": A team
    • "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=6712"