OnPlayerMarkerHit: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Many errors)
 
(10 intermediate revisions by 7 users not shown)
Line 1: Line 1:
[[Category:Incomplete Event]]
__NOTOC__
{{Server event}}
This event is triggered when a [[player]] hits a [[marker]].
{{Note|This event is triggered for <b>players</b> only. Attaching this event to a marker does nothing.}}


__NOTOC__
==Parameters==
This event is triggered when a player hits a marker.
 
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
void onPlayerMarkerHit ( marker hitmarker, bool matchingDimension )   
marker markerHit, bool matchingDimension
</syntaxhighlight>  
</syntaxhighlight>  
*'''markerHit''': the [[marker]] the [[player]] hit.
*'''matchingDimension''': a [[boolean]] representing whether the [[player]] and the hit [[marker]] are in the same [[dimension]].
==Source==
The [[event system#Event source|source]] of this event is the [[player]] that hit the marker.


==Example==  
==Example==  
This example does...
This example outputs when a player hits a marker.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
addEventHandler('onPlayerMarkerHit', root, function(marker, matchingDimension)
blabhalbalhb --abababa
    if not matchingDimension then return end -- checks if the dimension of the player who activated the marker is the same as the one the marker is in (in this case, if not, it will stop here)
--This line does this...
    outputChatBox('You have just entered a marker!', source, 255, 255, 0) -- output something
mooo
end)
</syntaxhighlight>
</syntaxhighlight>
{{See also/Server event|Player events}}

Latest revision as of 14:54, 6 July 2024

This event is triggered when a player hits a marker.

[[{{{image}}}|link=|]] Note: This event is triggered for players only. Attaching this event to a marker does nothing.

Parameters

marker markerHit, bool matchingDimension

Source

The source of this event is the player that hit the marker.

Example

This example outputs when a player hits a marker.

addEventHandler('onPlayerMarkerHit', root, function(marker, matchingDimension)
    if not matchingDimension then return end -- checks if the dimension of the player who activated the marker is the same as the one the marker is in (in this case, if not, it will stop here)
    outputChatBox('You have just entered a marker!', source, 255, 255, 0) -- output something
end)

See Also

Player events


Event functions