MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2021-12-20 12:06:00 +00:00
parent 1e732ea232
commit be8c95fcfd
69 changed files with 2023 additions and 1676 deletions

View File

@@ -1533,7 +1533,7 @@ Controls a network of short range air/missile defense groups.</p>
<tr>
<td class="style="width:40%;"><p><h2>Global <strong>SETTINGS</strong></h2></p></td>
<td class="style="width:60%;">
<p>Takes care of various settings that influence the behaviour of certain functionalities and classes within the MOOSE framework.</p>
<p>Takes care of various settings that influence the behavior of certain functionalities and classes within the MOOSE framework.</p>
</td>
</tr>
</table>
@@ -1544,13 +1544,13 @@ Controls a network of short range air/missile defense groups.</p>
<a href="##(SETTINGS)">#SETTINGS</a>
<a id="SETTINGS" ><strong>SETTINGS</strong></a>
<p>Takes care of various settings that influence the behaviour of certain functionalities and classes within the MOOSE framework.</p>
<p>Takes care of various settings that influence the behavior of certain functionalities and classes within the MOOSE framework.</p>
<hr/>
<p>The SETTINGS class takes care of various settings that influence the behaviour of certain functionalities and classes within the MOOSE framework.
<p>The SETTINGS class takes care of various settings that influence the behavior of certain functionalities and classes within the MOOSE framework.
SETTINGS can work on 2 levels:</p>
<ul>
@@ -1574,7 +1574,7 @@ These menus can be found <strong>on level F10 under "Settings"</strong>. There a
<p>A menu is created automatically per Command Center that allows to modify the <strong>Default</strong> settings.
So, when joining a CC unit, a menu will be available that allows to change the settings parameters <strong>FOR ALL THE PLAYERS</strong>!
Note that the <strong>Default settings</strong> will only be used when a player has not choosen its own settings.</p>
Note that the <strong>Default settings</strong> will only be used when a player has not chosen its own settings.</p>
<h2>2.2) Player settings menu</h2>
@@ -1584,7 +1584,7 @@ Note that when a player has not chosen a specific setting, the <strong>Default s
<h2>2.3) Show or Hide the Player Setting menus</h2>
<p>Of course, it may be requried not to show any setting menus. In this case, a method is available on the <strong>_SETTINGS object</strong>.
<p>Of course, it may be required not to show any setting menus. In this case, a method is available on the <strong>_SETTINGS object</strong>.
Use <a href="##(SETTINGS).SetPlayerMenuOff">SETTINGS.SetPlayerMenuOff</a>() to hide the player menus, and use <a href="##(SETTINGS).SetPlayerMenuOn">SETTINGS.SetPlayerMenuOn</a>() show the player menus.
Note that when this method is used, any player already in a slot will not have its menus visibility changed.
The option will only have effect when a player enters a new slot or changes a slot.</p>
@@ -1611,8 +1611,8 @@ See below a comprehensive description of each.</p>
<ul>
<li>A2G BR: <a href="https://en.wikipedia.org/wiki/Bearing_(navigation">Bearing Range</a>.</li>
<li>A2G MGRS: The <a href="https://en.wikipedia.org/wiki/Military_Grid_Reference_System">Military Grid Reference System</a>. The accuracy can also be adapted.</li>
<li>A2G LL DMS: Lattitude Longitude <a href="https://en.wikipedia.org/wiki/Geographic_coordinate_conversion">Degrees Minutes Seconds</a>. The accuracy can also be adapted.</li>
<li>A2G LL DDM: Lattitude Longitude <a href="https://en.wikipedia.org/wiki/Decimal_degrees">Decimal Degrees Minutes</a>. The accuracy can also be adapted.</li>
<li>A2G LL DMS: Latitude Longitude <a href="https://en.wikipedia.org/wiki/Geographic_coordinate_conversion">Degrees Minutes Seconds</a>. The accuracy can also be adapted.</li>
<li>A2G LL DDM: Latitude Longitude <a href="https://en.wikipedia.org/wiki/Decimal_degrees">Decimal Degrees Minutes</a>. The accuracy can also be adapted.</li>
</ul>
<h3>3.1.2) A2G coordinates setting <strong>menu</strong></h3>
@@ -1713,7 +1713,7 @@ but there isn't any player context (no player unit to reference from), the MGRS
<p>The settings can be changed by using the <strong>Default settings menu</strong> on the Command Center or the <strong>Player settings menu</strong> on the Player Slot.</p>
<p>Each Message Type has specific timings that will be applied when the message is displayed.
The Settings Menu will provide for each Message Type a selection of proposed durations from which can be choosen.
The Settings Menu will provide for each Message Type a selection of proposed durations from which can be chosen.
So the player can choose its own amount of seconds how long a message should be displayed of a certain type.
Note that <strong>Update</strong> messages can be chosen not to be displayed at all!</p>
@@ -1728,7 +1728,7 @@ Note that <strong>Update</strong> messages can be chosen not to be displayed at
<h2>3.5) <strong>Era</strong> of the battle</h2>
<p>The threat level metric is scaled according the era of the battle. A target that is AAA, will pose a much greather threat in WWII than on modern warfare.
<p>The threat level metric is scaled according the era of the battle. A target that is AAA, will pose a much greater threat in WWII than on modern warfare.
Therefore, there are 4 era that are defined within the settings:</p>
<ul>
@@ -2714,7 +2714,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(SETTINGS).A2ASystem" ><strong>SETTINGS.A2ASystem</strong></a>
@@ -2769,7 +2769,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(SETTINGS).Metric" ><strong>SETTINGS.Metric</strong></a>
@@ -4808,7 +4808,7 @@ It is advised to use this method at the start of the mission.</p>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#string
<a id="#(SETTINGS).A2ASystem" ><strong>SETTINGS.A2ASystem</strong></a>
@@ -4863,7 +4863,7 @@ It is advised to use this method at the start of the mission.</p>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(SETTINGS).Metric" ><strong>SETTINGS.Metric</strong></a>