MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2021-12-28 10:09:15 +00:00
parent 823c49c6a2
commit d99593df6b
53 changed files with 1174 additions and 1245 deletions

View File

@@ -1500,7 +1500,7 @@ Controls a network of short range air/missile defense groups.</p>
<ul>
<li>Patrol AI airplanes within a given zone.</li>
<li>Trigger detected events when enemy airplanes are detected.</li>
<li>Manage a fuel treshold to RTB on time.</li>
<li>Manage a fuel threshold to RTB on time.</li>
</ul>
<hr/>
@@ -1580,8 +1580,8 @@ use derived AI_ classes to model AI offensive or defensive behaviour.</p>
<p><img src="..\Presentations\AI_PATROL\Dia10.JPG" alt="Process"/></p>
<p>Until a fuel or damage treshold has been reached by the AI, or when the AI is commanded to RTB.
When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.</p>
<p>Until a fuel or damage threshold has been reached by the AI, or when the AI is commanded to RTB.
When the fuel threshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.</p>
<p><img src="..\Presentations\AI_PATROL\Dia11.JPG" alt="Process"/></p>
@@ -1614,7 +1614,7 @@ When the fuel treshold has been reached, the airplane will fly towards the neare
<li><strong>RTB</strong> ( Group ): Route the AI to the home base.</li>
<li><strong>Detect</strong> ( Group ): The AI is detecting targets.</li>
<li><strong>Detected</strong> ( Group ): The AI has detected new targets.</li>
<li><strong>Status</strong> ( Group ): The AI is checking status (fuel and damage). When the tresholds have been reached, the AI will RTB.</li>
<li><strong>Status</strong> ( Group ): The AI is checking status (fuel and damage). When the thresholds have been reached, the AI will RTB.</li>
</ul>
<h2>3. Set or Get the AI controllable</h2>
@@ -1653,8 +1653,8 @@ according the weather conditions.</p>
<h2>6. Manage the "out of fuel" in the AI_PATROL_ZONE</h2>
<p>When the AI is out of fuel, it is required that a new AI is started, before the old AI can return to the home base.
Therefore, with a parameter and a calculation of the distance to the home base, the fuel treshold is calculated.
When the fuel treshold is reached, the AI will continue for a given time its patrol task in orbit,
Therefore, with a parameter and a calculation of the distance to the home base, the fuel threshold is calculated.
When the fuel threshold is reached, the AI will continue for a given time its patrol task in orbit,
while a new AI is targetted to the AI_PATROL_ZONE.
Once the time is finished, the old AI will return to the base.
Use the method <a href="##(AI_PATROL_ZONE).ManageFuel">AI_PATROL_ZONE.ManageFuel</a>() to have this proces in place.</p>
@@ -1662,7 +1662,7 @@ Use the method <a href="##(AI_PATROL_ZONE).ManageFuel">AI_PATROL_ZONE.ManageFuel
<h2>7. Manage "damage" behaviour of the AI in the AI_PATROL_ZONE</h2>
<p>When the AI is damaged, it is required that a new AIControllable is started. However, damage cannon be foreseen early on.
Therefore, when the damage treshold is reached, the AI will return immediately to the home base (RTB).
Therefore, when the damage threshold is reached, the AI will return immediately to the home base (RTB).
Use the method <a href="##(AI_PATROL_ZONE).ManageDamage">AI_PATROL_ZONE.ManageDamage</a>() to have this proces in place.</p>
<hr/>
@@ -1760,7 +1760,7 @@ Use the method <a href="##(AI_PATROL_ZONE).ManageDamage">AI_PATROL_ZONE.ManageDa
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_PATROL_ZONE).ManageDamage">AI_PATROL_ZONE:ManageDamage(PatrolDamageThreshold)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>When the AI is damaged beyond a certain treshold, it is required that the AI returns to the home base.</p>
<p>When the AI is damaged beyond a certain threshold, it is required that the AI returns to the home base.</p>
</td>
</tr>
<tr class="w3-border">
@@ -3136,9 +3136,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> This table contains the targets detected during patrol.</p>
</div>
</div>
@@ -3341,14 +3338,14 @@ It is up to the mission designer to use the <a href="Wrapper.Unit.html">Wrapper.
<h2><a id="#(AI_PATROL_ZONE).ManageDamage" ><strong>AI_PATROL_ZONE:ManageDamage(PatrolDamageThreshold)</strong></a></h2>
</div>
<p>When the AI is damaged beyond a certain treshold, it is required that the AI returns to the home base.</p>
<p>When the AI is damaged beyond a certain threshold, it is required that the AI returns to the home base.</p>
<p>However, damage cannot be foreseen early on.
Therefore, when the damage treshold is reached,
Therefore, when the damage threshold is reached,
the AI will return immediately to the home base (RTB).
Note that for groups, the average damage of the complete group will be calculated.
So, in a group of 4 airplanes, 2 lost and 2 with damage 0.2, the damage treshold will be 0.25.</p>
So, in a group of 4 airplanes, 2 lost and 2 with damage 0.2, the damage threshold will be 0.25.</p>
<div id= "#Functions##ManageDamage" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -3366,7 +3363,7 @@ So, in a group of 4 airplanes, 2 lost and 2 with damage 0.2, the damage treshold
</div>
<div class="w3-half">
<p>The treshold in percentage (between 0 and 1) when the AI is considered to be damaged.</p>
<p>The threshold in percentage (between 0 and 1) when the AI is considered to be damaged.</p>
</div>
</div>
@@ -3395,8 +3392,8 @@ So, in a group of 4 airplanes, 2 lost and 2 with damage 0.2, the damage treshold
<p>When the AI is out of fuel, it is required that a new AI is started, before the old AI can return to the home base.</p>
<p>Therefore, with a parameter and a calculation of the distance to the home base, the fuel treshold is calculated.
When the fuel treshold is reached, the AI will continue for a given time its patrol task in orbit, while a new AIControllable is targetted to the AI_PATROL_ZONE.
<p>Therefore, with a parameter and a calculation of the distance to the home base, the fuel threshold is calculated.
When the fuel threshold is reached, the AI will continue for a given time its patrol task in orbit, while a new AIControllable is targetted to the AI_PATROL_ZONE.
Once the time is finished, the old AI will return to the base.</p>
<div id= "#Functions##ManageFuel" class="w3-show w3-white">
@@ -3415,7 +3412,7 @@ Once the time is finished, the old AI will return to the base.</p>
</div>
<div class="w3-half">
<p>The treshold in percentage (between 0 and 1) when the AIControllable is considered to get out of fuel.</p>
<p>The threshold in percentage (between 0 and 1) when the AIControllable is considered to get out of fuel.</p>
</div>
</div>
@@ -6386,9 +6383,6 @@ Note that this method is required, as triggers the next route when patrolling fo
<p> This table contains the targets detected during patrol.</p>
</div>
</div>
@@ -7133,9 +7127,6 @@ Note that this method is required, as triggers the next route when patrolling fo
<p> This table contains the targets detected during patrol.</p>
</div>
</div>
@@ -8772,9 +8763,6 @@ Note that this method is required, as triggers the next route when patrolling fo
<p> This table contains the targets detected during patrol.</p>
</div>
</div>