SetVehicleLandingGearDown - Revision history

Jaysds at 17:34, 7 April 2012

2012-04-07T17:34:54Z

← Older revision		Revision as of 17:34, 7 April 2012
Line 29:		Line 29:
	==See Also==		==See Also==
	{{Vehicle functions}}		{{Vehicle functions}}
	~~[[Category:Needs_Example]]~~

Jaysds: /* Example */

2012-04-07T17:33:44Z

Example

← Older revision		Revision as of 17:33, 7 April 2012
Line 16:		Line 16:

	==Example==		==Example==
	This ~~page does not have an~~ example		This example sets the landing gear up and outputs to the player to pull up
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function checkGear( thePlayer )		function checkGear( thePlayer )

Jaysds: /* Example */

2012-04-07T17:31:36Z

Example

← Older revision		Revision as of 17:31, 7 April 2012
Line 18:		Line 18:
	This page does not have an example		This page does not have an example
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	--~~add an example here~~.		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
	</syntaxhighlight>		</syntaxhighlight>

Talidan at 15:07, 29 August 2007

2007-08-29T15:07:32Z

← Older revision		Revision as of 15:07, 29 August 2007
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool setVehicleLandingGearDown ( vehicle ~~thevehicle~~, bool ~~gearstate~~ )		bool setVehicleLandingGearDown ( vehicle theVehicle, bool gearState )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===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===
	Returns ''true'' if ~~successful~~, ''false'' otherwise.		Returns ''true'' if the landing gear was set successfully, ''false'' otherwise.

	==Example==		==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">		<syntaxhighlight lang="lua">
	--~~This line does~~...		--add an example here.
	~~blabhalbalhb --abababa~~
	~~--This line does this...~~
	~~mooo~~
	</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~~]]		[[Category:Needs_Example]]

Arc at 19:30, 15 August 2007

2007-08-15T19:30:59Z

← Older revision		Revision as of 19:30, 15 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
			{{Server client function}}
	This function is used to set the landing gear state of certain vehicles.		This function is used to set the landing gear state of certain vehicles.

Black Dragon at 17:06, 20 June 2007

2007-06-20T17:06:41Z

← Older revision		Revision as of 17:06, 20 June 2007
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==

Ransom at 21:43, 11 April 2007

2007-04-11T21:43:04Z

← Older revision		Revision as of 21:43, 11 April 2007
Line 6:		Line 6:
	<!-- 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 -->		<!-- 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">
	~~returnType functionName~~ ( ~~arguments~~ )		bool setVehicleLandingGearDown ( vehicle thevehicle, bool gearstate )
	</syntaxhighlight>		</syntaxhighlight>

JonChappell at 08:14, 19 March 2007

2007-03-19T08:14:00Z

New page

__NOTOC__

This fake function is for use with blah & blah and does blahblahblabhalbhl

==Syntax==

<syntaxhighlight lang="lua">
returnType functionName ( arguments )
</syntaxhighlight>

===Required Arguments===

*'''argumentName:''' description


===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' description
*'''argumentName3:''' description

===Returns===

Returns ''true'' if blah, ''false'' otherwise.

==Example==

This example does...

<syntaxhighlight lang="lua">
--This line does...
blabhalbalhb --abababa
--This line does this...
mooo
</syntaxhighlight>

==See Also==

{{Vehicle functions}}
[[Category:Incomplete]]