MOOSE generated documentation [skip ci]

This commit is contained in:
FlightControl-User
2021-02-16 15:42:06 +00:00
parent 0c459b2220
commit 7f9658bdf0
21 changed files with 692 additions and 610 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">
<h1>Functional.Detection#DETECTION_AREAS} AWACS_Detection The #DETECTION_AREAS object for AWACS</h1>
<h1>Functional.Shorad#SHORAD} Shorad SHORAD Object, if available</h1>
</td>
</tr>
<tr class="w3-border">
@@ -1609,6 +1609,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).AWACS_Prefix">MANTIS.AWACS_Prefix</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).AddShorad">MANTIS:AddShorad(Shorad, Shoradtime)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Function to link up #MANTIS with a #SHORAD installation</p>
</td>
</tr>
<tr class="w3-border">
@@ -1656,7 +1662,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).EWR_Templates_Prefix">MANTIS.EWR_Templates_Prefix</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Prefix to build the #GROUP_SET for EWR group</p>
<p>Prefix to build the #SET_GROUP for EWR group</p>
</td>
</tr>
<tr class="w3-border">
@@ -1705,6 +1711,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).New">MANTIS:New(name, samprefix, ewrprefix, hq, coaltion, dynamic, awacs)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p> Function to instantiate a new object of class MANTIS</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS).RemoveShorad">MANTIS:RemoveShorad()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Function to unlink #MANTIS from a #SHORAD installation</p>
</td>
</tr>
<tr class="w3-border">
@@ -1722,7 +1734,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).SAM_Templates_Prefix">MANTIS.SAM_Templates_Prefix</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Prefix to build the #GROUP_SET for SAM sites</p>
<p>Prefix to build the #SET_GROUP for SAM sites</p>
</td>
</tr>
<tr class="w3-border">
@@ -1789,6 +1801,24 @@ 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).SetSAMStartState">MANTIS:SetSAMStartState()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(Internal) Function to set the SAM start state</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS).Shorad">MANTIS.Shorad</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).ShoradLink">MANTIS.ShoradLink</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>If true, #MANTIS has #SHORAD enabled</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MANTIS).ShoradTime">MANTIS.ShoradTime</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Timer in seconds, how long #SHORAD will be active after a detection inside of the defense range</p>
</td>
</tr>
<tr class="w3-border">
@@ -1999,6 +2029,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).Adv_EWR_Group" ><strong>MANTIS.Adv_EWR_Group</strong></a>
</div>
</div>
@@ -2044,7 +2085,7 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75%
#string
<a id="#(MANTIS).EWR_Templates_Prefix" ><strong>MANTIS.EWR_Templates_Prefix</strong></a>
<p>Prefix to build the #GROUP_SET for EWR group</p>
<p>Prefix to build the #SET_GROUP for EWR group</p>
</div>
@@ -2146,7 +2187,29 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75%
#string
<a id="#(MANTIS).SAM_Templates_Prefix" ><strong>MANTIS.SAM_Templates_Prefix</strong></a>
<p>Prefix to build the #GROUP_SET for SAM sites</p>
<p>Prefix to build the #SET_GROUP for SAM sites</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(MANTIS).ShoradLink" ><strong>MANTIS.ShoradLink</strong></a>
<p>If true, #MANTIS has #SHORAD enabled</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(MANTIS).ShoradTime" ><strong>MANTIS.ShoradTime</strong></a>
<p>Timer in seconds, how long #SHORAD will be active after a detection inside of the defense range</p>
</div>
@@ -2357,6 +2420,52 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75%
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(MANTIS).AddShorad" ><strong>MANTIS:AddShorad(Shorad, Shoradtime)</strong></a></h2>
</div>
<p>Function to link up #MANTIS with a #SHORAD installation</p>
<div id= "#Functions##AddShorad" 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>Parameters:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Functional.Shorad.html##(SHORAD)">Functional.Shorad#SHORAD</a>
<strong><strong>Shorad</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The #SHORAD object</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Shoradtime</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Number of seconds #SHORAD stays active post wake-up</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(MANTIS).CheckObjectInZone" ><strong>MANTIS:CheckObjectInZone(dectset, samcoordinate)</strong></a></h2>
</div>
@@ -2615,6 +2724,25 @@ 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">
<div class="w3-theme-l2">
<h2><a id="#(MANTIS).RemoveShorad" ><strong>MANTIS:RemoveShorad()</strong></a></h2>
</div>
<p>Function to unlink #MANTIS from a #SHORAD installation</p>
<div id= "#Functions##RemoveShorad" 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>
</div>
</div>
</div>