MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2022-05-10 08:20:06 +00:00
parent 0ca178267e
commit 7d6917c700
27 changed files with 1035 additions and 359 deletions

View File

@@ -1815,6 +1815,18 @@ and the resulting state will be the <strong>To</strong> state.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_AIR).RTBRoute">AI_AIR.RTBRoute(AIGroup, Fsm)</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="##(AI_AIR).RTBSpeedMaxFactor">AI_AIR.RTBSpeedMaxFactor</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="##(AI_AIR).RTBSpeedMinFactor">AI_AIR.RTBSpeedMinFactor</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -1869,6 +1881,12 @@ and the resulting state will be the <strong>To</strong> state.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_AIR).SetRTBSpeed">AI_AIR:SetRTBSpeed(RTBMinSpeed, RTBMaxSpeed)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Sets (modifies) the minimum and maximum RTB speed of the patrol.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(AI_AIR).SetRTBSpeedFactors">AI_AIR:SetRTBSpeedFactors(MinFactor, MaxFactor)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set the min and max factors on RTB speed.</p>
</td>
</tr>
<tr class="w3-border">
@@ -4786,6 +4804,68 @@ Once the time is finished, the old AI will return to the base.</p>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(AI_AIR).SetRTBSpeedFactors" ><strong>AI_AIR:SetRTBSpeedFactors(MinFactor, MaxFactor)</strong></a></h2>
</div>
<p>Set the min and max factors on RTB speed.</p>
<p>Use this, if your planes are heading back to base too fast. Default values are 0.5 and 0.6.
The RTB speed is calculated as the max speed of the unit multiplied by MinFactor (lower bracket) and multiplied by MaxFactor (upper bracket).
A random value in this bracket is then applied in the waypoint routing generation.</p>
<div id= "#Functions##SetRTBSpeedFactors" 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>AI_AIR</p>
</div>
<h2><strong>Parameters:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>MinFactor</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Lower bracket factor. Defaults to 0.5.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>MaxFactor</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Upper bracket factor. Defaults to 0.6.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="##(AI_AIR)">#AI_AIR</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
</div>
</div>
</div>