OnTrailerAttach: Difference between revisions

Revision as of 05:56, 30 December 2007

This event is triggered when a trailer is attached to a truck.

vehicle theTruck

The source of this event is the trailer vehicle that the truck got attached to.

If this event is canceled, the trailer will detach from the truck again.

This example does...

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

@@ Line 1: / Line 1: @@
-[[Category:Incomplete Event]]
+__NOTOC__
+{{Server event}}
-__NOTOC__
 This event is triggered when a trailer is attached to a truck.
-==Syntax==
+==Parameters==
 <syntaxhighlight lang="lua">
-void onTrailerAttach ( vehicle towedBy )
+vehicle theTruck
 </syntaxhighlight>
+*'''theTruck''': The truck vehicle that got attached to this trailer
+==Source==
+The [[event system#Event source|source]] of this event is the trailer [[vehicle]] that the truck got attached to.
+<!-- Only include this section below if cancelling the event has any effect. If you don't know if it does, ask a dev! -->
+==Cancel effect==
+If this event is [[Event system#Canceling|canceled]], the trailer will detach from the truck again.
 ==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]]