ctrlCommit: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
(minor sentence formatting edit.)
 
(59 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma |= Game name
|game1= arma1
|version1= 1.00


|1.00|= Game version
|game2= arma2
____________________________________________________________________________________________
|version2= 1.00


| Commits control animation to last specified duration. <br><br>
|game3= arma2oa
{{Important | The animation is not guaranteed to last given duration exactly, it could be shorter it could be longer, it depends on how busy is the rest of the system }}|DESCRIPTION=
|version3= 1.50
____________________________________________________________________________________________


| control '''ctrlCommit''' time |SYNTAX=
|game4= tkoh
|version4= 1.00


|p1= control: [[Control]] - control to animate |PARAMETER1=
|game5= arma3
|version5= 0.50


|p2= time: [[Number]] - animation duration |PARAMETER2=
|gr1= GUI Control


| [[Nothing]] |RETURNVALUE=
|descr= Commits control animation to last specified duration.
____________________________________________________________________________________________
{{Feature|important|The duration of the animation is not guaranteed to be exactly the same as the given time.}}
 
|x1= <code>_control [[ctrlCommit]] 2; // make animation last approx. 2 seconds</code>|EXAMPLE1=
____________________________________________________________________________________________


| [[ctrlCommitted]], [[ctrlSetPosition]], [[ctrlSetFade]]  |SEEALSO=:
|s1= control [[ctrlCommit]] time


}}
|p1= control: [[Control]] - control to animate


<h3 style="display:none">Notes</h3>
|p2= time: [[Number]] - animation duration
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|r1= [[Nothing]]
</dl>


<h3 style="display:none">Bottom Section</h3>
|x1= <sqf>_control ctrlCommit 2; // make animation last approx. 2 seconds</sqf>


[[Category:Scripting Commands|CTRLCOMMIT]]
|seealso= [[ctrlCommitted]] [[ctrlSetPosition]] [[ctrlSetFade]]
[[Category:Scripting Commands ArmA|CTRLCOMMIT]]
}}
[[Category:Command_Group:_GUI_Control|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]


<!-- CONTINUE Notes -->
{{Note
<dl class="command_description">
|user= Nelis.75733126
<dd class="notedate">Posted on April 11, 2015 - 23:06 (UTC)</dd>
|timestamp= 20150411230600
<dt class="note">[[User:IT07|IT07]]</dt>
|text= '''2024-04-16 edit:''':
<dd class="note">
<sqf inline>ctrlCommit</sqf> is required to apply the effect of, for example, ctrlSetFade.
Use this command if you want to for example change the position or size of a control.
}}
</dd>
 
</dl>
{{Note
<!-- DISCONTINUE Notes -->
|user= Demellion
|timestamp= 20170828113300
|text= The resulting speed might not to be exactly what [[ctrlCommit]] commands it to be. It seems to be dependent on your current framerate. Example:
<sqf>_ctrl ctrlSetFade 0.5;
_ctrl ctrlCommit 1;</sqf>
Will actually result in:
{{{!}} class="wikitable"
! FPS
! Duration
{{!}}-
{{!}} 60+
{{!}} ~1.0s
{{!}}-
{{!}} ~30
{{!}} ~1.2s
{{!}}-
{{!}} 10-
{{!}} ~5-10s
{{!}}}
This phenomenon probably occurs because of engine time simulation disruption caused by performance damage.
}}

Latest revision as of 19:06, 16 April 2024

Hover & click on the images for description

Description

Description:
Commits control animation to last specified duration.
The duration of the animation is not guaranteed to be exactly the same as the given time.
Groups:
GUI Control

Syntax

Syntax:
control ctrlCommit time
Parameters:
control: Control - control to animate
time: Number - animation duration
Return Value:
Nothing

Examples

Example 1:
_control ctrlCommit 2; // make animation last approx. 2 seconds

Additional Information

See also:
ctrlCommitted ctrlSetPosition ctrlSetFade

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
Nelis.75733126 - c
Posted on Apr 11, 2015 - 23:06 (UTC)
2024-04-16 edit:: ctrlCommit is required to apply the effect of, for example, ctrlSetFade.
Demellion - c
Posted on Aug 28, 2017 - 11:33 (UTC)
The resulting speed might not to be exactly what ctrlCommit commands it to be. It seems to be dependent on your current framerate. Example:
_ctrl ctrlSetFade 0.5; _ctrl ctrlCommit 1;
Will actually result in:
FPS Duration
60+ ~1.0s
~30 ~1.2s
10- ~5-10s

This phenomenon probably occurs because of engine time simulation disruption caused by performance damage.