animate: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *R([a-z ])" to "$1 - r$2")
 
(86 intermediate revisions by 16 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


|eff= global |= Effects in MP
|game4= arma2
____________________________________________________________________________________________
|version4= 1.00


| Process a linear animation on an object. Such animations are only used in user-made addons, they can be defined in the addon's config.cpp. |= Description
|game5= arma2oa
____________________________________________________________________________________________
|version5= 1.50


| objectName '''animate''' [animationName, phase] |= Syntax
|game6= tkoh
|version6= 1.00


|p1= objectName: [[Object]] |= Parameter 1
|game7= arma3
|version7= 0.50


|p2= [animationName, phase]: [[Array]] |= Parameter 2
|arg= global


|p3= animationName: [[String]] - name of the animation. This is the class-name of the animation defined in the addon's config.cpp. |= Parameter 3
|eff= global


|p4= phase: [[Number]] - 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 4
|gr1= Animations


| [[Nothing]] |= Return value
|descr= Activates given object animation. Animation is defined in CfgModels [[Model Config#Animations|animations]] class. Class names listed in CfgVehicles [[Model Config#AnimationSources|AnimationSources]] bound to "Proxy" controller can also be animated with [[animate]] command (see [[Arma 3: createVehicle/vehicles]]).
____________________________________________________________________________________________
{{Feature|arma3|
 
* It is recommended that [[animateSource]] command is used instead of [[animate]] whenever is possible, as it is more efficient and optimised for multiplayer
|x1= <pre>_building animate ["maindoor", 1]</pre> |= Example 1
* Since {{arma3}} v1.58 animation names can be obtained with [[animationNames]]}}
____________________________________________________________________________________________
{{Feature|warning|Mixing [[animateSource]] command with [[animate]] command to animate the same part may produce some undefined behaviour.}}


| [[animationPhase]], [[animationExists (VBS2)]] |= See also
|s1= object [[animate]] [animationName, phase, speed]


|p1= object: [[Object]]
|p2= animationName: [[String]] - name of the animation. This is the class-name of the animation defined in the config
|p3= phase: [[Number]] - 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
|p4= speed: [[Boolean]] or (since {{GVI|arma3|1.66|size= 0.75}}) [[Number]] - (Optional, default [[false]]) when [[true]] animation is instant; [[Number]] > 0 is treated as config speed value multiplier
|r1= [[Nothing]]
|x1= <sqf>_building animate ["maindoor", 1];</sqf>
|x2= <sqf>_building animate ["Door_1_rot", 1, true];</sqf>
|x3= Create Offroad and add flashing police light bar:
<sqf>
offroad = "C_Offroad_01_F" createVehicle (player getRelPos [5, 0]);
offroad animate ["HidePolice", 0];
offroad animate ["BeaconsStart", 1];
</sqf>
|seealso= [[animationPhase]] [[setFaceAnimation]] [[animateSource]] [[animationSourcePhase]] [[animateDoor]] [[doorPhase]] [[animationNames]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= Mikero
<!-- Note Section BEGIN -->
|timestamp= 20070823225000
<dd class="notedate">Posted on January 20, 2007</dd>
|text= Animations can be used on existing game models such as houses that have doors eg. The general syntax is
<dt class="note">'''[[User:bdfy|bdfy]]'''</dt><dd class="note">Animated object have to be in sight of the player (or camera) for the animation to be actually performed. If the object is not seen, animationPhase will only return zero.</dd>
<sqf>house animate ["dvere1", 1]</sqf>
<dd class="notedate">Posted on Aug 2007</dd>
to 'open' the door and <sqf>house animate ["dvere1", 0]</sqf> to 'close' it. Whether used on Oem addons, or official ones, an internal working knowledge (via config.cpp) of the model's animated name(s) is required.<br>
<dt class="note">'''[[User:Mikero|Mikero]]'''</dt><dd class="note">Animations can be used on existing game models such as houses that have doors eg. The general syntax is house animate ["dvere1",1] to 'open' the door and house animate ["dvere1",0] to 'close it'. Whether used on Oem addons, or official ones, an internal working knowledge (via config.cpp) of the model's animated name(s) is required.
<br>
'open' and 'close' are visual perceptions of the state of the model, and are a design decision of the p3d. Open does not, necessarily mean, 1, and close does not mean 0.<br>
'0' and '1' are better seen as FULLY_OFF and FULLY_ON<br>
If a door is initially closed in the model, FULLY_ON, will open it. If it is initialy OPEN visually, in the model, FULLY_ON will close it.<br>
<br>
{{hl|c= initphase = 1;}} (in config cpp) does not alter open and close meanings, all it does is set the model to the 'on' (rather than 'off') state to begin with. Whether on means open or close visually is a p3d design decision.
}}


'open' and 'close' are visual perceptions of the state of the model. Open does not, necessarily mean, 1, and close does not mean 0. If a door is initially closed in the model, 1, will open it. If it is initialy closed visually, in the model, 1 will close it.
{{Note
|user= Tyger
|timestamp= 20081206082300
|text= Also, to animate the object called "Bar Gate" in ArmA, use the following: <sqf>myGate animate ["Bargate",1]</sqf> to close it, and <sqf>myGate animate ["Bargate", 0]</sqf> to open it.
}}


initphase=1; (in config cpp) does not alter open and close meanings, all it does, is, set the model to the 'on' (rather than 'off') state to begin with. Whether on means open or close visually, is a p3d design decision.
{{Note
|user= RageBone
|timestamp= 20160216213300
|text= "Bargate" was exchanged with "Door_1_rot" at one point:
<sqf>object animate ["Bargate", 0]; // doesn't work</sqf>
<sqf>object animate ["Door_1_rot", 0]; // works</sqf>
}}


</dd>
{{Note
<dd class="notedate">Posted on  June 2011</dd>
|user= Killzone_Kid
<dt class="note">'''[[User:Tyger|Tyger]]'''</dt><dd class="note">Also, to animate the object called "Bar Gate" in ArmA, use the following: <pre>myGate animate ["Bargate",1]</pre> to close it, and <pre>myGate animate ["Bargate", 0]</pre> to open it.</dd>
|timestamp= 20160314003400
<!-- Note Section END -->
|text= To animate bargate use [[animateSource]]:
</dl>
<sqf>bargate animateSource ["Door_1_source", 1];</sqf>
}}


<h3 style="display:none">Bottom Section</h3>
{{Note
|user= SteveStevenson
|timestamp= 20171125205500
|text= For pop-up targets, you can keep the target down (until you tell it to pop up) with:
<sqf>target1 animate ["terc", 1];</sqf>


[[Category:Scripting Commands|ANIMATE]]
When you're ready for the target to pop up, you can use:
[[Category:Scripting Commands OFP 1.96|ANIMATE]]
<sqf>target1 animate ["terc", 0];</sqf>
[[Category:Scripting Commands ArmA|ANIMATE]]
 
[[Category:Command_Group:_System_Commands|{{uc:{{PAGENAME}}}}]]
With this setting, the target will return to its usual behavior of going down when hit and automatically popping back up again. To make the target stay down after being hit, add the following line:
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
<sqf>target1 addEventHandler ["HitPart", { target1 animate ["terc", 1]; }];</sqf>
[[Category:Scripting Commands VBS2|{{uc:{{PAGENAME}}}}]]
}}

Latest revision as of 15:47, 8 November 2023

Hover & click on the images for description

Description

Description:
Activates given object animation. Animation is defined in CfgModels animations class. Class names listed in CfgVehicles AnimationSources bound to "Proxy" controller can also be animated with animate command (see Arma 3: createVehicle/vehicles).
Arma 3
  • It is recommended that animateSource command is used instead of animate whenever is possible, as it is more efficient and optimised for multiplayer
  • Since Arma 3 v1.58 animation names can be obtained with animationNames
Mixing animateSource command with animate command to animate the same part may produce some undefined behaviour.
Groups:
Animations

Syntax

Syntax:
object animate [animationName, phase, speed]
Parameters:
object: Object
animationName: String - name of the animation. This is the class-name of the animation defined in the config
phase: Number - 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
speed: Boolean or (since Arma 3 logo black.png1.66) Number - (Optional, default false) when true animation is instant; Number > 0 is treated as config speed value multiplier
Return Value:
Nothing

Examples

Example 1:
_building animate ["maindoor", 1];
Example 2:
_building animate ["Door_1_rot", 1, true];
Example 3:
Create Offroad and add flashing police light bar:
offroad = "C_Offroad_01_F" createVehicle (player getRelPos [5, 0]); offroad animate ["HidePolice", 0]; offroad animate ["BeaconsStart", 1];

Additional Information

See also:
animationPhase setFaceAnimation animateSource animationSourcePhase animateDoor doorPhase 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
Mikero - c
Posted on Aug 23, 2007 - 22:50 (UTC)
Animations can be used on existing game models such as houses that have doors eg. The general syntax is
house animate ["dvere1", 1]
to 'open' the door and
house animate ["dvere1", 0]
to 'close' it. Whether used on Oem addons, or official ones, an internal working knowledge (via config.cpp) of the model's animated name(s) is required.

'open' and 'close' are visual perceptions of the state of the model, and are a design decision of the p3d. Open does not, necessarily mean, 1, and close does not mean 0.
'0' and '1' are better seen as FULLY_OFF and FULLY_ON
If a door is initially closed in the model, FULLY_ON, will open it. If it is initialy OPEN visually, in the model, FULLY_ON will close it.

initphase = 1; (in config cpp) does not alter open and close meanings, all it does is set the model to the 'on' (rather than 'off') state to begin with. Whether on means open or close visually is a p3d design decision.
Tyger - c
Posted on Dec 06, 2008 - 08:23 (UTC)
Also, to animate the object called "Bar Gate" in ArmA, use the following:
myGate animate ["Bargate",1]
to close it, and
myGate animate ["Bargate", 0]
to open it.
RageBone - c
Posted on Feb 16, 2016 - 21:33 (UTC)
"Bargate" was exchanged with "Door_1_rot" at one point:
object animate ["Bargate", 0]; // doesn't work
object animate ["Door_1_rot", 0]; // works
Killzone_Kid - c
Posted on Mar 14, 2016 - 00:34 (UTC)
To animate bargate use animateSource:
bargate animateSource ["Door_1_source", 1];
SteveStevenson - c
Posted on Nov 25, 2017 - 20:55 (UTC)
For pop-up targets, you can keep the target down (until you tell it to pop up) with:
target1 animate ["terc", 1];
When you're ready for the target to pop up, you can use:
target1 animate ["terc", 0];
With this setting, the target will return to its usual behavior of going down when hit and automatically popping back up again. To make the target stay down after being hit, add the following line:
target1 addEventHandler ["HitPart", { target1 animate ["terc", 1]; }];