SetVehicleLinearVelocity: Difference between revisions

From Onset Developer Wiki
No edit summary
No edit summary
Line 9: Line 9:
{{FuncParam|x|The X axis velocity}}
{{FuncParam|x|The X axis velocity}}
{{FuncParam|y|The Y axis velocity}}
{{FuncParam|y|The Y axis velocity}}
{{FuncParam|z |The Z axis velocity}}
{{FuncParam|z|The Z axis velocity}}
{{FuncParamOptional|reset|Boolean __EDIT_ME__}}
{{FuncParamOptional|reset|'''true''' to reset the velocity, default: '''false'''}}


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

Revision as of 19:30, 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 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