SetVehicleEngineState - Revision history

XLive at 09:01, 4 November 2020

2020-11-04T09:01:56Z

← Older revision		Revision as of 09:01, 4 November 2020
Line 40:		Line 40:
	end		end
	-- add 'turnEngineOff' as a handler for "onPlayerExitVehicle"		-- add 'turnEngineOff' as a handler for "onPlayerExitVehicle"
	addEventHandler ( "onPlayerVehicleExit", ~~getRootElement ( )~~, turnEngineOff )		addEventHandler ( "onPlayerVehicleExit", root, turnEngineOff )
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

Dutchman101: added example

2019-04-15T00:33:52Z

added example

@@ Line 16: / Line 16: @@
 ==Example==
 <section name="Serverside example" class="server" show="true">
 This example will turn off a vehicle's engine when the driver gets out of the car.

Jaysds1: OOP

2017-06-04T19:00:26Z

OOP

← Older revision		Revision as of 19:00, 4 June 2017
Line 7:		Line 7:
	bool setVehicleEngineState ( vehicle theVehicle, bool engineState )		bool setVehicleEngineState ( vehicle theVehicle, bool engineState )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[vehicle]]:setEngineState\|engineState\|getVehicleEngineState}}
	===Required Arguments===		===Required Arguments===
	*'''theVehicle''': The [[vehicle]] you wish to change the engine state of.		*'''theVehicle''': The [[vehicle]] you wish to change the engine state of.

Sebassje at 21:04, 20 June 2010

2010-06-20T21:04:02Z

← Older revision		Revision as of 21:04, 20 June 2010
Line 4:		Line 4:

	==Syntax==		==Syntax==
	~~<section name="Server and Client" class="both" show="true">~~
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool setVehicleEngineState ( vehicle theVehicle, bool engineState )		bool setVehicleEngineState ( vehicle theVehicle, bool engineState )
Line 15:		Line 14:
	===Returns===		===Returns===
	Returns ''true'' if the vehicle's engine state was successfully changed, ''false'' otherwise.		Returns ''true'' if the vehicle's engine state was successfully changed, ''false'' otherwise.
	~~</section>~~

	==Example==		==Example==

Dakilla: /* Example */

2010-02-13T10:18:05Z

Example

← Older revision		Revision as of 10:18, 13 February 2010
Line 29:		Line 29:
	end		end
	-- add 'turnEngineOff' as a handler for "onPlayerExitVehicle"		-- add 'turnEngineOff' as a handler for "onPlayerExitVehicle"
	addEventHandler ( "~~onPlayerExitVehicle~~", getRootElement ( ), turnEngineOff )		addEventHandler ( "onPlayerVehicleExit", getRootElement ( ), turnEngineOff )
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

Jbeta at 22:32, 27 August 2007

2007-08-27T22:32:59Z

← Older revision		Revision as of 22:32, 27 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	This function turns a vehicle's engine on or off ~~so it can't accelerate~~. Note that the engine will always be turned on when someone enters the driver seat, unless you override that behaviour with scripts.		This function turns a vehicle's engine on or off. Note that the engine will always be turned on when someone enters the driver seat, unless you override that behaviour with scripts.

	==Syntax==		==Syntax==

Jbeta at 22:31, 27 August 2007

2007-08-27T22:31:44Z

← Older revision		Revision as of 22:31, 27 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	This function turns a vehicle's engine on or off.		This function turns a vehicle's engine on or off so it can't accelerate. Note that the engine will always be turned on when someone enters the driver seat, unless you override that behaviour with scripts.

	==Syntax==		==Syntax==

Jbeta: Whoops

2007-08-27T21:21:26Z

Whoops

← Older revision		Revision as of 21:21, 27 August 2007
Line 18:		Line 18:

	==Example==		==Example==
	<section name="Serverside example" class="server" show="true"/>		<section name="Serverside example" class="server" show="true">
	This example will turn off a vehicle's engine when the driver gets out of the car.		This example will turn off a vehicle's engine when the driver gets out of the car.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Jbeta: Fixed section

2007-08-27T21:21:10Z

Fixed section

← Older revision		Revision as of 21:21, 27 August 2007
Line 4:		Line 4:

	==Syntax==		==Syntax==
	<section name="Server and Client" class="both" show="true"/>		<section name="Server and Client" class="both" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool setVehicleEngineState ( vehicle theVehicle, bool engineState )		bool setVehicleEngineState ( vehicle theVehicle, bool engineState )

Jbeta: Added sections, minor changes, improved example

2007-08-27T21:20:37Z

Added sections, minor changes, improved example

← Older revision		Revision as of 21:20, 27 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	This function ~~changes the on/off state of~~ a vehicle's engine		This function turns a vehicle's engine on or off.

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">bool setVehicleEngineState ( vehicle theVehicle, bool ~~engineOn~~ )</syntaxhighlight>		<section name="Server and Client" class="both" show="true"/>
			<syntaxhighlight lang="lua">
			bool setVehicleEngineState ( vehicle theVehicle, bool engineState )
			</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''theVehicle''': The [[vehicle]] you wish to change the engine state of.		*'''theVehicle''': The [[vehicle]] you wish to change the engine state of.
	*'''~~engineOn~~''': A boolean value representing whether ~~or not~~ the engine will be turned on or off.		*'''engineState''': A boolean value representing whether the engine will be turned on (''true'') or off (''false'').

	==Returns==		===Returns===
	Returns ''true'' if the vehicle's engine state was successfully changed, ''false'' otherwise.		Returns ''true'' if the vehicle's engine state was successfully changed, ''false'' otherwise.
			</section>

	==Example==		==Example==
	This example will ~~disallow~~ the ~~use~~ of the ~~engine in any vehicle~~.		<section name="Serverside example" class="server" show="true"/>
			This example will turn off a vehicle's engine when the driver gets out of the car.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function ~~onPlayerEnterVehicle~~ ( theVehicle, ~~seat~~, jacked )		function turnEngineOff ( theVehicle, leftSeat, jackerPlayer )
	if ~~seat~~ == 0 then -- ~~if they're getting into~~ the ~~driver seat~~		-- if it's the driver who got out, and he was not jacked,
	setVehicleEngineState ( theVehicle, false ) ~~-- turn off the engine~~		if leftSeat == 0 and not jackerPlayer then
			-- turn off the engine
			setVehicleEngineState ( theVehicle, false )
	end		end
	end		end
	addEventHandler ( "~~onPlayerEnterVehicle~~", getRootElement ( ), ~~onPlayerEnterVehicle~~ )		-- add 'turnEngineOff' as a handler for "onPlayerExitVehicle"
			addEventHandler ( "onPlayerExitVehicle", getRootElement ( ), turnEngineOff )
	</syntaxhighlight>		</syntaxhighlight>
			</section>

	==See Also==		==See Also==
	{{Vehicle functions}}		{{Vehicle functions}}