ctrlChecked: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Bot: Replacing category Scripting Commands Arma 3 with Arma 3: Scripting Commands)
m (Text replacement - "|SYNTAX= |p21=" to "|SYNTAX2= |p21=")
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{Command|Comments=
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma3 |= Game name
| arma3 |Game name=


|0.50|= Game version
|0.50|Game version=
____________________________________________________________________________________________
____________________________________________________________________________________________


| Returns the current state of given checkbox in checkboxes control (CT_CHECKBOXES type 7 of [[Dialog Control]]). Since Arma 3 v1.71.141591 it is possible to query multiple checkboxes by providing checkbox index. For more information see [[DialogControls-CheckBoxes]]. <br><br>
| Returns the current state of given checkbox in checkboxes control (CT_CHECKBOXES type 7 of [[Dialog Control]]). Since Arma 3 v1.71.141591 it is possible to query multiple checkboxes by providing checkbox index. For more information see [[DialogControls-CheckBoxes]]. <br><br>
{{Informative | The <tt>"CheckBoxesSelChanged"</tt> control EH returns the control, index of changed checkbox and its current checked state. The checked state however is not a [[Boolean]] but [[Number]] 0 or 1. To convert [[ctrlChecked]] command output into number as well, use [[parseNumber]] command}}|= Description
{{Informative | The <tt>"CheckBoxesSelChanged"</tt> control EH returns the control, index of changed checkbox and its current checked state. The checked state however is not a [[Boolean]] but [[Number]] 0 or 1. To convert [[ctrlChecked]] command output into number as well, use [[parseNumber]] command}}|DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''ctrlChecked''' control |= Syntax
| '''ctrlChecked''' control |SYNTAX=


|p1= control: [[Control]] - CT_CHECKBOXES control. If control contain multiple checkboxes, only checkbox with index 0 is queried.|= PARAMETER1  
|p1= control: [[Control]] - CT_CHECKBOXES control. If control contain multiple checkboxes, only checkbox with index 0 is queried.|PARAMETER1=   


| [[Boolean]] - [[true]] checked, [[false]] unchecked |= RETURNVALUE
| [[Boolean]] - [[true]] checked, [[false]] unchecked |RETURNVALUE=  




|s2= control '''ctrlChecked''' index &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(''Since Arma 3 v1.71.141591'') |= Syntax
|s2= control '''ctrlChecked''' index &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(''Since Arma 3 v1.71.141591'') |SYNTAX2=


|p21= control: [[Control]] - CT_CHECKBOXES control  |= PARAMETER1  
|p21= control: [[Control]] - CT_CHECKBOXES control  |PARAMETER1=   
|p22= index: [[Number]] - checkbox index  |= PARAMETER1  
|p22= index: [[Number]] - checkbox index  |PARAMETER1=   


| r2= [[Boolean]] - [[true]] checked, [[false]] unchecked|= RETURNVALUE
| r2= [[Boolean]] - [[true]] checked, [[false]] unchecked|RETURNVALUE=  


|x1= <code>[[ctrlChecked]] _control;</code>|= EXAMPLE1
|x1= <code>[[ctrlChecked]] _control;</code>|EXAMPLE1=  
|x2= <code>_control [[ctrlChecked]] 3;</code>|= EXAMPLE1
|x2= <code>_control [[ctrlChecked]] 3;</code>|EXAMPLE1=  
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[ctrlSetChecked]], [[cbChecked]], [[cbSetChecked]] |= SEEALSO
| [[ctrlSetChecked]], [[cbChecked]], [[cbSetChecked]] |SEEALSO=  


|  |= MPBEHAVIOUR
|  |MPBEHAVIOUR=  
____________________________________________________________________________________________
____________________________________________________________________________________________
}}
}}
Line 43: Line 43:


<h3 style='display:none'>Bottom Section</h3>
<h3 style='display:none'>Bottom Section</h3>
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Arma 3: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Arma 3: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Arma 3: Scripting Commands]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Command Group: GUI Control|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_GUI_Control|{{uc:{{PAGENAME}}}}]]

Revision as of 02:13, 3 September 2019

Hover & click on the images for description

Description

Description:
Returns the current state of given checkbox in checkboxes control (CT_CHECKBOXES type 7 of Dialog Control). Since Arma 3 v1.71.141591 it is possible to query multiple checkboxes by providing checkbox index. For more information see DialogControls-CheckBoxes.

The "CheckBoxesSelChanged" control EH returns the control, index of changed checkbox and its current checked state. The checked state however is not a Boolean but Number 0 or 1. To convert ctrlChecked command output into number as well, use parseNumber command
Groups:
Uncategorised

Syntax

Syntax:
ctrlChecked control
Parameters:
control: Control - CT_CHECKBOXES control. If control contain multiple checkboxes, only checkbox with index 0 is queried.
Return Value:
Boolean - true checked, false unchecked

Alternative Syntax

Syntax:
control ctrlChecked index        (Since Arma 3 v1.71.141591)
Parameters:
control: Control - CT_CHECKBOXES control
index: Number - checkbox index
Return Value:
Boolean - true checked, false unchecked

Examples

Example 1:
ctrlChecked _control;
Example 2:
_control ctrlChecked 3;

Additional Information

See also:
ctrlSetCheckedcbCheckedcbSetChecked

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

Notes

Bottom Section