animationPhase: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 1: Line 1:
[[Category:Scripting Commands|ANIMATIONPHASE]]
{{Command|= Comments
[[Category:Scripting Commands OFP 1.96|ANIMATIONPHASE]]
____________________________________________________________________________________________
[[Category:Scripting Commands ArmA|ANIMATIONPHASE]]


| ofpr |= Game name


<h2 style="color:#000066">'''''object'' animationPhase ''animation'''''</h2>
|1.75|= Game version


|arg= global |= Arguments in MP
____________________________________________________________________________________________


'''Operand types:'''
| Return the phase of the given animation on the given object, which is set by the [[animate]] command. |= Description
____________________________________________________________________________________________


'''object:''' [[Object]]
| object '''animationPhase''' animation |= Syntax


'''animation:''' [[String]]
|p1= object: [[Object]] |= Parameter 1


'''Type of returned value:'''
|p2= animation: [[String]] - name of the animation. This is the class-name of the animation defined in the addon's config.cpp. |= Parameter 2


[[Number]]
| [[Integer]]
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>


'''Compatibility:'''
returns 1 (if the animation speed is <= 2 seconds) |= Example 1
____________________________________________________________________________________________


Added in version '''1.75'''
| [[animate]] |= See also


'''Description:'''
}}


Return animation phase of '''animation''' on '''object'''.
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
</dl>


'''Example:'''
<h3 style="display:none">Bottom Section</h3>


house '''animationPhase''' "doors1"
[[Category:Scripting Commands|ANIMATIONPHASE]]
[[Category:Scripting Commands OFP 1.96|ANIMATIONPHASE]]
[[Category:Scripting Commands ArmA|ANIMATIONPHASE]]

Revision as of 22:02, 1 August 2006

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.
Groups:
Uncategorised

Syntax

Syntax:
object animationPhase animation
Parameters:
object: Object
animation: String - name of the animation. This is the class-name of the animation defined in the addon's config.cpp.
Return Value:
Integer - 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

Bottom Section