ctrlAnimateModel: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Some wiki formatting)
 
(45 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 1.84


|1.84|= Game version
|gr1= GUI Control - Object
____________________________________________________________________________________________


| Process an animation of 3D [[Dialog Control]]. Command uses name defined by source property and works similar like [[animateSource]] command. |= Description
|descr= Process an animation of 3D [[Arma: GUI Configuration]]. Command uses name defined by source property and works similar like [[animateSource]] command.
____________________________________________________________________________________________


| control '''ctrlAnimateModel''' [source, phase]|= Syntax
|s1= control [[ctrlAnimateModel]] [source, phase, speed]


|p1= control : [[Control]] - 3D control|PARAMETER1=
|p1= control : [[Control]] - 3D control


|p2= [source, phase]: [[Array]] |PARAMETER2=
|p2= source: [[String]] - common source


|p3= source: [[String]] - common source |PARAMETER3=
|p3= phase: [[Number]] - wanted animation phase


|p4= phase: [[Number]] - wanted animation phase |PARAMETER4=  
|p4= speed: [[Boolean]] or [[Number]] - (Optional, default [[false]])
* [[Boolean]] - when set to [[true]], animation is instant
* {{GVI|arma3|1.66|size= 0.75}} [[Number]] - > 0 is treated as config speed value multiplier


| [[Nothing]] |RETURNVALUE=
|r1= [[Nothing]]


|x1= <sqf>_control3D ctrlAnimateModel ["Close", 1];</sqf>


|x1= <code>_control3D [[ctrlAnimateModel]] ["Close",1];</code>|EXAMPLE1=
|x2= <sqf>_ctrlLaptop ctrlAnimateModel ["Lid", 1, 2];</sqf>


____________________________________________________________________________________________
|seealso= [[ctrlAnimationPhaseModel]] [[ctrlCreate]] [[ctrlDelete]] [[ctrlModel]] [[ctrlPosition]] [[ctrlSetPosition]] [[ctrlClassName]] [[displayCtrl]] [[ctrlModelScale]] [[ctrlSetModelScale]] [[ctrlModelDirAndUp]] [[ctrlSetModelDirAndUp]]
 
| [[ctrlAnimationPhaseModel]], [[ctrlCreate]], [[ctrlDelete]], [[ctrlModel]], [[ctrlPosition]], [[ctrlSetPosition]], [[ctrlClassName]], [[displayCtrl]], [[ctrlModelScale]], [[ctrlSetModelScale]], [[ctrlModelDirAndUp]], [[ctrlSetModelDirAndUp]] |SEEALSO=
 
|  |MPBEHAVIOUR=
____________________________________________________________________________________________
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_GUI_Control|{{uc:{{PAGENAME}}}}]]

Latest revision as of 00:03, 8 August 2022

Hover & click on the images for description

Description

Description:
Process an animation of 3D Arma: GUI Configuration. Command uses name defined by source property and works similar like animateSource command.
Groups:
GUI Control - Object

Syntax

Syntax:
control ctrlAnimateModel [source, phase, speed]
Parameters:
control : Control - 3D control
source: String - common source
phase: Number - wanted animation phase
speed: Boolean or Number - (Optional, default false)
  • Boolean - when set to true, animation is instant
  • Arma 3 logo black.png1.66 Number - > 0 is treated as config speed value multiplier
Return Value:
Nothing

Examples

Example 1:
_control3D ctrlAnimateModel ["Close", 1];
Example 2:
_ctrlLaptop ctrlAnimateModel ["Lid", 1, 2];

Additional Information

See also:
ctrlAnimationPhaseModel ctrlCreate ctrlDelete ctrlModel ctrlPosition ctrlSetPosition ctrlClassName displayCtrl ctrlModelScale ctrlSetModelScale ctrlModelDirAndUp ctrlSetModelDirAndUp

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