animate: 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|ANIMATE]]
{{Command|= Comments
[[Category:Scripting Commands OFP 1.96|ANIMATE]]
____________________________________________________________________________________________
[[Category:Scripting Commands ArmA|ANIMATE]]


| ofpr |= Game name


<h2 style="color:#000066">'''''object'' animate [''animation'', ''phase'']'''</h2>
|1.75|= Game version


|arg= global |= Arguments in MP


'''Operand types:'''
|eff= global |= Effects in MP
____________________________________________________________________________________________


'''object:''' [[Object]]
| Process a linear animations on an object. Such animations are only used in user-made addons, they can be defined in the addon's config.cpp. |= Description
____________________________________________________________________________________________


'''[animation, phase]:''' [[Array]]
| object '''animate''' [animation, phase] |= Syntax


'''Type of returned value:'''
|p1= object: [[Object]] |= Parameter 1


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


'''Compatibility:'''
|p3= animationPhase: [[Integer]] - range 0 (start point of the animation) to 1 (end point of the animation). The speed, in which the animation is processed, is defined in the addon's config.cpp and cannot be changed during running missions. |= Parameter 3


Added in version '''1.75'''
| [[Nothing]] |= Return value
____________________________________________________________________________________________
 
|x1= <pre>building animate ["maindoor", 1]</pre> |= Example 1
____________________________________________________________________________________________


'''Description:'''
| [[animationPhase]] |= See also


Process '''animation''' on object.
}}


Animation is defined in config file.
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->


Wanted animation phase is set to '''phase'''.
<!-- Note Section END -->
</dl>


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


'''Example:'''
[[Category:Scripting Commands|ANIMATE]]
 
[[Category:Scripting Commands OFP 1.96|ANIMATE]]
house '''animate''' ["doors1", 1]
[[Category:Scripting Commands ArmA|ANIMATE]]

Revision as of 23:01, 1 August 2006

Hover & click on the images for description

Description

Description:
Process a linear animations on an object. Such animations are only used in user-made addons, they can be defined in the addon's config.cpp.
Groups:
Uncategorised

Syntax

Syntax:
object animate [animation, phase]
Parameters:
object: Object
animation: String - name of the animation. This is the class-name of the animation defined in the addon's config.cpp.
animationPhase: Integer - range 0 (start point of the animation) to 1 (end point of the animation). The speed, in which the animation is processed, is defined in the addon's config.cpp and cannot be changed during running missions.
Return Value:
Nothing

Examples

Example 1:
building animate ["maindoor", 1]

Additional Information

See also:
animationPhase

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