MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2023-08-17 17:23:47 +00:00
parent b108a2fc30
commit 7ae42d1c8c
144 changed files with 10211 additions and 698 deletions

View File

@@ -1566,6 +1566,17 @@
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Wrapper</strong> - STATIC wraps the DCS StaticObject class.</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/Wrapper_Storage.png" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Storage.html">Wrapper.Storage</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Wrapper</strong> - Warehouse storage of DCS airbases.</p>
</p></div>
</div>
</div>
@@ -1902,6 +1913,18 @@ is implemented in the AIRBASE class as <a href="##(AIRBASE).GetName">AIRBASE.Get
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AIRBASE).GetRunways">AIRBASE:GetRunways()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get runways.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AIRBASE).GetStorage">AIRBASE:GetStorage()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the warehouse storage of this airbase.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AIRBASE).GetWarehouse">AIRBASE:GetWarehouse()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the DCS warehouse.</p>
</td>
</tr>
<tr class="w3-border">
@@ -1914,6 +1937,12 @@ is implemented in the AIRBASE class as <a href="##(AIRBASE).GetName">AIRBASE.Get
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AIRBASE).IsAirdrome">AIRBASE:IsAirdrome()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Check if airbase is an airdrome.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AIRBASE).IsAutoCapture">AIRBASE:IsAutoCapture()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns whether auto capturing of the airbase is on or off.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2132,6 +2161,30 @@ is implemented in the AIRBASE class as <a href="##(AIRBASE).GetName">AIRBASE.Get
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AIRBASE).SetActiveRunwayTakeoff">AIRBASE:SetActiveRunwayTakeoff(Name, PreferLeft)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set the active runway for takeoff.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AIRBASE).SetAutoCapture">AIRBASE:SetAutoCapture(Switch)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Enables or disables automatic capturing of the airbase.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AIRBASE).SetAutoCaptureOFF">AIRBASE:SetAutoCaptureOFF()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Disables automatic capturing of the airbase.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AIRBASE).SetAutoCaptureON">AIRBASE:SetAutoCaptureON()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Enables automatic capturing of the airbase.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AIRBASE).SetCoalition">AIRBASE:SetCoalition(Coal)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Sets the coalition of the airbase.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2403,6 +2456,12 @@ is implemented in the AIRBASE class as <a href="##(AIRBASE).GetName">AIRBASE.Get
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AIRBASE).runways">AIRBASE.runways</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Runways of airdromes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AIRBASE).storage">AIRBASE.storage</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>The DCS warehouse storage.</p>
</td>
</tr>
</table>
@@ -4581,6 +4640,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="Wrapper.Storage.html##(STORAGE)">Wrapper.Storage#STORAGE</a>
<a id="#(AIRBASE).storage" ><strong>AIRBASE.storage</strong></a>
<p>The DCS warehouse storage.</p>
</div>
</div>
<div class="functions w3-container w3-theme-l2">
<h2>Function(s)</h2>
@@ -6009,6 +6079,70 @@ The dimension of the spawned aircraft and of the potential obstacle are taken in
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(AIRBASE).GetStorage" ><strong>AIRBASE:GetStorage()</strong></a></h2>
</div>
<p>Get the warehouse storage of this airbase.</p>
<p>The returned <code>STORAGE</code> object is the wrapper of the DCS warehouse.
This allows you to add and remove items such as aircraft, liquids, weapons and other equipment.</p>
<div id= "#Functions##GetStorage" 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>AIRBASE</p>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="Wrapper.Storage.html##(STORAGE)">Wrapper.Storage#STORAGE</a>:</p>
</div>
<div class="w3-half">
<p>The storage.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(AIRBASE).GetWarehouse" ><strong>AIRBASE:GetWarehouse()</strong></a></h2>
</div>
<p>Get the DCS warehouse.</p>
<div id= "#Functions##GetWarehouse" 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>AIRBASE</p>
</div>
<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##(Warehouse)">DCS#Warehouse</a>:</p>
</div>
<div class="w3-half">
<p>The DCS warehouse object.</p>
</div>
</div>
</div>
</div>
</div>
@@ -6069,6 +6203,36 @@ The dimension of the spawned aircraft and of the potential obstacle are taken in
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(AIRBASE).IsAutoCapture" ><strong>AIRBASE:IsAutoCapture()</strong></a></h2>
</div>
<p>Returns whether auto capturing of the airbase is on or off.</p>
<div id= "#Functions##IsAutoCapture" 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>AIRBASE</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>Returns <code>true</code> if auto capturing is on, <code>false</code> if off and <code>nil</code> if the airbase object cannot be retrieved. </p>
</div>
</div>
</div>
</div>
</div>
@@ -6379,6 +6543,154 @@ The dimension of the spawned aircraft and of the potential obstacle are taken in
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(AIRBASE).SetAutoCapture" ><strong>AIRBASE:SetAutoCapture(Switch)</strong></a></h2>
</div>
<p>Enables or disables automatic capturing of the airbase.</p>
<div id= "#Functions##SetAutoCapture" 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>AIRBASE</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>
#boolean
<strong><strong>Switch</strong></strong>
</p>
</div>
<div class="w3-half">
<p>If <code>true</code>, enable auto capturing. If <code>false</code>, disable it.</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="##(AIRBASE)">#AIRBASE</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(AIRBASE).SetAutoCaptureOFF" ><strong>AIRBASE:SetAutoCaptureOFF()</strong></a></h2>
</div>
<p>Disables automatic capturing of the airbase.</p>
<div id= "#Functions##SetAutoCaptureOFF" 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>AIRBASE</p>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="##(AIRBASE)">#AIRBASE</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(AIRBASE).SetAutoCaptureON" ><strong>AIRBASE:SetAutoCaptureON()</strong></a></h2>
</div>
<p>Enables automatic capturing of the airbase.</p>
<div id= "#Functions##SetAutoCaptureON" 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>AIRBASE</p>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="##(AIRBASE)">#AIRBASE</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(AIRBASE).SetCoalition" ><strong>AIRBASE:SetCoalition(Coal)</strong></a></h2>
</div>
<p>Sets the coalition of the airbase.</p>
<div id= "#Functions##SetCoalition" 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>AIRBASE</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>
#number
<strong><strong>Coal</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Coalition that the airbase should have (0=Neutral, 1=Red, 2=Blue).</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="##(AIRBASE)">#AIRBASE</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
</div>
</div>
</div>
@@ -7369,6 +7681,17 @@ Note that this DOES NOT remove the airbase from the list. It just makes it unres
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="Wrapper.Storage.html##(STORAGE)">Wrapper.Storage#STORAGE</a>
<a id="#(AIRBASE).storage" ><strong>AIRBASE.storage</strong></a>
<p>The DCS warehouse storage.</p>
</div>
</div>
<div class="functions w3-container w3-theme-l2">
<h2>Function(s)</h2>
@@ -11940,6 +12263,17 @@ Coordinates are dependent on the position of the maps origin.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="Wrapper.Storage.html##(STORAGE)">Wrapper.Storage#STORAGE</a>
<a id="#(AIRBASE).storage" ><strong>AIRBASE.storage</strong></a>
<p>The DCS warehouse storage.</p>
</div>
</div>
<div class="functions w3-container w3-theme-l2">
<h2>Function(s)</h2>
@@ -13047,6 +13381,17 @@ If the Identifiable is alive, true is returned. </p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="Wrapper.Storage.html##(STORAGE)">Wrapper.Storage#STORAGE</a>
<a id="#(AIRBASE).storage" ><strong>AIRBASE.storage</strong></a>
<p>The DCS warehouse storage.</p>
</div>
</div>
<div class="functions w3-container w3-theme-l2">
<h2>Function(s)</h2>
@@ -13789,6 +14134,17 @@ If the Identifiable is alive, true is returned. </p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="Wrapper.Storage.html##(STORAGE)">Wrapper.Storage#STORAGE</a>
<a id="#(AIRBASE).storage" ><strong>AIRBASE.storage</strong></a>
<p>The DCS warehouse storage.</p>
</div>
</div>
<div class="functions w3-container w3-theme-l2">
<h2>Function(s)</h2>