menuData: 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 (Some wiki formatting)
 
(21 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command


|arma3 |= Game
|game1= arma3
|version1= 1.56


|1.56|Game Version=
|gr1= GUI Control - Menu


|gr1= GUI Control - Menu |GROUP1=
|descr= Returns data stored in menu entry on given path.


| Returns data stored in menu entry on given path. |DESCRIPTION=
|s1= [[menuData]] [idc, path]


| [[menuData]] [idc, path] |SYNTAX=
|p1= idc: [[Number]]


|p1= idc: [[Number]] |PARAMETER1=
|p2= path: [[Array]]


|p2= path: [[Array]] |PARAMETER2=
|r1= [[String]]


|p3=  |PARAMETER3=
|s2= control [[menuData]] path


| [[String]] |RETURNVALUE=
|p21= control: [[Control]]


|s2= control [[menuData]] path |Alternative Syntax=
|p22= path: [[Array]]


|p21= control: [[Control]] |Alternative Parameter 1=
|r2= [[String]]


|p22= path: [[Array]] |Alternative Parameter 2=
|x1= <sqf>
// 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)));"];
</sqf>


|r2= [[String]]  |Alternative Return Value=
|seealso= [[menuSetData]]
 
|x1=  <code>{{cc|Create an entry which will return its data once clicked}}
[[private]] _ctrlMenuStrip = [[findDisplay]] 313 [[displayCtrl]] 120;
[[private]] _indexMain = _ctrlMenuStrip [[menuAdd]] <nowiki>[</nowiki>[], "Custom Tools"];
[[private]] _indexData = _ctrlMenuStrip [[menuAdd]] <nowiki>[</nowiki>[_indexMain],"This entry will print its data to system chat when clicked"];
_ctrlMenuStrip [[menuSetData]] <nowiki>[</nowiki>[_indexMain,_indexData], "<nowiki>[</nowiki>[[objNull]],'Some String',[[true]]]"];
_ctrlMenuStrip [[menuSetAction]] <nowiki>[</nowiki>[_indexMain,_indexData], "[[systemChat]] ([[findDisplay]] 313 [[displayCtrl]] 120 [[menuData]] ([[menuHover]] ([[findDisplay]] 313 [[displayCtrl]] 120)));"];
</code>|EXAMPLE1=
 
 
| [[menuSetData]] |SEEALSO=
}}
}}
<dl class='command_description'>
<!-- 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>
<!-- Appropriate categories go here -->
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 15:00, 13 May 2022

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