Release prep

2025-10-29 16:58:06 +00:00 · 2017-03-17 11:50:24 +01:00
parent 8c4ae420e2
commit 7231492eaa
139 changed files with 70756 additions and 176 deletions
--- a/docs/Documentation/Menu.html
+++ b/docs/Documentation/Menu.html
@@ -257,6 +257,12 @@ Using this object reference, you can then remove ALL the menus and submenus unde
 		<td class="name" nowrap="nowrap"><a href="##(MENU_BASE).ClassName">MENU_BASE.ClassName</a></td>
 		<td class="summary">

+</td>
+		</tr>
+		<tr>
+		<td class="name" nowrap="nowrap"><a href="##(MENU_BASE).GetMenu">MENU_BASE:GetMenu(MenuText)</a></td>
+		<td class="summary">
+<p>Gets a <a href="Menu.html">Menu</a> from a parent <a href="Menu.html">Menu</a></p>
 </td>
 		</tr>
 		<tr>
@@ -269,6 +275,12 @@ Using this object reference, you can then remove ALL the menus and submenus unde
 		<td class="name" nowrap="nowrap"><a href="##(MENU_BASE).MenuPath">MENU_BASE.MenuPath</a></td>
 		<td class="summary">

+</td>
+		</tr>
+		<tr>
+		<td class="name" nowrap="nowrap"><a href="##(MENU_BASE).MenuRemoveParent">MENU_BASE.MenuRemoveParent</a></td>
+		<td class="summary">
+
 </td>
 		</tr>
 		<tr>
@@ -278,9 +290,27 @@ Using this object reference, you can then remove ALL the menus and submenus unde
 </td>
 		</tr>
 		<tr>
-		<td class="name" nowrap="nowrap"><a href="##(MENU_BASE).New">MENU_BASE:New(MenuText, ParentMenu)</a></td>
+		<td class="name" nowrap="nowrap"><a href="##(MENU_BASE).MenuTime">MENU_BASE.MenuTime</a></td>
+		<td class="summary">
+
+</td>
+		</tr>
+		<tr>
+		<td class="name" nowrap="nowrap"><a href="##(MENU_BASE).New">MENU_BASE.New(#, self, MenuText, ParentMenu)</a></td>
 		<td class="summary">
 <p>Consructor</p>
+</td>
+		</tr>
+		<tr>
+		<td class="name" nowrap="nowrap"><a href="##(MENU_BASE).SetRemoveParent">MENU_BASE:SetRemoveParent(RemoveParent)</a></td>
+		<td class="summary">
+<p>Sets a <a href="Menu.html">Menu</a> to remove automatically the parent menu when the menu removed is the last child menu of that parent <a href="Menu.html">Menu</a>.</p>
+</td>
+		</tr>
+		<tr>
+		<td class="name" nowrap="nowrap"><a href="##(MENU_BASE).SetTime">MENU_BASE:SetTime(MenuTime)</a></td>
+		<td class="summary">
+<p>Sets a time stamp for later prevention of menu removal.</p>
 </td>
 		</tr>
 	</table>
@@ -412,7 +442,7 @@ Using this object reference, you can then remove ALL the menus and submenus unde
 </td>
 		</tr>
 		<tr>
-		<td class="name" nowrap="nowrap"><a href="##(MENU_COMMAND_BASE).New">MENU_COMMAND_BASE:New(MenuText, ParentMenu, CommandMenuFunction, CommandMenuArguments)</a></td>
+		<td class="name" nowrap="nowrap"><a href="##(MENU_COMMAND_BASE).New">MENU_COMMAND_BASE.New(#, self, MenuText, ParentMenu, CommandMenuFunction, CommandMenuArguments)</a></td>
 		<td class="summary">
 <p>Constructor</p>
 </td>
@@ -449,12 +479,6 @@ Using this object reference, you can then remove ALL the menus and submenus unde
 		<td class="name" nowrap="nowrap"><a href="##(MENU_GROUP).MenuText">MENU_GROUP.MenuText</a></td>
 		<td class="summary">

-</td>
-		</tr>
-		<tr>
-		<td class="name" nowrap="nowrap"><a href="##(MENU_GROUP).Menus">MENU_GROUP.Menus</a></td>
-		<td class="summary">
-
 </td>
 		</tr>
 		<tr>
@@ -476,13 +500,13 @@ Using this object reference, you can then remove ALL the menus and submenus unde
 </td>
 		</tr>
 		<tr>
-		<td class="name" nowrap="nowrap"><a href="##(MENU_GROUP).Remove">MENU_GROUP:Remove()</a></td>
+		<td class="name" nowrap="nowrap"><a href="##(MENU_GROUP).Remove">MENU_GROUP:Remove(MenuTime)</a></td>
 		<td class="summary">
 <p>Removes the main menu and sub menus recursively of this MENU_GROUP.</p>
 </td>
 		</tr>
 		<tr>
-		<td class="name" nowrap="nowrap"><a href="##(MENU_GROUP).RemoveSubMenus">MENU_GROUP:RemoveSubMenus()</a></td>
+		<td class="name" nowrap="nowrap"><a href="##(MENU_GROUP).RemoveSubMenus">MENU_GROUP:RemoveSubMenus(MenuTime)</a></td>
 		<td class="summary">
 <p>Removes the sub menus recursively of this MENU_GROUP.</p>
 </td>
@@ -540,7 +564,7 @@ Using this object reference, you can then remove ALL the menus and submenus unde
 </td>
 		</tr>
 		<tr>
-		<td class="name" nowrap="nowrap"><a href="##(MENU_GROUP_COMMAND).Remove">MENU_GROUP_COMMAND:Remove()</a></td>
+		<td class="name" nowrap="nowrap"><a href="##(MENU_GROUP_COMMAND).Remove">MENU_GROUP_COMMAND:Remove(MenuTime)</a></td>
 		<td class="summary">
 <p>Removes a menu structure for a group.</p>
 </td>
@@ -757,6 +781,33 @@ Using this object reference, you can then remove ALL the menus and submenus unde
 	


+</dd>
+</dl>
+		<dl class="function">
+<dt>
+
+<a id="#(MENU_BASE).GetMenu" >
+<strong>MENU_BASE:GetMenu(MenuText)</strong>
+</a>
+</dt>
+<dd>
+	
+<p>Gets a <a href="Menu.html">Menu</a> from a parent <a href="Menu.html">Menu</a></p>
+
+		<h3>Parameter</h3>
+		<ul>
+				<li>
+				
+<p><code><em>#string MenuText </em></code>: 
+The text of the child menu.</p>
+
+				</li>
+		</ul>
+		<h3>Return value</h3>
+				
+<p><em><a href="##(MENU_BASE)">#MENU_BASE</a>:</em></p>
+
+
 </dd>
 </dl>
 		<dl class="function">
@@ -783,6 +834,20 @@ Using this object reference, you can then remove ALL the menus and submenus unde
 	


+</dd>
+</dl>
+		<dl class="function">
+<dt>
+
+		<em></em>
+<a id="#(MENU_BASE).MenuRemoveParent" >
+<strong>MENU_BASE.MenuRemoveParent</strong>
+</a>
+</dt>
+<dd>
+	
+
+
 </dd>
 </dl>
 		<dl class="function">
@@ -797,13 +862,27 @@ Using this object reference, you can then remove ALL the menus and submenus unde
 	


+</dd>
+</dl>
+		<dl class="function">
+<dt>
+
+		<em></em>
+<a id="#(MENU_BASE).MenuTime" >
+<strong>MENU_BASE.MenuTime</strong>
+</a>
+</dt>
+<dd>
+	
+
+
 </dd>
 </dl>
 		<dl class="function">
 <dt>

 <a id="#(MENU_BASE).New" >
-<strong>MENU_BASE:New(MenuText, ParentMenu)</strong>
+<strong>MENU_BASE.New(#, self, MenuText, ParentMenu)</strong>
 </a>
 </dt>
 <dd>
@@ -814,6 +893,17 @@ Using this object reference, you can then remove ALL the menus and submenus unde
 		<ul>
 				<li>
 				
+<p><code><em> # </em></code>: 
+ENU_BASE</p>
+
+				</li>
+				<li>
+				
+<p><code><em> self </em></code>: </p>
+
+				</li>
+				<li>
+				
 <p><code><em> MenuText </em></code>: </p>

 				</li>
@@ -823,6 +913,64 @@ Using this object reference, you can then remove ALL the menus and submenus unde

 				</li>
 		</ul>
+		<h3>Return value</h3>
+				
+<p><em><a href="##(MENU_BASE)">#MENU_BASE</a>:</em></p>
+
+
+</dd>
+</dl>
+		<dl class="function">
+<dt>
+
+<a id="#(MENU_BASE).SetRemoveParent" >
+<strong>MENU_BASE:SetRemoveParent(RemoveParent)</strong>
+</a>
+</dt>
+<dd>
+	
+<p>Sets a <a href="Menu.html">Menu</a> to remove automatically the parent menu when the menu removed is the last child menu of that parent <a href="Menu.html">Menu</a>.</p>
+
+		<h3>Parameter</h3>
+		<ul>
+				<li>
+				
+<p><code><em>#boolean RemoveParent </em></code>: 
+If true, the parent menu is automatically removed when this menu is the last child menu of that parent <a href="Menu.html">Menu</a>.</p>
+
+				</li>
+		</ul>
+		<h3>Return value</h3>
+				
+<p><em><a href="##(MENU_BASE)">#MENU_BASE</a>:</em></p>
+
+
+</dd>
+</dl>
+		<dl class="function">
+<dt>
+
+<a id="#(MENU_BASE).SetTime" >
+<strong>MENU_BASE:SetTime(MenuTime)</strong>
+</a>
+</dt>
+<dd>
+	
+<p>Sets a time stamp for later prevention of menu removal.</p>
+
+		<h3>Parameter</h3>
+		<ul>
+				<li>
+				
+<p><code><em> MenuTime </em></code>: </p>
+
+				</li>
+		</ul>
+		<h3>Return value</h3>
+				
+<p><em><a href="##(MENU_BASE)">#MENU_BASE</a>:</em></p>
+
+
 </dd>
 </dl>

@@ -1200,8 +1348,8 @@ self</p>

 		<h3>Return value</h3>
 				
-<p><em><a href="##(MENU_COALITION)">#MENU_COALITION</a>:</em>
-self</p>
+<p><em><a href="##(MENU_COALITION)">#MENU_COALITION</a>:</em></p>
+

 </dd>
 </dl>
@@ -1279,8 +1427,8 @@ An argument for the function. There can only be ONE argument given. So multiple
 		</ul>
 		<h3>Return value</h3>
 				
-<p><em><a href="##(MENU_COALITION_COMMAND)">#MENU<em>COALITION</em>COMMAND</a>:</em>
-self</p>
+<p><em><a href="##(MENU_COALITION_COMMAND)">#MENU<em>COALITION</em>COMMAND</a>:</em></p>
+

 </dd>
 </dl>
@@ -1366,7 +1514,7 @@ self</p>
 <dt>

 <a id="#(MENU_COMMAND_BASE).New" >
-<strong>MENU_COMMAND_BASE:New(MenuText, ParentMenu, CommandMenuFunction, CommandMenuArguments)</strong>
+<strong>MENU_COMMAND_BASE.New(#, self, MenuText, ParentMenu, CommandMenuFunction, CommandMenuArguments)</strong>
 </a>
 </dt>
 <dd>
@@ -1377,6 +1525,17 @@ self</p>
 		<ul>
 				<li>
 				
+<p><code><em> # </em></code>: 
+ENU<em>COMMAND</em>BASE</p>
+
+				</li>
+				<li>
+				
+<p><code><em> self </em></code>: </p>
+
+				</li>
+				<li>
+				
 <p><code><em> MenuText </em></code>: </p>

 				</li>
@@ -1396,6 +1555,11 @@ self</p>

 				</li>
 		</ul>
+		<h3>Return value</h3>
+				
+<p><em><a href="##(MENU_COMMAND_BASE)">#MENU<em>COMMAND</em>BASE</a>:</em></p>
+
+
 </dd>
 </dl>

@@ -1523,20 +1687,6 @@ self</p>
 	


-</dd>
-</dl>
-		<dl class="function">
-<dt>
-
-		<em></em>
-<a id="#(MENU_GROUP).Menus" >
-<strong>MENU_GROUP.Menus</strong>
-</a>
-</dt>
-<dd>
-	
-
-
 </dd>
 </dl>
 		<dl class="function">
@@ -1613,13 +1763,21 @@ self</p>
 <dt>

 <a id="#(MENU_GROUP).Remove" >
-<strong>MENU_GROUP:Remove()</strong>
+<strong>MENU_GROUP:Remove(MenuTime)</strong>
 </a>
 </dt>
 <dd>
 	
 <p>Removes the main menu and sub menus recursively of this MENU_GROUP.</p>

+		<h3>Parameter</h3>
+		<ul>
+				<li>
+				
+<p><code><em> MenuTime </em></code>: </p>
+
+				</li>
+		</ul>
 		<h3>Return value</h3>
 				
 <p><em>#nil:</em></p>
@@ -1631,13 +1789,21 @@ self</p>
 <dt>

 <a id="#(MENU_GROUP).RemoveSubMenus" >
-<strong>MENU_GROUP:RemoveSubMenus()</strong>
+<strong>MENU_GROUP:RemoveSubMenus(MenuTime)</strong>
 </a>
 </dt>
 <dd>
 	
 <p>Removes the sub menus recursively of this MENU_GROUP.</p>

+		<h3>Parameter</h3>
+		<ul>
+				<li>
+				
+<p><code><em> MenuTime </em></code>: </p>
+
+				</li>
+		</ul>
 		<h3>Return value</h3>
 				
 <p><em><a href="##(MENU_GROUP)">#MENU_GROUP</a>:</em>
@@ -1772,8 +1938,8 @@ An argument for the function.</p>
 		</ul>
 		<h3>Return value</h3>
 				
-<p><em><a href="Menu.html##(MENU_GROUP_COMMAND)">Menu#MENU<em>GROUP</em>COMMAND</a>:</em>
-self</p>
+<p><em><a href="##(MENU_GROUP_COMMAND)">#MENU<em>GROUP</em>COMMAND</a>:</em></p>
+

 </dd>
 </dl>
@@ -1809,13 +1975,21 @@ self</p>
 <dt>

 <a id="#(MENU_GROUP_COMMAND).Remove" >
-<strong>MENU_GROUP_COMMAND:Remove()</strong>
+<strong>MENU_GROUP_COMMAND:Remove(MenuTime)</strong>
 </a>
 </dt>
 <dd>
 	
 <p>Removes a menu structure for a group.</p>

+		<h3>Parameter</h3>
+		<ul>
+				<li>
+				
+<p><code><em> MenuTime </em></code>: </p>
+
+				</li>
+		</ul>
 		<h3>Return value</h3>
 				
 <p><em>#nil:</em></p>
@@ -1874,8 +2048,8 @@ The parent menu. This parameter can be ignored if you want the menu to be locate
 		</ul>
 		<h3>Return value</h3>
 				
-<p><em><a href="##(MENU_MISSION)">#MENU_MISSION</a>:</em>
-self</p>
+<p><em><a href="##(MENU_MISSION)">#MENU_MISSION</a>:</em></p>
+

 </dd>
 </dl>
@@ -1913,8 +2087,8 @@ self</p>

 		<h3>Return value</h3>
 				
-<p><em><a href="##(MENU_MISSION)">#MENU_MISSION</a>:</em>
-self</p>
+<p><em><a href="##(MENU_MISSION)">#MENU_MISSION</a>:</em></p>
+

 </dd>
 </dl>