MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2022-09-22 15:37:44 +00:00
parent 5de1a5835a
commit 972dcf0d10
27 changed files with 1107 additions and 773 deletions

View File

@@ -2757,6 +2757,12 @@ If you use units build by multiple templates, they will effectively double on lo
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD)._GetFMBeacon">CTLD:_GetFMBeacon(Name)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(Internal) Function to obtain a valid FM frequency.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD)._GetMaxLoadableMass">CTLD:_GetMaxLoadableMass(Unit)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(Internal) Function to calculate max loadable mass left over.</p>
</td>
</tr>
<tr class="w3-border">
@@ -4485,6 +4491,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD_CARGO).LoadDirectly">CTLD_CARGO.LoadDirectly</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Flag for direct loading.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD_CARGO).Mark">CTLD_CARGO.Mark</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -5057,6 +5069,61 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD_CARGO).onEvent">CTLD_CARGO:onEvent(event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>The main event handling function...</p>
</td>
</tr>
</table>
</div>
<div class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(CTLD_CARGO.Enum)">Type <strong>CTLD_CARGO.Enum</strong></a></h2></div>
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
<strong><a href="##(CTLD_CARGO.Enum)">CTLD_CARGO.Enum</a></strong>
</div>
<div class="w3-card w3-margin">
<table class="w3-table w3-border-bottom w3-border-theme-l2">
<tr class="w3-theme-l1">
<th class="w3-half w3-left-align w3-container w3-padding-16"word-wrap: break-word">Fields and Methods inherited from CTLD_CARGO.Enum</th>
<th class="w3-half w3-left-align w3-container w3-padding-16">Description</th>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD_CARGO.Enum).CRATE">CTLD_CARGO.Enum.CRATE</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD_CARGO.Enum).ENGINEERS">CTLD_CARGO.Enum.ENGINEERS</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD_CARGO.Enum).FOB">CTLD_CARGO.Enum.FOB</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD_CARGO.Enum).REPAIR">CTLD_CARGO.Enum.REPAIR</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD_CARGO.Enum).STATIC">CTLD_CARGO.Enum.STATIC</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD_CARGO.Enum).TROOPS">CTLD_CARGO.Enum.TROOPS</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD_CARGO.Enum).VEHICLE">CTLD_CARGO.Enum.VEHICLE</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
</table>
@@ -7039,6 +7106,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>Name of the class.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CTLD).CrateCounter" ><strong>CTLD.CrateCounter</strong></a>
</div>
</div>
@@ -7070,7 +7148,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CTLD).CtldUnits" ><strong>CTLD.CtldUnits</strong></a>
@@ -7164,7 +7242,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CTLD).FreeUHFFrequencies" ><strong>CTLD.FreeUHFFrequencies</strong></a>
@@ -7820,7 +7898,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CTLD).troopdropzoneradius" ><strong>CTLD.troopdropzoneradius</strong></a>
@@ -7836,9 +7914,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>self.I({prefixes = self.prefixes})</p>
</div>
</div>
@@ -11385,7 +11460,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="##(boolen)">#boolen</a>:</p>
<p>#boolean:</p>
</div>
<div class="w3-half">
@@ -11935,6 +12010,48 @@ 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="#(CTLD)._GetMaxLoadableMass" ><strong>CTLD:_GetMaxLoadableMass(Unit)</strong></a></h2>
</div>
<p>(Internal) Function to calculate max loadable mass left over.</p>
<div id= "#Functions##_GetMaxLoadableMass" 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>CTLD</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="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a>
<strong><strong>Unit</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<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>maxloadable Max loadable mass in kg</p>
</div>
</div>
</div>
</div>
</div>
@@ -14563,6 +14680,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>Name of the class.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CTLD).CrateCounter" ><strong>CTLD.CrateCounter</strong></a>
</div>
</div>
@@ -14594,7 +14722,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CTLD).CtldUnits" ><strong>CTLD.CtldUnits</strong></a>
@@ -14688,7 +14816,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CTLD).FreeUHFFrequencies" ><strong>CTLD.FreeUHFFrequencies</strong></a>
@@ -15344,7 +15472,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CTLD).troopdropzoneradius" ><strong>CTLD.troopdropzoneradius</strong></a>
@@ -15360,9 +15488,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>self.I({prefixes = self.prefixes})</p>
</div>
</div>
@@ -16924,6 +17049,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>Name of the class.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CTLD).CrateCounter" ><strong>CTLD.CrateCounter</strong></a>
</div>
</div>
@@ -16955,7 +17091,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CTLD).CtldUnits" ><strong>CTLD.CtldUnits</strong></a>
@@ -17049,7 +17185,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CTLD).FreeUHFFrequencies" ><strong>CTLD.FreeUHFFrequencies</strong></a>
@@ -17705,7 +17841,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CTLD).troopdropzoneradius" ><strong>CTLD.troopdropzoneradius</strong></a>
@@ -17721,9 +17857,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>self.I({prefixes = self.prefixes})</p>
</div>
</div>
@@ -21756,7 +21889,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="##(CTLD_CARGO.Enum)">#CTLD_CARGO.Enum</a>
#string
<a id="#(CTLD_CARGO).CargoType" ><strong>CTLD_CARGO.CargoType</strong></a>
<p>Enumerator of Type.</p>
@@ -21827,6 +21960,17 @@ When moose is loading dynamically (for moose class development), tracing is swit
<p>Flag for direct loading.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CTLD_CARGO).Mark" ><strong>CTLD_CARGO.Mark</strong></a>
</div>
</div>
@@ -21905,7 +22049,7 @@ When moose is loading dynamically (for moose class development), tracing is swit
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="##(CTLD_CARGO.Enum)">#CTLD_CARGO.Enum</a>
#string
<a id="#(CTLD_CARGO).CargoType" ><strong>CTLD_CARGO.CargoType</strong></a>
<p>Enumerator of Type.</p>
@@ -21976,6 +22120,17 @@ When moose is loading dynamically (for moose class development), tracing is swit
<p>Flag for direct loading.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CTLD_CARGO).Mark" ><strong>CTLD_CARGO.Mark</strong></a>
</div>
</div>
@@ -25395,6 +25550,98 @@ When moose is loading dynamically (for moose class development), tracing is swit
</div>
</div>
</div>
</div>
<div onclick="myFunction('#Types##CTLD_CARGO.Enum')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(CTLD_CARGO.Enum)">Type <strong>CTLD_CARGO.Enum</strong></a></h2></div>
<div id= "#Types##CTLD_CARGO.Enum" class="w3-container w3-white w3-padding-16" id="module_other_types">
<div class="w3-white" id="record_type">
<p>Define cargo types.</p>
<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">
#string
<a id="#(CTLD_CARGO.Enum).CRATE" ><strong>CTLD_CARGO.Enum.CRATE</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(CTLD_CARGO.Enum).ENGINEERS" ><strong>CTLD_CARGO.Enum.ENGINEERS</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(CTLD_CARGO.Enum).FOB" ><strong>CTLD_CARGO.Enum.FOB</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(CTLD_CARGO.Enum).REPAIR" ><strong>CTLD_CARGO.Enum.REPAIR</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(CTLD_CARGO.Enum).STATIC" ><strong>CTLD_CARGO.Enum.STATIC</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(CTLD_CARGO.Enum).TROOPS" ><strong>CTLD_CARGO.Enum.TROOPS</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(CTLD_CARGO.Enum).VEHICLE" ><strong>CTLD_CARGO.Enum.VEHICLE</strong></a>
</div>
</div>
<div class="functions w3-container w3-theme-l2">
<h2>Function(s)</h2>
</div>
</div>
</div>