mirror of
https://github.com/FlightControl-Master/MOOSE_DOCS.git
synced 2025-08-15 10:37:49 +00:00
MOOSE generated documentation [skip ci]
This commit is contained in:
Applevangelist
@@ -1681,6 +1681,7 @@ This is different from the EnRoute tasks, where the targets of the task need to
|
||||
<li><a href="##(CONTROLLABLE).TaskEmbarking">CONTROLLABLE.TaskEmbarking</a>: (AIR) Move the controllable to a Vec2 Point, wait for a defined duration and embark a controllable.</li>
|
||||
<li><a href="##(CONTROLLABLE).TaskEmbarkToTransport">CONTROLLABLE.TaskEmbarkToTransport</a>: (GROUND) Embark to a Transport landed at a location.</li>
|
||||
<li><a href="##(CONTROLLABLE).TaskEscort">CONTROLLABLE.TaskEscort</a>: (AIR) Escort another airborne controllable.</li>
|
||||
<li><a href="##(CONTROLLABLE).TaskGroundEscort">CONTROLLABLE.TaskGroundEscort</a>: (AIR/HELO) Escort a ground controllable.</li>
|
||||
<li><a href="##(CONTROLLABLE).TaskFAC_AttackGroup">CONTROLLABLE.TaskFAC_AttackGroup</a>: (AIR + GROUND) The task makes the controllable/unit a FAC and orders the FAC to control the target (enemy ground controllable) destruction.</li>
|
||||
<li><a href="##(CONTROLLABLE).TaskFireAtPoint">CONTROLLABLE.TaskFireAtPoint</a>: (GROUND) Fire some or all ammunition at a VEC2 point.</li>
|
||||
<li><a href="##(CONTROLLABLE).TaskFollow">CONTROLLABLE.TaskFollow</a>: (AIR) Following another airborne controllable.</li>
|
||||
@@ -2598,6 +2599,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).TaskFunction">CONTROLLABLE: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="##(CONTROLLABLE).TaskGroundEscort">CONTROLLABLE: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">
|
||||
@@ -11289,7 +11296,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>
|
||||
@@ -11302,7 +11309,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>
|
||||
@@ -11315,7 +11322,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>
|
||||
@@ -11831,6 +11838,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="#(CONTROLLABLE).TaskGroundEscort" ><strong>CONTROLLABLE: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>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>
|
||||
<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>
|
||||
|
||||
@@ -12318,7 +12412,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>
|
||||
|
||||
Reference in New Issue
Block a user