GetVehicleLandingGearDown: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
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 check whether a vehicles' landing gear is down or not.
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 getVehicleLandingGearDown ( vehicle thevehicle )
bool getVehicleLandingGearDown ( vehicle thevehicle )
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 that you wish to check its' landing gear state.
*'''argumentName:''' description
 
<!-- 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 landing gear is down, ''false'' if the landing gear is up.<br />
Returns ''true'' if blah, ''false'' otherwise.<br />
Returns ''nil'' if the vehicle has no landing gear, or is invalid.
Returns ''nil'' on error (No landing gear on the vehicle checked)


==Example==  
==Example==  

Revision as of 16:38, 20 June 2007

This function is used to check whether a vehicles' landing gear is down or not.

Syntax

bool getVehicleLandingGearDown ( vehicle thevehicle )

Required Arguments

  • thevehicle: The vehicle that you wish to check its' landing gear state.

Returns

Returns true if landing gear is down, false if the landing gear is up.
Returns nil if the vehicle has no landing gear, or is invalid.

Example

This example does... 

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

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/GetVehicleLandingGearDown?oldid=8745"