weyne/MOOSE_DOCS
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE_DOCS.git synced 2025-08-15 10:37:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

MOOSE generated documentation [skip ci]

Browse Source
This commit is contained in:
Applevangelist
2021-12-20 12:06:00 +00:00
parent 1e732ea232
commit be8c95fcfd
69 changed files with 2023 additions and 1676 deletions
Download Patch File Download Diff File Expand all files Collapse all files

90
Documentation/Core.Menu.html
View File

@@ -1511,7 +1511,7 @@ Controls a network of short range air/missile defense groups.</p>
<li>Update menu structures.</li>
<li>Refresh menu structures intelligently, based on a time stamp of updates.
<ul>
<li>Delete obscolete menus.</li>
<li>Delete obsolete menus.</li>
<li>Create new one where required.</li>
<li>Don't touch the existing ones.</li>
</ul></li>
@@ -1521,12 +1521,12 @@ Controls a network of short range air/missile defense groups.</p>
<li>Provide a great tool to manage menus in your code.</li>
</ul>
<p>DCS Menus can be managed using the MENU classes.
The advantage of using MENU classes is that it hides the complexity of dealing with menu management in more advanced scanerios where you need to
<p>DCS Menus can be managed using the MENU classes.
The advantage of using MENU classes is that it hides the complexity of dealing with menu management in more advanced scenarios where you need to
set menus and later remove them, and later set them again. You'll find while using use normal DCS scripting functions, that setting and removing
menus is not a easy feat if you have complex menu hierarchies defined.
menus is not a easy feat if you have complex menu hierarchies defined.
Using the MOOSE menu classes, the removal and refreshing of menus are nicely being handled within these classes, and becomes much more easy.
On top, MOOSE implements <strong>variable parameter</strong> passing for command menus. </p>
On top, MOOSE implements <strong>variable parameter</strong> passing for command menus.</p>
<p>There are basically two different MENU class types that you need to use:</p>
@@ -1547,12 +1547,12 @@ On top, MOOSE implements <strong>variable parameter</strong> passing for command
</ul>
<hr/>
<p>- </p>
<p>-</p>
<h3>Author: <strong>FlightControl</strong></h3>
<h3>Contributions:</h3>
<hr/>
<p> </p>
</div>
<div class="w3-container w3-theme-d2"><h2><strong>Global(s)</strong></h2></div>
@@ -1633,7 +1633,7 @@ Using this object reference, you can then remove ALL the menus and submenus unde
end
local function AddStatusMenu()
-- This would create a menu for the red coalition under the MenuCoalitionRed menu object.
MenuStatus = MENU_COALITION:New( coalition.side.RED, "Status for Planes" )
MenuStatusShow = MENU_COALITION_COMMAND:New( coalition.side.RED, "Show Status", MenuStatus, ShowStatus, "Status of planes is ok!", "Message to Red Coalition" )
@@ -1678,7 +1678,7 @@ Using this object reference, you can then remove ALL the menus and submenus unde
<tr>
<td class="style="width:40%;"><p><h2>Global <strong>MENU_COMMAND_BASE</strong></h2></p></td>
<td class="style="width:60%;">
<p>Defines the main MENU class where other MENU COMMAND_
<p>Defines the main MENU class where other MENU COMMAND_
classes are derived from, in order to set commands.</p>
</td>
@@ -1691,7 +1691,7 @@ classes are derived from, in order to set commands.</p>
<a href="##(MENU_COMMAND_BASE)">#MENU_COMMAND_BASE</a>
<a id="MENU_COMMAND_BASE" ><strong>MENU_COMMAND_BASE</strong></a>
<p>Defines the main MENU class where other MENU COMMAND_
<p>Defines the main MENU class where other MENU COMMAND_
classes are derived from, in order to set commands.</p>
@@ -1728,7 +1728,7 @@ Using this object reference, you can then remove ALL the menus and submenus unde
-- To test, join the planes, then look at the other radio menus (Option F10).
-- Then switch planes and check if the menu is still there.
-- And play with the Add and Remove menu options.
-- Note that in multi player, this will only work after the DCS groups bug is solved.
local function ShowStatus( PlaneGroup, StatusText, Coalition )
@@ -1983,7 +1983,7 @@ Using this object reference, you can then remove ALL the menus and submenus unde
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MENU_BASE).New">MENU_BASE:New(MenuText, ParentMenu)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Consructor</p>
<p>Constructor</p>
</td>
</tr>
<tr class="w3-border">
@@ -2636,7 +2636,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MENU_COALITION).New">MENU_COALITION:New(MenuText, ParentMenu)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Consructor</p>
<p>Constructor</p>
</td>
</tr>
<tr class="w3-border">
@@ -3263,7 +3263,7 @@ If the arguments change, no new menu needs to be generated if the menu text is t
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MENU_COALITION_COMMAND).SetCommandMenuFunction">MENU_COALITION_COMMAND:SetCommandMenuFunction(CommandMenuFunction)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>This sets the new command function of a menu,
<p>This sets the new command function of a menu,
so that if a menu is regenerated, or if command function changes,
that the function set for the menu is loosely coupled with the menu itself!!!
If the function changes, no new menu needs to be generated if the menu text is the same!!!</p>
@@ -3316,7 +3316,7 @@ If the function changes, no new menu needs to be generated if the menu text is t
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MENU_COALITION_COMMAND).New">MENU_COALITION_COMMAND:New(MenuText, ParentMenu)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Consructor</p>
<p>Constructor</p>
</td>
</tr>
<tr class="w3-border">
@@ -3916,7 +3916,7 @@ If the arguments change, no new menu needs to be generated if the menu text is t
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MENU_COMMAND_BASE).SetCommandMenuFunction">MENU_COMMAND_BASE:SetCommandMenuFunction(CommandMenuFunction)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>This sets the new command function of a menu,
<p>This sets the new command function of a menu,
so that if a menu is regenerated, or if command function changes,
that the function set for the menu is loosely coupled with the menu itself!!!
If the function changes, no new menu needs to be generated if the menu text is the same!!!</p>
@@ -3969,7 +3969,7 @@ If the function changes, no new menu needs to be generated if the menu text is t
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MENU_COMMAND_BASE).New">MENU_COMMAND_BASE:New(MenuText, ParentMenu)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Consructor</p>
<p>Constructor</p>
</td>
</tr>
<tr class="w3-border">
@@ -4640,7 +4640,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MENU_GROUP).New">MENU_GROUP:New(MenuText, ParentMenu)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Consructor</p>
<p>Constructor</p>
</td>
</tr>
<tr class="w3-border">
@@ -5285,7 +5285,7 @@ If the arguments change, no new menu needs to be generated if the menu text is t
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MENU_GROUP_COMMAND).SetCommandMenuFunction">MENU_GROUP_COMMAND:SetCommandMenuFunction(CommandMenuFunction)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>This sets the new command function of a menu,
<p>This sets the new command function of a menu,
so that if a menu is regenerated, or if command function changes,
that the function set for the menu is loosely coupled with the menu itself!!!
If the function changes, no new menu needs to be generated if the menu text is the same!!!</p>
@@ -5338,7 +5338,7 @@ If the function changes, no new menu needs to be generated if the menu text is t
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MENU_GROUP_COMMAND).New">MENU_GROUP_COMMAND:New(MenuText, ParentMenu)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Consructor</p>
<p>Constructor</p>
</td>
</tr>
<tr class="w3-border">
@@ -5995,7 +5995,7 @@ If the arguments change, no new menu needs to be generated if the menu text is t
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MENU_GROUP_COMMAND_DELAYED).SetCommandMenuFunction">MENU_GROUP_COMMAND_DELAYED:SetCommandMenuFunction(CommandMenuFunction)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>This sets the new command function of a menu,
<p>This sets the new command function of a menu,
so that if a menu is regenerated, or if command function changes,
that the function set for the menu is loosely coupled with the menu itself!!!
If the function changes, no new menu needs to be generated if the menu text is the same!!!</p>
@@ -6048,7 +6048,7 @@ If the function changes, no new menu needs to be generated if the menu text is t
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MENU_GROUP_COMMAND_DELAYED).New">MENU_GROUP_COMMAND_DELAYED:New(MenuText, ParentMenu)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Consructor</p>
<p>Constructor</p>
</td>
</tr>
<tr class="w3-border">
@@ -6731,7 +6731,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MENU_GROUP_DELAYED).New">MENU_GROUP_DELAYED:New(MenuText, ParentMenu)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Consructor</p>
<p>Constructor</p>
</td>
</tr>
<tr class="w3-border">
@@ -7390,7 +7390,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MENU_MISSION).New">MENU_MISSION:New(MenuText, ParentMenu)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Consructor</p>
<p>Constructor</p>
</td>
</tr>
<tr class="w3-border">
@@ -8017,7 +8017,7 @@ If the arguments change, no new menu needs to be generated if the menu text is t
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MENU_MISSION_COMMAND).SetCommandMenuFunction">MENU_MISSION_COMMAND:SetCommandMenuFunction(CommandMenuFunction)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>This sets the new command function of a menu,
<p>This sets the new command function of a menu,
so that if a menu is regenerated, or if command function changes,
that the function set for the menu is loosely coupled with the menu itself!!!
If the function changes, no new menu needs to be generated if the menu text is the same!!!</p>
@@ -8070,7 +8070,7 @@ If the function changes, no new menu needs to be generated if the menu text is t
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MENU_MISSION_COMMAND).New">MENU_MISSION_COMMAND:New(MenuText, ParentMenu)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Consructor</p>
<p>Constructor</p>
</td>
</tr>
<tr class="w3-border">
@@ -8655,7 +8655,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>self:F( { RemoveParent } )</p>
<p> self:F( { RemoveParent } )</p>
</div>
@@ -8794,7 +8794,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<h2><a id="#(MENU_BASE).New" ><strong>MENU_BASE:New(MenuText, ParentMenu)</strong></a></h2>
</div>
<p>Consructor</p>
<p>Constructor</p>
<div id= "#Functions##New" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -9061,7 +9061,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>self:F( { RemoveParent } )</p>
<p> self:F( { RemoveParent } )</p>
</div>
@@ -12387,7 +12387,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
</div>
<div class="w3-half">
<p>The parent menu. This parameter can be ignored if you want the menu to be located at the perent menu of DCS world (under F10 other).</p>
<p>The parent menu. This parameter can be ignored if you want the menu to be located at the parent menu of DCS world (under F10 other).</p>
</div>
</div>
@@ -12636,7 +12636,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
<h2><a id="#(MENU_COALITION).New" ><strong>MENU_COALITION:New(MenuText, ParentMenu)</strong></a></h2>
</div>
<p>Consructor</p>
<p>Constructor</p>
<div id= "#Functions##New" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -16455,7 +16455,7 @@ If the arguments change, no new menu needs to be generated if the menu text is t
<h2><a id="#(MENU_COALITION_COMMAND).SetCommandMenuFunction" ><strong>MENU_COALITION_COMMAND:SetCommandMenuFunction(CommandMenuFunction)</strong></a></h2>
</div>
<p>This sets the new command function of a menu,
<p>This sets the new command function of a menu,
so that if a menu is regenerated, or if command function changes,
that the function set for the menu is loosely coupled with the menu itself!!!
If the function changes, no new menu needs to be generated if the menu text is the same!!!</p>
@@ -16608,7 +16608,7 @@ If the function changes, no new menu needs to be generated if the menu text is t
<h2><a id="#(MENU_COALITION_COMMAND).New" ><strong>MENU_COALITION_COMMAND:New(MenuText, ParentMenu)</strong></a></h2>
</div>
<p>Consructor</p>
<p>Constructor</p>
<div id= "#Functions##New" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -20244,7 +20244,7 @@ If the arguments change, no new menu needs to be generated if the menu text is t
<h2><a id="#(MENU_COMMAND_BASE).SetCommandMenuFunction" ><strong>MENU_COMMAND_BASE:SetCommandMenuFunction(CommandMenuFunction)</strong></a></h2>
</div>
<p>This sets the new command function of a menu,
<p>This sets the new command function of a menu,
so that if a menu is regenerated, or if command function changes,
that the function set for the menu is loosely coupled with the menu itself!!!
If the function changes, no new menu needs to be generated if the menu text is the same!!!</p>
@@ -20408,7 +20408,7 @@ If the function changes, no new menu needs to be generated if the menu text is t
<h2><a id="#(MENU_COMMAND_BASE).New" ><strong>MENU_COMMAND_BASE:New(MenuText, ParentMenu)</strong></a></h2>
</div>
<p>Consructor</p>
<p>Constructor</p>
<div id= "#Functions##New" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -24313,7 +24313,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
<h2><a id="#(MENU_GROUP).New" ><strong>MENU_GROUP:New(MenuText, ParentMenu)</strong></a></h2>
</div>
<p>Consructor</p>
<p>Constructor</p>
<div id= "#Functions##New" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -28228,7 +28228,7 @@ If the arguments change, no new menu needs to be generated if the menu text is t
<h2><a id="#(MENU_GROUP_COMMAND).SetCommandMenuFunction" ><strong>MENU_GROUP_COMMAND:SetCommandMenuFunction(CommandMenuFunction)</strong></a></h2>
</div>
<p>This sets the new command function of a menu,
<p>This sets the new command function of a menu,
so that if a menu is regenerated, or if command function changes,
that the function set for the menu is loosely coupled with the menu itself!!!
If the function changes, no new menu needs to be generated if the menu text is the same!!!</p>
@@ -28414,7 +28414,7 @@ If the function changes, no new menu needs to be generated if the menu text is t
<h2><a id="#(MENU_GROUP_COMMAND).New" ><strong>MENU_GROUP_COMMAND:New(MenuText, ParentMenu)</strong></a></h2>
</div>
<p>Consructor</p>
<p>Constructor</p>
<div id= "#Functions##New" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -32381,7 +32381,7 @@ If the arguments change, no new menu needs to be generated if the menu text is t
<h2><a id="#(MENU_GROUP_COMMAND_DELAYED).SetCommandMenuFunction" ><strong>MENU_GROUP_COMMAND_DELAYED:SetCommandMenuFunction(CommandMenuFunction)</strong></a></h2>
</div>
<p>This sets the new command function of a menu,
<p>This sets the new command function of a menu,
so that if a menu is regenerated, or if command function changes,
that the function set for the menu is loosely coupled with the menu itself!!!
If the function changes, no new menu needs to be generated if the menu text is the same!!!</p>
@@ -32578,7 +32578,7 @@ If the function changes, no new menu needs to be generated if the menu text is t
<h2><a id="#(MENU_GROUP_COMMAND_DELAYED).New" ><strong>MENU_GROUP_COMMAND_DELAYED:New(MenuText, ParentMenu)</strong></a></h2>
</div>
<p>Consructor</p>
<p>Constructor</p>
<div id= "#Functions##New" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -36568,7 +36568,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
<h2><a id="#(MENU_GROUP_DELAYED).New" ><strong>MENU_GROUP_DELAYED:New(MenuText, ParentMenu)</strong></a></h2>
</div>
<p>Consructor</p>
<p>Constructor</p>
<div id= "#Functions##New" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -40167,7 +40167,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
</div>
<div class="w3-half">
<p>The parent menu. This parameter can be ignored if you want the menu to be located at the perent menu of DCS world (under F10 other).</p>
<p>The parent menu. This parameter can be ignored if you want the menu to be located at the parent menu of DCS world (under F10 other).</p>
</div>
</div>
@@ -40427,7 +40427,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
<h2><a id="#(MENU_MISSION).New" ><strong>MENU_MISSION:New(MenuText, ParentMenu)</strong></a></h2>
</div>
<p>Consructor</p>
<p>Constructor</p>
<div id= "#Functions##New" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -44223,7 +44223,7 @@ If the arguments change, no new menu needs to be generated if the menu text is t
<h2><a id="#(MENU_MISSION_COMMAND).SetCommandMenuFunction" ><strong>MENU_MISSION_COMMAND:SetCommandMenuFunction(CommandMenuFunction)</strong></a></h2>
</div>
<p>This sets the new command function of a menu,
<p>This sets the new command function of a menu,
so that if a menu is regenerated, or if command function changes,
that the function set for the menu is loosely coupled with the menu itself!!!
If the function changes, no new menu needs to be generated if the menu text is the same!!!</p>
@@ -44376,7 +44376,7 @@ If the function changes, no new menu needs to be generated if the menu text is t
<h2><a id="#(MENU_MISSION_COMMAND).New" ><strong>MENU_MISSION_COMMAND:New(MenuText, ParentMenu)</strong></a></h2>
</div>
<p>Consructor</p>
<p>Constructor</p>
<div id= "#Functions##New" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">