animationPhase: Difference between revisions

Revision as of 12:01, 12 May 2022

Hover & click on the images for description

Description:: Returns the phase of the given animation on the given object. Animation can be scripted (animate, animateSource, animateDoor) or engine driven. Animation names for an object could be found out with animationNames command. When animation is rotation, like with "MainTurret" for example, the output is in radians, to convert to degrees use deg command.
Multiplayer:: In Operation Flashpoint, on dedicated servers, animationPhase will always return 0, no matter what the actual phase is.
Groups:: Animations

Syntax:: object animationPhase animationName
Parameters:: object: Object
: animationName: String - Name of the animation. This is the class-name of the animation defined in the addon's config.cpp
Return Value:: Number - Range 0 (start point of the animation) to 1 (end point of the animation)

Example 1:: _building animate ["maindoor",1]; sleep 1; _p = _building animationPhase "maindoor";// Returns 1, if the animation speed is two seconds
Example 2:: _flagPole animationPhase "flag";
Example 3:: _tank animationPhase "MainTurret";

See also:: animate moveTime setFaceAnimation animateDoor doorPhase animateSource animationSourcePhase animationNames

: 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

@@ Line 42: / Line 42: @@
 _p = _building [[animationPhase]] "maindoor";{{cc|Returns 1, if the animation speed is two seconds}}</code>
-|x2= <code>_flagPole [[animationPhase]] "flag";</code>
+|x2= <code>_flagPole animationPhase "flag";</code>
-|x3= <code>_tank [[animationPhase]] "MainTurret";</code>
+|x3= <code>_tank animationPhase "MainTurret";</code>
 |seealso= [[animate]] [[moveTime]] [[setFaceAnimation]] [[animateDoor]] [[doorPhase]] [[animateSource]] [[animationSourcePhase]] [[animationNames]]
 }}