SetVehicleLandingGearDown: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
This function is used to set the landing gear state of certain vehicles.
This fake function is for use with blah & blah and does blahblahblabhalbhl


==Syntax==  
==Syntax==  
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool setVehicleLandingGearDown ( vehicle thevehicle, bool gearstate )
bool setVehicleLandingGearDown ( vehicle thevehicle, bool gearstate )
Line 10: Line 8:


===Required Arguments===  
===Required Arguments===  
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
*'''thevehicle:''' The vehicle of which you wish to set the landing gear state.
*'''argumentName:''' description
*'''gearstate:''' ''true'' or ''false''.
 
<!-- Only include this section below if there are optional arguments -->
===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' description
*'''argumentName3:''' description


===Returns===
===Returns===
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
Returns ''true'' if successful, ''false'' otherwise.
Returns ''true'' if blah, ''false'' otherwise.


==Example==  
==Example==  

Revision as of 17:06, 20 June 2007

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

Syntax

bool setVehicleLandingGearDown ( vehicle thevehicle, bool gearstate )

Required Arguments

  • thevehicle: The vehicle of which you wish to set the landing gear state.
  • gearstate: true or false.

Returns

Returns true if successful, false otherwise.

Example

This example does...

--This line does...
blabhalbalhb --abababa
--This line does this...
mooo

See Also