MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2022-04-25 08:46:39 +00:00
parent 52aa0eb715
commit be0ce2be29
132 changed files with 14448 additions and 9757 deletions

View File

@@ -1335,6 +1335,17 @@ Controls a network of short range air/missile defense groups.</p>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p>This module contains derived utilities taken from the MIST framework, as well as a lot of added helpers from the MOOSE community.</p>
</p></div>
</div>
</div>
<div class="w3-col s12 m6 l4">
<div class="w3-card-4 w3-white w3-margin-16">
<div class="w3-display-container w3-text-white w3-text-shadow">
<img src= "../Images/MOOSE.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Utils.FiFo.html">Utils.FiFo</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p> <strong>UTILS</strong> - ClassicFiFo Stack.</p>
</p></div>
</div>
</div>
@@ -1927,6 +1938,12 @@ amount of fuel in the group.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).GetMinHeight">GROUP:GetMinHeight()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the current minimum height of the group.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).GetNatoReportingName">GROUP:GetNatoReportingName()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p> [AIRPLANE] Get the NATO reporting name (platform, e.g.</p>
</td>
</tr>
<tr class="w3-border">
@@ -5089,7 +5106,7 @@ To raise these events, provide the <code>GenerateEvent</code> parameter.</p>
</div>
<div class="w3-half">
<p>If true, a crash or dead event for each unit is generated. If false, if no event is triggered. If nil, a RemoveUnit event is triggered.</p>
<p>If true, a crash [AIR] or dead [GROUND] event for each unit is generated. If false, if no event is triggered. If nil, a RemoveUnit event is triggered.</p>
</div>
</div>
@@ -5879,15 +5896,15 @@ amount of fuel in the group.</p>
</div>
<div class="w3-half">
<p>The fuel state of the unit with the least amount of fuel</p>
<p>The fuel state of the unit with the least amount of fuel.</p>
</div>
<div class="w3-half">
<p><a href="##(Unit)">#Unit</a>:</p>
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a>:</p>
</div>
<div class="w3-half">
<p>reference to #Unit object for further processing</p>
<p>reference to #Unit object for further processing.</p>
</div>
</div>
@@ -5910,24 +5927,16 @@ amount of fuel in the group.</p>
<div class="w3-margin-left">
<p>GROUP</p>
</div>
<h2><strong>Return values:</strong></h2>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#number:</p>
</div>
<div class="w3-half">
<p>mean heading of the GROUP</p>
<div class="w3-half">
<p>#number:</p>
</div>
<div class="w3-half">
<p>Mean heading of the GROUP in degrees or #nil The first UNIT is not existing or alive.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The first UNIT is not existing or alive.</p>
</div>
</div>
</div>
</div>
@@ -6147,6 +6156,39 @@ amount of fuel in the group.</p>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(GROUP).GetNatoReportingName" ><strong>GROUP:GetNatoReportingName()</strong></a></h2>
</div>
<p> [AIRPLANE] Get the NATO reporting name (platform, e.g.</p>
<p>"Flanker") of a GROUP (note - first unit the group). "Bogey" if not found. Currently airplanes only!</p>
<div id= "#Functions##GetNatoReportingName" 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>GROUP</p>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#string:</p>
</div>
<div class="w3-half">
<p>NatoReportingName or "Bogey" if unknown.</p>
</div>
</div>
</div>
</div>
</div>
@@ -6369,27 +6411,21 @@ amount of fuel in the group.</p>
</p>
</div>
<div class="w3-half">
<p></p>
<p>Radius in meters.</p>
</div>
</div>
<h2><strong>Return values:</strong></h2>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="DCS.html##(Vec3)">DCS#Vec3</a>:</p>
</div>
<div class="w3-half">
<p>The random 3D point vector around the first UNIT of the GROUP.</p>
<div class="w3-half">
<p><a href="DCS.html##(Vec3)">DCS#Vec3</a>:</p>
</div>
<div class="w3-half">
<p>The random 3D point vector around the first UNIT of the GROUP or #nil The GROUP is invalid or empty. </p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The GROUP is invalid or empty</p>
</div>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>
@@ -6863,24 +6899,16 @@ amount of fuel in the group.</p>
<div class="w3-margin-left">
<p>GROUP</p>
</div>
<h2><strong>Return values:</strong></h2>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="DCS.html##(Vec3)">DCS#Vec3</a>:</p>
</div>
<div class="w3-half">
<p>The velocity Vec3 vector</p>
<div class="w3-half">
<p><a href="DCS.html##(Vec3)">DCS#Vec3</a>:</p>
</div>
<div class="w3-half">
<p>The velocity Vec3 vector or <code>#nil</code> if the GROUP is not existing or alive. </p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The GROUP is not existing or alive. </p>
</div>
</div>
</div>
</div>