OnPlayerMarkerHit: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (Changed example, added note about attaching this event)
 
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 17: Line 18:
This example outputs when a player hits a marker.
This example outputs when a player hits a marker.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function markerAlert(markerHit,matchingDimension)
addEventHandler('onPlayerMarkerHit', root, function(marker, dimension)
if (matchingDimension) then -- Make sure the player is in the same dimension as the marker (so they're actually going into it).
if not dim then return end -- check if player is actually going into the marker
outputChatBox("You have just entered a marker.",source,255,255,0) -- Output that they are.
outputChatBox('You have just entered a marker!', source, 255, 255, 0) -- output something
end
end)
end
addEventHandler("onPlayerMarkerHit",getRootElement(),markerAlert)
</syntaxhighlight>
</syntaxhighlight>


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

Latest revision as of 18:20, 2 September 2023

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, dimension)
	if not dim then return end -- check if player is actually going into the marker
	outputChatBox('You have just entered a marker!', source, 255, 255, 0) -- output something
end)

See Also

Player events


Event functions