Difference between revisions of "menuData"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - " \| *(game[0-9]|version[0-9]|gr[0-9]|serverExec|mp|pr|descr|s[0-9]|p[0-9]{1,3}|r[0-9]|x1?[0-9]|seealso) *= +" to " |$1= ")
 
(31 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|=
+
{{RV|type=command
____________________________________________________________________________________________
 
|arma3 |= Game
 
|1.56|= Game Version
 
|arg=  |= Multiplayer Arguments
 
|eff=  |= Multiplayer Effects
 
____________________________________________________________________________________________
 
| Returns data stored in menu entry on given path. |DESCRIPTION=
 
____________________________________________________________________________________________
 
| [[menuData]] [idc, path] |SYNTAX=
 
|p1= idc: [[Number]] |PARAMETER1=
 
|p2= path: [[Array]] |PARAMETER2=
 
|p3=  |PARAMETER3=
 
  
| [[String]] |RETURNVALUE=
+
|game1= arma3
<!--
+
|version1= 1.56
|s2= control |= Alternative Syntax
+
 
|p21= control: [[Control]] |= Alternative Parameter 1
+
|gr1= GUI Control - Menu
|p22=  |= Alternative Parameter 2
+
 
|p23= |= Alternative Parameter 3
+
|descr= Returns data stored in menu entry on given path.
|r2=  |= Alternative Return Value
+
 
-->
+
|s1= [[menuData]] [idc, path]
|x1= |EXAMPLE1=
+
 
| ‎[[menuEnable]], [[menuExpand]], [[menuCollapse]], [[menuSetData]], [[menuSetValue]], [[‎menuSetCheck]], [[menuSetAction]], [[menuDelete]], [[menuAdd]], [[‎menuHover]], [[menuValue]], [[menuURL]], [[‎menuText]], [[menuSort]], [[‎menuSize]], [[menuEnabled]], [[‎menuChecked]], [[menuAction]], [[menuShortcutText]], [[menuShortcut]], [[menuPicture]], [[menuClear]], [[menuSetPicture]] |SEEALSO=
+
|p1= idc: [[Number]]
}}
+
 
 +
|p2= path: [[Array]]
 +
 
 +
|r1= [[String]]
 +
 
 +
|s2= control [[menuData]] path
 +
 
 +
|p21= control: [[Control]]
 +
 
 +
|p22= path: [[Array]]
  
<dl class='command_description'>
+
|r2= [[String]]
<!-- 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= <code>{{cc|Create an entry which will return its data once clicked}}
<!-- Appropriate categories go here -->
+
[[private]] _ctrlMenuStrip = [[findDisplay]] 313 [[displayCtrl]] 120;
 +
[[private]] _indexMain = _ctrlMenuStrip [[menuAdd]] [<nowiki/>[], "Custom Tools"];
 +
[[private]] _indexData = _ctrlMenuStrip [[menuAdd]] [<nowiki/>[_indexMain],"This entry will print its data to system chat when clicked"];
 +
_ctrlMenuStrip [[menuSetData]] [<nowiki/>[_indexMain,_indexData], "<nowiki>[</nowiki>[[objNull]],'Some String',[[true]]]"];
 +
_ctrlMenuStrip [[menuSetAction]] [<nowiki/>[_indexMain,_indexData], "[[systemChat]] ([[findDisplay]] 313 [[displayCtrl]] 120 [[menuData]] ([[menuHover]] ([[findDisplay]] 313 [[displayCtrl]] 120)));"];
 +
</code>
  
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
+
|seealso= [[menuSetData]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
+
}}

Latest revision as of 23:20, 19 June 2021

Hover & click on the images for description

Description

Description:
Returns data stored in menu entry on given path.
Groups:
GUI Control - Menu

Syntax

Syntax:
menuData [idc, path]
Parameters:
idc: Number
path: Array
Return Value:
String

Alternative Syntax

Syntax:
control menuData path
Parameters:
control: Control
path: Array
Return Value:
String

Examples

Example 1:
// Create an entry which will return its data once clicked private _ctrlMenuStrip = findDisplay 313 displayCtrl 120; private _indexMain = _ctrlMenuStrip menuAdd [[], "Custom Tools"]; private _indexData = _ctrlMenuStrip menuAdd [[_indexMain],"This entry will print its data to system chat when clicked"]; _ctrlMenuStrip menuSetData [[_indexMain,_indexData], "[objNull,'Some String',true]"]; _ctrlMenuStrip menuSetAction [[_indexMain,_indexData], "systemChat (findDisplay 313 displayCtrl 120 menuData (menuHover (findDisplay 313 displayCtrl 120)));"];

Additional Information

See also:
menuSetData

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