GetActorVelocityAlt

From GECK
Jump to: navigation, search


A function added by the JIP NVSE Plugin.

Description

Returns the calling actor's current linear velocity on each of the 3 X/Y/Z global axes. The result XYZ are placed into the 3 specified Script Variables.

  • If the optional 4th argument, getLocal, is non-zero, the result velocities are relative to the actor's local axes.

Syntax

[help]
(success:0/1) reference.GetActorVelocityAlt resX:ScriptVar resY:ScriptVar resZ:ScriptVar getLocal:0/1

Example

actorRef.GetActorVelocityAlt fVelX fVelY fVelZ 1 

Notes

  • The sign of the returned value indicates direction: a negative Z velocity indicates the actor is speeding downwards.
  • This function measures velocity as 0.1 Meter/sec, or 7 Units/sec.

See Also