SetVehicleLandingGearDown: Difference between revisions

Revision as of 15:07, 29 August 2007

This function is used to set the landing gear state of certain vehicles.

bool setVehicleLandingGearDown ( vehicle theVehicle, bool gearState )

theVehicle: The vehicle of which you wish to set the landing gear state.
gearState: A bool representing the state of the landing gear. true represents a collapsed landing gear, while false represents a disabled landing gear.

Returns true if the landing gear was set successfully, false otherwise.

This page does not have an example

--add an example here.

@@ Line 5: / Line 5: @@
 ==Syntax==
 <syntaxhighlight lang="lua">
-bool setVehicleLandingGearDown ( vehicle thevehicle, bool gearstate )
+bool setVehicleLandingGearDown ( vehicle theVehicle, bool gearState )
 </syntaxhighlight>
 ===Required Arguments===
-*'''thevehicle:''' The vehicle of which you wish to set the landing gear state.
+*'''theVehicle:''' The vehicle of which you wish to set the landing gear state.
-*'''gearstate:''' ''true'' or ''false''.
+*'''gearState:''' A bool representing the state of the landing gear.  ''true'' represents a collapsed landing gear, while ''false'' represents a disabled landing gear.
 ===Returns===
-Returns ''true'' if successful, ''false'' otherwise.
+Returns ''true'' if the landing gear was set successfully, ''false'' otherwise.
 ==Example==
-<!-- Explain what the example is in a single sentance -->
+This page does not have an example
-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...
+--add an example here.
-blabhalbalhb --abababa
---This line does this...
-mooo
 </syntaxhighlight>
 ==See Also==
-<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
 {{Vehicle functions}}
-[[Category:Incomplete]]
+[[Category:Needs_Example]]