OnMarkerLeave: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Improved example.)
 
(9 intermediate revisions by 5 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server event}}
{{Server event}}
This event is triggered when a player leaves the area of a marker created using [[createMarker]].
This event is triggered when an element leaves the area of a marker created using [[createMarker]].


==Parameters==
==Parameters==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
player leftPlayer, bool matchingDimension
element leftElement, bool matchingDimension
</syntaxhighlight>  
</syntaxhighlight>  


*'''leftPlayer''': The player that left the marker's area
*'''leftElement''': the [[element]] that left the [[marker|marker's]] area.
*'''matchingDimension''': True if the player is in the same dimension as the marker he left
*'''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 player left.
The [[event system#Event source|source]] of this event is the [[marker]] that the element left.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This example shows a message in the chat box when element (in this case a player) leaves a marker.
This example views a message when you leave the marker.
<!-- 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">
function MarkerHit ( leavePlayer, matchingDimension )
local myMarker = createMarker(-2596.6259765625, 579.3583984375, 15.626741409302, "cylinder", 2.0, 255, 0, 0, 150)
        outputChatBox ( "Bye", leavePlayer )
 
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("onMarkerHit", getRootElement (), MarkerHit)
</syntaxhighlight>
</syntaxhighlight>


{{See also/Server event|Marker events}}
{{See also/Server event|Marker events}}
[[Category:Needs Checking]]

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

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

Shared



Retrieved from "https://wiki.multitheftauto.com/wiki/OnMarkerLeave?oldid=69431"