SetVehicleEngineState: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Whoops)
mNo edit summary
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==

Revision as of 22:31, 27 August 2007

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

Click to collapse [-]
Server and Client
bool setVehicleEngineState ( vehicle theVehicle, bool engineState )

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 [-]
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 ( "onPlayerExitVehicle", getRootElement ( ), turnEngineOff )

See Also


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