OnMarkerLeave: Difference between revisions
Jump to navigation
Jump to search
(Minor changes + example) |
(Improved example.) |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 5: | Line 5: | ||
==Parameters== | ==Parameters== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
element leftElement, bool matchingDimension | |||
</syntaxhighlight> | </syntaxhighlight> | ||
*''' | *'''leftElement''': the [[element]] that left the [[marker|marker's]] area. | ||
*'''matchingDimension''': | *'''matchingDimension''': a [[boolean]] representing whether the [[element]] is in the same dimension as the [[marker]]. | ||
==Source== | ==Source== | ||
The [[event system#Event source|source]] of this event is the [[marker]] that the | The [[event system#Event source|source]] of this event is the [[marker]] that the element left. | ||
==Example== | ==Example== | ||
This example shows a message in the chat box when element (in this case a player) leaves a marker. | This example shows a message in the chat box when element (in this case a player) leaves a marker. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
local myMarker = createMarker(-2596.6259765625, 579.3583984375, 15.626741409302, "cylinder", 2.0, 255, 0, 0, 150) | |||
local | function markerLeave(leaveElement, matchingDimension) | ||
local elementType = getElementType(leaveElement) | |||
if elementType == "player" then | |||
outputChatBox("Player has left a marker.", root, 255, 255, 0) | |||
end | |||
end | end | ||
addEventHandler("onMarkerLeave", myMarker, markerLeave) | |||
addEventHandler( "onMarkerLeave", myMarker, markerLeave ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
{{See also/Server event|Marker events}} | {{See also/Server event|Marker events}} | ||
Latest revision as of 13:48, 24 February 2021
This event is triggered when an element leaves the area of a marker created using createMarker.
Parameters
element leftElement, bool matchingDimension
- leftElement: the element that left the marker's area.
- matchingDimension: a boolean representing whether the element is in the same dimension as the marker.
Source
The source of this event is the marker that the element left.
Example
This example shows a message in the chat box when element (in this case a player) leaves a marker.
local myMarker = createMarker(-2596.6259765625, 579.3583984375, 15.626741409302, "cylinder", 2.0, 255, 0, 0, 150)
function markerLeave(leaveElement, matchingDimension)
local elementType = getElementType(leaveElement)
if elementType == "player" then
outputChatBox("Player has left a marker.", root, 255, 255, 0)
end
end
addEventHandler("onMarkerLeave", myMarker, markerLeave)
See Also
Marker events
Event functions
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getCancelReason
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- triggerClientEvent
- triggerLatentClientEvent
- wasEventCancelled