GetElementType: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Fixed)
Line 12: Line 12:


===Returns===
===Returns===
There are a total of 11 strings this function returns:
Returns a ''string'' containing the element type, ''false'' if invalid arguments were passed.
*'''"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==  
==Example==  
Line 31: Line 18:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function onPlayerTargeted ( targetElem )
function onPlayerTargeted ( targetElem )
     -- if the targeted object is a haystack remove it from the game.
     -- if the targeted object is a haystack (an object with model ID 3374) remove it from the game.
     if ( getElementType ( targetElem ) == "object" ) and ( getObjectModel ( targetElem ) == 3374 ) then
     if ( getElementType ( targetElem ) == "object" ) and ( getObjectModel ( targetElem ) == 3374 ) then
         destroyElement ( targetElem )
         destroyElement ( targetElem )

Revision as of 00:13, 17 September 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

Returns a string containing the element type, false if invalid arguments were passed.

Example

This example destroys a haystack when a player targets it 

function onPlayerTargeted ( targetElem )
    -- if the targeted object is a haystack (an object with model ID 3374) 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=12058"