GetElementsByType: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
[[category:incomplete]]
[[category:incomplete]]
__NOTOC__  
__NOTOC__  
This fake function is for use with blah & blah and does blahblahblabhalbhl
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==  
==Syntax==  
Line 9: Line 9:


===Required Arguments===  
===Required Arguments===  
*'''argumentName:''' description
*'''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
===Optional Arguments===
**'''"vehicle":''': A vehicle
{{OptionalArg}}
**'''"object":''' An object
*'''argumentName2:''' descriptiona
**'''"pickup":''' A pickup
*'''argumentName3:''' description
**'''"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===
Returns ''true'' if blah, ''false'' otherwise.
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==  
==Example==  
This example does...
TODO: add an example here.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
Add example here...
blabhalbalhb --abababa
--This line does this...
mooo
</syntaxhighlight>
</syntaxhighlight>


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

Revision as of 15:30, 22 August 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

TODO: add an example here. 

Add example here...

See Also


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