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/ZoneCaptureCoalition.html
FlightControl_Master b7183023c9 Documentation
2017-11-22 06:23:58 +01:00

1075 lines
26 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head>
<link rel="stylesheet" href="stylesheet.css" type="text/css"/>
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div>
<div id="main">
<div id="navigation">
<h2>Modules</h2>
<ul><li>
<a href="index.html">index</a>
</li></ul>
<ul>
<li><a href="AI_A2A.html">AI_A2A</a></li>
<li><a href="AI_A2A_Cap.html">AI_A2A_Cap</a></li>
<li><a href="AI_A2A_Dispatcher.html">AI_A2A_Dispatcher</a></li>
<li><a href="AI_A2A_GCI.html">AI_A2A_GCI</a></li>
<li><a href="AI_A2A_Patrol.html">AI_A2A_Patrol</a></li>
<li><a href="AI_Bai.html">AI_Bai</a></li>
<li><a href="AI_Balancer.html">AI_Balancer</a></li>
<li><a href="AI_Cap.html">AI_Cap</a></li>
<li><a href="AI_Cas.html">AI_Cas</a></li>
<li><a href="AI_Formation.html">AI_Formation</a></li>
<li><a href="AI_Patrol.html">AI_Patrol</a></li>
<li><a href="ATC_Ground.html">ATC_Ground</a></li>
<li><a href="Account.html">Account</a></li>
<li><a href="Airbase.html">Airbase</a></li>
<li><a href="Assign.html">Assign</a></li>
<li><a href="Base.html">Base</a></li>
<li><a href="Cargo.html">Cargo</a></li>
<li><a href="CleanUp.html">CleanUp</a></li>
<li><a href="Client.html">Client</a></li>
<li><a href="CommandCenter.html">CommandCenter</a></li>
<li><a href="Controllable.html">Controllable</a></li>
<li><a href="DCSAirbase.html">DCSAirbase</a></li>
<li><a href="DCSCoalitionObject.html">DCSCoalitionObject</a></li>
<li><a href="DCSCommand.html">DCSCommand</a></li>
<li><a href="DCSController.html">DCSController</a></li>
<li><a href="DCSGroup.html">DCSGroup</a></li>
<li><a href="DCSObject.html">DCSObject</a></li>
<li><a href="DCSTask.html">DCSTask</a></li>
<li><a href="DCSTypes.html">DCSTypes</a></li>
<li><a href="DCSUnit.html">DCSUnit</a></li>
<li><a href="DCSVec3.html">DCSVec3</a></li>
<li><a href="DCSWorld.html">DCSWorld</a></li>
<li><a href="DCSZone.html">DCSZone</a></li>
<li><a href="DCScountry.html">DCScountry</a></li>
<li><a href="DCStimer.html">DCStimer</a></li>
<li><a href="DCStrigger.html">DCStrigger</a></li>
<li><a href="Database.html">Database</a></li>
<li><a href="Designate.html">Designate</a></li>
<li><a href="Detection.html">Detection</a></li>
<li><a href="DetectionManager.html">DetectionManager</a></li>
<li><a href="Escort.html">Escort</a></li>
<li><a href="Event.html">Event</a></li>
<li><a href="Fsm.html">Fsm</a></li>
<li><a href="Goal.html">Goal</a></li>
<li><a href="Group.html">Group</a></li>
<li><a href="Identifiable.html">Identifiable</a></li>
<li><a href="Menu.html">Menu</a></li>
<li><a href="Message.html">Message</a></li>
<li><a href="MissileTrainer.html">MissileTrainer</a></li>
<li><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>ZoneCaptureCoalition</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>ZoneCaptureCoalition</code></h1>
<p><strong>Functional</strong> -- (WIP R2.3) Models the process to capture a Zone for a Coalition, which is guarded by another Coalition.</p>
<hr/>
<p><img src="..\Presentations\ZONE_CAPTURE_COALITION\Dia1.JPG" alt="Banner Image"/></p>
<hr/>
<h3>Contributions: <strong>Millertime</strong>: Concept</h3>
<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_CAPTURE_COALITION">ZONE_CAPTURE_COALITION</a></td>
<td class="summary">
<h1>ZONE_CAPTURE_COALITION class, extends <a href="ZoneGoalCoalition.html##(ZONE_GOAL_COALITION)">ZoneGoalCoalition#ZONE<em>GOAL</em>COALITION</a></h1>
<p>Models the process to capture a Zone for a Coalition, which is guarded by another Coalition.</p>
</td>
</tr>
</table>
<h2><a id="#(ZONE_CAPTURE_COALITION)">Type <code>ZONE_CAPTURE_COALITION</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_CAPTURE_COALITION).Attack">ZONE_CAPTURE_COALITION:Attack()</a></td>
<td class="summary">
<p>Attack Trigger for ZONE_CAPTURE_COALITION</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_CAPTURE_COALITION).Capture">ZONE_CAPTURE_COALITION:Capture()</a></td>
<td class="summary">
<p>Capture Trigger for ZONE_CAPTURE_COALITION</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_CAPTURE_COALITION).Empty">ZONE_CAPTURE_COALITION:Empty()</a></td>
<td class="summary">
<p>Empty Trigger for ZONE_CAPTURE_COALITION</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_CAPTURE_COALITION).Guard">ZONE_CAPTURE_COALITION:Guard()</a></td>
<td class="summary">
<p>Guard Trigger for ZONE_CAPTURE_COALITION</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_CAPTURE_COALITION).IsAttacked">ZONE_CAPTURE_COALITION:IsAttacked()</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_CAPTURE_COALITION).IsCaptured">ZONE_CAPTURE_COALITION:IsCaptured()</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_CAPTURE_COALITION).IsEmpty">ZONE_CAPTURE_COALITION:IsEmpty()</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_CAPTURE_COALITION).IsGuarded">ZONE_CAPTURE_COALITION:IsGuarded()</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_CAPTURE_COALITION).Mark">ZONE_CAPTURE_COALITION:Mark()</a></td>
<td class="summary">
<p>Mark.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_CAPTURE_COALITION).MarkBlue">ZONE_CAPTURE_COALITION.MarkBlue</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_CAPTURE_COALITION).MarkRed">ZONE_CAPTURE_COALITION.MarkRed</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_CAPTURE_COALITION).New">ZONE_CAPTURE_COALITION:New(Zone, Coalition)</a></td>
<td class="summary">
<p>ZONE<em>CAPTURE</em>COALITION Constructor.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_CAPTURE_COALITION).OnAfterAttack">ZONE_CAPTURE_COALITION:OnAfterAttack(From, Event, To)</a></td>
<td class="summary">
<p>Attack Handler OnAfter for ZONE_CAPTURE_COALITION</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_CAPTURE_COALITION).OnAfterCapture">ZONE_CAPTURE_COALITION:OnAfterCapture(From, Event, To)</a></td>
<td class="summary">
<p>Capture Handler OnAfter for ZONE_CAPTURE_COALITION</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_CAPTURE_COALITION).OnAfterEmpty">ZONE_CAPTURE_COALITION:OnAfterEmpty(From, Event, To)</a></td>
<td class="summary">
<p>Empty Handler OnAfter for ZONE_CAPTURE_COALITION</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_CAPTURE_COALITION).OnAfterGuard">ZONE_CAPTURE_COALITION:OnAfterGuard(From, Event, To)</a></td>
<td class="summary">
<p>Guard Handler OnAfter for ZONE_CAPTURE_COALITION</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_CAPTURE_COALITION).OnBeforeAttack">ZONE_CAPTURE_COALITION:OnBeforeAttack(From, Event, To)</a></td>
<td class="summary">
<p>Attack Handler OnBefore for ZONE_CAPTURE_COALITION</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_CAPTURE_COALITION).OnBeforeCapture">ZONE_CAPTURE_COALITION:OnBeforeCapture(From, Event, To)</a></td>
<td class="summary">
<p>Capture Handler OnBefore for ZONE_CAPTURE_COALITION</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_CAPTURE_COALITION).OnBeforeEmpty">ZONE_CAPTURE_COALITION:OnBeforeEmpty(From, Event, To)</a></td>
<td class="summary">
<p>Empty Handler OnBefore for ZONE_CAPTURE_COALITION</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_CAPTURE_COALITION).OnBeforeGuard">ZONE_CAPTURE_COALITION:OnBeforeGuard(From, Event, To)</a></td>
<td class="summary">
<p>Guard Handler OnBefore for ZONE_CAPTURE_COALITION</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_CAPTURE_COALITION).ScheduleStatusZone">ZONE_CAPTURE_COALITION.ScheduleStatusZone</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_CAPTURE_COALITION).SmokeScheduler">ZONE_CAPTURE_COALITION.SmokeScheduler</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_CAPTURE_COALITION).States">ZONE_CAPTURE_COALITION.States</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_CAPTURE_COALITION).StatusZone">ZONE_CAPTURE_COALITION:StatusZone()</a></td>
<td class="summary">
<p>Check status Coalition ownership.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_CAPTURE_COALITION).__Attack">ZONE_CAPTURE_COALITION:__Attack(Delay)</a></td>
<td class="summary">
<p>Attack Asynchronous Trigger for ZONE_CAPTURE_COALITION</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_CAPTURE_COALITION).__Capture">ZONE_CAPTURE_COALITION:__Capture(Delay)</a></td>
<td class="summary">
<p>Capture Asynchronous Trigger for ZONE_CAPTURE_COALITION</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_CAPTURE_COALITION).__Empty">ZONE_CAPTURE_COALITION:__Empty(Delay)</a></td>
<td class="summary">
<p>Empty Asynchronous Trigger for ZONE_CAPTURE_COALITION</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_CAPTURE_COALITION).__Guard">ZONE_CAPTURE_COALITION:__Guard(Delay)</a></td>
<td class="summary">
<p>Guard Asynchronous Trigger for ZONE_CAPTURE_COALITION</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_CAPTURE_COALITION).onafterGuard">ZONE_CAPTURE_COALITION:onafterGuard()</a></td>
<td class="summary">
<p>When started, check the Coalition status.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_CAPTURE_COALITION).onenterAttacked">ZONE_CAPTURE_COALITION:onenterAttacked()</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_CAPTURE_COALITION).onenterCaptured">ZONE_CAPTURE_COALITION:onenterCaptured()</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_CAPTURE_COALITION).onenterEmpty">ZONE_CAPTURE_COALITION:onenterEmpty()</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(ZONE_CAPTURE_COALITION).onenterGuarded">ZONE_CAPTURE_COALITION:onenterGuarded()</a></td>
<td class="summary">
<p>Bound.</p>
</td>
</tr>
</table>
<h2>Global(s)</h2>
<dl class="function">
<dt>
<em><a href="##(ZONE_CAPTURE_COALITION)">#ZONE_CAPTURE_COALITION</a></em>
<a id="ZONE_CAPTURE_COALITION" >
<strong>ZONE_CAPTURE_COALITION</strong>
</a>
</dt>
<dd>
<h1>ZONE_CAPTURE_COALITION class, extends <a href="ZoneGoalCoalition.html##(ZONE_GOAL_COALITION)">ZoneGoalCoalition#ZONE<em>GOAL</em>COALITION</a></h1>
<p>Models the process to capture a Zone for a Coalition, which is guarded by another Coalition.</p>
<hr/>
<p><img src="..\Presentations\ZONE_CAPTURE_COALITION\Dia1.JPG" alt="Banner Image"/></p>
<hr/>
<p>The Zone is initially <strong>Guarded</strong> by the <strong>owning coalition</strong>, which is the coalition that initially occupies the zone with units of its coalition.
Once units of an other coalition are entering the Zone, the state will change to <strong>Attacked</strong>. As long as these units remain in the zone, the state keeps set to Attacked.
When all units are destroyed in the Zone, the state will change to <strong>Empty</strong>, which expresses that the Zone is empty, and can be captured.
When units of the other coalition are in the Zone, and no other units of the owning coalition is in the Zone, the Zone is captured, and its state will change to <strong>Captured</strong>.</p>
<p>Event handlers can be defined by the mission designer to action on the state transitions.</p>
<h2>1. ZONE_CAPTURE_COALITION constructor</h2>
<ul>
<li><a href="##(ZONE_CAPTURE_COALITION).New">ZONE<em>CAPTURE</em>COALITION.New</a>(): Creates a new ZONE_CAPTURE_COALITION object.</li>
</ul>
<h2>2. ZONE_CAPTURE_COALITION is a finite state machine (FSM).</h2>
<h3>2.1 ZONE_CAPTURE_COALITION States</h3>
<ul>
<li><strong>Captured</strong>: The Zone has been captured by an other coalition.</li>
<li><strong>Attacked</strong>: The Zone is currently intruded by an other coalition. There are units of the owning coalition and an other coalition in the Zone.</li>
<li><strong>Guarded</strong>: The Zone is guarded by the owning coalition. There is no other unit of an other coalition in the Zone.</li>
<li><strong>Empty</strong>: The Zone is empty. There is not valid unit in the Zone.</li>
</ul>
<h3>2.2 ZONE_CAPTURE_COALITION Events</h3>
<ul>
<li><strong>Capture</strong>: The Zone has been captured by an other coalition.</li>
<li><strong>Attack</strong>: The Zone is currently intruded by an other coalition. There are units of the owning coalition and an other coalition in the Zone.</li>
<li><strong>Guard</strong>: The Zone is guarded by the owning coalition. There is no other unit of an other coalition in the Zone.</li>
<li><strong>Empty</strong>: The Zone is empty. There is not valid unit in the Zone.
</li>
</ul>
</dd>
</dl>
<h2><a id="#(ZoneCaptureCoalition)" >Type <code>ZoneCaptureCoalition</code></a></h2>
<h2><a id="#(ZONE_CAPTURE_COALITION)" >Type <code>ZONE_CAPTURE_COALITION</code></a></h2>
<h3>Field(s)</h3>
<dl class="function">
<dt>
<a id="#(ZONE_CAPTURE_COALITION).Attack" >
<strong>ZONE_CAPTURE_COALITION:Attack()</strong>
</a>
</dt>
<dd>
<p>Attack Trigger for ZONE_CAPTURE_COALITION</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ZONE_CAPTURE_COALITION).Capture" >
<strong>ZONE_CAPTURE_COALITION:Capture()</strong>
</a>
</dt>
<dd>
<p>Capture Trigger for ZONE_CAPTURE_COALITION</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ZONE_CAPTURE_COALITION).Empty" >
<strong>ZONE_CAPTURE_COALITION:Empty()</strong>
</a>
</dt>
<dd>
<p>Empty Trigger for ZONE_CAPTURE_COALITION</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ZONE_CAPTURE_COALITION).Guard" >
<strong>ZONE_CAPTURE_COALITION:Guard()</strong>
</a>
</dt>
<dd>
<p>Guard Trigger for ZONE_CAPTURE_COALITION</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ZONE_CAPTURE_COALITION).IsAttacked" >
<strong>ZONE_CAPTURE_COALITION:IsAttacked()</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ZONE_CAPTURE_COALITION).IsCaptured" >
<strong>ZONE_CAPTURE_COALITION:IsCaptured()</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ZONE_CAPTURE_COALITION).IsEmpty" >
<strong>ZONE_CAPTURE_COALITION:IsEmpty()</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ZONE_CAPTURE_COALITION).IsGuarded" >
<strong>ZONE_CAPTURE_COALITION:IsGuarded()</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ZONE_CAPTURE_COALITION).Mark" >
<strong>ZONE_CAPTURE_COALITION:Mark()</strong>
</a>
</dt>
<dd>
<p>Mark.</p>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(ZONE_CAPTURE_COALITION).MarkBlue" >
<strong>ZONE_CAPTURE_COALITION.MarkBlue</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(ZONE_CAPTURE_COALITION).MarkRed" >
<strong>ZONE_CAPTURE_COALITION.MarkRed</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ZONE_CAPTURE_COALITION).New" >
<strong>ZONE_CAPTURE_COALITION:New(Zone, Coalition)</strong>
</a>
</dt>
<dd>
<p>ZONE<em>CAPTURE</em>COALITION Constructor.</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em><a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a> Zone </em></code>:
A <a href="Zone.html">Zone</a> object with the goal to be achieved.</p>
</li>
<li>
<p><code><em><a href="DCSCoalition.DCSCoalition.html##(coalition)">DCSCoalition.DCSCoalition#coalition</a> Coalition </em></code>:
The initial coalition owning the zone.</p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="##(ZONE_CAPTURE_COALITION)">#ZONE<em>CAPTURE</em>COALITION</a>:</em></p>
<h3>Usage:</h3>
<pre class="example"><code>
AttackZone = ZONE:New( "AttackZone" )
ZoneCaptureCoalition = ZONE_CAPTURE_COALITION:New( AttackZone, coalition.side.RED ) -- Create a new ZONE_CAPTURE_COALITION object of zone AttackZone with ownership RED coalition.
ZoneCaptureCoalition:__Guard( 1 ) -- Start the Guarding of the AttackZone.
</code></pre>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ZONE_CAPTURE_COALITION).OnAfterAttack" >
<strong>ZONE_CAPTURE_COALITION:OnAfterAttack(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>Attack Handler OnAfter for ZONE_CAPTURE_COALITION</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>: </p>
</li>
<li>
<p><code><em>#string Event </em></code>: </p>
</li>
<li>
<p><code><em>#string To </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ZONE_CAPTURE_COALITION).OnAfterCapture" >
<strong>ZONE_CAPTURE_COALITION:OnAfterCapture(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>Capture Handler OnAfter for ZONE_CAPTURE_COALITION</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>: </p>
</li>
<li>
<p><code><em>#string Event </em></code>: </p>
</li>
<li>
<p><code><em>#string To </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ZONE_CAPTURE_COALITION).OnAfterEmpty" >
<strong>ZONE_CAPTURE_COALITION:OnAfterEmpty(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>Empty Handler OnAfter for ZONE_CAPTURE_COALITION</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>: </p>
</li>
<li>
<p><code><em>#string Event </em></code>: </p>
</li>
<li>
<p><code><em>#string To </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ZONE_CAPTURE_COALITION).OnAfterGuard" >
<strong>ZONE_CAPTURE_COALITION:OnAfterGuard(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>Guard Handler OnAfter for ZONE_CAPTURE_COALITION</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>: </p>
</li>
<li>
<p><code><em>#string Event </em></code>: </p>
</li>
<li>
<p><code><em>#string To </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ZONE_CAPTURE_COALITION).OnBeforeAttack" >
<strong>ZONE_CAPTURE_COALITION:OnBeforeAttack(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>Attack Handler OnBefore for ZONE_CAPTURE_COALITION</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>: </p>
</li>
<li>
<p><code><em>#string Event </em></code>: </p>
</li>
<li>
<p><code><em>#string To </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#boolean:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ZONE_CAPTURE_COALITION).OnBeforeCapture" >
<strong>ZONE_CAPTURE_COALITION:OnBeforeCapture(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>Capture Handler OnBefore for ZONE_CAPTURE_COALITION</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>: </p>
</li>
<li>
<p><code><em>#string Event </em></code>: </p>
</li>
<li>
<p><code><em>#string To </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#boolean:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ZONE_CAPTURE_COALITION).OnBeforeEmpty" >
<strong>ZONE_CAPTURE_COALITION:OnBeforeEmpty(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>Empty Handler OnBefore for ZONE_CAPTURE_COALITION</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>: </p>
</li>
<li>
<p><code><em>#string Event </em></code>: </p>
</li>
<li>
<p><code><em>#string To </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#boolean:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ZONE_CAPTURE_COALITION).OnBeforeGuard" >
<strong>ZONE_CAPTURE_COALITION:OnBeforeGuard(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>Guard Handler OnBefore for ZONE_CAPTURE_COALITION</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>: </p>
</li>
<li>
<p><code><em>#string Event </em></code>: </p>
</li>
<li>
<p><code><em>#string To </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#boolean:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(ZONE_CAPTURE_COALITION).ScheduleStatusZone" >
<strong>ZONE_CAPTURE_COALITION.ScheduleStatusZone</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(ZONE_CAPTURE_COALITION).SmokeScheduler" >
<strong>ZONE_CAPTURE_COALITION.SmokeScheduler</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(ZONE_CAPTURE_COALITION).States" >
<strong>ZONE_CAPTURE_COALITION.States</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ZONE_CAPTURE_COALITION).StatusZone" >
<strong>ZONE_CAPTURE_COALITION:StatusZone()</strong>
</a>
</dt>
<dd>
<p>Check status Coalition ownership.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ZONE_CAPTURE_COALITION).__Attack" >
<strong>ZONE_CAPTURE_COALITION:__Attack(Delay)</strong>
</a>
</dt>
<dd>
<p>Attack Asynchronous Trigger for ZONE_CAPTURE_COALITION</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#number Delay </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ZONE_CAPTURE_COALITION).__Capture" >
<strong>ZONE_CAPTURE_COALITION:__Capture(Delay)</strong>
</a>
</dt>
<dd>
<p>Capture Asynchronous Trigger for ZONE_CAPTURE_COALITION</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#number Delay </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ZONE_CAPTURE_COALITION).__Empty" >
<strong>ZONE_CAPTURE_COALITION:__Empty(Delay)</strong>
</a>
</dt>
<dd>
<p>Empty Asynchronous Trigger for ZONE_CAPTURE_COALITION</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#number Delay </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ZONE_CAPTURE_COALITION).__Guard" >
<strong>ZONE_CAPTURE_COALITION:__Guard(Delay)</strong>
</a>
</dt>
<dd>
<p>Guard Asynchronous Trigger for ZONE_CAPTURE_COALITION</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#number Delay </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ZONE_CAPTURE_COALITION).onafterGuard" >
<strong>ZONE_CAPTURE_COALITION:onafterGuard()</strong>
</a>
</dt>
<dd>
<p>When started, check the Coalition status.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ZONE_CAPTURE_COALITION).onenterAttacked" >
<strong>ZONE_CAPTURE_COALITION:onenterAttacked()</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ZONE_CAPTURE_COALITION).onenterCaptured" >
<strong>ZONE_CAPTURE_COALITION:onenterCaptured()</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ZONE_CAPTURE_COALITION).onenterEmpty" >
<strong>ZONE_CAPTURE_COALITION:onenterEmpty()</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(ZONE_CAPTURE_COALITION).onenterGuarded" >
<strong>ZONE_CAPTURE_COALITION:onenterGuarded()</strong>
</a>
</dt>
<dd>
<p>Bound.</p>
</dd>
</dl>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink