OnPlayerTarget: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(7 intermediate revisions by 6 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server event}}
{{Server event}}
This event is triggered when a player targets an element with his crosshair while aiming. It's triggered again when the player no longer targets anything.
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==
==Parameters==
Line 8: Line 8:
</syntaxhighlight>  
</syntaxhighlight>  


*'''targettedElement''': The element the player is targetting. ''false'' if no element is being targetted anymore.
*'''targettedElement''': the [[element]] the [[player]] is targetting. ''false'' if no element is being targetted anymore.


<!-- Add the event's source in the section below -->
==Source==
==Source==
The [[event system#Event source|source]] of this event is the [[player]] that is targetting the element.
The [[event system#Event source|source]] of this event is the [[player]] that is targetting the element.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
<section class="server" name="Example 1 (Server)" show="true">
This example does...
This example destroys a haystack when a player targets it.''' It only works with elements created by MTA. '''
<!-- 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...
 
blah()
addEventHandler ("onPlayerTarget", root,
--This line does this...
    function(targetElem)
mooo
        if (isElement(targetElem)) and (getElementType(targetElem)=="object") and (getElementModel(targetElem)==3374) then
            destroyElement (targetElem)
        end
    end
)
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
{{See also/Server event|Player events}}
{{Event_functions}}
[[Category:Needs Example]]

Latest revision as of 03:02, 27 September 2018

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 [-]
Example 1 (Server)

This example destroys a haystack when a player targets it. It only works with elements created by MTA.


addEventHandler ("onPlayerTarget", root, 
    function(targetElem)
        if (isElement(targetElem)) and (getElementType(targetElem)=="object") and (getElementModel(targetElem)==3374) then
            destroyElement (targetElem)
        end
    end
)

See Also

Player events


Event functions