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
+145 -72
View File
@@ -2955,6 +2955,12 @@ amount of fuel in the group.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).RouteToVec3">GROUP: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="##(GROUP).SetAltitude">GROUP: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">
@@ -2967,6 +2973,12 @@ amount of fuel in the group.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).SetOption">GROUP: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="##(GROUP).SetSpeed">GROUP: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">
@@ -4757,18 +4769,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionInner" ><strong>GROUP.InitRespawnRandomizePositionInner</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionOuter" ><strong>GROUP.InitRespawnRandomizePositionOuter</strong></a>
<a id="#(GROUP).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
@@ -8913,18 +8914,7 @@ So each unit of the group is respawned at exactly the same parking spot as it cu
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionInner" ><strong>GROUP.InitRespawnRandomizePositionInner</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionOuter" ><strong>GROUP.InitRespawnRandomizePositionOuter</strong></a>
<a id="#(GROUP).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
@@ -14004,6 +13994,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="#(GROUP).SetAltitude" ><strong>GROUP: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><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a></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>
@@ -14105,6 +14165,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="#(GROUP).SetSpeed" ><strong>GROUP: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><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a></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>
@@ -17466,18 +17583,7 @@ Note that when the WayPoint parameter is used, the new start mission waypoint of
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionInner" ><strong>GROUP.InitRespawnRandomizePositionInner</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionOuter" ><strong>GROUP.InitRespawnRandomizePositionOuter</strong></a>
<a id="#(GROUP).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
@@ -21116,18 +21222,7 @@ Coordinates are dependent on the position of the maps origin.</p>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionInner" ><strong>GROUP.InitRespawnRandomizePositionInner</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionOuter" ><strong>GROUP.InitRespawnRandomizePositionOuter</strong></a>
<a id="#(GROUP).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
@@ -21781,18 +21876,7 @@ If the Identifiable is alive, true is returned. </p>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionInner" ><strong>GROUP.InitRespawnRandomizePositionInner</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionOuter" ><strong>GROUP.InitRespawnRandomizePositionOuter</strong></a>
<a id="#(GROUP).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
@@ -22052,18 +22136,7 @@ If the Identifiable is alive, true is returned. </p>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionInner" ><strong>GROUP.InitRespawnRandomizePositionInner</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionOuter" ><strong>GROUP.InitRespawnRandomizePositionOuter</strong></a>
<a id="#(GROUP).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>