SetVehicleRotorState: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
 
Line 23: Line 23:


==Example==
==Example==
<syntaxhighlight lang="lua">
{{Needs Example}}
local function toggleRotor()
    local veh = getPedOccupiedVehicle(localPlayer)
    if (not isElement(veh)) then
        return
    end
 
    setVehicleRotorState(veh, not getVehicleRotorState(veh))
    setVehicleEngineState(veh, not getVehicleEngineState(veh))
end
 
addEventHandler('onClientVehicleEnter', root, function(plr, seat)
    if (seat == 0)
        if (getVehicleType(source) == 'Plane' or getVehicleType(source) == 'Helicopter') then
            setVehicleRotorState(source, false)
            setVehicleEngineState(source, false)
            bindKey('E', 'down', toggleRotor)
        end
    end
end)
 
addEventHandler('onClientVehicleStartExit', root, function(plr, seat)
    if (seat == 0 and (getVehicleType(source) == 'Plane' or getVehicleType(source) == 'Helicopter')) then
        unbindKey('E', 'down', toggleRotor)
    end
end)
</syntaxhighlight>


==See Also==
==See Also==
{{Client vehicle functions}}
{{Client vehicle functions}}

Latest revision as of 02:24, 31 December 2024

ADDED/UPDATED IN VERSION 1.6.0 r22862:
Turns the rotor on/off for an plane or helicopter. A vehicle with the rotor turned off cannot hover in the air.
[[{{{image}}}|link=|]] Note: The function should not be confused with setVehicleEngineState.

Syntax

bool setVehicleRotorState(vehicle theVehicle, bool state [, bool stopRotor = true ] )

OOP Syntax Help! I don't understand this!

Method: vehicle:setRotorState(...)
Variable: .rotorState
Counterpart: getVehicleRotorState


Required Arguments

  • theVehicle: The vehicle (helicopter or plane) whose rotor you want to toggle.
  • state: The rotor state, which determines whether it should be on (true) or off (false).

Optional Arguments

  • stopRotor: Specifies whether the rotor should be stopped after being turned off. If false, the rotor will continue spinning at a constant speed (it won't slow down or accelerate). It will also not be able to lift off the ground. You can also use setVehicleRotorSpeed to manage the rotor speed.

Returns

Returns true if successful, false otherwise.

Example

Accessories-text-editor.png Script Example Missing Function SetVehicleRotorState needs a script example, help out by writing one.

Before submitting check out Editing Guidelines Script Examples.


See Also