getUnitMovesInfo

From Bohemia Interactive Community
Revision as of 18:03, 12 April 2024 by Leopard20 (talk | contribs)
Jump to navigation Jump to search
Hover & click on the images for description

Description

Description:
Returns various information about the unit moves (primary animation) and gestures (masked animation)
Groups:
Animations

Syntax

Syntax:
getUnitMovesInfo unit
Parameters:
unit: Object
Return Value:
Array in format:
  • 0 - moveProgress: Number - move progress in range 0-1
  • 1 - moveTime: Number - move elapsed time (move progress * move duration)
  • 2 - moveDuration: Number - move duration
  • 3 - moveFactor: Number - move blend factor
  • 4 - rtmStep: Vector3D - rtm step (how many meters the unit will move after finishing the animation)
  • 5 - gestureProgress: Number - gesture progress in range 0-1
  • 6 - gestureTime: Number - gesture elapsed time (gesture progress * gesture duration)
  • 7 - gestureDuration: Number - gesture duration
  • 8 - gestureFactor: Number - gesture blend factor

Alternative Syntax

Syntax:
unit getUnitMovesInfo index
Parameters:
unit: Object
index: Number - index of property from the main syntax
Return Value:
Anything - Value of the requested property, or Nothing if index is invalid. See the main syntax.

Examples

Example 1:
// Getting the move velocity of the animation private _animInfo = getUnitMovesInfo player; // velocity = displacement / time private _animVelocity = _animInfo # 4 vectorMultiply -1 / _animInfo # 2; // -1 is because man model is reversed, so the rtm animation moves "backwards"

Additional Information

See also:
switchMove switchGesture moveTime gestureState animationState

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note