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/docs/Documentation/Mission.html
FlightControl_Master 74951f4237 Documentation
2017-10-26 11:17:11 +02:00

2775 lines
56 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="AI_A2A.html">AI_A2A</a></li>
<li><a href="AI_A2A_Cap.html">AI_A2A_Cap</a></li>
<li><a href="AI_A2A_Dispatcher.html">AI_A2A_Dispatcher</a></li>
<li><a href="AI_A2A_GCI.html">AI_A2A_GCI</a></li>
<li><a href="AI_A2A_Patrol.html">AI_A2A_Patrol</a></li>
<li><a href="AI_Bai.html">AI_Bai</a></li>
<li><a href="AI_Balancer.html">AI_Balancer</a></li>
<li><a href="AI_Cap.html">AI_Cap</a></li>
<li><a href="AI_Cas.html">AI_Cas</a></li>
<li><a href="AI_Formation.html">AI_Formation</a></li>
<li><a href="AI_Patrol.html">AI_Patrol</a></li>
<li><a href="ATC_Ground.html">ATC_Ground</a></li>
<li><a href="Account.html">Account</a></li>
<li><a href="Airbase.html">Airbase</a></li>
<li><a href="Assign.html">Assign</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="CommandCenter.html">CommandCenter</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="DCSVec3.html">DCSVec3</a></li>
<li><a href="DCSWorld.html">DCSWorld</a></li>
<li><a href="DCSZone.html">DCSZone</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="Database.html">Database</a></li>
<li><a href="Designate.html">Designate</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="Fsm.html">Fsm</a></li>
<li><a href="Goal.html">Goal</a></li>
<li><a href="Group.html">Group</a></li>
<li><a href="Identifiable.html">Identifiable</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>Mission</li>
<li><a href="Movement.html">Movement</a></li>
<li><a href="Object.html">Object</a></li>
<li><a href="Point.html">Point</a></li>
<li><a href="Positionable.html">Positionable</a></li>
<li><a href="Process_JTAC.html">Process_JTAC</a></li>
<li><a href="Process_Pickup.html">Process_Pickup</a></li>
<li><a href="Protect.html">Protect</a></li>
<li><a href="Radio.html">Radio</a></li>
<li><a href="Rat.html">Rat</a></li>
<li><a href="Route.html">Route</a></li>
<li><a href="Scenery.html">Scenery</a></li>
<li><a href="ScheduleDispatcher.html">ScheduleDispatcher</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="Settings.html">Settings</a></li>
<li><a href="Smoke.html">Smoke</a></li>
<li><a href="Spawn.html">Spawn</a></li>
<li><a href="SpawnStatic.html">SpawnStatic</a></li>
<li><a href="Spot.html">Spot</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="TaskZoneCapture.html">TaskZoneCapture</a></li>
<li><a href="Task_A2A.html">Task_A2A</a></li>
<li><a href="Task_A2A_Dispatcher.html">Task_A2A_Dispatcher</a></li>
<li><a href="Task_A2G.html">Task_A2G</a></li>
<li><a href="Task_A2G_Dispatcher.html">Task_A2G_Dispatcher</a></li>
<li><a href="Task_Cargo.html">Task_Cargo</a></li>
<li><a href="Task_PICKUP.html">Task_PICKUP</a></li>
<li><a href="Unit.html">Unit</a></li>
<li><a href="UserFlag.html">UserFlag</a></li>
<li><a href="UserSound.html">UserSound</a></li>
<li><a href="Utils.html">Utils</a></li>
<li><a href="Zone.html">Zone</a></li>
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</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>Mission</code></h1>
<p><strong>Tasking</strong> -- A MISSION is the main owner of a Mission orchestration within MOOSE.</p>
<hr/>
<h3>Author: <strong>Sven Van de Velde (FlightControl)</strong></h3>
<h3>Contributions:</h3>
<hr/>
<h2>Global(s)</h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="#MISSION">MISSION</a></td>
<td class="summary">
</td>
</tr>
</table>
<h2><a id="#(MISSION)">Type <code>MISSION</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).AbortUnit">MISSION:AbortUnit(PlayerUnit)</a></td>
<td class="summary">
<p>Aborts a PlayerUnit from the Mission.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).AddPlayerName">MISSION:AddPlayerName(PlayerName)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).AddScoring">MISSION:AddScoring(Scoring)</a></td>
<td class="summary">
<p>Add a scoring to the mission.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).AddTask">MISSION:AddTask(Task)</a></td>
<td class="summary">
<p>Register a <a href="Task.html">Task</a> to be completed within the <a href="Mission.html">Mission</a>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).AssignedGroups">MISSION.AssignedGroups</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).ClassName">MISSION.ClassName</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).ClearGroupAssignment">MISSION:ClearGroupAssignment(MissionGroup)</a></td>
<td class="summary">
<p>Clear the <a href="Group.html">Group</a> assignment from the <a href="Mission.html">Mission</a>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).Complete">MISSION:Complete()</a></td>
<td class="summary">
<p>Synchronous Event Trigger for Event Complete.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).CrashUnit">MISSION:CrashUnit(PlayerUnit)</a></td>
<td class="summary">
<p>Handles a crash of a PlayerUnit from the Mission.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).Fail">MISSION:Fail()</a></td>
<td class="summary">
<p>Synchronous Event Trigger for Event Fail.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).GetCommandCenter">MISSION:GetCommandCenter()</a></td>
<td class="summary">
<p>Gets the COMMANDCENTER.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).GetGroups">MISSION:GetGroups()</a></td>
<td class="summary">
<p>Get the groups for which TASKS are given in the mission</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).GetMenu">MISSION:GetMenu(TaskGroup)</a></td>
<td class="summary">
<p>Gets the mission menu for the TaskGroup.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).GetName">MISSION:GetName()</a></td>
<td class="summary">
<p>Gets the mission name.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).GetNextTaskID">MISSION:GetNextTaskID(Task)</a></td>
<td class="summary">
<p>Return the next <a href="Task.html">Task</a> ID to be completed within the <a href="Mission.html">Mission</a>. </p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).GetPlayerNames">MISSION:GetPlayerNames()</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).GetRootMenu">MISSION:GetRootMenu(TaskGroup)</a></td>
<td class="summary">
<p>Gets the root mission menu for the TaskGroup.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).GetScoring">MISSION:GetScoring()</a></td>
<td class="summary">
<p>Get the scoring object of a mission.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).GetTask">MISSION.GetTask(TaskName, self)</a></td>
<td class="summary">
<p>Get the TASK identified by the TaskNumber from the Mission.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).GetTaskTypes">MISSION:GetTaskTypes()</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).GetTasks">MISSION:GetTasks()</a></td>
<td class="summary">
<p>Get all the TASKs from the Mission.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).GetTasksRemaining">MISSION:GetTasksRemaining()</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).HasGroup">MISSION.HasGroup(#, self, TaskGroup)</a></td>
<td class="summary">
<p>Validates if the Mission has a Group</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).IsCOMPLETED">MISSION:IsCOMPLETED()</a></td>
<td class="summary">
<p>Is the <a href="Mission.html">Mission</a> <strong>COMPLETED</strong>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).IsENGAGED">MISSION:IsENGAGED()</a></td>
<td class="summary">
<p>Is the <a href="Mission.html">Mission</a> <strong>ENGAGED</strong>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).IsFAILED">MISSION:IsFAILED()</a></td>
<td class="summary">
<p>Is the <a href="Mission.html">Mission</a> <strong>FAILED</strong>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).IsGroupAssigned">MISSION:IsGroupAssigned(MissionGroup)</a></td>
<td class="summary">
<p>Returns if the <a href="Mission.html">Mission</a> is assigned to the Group.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).IsHOLD">MISSION:IsHOLD()</a></td>
<td class="summary">
<p>Is the <a href="Mission.html">Mission</a> <strong>HOLD</strong>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).IsIDLE">MISSION:IsIDLE()</a></td>
<td class="summary">
<p>Is the <a href="Mission.html">Mission</a> <strong>IDLE</strong>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).JoinUnit">MISSION:JoinUnit(PlayerUnit, PlayerGroup)</a></td>
<td class="summary">
<p>Add a Unit to join the Mission.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).MenuReportBriefing">MISSION:MenuReportBriefing(ReportGroup)</a></td>
<td class="summary">
<p>Reports the briefing.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).MenuReportPlayersPerTask">MISSION:MenuReportPlayersPerTask(ReportGroup)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).MenuReportPlayersProgress">MISSION:MenuReportPlayersProgress(ReportGroup)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).MenuReportTasksPerStatus">MISSION:MenuReportTasksPerStatus(TaskStatus, ReportGroup)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).MenuReportTasksSummary">MISSION:MenuReportTasksSummary(ReportGroup)</a></td>
<td class="summary">
<p>Report the task summary.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).MissionBriefing">MISSION.MissionBriefing</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).MissionGoals">MISSION:MissionGoals()</a></td>
<td class="summary">
<p>MissionGoals Trigger for MISSION</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).MissionGroupMenu">MISSION.MissionGroupMenu</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).MissionMenu">MISSION.MissionMenu</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).MissionStatus">MISSION.MissionStatus</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).Name">MISSION.Name</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).New">MISSION:New(CommandCenter, MissionName, MissionPriority, MissionBriefing, MissionCoalition)</a></td>
<td class="summary">
<p>This is the main MISSION declaration method.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).OnAfterComplete">MISSION:OnAfterComplete(From, Event, To)</a></td>
<td class="summary">
<p>OnAfter Transition Handler for Event Complete.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).OnAfterFail">MISSION:OnAfterFail(From, Event, To)</a></td>
<td class="summary">
<p>OnAfter Transition Handler for Event Fail.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).OnAfterMissionGoals">MISSION:OnAfterMissionGoals(From, Event, To)</a></td>
<td class="summary">
<p>MissionGoals Handler OnAfter for MISSION</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).OnAfterStart">MISSION:OnAfterStart(From, Event, To)</a></td>
<td class="summary">
<p>OnAfter Transition Handler for Event Start.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).OnAfterStop">MISSION:OnAfterStop(From, Event, To)</a></td>
<td class="summary">
<p>OnAfter Transition Handler for Event Stop.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).OnBeforeComplete">MISSION:OnBeforeComplete(From, Event, To)</a></td>
<td class="summary">
<p>OnBefore Transition Handler for Event Complete.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).OnBeforeFail">MISSION:OnBeforeFail(From, Event, To)</a></td>
<td class="summary">
<p>OnBefore Transition Handler for Event Fail.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).OnBeforeMissionGoals">MISSION:OnBeforeMissionGoals(From, Event, To)</a></td>
<td class="summary">
<p>MissionGoals Handler OnBefore for MISSION</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).OnBeforeStart">MISSION:OnBeforeStart(From, Event, To)</a></td>
<td class="summary">
<p>OnBefore Transition Handler for Event Start.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).OnBeforeStop">MISSION:OnBeforeStop(From, Event, To)</a></td>
<td class="summary">
<p>OnBefore Transition Handler for Event Stop.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).OnEnterCOMPLETED">MISSION:OnEnterCOMPLETED(From, Event, To)</a></td>
<td class="summary">
<p>OnEnter Transition Handler for State COMPLETED.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).OnEnterENGAGED">MISSION:OnEnterENGAGED(From, Event, To)</a></td>
<td class="summary">
<p>OnEnter Transition Handler for State ENGAGED.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).OnEnterFAILED">MISSION:OnEnterFAILED(From, Event, To)</a></td>
<td class="summary">
<p>OnEnter Transition Handler for State FAILED.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).OnEnterIDLE">MISSION:OnEnterIDLE(From, Event, To)</a></td>
<td class="summary">
<p>OnEnter Transition Handler for State IDLE.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).OnLeaveCOMPLETED">MISSION:OnLeaveCOMPLETED(From, Event, To)</a></td>
<td class="summary">
<p>OnLeave Transition Handler for State COMPLETED.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).OnLeaveENGAGED">MISSION:OnLeaveENGAGED(From, Event, To)</a></td>
<td class="summary">
<p>OnLeave Transition Handler for State ENGAGED.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).OnLeaveFAILED">MISSION:OnLeaveFAILED(From, Event, To)</a></td>
<td class="summary">
<p>OnLeave Transition Handler for State FAILED.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).OnLeaveIDLE">MISSION:OnLeaveIDLE(From, Event, To)</a></td>
<td class="summary">
<p>OnLeave Transition Handler for State IDLE.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).RemoveMenu">MISSION:RemoveMenu(MenuTime)</a></td>
<td class="summary">
<p>Removes the Planned Task menu.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).RemoveTask">MISSION:RemoveTask(Task)</a></td>
<td class="summary">
<p>Removes a <a href="Task.html">Task</a> to be completed within the <a href="Mission.html">Mission</a>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).RemoveTaskMenu">MISSION:RemoveTaskMenu(Task)</a></td>
<td class="summary">
<p>Removes a Task menu.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).ReportBriefing">MISSION:ReportBriefing()</a></td>
<td class="summary">
<p>Create a briefing report of the Mission.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).ReportDetails">MISSION:ReportDetails(ReportGroup)</a></td>
<td class="summary">
<p>Create a detailed report of the Mission, listing all the details of the Task.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).ReportOverview">MISSION:ReportOverview(ReportGroup, TaskStatus)</a></td>
<td class="summary">
<p>Create a overview report of the Mission (multiple lines).</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).ReportPlayersPerTask">MISSION:ReportPlayersPerTask(ReportGroup)</a></td>
<td class="summary">
<p>Create an active player report of the Mission.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).ReportPlayersProgress">MISSION:ReportPlayersProgress(ReportGroup)</a></td>
<td class="summary">
<p>Create an Mission Progress report of the Mission.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).ReportStatus">MISSION:ReportStatus()</a></td>
<td class="summary">
<p>Create a status report of the Mission.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).ReportSummary">MISSION:ReportSummary(ReportGroup)</a></td>
<td class="summary">
<p>Create a summary report of the Mission (one line).</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).Scoring">MISSION.Scoring</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).SetGroupAssigned">MISSION:SetGroupAssigned(MissionGroup)</a></td>
<td class="summary">
<p>Set <a href="Group.html">Group</a> assigned to the <a href="Mission.html">Mission</a>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).SetMenu">MISSION:SetMenu(MenuTime)</a></td>
<td class="summary">
<p>Sets the Planned Task menu.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).Start">MISSION:Start()</a></td>
<td class="summary">
<p>Synchronous Event Trigger for Event Start.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).Stop">MISSION:Stop()</a></td>
<td class="summary">
<p>Synchronous Event Trigger for Event Stop.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION)._Clients">MISSION._Clients</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).__Complete">MISSION:__Complete(Delay)</a></td>
<td class="summary">
<p>Asynchronous Event Trigger for Event Complete.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).__Fail">MISSION:__Fail(Delay)</a></td>
<td class="summary">
<p>Asynchronous Event Trigger for Event Fail.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).__MissionGoals">MISSION:__MissionGoals(Delay)</a></td>
<td class="summary">
<p>MissionGoals Asynchronous Trigger for MISSION</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).__Start">MISSION:__Start(Delay)</a></td>
<td class="summary">
<p>Asynchronous Event Trigger for Event Start.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).__Stop">MISSION:__Stop(Delay)</a></td>
<td class="summary">
<p>Asynchronous Event Trigger for Event Stop.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).onenterCOMPLETED">MISSION:onenterCOMPLETED(From, Event, To)</a></td>
<td class="summary">
<p>FSM function for a MISSION</p>
</td>
</tr>
</table>
<h2>Global(s)</h2>
<dl class="function">
<dt>
<em><a href="##(MISSION)">#MISSION</a></em>
<a id="MISSION" >
<strong>MISSION</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<h2><a id="#(Mission)" >Type <code>Mission</code></a></h2>
<h2><a id="#(MISSION)" >Type <code>MISSION</code></a></h2>
<p>The MISSION class</p>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<a id="#(MISSION).AbortUnit" >
<strong>MISSION:AbortUnit(PlayerUnit)</strong>
</a>
</dt>
<dd>
<p>Aborts a PlayerUnit from the Mission.</p>
<p>For each Task within the Mission, the PlayerUnit is removed from Task where it is assigned.
If the Unit was not part of a Task in the Mission, false is returned.
If the Unit is part of a Task in the Mission, true is returned.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> PlayerUnit </em></code>:
The CLIENT or UNIT of the Player joining the Mission.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(MISSION)">#MISSION</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).AddPlayerName" >
<strong>MISSION:AddPlayerName(PlayerName)</strong>
</a>
</dt>
<dd>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> PlayerName </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).AddScoring" >
<strong>MISSION:AddScoring(Scoring)</strong>
</a>
</dt>
<dd>
<p>Add a scoring to the mission.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> Scoring </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(MISSION)">#MISSION</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).AddTask" >
<strong>MISSION:AddTask(Task)</strong>
</a>
</dt>
<dd>
<p>Register a <a href="Task.html">Task</a> to be completed within the <a href="Mission.html">Mission</a>.</p>
<p>Note that there can be multiple <a href="Task.html">Task</a>s registered to be completed.
Each Task can be set a certain Goals. The Mission will not be completed until all Goals are reached.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Tasking.Task.html##(TASK)">Tasking.Task#TASK</a> Task </em></code>:
is the <a href="Task.html">Task</a> object.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="Tasking.Task.html##(TASK)">Tasking.Task#TASK</a>:</em>
The task added.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(MISSION).AssignedGroups" >
<strong>MISSION.AssignedGroups</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(MISSION).ClassName" >
<strong>MISSION.ClassName</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).ClearGroupAssignment" >
<strong>MISSION:ClearGroupAssignment(MissionGroup)</strong>
</a>
</dt>
<dd>
<p>Clear the <a href="Group.html">Group</a> assignment from the <a href="Mission.html">Mission</a>.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> MissionGroup </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(MISSION)">#MISSION</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).Complete" >
<strong>MISSION:Complete()</strong>
</a>
</dt>
<dd>
<p>Synchronous Event Trigger for Event Complete.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).CrashUnit" >
<strong>MISSION:CrashUnit(PlayerUnit)</strong>
</a>
</dt>
<dd>
<p>Handles a crash of a PlayerUnit from the Mission.</p>
<p>For each Task within the Mission, the PlayerUnit is removed from Task where it is assigned.
If the Unit was not part of a Task in the Mission, false is returned.
If the Unit is part of a Task in the Mission, true is returned.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> PlayerUnit </em></code>:
The CLIENT or UNIT of the Player crashing.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(MISSION)">#MISSION</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).Fail" >
<strong>MISSION:Fail()</strong>
</a>
</dt>
<dd>
<p>Synchronous Event Trigger for Event Fail.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).GetCommandCenter" >
<strong>MISSION:GetCommandCenter()</strong>
</a>
</dt>
<dd>
<p>Gets the COMMANDCENTER.</p>
<h3>Return value</h3>
<p><em><a href="Tasking.CommandCenter.html##(COMMANDCENTER)">Tasking.CommandCenter#COMMANDCENTER</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).GetGroups" >
<strong>MISSION:GetGroups()</strong>
</a>
</dt>
<dd>
<p>Get the groups for which TASKS are given in the mission</p>
<h3>Return value</h3>
<p><em><a href="Core.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).GetMenu" >
<strong>MISSION:GetMenu(TaskGroup)</strong>
</a>
</dt>
<dd>
<p>Gets the mission menu for the TaskGroup.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> TaskGroup </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="Core.Menu.html##(MENU_COALITION)">Core.Menu#MENU_COALITION</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).GetName" >
<strong>MISSION:GetName()</strong>
</a>
</dt>
<dd>
<p>Gets the mission name.</p>
<h3>Return value</h3>
<p><em><a href="##(MISSION)">#MISSION</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).GetNextTaskID" >
<strong>MISSION:GetNextTaskID(Task)</strong>
</a>
</dt>
<dd>
<p>Return the next <a href="Task.html">Task</a> ID to be completed within the <a href="Mission.html">Mission</a>. </p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Tasking.Task.html##(TASK)">Tasking.Task#TASK</a> Task </em></code>:
is the <a href="Task.html">Task</a> object.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="Tasking.Task.html##(TASK)">Tasking.Task#TASK</a>:</em>
The task added.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).GetPlayerNames" >
<strong>MISSION:GetPlayerNames()</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).GetRootMenu" >
<strong>MISSION:GetRootMenu(TaskGroup)</strong>
</a>
</dt>
<dd>
<p>Gets the root mission menu for the TaskGroup.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> TaskGroup </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="Core.Menu.html##(MENU_COALITION)">Core.Menu#MENU_COALITION</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).GetScoring" >
<strong>MISSION:GetScoring()</strong>
</a>
</dt>
<dd>
<p>Get the scoring object of a mission.</p>
<h3>Return value</h3>
<p><em><a href="##(SCORING)">#SCORING</a>:</em>
Scoring</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).GetTask" >
<strong>MISSION.GetTask(TaskName, self)</strong>
</a>
</dt>
<dd>
<p>Get the TASK identified by the TaskNumber from the Mission.</p>
<p>This function is useful in GoalFunctions.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string TaskName </em></code>:
The Name of the <a href="Task.html">Task</a> within the <a href="Mission.html">Mission</a>.</p>
</li>
<li>
<p><code><em> self </em></code>: </p>
</li>
</ul>
<h3>Return values</h3>
<ol>
<li>
<p><em><a href="Tasking.Task.html##(TASK)">Tasking.Task#TASK</a>:</em>
The Task</p>
</li>
<li>
<p><em>#nil:</em>
Returns nil if no task was found.</p>
</li>
</ol>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).GetTaskTypes" >
<strong>MISSION:GetTaskTypes()</strong>
</a>
</dt>
<dd>
<h3>Return value</h3>
<p><em>#number:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).GetTasks" >
<strong>MISSION:GetTasks()</strong>
</a>
</dt>
<dd>
<p>Get all the TASKs from the Mission.</p>
<p>This function is useful in GoalFunctions.</p>
<h3>Return value</h3>
<p>{TASK,...} Structure of TASKS with the <a href="TASK.html">TASK</a> number as the key.</p>
<h3>Usage:</h3>
<pre class="example"><code>-- Get Tasks from the Mission.
Tasks = Mission:GetTasks()
env.info( "Task 2 Completion = " .. Tasks[2]:GetGoalPercentage() .. "%" )</code></pre>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).GetTasksRemaining" >
<strong>MISSION:GetTasksRemaining()</strong>
</a>
</dt>
<dd>
<h3>Return value</h3>
<p><em>#number:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).HasGroup" >
<strong>MISSION.HasGroup(#, self, TaskGroup)</strong>
</a>
</dt>
<dd>
<p>Validates if the Mission has a Group</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em> # </em></code>:
ISSION</p>
</li>
<li>
<p><code><em> self </em></code>: </p>
</li>
<li>
<p><code><em> TaskGroup </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#boolean:</em>
true if the Mission has a Group.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).IsCOMPLETED" >
<strong>MISSION:IsCOMPLETED()</strong>
</a>
</dt>
<dd>
<p>Is the <a href="Mission.html">Mission</a> <strong>COMPLETED</strong>.</p>
<h3>Return value</h3>
<p><em>#boolean:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).IsENGAGED" >
<strong>MISSION:IsENGAGED()</strong>
</a>
</dt>
<dd>
<p>Is the <a href="Mission.html">Mission</a> <strong>ENGAGED</strong>.</p>
<h3>Return value</h3>
<p><em>#boolean:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).IsFAILED" >
<strong>MISSION:IsFAILED()</strong>
</a>
</dt>
<dd>
<p>Is the <a href="Mission.html">Mission</a> <strong>FAILED</strong>.</p>
<h3>Return value</h3>
<p><em>#boolean:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).IsGroupAssigned" >
<strong>MISSION:IsGroupAssigned(MissionGroup)</strong>
</a>
</dt>
<dd>
<p>Returns if the <a href="Mission.html">Mission</a> is assigned to the Group.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> MissionGroup </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#boolean:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).IsHOLD" >
<strong>MISSION:IsHOLD()</strong>
</a>
</dt>
<dd>
<p>Is the <a href="Mission.html">Mission</a> <strong>HOLD</strong>.</p>
<h3>Return value</h3>
<p><em>#boolean:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).IsIDLE" >
<strong>MISSION:IsIDLE()</strong>
</a>
</dt>
<dd>
<p>Is the <a href="Mission.html">Mission</a> <strong>IDLE</strong>.</p>
<h3>Return value</h3>
<p><em>#boolean:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).JoinUnit" >
<strong>MISSION:JoinUnit(PlayerUnit, PlayerGroup)</strong>
</a>
</dt>
<dd>
<p>Add a Unit to join the Mission.</p>
<p>For each Task within the Mission, the Unit is joined with the Task.
If the Unit was not part of a Task in the Mission, false is returned.
If the Unit is part of a Task in the Mission, true is returned.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> PlayerUnit </em></code>:
The CLIENT or UNIT of the Player joining the Mission.</p>
</li>
<li>
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> PlayerGroup </em></code>:
The GROUP of the player joining the Mission.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#boolean:</em>
true if Unit is part of a Task in the Mission.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).MenuReportBriefing" >
<strong>MISSION:MenuReportBriefing(ReportGroup)</strong>
</a>
</dt>
<dd>
<p>Reports the briefing.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> ReportGroup </em></code>:
The group to which the report needs to be sent.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).MenuReportPlayersPerTask" >
<strong>MISSION:MenuReportPlayersPerTask(ReportGroup)</strong>
</a>
</dt>
<dd>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> ReportGroup </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).MenuReportPlayersProgress" >
<strong>MISSION:MenuReportPlayersProgress(ReportGroup)</strong>
</a>
</dt>
<dd>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> ReportGroup </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).MenuReportTasksPerStatus" >
<strong>MISSION:MenuReportTasksPerStatus(TaskStatus, ReportGroup)</strong>
</a>
</dt>
<dd>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string TaskStatus </em></code>:
The status</p>
</li>
<li>
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> ReportGroup </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).MenuReportTasksSummary" >
<strong>MISSION:MenuReportTasksSummary(ReportGroup)</strong>
</a>
</dt>
<dd>
<p>Report the task summary.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> ReportGroup </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(MISSION).MissionBriefing" >
<strong>MISSION.MissionBriefing</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).MissionGoals" >
<strong>MISSION:MissionGoals()</strong>
</a>
</dt>
<dd>
<p>MissionGoals Trigger for MISSION</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).MissionGroupMenu" >
<strong>MISSION.MissionGroupMenu</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Core.Menu.html##(MENU_COALITION)">Core.Menu#MENU_COALITION</a></em>
<a id="#(MISSION).MissionMenu" >
<strong>MISSION.MissionMenu</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(MISSION).MissionStatus" >
<strong>MISSION.MissionStatus</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(MISSION).Name" >
<strong>MISSION.Name</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).New" >
<strong>MISSION:New(CommandCenter, MissionName, MissionPriority, MissionBriefing, MissionCoalition)</strong>
</a>
</dt>
<dd>
<p>This is the main MISSION declaration method.</p>
<p>Each Mission is like the master or a Mission orchestration between, Clients, Tasks, Stages etc.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Tasking.CommandCenter.html##(COMMANDCENTER)">Tasking.CommandCenter#COMMANDCENTER</a> CommandCenter </em></code>: </p>
</li>
<li>
<p><code><em>#string MissionName </em></code>:
is the name of the mission. This name will be used to reference the status of each mission by the players.</p>
</li>
<li>
<p><code><em>#string MissionPriority </em></code>:
is a string indicating the "priority" of the Mission. f.e. "Primary", "Secondary" or "First", "Second". It is free format and up to the Mission designer to choose. There are no rules behind this field.</p>
</li>
<li>
<p><code><em>#string MissionBriefing </em></code>:
is a string indicating the mission briefing to be shown when a player joins a <a href="CLIENT.html">CLIENT</a>.</p>
</li>
<li>
<p><code><em><a href="Dcs.DCSCoalitionWrapper.Object.html##(coalition)">Dcs.DCSCoalitionWrapper.Object#coalition</a> MissionCoalition </em></code>:
is a string indicating the coalition or party to which this mission belongs to. It is free format and can be chosen freely by the mission designer. Note that this field is not to be confused with the coalition concept of the ME. Examples of a Mission Coalition could be "NATO", "CCCP", "Intruders", "Terrorists"...</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(MISSION)">#MISSION</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).OnAfterComplete" >
<strong>MISSION:OnAfterComplete(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>OnAfter Transition Handler for Event Complete.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>:
The From State string.</p>
</li>
<li>
<p><code><em>#string Event </em></code>:
The Event string.</p>
</li>
<li>
<p><code><em>#string To </em></code>:
The To State string.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).OnAfterFail" >
<strong>MISSION:OnAfterFail(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>OnAfter Transition Handler for Event Fail.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>:
The From State string.</p>
</li>
<li>
<p><code><em>#string Event </em></code>:
The Event string.</p>
</li>
<li>
<p><code><em>#string To </em></code>:
The To State string.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).OnAfterMissionGoals" >
<strong>MISSION:OnAfterMissionGoals(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>MissionGoals Handler OnAfter for MISSION</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>: </p>
</li>
<li>
<p><code><em>#string Event </em></code>: </p>
</li>
<li>
<p><code><em>#string To </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).OnAfterStart" >
<strong>MISSION:OnAfterStart(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>OnAfter Transition Handler for Event Start.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>:
The From State string.</p>
</li>
<li>
<p><code><em>#string Event </em></code>:
The Event string.</p>
</li>
<li>
<p><code><em>#string To </em></code>:
The To State string.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).OnAfterStop" >
<strong>MISSION:OnAfterStop(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>OnAfter Transition Handler for Event Stop.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>:
The From State string.</p>
</li>
<li>
<p><code><em>#string Event </em></code>:
The Event string.</p>
</li>
<li>
<p><code><em>#string To </em></code>:
The To State string.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).OnBeforeComplete" >
<strong>MISSION:OnBeforeComplete(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>OnBefore Transition Handler for Event Complete.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>:
The From State string.</p>
</li>
<li>
<p><code><em>#string Event </em></code>:
The Event string.</p>
</li>
<li>
<p><code><em>#string To </em></code>:
The To State string.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#boolean:</em>
Return false to cancel Transition.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).OnBeforeFail" >
<strong>MISSION:OnBeforeFail(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>OnBefore Transition Handler for Event Fail.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>:
The From State string.</p>
</li>
<li>
<p><code><em>#string Event </em></code>:
The Event string.</p>
</li>
<li>
<p><code><em>#string To </em></code>:
The To State string.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#boolean:</em>
Return false to cancel Transition.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).OnBeforeMissionGoals" >
<strong>MISSION:OnBeforeMissionGoals(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>MissionGoals Handler OnBefore for MISSION</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>: </p>
</li>
<li>
<p><code><em>#string Event </em></code>: </p>
</li>
<li>
<p><code><em>#string To </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#boolean:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).OnBeforeStart" >
<strong>MISSION:OnBeforeStart(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>OnBefore Transition Handler for Event Start.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>:
The From State string.</p>
</li>
<li>
<p><code><em>#string Event </em></code>:
The Event string.</p>
</li>
<li>
<p><code><em>#string To </em></code>:
The To State string.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#boolean:</em>
Return false to cancel Transition.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).OnBeforeStop" >
<strong>MISSION:OnBeforeStop(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>OnBefore Transition Handler for Event Stop.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>:
The From State string.</p>
</li>
<li>
<p><code><em>#string Event </em></code>:
The Event string.</p>
</li>
<li>
<p><code><em>#string To </em></code>:
The To State string.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#boolean:</em>
Return false to cancel Transition.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).OnEnterCOMPLETED" >
<strong>MISSION:OnEnterCOMPLETED(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>OnEnter Transition Handler for State COMPLETED.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>:
The From State string.</p>
</li>
<li>
<p><code><em>#string Event </em></code>:
The Event string.</p>
</li>
<li>
<p><code><em>#string To </em></code>:
The To State string.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).OnEnterENGAGED" >
<strong>MISSION:OnEnterENGAGED(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>OnEnter Transition Handler for State ENGAGED.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>:
The From State string.</p>
</li>
<li>
<p><code><em>#string Event </em></code>:
The Event string.</p>
</li>
<li>
<p><code><em>#string To </em></code>:
The To State string.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).OnEnterFAILED" >
<strong>MISSION:OnEnterFAILED(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>OnEnter Transition Handler for State FAILED.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>:
The From State string.</p>
</li>
<li>
<p><code><em>#string Event </em></code>:
The Event string.</p>
</li>
<li>
<p><code><em>#string To </em></code>:
The To State string.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).OnEnterIDLE" >
<strong>MISSION:OnEnterIDLE(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>OnEnter Transition Handler for State IDLE.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>:
The From State string.</p>
</li>
<li>
<p><code><em>#string Event </em></code>:
The Event string.</p>
</li>
<li>
<p><code><em>#string To </em></code>:
The To State string.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).OnLeaveCOMPLETED" >
<strong>MISSION:OnLeaveCOMPLETED(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>OnLeave Transition Handler for State COMPLETED.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>:
The From State string.</p>
</li>
<li>
<p><code><em>#string Event </em></code>:
The Event string.</p>
</li>
<li>
<p><code><em>#string To </em></code>:
The To State string.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#boolean:</em>
Return false to cancel Transition.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).OnLeaveENGAGED" >
<strong>MISSION:OnLeaveENGAGED(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>OnLeave Transition Handler for State ENGAGED.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>:
The From State string.</p>
</li>
<li>
<p><code><em>#string Event </em></code>:
The Event string.</p>
</li>
<li>
<p><code><em>#string To </em></code>:
The To State string.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#boolean:</em>
Return false to cancel Transition.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).OnLeaveFAILED" >
<strong>MISSION:OnLeaveFAILED(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>OnLeave Transition Handler for State FAILED.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>:
The From State string.</p>
</li>
<li>
<p><code><em>#string Event </em></code>:
The Event string.</p>
</li>
<li>
<p><code><em>#string To </em></code>:
The To State string.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#boolean:</em>
Return false to cancel Transition.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).OnLeaveIDLE" >
<strong>MISSION:OnLeaveIDLE(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>OnLeave Transition Handler for State IDLE.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>:
The From State string.</p>
</li>
<li>
<p><code><em>#string Event </em></code>:
The Event string.</p>
</li>
<li>
<p><code><em>#string To </em></code>:
The To State string.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#boolean:</em>
Return false to cancel Transition.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).RemoveMenu" >
<strong>MISSION:RemoveMenu(MenuTime)</strong>
</a>
</dt>
<dd>
<p>Removes the Planned Task menu.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#number MenuTime </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).RemoveTask" >
<strong>MISSION:RemoveTask(Task)</strong>
</a>
</dt>
<dd>
<p>Removes a <a href="Task.html">Task</a> to be completed within the <a href="Mission.html">Mission</a>.</p>
<p>Note that there can be multiple <a href="Task.html">Task</a>s registered to be completed.
Each Task can be set a certain Goals. The Mission will not be completed until all Goals are reached.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Tasking.Task.html##(TASK)">Tasking.Task#TASK</a> Task </em></code>:
is the <a href="Task.html">Task</a> object.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#nil:</em>
The cleaned Task reference.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).RemoveTaskMenu" >
<strong>MISSION:RemoveTaskMenu(Task)</strong>
</a>
</dt>
<dd>
<p>Removes a Task menu.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Tasking.Task.html##(TASK)">Tasking.Task#TASK</a> Task </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(MISSION)">#MISSION</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).ReportBriefing" >
<strong>MISSION:ReportBriefing()</strong>
</a>
</dt>
<dd>
<p>Create a briefing report of the Mission.</p>
<h3>Return value</h3>
<p><em>#string:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).ReportDetails" >
<strong>MISSION:ReportDetails(ReportGroup)</strong>
</a>
</dt>
<dd>
<p>Create a detailed report of the Mission, listing all the details of the Task.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> ReportGroup </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#string:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).ReportOverview" >
<strong>MISSION:ReportOverview(ReportGroup, TaskStatus)</strong>
</a>
</dt>
<dd>
<p>Create a overview report of the Mission (multiple lines).</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em> ReportGroup </em></code>: </p>
</li>
<li>
<p><code><em> TaskStatus </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#string:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).ReportPlayersPerTask" >
<strong>MISSION:ReportPlayersPerTask(ReportGroup)</strong>
</a>
</dt>
<dd>
<p>Create an active player report of the Mission.</p>
<p>This reports provides a one liner of the mission status. It indicates how many players and how many Tasks.</p>
<pre><code>Mission "&lt;MissionName&gt;" - &lt;MissionStatus&gt; - Active Players Report
- Player "&lt;PlayerName&gt;: Task &lt;TaskName&gt; &lt;TaskStatus&gt;, Task &lt;TaskName&gt; &lt;TaskStatus&gt;
- Player &lt;PlayerName&gt;: Task &lt;TaskName&gt; &lt;TaskStatus&gt;, Task &lt;TaskName&gt; &lt;TaskStatus&gt;
- ..
</code></pre>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> ReportGroup </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#string:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).ReportPlayersProgress" >
<strong>MISSION:ReportPlayersProgress(ReportGroup)</strong>
</a>
</dt>
<dd>
<p>Create an Mission Progress report of the Mission.</p>
<p>This reports provides a one liner per player of the mission achievements per task.</p>
<pre><code>Mission "&lt;MissionName&gt;" - &lt;MissionStatus&gt; - Active Players Report
- Player &lt;PlayerName&gt;: Task &lt;TaskName&gt; &lt;TaskStatus&gt;: &lt;Progress&gt;
- Player &lt;PlayerName&gt;: Task &lt;TaskName&gt; &lt;TaskStatus&gt;: &lt;Progress&gt;
- ..
</code></pre>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> ReportGroup </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#string:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).ReportStatus" >
<strong>MISSION:ReportStatus()</strong>
</a>
</dt>
<dd>
<p>Create a status report of the Mission.</p>
<p>This reports provides a one liner of the mission status. It indicates how many players and how many Tasks.</p>
<pre><code>Mission "&lt;MissionName&gt;" - Status "&lt;MissionStatus&gt;"
- Task Types: &lt;TaskType&gt;, &lt;TaskType&gt;
- &lt;xx&gt; Planned Tasks (xp)
- &lt;xx&gt; Assigned Tasks(xp)
- &lt;xx&gt; Success Tasks (xp)
- &lt;xx&gt; Hold Tasks (xp)
- &lt;xx&gt; Cancelled Tasks (xp)
- &lt;xx&gt; Aborted Tasks (xp)
- &lt;xx&gt; Failed Tasks (xp)
</code></pre>
<h3>Return value</h3>
<p><em>#string:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).ReportSummary" >
<strong>MISSION:ReportSummary(ReportGroup)</strong>
</a>
</dt>
<dd>
<p>Create a summary report of the Mission (one line).</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> ReportGroup </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#string:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(MISSION).Scoring" >
<strong>MISSION.Scoring</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).SetGroupAssigned" >
<strong>MISSION:SetGroupAssigned(MissionGroup)</strong>
</a>
</dt>
<dd>
<p>Set <a href="Group.html">Group</a> assigned to the <a href="Mission.html">Mission</a>.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> MissionGroup </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(MISSION)">#MISSION</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).SetMenu" >
<strong>MISSION:SetMenu(MenuTime)</strong>
</a>
</dt>
<dd>
<p>Sets the Planned Task menu.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#number MenuTime </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).Start" >
<strong>MISSION:Start()</strong>
</a>
</dt>
<dd>
<p>Synchronous Event Trigger for Event Start.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).Stop" >
<strong>MISSION:Stop()</strong>
</a>
</dt>
<dd>
<p>Synchronous Event Trigger for Event Stop.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="##(MISSION.Clients)">#MISSION.Clients</a></em>
<a id="#(MISSION)._Clients" >
<strong>MISSION._Clients</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).__Complete" >
<strong>MISSION:__Complete(Delay)</strong>
</a>
</dt>
<dd>
<p>Asynchronous Event Trigger for Event Complete.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#number Delay </em></code>:
The delay in seconds.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).__Fail" >
<strong>MISSION:__Fail(Delay)</strong>
</a>
</dt>
<dd>
<p>Asynchronous Event Trigger for Event Fail.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#number Delay </em></code>:
The delay in seconds.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).__MissionGoals" >
<strong>MISSION:__MissionGoals(Delay)</strong>
</a>
</dt>
<dd>
<p>MissionGoals Asynchronous Trigger for MISSION</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#number Delay </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).__Start" >
<strong>MISSION:__Start(Delay)</strong>
</a>
</dt>
<dd>
<p>Asynchronous Event Trigger for Event Start.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#number Delay </em></code>:
The delay in seconds.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).__Stop" >
<strong>MISSION:__Stop(Delay)</strong>
</a>
</dt>
<dd>
<p>Asynchronous Event Trigger for Event Stop.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#number Delay </em></code>:
The delay in seconds.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).onenterCOMPLETED" >
<strong>MISSION:onenterCOMPLETED(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>FSM function for a MISSION</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>: </p>
</li>
<li>
<p><code><em>#string Event </em></code>: </p>
</li>
<li>
<p><code><em>#string To </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<h2><a id="#(MISSION.Clients)" >Type <code>MISSION.Clients</code></a></h2>
<h2><a id="#(SCORING)" >Type <code>SCORING</code></a></h2>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink