GetActorVelocity

From GECK
Jump to: navigation, search


A function added by the JIP NVSE Plugin.

Description

Returns the calling actor's current Velocity on the (optional) specified Axis. If no axis is specified, the total, absolute velocity (product of all three axes) is returned.

Syntax

[help]
(velocity:float) reference.GetActorVelocity axis:X/Y/Z

Example

set fVelocity to actorRef.GetActorVelocity
set fVelocityZ to actorRef.GetActorVelocity Z 

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