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>
@@ -1671,6 +1682,7 @@
<li>PLAYERSJOINED</li>
<li>PLAYERS</li>
<li>CARGOS</li>
<li>STORAGES (DCS warehouses)</li>
</ul>
<p>On top, for internal MOOSE administration purposes, the DATABASE administers the Unit and Group TEMPLATES as defined within the Mission Editor.</p>
@@ -1764,6 +1776,12 @@ Moose refers to <strong>_DATABASE</strong> within the framework extensively, but
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DATABASE).AddStatic">DATABASE:AddStatic(DCSStaticName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Adds a Static based on the Static Name in the DATABASE.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DATABASE).AddStorage">DATABASE:AddStorage(AirbaseName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Adds a STORAGE (DCS warehouse wrapper) based on the Airbase Name to the DATABASE.</p>
</td>
</tr>
<tr class="w3-border">
@@ -1830,6 +1848,12 @@ Moose refers to <strong>_DATABASE</strong> within the framework extensively, but
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DATABASE).DeleteStatic">DATABASE:DeleteStatic(DCSStaticName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Deletes a Static from the DATABASE based on the Static Name.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DATABASE).DeleteStorage">DATABASE:DeleteStorage(AirbaseName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Deletes a STORAGE from the DATABASE based on the name of the associated airbase.</p>
</td>
</tr>
<tr class="w3-border">
@@ -1902,6 +1926,12 @@ Moose refers to <strong>_DATABASE</strong> within the framework extensively, but
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DATABASE).FindStatic">DATABASE:FindStatic(StaticName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Finds a STATIC based on the StaticName.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DATABASE).FindStorage">DATABASE:FindStorage(AirbaseName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Finds an STORAGE based on the name of the associated airbase.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2124,6 +2154,12 @@ Moose refers to <strong>_DATABASE</strong> within the framework extensively, but
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DATABASE).OnEventNewZone">DATABASE:OnEventNewZone(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the OnEventNewZone event.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DATABASE).STORAGES">DATABASE.STORAGES</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>DCS warehouse storages.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2800,6 +2836,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div onclick="myFunction('#Types##DATABASE')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(DATABASE)">Type <strong>DATABASE</strong></a></h2></div>
<div id= "#Types##DATABASE" class="w3-container w3-white w3-padding-16" id="module_other_types">
<div class="w3-white" id="record_type">
<p>DATABASE class.</p>
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</div>
@@ -2833,6 +2872,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">
#table
<a id="#(DATABASE).STORAGES" ><strong>DATABASE.STORAGES</strong></a>
<p>DCS warehouse storages.</p>
</div>
</div>
@@ -3319,6 +3369,50 @@ 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="#(DATABASE).AddStorage" ><strong>DATABASE:AddStorage(AirbaseName)</strong></a></h2>
</div>
<p>Adds a STORAGE (DCS warehouse wrapper) based on the Airbase Name to the DATABASE.</p>
<div id= "#Functions##AddStorage" 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>DATABASE</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>
#string
<strong><strong>AirbaseName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The name of the airbase.</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="Wrapper.Storage.html##(STORAGE)">Wrapper.Storage#STORAGE</a>:</p>
</div>
<div class="w3-half">
<p>Storage object.</p>
</div>
</div>
</div>
</div>
</div>
@@ -3657,6 +3751,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="#(DATABASE).DeleteStorage" ><strong>DATABASE:DeleteStorage(AirbaseName)</strong></a></h2>
</div>
<p>Deletes a STORAGE from the DATABASE based on the name of the associated airbase.</p>
<div id= "#Functions##DeleteStorage" 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>DATABASE</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>
#string
<strong><strong>AirbaseName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The name of the airbase.</p>
</div>
</div>
</div>
</div>
</div>
@@ -4139,6 +4266,50 @@ 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="#(DATABASE).FindStorage" ><strong>DATABASE:FindStorage(AirbaseName)</strong></a></h2>
</div>
<p>Finds an STORAGE based on the name of the associated airbase.</p>
<div id= "#Functions##FindStorage" 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>DATABASE</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>
#string
<strong><strong>AirbaseName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Name of the airbase.</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="Wrapper.Storage.html##(STORAGE)">Wrapper.Storage#STORAGE</a>:</p>
</div>
<div class="w3-half">
<p>The found STORAGE.</p>
</div>
</div>
</div>
</div>
</div>
@@ -6547,6 +6718,17 @@ This method is used by the SPAWN class.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(DATABASE).STORAGES" ><strong>DATABASE.STORAGES</strong></a>
<p>DCS warehouse storages.</p>
</div>
</div>