animationPhase: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:Scripting Commands OFP 1.[4-9]{2}(\|(\{\{uc:\{\{PAGENAME\}\}\}\}|#|[A-Z]+))?\]\] " to "")
m (formatting)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| ofpr
|game1= ofp


|1.75
|version1= 1.75
 
|game2= ofpe
 
|version2= 1.00
 
|game3= arma1
 
|version3= 1.00
 
|game4= arma2
 
|version4= 1.00
 
|game5= arma2oa
 
|version5= 1.51
 
|game6= tkoh
 
|version6= 1.00
 
|game7= arma3
 
|version7= 0.50


|arg= global
|arg= global
Line 9: Line 33:
|gr1= Animations
|gr1= Animations


| 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.
|descr= 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.


| object '''animationPhase''' animationName
|mp= In {{ofp}}, on dedicated servers, ''animationPhase'' will always return 0, no matter what the actual phase is.


|p1= object: [[Object]] - building eg
|s1= object '''animationPhase''' animationName


|p2= animationName: [[String]] - name of the animation. This is the class-name of the animation defined in the addon's config.cpp.
|p1= object: [[Object]]


| [[Number]] - range 0 (start point of the animation) to 1 (end point of the animation).
|p2= animationName: [[String]] - Name of the animation. This is the class-name of the animation defined in the addon's config.cpp
 
|r1= [[Number]] - Range 0 (start point of the animation) to 1 (end point of the animation)
   
   
|x1= <code>_building [[animate]] ["maindoor",1];
|x1= <code>_building [[animate]] ["maindoor",1];
[[sleep]] 1;
[[sleep]] 1;
_p = _building [[animationPhase]] "maindoor";</code>
_p = _building [[animationPhase]] "maindoor";{{cc|Returns 1, if the animation speed is two seconds}}</code>
 
returns 1 (if the animation speed is <nowiki><=</nowiki> 2 seconds)


|x2= <code>_flagPole [[animationPhase]] "flag";</code>
|x2= <code>_flagPole [[animationPhase]] "flag";</code>
Line 29: Line 53:
|x3= <code>_tank [[animationPhase]] "MainTurret";</code>
|x3= <code>_tank [[animationPhase]] "MainTurret";</code>


|mp= In OFP, on dedicated servers, ''animationPhase'' will always return 0, no matter what the actual phase is.|seealso= [[animate]], [[moveTime]], [[setFaceAnimation]], [[animateDoor]], [[doorPhase]], [[animateSource]], [[animationSourcePhase]], [[animationNames]]
|seealso= [[animate]], [[moveTime]], [[setFaceAnimation]], [[animateDoor]], [[doorPhase]], [[animateSource]], [[animationSourcePhase]], [[animationNames]]
}}
}}
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Revision as of 10:02, 27 March 2021

Logo A0.png1.75ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.51tkoh logo small.png1.00Arma 3 logo black.png0.50
GAGlobal
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 Operation Flashpoint, on dedicated servers, animationPhase will always return 0, no matter what the actual phase is.
Groups:
Animations

Syntax

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)

Examples

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";

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
Retrieved from "https://community.bistudio.com/wiki?title=animationPhase&oldid=251821"