mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-10-29 16:58:06 +00:00
Updated menu documentation and restructured some of the menu functions...
- Updated documentation. - _COMMAND:New methods now accept variable parameters. - Revised some code.
This commit is contained in:
FlightControl
@@ -37,6 +37,7 @@
|
||||
<li><a href="DCSWorld.html">DCSWorld</a></li>
|
||||
<li><a href="DCScountry.html">DCScountry</a></li>
|
||||
<li><a href="DCStimer.html">DCStimer</a></li>
|
||||
<li><a href="DCStrigger.html">DCStrigger</a></li>
|
||||
<li><a href="DEPLOYTASK.html">DEPLOYTASK</a></li>
|
||||
<li><a href="DESTROYBASETASK.html">DESTROYBASETASK</a></li>
|
||||
<li><a href="DESTROYGROUPSTASK.html">DESTROYGROUPSTASK</a></li>
|
||||
@@ -62,8 +63,9 @@
|
||||
<li><a href="Point.html">Point</a></li>
|
||||
<li><a href="Positionable.html">Positionable</a></li>
|
||||
<li><a href="Process.html">Process</a></li>
|
||||
<li><a href="Process_CAS.html">Process_CAS</a></li>
|
||||
<li><a href="Process_SEAD.html">Process_SEAD</a></li>
|
||||
<li><a href="Process_Destroy.html">Process_Destroy</a></li>
|
||||
<li><a href="Process_JTAC.html">Process_JTAC</a></li>
|
||||
<li><a href="Process_Smoke.html">Process_Smoke</a></li>
|
||||
<li><a href="ROUTETASK.html">ROUTETASK</a></li>
|
||||
<li><a href="STAGE.html">STAGE</a></li>
|
||||
<li><a href="Scheduler.html">Scheduler</a></li>
|
||||
@@ -74,7 +76,6 @@
|
||||
<li><a href="StateMachine.html">StateMachine</a></li>
|
||||
<li><a href="Static.html">Static</a></li>
|
||||
<li><a href="StaticObject.html">StaticObject</a></li>
|
||||
<li><a href="TASK.html">TASK</a></li>
|
||||
<li><a href="Task.html">Task</a></li>
|
||||
<li><a href="Task_Assign.html">Task_Assign</a></li>
|
||||
<li>Task_CAS</li>
|
||||
@@ -91,20 +92,20 @@
|
||||
<div id="content">
|
||||
<h1>Module <code>Task_CAS</code></h1>
|
||||
|
||||
<p>This module contains the TASK_CAS classes.</p>
|
||||
<p>This module contains the TASK_A2G classes.</p>
|
||||
|
||||
|
||||
|
||||
<h1>1) <a href="##(TASK_CAS)">#TASK_CAS</a> class, extends <a href="Task.html##(TASK_BASE)">Task#TASK_BASE</a></h1>
|
||||
<p>The <a href="##(TASK_CAS)">#TASK_CAS</a> class defines a new CAS task of a <a href="Set.html">Set</a> of Target Units, located at a Target Zone, based on the tasking capabilities defined in <a href="Task.html##(TASK_BASE)">Task#TASK_BASE</a>.
|
||||
The TASK_CAS is processed through a <a href="Statemachine.html##(STATEMACHINE_TASK)">Statemachine#STATEMACHINE_TASK</a>, and has the following statuses:</p>
|
||||
<h1>1) <a href="##(TASK_A2G)">#TASK_A2G</a> class, extends <a href="Task.html##(TASK_BASE)">Task#TASK_BASE</a></h1>
|
||||
<p>The <a href="##(TASK_A2G)">#TASK_A2G</a> class defines a new CAS task of a <a href="Set.html">Set</a> of Target Units, located at a Target Zone, based on the tasking capabilities defined in <a href="Task.html##(TASK_BASE)">Task#TASK_BASE</a>.
|
||||
The TASK_A2G is processed through a <a href="Statemachine.html##(STATEMACHINE_TASK)">Statemachine#STATEMACHINE_TASK</a>, and has the following statuses:</p>
|
||||
|
||||
<ul>
|
||||
<li>None: Start of the process</li>
|
||||
<li>Planned: The SEAD task is planned. Upon Planned, the sub-process <a href="Process_Assign.html##(PROCESS_ASSIGN_ACCEPT)">Process<em>Assign#PROCESS</em>ASSIGN_ACCEPT</a> is started to accept the task.</li>
|
||||
<li>Assigned: The SEAD task is assigned to a <a href="Group.html##(GROUP)">Group#GROUP</a>. Upon Assigned, the sub-process <a href="Process_Route.html##(PROCESS_ROUTE)">Process<em>Route#PROCESS</em>ROUTE</a> is started to route the active Units in the Group to the attack zone.</li>
|
||||
<li>Success: The SEAD task is successfully completed. Upon Success, the sub-process <a href="Process_SEAD.html##(PROCESS_SEAD)">Process<em>SEAD#PROCESS</em>SEAD</a> is started to follow-up successful SEADing of the targets assigned in the task.</li>
|
||||
<li>Failed: The SEAD task has failed. This will happen if the player exists the task early, without communicating a possible cancellation to HQ.</li>
|
||||
<li><strong>None</strong>: Start of the process</li>
|
||||
<li><strong>Planned</strong>: The SEAD task is planned. Upon Planned, the sub-process <a href="Process_Assign.html##(PROCESS_ASSIGN_ACCEPT)">Process<em>Assign#PROCESS</em>ASSIGN_ACCEPT</a> is started to accept the task.</li>
|
||||
<li><strong>Assigned</strong>: The SEAD task is assigned to a <a href="Group.html##(GROUP)">Group#GROUP</a>. Upon Assigned, the sub-process <a href="Process_Route.html##(PROCESS_ROUTE)">Process<em>Route#PROCESS</em>ROUTE</a> is started to route the active Units in the Group to the attack zone.</li>
|
||||
<li><strong>Success</strong>: The SEAD task is successfully completed. Upon Success, the sub-process <a href="Process_SEAD.html##(PROCESS_SEAD)">Process<em>SEAD#PROCESS</em>SEAD</a> is started to follow-up successful SEADing of the targets assigned in the task.</li>
|
||||
<li><strong>Failed</strong>: The SEAD task has failed. This will happen if the player exists the task early, without communicating a possible cancellation to HQ.</li>
|
||||
</ul>
|
||||
|
||||
<hr/>
|
||||
@@ -115,52 +116,64 @@ The TASK_CAS is processed through a <a href="Statemachine.html##(STATEMACHINE_TA
|
||||
<h2>Global(s)</h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="#TASK_CAS">TASK_CAS</a></td>
|
||||
<td class="name" nowrap="nowrap"><a href="#TASK_A2G">TASK_A2G</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h2><a id="#(TASK_CAS)">Type <code>TASK_CAS</code></a></h2>
|
||||
<h2><a id="#(TASK_A2G)">Type <code>TASK_A2G</code></a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(TASK_CAS).AssignToUnit">TASK_CAS:AssignToUnit(TaskUnit)</a></td>
|
||||
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G).AssignToUnit">TASK_A2G:AssignToUnit(TaskUnit)</a></td>
|
||||
<td class="summary">
|
||||
<p>Assign the <a href="Task.html">Task</a> to a <a href="Unit.html">Unit</a>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(TASK_CAS).ClassName">TASK_CAS.ClassName</a></td>
|
||||
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G).ClassName">TASK_A2G.ClassName</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(TASK_CAS).New">TASK_CAS:New(Mission, UnitSetTargets, TargetZone, MenuText, TargetSetUnit)</a></td>
|
||||
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G).CleanUp">TASK_A2G:CleanUp()</a></td>
|
||||
<td class="summary">
|
||||
<p>Instantiates a new TASK_CAS.</p>
|
||||
<p>Removes a TASK_A2G.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(TASK_CAS).OnNext">TASK_CAS:OnNext(Fsm, Event, From, To, Event)</a></td>
|
||||
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G).GetPlannedMenuText">TASK_A2G:GetPlannedMenuText()</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G).New">TASK_A2G:New(Mission, SetGroup, TaskName, TaskType, UnitSetTargets, TargetZone, TargetSetUnit, FACUnit)</a></td>
|
||||
<td class="summary">
|
||||
<p>Instantiates a new TASK_A2G.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G).OnNext">TASK_A2G:OnNext(Fsm, Event, From, To, Event)</a></td>
|
||||
<td class="summary">
|
||||
<p>StateMachine callback function for a TASK</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(TASK_CAS).TaskScheduler">TASK_CAS.TaskScheduler</a></td>
|
||||
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G).TaskScheduler">TASK_A2G.TaskScheduler</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(TASK_CAS)._Schedule">TASK_CAS:_Schedule()</a></td>
|
||||
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G)._Schedule">TASK_A2G:_Schedule()</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(TASK_CAS)._Scheduler">TASK_CAS:_Scheduler()</a></td>
|
||||
<td class="name" nowrap="nowrap"><a href="##(TASK_A2G)._Scheduler">TASK_A2G:_Scheduler()</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
@@ -171,9 +184,9 @@ The TASK_CAS is processed through a <a href="Statemachine.html##(STATEMACHINE_TA
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em><a href="##(TASK_CAS)">#TASK_CAS</a></em>
|
||||
<a id="TASK_CAS" >
|
||||
<strong>TASK_CAS</strong>
|
||||
<em><a href="##(TASK_A2G)">#TASK_A2G</a></em>
|
||||
<a id="TASK_A2G" >
|
||||
<strong>TASK_A2G</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -184,16 +197,16 @@ The TASK_CAS is processed through a <a href="Statemachine.html##(STATEMACHINE_TA
|
||||
</dl>
|
||||
<h2><a id="#(Task_CAS)" >Type <code>Task_CAS</code></a></h2>
|
||||
|
||||
<h2><a id="#(TASK_CAS)" >Type <code>TASK_CAS</code></a></h2>
|
||||
<h2><a id="#(TASK_A2G)" >Type <code>TASK_A2G</code></a></h2>
|
||||
|
||||
<p>The TASK_CAS class</p>
|
||||
<p>The TASK_A2G class</p>
|
||||
|
||||
<h3>Field(s)</h3>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(TASK_CAS).AssignToUnit" >
|
||||
<strong>TASK_CAS:AssignToUnit(TaskUnit)</strong>
|
||||
<a id="#(TASK_A2G).AssignToUnit" >
|
||||
<strong>TASK_A2G:AssignToUnit(TaskUnit)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -210,7 +223,7 @@ The TASK_CAS is processed through a <a href="Statemachine.html##(STATEMACHINE_TA
|
||||
</ul>
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em><a href="##(TASK_CAS)">#TASK_CAS</a>:</em>
|
||||
<p><em><a href="##(TASK_A2G)">#TASK_A2G</a>:</em>
|
||||
self</p>
|
||||
|
||||
</dd>
|
||||
@@ -219,8 +232,8 @@ self</p>
|
||||
<dt>
|
||||
|
||||
<em>#string</em>
|
||||
<a id="#(TASK_CAS).ClassName" >
|
||||
<strong>TASK_CAS.ClassName</strong>
|
||||
<a id="#(TASK_A2G).ClassName" >
|
||||
<strong>TASK_A2G.ClassName</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -232,13 +245,44 @@ self</p>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(TASK_CAS).New" >
|
||||
<strong>TASK_CAS:New(Mission, UnitSetTargets, TargetZone, MenuText, TargetSetUnit)</strong>
|
||||
<a id="#(TASK_A2G).CleanUp" >
|
||||
<strong>TASK_A2G:CleanUp()</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Instantiates a new TASK_CAS.</p>
|
||||
<p>Removes a TASK_A2G.</p>
|
||||
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em>#nil:</em></p>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(TASK_A2G).GetPlannedMenuText" >
|
||||
<strong>TASK_A2G:GetPlannedMenuText()</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(TASK_A2G).New" >
|
||||
<strong>TASK_A2G:New(Mission, SetGroup, TaskName, TaskType, UnitSetTargets, TargetZone, TargetSetUnit, FACUnit)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Instantiates a new TASK_A2G.</p>
|
||||
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
@@ -249,6 +293,24 @@ self</p>
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em><a href="Set.html##(SET_GROUP)">Set#SET_GROUP</a> SetGroup </em></code>:
|
||||
The set of groups for which the Task can be assigned.</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em>#string TaskName </em></code>:
|
||||
The name of the Task.</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em>#string TaskType </em></code>:
|
||||
BAI or CAS</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em><a href="Set.html##(SET_UNIT)">Set#SET_UNIT</a> UnitSetTargets </em></code>: </p>
|
||||
|
||||
</li>
|
||||
@@ -259,18 +321,18 @@ self</p>
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em> MenuText </em></code>: </p>
|
||||
<p><code><em> TargetSetUnit </em></code>: </p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em> TargetSetUnit </em></code>: </p>
|
||||
<p><code><em> FACUnit </em></code>: </p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em><a href="##(TASK_CAS)">#TASK_CAS</a>:</em>
|
||||
<p><em><a href="##(TASK_A2G)">#TASK_A2G</a>:</em>
|
||||
self</p>
|
||||
|
||||
</dd>
|
||||
@@ -278,8 +340,8 @@ self</p>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(TASK_CAS).OnNext" >
|
||||
<strong>TASK_CAS:OnNext(Fsm, Event, From, To, Event)</strong>
|
||||
<a id="#(TASK_A2G).OnNext" >
|
||||
<strong>TASK_A2G:OnNext(Fsm, Event, From, To, Event)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -320,8 +382,8 @@ self</p>
|
||||
<dt>
|
||||
|
||||
<em></em>
|
||||
<a id="#(TASK_CAS).TaskScheduler" >
|
||||
<strong>TASK_CAS.TaskScheduler</strong>
|
||||
<a id="#(TASK_A2G).TaskScheduler" >
|
||||
<strong>TASK_A2G.TaskScheduler</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -333,8 +395,8 @@ self</p>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(TASK_CAS)._Schedule" >
|
||||
<strong>TASK_CAS:_Schedule()</strong>
|
||||
<a id="#(TASK_A2G)._Schedule" >
|
||||
<strong>TASK_A2G:_Schedule()</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
@@ -346,8 +408,8 @@ self</p>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(TASK_CAS)._Scheduler" >
|
||||
<strong>TASK_CAS:_Scheduler()</strong>
|
||||
<a id="#(TASK_A2G)._Scheduler" >
|
||||
<strong>TASK_A2G:_Scheduler()</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
Reference in New Issue
Block a user