ctrlChecked: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (control cat added)
m (Text replacement - "\{\{Feature *\| *Informative *\| ([^↵]+) *\}\}" to "{{Feature|informative|$1}}")
 
(56 intermediate revisions by 4 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
____________________________________________________________________________________________


| Returns the current state of checkbox (CT_CHECKBOXES, Type 7). |= Description
|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}}
____________________________________________________________________________________________


| '''ctrlChecked''' control |= Syntax
|s1= [[ctrlChecked]] control


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


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


|s2= control [[ctrlChecked]]  index


|x1= <code>
|s2since= arma3 1.72
</code>|= EXAMPLE1


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


| [[ctrlSetChecked]], [[cbChecked]], [[cbSetChecked]] |= SEEALSO
|r2= [[Boolean]] - [[true]] checked, [[false]] unchecked


| |= MPBEHAVIOUR
|x1= <sqf>ctrlChecked _control;</sqf>
____________________________________________________________________________________________
}}


<h3 style='display:none'>Notes</h3>
|x2= <sqf>_control ctrlChecked 3;</sqf>
<dl class='command_description'>
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|seealso= [[ctrlSetChecked]] [[cbChecked]] [[cbSetChecked]]
</dl>
}}
 
<h3 style='display:none'>Bottom Section</h3>
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Arma 3: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_GUI_Control|{{uc:{{PAGENAME}}}}]]

Latest revision as of 18:11, 15 March 2024

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=353343"