ctrlSetFade: Difference between revisions

From Bohemia Interactive Community
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
m (Text replacement - "<sqf>([^↵][^\/]*↵[^\/]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(34 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma1 |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


| Sets wanted transparency for control animation. Requires [[ctrlCommit]] to commit changes. To hide or show a control instantly, use [[ctrlShow]].|DESCRIPTION=
|game4= tkoh
____________________________________________________________________________________________
|version4= 1.00


| controlName '''ctrlSetFade''' fade |SYNTAX=
|game5= arma3
|version5= 0.50


|p1= controlName: [[Control]] |PARAMETER1=
|gr1= GUI Control


|p2= fade: [[Number]] |PARAMETER2=
|descr= Sets wanted transparency for control animation. Requires [[ctrlCommit]] to commit changes. To hide or show a control instantly, use [[ctrlShow]].
{{Feature|informative|
If there are multiple (interactable) controls on top of each other but the top-most control is faded using <sqf inline>ctrlSetFade 1</sqf>,
this control will interfere with other controls that were defined earlier and in the exact same position.
To counter that, the faded control '''must''' be disabled with [[ctrlEnable]].
}}


| [[Nothing]] |RETURNVALUE=
|pr= Despite having <syntaxhighlight lang="cpp" inline>fade = 1;</syntaxhighlight> in a control's config, [[ctrlFade]] will still report a fade of 0 - resulting in <sqf inline>ctrlSetFade 0</sqf> doing nothing.<br>
____________________________________________________________________________________________
To counter that, first use <sqf inline>ctrlSetFade 1</sqf>, then <sqf inline>ctrlCommit 0</sqf> to apply it, and only then [[ctrlSetFade]] can be used as usual.
 
|x1= <code>_control [[ctrlSetFade]] 1;
_control [[ctrlCommit]] 5;</code> |EXAMPLE1=
____________________________________________________________________________________________


| [[ctrlFade]], [[cutFadeOut]], [[ctrlCommit]] |SEEALSO=
|s1= controlName [[ctrlSetFade]] fade


}}
|p1= controlName: [[Control]]


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


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


<h3 style="display:none">Bottom Section</h3>
|x1= <sqf>
_control ctrlSetFade 1;
_control ctrlCommit 5;
</sqf>


[[Category:Scripting Commands|CTRLSETFADE]]
|seealso= [[ctrlFade]] [[cutFadeOut]] [[ctrlCommit]]
{{GameCategory|arma1|Scripting Commands}}
}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}


<!-- CONTINUE Notes -->
{{Note
<dl class="command_description">
|user= Nelis75733126
<dd class="notedate">Posted on March 10, 2015 - 02:02 (UTC)</dd>
|timestamp= 20240416211007
<dt class="note">[[User:Feint|Feint]]</dt>
|text=in {{arma3}} 2.17, when <sqf inline>ctrlSetFade</sqf> is used on a CtrlToolbox or RscToolbox, it only has effect on the text of it.
<dd class="note">
}}
This command sets the amount of fade. For example:
<code>
_ctrl ctrlSetFade 1; // hides the control<br>
_ctrl ctrlSetFade 0.5; // control is 50% visible<br>
_ctrl ctrlSetFade 0; // control is fully visible
</code>
</dd>
</dl>
<dl class="command_description">
<dd class="notedate">Posted on August 28, 2017 - 11:33 (UTC)</dd>
<dt class="note">[[User:Demellion|Demellion]]</dt>
<dd class="note">
The resulting fade speed seems like is not exactly what [[ctrlCommit]] commands it to be, as is dependant on your current framerate. Example:
<code>_ctrl ctrlSetFade 0.5;
_ctrl ctrlCommit 1;
</code>
Will actually result in:
<code>'''[60 FPS and higher]''' = ~1.0 seconds
'''[30 FPS and around]''' = ~1.2 seconds
'''[10 FPS and anything lower]''' = ~5-10 seconds
</code>
This phenomenon probably occurs because of engine time simulation disruption caused by performance damage.
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 11:35, 3 September 2024

Logo A1 black.png 1.00Logo A2.png 1.00A2 OA Logo.png 1.50tkoh logo small.png 1.00Arma 3 logo black.png 0.50
Hover & click on the images for description

Description

Description:
Sets wanted transparency for control animation. Requires ctrlCommit to commit changes. To hide or show a control instantly, use ctrlShow.
ⓘ
If there are multiple (interactable) controls on top of each other but the top-most control is faded using ctrlSetFade 1,

this control will interfere with other controls that were defined earlier and in the exact same position.

To counter that, the faded control must be disabled with ctrlEnable.
Problems:
Despite having fade = 1; in a control's config, ctrlFade will still report a fade of 0 - resulting in ctrlSetFade 0 doing nothing.
To counter that, first use ctrlSetFade 1, then ctrlCommit 0 to apply it, and only then ctrlSetFade can be used as usual.
Groups:
GUI Control

Syntax

Syntax:
controlName ctrlSetFade fade
Parameters:
controlName: Control
fade: Number
Return Value:
Nothing

Examples

Example 1:
_control ctrlSetFade 1; _control ctrlCommit 5;

Additional Information

See also:
ctrlFade cutFadeOut ctrlCommit

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 16, 2024 - 21:10 (UTC)
in Arma 3 2.17, when ctrlSetFade is used on a CtrlToolbox or RscToolbox, it only has effect on the text of it.
Retrieved from "https://community.bistudio.com/wiki?title=ctrlSetFade&oldid=369232"