MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2021-06-12 20:26:25 +00:00
parent 806818f25b
commit f1e4ab289c
129 changed files with 36468 additions and 9927 deletions

View File

@@ -494,6 +494,17 @@
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Core</strong> - The base class within the framework.</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/Core_Radio.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Beacon.html">Core.Beacon</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Core</strong> - TACAN and other beacons.</p>
</p></div>
</div>
</div>
@@ -571,39 +582,6 @@
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Core</strong> - Defines an extensive API to manage 3D points in the DCS World 3D simulation space.</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/Core_Radio.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Radio.html">Core.Radio</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Core</strong> - Is responsible for everything that is related to radio transmission and you can hear in DCS, be it TACAN beacons, Radio transmissions.</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/Core_Radio.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.RadioQueue.html">Core.RadioQueue</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Core</strong> - Queues Radio Transmissions.</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/Core_Radio.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.RadioSpeech.html">Core.RadioSpeech</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Core</strong> - Makes the radio talk.</p>
</p></div>
</div>
</div>
@@ -714,17 +692,6 @@
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Core</strong> - Manage user flags to interact with the mission editor trigger system and server side scripts.</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/Core_Usersound.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.UserSound.html">Core.UserSound</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Core</strong> - Manage user sound.</p>
</p></div>
</div>
</div>
@@ -1068,6 +1035,72 @@ Controls a network of short range air/missile defense groups.</p>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Ops</strong> - Rescue helicopter for carrier operations.</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/Sound_MSRS.png" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Sound.MSRS.html">Sound.MSRS</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Sound</strong> - Simple Radio Standalone (SRS) Integration.</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/Core_Radio.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Sound.Radio.html">Sound.Radio</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Sound</strong> - Radio transmissions.</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/Core_Radio.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Sound.RadioQueue.html">Sound.RadioQueue</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Sound</strong> - Queues Radio Transmissions.</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/Core_Radio.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Sound.RadioSpeech.html">Sound.RadioSpeech</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Core</strong> - Makes the radio talk.</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/Sound_SoundOutput.png" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Sound.SoundOutput.html">Sound.SoundOutput</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Sound</strong> - Sound output classes.</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/Core_Usersound.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Sound.UserSound.html">Sound.UserSound</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Sound</strong> - Manage user sound.</p>
</p></div>
</div>
</div>
@@ -1280,6 +1313,17 @@ Controls a network of short range air/missile defense groups.</p>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p>This module contains derived utilities taken from the MIST framework, which are excellent tools to be reused in an OO environment.</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/MOOSE.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Utils.STTS.html">Utils.STTS</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Utilities</strong> DCS Simple Text-To-Speech (STTS).</p>
</p></div>
</div>
</div>
@@ -1710,6 +1754,12 @@ Controls a network of short range air/missile defense groups.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DCSMAP).Caucasus">DCSMAP.Caucasus</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Caucasus map.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DCSMAP).MarianaIslands">DCSMAP.MarianaIslands</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Mariana Islands map.</p>
</td>
</tr>
<tr class="w3-border">
@@ -1844,7 +1894,7 @@ Controls a network of short range air/missile defense groups.</p>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).BeaufortScale">UTILS.BeaufortScale(speed)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Beaufort scale: returns Beaufort number and wind description as a function of wind speed in m/s.</p>
</td>
</tr>
<tr class="w3-border">
@@ -1905,6 +1955,12 @@ Controls a network of short range air/missile defense groups.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).GetCallsignName">UTILS.GetCallsignName(Callsign)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the callsign name from its enumerator value</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).GetCharacters">UTILS.GetCharacters(str)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get a table of all characters in a string.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2513,6 +2569,17 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(DCSMAP).MarianaIslands" ><strong>DCSMAP.MarianaIslands</strong></a>
<p>Mariana Islands map.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -2661,10 +2728,7 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
<h2><a id="#(UTILS).BeaufortScale" ><strong>UTILS.BeaufortScale(speed)</strong></a></h2>
</div>
<p> Beaufort scale: returns Beaufort number and wind description as a function of wind speed in m/s.</p>
<p>Beaufort scale: returns Beaufort number and wind description as a function of wind speed in m/s.</p>
<div id= "#Functions##BeaufortScale" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -2676,13 +2740,35 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>speed</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
<p>Wind speed in m/s.</p>
</div>
</div>
<h2><strong>Return values:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#number:</p>
</div>
<div class="w3-half">
<p>Beaufort number.</p>
</div>
<div class="w3-half">
<p>#string:</p>
</div>
<div class="w3-half">
<p>Beauford wind description.</p>
</div>
</div>
</div>
</div>
@@ -3084,6 +3170,50 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(UTILS).GetCharacters" ><strong>UTILS.GetCharacters(str)</strong></a></h2>
</div>
<p>Get a table of all characters in a string.</p>
<div id= "#Functions##GetCharacters" 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>UTILS</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>str</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Sting.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#table:</p>
</div>
<div class="w3-half">
<p>Individual characters.</p>
</div>
</div>
</div>
</div>
</div>
@@ -3364,6 +3494,9 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
<li>NTTR +12 (East), year ~ 2011</li>
<li>Normandy -10 (West), year ~ 1944</li>
<li>Persian Gulf +2 (East), year ~ 2011</li>
<li>The Cannel Map -10 (West)</li>
<li>Syria +5 (East)</li>
<li>Mariana Islands +2 (East)</li>
</ul>
<div id= "#Functions##GetMagneticDeclination" class="w3-show w3-white">