animationPhase: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (VBS2 scripting category removal)
(mass edit: removing obsolete </dt> and </dd> tags)
Line 37: Line 37:
<dl class="command_description">
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section BEGIN -->
<dd class="notedate">Posted on January 20, 2007</dd>
<dd class="notedate">Posted on January 20, 2007
<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>
<dt class="note">'''[[User:Bdfy|Bdfy]]'''<dd class="note">If animated object is not seen by the player or camera, animationPhase will only return zero.
   
   
<!-- Note Section END -->
<!-- Note Section END -->

Revision as of 17:49, 17 October 2011

Hover & click on the images for description

Description

Description:
Return the phase of the given animation on the given object, which is set by the animate command.
Multiplayer:
In OFP, on dedicated servers, animationPhase will always return 0, no matter what the actual phase is.
Groups:
Uncategorised

Syntax

Syntax:
Number = 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 - Integer of range 0 (start point of the animation) to 1 (end point of the animation).

Examples

Example 1:
_building animate ["maindoor",1]
~2
_p = _building animationPhase "maindoor"
returns 1 (if the animation speed is <= 2 seconds)

Additional Information

See also:
animate

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

Posted on January 20, 2007
Bdfy
If animated object is not seen by the player or camera, animationPhase will only return zero.

Bottom Section