MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2021-07-14 06:49:18 +00:00
parent 6d428b0b17
commit 8525602b01
23 changed files with 2524 additions and 1018 deletions

View File

@@ -1787,6 +1787,7 @@ be loaded from the Rearm/Refuel menu, i.e. you can drop them into the field, but
<pre><code> my_ctld.enableHercules = true
my_ctld.HercMinAngels = 155 -- for troop/cargo drop via chute in meters, ca 470 ft
my_ctld.HercMaxAngels = 2000 -- for troop/cargo drop via chute in meters, ca 6000 ft
my_ctld.HercMaxSpeed = 77 -- 77mps or 270 kph or 150 kn
</code></pre>
<p>Also, the following options need to be set to <code>true</code>:</p>
@@ -1943,12 +1944,6 @@ be loaded from the Rearm/Refuel menu, i.e. you can drop them into the field, but
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD).CtldUnits">CTLD.CtldUnits</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).DROP">CTLD.DROP</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -2003,6 +1998,12 @@ be loaded from the Rearm/Refuel menu, i.e. you can drop them into the field, but
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD).HercMaxAngels">CTLD.HercMaxAngels</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).HercMaxSpeed">CTLD.HercMaxSpeed</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -2045,12 +2046,6 @@ be loaded from the Rearm/Refuel menu, i.e. you can drop them into the field, but
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD).IsUnitInZone">CTLD:IsUnitInZone(Unit, Zonetype)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(Internal) Function to see if a unit is in a specific zone type.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD).LOAD">CTLD.LOAD</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -2063,12 +2058,6 @@ be loaded from the Rearm/Refuel menu, i.e. you can drop them into the field, but
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD).Loaded_Cargo">CTLD.Loaded_Cargo</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).MOVE">CTLD.MOVE</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -2264,7 +2253,7 @@ be loaded from the Rearm/Refuel menu, i.e. you can drop them into the field, but
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD)._GenerateFMFrequencies">CTLD._GenerateFMFrequencies(sel, self)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD)._GenerateFMFrequencies">CTLD:_GenerateFMFrequencies()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(Internal) Function to generate valid FM Frequencies</p>
</td>
@@ -3520,6 +3509,37 @@ 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.CargoZone).vhfbeacon">CTLD.CargoZone.vhfbeacon</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Beacon info as #CTLD.ZoneBeacon</p>
</td>
</tr>
</table>
</div>
<div class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(CTLD.CargoZoneType)">Type <strong>CTLD.CargoZoneType</strong></a></h2></div>
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
<strong><a href="##(CTLD.CargoZoneType)">CTLD.CargoZoneType</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.CargoZoneType</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.CargoZoneType).DROP">CTLD.CargoZoneType.DROP</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.CargoZoneType).LOAD">CTLD.CargoZoneType.LOAD</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.CargoZoneType).MOVE">CTLD.CargoZoneType.MOVE</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
</table>
@@ -4715,11 +4735,24 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div id= "#Types##CTLD" class="w3-container w3-white w3-padding-16" id="module_other_types">
<div class="w3-white" id="record_type">
<p>Zone Type Info.</p>
<ul>
<li><strong>CTLD</strong> class, extends Core.Base#BASE, Core.Fsm#FSM</li>
</ul>
<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">
#number
<a id="#(CTLD).CargoCounter" ><strong>CTLD.CargoCounter</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -4734,7 +4767,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">
<a href="##(CTLD)">#CTLD</a>
<a href="##(CTLD.CargoZoneType)">#CTLD.CargoZoneType</a>
<a id="#(CTLD).CargoZoneType" ><strong>CTLD.CargoZoneType</strong></a>
@@ -4822,17 +4855,6 @@ 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">
#string
<a id="#(CTLD).DROP" ><strong>CTLD.DROP</strong></a>
</div>
</div>
@@ -4861,7 +4883,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).FreeFMFrequencies" ><strong>CTLD.FreeFMFrequencies</strong></a>
@@ -4872,7 +4894,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>
@@ -4888,6 +4910,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Beacons</p>
</div>
</div>
@@ -4905,7 +4930,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">
<a href="##(booolean)">#booolean</a>
#boolean
<a id="#(CTLD).HasBeenMoved" ><strong>CTLD.HasBeenMoved</strong></a>
@@ -4926,6 +4951,20 @@ 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">
#number
<a id="#(CTLD).HercMaxSpeed" ><strong>CTLD.HercMaxSpeed</strong></a>
<p> 280 kph or 150kn eq 77 mps</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -4944,18 +4983,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">
#string
<a id="#(CTLD).LOAD" ><strong>CTLD.LOAD</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="##(booolean)">#booolean</a>
#boolean
<a id="#(CTLD).LoadDirectly" ><strong>CTLD.LoadDirectly</strong></a>
@@ -4971,17 +4999,6 @@ 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">
#string
<a id="#(CTLD).MOVE" ><strong>CTLD.MOVE</strong></a>
</div>
</div>
@@ -5010,13 +5027,13 @@ 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).PilotGroups" ><strong>CTLD.PilotGroups</strong></a>
<p>self:T("CTLD with prefixes and Hercules")</p>
<p> tables</p>
</div>
@@ -7387,7 +7404,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CTLD)._GenerateFMFrequencies" ><strong>CTLD._GenerateFMFrequencies(sel, self)</strong></a></h2>
<h2><a id="#(CTLD)._GenerateFMFrequencies" ><strong>CTLD:_GenerateFMFrequencies()</strong></a></h2>
</div>
<p>(Internal) Function to generate valid FM Frequencies</p>
@@ -7398,28 +7415,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div class="w3-margin-left">
<p>CTLD</p>
</div>
<h2><strong>Parameters:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="##(CTLD)">#CTLD</a>
<strong><strong>sel</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>self</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
@@ -9419,6 +9414,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<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">
#number
<a id="#(CTLD).CargoCounter" ><strong>CTLD.CargoCounter</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -9433,7 +9439,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">
<a href="##(CTLD)">#CTLD</a>
<a href="##(CTLD.CargoZoneType)">#CTLD.CargoZoneType</a>
<a id="#(CTLD).CargoZoneType" ><strong>CTLD.CargoZoneType</strong></a>
@@ -9521,17 +9527,6 @@ 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">
#string
<a id="#(CTLD).DROP" ><strong>CTLD.DROP</strong></a>
</div>
</div>
@@ -9560,7 +9555,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).FreeFMFrequencies" ><strong>CTLD.FreeFMFrequencies</strong></a>
@@ -9571,7 +9566,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>
@@ -9587,6 +9582,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Beacons</p>
</div>
</div>
@@ -9604,7 +9602,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">
<a href="##(booolean)">#booolean</a>
#boolean
<a id="#(CTLD).HasBeenMoved" ><strong>CTLD.HasBeenMoved</strong></a>
@@ -9625,6 +9623,20 @@ 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">
#number
<a id="#(CTLD).HercMaxSpeed" ><strong>CTLD.HercMaxSpeed</strong></a>
<p> 280 kph or 150kn eq 77 mps</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -9643,18 +9655,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">
#string
<a id="#(CTLD).LOAD" ><strong>CTLD.LOAD</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="##(booolean)">#booolean</a>
#boolean
<a id="#(CTLD).LoadDirectly" ><strong>CTLD.LoadDirectly</strong></a>
@@ -9670,17 +9671,6 @@ 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">
#string
<a id="#(CTLD).MOVE" ><strong>CTLD.MOVE</strong></a>
</div>
</div>
@@ -9709,13 +9699,13 @@ 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).PilotGroups" ><strong>CTLD.PilotGroups</strong></a>
<p>self:T("CTLD with prefixes and Hercules")</p>
<p> tables</p>
</div>
@@ -11525,6 +11515,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<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">
#number
<a id="#(CTLD).CargoCounter" ><strong>CTLD.CargoCounter</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -11539,7 +11540,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">
<a href="##(CTLD)">#CTLD</a>
<a href="##(CTLD.CargoZoneType)">#CTLD.CargoZoneType</a>
<a id="#(CTLD).CargoZoneType" ><strong>CTLD.CargoZoneType</strong></a>
@@ -11627,17 +11628,6 @@ 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">
#string
<a id="#(CTLD).DROP" ><strong>CTLD.DROP</strong></a>
</div>
</div>
@@ -11666,7 +11656,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).FreeFMFrequencies" ><strong>CTLD.FreeFMFrequencies</strong></a>
@@ -11677,7 +11667,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>
@@ -11693,6 +11683,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> Beacons</p>
</div>
</div>
@@ -11710,7 +11703,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">
<a href="##(booolean)">#booolean</a>
#boolean
<a id="#(CTLD).HasBeenMoved" ><strong>CTLD.HasBeenMoved</strong></a>
@@ -11731,6 +11724,20 @@ 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">
#number
<a id="#(CTLD).HercMaxSpeed" ><strong>CTLD.HercMaxSpeed</strong></a>
<p> 280 kph or 150kn eq 77 mps</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -11749,18 +11756,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">
#string
<a id="#(CTLD).LOAD" ><strong>CTLD.LOAD</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="##(booolean)">#booolean</a>
#boolean
<a id="#(CTLD).LoadDirectly" ><strong>CTLD.LoadDirectly</strong></a>
@@ -11776,17 +11772,6 @@ 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">
#string
<a id="#(CTLD).MOVE" ><strong>CTLD.MOVE</strong></a>
</div>
</div>
@@ -11815,13 +11800,13 @@ 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).PilotGroups" ><strong>CTLD.PilotGroups</strong></a>
<p>self:T("CTLD with prefixes and Hercules")</p>
<p> tables</p>
</div>
@@ -15593,6 +15578,54 @@ BASE:TraceOnOff( false )</code></pre>
<p>Beacon info as #CTLD.ZoneBeacon</p>
</div>
</div>
<div class="functions w3-container w3-theme-l2">
<h2>Function(s)</h2>
</div>
</div>
</div>
<div onclick="myFunction('#Types##CTLD.CargoZoneType')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(CTLD.CargoZoneType)">Type <strong>CTLD.CargoZoneType</strong></a></h2></div>
<div id= "#Types##CTLD.CargoZoneType" class="w3-container w3-white w3-padding-16" id="module_other_types">
<div class="w3-white" id="record_type">
<p>Zone Type Info.</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.CargoZoneType).DROP" ><strong>CTLD.CargoZoneType.DROP</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(CTLD.CargoZoneType).LOAD" ><strong>CTLD.CargoZoneType.LOAD</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(CTLD.CargoZoneType).MOVE" ><strong>CTLD.CargoZoneType.MOVE</strong></a>
</div>
</div>