GetElementsByType: Difference between revisions

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


==Syntax==  
==Syntax==  
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
table getElementsByType ( string theType, [ element startat=getRootElement() ] )  
table getElementsByType ( string theType, [ element startat=getRootElement() ] )  
</syntaxhighlight>  
</syntaxhighlight>
</section>
 
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
table getElementsByType ( string theType, [ element startat=getRootElement(), bool streamedIn=false ] )
</syntaxhighlight>
</section>
 


===Required Arguments===  
===Required Arguments===  
Line 25: Line 34:
**'''"remoteclient":''' A remote client connected to the server
**'''"remoteclient":''' A remote client connected to the server
**'''"console":''' The server Console
**'''"console":''' The server Console


==Optional Arguments==
==Optional Arguments==
{{OptionalArg}}
{{OptionalArg}}
*'''startat:''' The [[element]] the search should start at. Children of this element are searched, siblings or parents will not be found. By default, this is the root element which should suit most uses.
*'''startat:''' The [[element]] the search should start at. Children of this element are searched, siblings or parents will not be found. By default, this is the root element which should suit most uses.
<section name="Client" class="client" show="true">
*'''streamedIn:''' If true, function will only return elements that are streamed in.
</section>
<span style="color: #FFF"> (PS: lil_Toady is a commie) </span>


===Returns===
===Returns===

Revision as of 22:13, 25 February 2010

This function is used to retrieve a list of all elements of the specified type. This can be useful, as it disregards where in the element tree it is. It can be used with either the built in types (listed below) or with any custom type used in a .map file. For example, if there is an element of type "flag" (e.g. <flag />) in the .map file, the using "flag" as the type argument would find it.

Syntax

Click to collapse [-]
Server
table getElementsByType ( string theType, [ element startat=getRootElement() ] ) 
Click to collapse [-]
Client
table getElementsByType ( string theType, [ element startat=getRootElement(), bool streamedIn=false ] ) 


Required Arguments

  • theType: The type of element you want a list of. This is the same as the tag name in the .map file, so this can be used with a custom element type if desired. Built in types are:
    • "player": A player connected to the server
    • "ped": A ped
    • "water": A water polygon
    • "sound": A playing sound
    • "vehicle": A vehicle
    • "object": An object
    • "pickup": A pickup
    • "marker": A marker
    • "colshape": A 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


Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • startat: The element the search should start at. Children of this element are searched, siblings or parents will not be found. By default, this is the root element which should suit most uses.
Click to collapse [-]
Client
  • streamedIn: If true, function will only return elements that are streamed in.

(PS: lil_Toady is a commie)

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 ipairs(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 ( getPlayerName ( thePlayer ) .. " is in a vehicle" )
   else -- if the player isn't in a vehicle, announce that he/she is on foot
      outputChatBox ( getPlayerName ( thePlayer ) .. " is on foot" )
   end
end

See Also