ctrlChecked: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]3(\|.*)]]" to "{{GameCategory|arma3|Scripting Commands}}")
m (Text replacement - "<code>([a-zA-Z0-9_]+) +\[\[([a-zA-Z0-9_]+)\]\] +([a-zA-Z0-9_]+);?<\/code>" to "<sqf>$1 $2 $3;</sqf>")
(32 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 0.50


|0.50|Game version=
|gr1= GUI Control


|gr1= GUI Control |GROUP1=
|descr= Returns the current state of given [[CT_CHECKBOXES]] control. Since Arma 3 v1.72 it is possible to query multiple checkboxes by providing checkbox index. For more information see [[CT_CHECKBOXES]].{{Feature | Informative | The {{hl|"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}}
____________________________________________________________________________________________


| 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>
|s1= [[ctrlChecked]] control
{{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=
|p1= control: [[Control]] - [[CT_CHECKBOXES]] control. If control contain multiple checkboxes, only checkbox with index 0 is queried.


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


| [[Boolean]] - [[true]] checked, [[false]] unchecked |RETURNVALUE=
|s2= control [[ctrlChecked]] index


|s2since= arma3 1.72


|s2= control '''ctrlChecked''' index {{since|arma3|1.71.141591|y}} |SYNTAX2=
|p21= control: [[Control]] - [[CT_CHECKBOXES]] control
|p22= index: [[Number]] - checkbox index


|p21= control: [[Control]] - [[CT_CHECKBOXES]] control  |PARAMETER21=
|r2= [[Boolean]] - [[true]] checked, [[false]] unchecked
|p22= index: [[Number]] - checkbox index  |PARAMETER22=


|r2= [[Boolean]] - [[true]] checked, [[false]] unchecked|RETURNVALUE2=  
|x1= <sqf>ctrlChecked _control;</sqf>


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


|x2= <code>_control [[ctrlChecked]] 3;</code>|EXAMPLE2=
|seealso= [[ctrlSetChecked]] [[cbChecked]] [[cbSetChecked]]
____________________________________________________________________________________________
 
| [[ctrlSetChecked]], [[cbChecked]], [[cbSetChecked]] |SEEALSO=
 
|  |MPBEHAVIOUR=
____________________________________________________________________________________________
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
{{GameCategory|arma3|New Scripting Commands List}}
{{GameCategory|arma3|Scripting Commands}}

Revision as of 14:25, 5 May 2022

Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Returns the current state of given CT_CHECKBOXES control. Since Arma 3 v1.72 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
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:
ctrlSetChecked cbChecked cbSetChecked

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
Retrieved from "https://community.bistudio.com/wiki?title=ctrlChecked&oldid=310124"