OnMarkerLeave: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Minor changes + example)
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
player leftElement, bool matchingDimension
</syntaxhighlight>  
</syntaxhighlight>  


*'''leftPlayer''': The player that left the marker's area
*'''leftPlayer''': The element that left the marker's area
*'''matchingDimension''': True if the player is in the same dimension as the marker he left
*'''matchingDimension''': True if the element is in the same dimension as the marker he left


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


==Example==  
==Example==  
This example shows a message in the player's chat box when they leave 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">
function markerLeave ( leavePlayer, matchingDimension )
 
         outputChatBox ( "You left a marker", leavePlayer )
local myMarker = createMarker( -2596.6259765625, 579.3583984375, 15.626741409302, "cylinder", 2.0, 255, 0, 0, 150 )
 
function markerLeave( leaveElement, matchingDimension )
         if getElementType( leaveElement ) == "player" then
          outputChatBox ( "Player has left a marker", getRootElement(), 255, 255, 0 )
        end
end
end


addEventHandler("onMarkerLeave", getRootElement (), markerLeave )
addEventHandler( "onMarkerLeave", myMarker, markerLeave )
</syntaxhighlight>
</syntaxhighlight>


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

Revision as of 20:36, 3 November 2009

This event is triggered when an element leaves the area of a marker created using createMarker.

Parameters

player leftElement, bool matchingDimension
  • leftPlayer: The element that left the marker's area
  • matchingDimension: True if the element is in the same dimension as the marker he left

Source

The source of this event is the marker that the player 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 )
        if getElementType( leaveElement ) == "player" then
          outputChatBox ( "Player has left a marker", getRootElement(), 255, 255, 0 )
        end
end

addEventHandler( "onMarkerLeave", myMarker, markerLeave )

See Also

Marker events


Event functions


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