OnPlayerTarget: Difference between revisions

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


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
<section name="Server" class="server" show="true">
This example does...
This example destroys a haystack when a player targets it
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
function onPlayerTarget ( targetElem )
blah()
    -- if the targeted object is a haystack (an object with model ID 3374) remove it from the game
--This line does this...
    if getElementType ( targetElem ) == "object" and getElementModel ( targetElem ) == 3374 then
mooo
        destroyElement ( targetElem )
    end
end
addEventHandler ( "onPlayerTarget", getRootElement(), onPlayerTarget )    -- add above function as handler for targeting event
</syntaxhighlight>
</syntaxhighlight>
</section>


{{See also/Server event|Player events}}
{{See also/Server event|Player events}}


[[Category:Needs Example]]
[[Category:Needs Example]]

Revision as of 22:53, 19 February 2010

This event is triggered when a player targets an element with his crosshair while aiming, or simply facing it while standing close. It's triggered again when the player no longer targets anything.

Parameters

element targettedElement
  • targettedElement: The element the player is targetting. false if no element is being targetted anymore.

Source

The source of this event is the player that is targetting the element.

Example

Click to collapse [-]
Server

This example destroys a haystack when a player targets it

function onPlayerTarget ( targetElem )
    -- if the targeted object is a haystack (an object with model ID 3374) remove it from the game
    if getElementType ( targetElem ) == "object" and getElementModel ( targetElem ) == 3374 then
        destroyElement ( targetElem )
    end
end
addEventHandler ( "onPlayerTarget", getRootElement(), onPlayerTarget )    -- add above function as handler for targeting event


See Also

Player events


Event functions