animationPhase: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "<sqf>([^↵][^<]*↵[^<]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(67 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| ofpr |= Game name
|game1= ofp
|version1= 1.75


|1.75|= Game version
|game2= ofpe
|version2= 1.00


|arg= global |= Arguments in MP
|game3= arma1
____________________________________________________________________________________________
|version3= 1.00


| Return the phase of the given animation on the given object, which is set by the [[animate]] command. |= Description
|game4= arma2
____________________________________________________________________________________________
|version4= 1.00


| [[Number]] <nowiki>=</nowiki> object '''animationPhase''' animationName |= Syntax
|game5= arma2oa
|version5= 1.50


|p1= object: [[Object]] - building eg |= Parameter 1
|game6= tkoh
|version6= 1.00


|p2= animationName: [[String]] - name of the animation. This is the class-name of the animation defined in the addon's config.cpp. |= Parameter 2
|game7= arma3
|version7= 0.50


| [[Number]] - 
|arg= global
Integer of range 0 (start point of the animation) to 1 (end point of the animation). |= Return value
____________________________________________________________________________________________
 
|x1= <pre>_building animate ["maindoor",1]
~2
_p = _building animationPhase "maindoor"</pre>


returns 1 (if the animation speed is <nowiki><=</nowiki> 2 seconds) |= Example 1
|gr1= Animations
____________________________________________________________________________________________


| mp = In OFP, on dedicated servers, ''animationPhase'' will always return 0, no matter what the actual phase is. |= Multiplayer
|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.
| [[animate]] |= See also


}}
|mp= In {{ofp}}, on dedicated servers, ''animationPhase'' will always return 0, no matter what the actual phase is.
 
|s1= object [[animationPhase]]  animationName
 
|p1= object: [[Object]]
 
|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= <sqf>
_building animate ["maindoor",1];
sleep 1;
_p = _building animationPhase "maindoor";// Returns 1, if the animation speed is two seconds
</sqf>


<h3 style="display:none">Notes</h3>
|x2= <sqf>_flagPole animationPhase "flag";</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->
<dd class="notedate">Posted on January 20, 2007</dd>
<dt class="note">'''[[User:Bdfy|Bdfy]]'''</dt><dd class="note">If animated object is not seen by the player or camera, animationPhase will only return zero.</dd>
<!-- Note Section END -->
</dl>


<h3 style="display:none">Bottom Section</h3>
|x3= <sqf>_tank animationPhase "MainTurret";</sqf>


[[Category:Scripting Commands|ANIMATIONPHASE]]
|seealso= [[animate]] [[moveTime]] [[setFaceAnimation]] [[animateDoor]] [[doorPhase]] [[animateSource]] [[animationSourcePhase]] [[animationNames]]
[[Category:Scripting Commands OFP 1.96|ANIMATIONPHASE]]
}}
[[Category:Scripting Commands ArmA|ANIMATIONPHASE]]
[[Category:Command_Group:_System_Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 19:43, 3 September 2024

Logo A0.png1.75ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh 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:
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
Retrieved from "https://community.bistudio.com/wiki?title=animationPhase&oldid=369354"