GetVehicleEngineState: Difference between revisions

From Onset Developer Wiki
Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|GetVehicleEngineState(vehicle)}} {{FuncParameters}} {{FuncParam|vehicle|__EDIT_ME__}} {{FuncRetur..."
 
No edit summary
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Info|Function|Server|1.0}}
{{Info|Function|Server & Client|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Get the vehicle's engine state.}}


{{FuncSyntax|GetVehicleEngineState(vehicle)}}
{{FuncSyntax|GetVehicleEngineState(vehicle)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|vehicle|__EDIT_ME__}}
{{FuncParam|vehicle|The vehicle identifier.}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Returns '''true''' if on.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua>
AddCommand("engine", function(playerid)
    local vehicle = GetPlayerOccupiedVehicle(playerid)
    if vehicle == 0 then
        return AddPlayerChat(playerid, "You must be in a vehicle!")
    end
 
    local state = not GetVehicleEngineState(vehicle)
    if state == true then
        StopVehicleEngine(vehicle)
    else
        StartVehicleEngine(vehicle)
    end
 
    return AddPlayerChat(playerid, "Vehicle engine state changed to: " .. (state and "on" or "off") .. "!")
end)
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
{{Template:VehicleFunctions}}

Latest revision as of 16:11, 27 May 2021

GetVehicleEngineState

Type: Function
Context: Server & Client
Introduced: v1.0

Description

Get the vehicle's engine state.

Syntax

GetVehicleEngineState(vehicle)

Parameters

  • vehicle
    The vehicle identifier.

Return Value

  • Returns true if on.

Example

AddCommand("engine", function(playerid)
    local vehicle = GetPlayerOccupiedVehicle(playerid)
    if vehicle == 0 then
        return AddPlayerChat(playerid, "You must be in a vehicle!")
    end

    local state = not GetVehicleEngineState(vehicle)
    if state == true then
        StopVehicleEngine(vehicle)
    else
        StartVehicleEngine(vehicle)
    end

    return AddPlayerChat(playerid, "Vehicle engine state changed to: " .. (state and "on" or "off") .. "!")
end)

See also

Retrieved from "https://dev.playonset.com/index.php?title=GetVehicleEngineState&oldid=4761"