MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2023-07-16 09:40:41 +00:00
parent 53c8617a92
commit bf5ac500fe
26 changed files with 1004 additions and 641 deletions

View File

@@ -1694,19 +1694,21 @@ This is case-sensitive, so "sa-11" is not equal to "SA-11" is not equal to "Sa-1
<p>Known SAM types at the time of writing are:</p>
<ul>
<li>Avenger</li>
<li>Chaparrel</li>
<li>Hawk</li>
<li>Linebacker</li>
<li>NASAMS</li>
<li>Patriot</li>
<li>Rapier</li>
<li>Roland</li>
<li>Silkworm (though strictly speaking this is a surface to ship missile)</li>
<li>SA-2, SA-3, SA-5, SA-6, SA-7, SA-8, SA-9, SA-10, SA-11, SA-13, SA-15, SA-19</li>
<li>From HDS (see note on HDS below): SA-2, SA-3, SA-10B, SA-10C, SA-12, SA-17, SA-20A, SA-20B, SA-23, HQ-2</li>
<li>From SMA: RBS98M, RBS70, RBS90, RBS90M, RBS103A, RBS103B, RBS103AM, RBS103BM, Lvkv9040M
<strong>NOTE</strong> If you are using the Swedish Military Assets (SMA), please note that the <strong>group name</strong> for RBS-SAM types also needs to contain the keyword "SMA"</li>
<li><p>Avenger</p></li>
<li><p>Chaparrel</p></li>
<li><p>Hawk</p></li>
<li><p>Linebacker</p></li>
<li><p>NASAMS</p></li>
<li><p>Patriot</p></li>
<li><p>Rapier</p></li>
<li><p>Roland</p></li>
<li><p>Silkworm (though strictly speaking this is a surface to ship missile)</p></li>
<li><p>SA-2, SA-3, SA-5, SA-6, SA-7, SA-8, SA-9, SA-10, SA-11, SA-13, SA-15, SA-19</p></li>
<li><p>From HDS (see note on HDS below): SA-2, SA-3, SA-10B, SA-10C, SA-12, SA-17, SA-20A, SA-20B, SA-23, HQ-2</p></li>
<li><p>From SMA: RBS98M, RBS70, RBS90, RBS90M, RBS103A, RBS103B, RBS103AM, RBS103BM, Lvkv9040M
<strong>NOTE</strong> If you are using the Swedish Military Assets (SMA), please note that the <strong>group name</strong> for RBS-SAM types also needs to contain the keyword "SMA"</p></li>
<li><p>From CH: 2S38, PantsirS1, PantsirS2, PGL-625, HQ-17A, M903PAC2, M903PAC3, TorM2, TorM2K, TorM2M, NASAMS3-AMRAAMER, NASAMS3-AIM9X2, C-RAM, PGZ-09, S350-9M100, S350-9M96D
<strong>NOTE</strong> If you are using the Military Assets by Currenthill (CH), please note that the <strong>group name</strong> for CH-SAM types also needs to contain the keyword "CHM"</p></li>
</ul>
<p>Following the example started above, an SA-6 site group name should start with "Red SAM SA-6" then, or a blue Patriot installation with e.g. "Blue SAM Patriot".
@@ -2135,6 +2137,12 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75%
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS).SamData">MANTIS.SamData</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="##(MANTIS).SamDataCH">MANTIS.SamDataCH</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -2384,7 +2392,7 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75%
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS)._GetSAMDataFromUnits">MANTIS:_GetSAMDataFromUnits(grpname, mod, sma)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS)._GetSAMDataFromUnits">MANTIS:_GetSAMDataFromUnits(grpname, mod, sma, chm)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>[Internal] Function to get SAM firing data from units types.</p>
</td>
@@ -3477,6 +3485,145 @@ 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="##(MANTIS.SamData).Type">MANTIS.SamData.Type</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<h1>MANTIS.SamType of SAM, i.e. SHORT, MEDIUM or LONG (range)</h1>
</td>
</tr>
</table>
</div>
<div class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(MANTIS.SamDataCH)">Type <strong>MANTIS.SamDataCH</strong></a></h2></div>
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
<strong><a href="##(MANTIS.SamDataCH)">MANTIS.SamDataCH</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 MANTIS.SamDataCH</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="##(MANTIS.SamDataCH).2S38 CH">MANTIS.SamDataCH.2S38 CH</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="##(MANTIS.SamDataCH).Blindspot">MANTIS.SamDataCH.Blindspot</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>no-firing range (green circle)</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS.SamDataCH).C-RAM CH">MANTIS.SamDataCH.C-RAM CH</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="##(MANTIS.SamDataCH).HQ-17A CH">MANTIS.SamDataCH.HQ-17A CH</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="##(MANTIS.SamDataCH).Height">MANTIS.SamDataCH.Height</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Max firing height in km</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS.SamDataCH).M903PAC2 CH">MANTIS.SamDataCH.M903PAC2 CH</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="##(MANTIS.SamDataCH).M903PAC3 CH">MANTIS.SamDataCH.M903PAC3 CH</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="##(MANTIS.SamDataCH).NASAMS3-AIM9X2 CH">MANTIS.SamDataCH.NASAMS3-AIM9X2 CH</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="##(MANTIS.SamDataCH).NASAMS3-AMRAAMER CH">MANTIS.SamDataCH.NASAMS3-AMRAAMER CH</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="##(MANTIS.SamDataCH).PGL-625 CH">MANTIS.SamDataCH.PGL-625 CH</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="##(MANTIS.SamDataCH).PGZ-09 CH">MANTIS.SamDataCH.PGZ-09 CH</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="##(MANTIS.SamDataCH).PantsirS1 CH">MANTIS.SamDataCH.PantsirS1 CH</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="##(MANTIS.SamDataCH).PantsirS2 CH">MANTIS.SamDataCH.PantsirS2 CH</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="##(MANTIS.SamDataCH).Radar">MANTIS.SamDataCH.Radar</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Radar typename on unit level (used as key)</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS.SamDataCH).Range">MANTIS.SamDataCH.Range</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Max firing range in km</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS.SamDataCH).S350-9M100 CH">MANTIS.SamDataCH.S350-9M100 CH</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="##(MANTIS.SamDataCH).S350-9M96D CH">MANTIS.SamDataCH.S350-9M96D CH</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="##(MANTIS.SamDataCH).TorM2 CH">MANTIS.SamDataCH.TorM2 CH</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="##(MANTIS.SamDataCH).TorM2K CH">MANTIS.SamDataCH.TorM2K CH</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="##(MANTIS.SamDataCH).TorM2M CH">MANTIS.SamDataCH.TorM2M CH</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="##(MANTIS.SamDataCH).Type">MANTIS.SamDataCH.Type</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<h1>MANTIS.SamType of SAM, i.e. SHORT, MEDIUM or LONG (range)</h1>
</td>
</tr>
</table>
@@ -3936,6 +4083,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="##(MANTIS.SamDataCH)">#MANTIS.SamDataCH</a>
<a id="#(MANTIS).SamDataCH" ><strong>MANTIS.SamDataCH</strong></a>
</div>
</div>
@@ -4374,9 +4532,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> switch alarm state RED</p>
</div>
</div>
@@ -6733,7 +6888,7 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`</code></pre>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(MANTIS)._GetSAMDataFromUnits" ><strong>MANTIS:_GetSAMDataFromUnits(grpname, mod, sma)</strong></a></h2>
<h2><a id="#(MANTIS)._GetSAMDataFromUnits" ><strong>MANTIS:_GetSAMDataFromUnits(grpname, mod, sma, chm)</strong></a></h2>
</div>
<p>[Internal] Function to get SAM firing data from units types.</p>
@@ -6782,6 +6937,19 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`</code></pre>
<p>SMA mod flag</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>chm</strong></strong>
</p>
</div>
<div class="w3-half">
<p>CH mod flag</p>
</div>
</div>
<h2><strong>Return values:</strong></h2>
@@ -8439,6 +8607,17 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`</code></pre>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="##(MANTIS.SamDataCH)">#MANTIS.SamDataCH</a>
<a id="#(MANTIS).SamDataCH" ><strong>MANTIS.SamDataCH</strong></a>
</div>
</div>
@@ -8877,9 +9056,6 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`</code></pre>
<p> switch alarm state RED</p>
</div>
</div>
@@ -12684,6 +12860,257 @@ When moose is loading dynamically (for moose class development), tracing is swit
</div>
</div>
<div class="functions w3-container w3-theme-l2">
<h2>Function(s)</h2>
</div>
</div>
</div>
<div onclick="myFunction('#Types##MANTIS.SamDataCH')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(MANTIS.SamDataCH)">Type <strong>MANTIS.SamDataCH</strong></a></h2></div>
<div id= "#Types##MANTIS.SamDataCH" class="w3-container w3-white w3-padding-16" id="module_other_types">
<div class="w3-white" id="record_type">
<p>SAM data CH</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">
#table
<a id="#(MANTIS.SamDataCH).2S38 CH" ><strong>MANTIS.SamDataCH.2S38 CH</strong></a>
<p> units from CH (Military Assets by Currenthill)
https://www.currenthill.com/
group name MUST contain CHM to ID launcher type correctly!</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(MANTIS.SamDataCH).Blindspot" ><strong>MANTIS.SamDataCH.Blindspot</strong></a>
<p>no-firing range (green circle)</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(MANTIS.SamDataCH).C-RAM CH" ><strong>MANTIS.SamDataCH.C-RAM CH</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(MANTIS.SamDataCH).HQ-17A CH" ><strong>MANTIS.SamDataCH.HQ-17A CH</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(MANTIS.SamDataCH).Height" ><strong>MANTIS.SamDataCH.Height</strong></a>
<p>Max firing height in km</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(MANTIS.SamDataCH).M903PAC2 CH" ><strong>MANTIS.SamDataCH.M903PAC2 CH</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(MANTIS.SamDataCH).M903PAC3 CH" ><strong>MANTIS.SamDataCH.M903PAC3 CH</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(MANTIS.SamDataCH).NASAMS3-AIM9X2 CH" ><strong>MANTIS.SamDataCH.NASAMS3-AIM9X2 CH</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(MANTIS.SamDataCH).NASAMS3-AMRAAMER CH" ><strong>MANTIS.SamDataCH.NASAMS3-AMRAAMER CH</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(MANTIS.SamDataCH).PGL-625 CH" ><strong>MANTIS.SamDataCH.PGL-625 CH</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(MANTIS.SamDataCH).PGZ-09 CH" ><strong>MANTIS.SamDataCH.PGZ-09 CH</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(MANTIS.SamDataCH).PantsirS1 CH" ><strong>MANTIS.SamDataCH.PantsirS1 CH</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(MANTIS.SamDataCH).PantsirS2 CH" ><strong>MANTIS.SamDataCH.PantsirS2 CH</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(MANTIS.SamDataCH).Radar" ><strong>MANTIS.SamDataCH.Radar</strong></a>
<p>Radar typename on unit level (used as key)</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(MANTIS.SamDataCH).Range" ><strong>MANTIS.SamDataCH.Range</strong></a>
<p>Max firing range in km</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(MANTIS.SamDataCH).S350-9M100 CH" ><strong>MANTIS.SamDataCH.S350-9M100 CH</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(MANTIS.SamDataCH).S350-9M96D CH" ><strong>MANTIS.SamDataCH.S350-9M96D CH</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(MANTIS.SamDataCH).TorM2 CH" ><strong>MANTIS.SamDataCH.TorM2 CH</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(MANTIS.SamDataCH).TorM2K CH" ><strong>MANTIS.SamDataCH.TorM2K CH</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(MANTIS.SamDataCH).TorM2M CH" ><strong>MANTIS.SamDataCH.TorM2M CH</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(MANTIS.SamDataCH).Type" ><strong>MANTIS.SamDataCH.Type</strong></a>
<h1>MANTIS.SamType of SAM, i.e. SHORT, MEDIUM or LONG (range)</h1>
</div>
</div>
<div class="functions w3-container w3-theme-l2">
<h2>Function(s)</h2>