ctrlEnable: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| ofp |Game name=
| ofp


|1.5|Game version=
|1.5


|arg= local |Multiplayer Arguments=
|arg= local


|eff= local |Multiplayer Effects=
|eff= local


|gr1= GUI Control |GROUP1=
|gr1= GUI Control


| Enable or disable a control of the currently active user dialog. Disabled controls cannot be clicked onto.
| Enable or disable a control of the currently active user dialog. Disabled controls cannot be clicked onto.


Read [[Arma: GUI Configuration]] for more information about user dialogs and controls. |DESCRIPTION=
Read [[Arma: GUI Configuration]] for more information about user dialogs and controls.


| '''ctrlEnable''' [idc, enable] |SYNTAX=
| '''ctrlEnable''' [idc, enable]


|p1= [idc, enable]: [[Array]] |PARAMETER1=
|p1= [idc, enable]: [[Array]]


|p2= idc: [[Number]] - control ID |PARAMETER2=
|p2= idc: [[Number]] - control ID


|p3= enable: [[Boolean]] - true to enable the control, false to disable it |PARAMETER3=
|p3= enable: [[Boolean]] - true to enable the control, false to disable it


| [[Nothing]] |RETURNVALUE=
| [[Nothing]]


|s2= controlName '''ctrlEnable''' enable |Alternative Syntax=
|s2= controlName '''ctrlEnable''' enable


|p21=  controlName: [[Control]] |PARAMETER21=
|p21=  controlName: [[Control]] |PARAMETER21=
Line 31: Line 31:
|p22= enable: [[Boolean]] |PARAMETER22=
|p22= enable: [[Boolean]] |PARAMETER22=


|r2= [[Nothing]] |RETURNVALUE2=
|r2= [[Nothing]]
   
   
|x1= <code>[[ctrlEnable]] [100, [[false]]]</code> |EXAMPLE1=
|x1= <code>[[ctrlEnable]] [100, [[false]]]</code>


|x2= <code>_ctrl [[ctrlEnable]] [[false]]</code> |EXAMPLE2=
|x2= <code>_ctrl [[ctrlEnable]] [[false]]</code>




| [[ctrlEnabled]] |SEEALSO=
| [[ctrlEnabled]]


}}
}}

Revision as of 00:27, 18 January 2021

Hover & click on the images for description

Description

Description:
Enable or disable a control of the currently active user dialog. Disabled controls cannot be clicked onto. Read Arma: GUI Configuration for more information about user dialogs and controls.
Groups:
GUI Control

Syntax

Syntax:
ctrlEnable [idc, enable]
Parameters:
[idc, enable]: Array
idc: Number - control ID
enable: Boolean - true to enable the control, false to disable it
Return Value:
Nothing

Alternative Syntax

Syntax:
controlName ctrlEnable enable
Parameters:
controlName: Control
enable: Boolean
Return Value:
Nothing

Examples

Example 1:
ctrlEnable [100, false]
Example 2:
_ctrl ctrlEnable false

Additional Information

See also:
ctrlEnabled

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

Bottom Section

Posted on July 20, 2017 - 11:59 (UTC)
Yuval
Please do note that enabled controls can gain focus upon click. Therefore do not enable background controls or else they will cover any controls on top of them.
As a general rule of thumb, enabled controls should only be already on the top of the GUI.


Posted on September 7, 2020 - 22:26 (UTC)
R3vo
One can disable a control when it is loaded by using ctrlEnable in the onLoad event handler. class MyDialog { class MyControl { onLoad = "(_this # 0) ctrlEnable false;"; }; };