StopVehicleEngine: Difference between revisions

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


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Used to stop vehicle engine}}


{{FuncSyntax|StopVehicleEngine(vehicle)}}
{{FuncSyntax|StopVehicleEngine(vehicle)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|vehicle|__EDIT_ME__}}
{{FuncParam|vehicle|Vehicle which engine you want to stop}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Returns '''true''' on success, even if the engine is off already.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua">
function StopEngine(player)
  local veh = GetPlayerVehicle(player)
  if veh ~= 0 then
      StopVehicleEngine(veh)
  end
end
AddCommand('engineoff', StopEngine)
</syntaxhighlight>


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

Latest revision as of 20:29, 30 August 2020

StopVehicleEngine

Type: Function
Context: Server
Introduced: v1.0

Description

Used to stop vehicle engine

Syntax

StopVehicleEngine(vehicle)

Parameters

  • vehicle
    Vehicle which engine you want to stop

Return Value

  • Returns true on success, even if the engine is off already.

Example

function StopEngine(player)
   local veh = GetPlayerVehicle(player)
   if veh ~= 0 then
      StopVehicleEngine(veh)
   end
end
AddCommand('engineoff', StopEngine)

See also

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