animationPhase: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[[cC]ategory:[sS]cripting [cC]ommands\|[a-z A-Z 0-9_]+\]\]" to "")
m (Text replacement - "<sqf>([^↵][^<]*↵[^<]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(23 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| ofpr
|game1= ofp
|version1= 1.75


|1.75
|game2= ofpe
|version2= 1.00


|arg= global
|game3= arma1
|version3= 1.00
 
|game4= arma2
|version4= 1.00
 
|game5= arma2oa
|version5= 1.50


|gr1= Animations
|game6= tkoh
|version6= 1.00


| 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.
|game7= arma3
|version7= 0.50


| object '''animationPhase''' animationName
|arg= global


|p1= object: [[Object]] - building eg
|gr1= Animations


|p2= animationName: [[String]] - name of the animation. This is the class-name of the animation defined in the addon's config.cpp.
|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.


| [[Number]] - range 0 (start point of the animation) to 1 (end point of the animation).
|mp= In {{ofp}}, on dedicated servers, ''animationPhase'' will always return 0, no matter what the actual phase is.
 
|x1= <code>_building [[animate]] ["maindoor",1];
[[sleep]] 1;
_p = _building [[animationPhase]] "maindoor";</code>


returns 1 (if the animation speed is <nowiki><=</nowiki> 2 seconds)
|s1= object [[animationPhase]]  animationName


|x2= <code>_flagPole [[animationPhase]] "flag";</code>
|p1= object: [[Object]]


|x3= <code>_tank [[animationPhase]] "MainTurret";</code>
|p2= animationName: [[String]] - name of the animation. This is the class-name of the animation defined in the addon's config.cpp


|mp= In OFP, on dedicated servers, ''animationPhase'' will always return 0, no matter what the actual phase is.| [[animate]], [[moveTime]], [[setFaceAnimation]], [[animateDoor]], [[doorPhase]], [[animateSource]], [[animationSourcePhase]], [[animationNames]]
|r1= [[Number]] - range 0 (start point of the animation) to 1 (end point of the animation)
}}


<dl class="command_description">
|x1= <sqf>
</dl>
_building animate ["maindoor",1];
sleep 1;
_p = _building animationPhase "maindoor";// Returns 1, if the animation speed is two seconds
</sqf>


|x2= <sqf>_flagPole animationPhase "flag";</sqf>


|x3= <sqf>_tank animationPhase "MainTurret";</sqf>


[[Category:Scripting Commands OFP 1.99|ANIMATIONPHASE]]
|seealso= [[animate]] [[moveTime]] [[setFaceAnimation]] [[animateDoor]] [[doorPhase]] [[animateSource]] [[animationSourcePhase]] [[animationNames]]
[[Category:Scripting Commands OFP 1.96|ANIMATIONPHASE]]
}}
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 19:43, 3 September 2024

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:
animate moveTime setFaceAnimation animateDoor doorPhase animateSource animationSourcePhase animationNames

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