OnElementColShapeLeave: Difference between revisions

Revision as of 04:40, 30 December 2007

This event is triggered when an player or vehicle element leaves the area of a colshape.

colshape theColShape, bool matchingDimension

theColShape: The colshape that this element left the area of
matchingDimension: True if the colshape and the element that left it are in the same dimension

The source of this event is the player or vehicle that left colshape.

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 an player or vehicle element leaves the area of a colshape.
-__NOTOC__
+==Parameters==
-This event is triggered when an element inside a [[colshape]] leaves.
-==Syntax==
 <syntaxhighlight lang="lua">
-void onElementColShapeLeave ( colshape leftcolshape, bool matchingDimension )
+colshape theColShape, bool matchingDimension
 </syntaxhighlight>
+*'''theColShape''': The [[colshape]] that this element left the area of
+*'''matchingDimension''': True if the colshape and the element that left it are in the same dimension
+==Source==
+The [[event system#Event source|source]] of this event is the [[player]] or [[vehicle]] that left colshape.
 ==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]]