GetElementType: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
__NOTOC__  
{{Server client function}}
This function is used to retrieve the type of an Element.
__NOTOC__
This function is used to retrieve the type of an element.


==Syntax==  
==Syntax==  
Line 24: Line 25:
*'''"unknown":''' Unknown element type
*'''"unknown":''' Unknown element type


This function will return ''false'' if ''theElement'' is invalid.
This function will return ''false'' if '''theElement''' is invalid.


==Example==  
==Example==  
This example destroys a haystack when a player targets it
This example destroys a haystack when a player targets it
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--Add an event, so the server knows to wait for someone to start targeting stuff
function onPlayerTargeted ( targetElem )
addEventHandler ( "onPlayerTargeted", root, "onPlayerTargeted" )
     -- if the targeted object is a haystack remove it from the game.
--Add the function that runs when the event is tripped
     if ( getElementType ( targetElem ) == "object" ) and ( getObjectModel ( targetElem ) == 3374 ) then
function onPlayerTargeted ( element )
         destroyElement ( targetElem )
     --If the targetted object is a haystack remove it from the game.
     if ( getElementType ( element ) == "object" ) and ( getObjectModel ( element ) == 3374 ) then
         destroyElement ( element )
     end
     end
end    
end
addEventHandler ( "onPlayerTargeted", getRootElement(), onPlayerTargeted )    -- add above function as handler for targeting event
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Element functions}}
{{Element functions}}

Revision as of 19:09, 19 August 2007

This function is used to retrieve the type of an element.

Syntax

string getElementType ( element theElement )

Required Arguments

  • theElement: The element you wish to get the type of.

Returns

There are a total of 11 strings this function returns:

  • "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
  • "colshape": A collision shape
  • "console": The server Console
  • "unknown": Unknown element type

This function will return false if theElement is invalid.

Example

This example destroys a haystack when a player targets it 

function onPlayerTargeted ( targetElem )
    -- if the targeted object is a haystack remove it from the game.
    if ( getElementType ( targetElem ) == "object" ) and ( getObjectModel ( targetElem ) == 3374 ) then
        destroyElement ( targetElem )
    end
end
addEventHandler ( "onPlayerTargeted", getRootElement(), onPlayerTargeted )    -- add above function as handler for targeting event

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetElementType?oldid=10734"