OnPlayerMarkerHit: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Many errors)
 
(9 intermediate revisions by 6 users not shown)
Line 2: Line 2:
{{Server event}}
{{Server event}}
This event is triggered when a [[player]] hits a [[marker]].
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.}}


==Parameters==
==Parameters==
Line 8: Line 9:
</syntaxhighlight>  
</syntaxhighlight>  


*'''markerHit''': The marker the player hit
*'''markerHit''': the [[marker]] the [[player]] hit.
*'''matchingDimension''': Whether the player and the marker he hit are in the same dimension
*'''matchingDimension''': a [[boolean]] representing whether the [[player]] and the hit [[marker]] are in the same [[dimension]].


==Source==
==Source==
Line 15: Line 16:


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This example outputs when a player hits a marker.
This example does...
<!-- 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...
addEventHandler('onPlayerMarkerHit', root, function(marker, matchingDimension)
blah()
    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==
{{See also/Server event|Player events}}
{{Event_functions}}
[[Category:Needs Example]]

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

Shared



Retrieved from "https://wiki.multitheftauto.com/wiki/OnPlayerMarkerHit?oldid=79779"