getUnitMovesInfo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Example)
mNo edit summary
Line 15: Line 15:


|r1= [[Array]] in format:
|r1= [[Array]] in format:
* 0 - [[Scalar]] - move progress in range 0-1
* 0 - [[Number]] - move progress in range 0-1
* 1 - [[Scalar]] - move elapsed time ({{hl|move progress * move duration}})
* 1 - [[Number]] - move elapsed time ({{hl|move progress * move duration}})
* 2 - [[Scalar]] - move duration
* 2 - [[Number]] - move duration
* 3 - [[Scalar]] - move blend factor
* 3 - [[Number]] - move blend factor
* 4 - [[Vector3D]] - rtm step (how many meters the unit moves after finishing the move)
* 4 - [[Vector3D]] - rtm step (how many meters the unit moves after finishing the move)
* 5 - [[Scalar]] - gesture progress in range 0-1
* 5 - [[Number]] - gesture progress in range 0-1
* 6 - [[Scalar]] - gesture elapsed time ({{hl|gesture progress * gesture duration}})
* 6 - [[Number]] - gesture elapsed time ({{hl|gesture progress * gesture duration}})
* 7 - [[Scalar]] - gesture duration
* 7 - [[Number]] - gesture duration
* 8 - [[Scalar]] - gesture blend factor
* 8 - [[Number]] - gesture blend factor


|s2= unit [[getUnitMovesInfo]] index
|s2= unit [[getUnitMovesInfo]] index

Revision as of 13:47, 26 February 2024

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 - Number - move progress in range 0-1
  • 1 - Number - move elapsed time (move progress * move duration)
  • 2 - Number - move duration
  • 3 - Number - move blend factor
  • 4 - Vector3D - rtm step (how many meters the unit moves after finishing the move)
  • 5 - Number - gesture progress in range 0-1
  • 6 - Number - gesture elapsed time (gesture progress * gesture duration)
  • 7 - Number - gesture duration
  • 8 - 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:
_animInfo = getUnitMovesInfo player; // velocity = displacement / time _animVelocity = _animInfo#4 vectorMultiply -1 / _animInfo#2; // -1 is because man model is reversed, so 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