MOOSE generated documentation [skip ci]

Documentation/Functional.Mantis.html

@@ -1429,20 +1429,39 @@ Leverage attack range setup added by DCS in 11/20.</p>
 Set up your EWR system in the mission editor. Name the groups with common prefix like "Red EWR". Can be e.g. AWACS or a combination of AWACS and Search Radars like e.g. EWR 1L13 etc.
 [optional] Set up your HQ. Can be any group, e.g. a command vehicle.</p>
 
-<p>Start up your MANTIS</p>
+<h1>1. Start up your MANTIS</h1>
 
 <p>   <code>myredmantis = MANTIS:New("myredmantis","Red SAM","Red EWR",nil,"red",false)</code></p>
 
-<p>[optional] Use <br/>
- * <code>MANTIS:SetEWRGrouping(radius)</code> <br/>
- * <code>MANTIS:SetEWRRange(radius)</code> <br/>
- * <code>MANTIS:SetSAMRadius(radius)</code> <br/>
- * <code>MANTIS:SetDetectInterval(interval)</code>
- * <code>MANTIS:SetAutoRelocate(hq, ewr)</code> <br/>
-to fine-tune your setup.</p>
+<p>[optional] Use  </p>
+
+<ul>
+    <li><code>MANTIS:SetEWRGrouping(radius)</code>  </li>
+    <li><code>MANTIS:SetEWRRange(radius)</code>  </li>
+    <li><code>MANTIS:SetSAMRadius(radius)</code>  </li>
+    <li><code>MANTIS:SetDetectInterval(interval)</code></li>
+    <li><code>MANTIS:SetAutoRelocate(hq, ewr)</code></li>
+</ul>
+
+<p>to fine-tune your setup.</p>
 
 <p>   <code>myredmantis:Start()</code></p>
 
+<h1>2. Default settings</h1>
+
+<p>By default, the following settings are active:</p>
+
+<ul>
+    <li>checkradius = 25000 (meters) - SAMs will engage enemy flights, if they are within a 25km around each SAM site - <code>MANTIS:SetSAMRadius(radius)</code></li>
+    <li>grouping = 5000 (meters) - Detection (EWR) will group enemy flights to areas of 5km for tracking - <code>MANTIS:SetEWRGrouping(radius)</code></li>
+    <li>acceptrange = 80000 (meters) - Detection (EWR) will on consider flights inside a 80km radius - <code>MANTIS:SetEWRRange(radius)</code>  </li>
+    <li>detectinterval = 30 (seconds) - MANTIS will decide every 30 seconds which SAM to activate - <code>MANTIS:SetDetectInterval(interval)</code></li>
+    <li>engagerange = 75 (percent) - SAMs will only fire if flights are inside of a 75% radius of their max firerange - <code>MANTIS:SetSAMRange(range)</code></li>
+    <li>dynamic = false - Group filtering is set to once, i.e. newly added groups will not be part of the setup by default - <code>MANTIS:New(name,samprefix,ewrprefix,hq,coaltion,dynamic)</code></li>
+    <li>autorelocate = false - HQ and (mobile) EWR system will not relocate in random intervals between 30mins and 1 hour - <code>MANTIS:SetAutoRelocate(hq, ewr)</code></li>
+    <li>debug = false - Debugging reports on screen are set to off - <code>MANTIS:Debug(onoff)</code></li>
+</ul>
+
 
 
 </div>
@@ -1613,6 +1632,12 @@ to fine-tune your setup.</p>
             <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS).SetSAMRadius">MANTIS:SetSAMRadius(radius)</a></p></td>
             <td class="summary w3-half w3-container" style="word-wrap: break-word">
 <p>Function to set switch-on/off zone for the SAM sites in meters</p>
+</td>
+          </tr>
+          <tr class="w3-border">
+            <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS).SetSAMRange">MANTIS:SetSAMRange(range)</a></p></td>
+            <td class="summary w3-half w3-container" style="word-wrap: break-word">
+<p>Function to set SAM firing engage range, 0-100 percent, e.g.</p>
 </td>
           </tr>
           <tr class="w3-border">
@@ -2426,6 +2451,42 @@ to fine-tune your setup.</p>
         </div>
 </div>
 
+</div>
+</div>
+
+        <div class="w3-card-2 w3-padding-small w3-margin-top">
+
+<div class="w3-theme-l2">
+<h2><a id="#(MANTIS).SetSAMRange" ><strong>MANTIS:SetSAMRange(range)</strong></a></h2>
+</div>
+    
+<p>Function to set SAM firing engage range, 0-100 percent, e.g.</p>
+
+    
+<p>75</p>
+
+<div id= "#Functions##SetSAMRange" 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>MANTIS</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>
+                #number
+            <strong><strong>range</strong></strong>
+            </p>
+          </div>
+          <div class="w3-half">
+              
+<p>Percent of the max fire range</p>
+
+          </div>
+        </div>
+</div>
+
 </div>
 </div>