ctrlChecked: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{uc:{{PAGENAME}}}}" to "")
m (updated description)
Line 9: Line 9:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Returns the current state of given checkbox in checkboxes control (CT_CHECKBOXES type 7 of [[Arma: GUI Configuration]]). 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 [[CT_CHECKBOXES]] control. Since Arma 3 v1.71.141591 it is possible to query multiple checkboxes by providing checkbox index. For more information see [[CT_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=
____________________________________________________________________________________________
____________________________________________________________________________________________
Line 15: Line 15:
| '''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=
Line 22: Line 22:
|s2= control '''ctrlChecked''' index {{since|arma3|1.71.141591|y}} |SYNTAX2=
|s2= control '''ctrlChecked''' index {{since|arma3|1.71.141591|y}} |SYNTAX2=


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



Revision as of 15:26, 29 November 2020

Hover & click on the images for description

Description

Description:
Returns the current state of given CT_CHECKBOXES control. Since Arma 3 v1.71.141591 it is possible to query multiple checkboxes by providing checkbox index. For more information see CT_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:
GUI Control

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 Template:since
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