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>
@@ -1911,6 +1922,12 @@ If the DCS Unit object does not exist or is nil, the CLIENT methods will return
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetLifeRelative">CLIENT:GetLifeRelative()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the unit's relative health.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetNatoReportingName">CLIENT:GetNatoReportingName()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p> [AIRPLANE] Get the NATO reporting name of a UNIT.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2041,6 +2058,12 @@ If the DCS Unit object does not exist or is nil, the CLIENT methods will return
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).IsAlive">CLIENT:IsAlive()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns if the Unit is alive.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).IsAmmoSupply">CLIENT:IsAmmoSupply()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Check if the unit can supply ammo.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2059,6 +2082,12 @@ If the DCS Unit object does not exist or is nil, the CLIENT methods will return
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).IsFriendly">CLIENT:IsFriendly(FriendlyCoalition)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns if the unit is a friendly unit.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).IsFuelSupply">CLIENT:IsFuelSupply()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Check if the unit can supply fuel.</p>
</td>
</tr>
<tr class="w3-border">
@@ -4243,7 +4272,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Alive.</p>
<p> Alive2.</p>
</div>
@@ -5357,7 +5386,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Alive.</p>
<p> Alive2.</p>
</div>
@@ -6079,6 +6108,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetNatoReportingName" ><strong>CLIENT:GetNatoReportingName()</strong></a></h2>
</div>
<p> [AIRPLANE] Get the NATO reporting name of a UNIT.</p>
<p>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><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a></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>
@@ -6915,6 +6977,48 @@ If the Unit is alive but not active, false is returned. </p>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).IsAmmoSupply" ><strong>CLIENT:IsAmmoSupply()</strong></a></h2>
</div>
<p>Check if the unit can supply ammo.</p>
<p>Currently, we have</p>
<ul>
<li>M 818</li>
<li>Ural-375</li>
<li>ZIL-135</li>
</ul>
<p>This list needs to be extended, if DCS adds other units capable of supplying ammo.</p>
<div id= "#Functions##IsAmmoSupply" 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="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a></p>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#boolean:</p>
</div>
<div class="w3-half">
<p>If <code>true</code>, unit can supply ammo.</p>
</div>
</div>
</div>
</div>
</div>
@@ -7031,6 +7135,49 @@ If the Unit is alive but not active, false is returned. </p>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).IsFuelSupply" ><strong>CLIENT:IsFuelSupply()</strong></a></h2>
</div>
<p>Check if the unit can supply fuel.</p>
<p>Currently, we have</p>
<ul>
<li>M978 HEMTT Tanker</li>
<li>ATMZ-5</li>
<li>ATMZ-10</li>
<li>ATZ-5</li>
</ul>
<p>This list needs to be extended, if DCS adds other units capable of supplying fuel.</p>
<div id= "#Functions##IsFuelSupply" 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="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a></p>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#boolean:</p>
</div>
<div class="w3-half">
<p>If <code>true</code>, unit can supply fuel.</p>
</div>
</div>
</div>
</div>
</div>
@@ -7621,7 +7768,7 @@ If the Unit is alive but not active, false is returned. </p>
<p> Alive.</p>
<p> Alive2.</p>
</div>
@@ -16310,7 +16457,7 @@ Note that when the WayPoint parameter is used, the new start mission waypoint of
<p> Alive.</p>
<p> Alive2.</p>
</div>
@@ -19969,7 +20116,7 @@ Coordinates are dependent on the position of the maps origin.</p>
<p> Alive.</p>
<p> Alive2.</p>
</div>
@@ -20643,7 +20790,7 @@ If the Identifiable is alive, true is returned. </p>
<p> Alive.</p>
<p> Alive2.</p>
</div>
@@ -20923,7 +21070,7 @@ If the Identifiable is alive, true is returned. </p>
<p> Alive.</p>
<p> Alive2.</p>
</div>