MOOSE generated documentation [skip ci]

This commit is contained in:
FlightControl-User
2021-01-26 11:44:18 +00:00
parent fb2e344dde
commit a872811a41
21 changed files with 754 additions and 631 deletions

View File

@@ -1596,7 +1596,7 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75%
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS).@">MANTIS.@</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Functional.Detection#DETECTION_AREAS} AWACS_Detection The #DETECTION_AREAS object for AWACS</p>
<h1>Functional.Detection#DETECTION_AREAS} AWACS_Detection The #DETECTION_AREAS object for AWACS</h1>
</td>
</tr>
<tr class="w3-border">
@@ -1620,7 +1620,7 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75%
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS).CheckObjectInZone">MANTIS:CheckObjectInZone(dectset, samcoordinate)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Function to check if any object is in the given SAM zone</p>
<p>(Internal) Function to check if any object is in the given SAM zone</p>
</td>
</tr>
<tr class="w3-border">
@@ -1788,7 +1788,7 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75%
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS).SetSAMStartState">MANTIS:SetSAMStartState()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Function to set the SAM start state</p>
<p>(Internal) Function to set the SAM start state</p>
</td>
</tr>
<tr class="w3-border">
@@ -1800,13 +1800,13 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75%
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS).StartAwacsDetection">MANTIS:StartAwacsDetection()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Function to start the detection via AWACS if defined as separate</p>
<p>(Internal) Function to start the detection via AWACS if defined as separate</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS).StartDetection">MANTIS:StartDetection()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Function to start the detection via EWR groups</p>
<p>(Internal) Function to start the detection via EWR groups</p>
</td>
</tr>
<tr class="w3-border">
@@ -1999,6 +1999,17 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75%
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(MANTIS).AWACS_Prefix" ><strong>MANTIS.AWACS_Prefix</strong></a>
</div>
</div>
@@ -2361,7 +2372,7 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75%
<h2><a id="#(MANTIS).CheckObjectInZone" ><strong>MANTIS:CheckObjectInZone(dectset, samcoordinate)</strong></a></h2>
</div>
<p>Function to check if any object is in the given SAM zone</p>
<p>(Internal) Function to check if any object is in the given SAM zone</p>
<div id= "#Functions##CheckObjectInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -2591,6 +2602,28 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75%
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>Start up your MANTIS with a basic setting
`myredmantis = MANTIS:New("myredmantis","Red SAM","Red EWR",nil,"red",false)`
`myredmantis:Start()`
[optional] Use
* `MANTIS:SetEWRGrouping(radius)`
* `MANTIS:SetEWRRange(radius)`
* `MANTIS:SetSAMRadius(radius)`
* `MANTIS:SetDetectInterval(interval)`
* `MANTIS:SetAutoRelocate(hq, ewr)`
before starting #MANTIS to fine-tune your setup.
If you want to use a separate AWACS unit (default detection range: 250km) to support your EWR system, use e.g. the following setup:
`mybluemantis = MANTIS:New("bluemantis","Blue SAM","Blue EWR",nil,"blue",false,"Blue Awacs")`
`mybluemantis:Start()`
</code></pre>
</div>
</div>
@@ -2981,7 +3014,7 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`</code></pre>
<h2><a id="#(MANTIS).SetSAMStartState" ><strong>MANTIS:SetSAMStartState()</strong></a></h2>
</div>
<p>Function to set the SAM start state</p>
<p>(Internal) Function to set the SAM start state</p>
<div id= "#Functions##SetSAMStartState" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -3041,7 +3074,7 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`</code></pre>
<h2><a id="#(MANTIS).StartAwacsDetection" ><strong>MANTIS:StartAwacsDetection()</strong></a></h2>
</div>
<p>Function to start the detection via AWACS if defined as separate</p>
<p>(Internal) Function to start the detection via AWACS if defined as separate</p>
<div id= "#Functions##StartAwacsDetection" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -3071,7 +3104,7 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`</code></pre>
<h2><a id="#(MANTIS).StartDetection" ><strong>MANTIS:StartDetection()</strong></a></h2>
</div>
<p>Function to start the detection via EWR groups</p>
<p>(Internal) Function to start the detection via EWR groups</p>
<div id= "#Functions##StartDetection" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">