animate: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "Category:Scripting Commands ArmA2" to "Category:Scripting Commands Arma 2")
(Fix description and clean comments)
Line 11: Line 11:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Activates given object animation. Animation is defined in CfgModels ''Animations'' class of model.cfg or another model config. Since Arma 3 v1.65.138459 speed of animation can be altered with coefficient.
| Activates given object animation. Animation is defined in CfgModels [[Model Config#Animations|animations]] class.<br>
 
Since {{arma3}} v1.58 animation names can be obtained with [[animationNames]].<br>
<br><br>To animate door of the house from example below: <tt>house [[animate]] ["Door_1_rot", 1];</tt>
<br>
<syntaxhighlight lang="cpp">
Class names listed in CfgVehicles [[Model Config#AnimationSources|AnimationSources]] bound to "Proxy" controller can also be animated with [[animate]] command (see [[createVehicle/vehicles]]).
class Animations
{
class Door_1_rot
{
type = rotation;
source = Door_1_source;
selection = Door_1;
axis = Door_1_axis;
memory = 1;
minValue = 0.1;
maxValue = 1;
angle0 = 0;
angle1 = (rad 110);
};
class Door_Handle_1_rot_1
{
type = rotation;
source = Door_1_handle_source;
selection = Door_Handle_1;
axis = Door_Handle_1_axis;
memory = 1;
minValue = 0;
maxValue = 0.1;
angle0 = 0;
angle1 = (rad -50);
};
};</syntaxhighlight>
 
Since model.cfg is not always available for reference, most animation names could also be obtained from [[animationNames]] command. Class names listed in [[CfgVehicles]] ''AnimationSources'' bound to "Proxy" controller can also be animated with [[animate]] command (see [[createVehicle/vehicles]]): <tt>offroad [[animate]] ["HideBackpacks", 0];</tt><br><br>


{{Feature arma3| It is recommended that [[animateSource]] command is used instead of [[animate]] whenever is possible, as it is more efficient and optimised for MP}}
{{Feature arma3| It is recommended that [[animateSource]] command is used instead of [[animate]] whenever is possible, as it is more efficient and optimised for MP}}
Line 50: Line 21:
____________________________________________________________________________________________
____________________________________________________________________________________________


| objectName '''animate''' [animationName, phase, speed] |SYNTAX=
| objectName [[animate]] [animationName, phase, speed] |SYNTAX=


|p1= objectName: [[Object]] |PARAMETER1=
|p1= objectName: [[Object]] |PARAMETER1=
Line 58: Line 29:
|p3= animationName: [[String]] - name of the animation. This is the class-name of the animation defined in the config. |PARAMETER3=
|p3= animationName: [[String]] - name of the animation. This is the class-name of the animation defined in the config. |PARAMETER3=


|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. |PARAMETER5=
|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. |PARAMETER4=


|p5= speed: [[Boolean]] or [[Number]] - When [[true]] animation is instant. Since Arma 3 v1.65.138459 [[Number]] > 0 is treated as config speed value multiplier |PARAMETER4=
|p5= speed: [[Boolean]] or [[Number]] - When [[true]] animation is instant. Since {{arma3}} v1.65.138459 [[Number]] > 0 is treated as config speed value multiplier |PARAMETER5=


| [[Nothing]] |RETURNVALUE=
| [[Nothing]] |RETURNVALUE=
Line 67: Line 38:
   
   
|x1= <code>_building [[animate]] ["maindoor", 1];</code> |EXAMPLE1=
|x1= <code>_building [[animate]] ["maindoor", 1];</code> |EXAMPLE1=
|x2= <code>_building [[animate]] ["Door_1_rot", 1, [[true]]];</code> |EXAMPLE2=
|x2= <code>_building [[animate]] ["Door_1_rot", 1, [[true]]];</code> |EXAMPLE2=
|x3= Create Offroad and add flashing police light bar:<code>offroad = "C_Offroad_01_F" [[createVehicle]] ([[player]] [[getRelPos]] [5, 0]);
|x3= Create Offroad and add flashing police light bar:<code>offroad = "C_Offroad_01_F" [[createVehicle]] ([[player]] [[getRelPos]] [5, 0]);
offroad [[animate]] ["HidePolice", 0];
offroad [[animate]] ["HidePolice", 0];
Line 81: Line 54:
<!-- Note Section BEGIN -->
<!-- Note Section BEGIN -->
<dd class="notedate">Posted on Aug 2007
<dd class="notedate">Posted on Aug 2007
<dt class="note">'''[[User:Mikero|Mikero]]'''<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.
<dt class="note">[[User:Mikero|Mikero]]
 
<dd class="note">Animations can be used on existing game models such as houses that have doors eg. The general syntax is<code>house [[animate]] ["dvere1", 1]</code>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
'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.
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>
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.
<tt>initphase = 1;</tt> (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.
 


<dd class="notedate">Posted on  June 2011
<dd class="notedate">Posted on  June 2011
<dt class="note">'''[[User:Tyger|Tyger]]'''<dd class="note">Also, to animate the object called "Bar Gate" in ArmA, use the following: <code>myGate [[animate]] ["Bargate",1]</code> to close it, and <code>myGate [[animate]] ["Bargate", 0]</code> to open it.
<dt class="note">[[User:Tyger|Tyger]]
<dd class="note">Also, to animate the object called "Bar Gate" in ArmA, use the following: <code>myGate [[animate]] ["Bargate",1]</code> to close it, and <code>myGate [[animate]] ["Bargate", 0]</code> to open it.
<!-- Note Section END -->
<!-- Note Section END -->
</dl>
</dl>
Line 98: Line 71:
<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>


[[Category:Scripting Commands|ANIMATE]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.99|ANIMATE]]
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|ANIMATE]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA|ANIMATE]]
[[Category:Scripting Commands ArmA|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_System_Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
 
[[Category:Command Group: System Commands|{{uc:{{PAGENAME}}}}]]
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on June 21, 2015 - 16:41 (UTC)</dd>
<dt class="note">[[User:LeClubBWA|LeClubBWA]]</dt>
<dd class="note">
 
With this command you can switch the offroad police lights on like this :<br>
 
<code>_vehicle animate ["BeaconsStart",1];</code>
 
And switch it off :<br>
 
<code>_vehicle animate ["BeaconsStart",0];</code>
</dd>
</dl>
<!-- DISCONTINUE Notes -->


<!-- CONTINUE Notes -->
<!-- CONTINUE Notes -->
Line 129: Line 85:
<dt class="note">[[User:RageBone|RageBone]]</dt>
<dt class="note">[[User:RageBone|RageBone]]</dt>
<dd class="note">
<dd class="note">
 
"Bargate" was exchanged with "Door_1_rot" at one point:
 
<code>object [[animate]] ["Bargate", 0]; {{cc|doesn't work}}</code>
 
<code>object [[animate]] ["Door_1_rot", 0]; {{cc|works}}</code>
Aparently  "Bargate" was exchainged with "Door_1_rot"<br>
 
Doesen't work:<br>
<code>object animate ["Bargate", 0];</code><br>
Works:<br>
<code>object animate ["Door_1_rot", 0];</code><br>
</dd>
</dd>
</dl>
</dl>
<!-- DISCONTINUE Notes -->


<!-- CONTINUE Notes -->
<dl class="command_description">
<dl class="command_description">
<dd class="notedate">Posted on March 14, 2016 - 00:34 (UTC)</dd>
<dd class="notedate">Posted on March 14, 2016 - 00:34 (UTC)</dd>
Line 148: Line 96:
<dd class="note">
<dd class="note">
To animate bargate use [[animateSource]]:
To animate bargate use [[animateSource]]:
<code>bargate animateSource ["Door_1_source", 1];</code>
<code>bargate [[animateSource]] ["Door_1_source", 1];</code>
</dd>
</dd>
</dl>
</dl>
<!-- DISCONTINUE Notes -->


<!-- CONTINUE Notes -->
<dl class="command_description">
<dl class="command_description">
<dd class="notedate">Posted on November 25, 2017 - 20:55 (UTC)</dd>
<dd class="notedate">Posted on November 25, 2017 - 20:55 (UTC)</dd>
Line 159: Line 105:
<dd class="note">
<dd class="note">


:For pop-up targets, you can keep the target down (until you tell it to pop up) with:
For pop-up targets, you can keep the target down (until you tell it to pop up) with:
 
<code>target1 [[animate]] ["terc", 1];</code>
:<code>target1 animate ["terc", 1];</code>
 
:When you're ready for the target to pop up, you can use:
 
:<code>target1 animate ["terc", 0];</code>


: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:
When you're ready for the target to pop up, you can use:
<code>target1 [[animate]] ["terc", 0];</code>


:<code>target1 addEventHandler ["HitPart", {target1 animate ["terc", 1];}];</code>
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:
<code>target1 [[addEventHandler]] ["HitPart", { target1 [[animate]] ["terc", 1]; }];</code>


</dd>
</dd>
</dl>
</dl>
<!-- DISCONTINUE Notes -->
<!-- DISCONTINUE Notes -->

Revision as of 15:27, 7 February 2020

Hover & click on the images for description

Description

Description:
Activates given object animation. Animation is defined in CfgModels animations class.
Since Arma 3 v1.58 animation names can be obtained with animationNames.

Class names listed in CfgVehicles AnimationSources bound to "Proxy" controller can also be animated with animate command (see 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 MP
Mixing animateSource command with animate command to animate the same part may produce some undefined behaviour
Groups:
Uncategorised

Syntax

Syntax:
objectName animate [animationName, phase, speed]
Parameters:
objectName: Object
[animationName, phase, speed]: Array
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 Number - When true animation is instant. Since Arma 3 v1.65.138459 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:
animationPhasesetFaceAnimationanimateSourceanimationSourcePhaseanimateDoordoorPhaseanimationNames

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 Aug 2007
Mikero
Animations can be used on existing game models such as houses that have doors eg. The general syntax ishouse 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.
Posted on June 2011
Tyger
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.

Bottom Section

Posted on February 16, 2016 - 21:33 (UTC)
RageBone
"Bargate" was exchanged with "Door_1_rot" at one point: object animate ["Bargate", 0]; // doesn't work object animate ["Door_1_rot", 0]; // works
Posted on March 14, 2016 - 00:34 (UTC)
Killzone Kid
To animate bargate use animateSource: bargate animateSource ["Door_1_source", 1];
Posted on November 25, 2017 - 20:55 (UTC)
SteveStevenson
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]; }];