ctrlCommit: Difference between revisions

Latest revision as of 11:35, 3 September 2024

1.00

1.50

1.00

0.50

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

Nelis75733126 - 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.

@@ 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
-|gr1= GUI Control |GROUP1=
+|game3= arma2oa
+|version3= 1.50
+|game4= tkoh
+|version4= 1.00
+|game5= arma3
+|version5= 0.50
-|gr1= GUI Control |=GROUP1
+|gr1= GUI Control
-____________________________________________________________________________________________
-| Commits control animation to last specified duration. <br><br>
+|descr= Commits control animation to last specified duration.
-{{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=
+{{Feature|important|The duration of the animation is not guaranteed to be exactly the same as the given time.}}
-____________________________________________________________________________________________
-| control '''ctrlCommit''' time |SYNTAX=
+|s1= control [[ctrlCommit]] time
-|p1=  control: [[Control]] - control to animate |PARAMETER1=
+|p1= control: [[Control]] - control to animate
-|p2= time: [[Number]] - animation duration |PARAMETER2=
+|p2= time: [[Number]] - animation duration
-| [[Nothing]] |RETURNVALUE=
+|r1= [[Nothing]]
-____________________________________________________________________________________________
-|x1= <code>_control [[ctrlCommit]] 2; // make animation last approx. 2 seconds</code>|EXAMPLE1=
-____________________________________________________________________________________________
-| [[ctrlCommitted]], [[ctrlSetPosition]], [[ctrlSetFade]]  |SEEALSO=:
+|x1= <sqf>_control ctrlCommit 2; // make animation last approx. 2 seconds</sqf>
+|seealso= [[ctrlCommitted]] [[ctrlSetPosition]] [[ctrlSetFade]]
 }}
-<h3 style="display:none">Notes</h3>
+{{Note
-<dl class="command_description">
+|user= Nelis75733126
-<!-- Note Section BEGIN -->
+|timestamp= 20150411230600
+|text= '''2024-04-16 edit:''':
+<sqf inline>ctrlCommit</sqf> is required to apply the effect of, for example, ctrlSetFade.
+}}
-<!-- Note Section END -->
+{{Note
-</dl>
+|user= Demellion
+|timestamp= 20170828113300
-<h3 style="display:none">Bottom Section</h3>
+|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>
-[[Category:Scripting Commands|CTRLCOMMIT]]
+_ctrl ctrlSetFade 0.5;
-[[Category:Scripting Commands Armed Assault|CTRLCOMMIT]]
+_ctrl ctrlCommit 1;
-[[Category:Command_Group:_GUI_Control|{{uc:{{PAGENAME}}}}]]
+</sqf>
-[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
+Will actually result in:
-[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
+{{{!}} class="wikitable"
-[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
+! FPS
+! Duration
-<!-- CONTINUE Notes -->
+{{!}}-
-<dl class="command_description">
+{{!}} 60+
-<dd class="notedate">Posted on April 11, 2015 - 23:06 (UTC)</dd>
+{{!}} ~1.0s
-<dt class="note">[[User:IT07|IT07]]</dt>
+{{!}}-
-<dd class="note">
+{{!}} ~30
-Use this command if you want to for example change the position or size of a control.
+{{!}} ~1.2s
-</dd>
+{{!}}-
-</dl>
+{{!}} 10-
-<!-- DISCONTINUE Notes -->
+{{!}} ~5-10s
+{{!}}}
+This phenomenon probably occurs because of engine time simulation disruption caused by performance damage.
+}}