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/Task_Protect.html
FlightControl_Master 1f5030fcbc Progress
2017-10-03 19:19:09 +02:00

852 lines
21 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="Account.html">Account</a></li>
<li><a href="Airbase.html">Airbase</a></li>
<li><a href="AirbasePolice.html">AirbasePolice</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><a href="Mission.html">Mission</a></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="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>Task_Protect</li>
<li><a href="Unit.html">Unit</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="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>Task_Protect</code></h1>
<p><strong>Tasking</strong> - The TASK_Protect models tasks for players to protect or capture specific zones.</p>
<hr/>
<h3>Author: <strong>Sven Van de Velde (FlightControl)</strong></h3>
<h3>Contributions: MillerTime</h3>
<hr/>
<p> </p>
<h2>Global(s)</h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="#TASK_CAPTURE_ZONE">TASK_CAPTURE_ZONE</a></td>
<td class="summary">
<h1>TASK<em>CAPTURE</em>ZONE class, extends <a href="Task_A2G.html##(TASK_PROTECT)">Task<em>A2G#TASK</em>PROTECT</a></h1>
<p>The TASK<em>CAPTURE</em>ZONE class defines an Suppression or Extermination of Air Defenses task for a human player to be executed.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="#TASK_PROTECT">TASK_PROTECT</a></td>
<td class="summary">
<h1>TASK_PROTECT class, extends <a href="Task.html##(TASK)">Task#TASK</a></h1>
<p>The TASK_PROTECT class defines the task to protect or capture a protection zone.</p>
</td>
</tr>
</table>
<h2><a id="#(TASK_CAPTURE_ZONE)">Type <code>TASK_CAPTURE_ZONE</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_CAPTURE_ZONE).New">TASK_CAPTURE_ZONE:New(Mission, SetGroup, TaskName, Protect, TaskBriefing)</a></td>
<td class="summary">
<p>Instantiates a new TASK<em>CAPTURE</em>ZONE.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_CAPTURE_ZONE).OnAfterGoal">TASK_CAPTURE_ZONE:OnAfterGoal(TaskUnit, From, Event, To, PlayerUnit, PlayerName)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_CAPTURE_ZONE).ReportOrder">TASK_CAPTURE_ZONE:ReportOrder(ReportGroup)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_CAPTURE_ZONE).SetScoreOnFail">TASK_CAPTURE_ZONE:SetScoreOnFail(PlayerName, Penalty, TaskUnit)</a></td>
<td class="summary">
<p>Set a penalty when the A2G attack has failed.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_CAPTURE_ZONE).SetScoreOnProgress">TASK_CAPTURE_ZONE:SetScoreOnProgress(PlayerName, Score, TaskUnit)</a></td>
<td class="summary">
<p>Set a score when a target in scope of the A2G attack, has been destroyed .</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_CAPTURE_ZONE).SetScoreOnSuccess">TASK_CAPTURE_ZONE:SetScoreOnSuccess(PlayerName, Score, TaskUnit)</a></td>
<td class="summary">
<p>Set a score when all the targets in scope of the A2G attack, have been destroyed.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_CAPTURE_ZONE).TargetSetUnit">TASK_CAPTURE_ZONE.TargetSetUnit</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_CAPTURE_ZONE).TaskCoalition">TASK_CAPTURE_ZONE.TaskCoalition</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_CAPTURE_ZONE).TaskCoalitionName">TASK_CAPTURE_ZONE.TaskCoalitionName</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_CAPTURE_ZONE).TaskZoneName">TASK_CAPTURE_ZONE.TaskZoneName</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_CAPTURE_ZONE).UpdateTaskInfo">TASK_CAPTURE_ZONE:UpdateTaskInfo()</a></td>
<td class="summary">
<p>Instantiates a new TASK<em>CAPTURE</em>ZONE.</p>
</td>
</tr>
</table>
<h2><a id="#(TASK_PROTECT)">Type <code>TASK_PROTECT</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_PROTECT).GetGoalTotal">TASK_PROTECT:GetGoalTotal()</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_PROTECT).GetPlannedMenuText">TASK_PROTECT:GetPlannedMenuText()</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_PROTECT).GetTargetZone">TASK_PROTECT:GetTargetZone(TaskUnit)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_PROTECT).New">TASK_PROTECT:New(Mission, SetGroup, TaskName, Protect, TaskType, TaskBriefing)</a></td>
<td class="summary">
<p>Instantiates a new TASK_PROTECT.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_PROTECT).Protect">TASK_PROTECT.Protect</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_PROTECT).SetGoalTotal">TASK_PROTECT:SetGoalTotal()</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_PROTECT).SetProtect">TASK_PROTECT:SetProtect(Protect)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_PROTECT).SetTargetZone">TASK_PROTECT:SetTargetZone(TargetZone, TaskUnit)</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK_PROTECT).TaskType">TASK_PROTECT.TaskType</a></td>
<td class="summary">
</td>
</tr>
</table>
<h2>Global(s)</h2>
<dl class="function">
<dt>
<em><a href="##(TASK_CAPTURE_ZONE)">#TASK_CAPTURE_ZONE</a></em>
<a id="TASK_CAPTURE_ZONE" >
<strong>TASK_CAPTURE_ZONE</strong>
</a>
</dt>
<dd>
<h1>TASK<em>CAPTURE</em>ZONE class, extends <a href="Task_A2G.html##(TASK_PROTECT)">Task<em>A2G#TASK</em>PROTECT</a></h1>
<p>The TASK<em>CAPTURE</em>ZONE class defines an Suppression or Extermination of Air Defenses task for a human player to be executed.</p>
<p>These tasks are important to be executed as they will help to achieve air superiority at the vicinity.</p>
<p>The TASK<em>CAPTURE</em>ZONE is used by the <a href="Task_A2G_Dispatcher.html##(TASK_A2G_DISPATCHER)">Task<em>A2G</em>Dispatcher#TASK<em>A2G</em>DISPATCHER</a> to automatically create SEAD tasks
based on detected enemy ground targets.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="##(TASK_PROTECT)">#TASK_PROTECT</a></em>
<a id="TASK_PROTECT" >
<strong>TASK_PROTECT</strong>
</a>
</dt>
<dd>
<h1>TASK_PROTECT class, extends <a href="Task.html##(TASK)">Task#TASK</a></h1>
<p>The TASK_PROTECT class defines the task to protect or capture a protection zone.</p>
<p>The TASK_PROTECT is implemented using a <a href="Fsm.html##(FSM_TASK)">Fsm#FSM_TASK</a>, and has the following statuses:</p>
<ul>
<li><strong>None</strong>: Start of the process</li>
<li><strong>Planned</strong>: The A2G task is planned.</li>
<li><strong>Assigned</strong>: The A2G task is assigned to a <a href="Group.html##(GROUP)">Group#GROUP</a>.</li>
<li><strong>Success</strong>: The A2G task is successfully completed.</li>
<li><strong>Failed</strong>: The A2G task has failed. This will happen if the player exists the task early, without communicating a possible cancellation to HQ.</li>
</ul>
<h2>Set the scoring of achievements in an A2G attack.</h2>
<p>Scoring or penalties can be given in the following circumstances:</p>
<ul>
<li><a href="##(TASK_PROTECT).SetScoreOnDestroy">TASK_PROTECT.SetScoreOnDestroy</a>(): Set a score when a target in scope of the A2G attack, has been destroyed.</li>
<li><a href="##(TASK_PROTECT).SetScoreOnSuccess">TASK_PROTECT.SetScoreOnSuccess</a>(): Set a score when all the targets in scope of the A2G attack, have been destroyed.</li>
<li><a href="##(TASK_PROTECT).SetPenaltyOnFailed">TASK_PROTECT.SetPenaltyOnFailed</a>(): Set a penalty when the A2G attack has failed.</li>
</ul>
</dd>
</dl>
<h2><a id="#(Task_Protect)" >Type <code>Task_Protect</code></a></h2>
<h2><a id="#(FSM_PROCESS)" >Type <code>FSM_PROCESS</code></a></h2>
<h2><a id="#(TASK_CAPTURE_ZONE)" >Type <code>TASK_CAPTURE_ZONE</code></a></h2>
<p>The TASK<em>CAPTURE</em>ZONE class</p>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<a id="#(TASK_CAPTURE_ZONE).New" >
<strong>TASK_CAPTURE_ZONE:New(Mission, SetGroup, TaskName, Protect, TaskBriefing)</strong>
</a>
</dt>
<dd>
<p>Instantiates a new TASK<em>CAPTURE</em>ZONE.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Tasking.Mission.html##(MISSION)">Tasking.Mission#MISSION</a> Mission </em></code>: </p>
</li>
<li>
<p><code><em><a href="Core.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a> SetGroup </em></code>:
The set of groups for which the Task can be assigned.</p>
</li>
<li>
<p><code><em>#string TaskName </em></code>:
The name of the Task.</p>
</li>
<li>
<p><code><em><a href="Functional.Protect.html##(PROTECT)">Functional.Protect#PROTECT</a> Protect </em></code>: </p>
</li>
<li>
<p><code><em>#string TaskBriefing </em></code>:
The briefing of the task.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(TASK_CAPTURE_ZONE)">#TASK<em>CAPTURE</em>ZONE</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_CAPTURE_ZONE).OnAfterGoal" >
<strong>TASK_CAPTURE_ZONE:OnAfterGoal(TaskUnit, From, Event, To, PlayerUnit, PlayerName)</strong>
</a>
</dt>
<dd>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> TaskUnit </em></code>: </p>
</li>
<li>
<p><code><em> From </em></code>: </p>
</li>
<li>
<p><code><em> Event </em></code>: </p>
</li>
<li>
<p><code><em> To </em></code>: </p>
</li>
<li>
<p><code><em> PlayerUnit </em></code>: </p>
</li>
<li>
<p><code><em> PlayerName </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_CAPTURE_ZONE).ReportOrder" >
<strong>TASK_CAPTURE_ZONE:ReportOrder(ReportGroup)</strong>
</a>
</dt>
<dd>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> ReportGroup </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_CAPTURE_ZONE).SetScoreOnFail" >
<strong>TASK_CAPTURE_ZONE:SetScoreOnFail(PlayerName, Penalty, TaskUnit)</strong>
</a>
</dt>
<dd>
<p>Set a penalty when the A2G attack has failed.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string PlayerName </em></code>:
The name of the player.</p>
</li>
<li>
<p><code><em>#number Penalty </em></code>:
The penalty in points, must be a negative value!</p>
</li>
<li>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> TaskUnit </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(TASK_CAPTURE_ZONE)">#TASK<em>CAPTURE</em>ZONE</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_CAPTURE_ZONE).SetScoreOnProgress" >
<strong>TASK_CAPTURE_ZONE:SetScoreOnProgress(PlayerName, Score, TaskUnit)</strong>
</a>
</dt>
<dd>
<p>Set a score when a target in scope of the A2G attack, has been destroyed .</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string PlayerName </em></code>:
The name of the player.</p>
</li>
<li>
<p><code><em>#number Score </em></code>:
The score in points to be granted when task process has been achieved.</p>
</li>
<li>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> TaskUnit </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(TASK_CAPTURE_ZONE)">#TASK<em>CAPTURE</em>ZONE</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_CAPTURE_ZONE).SetScoreOnSuccess" >
<strong>TASK_CAPTURE_ZONE:SetScoreOnSuccess(PlayerName, Score, TaskUnit)</strong>
</a>
</dt>
<dd>
<p>Set a score when all the targets in scope of the A2G attack, have been destroyed.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string PlayerName </em></code>:
The name of the player.</p>
</li>
<li>
<p><code><em>#number Score </em></code>:
The score in points.</p>
</li>
<li>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> TaskUnit </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(TASK_CAPTURE_ZONE)">#TASK<em>CAPTURE</em>ZONE</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Set.html##(SET_UNIT)">Set#SET_UNIT</a></em>
<a id="#(TASK_CAPTURE_ZONE).TargetSetUnit" >
<strong>TASK_CAPTURE_ZONE.TargetSetUnit</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(TASK_CAPTURE_ZONE).TaskCoalition" >
<strong>TASK_CAPTURE_ZONE.TaskCoalition</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(TASK_CAPTURE_ZONE).TaskCoalitionName" >
<strong>TASK_CAPTURE_ZONE.TaskCoalitionName</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(TASK_CAPTURE_ZONE).TaskZoneName" >
<strong>TASK_CAPTURE_ZONE.TaskZoneName</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_CAPTURE_ZONE).UpdateTaskInfo" >
<strong>TASK_CAPTURE_ZONE:UpdateTaskInfo()</strong>
</a>
</dt>
<dd>
<p>Instantiates a new TASK<em>CAPTURE</em>ZONE.</p>
</dd>
</dl>
<h2><a id="#(TASK_PROTECT)" >Type <code>TASK_PROTECT</code></a></h2>
<p>The TASK_PROTECT class</p>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<a id="#(TASK_PROTECT).GetGoalTotal" >
<strong>TASK_PROTECT:GetGoalTotal()</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_PROTECT).GetPlannedMenuText" >
<strong>TASK_PROTECT:GetPlannedMenuText()</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_PROTECT).GetTargetZone" >
<strong>TASK_PROTECT:GetTargetZone(TaskUnit)</strong>
</a>
</dt>
<dd>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> TaskUnit </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="Core.Zone.html##(ZONE_BASE)">Core.Zone#ZONE_BASE</a>:</em>
The Zone object where the Target is located on the map.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_PROTECT).New" >
<strong>TASK_PROTECT:New(Mission, SetGroup, TaskName, Protect, TaskType, TaskBriefing)</strong>
</a>
</dt>
<dd>
<p>Instantiates a new TASK_PROTECT.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Tasking.Mission.html##(MISSION)">Tasking.Mission#MISSION</a> Mission </em></code>: </p>
</li>
<li>
<p><code><em><a href="Set.html##(SET_GROUP)">Set#SET_GROUP</a> SetGroup </em></code>:
The set of groups for which the Task can be assigned.</p>
</li>
<li>
<p><code><em>#string TaskName </em></code>:
The name of the Task.</p>
</li>
<li>
<p><code><em><a href="Functional.Protect.html##(PROTECT)">Functional.Protect#PROTECT</a> Protect </em></code>: </p>
</li>
<li>
<p><code><em> TaskType </em></code>: </p>
</li>
<li>
<p><code><em> TaskBriefing </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(TASK_PROTECT)">#TASK_PROTECT</a>:</em>
self</p>
</dd>
</dl>
<dl class="function">
<dt>
<em><a href="Functional.Protect.html##(PROTECT)">Functional.Protect#PROTECT</a></em>
<a id="#(TASK_PROTECT).Protect" >
<strong>TASK_PROTECT.Protect</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_PROTECT).SetGoalTotal" >
<strong>TASK_PROTECT:SetGoalTotal()</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_PROTECT).SetProtect" >
<strong>TASK_PROTECT:SetProtect(Protect)</strong>
</a>
</dt>
<dd>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Functional.Protect.html##(PROTECT)">Functional.Protect#PROTECT</a> Protect </em></code>:
The Protect Engine.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK_PROTECT).SetTargetZone" >
<strong>TASK_PROTECT:SetTargetZone(TargetZone, TaskUnit)</strong>
</a>
</dt>
<dd>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Core.Zone.html##(ZONE_BASE)">Core.Zone#ZONE_BASE</a> TargetZone </em></code>:
The Zone object where the Target is located on the map.</p>
</li>
<li>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> TaskUnit </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(TASK_PROTECT).TaskType" >
<strong>TASK_PROTECT.TaskType</strong>
</a>
</dt>
<dd>
</dd>
</dl>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink