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/Documentation/MISSION.html
FlightControl 9da2f56d37 Updated CLEANUP luadoc documentation.
2016-04-02 23:06:26 +02:00

1645 lines
36 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="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="DCSAirbase.html">DCSAirbase</a></li>
<li><a href="DCSCoalitionObject.html">DCSCoalitionObject</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="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="Escort.html">Escort</a></li>
<li><a href="GOHOMETASK.html">GOHOMETASK</a></li>
<li><a href="Group.html">Group</a></li>
<li>MISSION</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="NOTASK.html">NOTASK</a></li>
<li><a href="PICKUPTASK.html">PICKUPTASK</a></li>
<li><a href="ROUTETASK.html">ROUTETASK</a></li>
<li><a href="STAGE.html">STAGE</a></li>
<li><a href="Sead.html">Sead</a></li>
<li><a href="Spawn.html">Spawn</a></li>
<li><a href="StaticObject.html">StaticObject</a></li>
<li><a href="TASK.html">TASK</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>MISSION</code></h1>
<p>A MISSION is the main owner of a Mission orchestration within MOOSE .</p>
<p>The Mission framework orchestrates <a href="CLIENT.html">CLIENT</a>s, <a href="TASK.html">TASK</a>s, <a href="STAGE.html">STAGE</a>s etc.
A <a href="CLIENT.html">CLIENT</a> needs to be registered within the <a href="MISSION.html">MISSION</a> through the function <a href="AddClient.html">AddClient</a>. A <a href="TASK.html">TASK</a> needs to be registered within the <a href="MISSION.html">MISSION</a> through the function <a href="AddTask.html">AddTask</a>.</p>
<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>
<tr>
<td class="name" nowrap="nowrap"><a href="#MISSIONSCHEDULER">MISSIONSCHEDULER</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="#TaskComplete">TaskComplete</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="#_TransportExecuteStage">_TransportExecuteStage</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).AddClient">MISSION.AddClient(CLIENT, self, Client)</a></td>
<td class="summary">
<p>Register a new <a href="CLIENT.html">CLIENT</a> to participate within the mission.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).AddGoalFunction">MISSION.AddGoalFunction(function, self, GoalFunction)</a></td>
<td class="summary">
<p>Add a goal function to a MISSION.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).AddTask">MISSION:AddTask(Task, TaskNumber)</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).Completed">MISSION:Completed()</a></td>
<td class="summary">
<p>Set a Mission to completed.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).FAILED">MISSION.FAILED</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).Failed">MISSION:Failed()</a></td>
<td class="summary">
<p>Set a Mission to failed.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).FindClient">MISSION.FindClient(CLIENT, self, ClientName)</a></td>
<td class="summary">
<p>Find a <a href="CLIENT.html">CLIENT</a> object within the <a href="MISSION.html">MISSION</a> by its ClientName.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).GetTask">MISSION:GetTask(TaskNumber)</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).GoalFunction">MISSION.GoalFunction</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).IsCompleted">MISSION:IsCompleted()</a></td>
<td class="summary">
<p>Returns if a Mission has completed.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).IsFailed">MISSION:IsFailed()</a></td>
<td class="summary">
<p>Returns if a Mission has failed.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).IsOngoing">MISSION:IsOngoing()</a></td>
<td class="summary">
<p>Returns if a Mission is ongoing.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).IsPending">MISSION:IsPending()</a></td>
<td class="summary">
<p>Returns if a Mission is pending.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).Meta">MISSION:Meta()</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).MissionCoalition">MISSION.MissionCoalition</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).MissionProgressTrigger">MISSION.MissionProgressTrigger</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).MissionReportFlash">MISSION.MissionReportFlash</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).MissionReportShow">MISSION.MissionReportShow</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).MissionReportTrigger">MISSION.MissionReportTrigger</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).MissionTimeInterval">MISSION.MissionTimeInterval</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(string, string, string, string, self, 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).Ongoing">MISSION:Ongoing()</a></td>
<td class="summary">
<p>Set a Mission to ongoing.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).Pending">MISSION:Pending()</a></td>
<td class="summary">
<p>Set a Mission to pending.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).REPEAT">MISSION.REPEAT</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).ReportToAll">MISSION:ReportToAll()</a></td>
<td class="summary">
<p>Report the status of all MISSIONs to all active Clients.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).ReportTrigger">MISSION:ReportTrigger()</a></td>
<td class="summary">
<p>Handles the reporting.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).SUCCESS">MISSION.SUCCESS</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).ShowBriefing">MISSION.ShowBriefing(CLIENT, self, Client)</a></td>
<td class="summary">
<p>Show the briefing of the MISSION to the CLIENT.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION).StatusToClients">MISSION:StatusToClients()</a></td>
<td class="summary">
<p>Send the status of the MISSION to all Clients.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION)._ActiveTasks">MISSION._ActiveTasks</a></td>
<td class="summary">
</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)._GoalTasks">MISSION._GoalTasks</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSION)._Tasks">MISSION._Tasks</a></td>
<td class="summary">
</td>
</tr>
</table>
<h2><a id="#(MISSIONSCHEDULER)">Type <code>MISSIONSCHEDULER</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSIONSCHEDULER).AddMission">MISSIONSCHEDULER.AddMission(Mission)</a></td>
<td class="summary">
<p>This is the main MISSION declaration method.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSIONSCHEDULER).FindMission">MISSIONSCHEDULER.FindMission(MissionName)</a></td>
<td class="summary">
<p>Find a MISSION within the MISSIONSCHEDULER.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSIONSCHEDULER).MissionCount">MISSIONSCHEDULER.MissionCount</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSIONSCHEDULER).Missions">MISSIONSCHEDULER.Missions</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSIONSCHEDULER).RemoveMission">MISSIONSCHEDULER.RemoveMission(MissionName)</a></td>
<td class="summary">
<p>Remove a MISSION from the MISSIONSCHEDULER.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSIONSCHEDULER).ReportMenu">MISSIONSCHEDULER.ReportMenu()</a></td>
<td class="summary">
<p>Enables a MENU option in the communications menu under F10 to control the status of the active missions.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSIONSCHEDULER).ReportMissionsFlash">MISSIONSCHEDULER.ReportMissionsFlash(TimeInterval)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSIONSCHEDULER).ReportMissionsHide">MISSIONSCHEDULER.ReportMissionsHide(Prm)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSIONSCHEDULER).ReportMissionsShow">MISSIONSCHEDULER.ReportMissionsShow()</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSIONSCHEDULER).Scheduler">MISSIONSCHEDULER.Scheduler()</a></td>
<td class="summary">
<p>This is the main MISSIONSCHEDULER Scheduler function.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSIONSCHEDULER).SchedulerId">MISSIONSCHEDULER.SchedulerId</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSIONSCHEDULER).Start">MISSIONSCHEDULER.Start()</a></td>
<td class="summary">
<p>Start the MISSIONSCHEDULER.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSIONSCHEDULER).Stop">MISSIONSCHEDULER.Stop()</a></td>
<td class="summary">
<p>Stop the MISSIONSCHEDULER.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSIONSCHEDULER).Time">MISSIONSCHEDULER:Time(TimeSeconds, TimeIntervalShow, TimeShow)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSIONSCHEDULER).TimeIntervalCount">MISSIONSCHEDULER.TimeIntervalCount</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSIONSCHEDULER).TimeIntervalShow">MISSIONSCHEDULER.TimeIntervalShow</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSIONSCHEDULER).TimeSeconds">MISSIONSCHEDULER.TimeSeconds</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(MISSIONSCHEDULER).TimeShow">MISSIONSCHEDULER.TimeShow</a></td>
<td class="summary">
</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>
<dl class="function">
<dt>
<em><a href="##(MISSIONSCHEDULER)">#MISSIONSCHEDULER</a></em>
<a id="MISSIONSCHEDULER" >
<strong>MISSIONSCHEDULER</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em>#boolean</em>
<a id="TaskComplete" >
<strong>TaskComplete</strong>
</a>
</dt>
<dd>
<p> For each Client, check for each Task the state and evolve the mission.
This flag will indicate if the Task of the Client is Complete.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="_TransportExecuteStage" >
<strong>_TransportExecuteStage</strong>
</a>
</dt>
<dd>
<p> _TransportExecuteStage: Defines the different stages of Transport unload/load execution. This table is internal and is used to control the validity of Transport load/unload timing.</p>
<ul>
<li>_TransportExecuteStage.EXECUTING</li>
<li>_TransportExecuteStage.SUCCESS</li>
<li>_TransportExecuteStage.FAILED</li>
</ul>
<p>--</p>
</dd>
</dl>
<h2><a id="#(MISSION)" >Type <code>MISSION</code></a></h2>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<a id="#(MISSION).AddClient" >
<strong>MISSION.AddClient(CLIENT, self, Client)</strong>
</a>
</dt>
<dd>
<p>Register a new <a href="CLIENT.html">CLIENT</a> to participate within the mission.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em> CLIENT </em></code>:
Client is the <a href="CLIENT.html">CLIENT</a> object. The object must have been instantiated with <a href="CLIENT.html">CLIENT</a>.</p>
</li>
<li>
<p><code><em> self </em></code>: </p>
</li>
<li>
<p><code><em> Client </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p>CLIENT</p>
<h3>Usage:</h3>
<pre class="example"><code>Add a number of Client objects to the Mission.
Mission:AddClient( CLIENT:New( 'US UH-1H*HOT-Deploy Troops 1', 'Transport 3 groups of air defense engineers from our barracks "Gold" and "Titan" to each patriot battery control center to activate our air defenses.' ):Transport() )
Mission:AddClient( CLIENT:New( 'US UH-1H*RAMP-Deploy Troops 3', 'Transport 3 groups of air defense engineers from our barracks "Gold" and "Titan" to each patriot battery control center to activate our air defenses.' ):Transport() )
Mission:AddClient( CLIENT:New( 'US UH-1H*HOT-Deploy Troops 2', 'Transport 3 groups of air defense engineers from our barracks "Gold" and "Titan" to each patriot battery control center to activate our air defenses.' ):Transport() )
Mission:AddClient( CLIENT:New( 'US UH-1H*RAMP-Deploy Troops 4', 'Transport 3 groups of air defense engineers from our barracks "Gold" and "Titan" to each patriot battery control center to activate our air defenses.' ):Transport() )</code></pre>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).AddGoalFunction" >
<strong>MISSION.AddGoalFunction(function, self, GoalFunction)</strong>
</a>
</dt>
<dd>
<p>Add a goal function to a MISSION.</p>
<p>Goal functions are called when a <a href="TASK.html">TASK</a> within a mission has been completed.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em> function </em></code>:
GoalFunction is the function defined by the mission designer to evaluate whether a certain goal has been reached after a <a href="TASK.html">TASK</a> finishes within the <a href="MISSION.html">MISSION</a>. A GoalFunction must accept 2 parameters: Mission, Client, which contains the current MISSION object and the current CLIENT object respectively.</p>
</li>
<li>
<p><code><em> self </em></code>: </p>
</li>
<li>
<p><code><em> GoalFunction </em></code>: </p>
</li>
</ul>
<h3>Usage:</h3>
<pre class="example"><code> PatriotActivation = {
{ "US SAM Patriot Zerti", false },
{ "US SAM Patriot Zegduleti", false },
{ "US SAM Patriot Gvleti", false }
}
function DeployPatriotTroopsGoal( Mission, Client )
-- Check if the cargo is all deployed for mission success.
for CargoID, CargoData in pairs( Mission._Cargos ) do
if Group.getByName( CargoData.CargoGroupName ) then
CargoGroup = Group.getByName( CargoData.CargoGroupName )
if CargoGroup then
-- Check if the cargo is ready to activate
CurrentLandingZoneID = routines.IsUnitInZones( CargoGroup:getUnits()[1], Mission:GetTask( 2 ).LandingZones ) -- The second task is the Deploytask to measure mission success upon
if CurrentLandingZoneID then
if PatriotActivation[CurrentLandingZoneID][2] == false then
-- Now check if this is a new Mission Task to be completed...
trigger.action.setGroupAIOn( Group.getByName( PatriotActivation[CurrentLandingZoneID][1] ) )
PatriotActivation[CurrentLandingZoneID][2] = true
MessageToBlue( "Mission Command: Message to all airborne units! The " .. PatriotActivation[CurrentLandingZoneID][1] .. " is armed. Our air defenses are now stronger.", 60, "BLUE/PatriotDefense" )
MessageToRed( "Mission Command: Our satellite systems are detecting additional NATO air defenses. To all airborne units: Take care!!!", 60, "RED/PatriotDefense" )
Mission:GetTask( 2 ):AddGoalCompletion( "Patriots activated", PatriotActivation[CurrentLandingZoneID][1], 1 ) -- Register Patriot activation as part of mission goal.
end
end
end
end
end
end
local Mission = MISSIONSCHEDULER.AddMission( 'NATO Transport Troops', 'Operational', 'Transport 3 groups of air defense engineers from our barracks "Gold" and "Titan" to each patriot battery control center to activate our air defenses.', 'NATO' )
Mission:AddGoalFunction( DeployPatriotTroopsGoal )</code></pre>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).AddTask" >
<strong>MISSION:AddTask(Task, TaskNumber)</strong>
</a>
</dt>
<dd>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em> Task </em></code>: </p>
</li>
<li>
<p><code><em> TaskNumber </em></code>: </p>
</li>
</ul>
</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).Completed" >
<strong>MISSION:Completed()</strong>
</a>
</dt>
<dd>
<p>Set a Mission to completed.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(MISSION).FAILED" >
<strong>MISSION.FAILED</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).Failed" >
<strong>MISSION:Failed()</strong>
</a>
</dt>
<dd>
<p>Set a Mission to failed.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).FindClient" >
<strong>MISSION.FindClient(CLIENT, self, ClientName)</strong>
</a>
</dt>
<dd>
<p>Find a <a href="CLIENT.html">CLIENT</a> object within the <a href="MISSION.html">MISSION</a> by its ClientName.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em> CLIENT </em></code>:
ClientName is a string defining the Client Group as defined within the ME.</p>
</li>
<li>
<p><code><em> self </em></code>: </p>
</li>
<li>
<p><code><em> ClientName </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p>CLIENT</p>
<h3>Usage:</h3>
<pre class="example"><code>-- Seach for Client "Bomber" within the Mission.
local BomberClient = Mission:FindClient( "Bomber" )</code></pre>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).GetTask" >
<strong>MISSION:GetTask(TaskNumber)</strong>
</a>
</dt>
<dd>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> TaskNumber </em></code>: </p>
</li>
</ul>
</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).GoalFunction" >
<strong>MISSION.GoalFunction</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).IsCompleted" >
<strong>MISSION:IsCompleted()</strong>
</a>
</dt>
<dd>
<p>Returns if a Mission has completed.</p>
<h3>Return value</h3>
<p>bool</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).IsFailed" >
<strong>MISSION:IsFailed()</strong>
</a>
</dt>
<dd>
<p>Returns if a Mission has failed.</p>
<p>treturn bool</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).IsOngoing" >
<strong>MISSION:IsOngoing()</strong>
</a>
</dt>
<dd>
<p>Returns if a Mission is ongoing.</p>
<p>treturn bool</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).IsPending" >
<strong>MISSION:IsPending()</strong>
</a>
</dt>
<dd>
<p>Returns if a Mission is pending.</p>
<p>treturn bool</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).Meta" >
<strong>MISSION:Meta()</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em>#string</em>
<a id="#(MISSION).MissionCoalition" >
<strong>MISSION.MissionCoalition</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(MISSION).MissionProgressTrigger" >
<strong>MISSION.MissionProgressTrigger</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em>#boolean</em>
<a id="#(MISSION).MissionReportFlash" >
<strong>MISSION.MissionReportFlash</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em>#boolean</em>
<a id="#(MISSION).MissionReportShow" >
<strong>MISSION.MissionReportShow</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(MISSION).MissionReportTrigger" >
<strong>MISSION.MissionReportTrigger</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>#number</em>
<a id="#(MISSION).MissionTimeInterval" >
<strong>MISSION.MissionTimeInterval</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(string, string, string, string, self, 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> string </em></code>:
MissionName 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 </em></code>:
MissionPriority 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 </em></code>:
MissionBriefing 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> string </em></code>:
MissionCoalition 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>
<li>
<p><code><em> self </em></code>: </p>
</li>
<li>
<p><code><em> MissionName </em></code>: </p>
</li>
<li>
<p><code><em> MissionPriority </em></code>: </p>
</li>
<li>
<p><code><em> MissionBriefing </em></code>: </p>
</li>
<li>
<p><code><em> MissionCoalition </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p>MISSION</p>
<h3>Usage:</h3>
<pre class="example"><code>
-- Declare a few missions.
local Mission = MISSIONSCHEDULER.AddMission( 'Russia Transport Troops SA-6', 'Operational', 'Transport troops from the control center to one of the SA-6 SAM sites to activate their operation.', 'Russia' )
local Mission = MISSIONSCHEDULER.AddMission( 'Patriots', 'Primary', 'Our intelligence reports that 3 Patriot SAM defense batteries are located near Ruisi, Kvarhiti and Gori.', 'Russia' )
local Mission = MISSIONSCHEDULER.AddMission( 'Package Delivery', 'Operational', 'In order to be in full control of the situation, we need you to deliver a very important package at a secret location. Fly undetected through the NATO defenses and deliver the secret package. The secret agent is located at waypoint 4.', 'Russia' )
local Mission = MISSIONSCHEDULER.AddMission( 'Rescue General', 'Tactical', 'Our intelligence has received a remote signal behind Gori. We believe it is a very important Russian General that was captured by Georgia. Go out there and rescue him! Ensure you stay out of the battle zone, keep south. Waypoint 4 is the location of our Russian General.', 'Russia' )
local Mission = MISSIONSCHEDULER.AddMission( 'NATO Transport Troops', 'Operational', 'Transport 3 groups of air defense engineers from our barracks "Gold" and "Titan" to each patriot battery control center to activate our air defenses.', 'NATO' )
local Mission = MISSIONSCHEDULER.AddMission( 'SA-6 SAMs', 'Primary', 'Our intelligence reports that 3 SA-6 SAM defense batteries are located near Didmukha, Khetagurov and Berula. Eliminate the Russian SAMs.', 'NATO' )
local Mission = MISSIONSCHEDULER.AddMission( 'NATO Sling Load', 'Operational', 'Fly to the cargo pickup zone at Dzegvi or Kaspi, and sling the cargo to Soganlug airbase.', 'NATO' )
local Mission = MISSIONSCHEDULER.AddMission( 'Rescue secret agent', 'Tactical', 'In order to be in full control of the situation, we need you to rescue a secret agent from the woods behind enemy lines. Avoid the Russian defenses and rescue the agent. Keep south until Khasuri, and keep your eyes open for any SAM presence. The agent is located at waypoint 4 on your kneeboard.', 'NATO' )</code></pre>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).Ongoing" >
<strong>MISSION:Ongoing()</strong>
</a>
</dt>
<dd>
<p>Set a Mission to ongoing.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).Pending" >
<strong>MISSION:Pending()</strong>
</a>
</dt>
<dd>
<p>Set a Mission to pending.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(MISSION).REPEAT" >
<strong>MISSION.REPEAT</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).ReportToAll" >
<strong>MISSION:ReportToAll()</strong>
</a>
</dt>
<dd>
<p>Report the status of all MISSIONs to all active Clients.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).ReportTrigger" >
<strong>MISSION:ReportTrigger()</strong>
</a>
</dt>
<dd>
<p>Handles the reporting.</p>
<p>After certain time intervals, a MISSION report MESSAGE will be shown to All Players.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(MISSION).SUCCESS" >
<strong>MISSION.SUCCESS</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).ShowBriefing" >
<strong>MISSION.ShowBriefing(CLIENT, self, Client)</strong>
</a>
</dt>
<dd>
<p>Show the briefing of the MISSION to the CLIENT.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em> CLIENT </em></code>:
Client to show briefing to.</p>
</li>
<li>
<p><code><em> self </em></code>: </p>
</li>
<li>
<p><code><em> Client </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p>CLIENT</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSION).StatusToClients" >
<strong>MISSION:StatusToClients()</strong>
</a>
</dt>
<dd>
<p>Send the status of the MISSION to all Clients.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(MISSION)._ActiveTasks" >
<strong>MISSION._ActiveTasks</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(MISSION)._Clients" >
<strong>MISSION._Clients</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(MISSION)._GoalTasks" >
<strong>MISSION._GoalTasks</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(MISSION)._Tasks" >
<strong>MISSION._Tasks</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<h2><a id="#(MISSIONSCHEDULER)" >Type <code>MISSIONSCHEDULER</code></a></h2>
<p>The MISSIONSCHEDULER is an OBJECT and is the main scheduler of ALL active MISSIONs registered within this scheduler.</p>
<p>It's workings are considered internal and is automatically created when the Mission.lua file is included.</p>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<a id="#(MISSIONSCHEDULER).AddMission" >
<strong>MISSIONSCHEDULER.AddMission(Mission)</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>Parameter</h3>
<ul>
<li>
<p><code><em> Mission </em></code>:
is the MISSION object instantiated by <a href="MISSION.html">MISSION</a>.</p>
</li>
</ul>
<h3>Return value</h3>
<p>MISSION</p>
<h3>Usage:</h3>
<pre class="example"><code>
-- Declare a mission.
Mission = MISSION:New( 'Russia Transport Troops SA-6',
'Operational',
'Transport troops from the control center to one of the SA-6 SAM sites to activate their operation.',
'Russia' )
MISSIONSCHEDULER:AddMission( Mission )</code></pre>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSIONSCHEDULER).FindMission" >
<strong>MISSIONSCHEDULER.FindMission(MissionName)</strong>
</a>
</dt>
<dd>
<p>Find a MISSION within the MISSIONSCHEDULER.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> MissionName </em></code>:
is the name of the MISSION given at declaration using <a href="AddMission.html">AddMission</a>.</p>
</li>
</ul>
<h3>Return value</h3>
<p>MISSION</p>
<h3>Usage:</h3>
<pre class="example"><code>-- Declare a mission.
Mission = MISSION:New( 'Russia Transport Troops SA-6',
'Operational',
'Transport troops from the control center to one of the SA-6 SAM sites to activate their operation.',
'Russia' )
MISSIONSCHEDULER:AddMission( Mission )
-- Now find the Mission.
MissionFind = MISSIONSCHEDULER:FindMission( 'Russia Transport Troops SA-6' )</code></pre>
</dd>
</dl>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(MISSIONSCHEDULER).MissionCount" >
<strong>MISSIONSCHEDULER.MissionCount</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(MISSIONSCHEDULER).Missions" >
<strong>MISSIONSCHEDULER.Missions</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSIONSCHEDULER).RemoveMission" >
<strong>MISSIONSCHEDULER.RemoveMission(MissionName)</strong>
</a>
</dt>
<dd>
<p>Remove a MISSION from the MISSIONSCHEDULER.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> MissionName </em></code>:
is the name of the MISSION given at declaration using <a href="AddMission.html">AddMission</a>.</p>
</li>
</ul>
<h3>Usage:</h3>
<pre class="example"><code>-- Declare a mission.
Mission = MISSION:New( 'Russia Transport Troops SA-6',
'Operational',
'Transport troops from the control center to one of the SA-6 SAM sites to activate their operation.',
'Russia' )
MISSIONSCHEDULER:AddMission( Mission )
-- Now remove the Mission.
MISSIONSCHEDULER:RemoveMission( 'Russia Transport Troops SA-6' )</code></pre>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSIONSCHEDULER).ReportMenu" >
<strong>MISSIONSCHEDULER.ReportMenu()</strong>
</a>
</dt>
<dd>
<p>Enables a MENU option in the communications menu under F10 to control the status of the active missions.</p>
<p>This function should be called only once when starting the MISSIONSCHEDULER.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSIONSCHEDULER).ReportMissionsFlash" >
<strong>MISSIONSCHEDULER.ReportMissionsFlash(TimeInterval)</strong>
</a>
</dt>
<dd>
<p> Internal function used by the MISSIONSCHEDULER menu.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> TimeInterval </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSIONSCHEDULER).ReportMissionsHide" >
<strong>MISSIONSCHEDULER.ReportMissionsHide(Prm)</strong>
</a>
</dt>
<dd>
<p> Internal function used by the MISSIONSCHEDULER menu.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> Prm </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSIONSCHEDULER).ReportMissionsShow" >
<strong>MISSIONSCHEDULER.ReportMissionsShow()</strong>
</a>
</dt>
<dd>
<p> Internal function used by the MISSIONSCHEDULER menu.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSIONSCHEDULER).Scheduler" >
<strong>MISSIONSCHEDULER.Scheduler()</strong>
</a>
</dt>
<dd>
<p>This is the main MISSIONSCHEDULER Scheduler function.</p>
<p>It is considered internal and is automatically created when the Mission.lua file is included.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(MISSIONSCHEDULER).SchedulerId" >
<strong>MISSIONSCHEDULER.SchedulerId</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSIONSCHEDULER).Start" >
<strong>MISSIONSCHEDULER.Start()</strong>
</a>
</dt>
<dd>
<p>Start the MISSIONSCHEDULER.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSIONSCHEDULER).Stop" >
<strong>MISSIONSCHEDULER.Stop()</strong>
</a>
</dt>
<dd>
<p>Stop the MISSIONSCHEDULER.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(MISSIONSCHEDULER).Time" >
<strong>MISSIONSCHEDULER:Time(TimeSeconds, TimeIntervalShow, TimeShow)</strong>
</a>
</dt>
<dd>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em> TimeSeconds </em></code>: </p>
</li>
<li>
<p><code><em> TimeIntervalShow </em></code>: </p>
</li>
<li>
<p><code><em> TimeShow </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(MISSIONSCHEDULER).TimeIntervalCount" >
<strong>MISSIONSCHEDULER.TimeIntervalCount</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(MISSIONSCHEDULER).TimeIntervalShow" >
<strong>MISSIONSCHEDULER.TimeIntervalShow</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(MISSIONSCHEDULER).TimeSeconds" >
<strong>MISSIONSCHEDULER.TimeSeconds</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em>#number</em>
<a id="#(MISSIONSCHEDULER).TimeShow" >
<strong>MISSIONSCHEDULER.TimeShow</strong>
</a>
</dt>
<dd>
</dd>
</dl>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink