StartVehicleEngine: Difference between revisions

From Onset Developer Wiki
Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|StartVehicleEngine(vehicle)}} {{FuncParameters}} {{FuncParam|vehicle|__EDIT_ME__}} {{FuncReturnVa..."
 
No edit summary
 
(3 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 start vehicle engine}}


{{FuncSyntax|StartVehicleEngine(vehicle)}}
{{FuncSyntax|StartVehicleEngine(vehicle)}}


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


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


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


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

Latest revision as of 13:23, 1 September 2020

StartVehicleEngine

Type: Function
Context: Server
Introduced: v1.0

Description

Used to start vehicle engine

Syntax

StartVehicleEngine(vehicle)

Parameters

  • vehicle
    Vehicle which engine you want to start

Return Value

  • Returns true on success.

Example

function StartEngine(player)
   local veh = GetPlayerVehicle(player)
   if veh ~= 0 then
      StartVehicleEngine(veh)
   end
end
AddCommand('engine', StartEngine)

See also

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