OnPlayerMarkerHit: Difference between revisions
Jump to navigation
Jump to search
m (See Also for server events) |
m (Changed example, added note about attaching this event) |
||
| (5 intermediate revisions by 3 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''': | *'''markerHit''': the [[marker]] the [[player]] hit. | ||
*'''matchingDimension''': | *'''matchingDimension''': a [[boolean]] representing whether the [[player]] and the hit [[marker]] are in the same [[dimension]]. | ||
==Source== | ==Source== | ||
| Line 15: | Line 16: | ||
==Example== | ==Example== | ||
This example outputs when a player hits a marker. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- | 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) | |||
</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.
| Note: This event is triggered for players only. Attaching this event to a marker does nothing. |
Parameters
marker markerHit, bool matchingDimension
- markerHit: the marker the player hit.
- matchingDimension: a boolean representing whether the player and the hit marker are in the same dimension.
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
- onPlayerACInfo
- onPlayerBan
- onPlayerChangeNick
- onPlayerChat
- onPlayerClick
- onPlayerCommand
- onPlayerConnect
- onPlayerContact
- onPlayerDamage
- onPlayerJoin
- onPlayerLogin
- onPlayerLogout
- onPlayerMarkerHit
- onPlayerMarkerLeave
- onPlayerModInfo
- onPlayerMute
- onPlayerNetworkStatus
- onPlayerPickupHit
- onPlayerPickupLeave
- onPlayerPickupUse
- onPlayerPrivateMessage
- onPlayerQuit
- onPlayerScreenShot
- onPlayerSpawn
- onPlayerStealthKill
- onPlayerTarget
- onPlayerUnmute
- onPlayerVehicleEnter
- onPlayerVehicleExit
- onPlayerVoiceStart
- onPlayerVoiceStop
- onPlayerWasted
- onPlayerWeaponFire
- onPlayerWeaponSwitch
Event functions
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getCancelReason
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- triggerClientEvent
- triggerLatentClientEvent
- wasEventCancelled