MOOSE generated documentation [skip ci]

This commit is contained in:
FlightControl-User
2020-11-15 22:04:46 +00:00
parent 472ba15d72
commit 73620d3d2e
94 changed files with 1793 additions and 1493 deletions

View File

@@ -1663,7 +1663,7 @@ Example code snippet:</p>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(EVENT).Init">EVENT:Init(EventID, EventClass)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Initializes the Events structure for the event</p>
<p>Initializes the Events structure for the event.</p>
</td>
</tr>
<tr class="w3-border">
@@ -1717,29 +1717,29 @@ Example code snippet:</p>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(EVENT).OnEventForUnit">EVENT:OnEventForUnit(UnitName, EventFunction, EventClass, EventID)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set a new listener for an S_EVENT_X event for a UNIT.</p>
<p>Set a new listener for an <code>S_EVENT_X</code> event for a UNIT.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(EVENT).OnEventGeneric">EVENT:OnEventGeneric(EventFunction, EventClass, EventID)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set a new listener for an S_EVENT_X event independent from a unit or a weapon.</p>
<p>Set a new listener for an <code>S_EVENT_X</code> event independent from a unit or a weapon.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(EVENT).OnLandForTemplate">EVENT:OnLandForTemplate(EventTemplate, EventFunction, EventClass)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Create an OnLand event handler for a group</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(EVENT).OnTakeOffForTemplate">EVENT:OnTakeOffForTemplate(EventTemplate, EventFunction, EventClass)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Create an OnTakeOff event handler for a group</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(EVENT).RemoveAll">EVENT:RemoveAll(EventObject)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(EVENT).RemoveAll">EVENT:RemoveAll(EventClass)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Clears all event subscriptions for a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> derived object.</p>
</td>
@@ -1753,13 +1753,13 @@ Example code snippet:</p>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(EVENT).Reset">EVENT:Reset(EventClass, EventID, EventObject)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Resets subscriptions</p>
<p>Resets subscriptions.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(EVENT).onEvent">EVENT:onEvent(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Main event function.</p>
</td>
</tr>
</table>
@@ -1897,7 +1897,7 @@ Example code snippet:</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(EVENT).HandleEvent">EVENT:HandleEvent(Event, EventFunction)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(EVENT).HandleEvent">EVENT:HandleEvent(EventID, EventFunction)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Subscribe to a DCS Event.</p>
</td>
@@ -2214,7 +2214,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(EVENT).UnHandleEvent">EVENT:UnHandleEvent(Event)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(EVENT).UnHandleEvent">EVENT:UnHandleEvent(EventID)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>UnSubscribe to a DCS event.</p>
</td>
@@ -2622,7 +2622,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="##(EVENTHANDLER).New">EVENTHANDLER:New()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>The EVENTHANDLER constructor</p>
<p>The EVENTHANDLER constructor.</p>
</td>
</tr>
</table>
@@ -2760,7 +2760,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(EVENTHANDLER).HandleEvent">EVENTHANDLER:HandleEvent(Event, EventFunction)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(EVENTHANDLER).HandleEvent">EVENTHANDLER:HandleEvent(EventID, EventFunction)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Subscribe to a DCS Event.</p>
</td>
@@ -3077,7 +3077,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(EVENTHANDLER).UnHandleEvent">EVENTHANDLER:UnHandleEvent(Event)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(EVENTHANDLER).UnHandleEvent">EVENTHANDLER:UnHandleEvent(EventID)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>UnSubscribe to a DCS event.</p>
</td>
@@ -3628,7 +3628,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<h2><a id="#(EVENT).Init" ><strong>EVENT:Init(EventID, EventClass)</strong></a></h2>
</div>
<p>Initializes the Events structure for the event</p>
<p>Initializes the Events structure for the event.</p>
<div id= "#Functions##Init" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -3645,7 +3645,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</p>
</div>
<div class="w3-half">
<p></p>
<p>Event ID.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
@@ -3656,7 +3658,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</p>
</div>
<div class="w3-half">
<p></p>
<p>The class object for which events are handled.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
@@ -3882,7 +3886,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</p>
</div>
<div class="w3-half">
<p></p>
<p>The GROUP object.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
@@ -3901,6 +3907,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>EventClass</strong></strong>
</p>
</div>
@@ -3927,7 +3934,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
@@ -4187,7 +4194,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<h2><a id="#(EVENT).OnEventForUnit" ><strong>EVENT:OnEventForUnit(UnitName, EventFunction, EventClass, EventID)</strong></a></h2>
</div>
<p>Set a new listener for an S_EVENT_X event for a UNIT.</p>
<p>Set a new listener for an <code>S_EVENT_X</code> event for a UNIT.</p>
<div id= "#Functions##OnEventForUnit" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -4252,7 +4259,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
@@ -4267,7 +4274,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<h2><a id="#(EVENT).OnEventGeneric" ><strong>EVENT:OnEventGeneric(EventFunction, EventClass, EventID)</strong></a></h2>
</div>
<p>Set a new listener for an S_EVENT_X event independent from a unit or a weapon.</p>
<p>Set a new listener for an <code>S_EVENT_X</code> event independent from a unit or a weapon.</p>
<div id= "#Functions##OnEventGeneric" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -4334,7 +4341,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<h2><a id="#(EVENT).OnLandForTemplate" ><strong>EVENT:OnLandForTemplate(EventTemplate, EventFunction, EventClass)</strong></a></h2>
</div>
<p>Create an OnLand event handler for a group</p>
<div id= "#Functions##OnLandForTemplate" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -4346,6 +4353,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>EventTemplate</strong></strong>
</p>
</div>
@@ -4356,23 +4364,40 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#function
<strong><strong>EventFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>The function to be called when the event occurs for the unit.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>EventClass</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>The self instance of the class for which the event is.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="##(EVENT)">#EVENT</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
</div>
</div>
@@ -4384,7 +4409,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<h2><a id="#(EVENT).OnTakeOffForTemplate" ><strong>EVENT:OnTakeOffForTemplate(EventTemplate, EventFunction, EventClass)</strong></a></h2>
</div>
<p>Create an OnTakeOff event handler for a group</p>
<div id= "#Functions##OnTakeOffForTemplate" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -4396,33 +4421,53 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>EventTemplate</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>Template table.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#function
<strong><strong>EventFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>The function to be called when the event occurs for the unit.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>EventClass</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>The self instance of the class for which the event is.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="##(EVENT)">#EVENT</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
</div>
</div>
@@ -4431,7 +4476,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(EVENT).RemoveAll" ><strong>EVENT:RemoveAll(EventObject)</strong></a></h2>
<h2><a id="#(EVENT).RemoveAll" ><strong>EVENT:RemoveAll(EventClass)</strong></a></h2>
</div>
<p>Clears all event subscriptions for a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> derived object.</p>
@@ -4447,13 +4492,26 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div class="w3-half">
<p>
<a href="Core.Base.html##(BASE)">Core.Base#BASE</a>
<strong><strong>EventObject</strong></strong>
<strong><strong>EventClass</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>The self class object for which the events are removed.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="##(EVENT)">#EVENT</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
</div>
</div>
@@ -4495,17 +4553,19 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</p>
</div>
<div class="w3-half">
<p></p>
<p>Event ID.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="##(EVENT.Events)">#EVENT.Events</a>:</p>
<p><a href="##(EVENT)">#EVENT</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
@@ -4520,7 +4580,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<h2><a id="#(EVENT).Reset" ><strong>EVENT:Reset(EventClass, EventID, EventObject)</strong></a></h2>
</div>
<p>Resets subscriptions</p>
<p>Resets subscriptions.</p>
<div id= "#Functions##Reset" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -4550,7 +4610,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</p>
</div>
<div class="w3-half">
<p></p>
<p>Event ID.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
@@ -4585,7 +4647,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<h2><a id="#(EVENT).onEvent" ><strong>EVENT:onEvent(Event)</strong></a></h2>
</div>
<p>Main event function.</p>
<div id= "#Functions##onEvent" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -4602,7 +4664,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</p>
</div>
<div class="w3-half">
<p></p>
<p>Event data table.</p>
</div>
</div>
</div>
@@ -5397,7 +5461,7 @@ reflecting the order of the classes subscribed to the Event to be processed.</p>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(EVENT).HandleEvent" ><strong>EVENT:HandleEvent(Event, EventFunction)</strong></a></h2>
<h2><a id="#(EVENT).HandleEvent" ><strong>EVENT:HandleEvent(EventID, EventFunction)</strong></a></h2>
</div>
<p>Subscribe to a DCS Event.</p>
@@ -5413,11 +5477,13 @@ reflecting the order of the classes subscribed to the Event to be processed.</p>
<div class="w3-half">
<p>
<a href="Core.Event.html##(EVENTS)">Core.Event#EVENTS</a>
<strong><strong>Event</strong></strong>
<strong><strong>EventID</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>Event ID.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
@@ -7444,7 +7510,7 @@ BASE:TraceOnOff( false )</code></pre>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(EVENT).UnHandleEvent" ><strong>EVENT:UnHandleEvent(Event)</strong></a></h2>
<h2><a id="#(EVENT).UnHandleEvent" ><strong>EVENT:UnHandleEvent(EventID)</strong></a></h2>
</div>
<p>UnSubscribe to a DCS event.</p>
@@ -7460,11 +7526,13 @@ BASE:TraceOnOff( false )</code></pre>
<div class="w3-half">
<p>
<a href="Core.Event.html##(EVENTS)">Core.Event#EVENTS</a>
<strong><strong>Event</strong></strong>
<strong><strong>EventID</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>Event ID.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
@@ -8211,7 +8279,7 @@ Note that at the beginning of each field description, there is an indication whi
<div id= "#Types##EVENTHANDLER" class="w3-container w3-white w3-padding-16" id="module_other_types">
<div class="w3-white" id="record_type">
<p>The EVENTHANDLER structure</p>
<p>The EVENTHANDLER structure.</p>
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
@@ -8247,7 +8315,7 @@ Note that at the beginning of each field description, there is an indication whi
<h2><a id="#(EVENTHANDLER).New" ><strong>EVENTHANDLER:New()</strong></a></h2>
</div>
<p>The EVENTHANDLER constructor</p>
<p>The EVENTHANDLER constructor.</p>
<div id= "#Functions##New" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -9058,7 +9126,7 @@ reflecting the order of the classes subscribed to the Event to be processed.</p>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(EVENTHANDLER).HandleEvent" ><strong>EVENTHANDLER:HandleEvent(Event, EventFunction)</strong></a></h2>
<h2><a id="#(EVENTHANDLER).HandleEvent" ><strong>EVENTHANDLER:HandleEvent(EventID, EventFunction)</strong></a></h2>
</div>
<p>Subscribe to a DCS Event.</p>
@@ -9074,11 +9142,13 @@ reflecting the order of the classes subscribed to the Event to be processed.</p>
<div class="w3-half">
<p>
<a href="Core.Event.html##(EVENTS)">Core.Event#EVENTS</a>
<strong><strong>Event</strong></strong>
<strong><strong>EventID</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>Event ID.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
@@ -11105,7 +11175,7 @@ BASE:TraceOnOff( false )</code></pre>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(EVENTHANDLER).UnHandleEvent" ><strong>EVENTHANDLER:UnHandleEvent(Event)</strong></a></h2>
<h2><a id="#(EVENTHANDLER).UnHandleEvent" ><strong>EVENTHANDLER:UnHandleEvent(EventID)</strong></a></h2>
</div>
<p>UnSubscribe to a DCS event.</p>
@@ -11121,11 +11191,13 @@ BASE:TraceOnOff( false )</code></pre>
<div class="w3-half">
<p>
<a href="Core.Event.html##(EVENTS)">Core.Event#EVENTS</a>
<strong><strong>Event</strong></strong>
<strong><strong>EventID</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>Event ID.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>