MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2022-10-20 09:53:54 +00:00
parent ee788bdaf8
commit 8fe5c5ff1c
140 changed files with 1262 additions and 817 deletions

View File

@@ -912,8 +912,7 @@
<hr/>
<p><strong>MANTIS</strong> - Moose derived Modular, Automatic and Network capable Targeting and Interception System
Controls a network of SAM sites.</p>
<p><strong>MANTIS</strong> - Moose derived Modular, Automatic and Network capable Targeting and Interception System.</p>
</p></div>
</div>
</div>
@@ -1610,11 +1609,10 @@ Controls a network of short range air/missile defense groups.</p>
<hr/>
<p><strong>MANTIS</strong> - Moose derived Modular, Automatic and Network capable Targeting and Interception System
Controls a network of SAM sites.</p>
<p><strong>MANTIS</strong> - Moose derived Modular, Automatic and Network capable Targeting and Interception System.</p>
<p>Uses detection to switch on the AA site closest to the enemy. <br/>
<p>Controls a network of SAM sites. Uses detection to switch on the AA site closest to the enemy. <br/>
Automatic mode (default since 0.8) can set-up your SAM site network automatically for you. <br/>
Leverage evasiveness from SEAD, leverage attack range setting. </p>
@@ -1638,10 +1636,13 @@ Leverage evasiveness from SEAD, leverage attack range setting. </p>
<td class="style="width:60%;">
<p><em>The worst thing that can happen to a good cause is, not to be skillfully attacked, but to be ineptly defended.</em> - Frédéric Bastiat</p>
<p>Simple Class for a more intelligent Air Defense System</p>
<p>Moose class for a more intelligent Air Defense System</p>
<h1>MANTIS</h1>
<p>Moose derived Modular, Automatic and Network capable Targeting and Interception System.</p>
<ul>
<li>Moose derived Modular, Automatic and Network capable Targeting and Interception System.</li>
</ul>
</td>
</tr>
</table>
@@ -1654,10 +1655,13 @@ Leverage evasiveness from SEAD, leverage attack range setting. </p>
<p><em>The worst thing that can happen to a good cause is, not to be skillfully attacked, but to be ineptly defended.</em> - Frédéric Bastiat</p>
<p>Simple Class for a more intelligent Air Defense System</p>
<p>Moose class for a more intelligent Air Defense System</p>
<h1>MANTIS</h1>
<p>Moose derived Modular, Automatic and Network capable Targeting and Interception System.</p>
<ul>
<li>Moose derived Modular, Automatic and Network capable Targeting and Interception System.</li>
</ul>
<ul>
@@ -1700,10 +1704,12 @@ This is case-sensitive, so "sa-11" is not equal to "SA-11" is not equal to "Sa-1
<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>and from HDS (see note below): SA-2, SA-3, SA-10B, SA-10C, SA-12, SA-17, SA-20A, SA-20B, SA-23, HQ-2</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>
</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". <br/>
<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".
<strong>NOTE</strong> If you are using the High-Digit-Sam Mod, please note that the <strong>group name</strong> for the following SAM types also needs to contain the keyword "HDS":</p>
<ul>
@@ -1997,12 +2003,6 @@ 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).GetCommandCenter">MANTIS:GetCommandCenter()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Function to get the HQ object for further use</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS).Groupset">MANTIS.Groupset</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -2135,6 +2135,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).SamDataHDS">MANTIS.SamDataHDS</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).SamDataSMA">MANTIS.SamDataSMA</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -2372,7 +2378,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)</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)</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>
@@ -3556,6 +3562,109 @@ 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.SamDataHDS).Type">MANTIS.SamDataHDS.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.SamDataSMA)">Type <strong>MANTIS.SamDataSMA</strong></a></h2></div>
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
<strong><a href="##(MANTIS.SamDataSMA)">MANTIS.SamDataSMA</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.SamDataSMA</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.SamDataSMA).Blindspot">MANTIS.SamDataSMA.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.SamDataSMA).Height">MANTIS.SamDataSMA.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.SamDataSMA).Lvkv9040M SMA">MANTIS.SamDataSMA.Lvkv9040M SMA</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.SamDataSMA).RBS103A SMA">MANTIS.SamDataSMA.RBS103A SMA</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.SamDataSMA).RBS103AM SMA">MANTIS.SamDataSMA.RBS103AM SMA</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.SamDataSMA).RBS103B SMA">MANTIS.SamDataSMA.RBS103B SMA</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.SamDataSMA).RBS103BM SMA">MANTIS.SamDataSMA.RBS103BM SMA</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.SamDataSMA).RBS70 SMA">MANTIS.SamDataSMA.RBS70 SMA</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.SamDataSMA).RBS70M SMA">MANTIS.SamDataSMA.RBS70M SMA</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.SamDataSMA).RBS90 SMA">MANTIS.SamDataSMA.RBS90 SMA</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.SamDataSMA).RBS90M SMA">MANTIS.SamDataSMA.RBS90M SMA</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.SamDataSMA).RBS98M SMA">MANTIS.SamDataSMA.RBS98M SMA</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.SamDataSMA).Radar">MANTIS.SamDataSMA.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.SamDataSMA).Range">MANTIS.SamDataSMA.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.SamDataSMA).Type">MANTIS.SamDataSMA.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>
@@ -3727,17 +3836,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>Prefix to build the #SET_GROUP for EWR group</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(MANTIS).Groupset" ><strong>MANTIS.Groupset</strong></a>
</div>
</div>
@@ -3799,7 +3897,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="#(MANTIS).SAM_Table_Long" ><strong>MANTIS.SAM_Table_Long</strong></a>
@@ -3810,7 +3908,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="#(MANTIS).SAM_Table_Medium" ><strong>MANTIS.SAM_Table_Medium</strong></a>
@@ -3821,7 +3919,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="#(MANTIS).SAM_Table_Short" ><strong>MANTIS.SAM_Table_Short</strong></a>
@@ -3859,6 +3957,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.SamDataSMA)">#MANTIS.SamDataSMA</a>
<a id="#(MANTIS).SamDataSMA" ><strong>MANTIS.SamDataSMA</strong></a>
</div>
</div>
@@ -4173,6 +4282,50 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>Prefix for logging</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(MANTIS).maxclassic" ><strong>MANTIS.maxclassic</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(MANTIS).maxlongrange" ><strong>MANTIS.maxlongrange</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(MANTIS).maxmidrange" ><strong>MANTIS.maxmidrange</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(MANTIS).maxshortrange" ><strong>MANTIS.maxshortrange</strong></a>
</div>
</div>
@@ -4231,9 +4384,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> switch alarm state RED</p>
</div>
</div>
@@ -6593,7 +6743,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)</strong></a></h2>
<h2><a id="#(MANTIS)._GetSAMDataFromUnits" ><strong>MANTIS:_GetSAMDataFromUnits(grpname, mod, sma)</strong></a></h2>
</div>
<p>[Internal] Function to get SAM firing data from units types.</p>
@@ -6629,6 +6779,19 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`</code></pre>
<p>HDS 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>sma</strong></strong>
</p>
</div>
<div class="w3-half">
<p>SMA mod flag</p>
</div>
</div>
<h2><strong>Return values:</strong></h2>
@@ -8198,17 +8361,6 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`</code></pre>
<p>Prefix to build the #SET_GROUP for EWR group</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(MANTIS).Groupset" ><strong>MANTIS.Groupset</strong></a>
</div>
</div>
@@ -8270,7 +8422,7 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`</code></pre>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(MANTIS).SAM_Table_Long" ><strong>MANTIS.SAM_Table_Long</strong></a>
@@ -8281,7 +8433,7 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`</code></pre>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(MANTIS).SAM_Table_Medium" ><strong>MANTIS.SAM_Table_Medium</strong></a>
@@ -8292,7 +8444,7 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`</code></pre>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(MANTIS).SAM_Table_Short" ><strong>MANTIS.SAM_Table_Short</strong></a>
@@ -8330,6 +8482,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.SamDataSMA)">#MANTIS.SamDataSMA</a>
<a id="#(MANTIS).SamDataSMA" ><strong>MANTIS.SamDataSMA</strong></a>
</div>
</div>
@@ -8644,6 +8807,50 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`</code></pre>
<p>Prefix for logging</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(MANTIS).maxclassic" ><strong>MANTIS.maxclassic</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(MANTIS).maxlongrange" ><strong>MANTIS.maxlongrange</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(MANTIS).maxmidrange" ><strong>MANTIS.maxmidrange</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(MANTIS).maxshortrange" ><strong>MANTIS.maxshortrange</strong></a>
</div>
</div>
@@ -8702,9 +8909,6 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`</code></pre>
<p> switch alarm state RED</p>
</div>
</div>
@@ -12674,6 +12878,191 @@ 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.SamDataSMA')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(MANTIS.SamDataSMA)">Type <strong>MANTIS.SamDataSMA</strong></a></h2></div>
<div id= "#Types##MANTIS.SamDataSMA" class="w3-container w3-white w3-padding-16" id="module_other_types">
<div class="w3-white" id="record_type">
<p>SAM data SMA</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">
#number
<a id="#(MANTIS.SamDataSMA).Blindspot" ><strong>MANTIS.SamDataSMA.Blindspot</strong></a>
<p>no-firing range (green circle)</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(MANTIS.SamDataSMA).Height" ><strong>MANTIS.SamDataSMA.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.SamDataSMA).Lvkv9040M SMA" ><strong>MANTIS.SamDataSMA.Lvkv9040M SMA</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(MANTIS.SamDataSMA).RBS103A SMA" ><strong>MANTIS.SamDataSMA.RBS103A SMA</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(MANTIS.SamDataSMA).RBS103AM SMA" ><strong>MANTIS.SamDataSMA.RBS103AM SMA</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(MANTIS.SamDataSMA).RBS103B SMA" ><strong>MANTIS.SamDataSMA.RBS103B SMA</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(MANTIS.SamDataSMA).RBS103BM SMA" ><strong>MANTIS.SamDataSMA.RBS103BM SMA</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(MANTIS.SamDataSMA).RBS70 SMA" ><strong>MANTIS.SamDataSMA.RBS70 SMA</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(MANTIS.SamDataSMA).RBS70M SMA" ><strong>MANTIS.SamDataSMA.RBS70M SMA</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(MANTIS.SamDataSMA).RBS90 SMA" ><strong>MANTIS.SamDataSMA.RBS90 SMA</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(MANTIS.SamDataSMA).RBS90M SMA" ><strong>MANTIS.SamDataSMA.RBS90M SMA</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(MANTIS.SamDataSMA).RBS98M SMA" ><strong>MANTIS.SamDataSMA.RBS98M SMA</strong></a>
<p> units from SMA Mod (Sweedish Military Assets)
https://forum.dcs.world/topic/295202-swedish-military-assets-for-dcs-by-currenthill/
group name MUST contain SMA to ID launcher type correctly!</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(MANTIS.SamDataSMA).Radar" ><strong>MANTIS.SamDataSMA.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.SamDataSMA).Range" ><strong>MANTIS.SamDataSMA.Range</strong></a>
<p>Max firing range in km</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(MANTIS.SamDataSMA).Type" ><strong>MANTIS.SamDataSMA.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>