weyne/MOOSE_DOCS
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE_DOCS.git synced 2025-08-15 10:37:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

MOOSE generated documentation [skip ci]

Browse Source
This commit is contained in:
Applevangelist
2023-07-03 14:54:53 +00:00
parent 9e5a94b774
commit 97ec475824
29 changed files with 1002 additions and 833 deletions
Download Patch File Download Diff File Expand all files Collapse all files

179
Documentation/Wrapper.Group.html
View File

@@ -3311,6 +3311,12 @@ amount of fuel in the group.</p>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).TaskFunction">GROUP:TaskFunction(FunctionString, ...)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>This creates a Task element, with an action to call a function as part of a Wrapped Task.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(GROUP).TaskGroundEscort">GROUP:TaskGroundEscort(FollowControllable, LastWaypointIndex, OrbitDistance, TargetTypes)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR/HELO) Escort a ground controllable.</p>
</td>
</tr>
<tr class="w3-border">
@@ -5043,7 +5049,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>
@@ -9536,7 +9553,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>
@@ -16789,7 +16817,7 @@ The unit / controllable will also protect that controllable from threats of spec
</div>
<div class="w3-half">
<p>Detach waypoint of another controllable. Once reached the unit / controllable Follow task is finished.</p>
<p>Detach waypoint of another controllable. Once reached the unit / controllable Escort task is finished.</p>
</div>
</div>
@@ -16802,7 +16830,7 @@ The unit / controllable will also protect that controllable from threats of spec
</div>
<div class="w3-half">
<p>Maximal distance from escorted controllable to threat. If the threat is already engaged by escort escort will disengage if the distance becomes greater than 1.5 * engagementDistMax.</p>
<p>Maximal distance from escorted controllable to threat in meters. If the threat is already engaged by escort escort will disengage if the distance becomes greater than 1.5 * engagementDistMax.</p>
</div>
</div>
@@ -16815,7 +16843,7 @@ The unit / controllable will also protect that controllable from threats of spec
</div>
<div class="w3-half">
<p>Array of AttributeName that is contains threat categories allowed to engage. Default {"Air"}.</p>
<p>Array of AttributeName that is contains threat categories allowed to engage. Default {"Air"}. See https://wiki.hoggit.us/view/DCS_enum_attributes</p>
</div>
</div>
@@ -17331,6 +17359,93 @@ Used to support CarpetBombing Task</p>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(GROUP).TaskGroundEscort" ><strong>GROUP:TaskGroundEscort(FollowControllable, LastWaypointIndex, OrbitDistance, TargetTypes)</strong></a></h2>
</div>
<p>(AIR/HELO) Escort a ground controllable.</p>
<p>The unit / controllable will follow lead unit of the other controllable, additional units of both controllables will continue following their leaders.
The unit / controllable will also protect that controllable from threats of specified types.</p>
<div id= "#Functions##TaskGroundEscort" 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="##(CONTROLLABLE)">#CONTROLLABLE</a>
<strong><strong>FollowControllable</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The controllable to be escorted.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>LastWaypointIndex</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Detach waypoint of another controllable. Once reached the unit / controllable Escort task is finished.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>OrbitDistance</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Maximum distance helo will orbit around the ground unit in meters. Defaults to 2000 meters.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="DCS.html##(AttributeNameArray)">DCS#AttributeNameArray</a>
<strong><strong>TargetTypes</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Array of AttributeName that is contains threat categories allowed to engage. Default {"Ground vehicles"}. See <a href="https://wiki.hoggit.us/view/DCS_enum_attributes">https://wiki.hoggit.us/view/DCS_enum_attributes</a></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>
@@ -17818,7 +17933,7 @@ Used to support CarpetBombing Task</p>
</div>
<div class="w3-half">
<p>Coordinate at which the CONTROLLABLE orbits.</p>
<p>Coordinate at which the CONTROLLABLE orbits. Can also be given as a <code>DCS#Vec3</code> or <code>DCS#Vec2</code> object.</p>
</div>
</div>
@@ -18775,7 +18890,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>
@@ -22864,7 +22990,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>
@@ -23489,7 +23626,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>
@@ -23749,7 +23897,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>