OnMarkerLeave: Difference between revisions

Revision as of 04:54, 30 December 2007

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

player leftPlayer, bool matchingDimension

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

The source of this event is the marker that the player left.

This example does...

--This line does...
blah()
--This line does this...
mooo

@@ Line 1: / Line 1: @@
-[[Category:Incomplete Event]]
+__NOTOC__
+{{Server event}}
+This event is triggered when a player leaves the area of a marker created using [[createMarker]].
-__NOTOC__
+==Parameters==
-This event is triggered when a player leaves a marker.
-==Syntax==
 <syntaxhighlight lang="lua">
-void onMarkerLeave ( player thePlayer, bool matchingdimension )
+player leftPlayer, bool matchingDimension
 </syntaxhighlight>
+*'''leftPlayer''': The player that left the marker's area
+*'''matchingDimension''': True if the player is in the same dimension as the marker he left
+==Source==
+The [[event system#Event source|source]] of this event is the [[marker]] that the player left.
 ==Example==
+<!-- Explain what the example is in a single sentance -->
 This example does...
+<!-- 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">
 --This line does...
-blabhalbalhb --abababa
+blah()
 --This line does this...
 mooo
 </syntaxhighlight>
+==See Also==
+{{Event_functions}}
+[[Category:Needs Example]]