SetVehicleEngineState: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(9 intermediate revisions by 5 users not shown)
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. Note that the engine will always be turned on when someone enters the driver seat, unless you override that behaviour with scripts.
 
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">bool setVehicleEngineState ( vehicle theVehicle, bool engineOn )</syntaxhighlight>
<syntaxhighlight lang="lua">
 
bool setVehicleEngineState ( vehicle theVehicle, bool engineState )
</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.
*'''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.


==Example==
==Example==
This example will disallow the use of the engine in any vehicle.
<section name="Clientside example" class="client" show="true">
This example lets the driver toggle vehicle engine on/off.
<syntaxhighlight lang="lua">
function toggleEngine()
local vehicle = getPedOccupiedVehicle(localPlayer)
if vehicle and getVehicleController(vehicle) == localPlayer then
setVehicleEngineState(vehicle, not getVehicleEngineState(vehicle))
end
end
addCommandHandler("engine", toggleEngine)
</syntaxhighlight>
</section>
 
<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 ( "onPlayerVehicleExit", root, turnEngineOff )
</syntaxhighlight>
</syntaxhighlight>
</section>


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

Latest revision as of 09:01, 4 November 2020

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

bool setVehicleEngineState ( vehicle theVehicle, bool engineState )

OOP Syntax Help! I don't understand this!

Method: vehicle:setEngineState(...)
Variable: .engineState
Counterpart: getVehicleEngineState


Required Arguments

  • theVehicle: The vehicle you wish to change the engine state of.
  • engineState: A boolean value representing whether the engine will be turned on (true) or off (false).

Returns

Returns true if the vehicle's engine state was successfully changed, false otherwise.

Example

Click to collapse [-]
Clientside example

This example lets the driver toggle vehicle engine on/off. 

function toggleEngine()
	local vehicle = getPedOccupiedVehicle(localPlayer)
	if vehicle and getVehicleController(vehicle) == localPlayer then
		setVehicleEngineState(vehicle, not getVehicleEngineState(vehicle))
	end
end
addCommandHandler("engine", toggleEngine)
Click to collapse [-]
Serverside example

This example will turn off a vehicle's engine when the driver gets out of the car. 

function turnEngineOff ( theVehicle, leftSeat, jackerPlayer )
    -- if it's the driver who got out, and he was not jacked,
    if leftSeat == 0 and not jackerPlayer then
        -- turn off the engine
        setVehicleEngineState ( theVehicle, false )
    end
end
-- add 'turnEngineOff' as a handler for "onPlayerExitVehicle"
addEventHandler ( "onPlayerVehicleExit", root, turnEngineOff )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetVehicleEngineState?oldid=67711"