GetAngularVelocityAlt

From GECK
Jump to: navigation, search


A function added by the JIP NVSE Plugin.

Description

Returns the angular velocity of each of the 3 X/Y/Z axes, of the collision object (if any) attached to the specified node in the calling reference's loaded 3D model. The result XYZ are placed into the 3 specified Script Variables.

  • By default, the function returns the velocities relative to the object's local axes, unless the optional 5th argument, getGlobal, is non-zero, on which case the velocities are relative to the world, global axes.
  • The velocity is in units of 2π rad/s (essentially, revolutions/second).
  • If the 3D model does not have the specified node, or the node does not have a mobile collision object, the function returns 0, and the script variables are unchanged.

Syntax

[help]
(success:0/1) reference.GetAngularVelocityAlt nodeName:string resX:ScriptVar resY:ScriptVar resZ:ScriptVar getGlobal:0/1

Example

objectRef.GetAngularVelocityAlt "TumbleweedNV" fVelX fVelY fVelZ 

See Also