weyne/MOOSE
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE.git synced 2025-08-15 10:47:21 +00:00
Code Issues Packages Projects Releases Wiki Activity
MOOSE/Moose Training/Documentation/TASK.html
FlightControl d5671a5f65 Working version of the DETECTION classes
2016-07-19 18:12:26 +02:00

1480 lines
33 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
<link rel="stylesheet" href="stylesheet.css" type="text/css"/>
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div>
<div id="main">
<div id="navigation">
<h2>Modules</h2>
<ul><li>
<a href="index.html">index</a>
</li></ul>
<ul>
<li><a href="AIBalancer.html">AIBalancer</a></li>
<li><a href="Airbase.html">Airbase</a></li>
<li><a href="AirbasePolice.html">AirbasePolice</a></li>
<li><a href="Base.html">Base</a></li>
<li><a href="CARGO.html">CARGO</a></li>
<li><a href="CleanUp.html">CleanUp</a></li>
<li><a href="Client.html">Client</a></li>
<li><a href="Controllable.html">Controllable</a></li>
<li><a href="DCSAirbase.html">DCSAirbase</a></li>
<li><a href="DCSCoalitionObject.html">DCSCoalitionObject</a></li>
<li><a href="DCSCommand.html">DCSCommand</a></li>
<li><a href="DCSController.html">DCSController</a></li>
<li><a href="DCSGroup.html">DCSGroup</a></li>
<li><a href="DCSObject.html">DCSObject</a></li>
<li><a href="DCSTask.html">DCSTask</a></li>
<li><a href="DCSTypes.html">DCSTypes</a></li>
<li><a href="DCSUnit.html">DCSUnit</a></li>
<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="DEPLOYTASK.html">DEPLOYTASK</a></li>
<li><a href="DESTROYBASETASK.html">DESTROYBASETASK</a></li>
<li><a href="DESTROYGROUPSTASK.html">DESTROYGROUPSTASK</a></li>
<li><a href="DESTROYRADARSTASK.html">DESTROYRADARSTASK</a></li>
<li><a href="DESTROYUNITTYPESTASK.html">DESTROYUNITTYPESTASK</a></li>
<li><a href="Database.html">Database</a></li>
<li><a href="Detection.html">Detection</a></li>
<li><a href="DetectionManager.html">DetectionManager</a></li>
<li><a href="Escort.html">Escort</a></li>
<li><a href="Event.html">Event</a></li>
<li><a href="GOHOMETASK.html">GOHOMETASK</a></li>
<li><a href="Group.html">Group</a></li>
<li><a href="Identifiable.html">Identifiable</a></li>
<li><a href="MOVEMENT.html">MOVEMENT</a></li>
<li><a href="Menu.html">Menu</a></li>
<li><a href="Message.html">Message</a></li>
<li><a href="MissileTrainer.html">MissileTrainer</a></li>
<li><a href="Mission.html">Mission</a></li>
<li><a href="NOTASK.html">NOTASK</a></li>
<li><a href="Object.html">Object</a></li>
<li><a href="PICKUPTASK.html">PICKUPTASK</a></li>
<li><a href="PatrolZone.html">PatrolZone</a></li>
<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="ROUTETASK.html">ROUTETASK</a></li>
<li><a href="STAGE.html">STAGE</a></li>
<li><a href="Scheduler.html">Scheduler</a></li>
<li><a href="Scoring.html">Scoring</a></li>
<li><a href="Sead.html">Sead</a></li>
<li><a href="Set.html">Set</a></li>
<li><a href="Spawn.html">Spawn</a></li>
<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>Task</li>
<li><a href="Task_Assign.html">Task_Assign</a></li>
<li><a href="Task_CAS.html">Task_CAS</a></li>
<li><a href="Task_Client_Menu.html">Task_Client_Menu</a></li>
<li><a href="Task_Route.html">Task_Route</a></li>
<li><a href="Task_SEAD.html">Task_SEAD</a></li>
<li><a href="Unit.html">Unit</a></li>
<li><a href="Zone.html">Zone</a></li>
<li><a href="env.html">env</a></li>
<li><a href="land.html">land</a></li>
<li><a href="routines.html">routines</a></li>
</ul>
</div>
<div id="content">
<h1>Module <code>Task</code></h1>
<p>This module contains the TASK_BASE class.</p>
<h1>1) <a href="##(TASK_BASE)">#TASK_BASE</a> class, extends <a href="Base.html##(BASE)">Base#BASE</a></h1>
<h2>1.1) The <a href="##(TASK_BASE)">#TASK_BASE</a> class implements the methods for task orchestration within MOOSE. </h2>
<p>The class provides a couple of methods to:</p>
<ul>
<li><a href="##(TASK_BASE).AssignToGroup">TASK_BASE.AssignToGroup</a>():Assign a task to a group (of players).</li>
<li><a href="##(TASK_BASE).AddProcess">TASK_BASE.AddProcess</a>():Add a <a href="Process.html">Process</a> to a task.</li>
<li><a href="##(TASK_BASE).RemoveProcesses">TASK_BASE.RemoveProcesses</a>():Remove a running <a href="Process.html">Process</a> from a running task.</li>
<li><a href="##(TASK_BASE).AddStateMachine">TASK_BASE.AddStateMachine</a>():Add a <a href="StateMachine.html">StateMachine</a> to a task.</li>
<li><a href="##(TASK_BASE).RemoveStateMachines">TASK_BASE.RemoveStateMachines</a>():Remove <a href="StateMachine.html">StateMachine</a>s from a task.</li>
<li><a href="##(TASK_BASE).HasStateMachine">TASK_BASE.HasStateMachine</a>():Enquire if the task has a <a href="StateMachine.html">StateMachine</a></li>
<li><a href="##(TASK_BASE).AssignToUnit">TASK_BASE.AssignToUnit</a>(): Assign a task to a unit. (Needs to be implemented in the derived classes from <a href="##(TASK_BASE)">#TASK_BASE</a>.</li>
<li><a href="##(TASK_BASE).UnAssignFromUnit">TASK_BASE.UnAssignFromUnit</a>(): Unassign the task from a unit.</li>
</ul>
<h2>1.2) Set and enquire task status (beyond the task state machine processing).</h2>
<p>A task needs to implement as a minimum the following task states:</p>
<ul>
<li><strong>Success</strong>: Expresses the successful execution and finalization of the task.</li>
<li><strong>Failed</strong>: Expresses the failure of a task.</li>
<li><strong>Planned</strong>: Expresses that the task is created, but not yet in execution and is not assigned yet.</li>
<li><strong>Assigned</strong>: Expresses that the task is assigned to a Group of players, and that the task is in execution mode.</li>
</ul>
<p>A task may also implement the following task states:</p>
<ul>
<li><strong>Rejected</strong>: Expresses that the task is rejected by a player, who was requested to accept the task.</li>
<li><strong>Cancelled</strong>: Expresses that the task is cancelled by HQ or through a logical situation where a cancellation of the task is required.</li>
</ul>
<p>A task can implement more statusses than the ones outlined above. Please consult the documentation of the specific tasks to understand the different status modelled.</p>
<p>The status of tasks can be set by the methods <strong>State</strong> followed by the task status. An example is <code>StateAssigned()</code>.
The status of tasks can be enquired by the methods <strong>IsState</strong> followed by the task status name. An example is <code>if IsStateAssigned() then</code>.</p>
<h2>1.3) Add scoring when reaching a certain task status:</h2>
<p>Upon reaching a certain task status in a task, additional scoring can be given. If the Mission has a scoring system attached, the scores will be added to the mission scoring.
Use the method <a href="##(TASK_BASE).AddScore">TASK_BASE.AddScore</a>() to add scores when a status is reached.</p>
<h2>1.4) Task briefing:</h2>
<p>A task briefing can be given that is shown to the player when he is assigned to the task.</p>
<hr/>
<h3>Authors: FlightControl - Design and Programming</h3>
<h2>Global(s)</h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="#TASK_BASE">TASK_BASE</a></td>
<td class="summary">
</td>
</tr>
</table>
<h2><a id="#(TASK_BASE)">Type <code>TASK_BASE</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).AddProcess">TASK_BASE:AddProcess(TaskUnit, Process)</a></td>
<td class="summary">
<p>Add Process to <a href="Task.html">Task</a> with key <a href="Unit.html">Unit</a></p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).AddScore">TASK_BASE:AddScore(TaskStatus, ScoreText, Score)</a></td>
<td class="summary">
<p>Adds a score for the TASK to be achieved.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).AddStateMachine">TASK_BASE:AddStateMachine(TaskUnit, Fsm)</a></td>
<td class="summary">
<p>Add a FiniteStateMachine to <a href="Task.html">Task</a> with key <a href="Unit.html">Unit</a></p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).AssignToGroup">TASK_BASE:AssignToGroup(TaskGroup)</a></td>
<td class="summary">
<p>Assign the <a href="Task.html">Task</a>to a <a href="Group.html">Group</a>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).AssignToUnit">TASK_BASE:AssignToUnit(TaskUnit)</a></td>
<td class="summary">
<p>Assign the <a href="Task.html">Task</a>to an alive <a href="Unit.html">Unit</a>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).ClassName">TASK_BASE.ClassName</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).Fsm">TASK_BASE.Fsm</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).GetCategory">TASK_BASE:GetCategory()</a></td>
<td class="summary">
<p>Gets the Category of the Task</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).GetID">TASK_BASE:GetID()</a></td>
<td class="summary">
<p>Gets the ID of the Task</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).GetName">TASK_BASE:GetName()</a></td>
<td class="summary">
<p>Gets the Name of the Task</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).GetScoring">TASK_BASE:GetScoring()</a></td>
<td class="summary">
<p>Gets the Scoring of the task</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).GetStateString">TASK_BASE:GetStateString()</a></td>
<td class="summary">
<p>Gets the <a href="Task.html">Task</a> status.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).GetType">TASK_BASE:GetType()</a></td>
<td class="summary">
<p>Gets the Type of the Task</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).HasStateMachine">TASK_BASE:HasStateMachine(TaskUnit)</a></td>
<td class="summary">
<p>Checks if there is a FiniteStateMachine assigned to <a href="Unit.html">Unit</a> for <a href="Task.html">Task</a></p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).IsStateAssigned">TASK_BASE:IsStateAssigned()</a></td>
<td class="summary">
<p>Is the <a href="Task.html">Task</a> status <strong>Assigned</strong>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).IsStateFailed">TASK_BASE:IsStateFailed()</a></td>
<td class="summary">
<p>Is the <a href="Task.html">Task</a> status <strong>Failed</strong>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).IsStateHold">TASK_BASE:IsStateHold()</a></td>
<td class="summary">
<p>Is the <a href="Task.html">Task</a> status <strong>Hold</strong>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).IsStatePlanned">TASK_BASE:IsStatePlanned()</a></td>
<td class="summary">
<p>Is the <a href="Task.html">Task</a> status <strong>Planned</strong>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).IsStateReplanned">TASK_BASE:IsStateReplanned()</a></td>
<td class="summary">
<p>Is the <a href="Task.html">Task</a> status <strong>Replanned</strong>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).IsStateSuccess">TASK_BASE:IsStateSuccess()</a></td>
<td class="summary">
<p>Is the <a href="Task.html">Task</a> status <strong>Success</strong>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).Mission">TASK_BASE.Mission</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).New">TASK_BASE:New(Mission, TaskName, TaskType, TaskCategory)</a></td>
<td class="summary">
<p>Instantiates a new TASK_BASE.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).OnStateChange">TASK_BASE:OnStateChange(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_BASE).Players">TASK_BASE.Players</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).Processes">TASK_BASE.Processes</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).RemoveProcesses">TASK_BASE:RemoveProcesses(TaskUnit, FailProcesses)</a></td>
<td class="summary">
<p>Remove Processes from <a href="Task.html">Task</a> with key <a href="Unit.html">Unit</a></p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).RemoveStateMachines">TASK_BASE:RemoveStateMachines(TaskUnit)</a></td>
<td class="summary">
<p>Remove FiniteStateMachines from <a href="Task.html">Task</a> with key <a href="Unit.html">Unit</a></p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).Scores">TASK_BASE.Scores</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).SetBriefing">TASK_BASE:SetBriefing(TaskBriefing)</a></td>
<td class="summary">
<p>Sets a <a href="Task.html">Task</a> briefing.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).SetCategory">TASK_BASE:SetCategory(TaskCategory)</a></td>
<td class="summary">
<p>Sets the Category of the Task</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).SetID">TASK_BASE:SetID(TaskID)</a></td>
<td class="summary">
<p>Sets the ID of the Task</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).SetName">TASK_BASE:SetName(TaskName)</a></td>
<td class="summary">
<p>Sets the Name of the Task</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).SetType">TASK_BASE:SetType(TaskType)</a></td>
<td class="summary">
<p>Sets the Type of the Task</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).StateAssigned">TASK_BASE:StateAssigned()</a></td>
<td class="summary">
<p>Sets a <a href="Task.html">Task</a> to status <strong>Assigned</strong>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).StateFailed">TASK_BASE:StateFailed()</a></td>
<td class="summary">
<p>Sets a <a href="Task.html">Task</a> to status <strong>Failed</strong>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).StateHold">TASK_BASE:StateHold()</a></td>
<td class="summary">
<p>Sets a <a href="Task.html">Task</a> to status <strong>Hold</strong>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).StatePlanned">TASK_BASE:StatePlanned()</a></td>
<td class="summary">
<p>Sets a <a href="Task.html">Task</a> to status <strong>Planned</strong>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).StateReplanned">TASK_BASE:StateReplanned()</a></td>
<td class="summary">
<p>Sets a <a href="Task.html">Task</a> to status <strong>Replanned</strong>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).StateSuccess">TASK_BASE:StateSuccess()</a></td>
<td class="summary">
<p>Sets a <a href="Task.html">Task</a> to status <strong>Success</strong>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).TaskBriefing">TASK_BASE.TaskBriefing</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).TaskCategory">TASK_BASE.TaskCategory</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).TaskID">TASK_BASE.TaskID</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).TaskName">TASK_BASE.TaskName</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).TaskScheduler">TASK_BASE.TaskScheduler</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).TaskType">TASK_BASE.TaskType</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).TaskUnit">TASK_BASE.TaskUnit</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE).UnAssignFromUnit">TASK_BASE:UnAssignFromUnit(TaskUnit, FailProcesses)</a></td>
<td class="summary">
<p>UnAssign the <a href="Task.html">Task</a> from an alive <a href="Unit.html">Unit</a>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE)._EventAssignUnit">TASK_BASE:_EventAssignUnit(Event)</a></td>
<td class="summary">
<p>Register a potential new assignment for a new spawned <a href="Unit.html">Unit</a>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE)._EventUnAssignUnit">TASK_BASE:_EventUnAssignUnit(Event)</a></td>
<td class="summary">
<p>UnAssigns a <a href="Unit.html">Unit</a> that is left by a player, crashed, dead, ....</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE)._Schedule">TASK_BASE:_Schedule()</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_BASE)._Scheduler">TASK_BASE:_Scheduler()</a></td>
<td class="summary">
</td>
</tr>
</table>
<h2>Global(s)</h2>
<dl class="function">
<dt>
<em><a href="##(TASK_BASE)">#TASK_BASE</a></em>
<a id="TASK_BASE" >
<strong>TASK_BASE</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<h2><a id="#(Task)" >Type <code>Task</code></a></h2>
<h2><a id="#(TASK_BASE)" >Type <code>TASK_BASE</code></a></h2>
<p>The TASK_BASE class</p>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<a id="#(TASK_BASE).AddProcess" >
<strong>TASK_BASE:AddProcess(TaskUnit, Process)</strong>
</a>
</dt>
<dd>
<p>Add Process to <a href="Task.html">Task</a> with key <a href="Unit.html">Unit</a></p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Unit.html##(UNIT)">Unit#UNIT</a> TaskUnit </em></code>: </p>
</li>
<li>
<p><code><em> Process </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(TASK_BASE)">#TASK_BASE</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE).AddScore" >
<strong>TASK_BASE:AddScore(TaskStatus, ScoreText, Score)</strong>
</a>
</dt>
<dd>
<p>Adds a score for the TASK to be achieved.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string TaskStatus </em></code>:
is the status of the TASK when the score needs to be given.</p>
</li>
<li>
<p><code><em>#string ScoreText </em></code>:
is a text describing the score that is given according the status.</p>
</li>
<li>
<p><code><em>#number Score </em></code>:
is a number providing the score of the status.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(TASK_BASE)">#TASK_BASE</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE).AddStateMachine" >
<strong>TASK_BASE:AddStateMachine(TaskUnit, Fsm)</strong>
</a>
</dt>
<dd>
<p>Add a FiniteStateMachine to <a href="Task.html">Task</a> with key <a href="Unit.html">Unit</a></p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Unit.html##(UNIT)">Unit#UNIT</a> TaskUnit </em></code>: </p>
</li>
<li>
<p><code><em> Fsm </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(TASK_BASE)">#TASK_BASE</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE).AssignToGroup" >
<strong>TASK_BASE:AssignToGroup(TaskGroup)</strong>
</a>
</dt>
<dd>
<p>Assign the <a href="Task.html">Task</a>to a <a href="Group.html">Group</a>.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Group.html##(GROUP)">Group#GROUP</a> TaskGroup </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(TASK_BASE)">#TASK_BASE</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE).AssignToUnit" >
<strong>TASK_BASE:AssignToUnit(TaskUnit)</strong>
</a>
</dt>
<dd>
<p>Assign the <a href="Task.html">Task</a>to an alive <a href="Unit.html">Unit</a>.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Unit.html##(UNIT)">Unit#UNIT</a> TaskUnit </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(TASK_BASE)">#TASK_BASE</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(TASK_BASE).ClassName" >
<strong>TASK_BASE.ClassName</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="StateMachine.html##(STATEMACHINE)">StateMachine#STATEMACHINE</a></em>
<a id="#(TASK_BASE).Fsm" >
<strong>TASK_BASE.Fsm</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE).GetCategory" >
<strong>TASK_BASE:GetCategory()</strong>
</a>
</dt>
<dd>
<p>Gets the Category of the Task</p>
<h3>Return value</h3>
<p><em>#string:</em>
TaskCategory</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE).GetID" >
<strong>TASK_BASE:GetID()</strong>
</a>
</dt>
<dd>
<p>Gets the ID of the Task</p>
<h3>Return value</h3>
<p><em>#string:</em>
TaskID</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE).GetName" >
<strong>TASK_BASE:GetName()</strong>
</a>
</dt>
<dd>
<p>Gets the Name of the Task</p>
<h3>Return value</h3>
<p><em>#string:</em>
The Task Name</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE).GetScoring" >
<strong>TASK_BASE:GetScoring()</strong>
</a>
</dt>
<dd>
<p>Gets the Scoring of the task</p>
<h3>Return value</h3>
<p><em><a href="Scoring.html##(SCORING)">Scoring#SCORING</a>:</em>
Scoring</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE).GetStateString" >
<strong>TASK_BASE:GetStateString()</strong>
</a>
</dt>
<dd>
<p>Gets the <a href="Task.html">Task</a> status.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE).GetType" >
<strong>TASK_BASE:GetType()</strong>
</a>
</dt>
<dd>
<p>Gets the Type of the Task</p>
<h3>Return value</h3>
<p><em>#string:</em>
TaskType</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE).HasStateMachine" >
<strong>TASK_BASE:HasStateMachine(TaskUnit)</strong>
</a>
</dt>
<dd>
<p>Checks if there is a FiniteStateMachine assigned to <a href="Unit.html">Unit</a> for <a href="Task.html">Task</a></p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Unit.html##(UNIT)">Unit#UNIT</a> TaskUnit </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(TASK_BASE)">#TASK_BASE</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE).IsStateAssigned" >
<strong>TASK_BASE:IsStateAssigned()</strong>
</a>
</dt>
<dd>
<p>Is the <a href="Task.html">Task</a> status <strong>Assigned</strong>.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE).IsStateFailed" >
<strong>TASK_BASE:IsStateFailed()</strong>
</a>
</dt>
<dd>
<p>Is the <a href="Task.html">Task</a> status <strong>Failed</strong>.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE).IsStateHold" >
<strong>TASK_BASE:IsStateHold()</strong>
</a>
</dt>
<dd>
<p>Is the <a href="Task.html">Task</a> status <strong>Hold</strong>.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE).IsStatePlanned" >
<strong>TASK_BASE:IsStatePlanned()</strong>
</a>
</dt>
<dd>
<p>Is the <a href="Task.html">Task</a> status <strong>Planned</strong>.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE).IsStateReplanned" >
<strong>TASK_BASE:IsStateReplanned()</strong>
</a>
</dt>
<dd>
<p>Is the <a href="Task.html">Task</a> status <strong>Replanned</strong>.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE).IsStateSuccess" >
<strong>TASK_BASE:IsStateSuccess()</strong>
</a>
</dt>
<dd>
<p>Is the <a href="Task.html">Task</a> status <strong>Success</strong>.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Mission.html##(MISSION)">Mission#MISSION</a></em>
<a id="#(TASK_BASE).Mission" >
<strong>TASK_BASE.Mission</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE).New" >
<strong>TASK_BASE:New(Mission, TaskName, TaskType, TaskCategory)</strong>
</a>
</dt>
<dd>
<p>Instantiates a new TASK_BASE.</p>
<p>Should never be used. Interface Class.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em> Mission </em></code>: </p>
</li>
<li>
<p><code><em> TaskName </em></code>: </p>
</li>
<li>
<p><code><em> TaskType </em></code>: </p>
</li>
<li>
<p><code><em> TaskCategory </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(TASK_BASE)">#TASK_BASE</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE).OnStateChange" >
<strong>TASK_BASE:OnStateChange(Fsm, Event, From, To, Event)</strong>
</a>
</dt>
<dd>
<p>StateMachine callback function for a TASK</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="StateMachine.html##(STATEMACHINE_TASK)">StateMachine#STATEMACHINE_TASK</a> Fsm </em></code>: </p>
</li>
<li>
<p><code><em>#string Event </em></code>: </p>
</li>
<li>
<p><code><em>#string From </em></code>: </p>
</li>
<li>
<p><code><em>#string To </em></code>: </p>
</li>
<li>
<p><code><em><a href="Event.html##(EVENTDATA)">Event#EVENTDATA</a> Event </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE).Players" >
<strong>TASK_BASE.Players</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(TASK_BASE).Processes" >
<strong>TASK_BASE.Processes</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE).RemoveProcesses" >
<strong>TASK_BASE:RemoveProcesses(TaskUnit, FailProcesses)</strong>
</a>
</dt>
<dd>
<p>Remove Processes from <a href="Task.html">Task</a> with key <a href="Unit.html">Unit</a></p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em> TaskUnit </em></code>: </p>
</li>
<li>
<p><code><em> FailProcesses </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(TASK_BASE)">#TASK_BASE</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE).RemoveStateMachines" >
<strong>TASK_BASE:RemoveStateMachines(TaskUnit)</strong>
</a>
</dt>
<dd>
<p>Remove FiniteStateMachines from <a href="Task.html">Task</a> with key <a href="Unit.html">Unit</a></p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> TaskUnit </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(TASK_BASE)">#TASK_BASE</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(TASK_BASE).Scores" >
<strong>TASK_BASE.Scores</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE).SetBriefing" >
<strong>TASK_BASE:SetBriefing(TaskBriefing)</strong>
</a>
</dt>
<dd>
<p>Sets a <a href="Task.html">Task</a> briefing.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#string TaskBriefing </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p>self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE).SetCategory" >
<strong>TASK_BASE:SetCategory(TaskCategory)</strong>
</a>
</dt>
<dd>
<p>Sets the Category of the Task</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#string TaskCategory </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE).SetID" >
<strong>TASK_BASE:SetID(TaskID)</strong>
</a>
</dt>
<dd>
<p>Sets the ID of the Task</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#string TaskID </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE).SetName" >
<strong>TASK_BASE:SetName(TaskName)</strong>
</a>
</dt>
<dd>
<p>Sets the Name of the Task</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#string TaskName </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE).SetType" >
<strong>TASK_BASE:SetType(TaskType)</strong>
</a>
</dt>
<dd>
<p>Sets the Type of the Task</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#string TaskType </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE).StateAssigned" >
<strong>TASK_BASE:StateAssigned()</strong>
</a>
</dt>
<dd>
<p>Sets a <a href="Task.html">Task</a> to status <strong>Assigned</strong>.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE).StateFailed" >
<strong>TASK_BASE:StateFailed()</strong>
</a>
</dt>
<dd>
<p>Sets a <a href="Task.html">Task</a> to status <strong>Failed</strong>.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE).StateHold" >
<strong>TASK_BASE:StateHold()</strong>
</a>
</dt>
<dd>
<p>Sets a <a href="Task.html">Task</a> to status <strong>Hold</strong>.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE).StatePlanned" >
<strong>TASK_BASE:StatePlanned()</strong>
</a>
</dt>
<dd>
<p>Sets a <a href="Task.html">Task</a> to status <strong>Planned</strong>.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE).StateReplanned" >
<strong>TASK_BASE:StateReplanned()</strong>
</a>
</dt>
<dd>
<p>Sets a <a href="Task.html">Task</a> to status <strong>Replanned</strong>.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE).StateSuccess" >
<strong>TASK_BASE:StateSuccess()</strong>
</a>
</dt>
<dd>
<p>Sets a <a href="Task.html">Task</a> to status <strong>Success</strong>.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(TASK_BASE).TaskBriefing" >
<strong>TASK_BASE.TaskBriefing</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(TASK_BASE).TaskCategory" >
<strong>TASK_BASE.TaskCategory</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(TASK_BASE).TaskID" >
<strong>TASK_BASE.TaskID</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(TASK_BASE).TaskName" >
<strong>TASK_BASE.TaskName</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Scheduler.html##(SCHEDULER)">Scheduler#SCHEDULER</a></em>
<a id="#(TASK_BASE).TaskScheduler" >
<strong>TASK_BASE.TaskScheduler</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(TASK_BASE).TaskType" >
<strong>TASK_BASE.TaskType</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(TASK_BASE).TaskUnit" >
<strong>TASK_BASE.TaskUnit</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE).UnAssignFromUnit" >
<strong>TASK_BASE:UnAssignFromUnit(TaskUnit, FailProcesses)</strong>
</a>
</dt>
<dd>
<p>UnAssign the <a href="Task.html">Task</a> from an alive <a href="Unit.html">Unit</a>.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Unit.html##(UNIT)">Unit#UNIT</a> TaskUnit </em></code>: </p>
</li>
<li>
<p><code><em> FailProcesses </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(TASK_BASE)">#TASK_BASE</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE)._EventAssignUnit" >
<strong>TASK_BASE:_EventAssignUnit(Event)</strong>
</a>
</dt>
<dd>
<p>Register a potential new assignment for a new spawned <a href="Unit.html">Unit</a>.</p>
<p>Tasks only get assigned if there are players in it.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Event.html##(EVENTDATA)">Event#EVENTDATA</a> Event </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(TASK_BASE)">#TASK_BASE</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE)._EventUnAssignUnit" >
<strong>TASK_BASE:_EventUnAssignUnit(Event)</strong>
</a>
</dt>
<dd>
<p>UnAssigns a <a href="Unit.html">Unit</a> that is left by a player, crashed, dead, ....</p>
<p>There are only assignments if there are players in it.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Event.html##(EVENTDATA)">Event#EVENTDATA</a> Event </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(TASK_BASE)">#TASK_BASE</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE)._Schedule" >
<strong>TASK_BASE:_Schedule()</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_BASE)._Scheduler" >
<strong>TASK_BASE:_Scheduler()</strong>
</a>
</dt>
<dd>
</dd>
</dl>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink