animationPhase: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (=)
m (changed global to local variable to make clear the variable)
Line 12: Line 12:
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[Number]] <nowiki>=</nowiki> object '''animationPhase''' "animationName" |= Syntax
| [[Number]] <nowiki>=</nowiki> [[Object]] '''animationPhase''' "animationName" |= Syntax


|p1= object: [[Object]] |= Parameter 1
|p1= object: [[Object]] building eg |= Parameter 1


|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
Line 22: Line 22:
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <pre>building animate ["maindoor",1]
|x1= <pre>_building animate ["maindoor",1]
~2
~2
_p = building animationPhase "maindoor"</pre>
_p = _building animationPhase "maindoor"</pre>


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

Revision as of 06:32, 27 August 2007

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