mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-08-15 10:47:21 +00:00
800 lines
20 KiB
HTML
800 lines
20 KiB
HTML
<!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>TaskZoneCapture</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>TaskZoneCapture</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_ZONE_CAPTURE">TASK_ZONE_CAPTURE</a></td>
|
|
<td class="summary">
|
|
<h1>TASK<em>ZONE</em>CAPTURE class, extends <a href="TaskZoneGoal.html##(TASK_ZONE_GOAL)">TaskZoneGoal#TASK<em>ZONE</em>GOAL</a></h1>
|
|
|
|
<p>The TASK<em>ZONE</em>CAPTURE 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_ZONE_GOAL">TASK_ZONE_GOAL</a></td>
|
|
<td class="summary">
|
|
<h1>TASK<em>ZONE</em>GOAL class, extends <a href="Task.html##(TASK)">Task#TASK</a></h1>
|
|
|
|
<p>The TASK<em>ZONE</em>GOAL class defines the task to protect or capture a protection zone.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<h2><a id="#(TASK_ZONE_CAPTURE)">Type <code>TASK_ZONE_CAPTURE</code></a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(TASK_ZONE_CAPTURE).New">TASK_ZONE_CAPTURE:New(Mission, SetGroup, TaskName, ZoneGoalCoalition, TaskBriefing)</a></td>
|
|
<td class="summary">
|
|
<p>Instantiates a new TASK<em>ZONE</em>CAPTURE.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(TASK_ZONE_CAPTURE).OnAfterGoal">TASK_ZONE_CAPTURE:OnAfterGoal(TaskUnit, From, Event, To, PlayerUnit, PlayerName)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(TASK_ZONE_CAPTURE).ReportOrder">TASK_ZONE_CAPTURE:ReportOrder(ReportGroup)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(TASK_ZONE_CAPTURE).TaskCoalition">TASK_ZONE_CAPTURE.TaskCoalition</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(TASK_ZONE_CAPTURE).TaskCoalitionName">TASK_ZONE_CAPTURE.TaskCoalitionName</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(TASK_ZONE_CAPTURE).TaskZoneName">TASK_ZONE_CAPTURE.TaskZoneName</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(TASK_ZONE_CAPTURE).UpdateTaskInfo">TASK_ZONE_CAPTURE:UpdateTaskInfo()</a></td>
|
|
<td class="summary">
|
|
<p>Instantiates a new TASK<em>ZONE</em>CAPTURE.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(TASK_ZONE_CAPTURE).ZoneGoal">TASK_ZONE_CAPTURE.ZoneGoal</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2><a id="#(TASK_ZONE_GOAL)">Type <code>TASK_ZONE_GOAL</code></a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(TASK_ZONE_GOAL).GetGoalTotal">TASK_ZONE_GOAL:GetGoalTotal()</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(TASK_ZONE_GOAL).GetMarkInfo">TASK_ZONE_GOAL:GetMarkInfo(TaskInfoID, TaskInfo)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(TASK_ZONE_GOAL).GetPlannedMenuText">TASK_ZONE_GOAL:GetPlannedMenuText()</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(TASK_ZONE_GOAL).GetReportDetail">TASK_ZONE_GOAL:GetReportDetail(ReportGroup, TaskInfoID, TaskInfo)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(TASK_ZONE_GOAL).GetTargetZone">TASK_ZONE_GOAL:GetTargetZone(TaskUnit)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(TASK_ZONE_GOAL).New">TASK_ZONE_GOAL:New(Mission, SetGroup, TaskName, ZoneGoal, TaskType, TaskBriefing)</a></td>
|
|
<td class="summary">
|
|
<p>Instantiates a new TASK<em>ZONE</em>GOAL.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(TASK_ZONE_GOAL).SetGoalTotal">TASK_ZONE_GOAL:SetGoalTotal(GoalTotal)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(TASK_ZONE_GOAL).SetProtect">TASK_ZONE_GOAL:SetProtect(ZoneGoal)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(TASK_ZONE_GOAL).SetTargetZone">TASK_ZONE_GOAL:SetTargetZone(TargetZone, TaskUnit)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(TASK_ZONE_GOAL).TaskType">TASK_ZONE_GOAL.TaskType</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(TASK_ZONE_GOAL).ZoneGoal">TASK_ZONE_GOAL.ZoneGoal</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2>Global(s)</h2>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="##(TASK_ZONE_CAPTURE)">#TASK_ZONE_CAPTURE</a></em>
|
|
<a id="TASK_ZONE_CAPTURE" >
|
|
<strong>TASK_ZONE_CAPTURE</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<h1>TASK<em>ZONE</em>CAPTURE class, extends <a href="TaskZoneGoal.html##(TASK_ZONE_GOAL)">TaskZoneGoal#TASK<em>ZONE</em>GOAL</a></h1>
|
|
|
|
<p>The TASK<em>ZONE</em>CAPTURE 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>ZONE</em>CAPTURE 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_ZONE_GOAL)">#TASK_ZONE_GOAL</a></em>
|
|
<a id="TASK_ZONE_GOAL" >
|
|
<strong>TASK_ZONE_GOAL</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<h1>TASK<em>ZONE</em>GOAL class, extends <a href="Task.html##(TASK)">Task#TASK</a></h1>
|
|
|
|
<p>The TASK<em>ZONE</em>GOAL class defines the task to protect or capture a protection zone.</p>
|
|
|
|
|
|
<p>The TASK<em>ZONE</em>GOAL 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_ZONE_GOAL).SetScoreOnDestroy">TASK<em>ZONE</em>GOAL.SetScoreOnDestroy</a>(): Set a score when a target in scope of the A2G attack, has been destroyed.</li>
|
|
<li><a href="##(TASK_ZONE_GOAL).SetScoreOnSuccess">TASK<em>ZONE</em>GOAL.SetScoreOnSuccess</a>(): Set a score when all the targets in scope of the A2G attack, have been destroyed.</li>
|
|
<li><a href="##(TASK_ZONE_GOAL).SetPenaltyOnFailed">TASK<em>ZONE</em>GOAL.SetPenaltyOnFailed</a>(): Set a penalty when the A2G attack has failed.</li>
|
|
</ul>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<h2><a id="#(TaskZoneCapture)" >Type <code>TaskZoneCapture</code></a></h2>
|
|
|
|
<h2><a id="#(FSM_PROCESS)" >Type <code>FSM_PROCESS</code></a></h2>
|
|
|
|
<h2><a id="#(TASK_ZONE_CAPTURE)" >Type <code>TASK_ZONE_CAPTURE</code></a></h2>
|
|
|
|
<p>The TASK<em>ZONE</em>CAPTURE class</p>
|
|
|
|
<h3>Field(s)</h3>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(TASK_ZONE_CAPTURE).New" >
|
|
<strong>TASK_ZONE_CAPTURE:New(Mission, SetGroup, TaskName, ZoneGoalCoalition, TaskBriefing)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Instantiates a new TASK<em>ZONE</em>CAPTURE.</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="Core.ZoneGoalCoalition.html##(ZONE_GOAL_COALITION)">Core.ZoneGoalCoalition#ZONE<em>GOAL</em>COALITION</a> ZoneGoalCoalition </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_ZONE_CAPTURE)">#TASK<em>ZONE</em>CAPTURE</a>:</em>
|
|
self</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(TASK_ZONE_CAPTURE).OnAfterGoal" >
|
|
<strong>TASK_ZONE_CAPTURE: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_ZONE_CAPTURE).ReportOrder" >
|
|
<strong>TASK_ZONE_CAPTURE: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>
|
|
|
|
<em></em>
|
|
<a id="#(TASK_ZONE_CAPTURE).TaskCoalition" >
|
|
<strong>TASK_ZONE_CAPTURE.TaskCoalition</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(TASK_ZONE_CAPTURE).TaskCoalitionName" >
|
|
<strong>TASK_ZONE_CAPTURE.TaskCoalitionName</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(TASK_ZONE_CAPTURE).TaskZoneName" >
|
|
<strong>TASK_ZONE_CAPTURE.TaskZoneName</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(TASK_ZONE_CAPTURE).UpdateTaskInfo" >
|
|
<strong>TASK_ZONE_CAPTURE:UpdateTaskInfo()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Instantiates a new TASK<em>ZONE</em>CAPTURE.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="Core.ZoneGoalCoalition.html##(ZONE_GOAL_COALITION)">Core.ZoneGoalCoalition#ZONE_GOAL_COALITION</a></em>
|
|
<a id="#(TASK_ZONE_CAPTURE).ZoneGoal" >
|
|
<strong>TASK_ZONE_CAPTURE.ZoneGoal</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
<h2><a id="#(TASK_ZONE_GOAL)" >Type <code>TASK_ZONE_GOAL</code></a></h2>
|
|
|
|
<p>The TASK<em>ZONE</em>GOAL class</p>
|
|
|
|
<h3>Field(s)</h3>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(TASK_ZONE_GOAL).GetGoalTotal" >
|
|
<strong>TASK_ZONE_GOAL:GetGoalTotal()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(TASK_ZONE_GOAL).GetMarkInfo" >
|
|
<strong>TASK_ZONE_GOAL:GetMarkInfo(TaskInfoID, TaskInfo)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em> TaskInfoID </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> TaskInfo </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(TASK_ZONE_GOAL).GetPlannedMenuText" >
|
|
<strong>TASK_ZONE_GOAL:GetPlannedMenuText()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(TASK_ZONE_GOAL).GetReportDetail" >
|
|
<strong>TASK_ZONE_GOAL:GetReportDetail(ReportGroup, TaskInfoID, TaskInfo)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em> ReportGroup </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> TaskInfoID </em></code>: </p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em> TaskInfo </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(TASK_ZONE_GOAL).GetTargetZone" >
|
|
<strong>TASK_ZONE_GOAL: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_ZONE_GOAL).New" >
|
|
<strong>TASK_ZONE_GOAL:New(Mission, SetGroup, TaskName, ZoneGoal, TaskType, TaskBriefing)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Instantiates a new TASK<em>ZONE</em>GOAL.</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="Core.ZoneGoal.html##(ZONE_GOAL)">Core.ZoneGoal#ZONE_GOAL</a> ZoneGoal </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_ZONE_GOAL)">#TASK<em>ZONE</em>GOAL</a>:</em>
|
|
self</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(TASK_ZONE_GOAL).SetGoalTotal" >
|
|
<strong>TASK_ZONE_GOAL:SetGoalTotal(GoalTotal)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em> GoalTotal </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(TASK_ZONE_GOAL).SetProtect" >
|
|
<strong>TASK_ZONE_GOAL:SetProtect(ZoneGoal)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Core.ZoneGoal.html##(ZONE_GOAL)">Core.ZoneGoal#ZONE_GOAL</a> ZoneGoal </em></code>:
|
|
The ZoneGoal Engine.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(TASK_ZONE_GOAL).SetTargetZone" >
|
|
<strong>TASK_ZONE_GOAL: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_ZONE_GOAL).TaskType" >
|
|
<strong>TASK_ZONE_GOAL.TaskType</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="Core.ZoneGoal.html##(ZONE_GOAL)">Core.ZoneGoal#ZONE_GOAL</a></em>
|
|
<a id="#(TASK_ZONE_GOAL).ZoneGoal" >
|
|
<strong>TASK_ZONE_GOAL.ZoneGoal</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</body>
|
|
</html>
|