GetActorVelocity

A function added by the JIP NVSE Plugin.

Description

Returns the calling actor's current velocity vector in 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 indicated the actor is speeding downwards.