animationPhase: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Bot: Reverted to revision 97307 by killzone_kid on 2016-09-08T21:19:18Z)
m (template:command argument fix)
Line 9: Line 9:
____________________________________________________________________________________________
____________________________________________________________________________________________


| 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. |= 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. |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| object '''animationPhase''' animationName |= Syntax
| object '''animationPhase''' animationName |SYNTAX=


|p1= object: [[Object]] - building eg |= Parameter 1
|p1= object: [[Object]] - building eg |= Parameter 1
Line 18: Line 18:
|p2= animationName: [[String]] - name of the animation. This is the class-name of the animation defined in the addon's config.cpp. |= Parameter 2
|p2= animationName: [[String]] - name of the animation. This is the class-name of the animation defined in the addon's config.cpp. |= Parameter 2


| [[Number]] - range 0 (start point of the animation) to 1 (end point of the animation). |= Return value
| [[Number]] - range 0 (start point of the animation) to 1 (end point of the animation). |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
Line 33: Line 33:


| mp = In OFP, on dedicated servers, ''animationPhase'' will always return 0, no matter what the actual phase is. |= Multiplayer
| mp = In OFP, on dedicated servers, ''animationPhase'' will always return 0, no matter what the actual phase is. |= Multiplayer
| [[animate]], [[moveTime]], [[setFaceAnimation]], [[animateDoor]], [[doorPhase]], [[animateSource]], [[animationSourcePhase]], [[animationNames]] |= See also
| [[animate]], [[moveTime]], [[setFaceAnimation]], [[animateDoor]], [[doorPhase]], [[animateSource]], [[animationSourcePhase]], [[animationNames]] |SEEALSO=


}}
}}

Revision as of 12:25, 7 April 2019

Hover & click on the images for description

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 OFP, on dedicated servers, animationPhase will always return 0, no matter what the actual phase is.
Groups:
Uncategorised

Syntax

Syntax:
object animationPhase animationName
Parameters:
object: Object - building eg
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).

Examples

Example 1:
_building animate ["maindoor",1]; sleep 1; _p = _building animationPhase "maindoor"; returns 1 (if the animation speed is <= 2 seconds)
Example 2:
_flagPole animationPhase "flag";
Example 3:
_tank animationPhase "MainTurret";

Additional Information

See also:
animatemoveTimesetFaceAnimationanimateDoordoorPhaseanimateSourceanimationSourcePhaseanimationNames

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

Notes

Bottom Section