SetVehicleLinearVelocity: Difference between revisions

From Onset Developer Wiki
(Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|SetVehicleLinearVelocity(vehicle, x, y, z [, reset])}} {{FuncParameters}} {{FuncParam|vehicle|__ED...")
 
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|Set the vehicle's linear velocity.}}


{{FuncSyntax|SetVehicleLinearVelocity(vehicle, x, y, z [, reset])}}
{{FuncSyntax|SetVehicleLinearVelocity(vehicle, x, y, z [, reset])}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|vehicle|__EDIT_ME__}}
{{FuncParam|vehicle|The vehicle identifier.}}
{{FuncParam|x|__EDIT_ME__}}
{{FuncParam|x|The X axis velocity}}
{{FuncParam|y|__EDIT_ME__}}
{{FuncParam|y|The Y axis velocity}}
{{FuncParam|z |__EDIT_ME__}}
{{FuncParam|z|The Z axis velocity}}
{{FuncParamOptional|reset|__EDIT_ME__}}
{{FuncParamOptional|reset|'''true''' to reset the linear velocity, default: '''false'''}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|This function returns '''true'''.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua">
SetVehicleLinearVelocity(vehicleId, 100.0, 0.0, 0.0, false)
-- Push the vehicle towards 100.0 units in X axis
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
{{VehicleFunctions}}

Latest revision as of 19:32, 30 August 2020

SetVehicleLinearVelocity

Type: Function
Context: Server
Introduced: v1.0

Description

Set the vehicle's linear velocity.

Syntax

SetVehicleLinearVelocity(vehicle, x, y, z [, reset])

Parameters

  • vehicle
    The vehicle identifier.
  • x
    The X axis velocity
  • y
    The Y axis velocity
  • z
    The Z axis velocity
  • reset (optional)
    true to reset the linear velocity, default: false

Return Value

  • This function returns true.

Example

SetVehicleLinearVelocity(vehicleId, 100.0, 0.0, 0.0, false)
-- Push the vehicle towards 100.0 units in X axis

See also

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