MOOSE generated documentation [skip ci]

This commit is contained in:
FlightControl-User
2021-03-29 16:07:18 +00:00
parent d755d73460
commit 6ce666d341
99 changed files with 23284 additions and 553 deletions

View File

@@ -1704,6 +1704,12 @@ on defined intervals (currently every minute).</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MOVEMENT).OnEvent">MOVEMENT:OnEvent(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Occurs when an object is completely destroyed.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MOVEMENT).OnEventBDA">MOVEMENT:OnEventBDA(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>BDA.</p>
</td>
</tr>
<tr class="w3-border">
@@ -1734,6 +1740,12 @@ on defined intervals (currently every minute).</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MOVEMENT).OnEventDetailedFailure">MOVEMENT:OnEventDetailedFailure(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Unknown precisely what creates this event, likely tied into newer damage model.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MOVEMENT).OnEventDiscardChairAfterEjection">MOVEMENT:OnEventDiscardChairAfterEjection(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Discard chair after ejection.</p>
</td>
</tr>
<tr class="w3-border">
@@ -1785,6 +1797,12 @@ place: Object that the unit landed on.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MOVEMENT).OnEventLandingAfterEjection">MOVEMENT:OnEventLandingAfterEjection(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MOVEMENT).OnEventLandingQualityMark">MOVEMENT:OnEventLandingQualityMark(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Landing quality mark. </p>
</td>
</tr>
<tr class="w3-border">
@@ -1815,6 +1833,12 @@ place: Object that the unit landed on.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MOVEMENT).OnEventMissionStart">MOVEMENT:OnEventMissionStart(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Occurs when a mission starts </p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MOVEMENT).OnEventParatrooperLanding">MOVEMENT:OnEventParatrooperLanding(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Weapon add.</p>
</td>
</tr>
<tr class="w3-border">
@@ -1881,6 +1905,12 @@ place: Object that the unit landed on.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MOVEMENT).OnEventTakeoff">MOVEMENT:OnEventTakeoff(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Occurs when an aircraft takes off from an airbase, farp, or ship.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MOVEMENT).OnEventTriggerZone">MOVEMENT:OnEventTriggerZone(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Trigger zone.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2038,20 +2068,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(MOVEMENT).AliveUnits" ><strong>MOVEMENT.AliveUnits</strong></a>
<p> Contains the counter how many units are currently alive</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -2282,20 +2298,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(MOVEMENT).AliveUnits" ><strong>MOVEMENT.AliveUnits</strong></a>
<p> Contains the counter how many units are currently alive</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -3449,6 +3451,39 @@ end
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(MOVEMENT).OnEventBDA" ><strong>MOVEMENT:OnEventBDA(EventData)</strong></a></h2>
</div>
<p>BDA.</p>
<div id= "#Functions##OnEventBDA" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
<strong><strong>EventData</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The EventData structure.</p>
</div>
</div>
</div>
</div>
</div>
@@ -3635,6 +3670,39 @@ place: The airbase that was captured, can be a FARP or Airbase. When calling pla
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(MOVEMENT).OnEventDiscardChairAfterEjection" ><strong>MOVEMENT:OnEventDiscardChairAfterEjection(EventData)</strong></a></h2>
</div>
<p>Discard chair after ejection.</p>
<div id= "#Functions##OnEventDiscardChairAfterEjection" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
<strong><strong>EventData</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The EventData structure.</p>
</div>
</div>
</div>
</div>
</div>
@@ -3939,6 +4007,39 @@ place: Object that the unit landed on.</p>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(MOVEMENT).OnEventLandingQualityMark" ><strong>MOVEMENT:OnEventLandingQualityMark(EventData)</strong></a></h2>
</div>
<p>Landing quality mark. </p>
<div id= "#Functions##OnEventLandingQualityMark" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
<strong><strong>EventData</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The EventData structure.</p>
</div>
</div>
</div>
</div>
</div>
@@ -4113,6 +4214,42 @@ place: Object that the unit landed on.</p>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(MOVEMENT).OnEventParatrooperLanding" ><strong>MOVEMENT:OnEventParatrooperLanding(EventData)</strong></a></h2>
</div>
<p>Weapon add.</p>
<p>Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted.</p>
<div id= "#Functions##OnEventParatrooperLanding" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
<strong><strong>EventData</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The EventData structure.</p>
</div>
</div>
</div>
</div>
</div>
@@ -4515,6 +4652,39 @@ place: Object from where the AI took-off from. Can be an Airbase Object, FARP, o
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(MOVEMENT).OnEventTriggerZone" ><strong>MOVEMENT:OnEventTriggerZone(EventData)</strong></a></h2>
</div>
<p>Trigger zone.</p>
<div id= "#Functions##OnEventTriggerZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
<strong><strong>EventData</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The EventData structure.</p>
</div>
</div>
</div>
</div>
</div>