ctrlFade: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|Game version=" to "|Game version= |gr1= GUI Control |GROUP1= ")
m (changed the private variable name to something more obvious)
 
(25 intermediate revisions by 3 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


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


| Returns the current fade factor of control. |DESCRIPTION=
|descr= Returns the current fade factor of control.<br>
____________________________________________________________________________________________
{{ Feature | Informative | Despite having <syntaxhighlight lang="cpp" inline>fade = 1;</syntaxhighlight> inside a control's config, <sqf inline>ctrlFade</sqf> will '''still report a fade of 0'''.<br>
Only the value actually set by [[ctrlSetFade]] will be returned by [[ctrlFade]].}}


| [[Number]] <nowiki>=</nowiki> '''ctrlFade''' controlName|SYNTAX=
|s1= [[ctrlFade]] controlName


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


| [[Number]] |RETURNVALUE=
|r1= [[Number]]
____________________________________________________________________________________________
 
|x1= <pre>_scale = ctrlFade _control</pre> |EXAMPLE1=
____________________________________________________________________________________________


| [[ctrlSetFade]] |SEEALSO=
|x1= <sqf>_fade = ctrlFade _control;</sqf>


|seealso= [[ctrlSetFade]]
}}
}}
<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:Scripting Commands|CTRLFADE]]
[[Category:Scripting Commands Armed Assault|CTRLFADE]]
[[Category:Command_Group:_GUI_Control|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]

Latest revision as of 15:19, 21 April 2024

Hover & click on the images for description

Description

Description:
Returns the current fade factor of control.
Despite having fade = 1; inside a control's config, ctrlFade will still report a fade of 0.
Only the value actually set by ctrlSetFade will be returned by ctrlFade.
Groups:
GUI Control

Syntax

Syntax:
ctrlFade controlName
Parameters:
controlName: Control
Return Value:
Number

Examples

Example 1:
_fade = ctrlFade _control;

Additional Information

See also:
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