menuSetCheck: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Alternative Parameter 1 " to "|Alternative Parameter 1= ")
m (Text replacement - "‎" to "")
 
(39 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________
 
|arma3 |= Game
|game1= arma3
|1.56|Game Version=
 
|arg=  |Multiplayer Arguments=
|version1= 1.56
|eff=  |Multiplayer Effects=
 
____________________________________________________________________________________________
|gr1= GUI Control - Menu
| Sets item on given path to be checked or not. |DESCRIPTION=
 
____________________________________________________________________________________________
|descr= Sets item on given path to be checked or not. By default menu strip entries are not checkable.
| [[menuSetCheck]] [idc, path, checkedl] |SYNTAX=
Once this command was executed, an entry can become checked and unchecked.
|p1= idc: [[Number]] |PARAMETER1=
If an entry is checked is indicated by a tick to the left of the entry's text.
|p2= path: [[Array]] |PARAMETER2=
Setting an entry to be checkable will overwrite set picture with [[menuSetPicture]].
|p3= checked: [[Bool]] |PARAMETER3=
 
| [[Nothing]] |RETURNVALUE=
|s1= [[menuSetCheck]] [idc, path, checked]
<!--
 
|s2= control |= Alternative Syntax
|p1= idc: [[Number]]
|p21= control: [[Control]] |Alternative Parameter 1=
 
|p22= |= Alternative Parameter 2
|p2= path: [[Array]]
|p23= |= Alternative Parameter 3
 
|r2=  |= Alternative Return Value
|p3= checked: [[Boolean]]
-->
 
|x1=  |EXAMPLE1=
|r1= [[Nothing]]
| ‎[[menuEnable]], [[menuExpand]], [[menuCollapse]], [[menuSetData]], [[menuSetValue]], [[menuSetAction]], [[menuDelete]], [[menuAdd]], [[‎menuHover]], [[menuValue]], [[menuURL]], [[‎menuText]], [[menuSort]], [[‎menuSize]], [[menuEnabled]], [[‎menuChecked]], [[menuAction]], [[menuShortcutText]], [[menuShortcut]], [[menuPicture]], [[menuData]], [[menuClear]], [[menuSetPicture]] |SEEALSO=
 
}}
|s2= control [[menuSetCheck]] [path, checked]
 
|p21= control: [[Control]]
 
|p22= path: [[Array]]
 
|p23= checked: [[Boolean]]


<dl class='command_description'>
|r2= [[Nothing]]
<!-- BEGIN Note Section -->
<!-- For example:
<dd class='notedate'>Posted on Month Day, Year - Time (UTC)</dd>
<dt class='note'>'''[[User:User Name|User Name]]'''</dt>
<dd class='note'>This is an example note. It is true and verifiable, and contains a little code snippet.
<code>[[if]] ([[_this]] == anExample) [[then]] { [[hint]] Leave it here for others to read; };</code></dd>
-->
<!-- END Note Section -->
</dl>


<h3 style='display:none'>Bottom Section</h3>
|x1= <sqf>findDisplay 313 displayCtrl 120 menuSetCheck [[0,1], true];</sqf>
<!-- Appropriate categories go here -->


[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
|seealso= [[menuChecked]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
}}

Latest revision as of 11:54, 26 April 2023

Hover & click on the images for description

Description

Description:
Sets item on given path to be checked or not. By default menu strip entries are not checkable. Once this command was executed, an entry can become checked and unchecked. If an entry is checked is indicated by a tick to the left of the entry's text. Setting an entry to be checkable will overwrite set picture with menuSetPicture.
Groups:
GUI Control - Menu

Syntax

Syntax:
menuSetCheck [idc, path, checked]
Parameters:
idc: Number
path: Array
checked: Boolean
Return Value:
Nothing

Alternative Syntax

Syntax:
control menuSetCheck [path, checked]
Parameters:
control: Control
path: Array
checked: Boolean
Return Value:
Nothing

Examples

Example 1:
findDisplay 313 displayCtrl 120 menuSetCheck [[0,1], true];

Additional Information

See also:
menuChecked

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