mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-08-15 10:47:21 +00:00
570 lines
14 KiB
HTML
570 lines
14 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="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><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="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="Velocity.html">Velocity</a></li>
|
|
<li><a href="Zone.html">Zone</a></li>
|
|
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
|
<li>ZoneGoal</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>ZoneGoal</code></h1>
|
|
|
|
<p><strong>Functional (WIP)</strong> -- Base class that models processes to achieve goals involving a Zone.</p>
|
|
|
|
|
|
|
|
<hr/>
|
|
|
|
<p>ZONE_GOAL models processes that have a Goal with a defined achievement involving a Zone.
|
|
Derived classes implement the ways how the achievements can be realized.</p>
|
|
|
|
<hr/>
|
|
|
|
<h3>Author: <strong>Sven Van de Velde (FlightControl)</strong></h3>
|
|
|
|
<hr/>
|
|
|
|
|
|
<h2>Global(s)</h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="#ZONE_GOAL">ZONE_GOAL</a></td>
|
|
<td class="summary">
|
|
<h1>ZONE_GOAL class, extends <a href="Fsm.html##(FSM)">Fsm#FSM</a></h1>
|
|
|
|
<p>ZONE_GOAL models processes that have a Goal with a defined achievement involving a Zone.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<h2><a id="#(ZONE_GOAL)">Type <code>ZONE_GOAL</code></a></h2>
|
|
<table class="function_list">
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ZONE_GOAL).Flare">ZONE_GOAL:Flare(FlareColor)</a></td>
|
|
<td class="summary">
|
|
<p>Flare the center of the zone.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ZONE_GOAL).GetZone">ZONE_GOAL:GetZone()</a></td>
|
|
<td class="summary">
|
|
<p>Get the Zone</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ZONE_GOAL).GetZoneName">ZONE_GOAL:GetZoneName()</a></td>
|
|
<td class="summary">
|
|
<p>Get the name of the ProtectZone</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ZONE_GOAL).Goal">ZONE_GOAL.Goal</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ZONE_GOAL).MonitorDestroyedUnits">ZONE_GOAL:MonitorDestroyedUnits()</a></td>
|
|
<td class="summary">
|
|
<p>Activate the event UnitDestroyed to be fired when a unit is destroyed in the zone.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ZONE_GOAL).New">ZONE_GOAL:New(Zone)</a></td>
|
|
<td class="summary">
|
|
<p>ZONE_GOAL Constructor.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ZONE_GOAL).OnAfterDestroyedUnit">ZONE_GOAL:OnAfterDestroyedUnit(From, Event, To, DestroyedUnit, PlayerName)</a></td>
|
|
<td class="summary">
|
|
<p>DestroyedUnit Handler OnAfter for ZONE_GOAL</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ZONE_GOAL).Smoke">ZONE_GOAL:Smoke(SmokeColor)</a></td>
|
|
<td class="summary">
|
|
<p>Smoke the center of theh zone.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ZONE_GOAL).SmokeColor">ZONE_GOAL.SmokeColor</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ZONE_GOAL).SmokeScheduler">ZONE_GOAL.SmokeScheduler</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ZONE_GOAL).SmokeTime">ZONE_GOAL.SmokeTime</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ZONE_GOAL).StatusSmoke">ZONE_GOAL:StatusSmoke()</a></td>
|
|
<td class="summary">
|
|
<p>Check status Smoke.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ZONE_GOAL).Zone">ZONE_GOAL.Zone</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ZONE_GOAL).__Destroyed">ZONE_GOAL:__Destroyed(EventData)</a></td>
|
|
<td class="summary">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="name" nowrap="nowrap"><a href="##(ZONE_GOAL).onafterGuard">ZONE_GOAL:onafterGuard()</a></td>
|
|
<td class="summary">
|
|
<p>When started, check the Smoke and the Zone status.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2>Global(s)</h2>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="##(ZONE_GOAL)">#ZONE_GOAL</a></em>
|
|
<a id="ZONE_GOAL" >
|
|
<strong>ZONE_GOAL</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<h1>ZONE_GOAL class, extends <a href="Fsm.html##(FSM)">Fsm#FSM</a></h1>
|
|
|
|
<p>ZONE_GOAL models processes that have a Goal with a defined achievement involving a Zone.</p>
|
|
|
|
|
|
<p>Derived classes implement the ways how the achievements can be realized.</p>
|
|
|
|
<h2>1. ZONE_GOAL constructor</h2>
|
|
|
|
<ul>
|
|
<li><a href="##(ZONE_GOAL).New">ZONE_GOAL.New</a>(): Creates a new ZONE_GOAL object.</li>
|
|
</ul>
|
|
|
|
<h2>2. ZONE_GOAL is a finite state machine (FSM).</h2>
|
|
|
|
<h3>2.1 ZONE_GOAL States</h3>
|
|
|
|
<ul>
|
|
<li>None: Initial State</li>
|
|
</ul>
|
|
|
|
<h3>2.2 ZONE_GOAL Events</h3>
|
|
|
|
<ul>
|
|
<li>DestroyedUnit: A <a href="Unit.html">Unit</a> is destroyed in the Zone. The event will only get triggered if the method <a href="##(ZONE_GOAL).MonitorDestroyedUnits">ZONE_GOAL.MonitorDestroyedUnits</a>() is used.</li>
|
|
</ul>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<h2><a id="#(ZoneGoal)" >Type <code>ZoneGoal</code></a></h2>
|
|
|
|
<h2><a id="#(SMOKECOLOR.Color)" >Type <code>SMOKECOLOR.Color</code></a></h2>
|
|
|
|
<h2><a id="#(ZONE_GOAL)" >Type <code>ZONE_GOAL</code></a></h2>
|
|
<h3>Field(s)</h3>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ZONE_GOAL).Flare" >
|
|
<strong>ZONE_GOAL:Flare(FlareColor)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Flare the center of the zone.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="##(SMOKECOLOR.Color)">#SMOKECOLOR.Color</a> FlareColor </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ZONE_GOAL).GetZone" >
|
|
<strong>ZONE_GOAL:GetZone()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Get the Zone</p>
|
|
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="Core.Zone.html##(ZONE_BASE)">Core.Zone#ZONE_BASE</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ZONE_GOAL).GetZoneName" >
|
|
<strong>ZONE_GOAL:GetZoneName()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Get the name of the ProtectZone</p>
|
|
|
|
<h3>Return value</h3>
|
|
|
|
<p><em>#string:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ZONE_GOAL).Goal" >
|
|
<strong>ZONE_GOAL.Goal</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ZONE_GOAL).MonitorDestroyedUnits" >
|
|
<strong>ZONE_GOAL:MonitorDestroyedUnits()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Activate the event UnitDestroyed to be fired when a unit is destroyed in the zone.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ZONE_GOAL).New" >
|
|
<strong>ZONE_GOAL:New(Zone)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>ZONE_GOAL Constructor.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Core.Zone.html##(ZONE_BASE)">Core.Zone#ZONE_BASE</a> Zone </em></code>:
|
|
A <a href="Zone.html">Zone</a> object with the goal to be achieved.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
<h3>Return value</h3>
|
|
|
|
<p><em><a href="##(ZONE_GOAL)">#ZONE_GOAL</a>:</em></p>
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ZONE_GOAL).OnAfterDestroyedUnit" >
|
|
<strong>ZONE_GOAL:OnAfterDestroyedUnit(From, Event, To, DestroyedUnit, PlayerName)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>DestroyedUnit Handler OnAfter for ZONE_GOAL</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>
|
|
<li>
|
|
|
|
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> DestroyedUnit </em></code>:
|
|
The destroyed unit.</p>
|
|
|
|
</li>
|
|
<li>
|
|
|
|
<p><code><em>#string PlayerName </em></code>:
|
|
The name of the player.</p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ZONE_GOAL).Smoke" >
|
|
<strong>ZONE_GOAL:Smoke(SmokeColor)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Smoke the center of theh zone.</p>
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="##(SMOKECOLOR.Color)">#SMOKECOLOR.Color</a> SmokeColor </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ZONE_GOAL).SmokeColor" >
|
|
<strong>ZONE_GOAL.SmokeColor</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em></em>
|
|
<a id="#(ZONE_GOAL).SmokeScheduler" >
|
|
<strong>ZONE_GOAL.SmokeScheduler</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ZONE_GOAL).SmokeTime" >
|
|
<strong>ZONE_GOAL.SmokeTime</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ZONE_GOAL).StatusSmoke" >
|
|
<strong>ZONE_GOAL:StatusSmoke()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>Check status Smoke.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<em><a href="Core.Zone.html##(ZONE_BASE)">Core.Zone#ZONE_BASE</a></em>
|
|
<a id="#(ZONE_GOAL).Zone" >
|
|
<strong>ZONE_GOAL.Zone</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ZONE_GOAL).__Destroyed" >
|
|
<strong>ZONE_GOAL:__Destroyed(EventData)</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
|
|
|
|
<h3>Parameter</h3>
|
|
<ul>
|
|
<li>
|
|
|
|
<p><code><em><a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a> EventData </em></code>: </p>
|
|
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
<dl class="function">
|
|
<dt>
|
|
|
|
<a id="#(ZONE_GOAL).onafterGuard" >
|
|
<strong>ZONE_GOAL:onafterGuard()</strong>
|
|
</a>
|
|
</dt>
|
|
<dd>
|
|
|
|
<p>When started, check the Smoke and the Zone status.</p>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</body>
|
|
</html>
|