ctrlEnabled: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "Dialog Control" to "Arma: GUI Configuration")
m (Some wiki formatting)
 
(36 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| ofp |Game name=
|game1= ofp
|version1= 1.75


|1.5|Game version=
|game2= ofpe
|version2= 1.00


|arg= local |Multiplayer Arguments=
|game3= arma1
____________________________________________________________________________________________
|version3= 1.00


| Returns if a control on the currently active user dialog is enabled. Disabled controls cannot be focused.
|game4= arma2
|version4= 1.00


Read [[Arma: GUI Configuration]] for more information about user dialogs and controls. |DESCRIPTION=
|game5= arma2oa
____________________________________________________________________________________________
|version5= 1.50


| [[Boolean]] <nowiki>=</nowiki>  '''ctrlEnabled''' idc |SYNTAX=
|game6= tkoh
|version6= 1.00


|p1= idc: [[Number]] - control ID |PARAMETER1=
|game7= arma3
|version7= 0.50


| [[Boolean]] - 
|arg= local
true if the control is enabled, false if not. |RETURNVALUE=
____________________________________________________________________________________________


|s2= [[Boolean]] <nowiki>=</nowiki> '''ctrlEnabled''' controlName |Alternative Syntax=
|gr1= GUI Control


|p21= controlName: [[Control]] |PARAMETER21=
|descr= Returns if a control on the currently active user dialog is enabled. Disabled controls cannot be focused. Read [[Arma: GUI Configuration]] for more information about user dialogs and controls.


|r2= [[Boolean]] |RETURNVALUE2=____________________________________________________________________________________________
|s1= [[ctrlEnabled]] idc
 
|x1= <pre>if (!(ctrlEnabled 100)) then
{
  ctrlEnable [100, true]
};</pre> |EXAMPLE1=


|x2= <pre>_enabled = ctrlEnabled _control</pre> |EXAMPLE2=
|p1= idc: [[Number]] - control's IDC
____________________________________________________________________________________________


| [[ctrlEnable]] |SEEALSO=
|r1= [[Boolean]] - [[true]] if the control is enabled, [[false]] if not


}}
|s2= [[ctrlEnabled]] controlName


<h3 style="display:none">Notes</h3>
|p21= controlName: [[Control]]
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|r2= [[Boolean]] - [[true]] if the control is enabled, [[false]] if not
</dl>


<h3 style="display:none">Bottom Section</h3>
|x1= <sqf>
if !(ctrlEnabled 100) then
{
ctrlEnable [100, true];
};
</sqf>


[[Category:Scripting Commands|CTRLENABLED]]
|x2= <sqf>_enabled = ctrlEnabled _control;</sqf>
[[Category:Scripting Commands OFP 1.99|CTRLENABLED]]
 
[[Category:Scripting Commands OFP 1.96|CTRLENABLED]]
|seealso= [[ctrlEnable]]
[[Category:Scripting Commands ArmA|CTRLENABLED]]
}}
[[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:59, 20 March 2023

Hover & click on the images for description

Description

Description:
Returns if a control on the currently active user dialog is enabled. Disabled controls cannot be focused. Read Arma: GUI Configuration for more information about user dialogs and controls.
Groups:
GUI Control

Syntax

Syntax:
ctrlEnabled idc
Parameters:
idc: Number - control's IDC
Return Value:
Boolean - true if the control is enabled, false if not

Alternative Syntax

Syntax:
ctrlEnabled controlName
Parameters:
controlName: Control
Return Value:
Boolean - true if the control is enabled, false if not

Examples

Example 1:
if !(ctrlEnabled 100) then { ctrlEnable [100, true]; };
Example 2:
_enabled = ctrlEnabled _control;

Additional Information

See also:
ctrlEnable

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