MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2022-03-18 06:49:04 +00:00
parent ae90a30579
commit efa85873ac
28 changed files with 1231 additions and 573 deletions

View File

@@ -2290,6 +2290,12 @@ The method <a href="##(CONTROLLABLE).SetTaskWaypoint">CONTROLLABLE.SetTaskWaypoi
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONTROLLABLE).RouteToVec3">CONTROLLABLE:RouteToVec3(Point, Speed)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR + GROUND) Make the Controllable move to a given point.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONTROLLABLE).SetAltitude">CONTROLLABLE:SetAltitude(Altitude, Keep, AltType)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>[AIR] Sets the controlled aircraft group to the specified altitude in meters.</p>
</td>
</tr>
<tr class="w3-border">
@@ -2302,6 +2308,12 @@ The method <a href="##(CONTROLLABLE).SetTaskWaypoint">CONTROLLABLE.SetTaskWaypoi
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONTROLLABLE).SetOption">CONTROLLABLE:SetOption(OptionID, OptionValue)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set option.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CONTROLLABLE).SetSpeed">CONTROLLABLE:SetSpeed(Speed, Keep)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Sets the controlled group to go the specified speed in meters per second. </p>
</td>
</tr>
<tr class="w3-border">
@@ -8884,6 +8896,76 @@ Warning! When you switch this option off, the airborne group will continue to fl
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CONTROLLABLE).SetAltitude" ><strong>CONTROLLABLE:SetAltitude(Altitude, Keep, AltType)</strong></a></h2>
</div>
<p>[AIR] Sets the controlled aircraft group to the specified altitude in meters.</p>
<div id= "#Functions##SetAltitude" 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>CONTROLLABLE</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>Altitude</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Altitude in meters</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>Keep</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) When set to true will maintain that altitude on passing waypoints. If no present or false the controlled group will return to the altitude as defined by their route. </p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>AltType</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Will specify the altitude type used. If nil the altitude type of the current waypoint will be used. Accepted values are "BARO" and "RADIO".</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="##(CONTROLLABLE)">#CONTROLLABLE</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
</div>
</div>
</div>
@@ -8985,6 +9067,63 @@ Warning! When you switch this option off, the airborne group will continue to fl
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CONTROLLABLE).SetSpeed" ><strong>CONTROLLABLE:SetSpeed(Speed, Keep)</strong></a></h2>
</div>
<p>Sets the controlled group to go the specified speed in meters per second. </p>
<div id= "#Functions##SetSpeed" 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>CONTROLLABLE</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>Speed</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Speed in meters per second</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>Keep</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) When set to true will maintain that speed on passing waypoints. If no present or false the controlled group will return to the speed as defined by their route. </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="##(CONTROLLABLE)">#CONTROLLABLE</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
</div>
</div>
</div>