OnMarkerHit: Difference between revisions

Revision as of 04:53, 30 December 2007

This event is triggered when a player enters a marker created using createMarker.

player hitPlayer, bool matchingDimension

hitPlayer: The player that hit the marker
matchingDimension: True if the player is in the same dimension as the marker he hit

The source of this event is the marker that got hit by the player.

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 enters a marker created using [[createMarker]].
-__NOTOC__
+==Parameters==
-This event is triggered when a player hits a marker.
-==Syntax==
 <syntaxhighlight lang="lua">
-void onMarkerHit ( player, bool matchingdimension )
+player hitPlayer, bool matchingDimension
 </syntaxhighlight>
+*'''hitPlayer''': The player that hit the marker
+*'''matchingDimension''': True if the player is in the same dimension as the marker he hit
+==Source==
+The [[event system#Event source|source]] of this event is the [[marker]] that got hit by the player.
 ==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]]