SetVehicleLandingGearDown: Difference between revisions

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


==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 )
</syntaxhighlight>  
</syntaxhighlight>  


===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:''' A bool representing the state of the landing gear.  ''true'' represents a collapsed landing gear, while ''false'' represents a disabled landing gear.
 
<!-- 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 the landing gear was set successfully, ''false'' otherwise.
Returns ''true'' if blah, ''false'' otherwise.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This example sets the landing gear up and outputs to the player to pull up
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">
<syntaxhighlight lang="lua">
--This line does...
function checkGear( thePlayer )
blabhalbalhb --abababa
    local theVehicle = getPedOccupiedVehicle( thePlayer )    --Get the players vehicle
--This line does this...
    if ( getElementModel(theVehicle) == 520 and getVehicleLandingGearDown( theVehicle ) == true) then --if the vehicle is a hydra, and the landing gear is down
mooo
      setVehicleLandingGearDown(theVehicle,false) --Set the landing gear up
      outputChatBox( "Pull up!", thePlayer )    --and tell the player to pull up.
    end
end
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==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}}
{{Vehicle functions}}
[[Category:Incomplete]]

Latest revision as of 17:34, 7 April 2012

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: 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 the landing gear was set successfully, false otherwise.

Example

This example sets the landing gear up and outputs to the player to pull up 

function checkGear( thePlayer )
    local theVehicle = getPedOccupiedVehicle( thePlayer )    --Get the players vehicle
    if ( getElementModel(theVehicle) == 520 and getVehicleLandingGearDown( theVehicle ) == true) then --if the vehicle is a hydra, and the landing gear is down
      setVehicleLandingGearDown(theVehicle,false) --Set the landing gear up
      outputChatBox( "Pull up!", thePlayer )    --and tell the player to pull up.
    end
end

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetVehicleLandingGearDown?oldid=29924"