MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2022-10-23 14:53:42 +00:00
parent ffeb91ddff
commit f3e47adf8e
57 changed files with 1187 additions and 967 deletions

View File

@@ -1769,15 +1769,15 @@ according the weather conditions.</p>
<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 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.
while a new AI is targeted 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>
Use the method <a href="##(AI_PATROL_ZONE).ManageFuel">AI_PATROL_ZONE.ManageFuel</a>() to have this process in place.</p>
<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 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>
Use the method <a href="##(AI_PATROL_ZONE).ManageDamage">AI_PATROL_ZONE.ManageDamage</a>() to have this process in place.</p>
<hr/>
@@ -2240,13 +2240,13 @@ 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).onafterRoute">AI_PATROL_ZONE:onafterRoute(Controllable, From, Event, To)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Defines a new patrol route using the <a href="Process_PatrolZone.html">Process_PatrolZone</a> parameters and settings.</p>
<p>Defines a new patrol route using the <a href="##(AI_PATROL_ZONE)">#AI_PATROL_ZONE</a> parameters and settings.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_PATROL_ZONE).onafterStart">AI_PATROL_ZONE:onafterStart(Controllable, From, Event, To)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Defines a new patrol route using the <a href="Process_PatrolZone.html">Process_PatrolZone</a> parameters and settings.</p>
<p>Defines a new patrol route using the <a href="##(AI_PATROL_ZONE)">#AI_PATROL_ZONE</a> parameters and settings.</p>
</td>
</tr>
<tr class="w3-border">
@@ -3258,6 +3258,9 @@ 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>
@@ -3515,7 +3518,7 @@ So, in a group of 4 airplanes, 2 lost and 2 with damage 0.2, the damage threshol
<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.
When the fuel threshold is reached, the AI will continue for a given time its patrol task in orbit, while a new AIControllable is targeted 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">
@@ -5815,7 +5818,7 @@ The default interval is 30 seconds.</p>
</div>
<div class="w3-half">
<p>This statis method is called from the route path within the last task at the last waaypoint of the Controllable.
<p>This static method is called from the route path within the last task at the last waypoint of the Controllable.
Note that this method is required, as triggers the next route when patrolling for the Controllable.</p>
</div>
@@ -6170,7 +6173,7 @@ Note that this method is required, as triggers the next route when patrolling fo
<h2><a id="#(AI_PATROL_ZONE).onafterRoute" ><strong>AI_PATROL_ZONE:onafterRoute(Controllable, From, Event, To)</strong></a></h2>
</div>
<p>Defines a new patrol route using the <a href="Process_PatrolZone.html">Process_PatrolZone</a> parameters and settings.</p>
<p>Defines a new patrol route using the <a href="##(AI_PATROL_ZONE)">#AI_PATROL_ZONE</a> parameters and settings.</p>
<div id= "#Functions##onafterRoute" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -6242,7 +6245,7 @@ Note that this method is required, as triggers the next route when patrolling fo
<h2><a id="#(AI_PATROL_ZONE).onafterStart" ><strong>AI_PATROL_ZONE:onafterStart(Controllable, From, Event, To)</strong></a></h2>
</div>
<p>Defines a new patrol route using the <a href="Process_PatrolZone.html">Process_PatrolZone</a> parameters and settings.</p>
<p>Defines a new patrol route using the <a href="##(AI_PATROL_ZONE)">#AI_PATROL_ZONE</a> parameters and settings.</p>
<div id= "#Functions##onafterStart" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
@@ -6505,6 +6508,9 @@ 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>
@@ -7249,6 +7255,9 @@ 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>
@@ -8881,6 +8890,9 @@ 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>