ctrlEnable: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - "\] +\[" to "] [")
 
(61 intermediate revisions by 3 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 |= Arguments in MP
|game3= arma1
|version3= 1.00


|eff= local |= Effects in MP
|game4= arma2
____________________________________________________________________________________________
|version4= 1.00


| Enable or disable a control of the currently active user dialog. Disabled controls cannot be clicked onto.
|game5= arma2oa
|version5= 1.50


Read [[Dialog Control]] for more information about user dialogs and controls. |DESCRIPTION=
|game6= tkoh
____________________________________________________________________________________________
|version6= 1.00


| '''ctrlEnable''' [idc, enable] |SYNTAX=
|game7= arma3
|version7= 0.50


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


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


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


| [[Nothing]] |RETURNVALUE=
|descr= Enables or disables 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.


|s2= controlName '''ctrlEnable''' enable |= Alternative Syntax
|s1= [[ctrlEnable]] [idc, enable]


|p21= controlName: [[Control]] |PARAMETER1=
|p1= idc: [[Number]] - control IDC


|p22= enable: [[Boolean]] |PARAMETER2=
|p2= enable: [[Boolean]] - [[true]] to enable the control, [[false]] to disable it


|r2= [[Nothing]] |RETURNVALUE=
|r1= [[Nothing]]
____________________________________________________________________________________________
 
|x1= <pre>ctrlEnable [100, false]</pre> |EXAMPLE1=


|x2= <code>_ctrl ctrlEnable [[false]]</code> |EXAMPLE2=
|s2= controlName [[ctrlEnable]] enable
____________________________________________________________________________________________


| [[ctrlEnabled]] |SEEALSO=
|p21= controlName: [[Control]]


}}
|p22= enable: [[Boolean]]


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


<!-- Note Section END -->
|x1= <sqf>ctrlEnable [100, false];</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|x2= <sqf>_ctrl ctrlEnable false;</sqf>


[[Category:Scripting Commands|CTRLENABLE]]
|seealso= [[ctrlEnabled]]
[[Category:Scripting Commands OFP 1.99|CTRLENABLE]]
}}
[[Category:Scripting Commands OFP 1.96|CTRLENABLE]]
[[Category:Scripting Commands ArmA|CTRLENABLE]]
[[Category:Command_Group:_GUI_Control|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]


<!-- CONTINUE Notes -->
{{Note
<dl class="command_description">
|user= Yuval
<dd class="notedate">Posted on July 20, 2017 - 11:59 (UTC)</dd>
|timestamp= 20170720115900
<dt class="note">[[User:Yuval|Yuval]]</dt>
|text= 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.<br>
<dd class="note">
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.<br />
As a general rule of thumb, enabled controls should only be already on the top of the GUI.
As a general rule of thumb, enabled controls should only be already on the top of the GUI.
</dd>
}}
</dl>
 
<!-- DISCONTINUE Notes -->
{{Note
|user= R3vo
|timestamp= 20200907222600
|text= One can disable a control when it is loaded by using [[ctrlEnable]] in the [[User_Interface_Event_Handlers#onLoad|onLoad]] event handler.
<syntaxhighlight lang="cpp">
class MyDialog
{
class MyControl
{
onLoad = "(_this # 0) ctrlEnable false;";
};
};
</syntaxhighlight>
}}

Latest revision as of 11:46, 5 May 2024

Logo A0.png1.75ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
LALocalLELocal
Hover & click on the images for description

Description

Description:
Enables or disables 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: Number - control IDC
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
Yuval - c
Posted on Jul 20, 2017 - 11:59 (UTC)
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.
R3vo - c
Posted on Sep 07, 2020 - 22:26 (UTC)
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;";
	};
};
Retrieved from "https://community.bistudio.com/wiki?title=ctrlEnable&oldid=364166"