MOOSE generated documentation [skip ci]

This commit is contained in:
FlightControl-User
2021-02-16 17:44:46 +00:00
parent 9e0ef9f94e
commit 0b782b21db
124 changed files with 8883 additions and 554 deletions

View File

@@ -942,6 +942,22 @@ Controls a network of SAM sites.</p>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Functional</strong> -- Make SAM sites execute evasive and defensive behaviour when being fired upon.</p>
</p></div>
</div>
</div>
<div class="w3-col s12 m6 l4">
<div class="w3-card-4 w3-white w3-margin-16">
<div class="w3-display-container w3-text-white w3-text-shadow">
<img src= "../Images/Functional.Mantis.jpg" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Shorad.html">Functional.Shorad</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Functional</strong> -- Short Range Air Defense System</p>
<hr/>
<p><strong>SHORAD</strong> - Short Range Air Defense System
Controls a network of short range AAA groups.</p>
</p></div>
</div>
</div>
@@ -1418,7 +1434,7 @@ Controls a network of SAM sites.</p>
<h3>Authors: <strong>FlightControl</strong>, <strong>applevangelist</strong></h3>
<p>Last Update: Dec 2020</p>
<p>Last Update: Feb 2021</p>
<hr/>
@@ -1477,7 +1493,13 @@ Controls a network of SAM sites.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SEAD).New">SEAD.New(table, self, SEADGroupPrefixes)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SEAD).Harms">SEAD.Harms</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="##(SEAD).New">SEAD:New(table, SEADGroupPrefixes)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creates the main object which is handling defensive actions for SA sites or moving SA vehicles.</p>
</td>
@@ -1485,7 +1507,7 @@ Controls a network of SAM sites.</p>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SEAD).OnEventShot">SEAD.OnEventShot(EventData, self)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Detects if an SA site was shot with an anti radiation missile.</p>
<p>Detects if an SAM site was shot with an anti radiation missile.</p>
</td>
</tr>
<tr class="w3-border">
@@ -1498,6 +1520,12 @@ Controls a network of SAM sites.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SEAD).UpdateSet">SEAD:UpdateSet(SEADGroupPrefixes)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Update the active SEAD Set</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SEAD)._CheckHarms">SEAD:_CheckHarms(WeaponName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Check if a known HARM was fired</p>
</td>
</tr>
</table>
@@ -2022,6 +2050,22 @@ 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">
#table
<a id="#(SEAD).Harms" ><strong>SEAD.Harms</strong></a>
<p> TODO Complete list?
- Missile enumerators
@field Harms</p>
</div>
</div>
@@ -2031,7 +2075,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SEAD).New" ><strong>SEAD.New(table, self, SEADGroupPrefixes)</strong></a></h2>
<h2><a id="#(SEAD).New" ><strong>SEAD:New(table, SEADGroupPrefixes)</strong></a></h2>
</div>
<p>Creates the main object which is handling defensive actions for SA sites or moving SA vehicles.</p>
@@ -2059,16 +2103,6 @@ Chances are big that the missile will miss.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>self</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
@@ -2105,7 +2139,7 @@ SEAD_RU_SAM_Defenses = SEAD:New( { 'RU SA-6 Kub', 'RU SA-6 Defenses', 'RU MI-26
<h2><a id="#(SEAD).OnEventShot" ><strong>SEAD.OnEventShot(EventData, self)</strong></a></h2>
</div>
<p>Detects if an SA site was shot with an anti radiation missile.</p>
<p>Detects if an SAM site was shot with an anti radiation missile.</p>
<p>In this case, take evasive actions based on the skill level set within the ME.</p>
@@ -2230,6 +2264,48 @@ SEAD_RU_SAM_Defenses = SEAD:New( { 'RU SA-6 Kub', 'RU SA-6 Defenses', 'RU MI-26
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SEAD)._CheckHarms" ><strong>SEAD:_CheckHarms(WeaponName)</strong></a></h2>
</div>
<p>Check if a known HARM was fired</p>
<div id= "#Functions##_CheckHarms" 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>SEAD</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>
#string
<strong><strong>WeaponName</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#boolean:</p>
</div>
<div class="w3-half">
<p>Returns true for a match</p>
</div>
</div>
</div>
</div>
</div>
@@ -2244,6 +2320,22 @@ SEAD_RU_SAM_Defenses = SEAD:New( { 'RU SA-6 Kub', 'RU SA-6 Defenses', 'RU MI-26
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(SEAD).Harms" ><strong>SEAD.Harms</strong></a>
<p> TODO Complete list?
- Missile enumerators
@field Harms</p>
</div>
</div>