MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2022-11-18 09:11:23 +00:00
parent fded888298
commit 8f67155098
22 changed files with 1266 additions and 302 deletions

View File

@@ -2460,6 +2460,12 @@ amount of fuel in the group.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).SetAIOnOff">GROUP:SetAIOnOff(AIOnOff)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Turns the AI On or Off for the GROUP.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).SetAsRecoveryTanker">GROUP:SetAsRecoveryTanker(CarrierGroup, Speed, ToKIAS, Altitude, Delay, LastWaypoint)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -3308,6 +3314,12 @@ amount of fuel in the group.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).TaskOrbitCircleAtVec2">GROUP:TaskOrbitCircleAtVec2(Point, Altitude, Speed)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR) Orbit at a specified position at a specified altitude during a specified duration with a specified speed.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).TaskRecoveryTanker">GROUP:TaskRecoveryTanker(CarrierGroup, Speed, Altitude, LastWptNumber)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR) Act as Recovery Tanker for a naval/carrier group.</p>
</td>
</tr>
<tr class="w3-border">
@@ -4944,7 +4956,18 @@ 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).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
<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>
@@ -8935,6 +8958,113 @@ So each unit of the group is respawned at exactly the same parking spot as it cu
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(GROUP).SetAsRecoveryTanker" ><strong>GROUP:SetAsRecoveryTanker(CarrierGroup, Speed, ToKIAS, Altitude, Delay, LastWaypoint)</strong></a></h2>
</div>
<div id= "#Functions##SetAsRecoveryTanker" 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>GROUP</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>
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
<strong><strong>CarrierGroup</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<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 knots.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>ToKIAS</strong></strong>
</p>
</div>
<div class="w3-half">
<p>If true, adjust speed to altitude (KIAS).</p>
</div>
</div>
<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 the tanker orbits at in feet.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Delay</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Set the task after this many seconds. Defaults to one.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>LastWaypoint</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Waypoint number of carrier group that when reached, ends the recovery tanker task.</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="##(GROUP)">#GROUP</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
</div>
</div>
</div>
@@ -9336,7 +9466,18 @@ 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).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
<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>
@@ -17542,6 +17683,87 @@ Used to support CarpetBombing Task</p>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(GROUP).TaskRecoveryTanker" ><strong>GROUP:TaskRecoveryTanker(CarrierGroup, Speed, Altitude, LastWptNumber)</strong></a></h2>
</div>
<p>(AIR) Act as Recovery Tanker for a naval/carrier group.</p>
<div id= "#Functions##TaskRecoveryTanker" 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>
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
<strong><strong>CarrierGroup</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<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>
#number
<strong><strong>Altitude</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Altitude the tanker orbits at in meters</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>LastWptNumber</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Waypoint of carrier group that when reached, ends the recovery tanker task</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="DCS.html##(Task)">DCS#Task</a>:</p>
</div>
<div class="w3-half">
<p>The DCS task structure.</p>
</div>
</div>
</div>
</div>
</div>
@@ -18222,7 +18444,18 @@ Note that when WayPointInitialize is called, the Mission of the controllable is
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
<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>
@@ -22068,7 +22301,18 @@ 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).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
<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>
@@ -22693,7 +22937,18 @@ If the Identifiable is alive, true is returned. </p>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
<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>
@@ -22953,7 +23208,18 @@ If the Identifiable is alive, true is returned. </p>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(GROUP).InitRespawnRandomizePositionZone" ><strong>GROUP.InitRespawnRandomizePositionZone</strong></a>
<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>