FlightControl-Master/MOOSE
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE.git synced 2025-10-29 16:58:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation

Browse Source
This commit is contained in:
FlightControl_Master
2017-11-01 17:50:04 +01:00
parent 7bc0f103d9
commit e625aaf28c
17 changed files with 112 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files

91
docs/Documentation/ZoneCaptureCoalition.html
View File

@@ -116,12 +116,17 @@
<div id="content">
<h1>Module <code>ZoneCaptureCoalition</code></h1>
<p><strong>Functional (wIP)</strong> -- Models the process to capture a Zone for a Coalition, which is guarded by another Coalition.</p>
<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/>
@@ -132,7 +137,7 @@
<tr>
<td class="name" nowrap="nowrap"><a href="#ZONE_CAPTURE_COALITION">ZONE_CAPTURE_COALITION</a></td>
<td class="summary">
<h1>ZONE<em>CAPTURE</em>COALITION class, extends <a href="ZoneGoalCoalition.html##(ZONE_GOAL_COALITION)">ZoneGoalCoalition#ZONE<em>GOAL</em>COALITION</a></h1>
<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>
@@ -143,25 +148,25 @@
<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<em>CAPTURE</em>COALITION</p>
<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<em>CAPTURE</em>COALITION</p>
<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<em>CAPTURE</em>COALITION</p>
<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<em>CAPTURE</em>COALITION</p>
<p>Guard Trigger for ZONE_CAPTURE_COALITION</p>
</td>
</tr>
<tr>
@@ -215,49 +220,49 @@
<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<em>CAPTURE</em>COALITION</p>
<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<em>CAPTURE</em>COALITION</p>
<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<em>CAPTURE</em>COALITION</p>
<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<em>CAPTURE</em>COALITION</p>
<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<em>CAPTURE</em>COALITION</p>
<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<em>CAPTURE</em>COALITION</p>
<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<em>CAPTURE</em>COALITION</p>
<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<em>CAPTURE</em>COALITION</p>
<p>Guard Handler OnBefore for ZONE_CAPTURE_COALITION</p>
</td>
</tr>
<tr>
@@ -287,25 +292,25 @@
<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<em>CAPTURE</em>COALITION</p>
<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<em>CAPTURE</em>COALITION</p>
<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<em>CAPTURE</em>COALITION</p>
<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<em>CAPTURE</em>COALITION</p>
<p>Guard Asynchronous Trigger for ZONE_CAPTURE_COALITION</p>
</td>
</tr>
<tr>
@@ -351,12 +356,18 @@
</dt>
<dd>
<h1>ZONE<em>CAPTURE</em>COALITION class, extends <a href="ZoneGoalCoalition.html##(ZONE_GOAL_COALITION)">ZoneGoalCoalition#ZONE<em>GOAL</em>COALITION</a></h1>
<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.
@@ -364,15 +375,15 @@ When units of the other coalition are in the Zone, and no other units of the own
<p>Event handlers can be defined by the mission designer to action on the state transitions.</p>
<h2>1. ZONE<em>CAPTURE</em>COALITION constructor</h2>
<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<em>CAPTURE</em>COALITION object.</li>
<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<em>CAPTURE</em>COALITION is a finite state machine (FSM).</h2>
<h2>2. ZONE_CAPTURE_COALITION is a finite state machine (FSM).</h2>
<h3>2.1 ZONE<em>CAPTURE</em>COALITION States</h3>
<h3>2.1 ZONE_CAPTURE_COALITION States</h3>
<ul>
<li><strong>Captured</strong>: The Zone has been captured by an other coalition.</li>
@@ -381,7 +392,7 @@ When units of the other coalition are in the Zone, and no other units of the own
<li><strong>Empty</strong>: The Zone is empty. There is not valid unit in the Zone.</li>
</ul>
<h3>2.2 ZONE<em>CAPTURE</em>COALITION Events</h3>
<h3>2.2 ZONE_CAPTURE_COALITION Events</h3>
<ul>
<li><strong>Capture</strong>: The Zone has been captured by an other coalition.</li>
@@ -406,7 +417,7 @@ When units of the other coalition are in the Zone, and no other units of the own
</dt>
<dd>
<p>Attack Trigger for ZONE<em>CAPTURE</em>COALITION</p>
<p>Attack Trigger for ZONE_CAPTURE_COALITION</p>
</dd>
</dl>
@@ -419,7 +430,7 @@ When units of the other coalition are in the Zone, and no other units of the own
</dt>
<dd>
<p>Capture Trigger for ZONE<em>CAPTURE</em>COALITION</p>
<p>Capture Trigger for ZONE_CAPTURE_COALITION</p>
</dd>
</dl>
@@ -432,7 +443,7 @@ When units of the other coalition are in the Zone, and no other units of the own
</dt>
<dd>
<p>Empty Trigger for ZONE<em>CAPTURE</em>COALITION</p>
<p>Empty Trigger for ZONE_CAPTURE_COALITION</p>
</dd>
</dl>
@@ -445,7 +456,7 @@ When units of the other coalition are in the Zone, and no other units of the own
</dt>
<dd>
<p>Guard Trigger for ZONE<em>CAPTURE</em>COALITION</p>
<p>Guard Trigger for ZONE_CAPTURE_COALITION</p>
</dd>
</dl>
@@ -592,7 +603,7 @@ The initial coalition owning the zone.</p>
</dt>
<dd>
<p>Attack Handler OnAfter for ZONE<em>CAPTURE</em>COALITION</p>
<p>Attack Handler OnAfter for ZONE_CAPTURE_COALITION</p>
<h3>Parameters</h3>
<ul>
@@ -623,7 +634,7 @@ The initial coalition owning the zone.</p>
</dt>
<dd>
<p>Capture Handler OnAfter for ZONE<em>CAPTURE</em>COALITION</p>
<p>Capture Handler OnAfter for ZONE_CAPTURE_COALITION</p>
<h3>Parameters</h3>
<ul>
@@ -654,7 +665,7 @@ The initial coalition owning the zone.</p>
</dt>
<dd>
<p>Empty Handler OnAfter for ZONE<em>CAPTURE</em>COALITION</p>
<p>Empty Handler OnAfter for ZONE_CAPTURE_COALITION</p>
<h3>Parameters</h3>
<ul>
@@ -685,7 +696,7 @@ The initial coalition owning the zone.</p>
</dt>
<dd>
<p>Guard Handler OnAfter for ZONE<em>CAPTURE</em>COALITION</p>
<p>Guard Handler OnAfter for ZONE_CAPTURE_COALITION</p>
<h3>Parameters</h3>
<ul>
@@ -716,7 +727,7 @@ The initial coalition owning the zone.</p>
</dt>
<dd>
<p>Attack Handler OnBefore for ZONE<em>CAPTURE</em>COALITION</p>
<p>Attack Handler OnBefore for ZONE_CAPTURE_COALITION</p>
<h3>Parameters</h3>
<ul>
@@ -752,7 +763,7 @@ The initial coalition owning the zone.</p>
</dt>
<dd>
<p>Capture Handler OnBefore for ZONE<em>CAPTURE</em>COALITION</p>
<p>Capture Handler OnBefore for ZONE_CAPTURE_COALITION</p>
<h3>Parameters</h3>
<ul>
@@ -788,7 +799,7 @@ The initial coalition owning the zone.</p>
</dt>
<dd>
<p>Empty Handler OnBefore for ZONE<em>CAPTURE</em>COALITION</p>
<p>Empty Handler OnBefore for ZONE_CAPTURE_COALITION</p>
<h3>Parameters</h3>
<ul>
@@ -824,7 +835,7 @@ The initial coalition owning the zone.</p>
</dt>
<dd>
<p>Guard Handler OnBefore for ZONE<em>CAPTURE</em>COALITION</p>
<p>Guard Handler OnBefore for ZONE_CAPTURE_COALITION</p>
<h3>Parameters</h3>
<ul>
@@ -915,7 +926,7 @@ The initial coalition owning the zone.</p>
</dt>
<dd>
<p>Attack Asynchronous Trigger for ZONE<em>CAPTURE</em>COALITION</p>
<p>Attack Asynchronous Trigger for ZONE_CAPTURE_COALITION</p>
<h3>Parameter</h3>
<ul>
@@ -936,7 +947,7 @@ The initial coalition owning the zone.</p>
</dt>
<dd>
<p>Capture Asynchronous Trigger for ZONE<em>CAPTURE</em>COALITION</p>
<p>Capture Asynchronous Trigger for ZONE_CAPTURE_COALITION</p>
<h3>Parameter</h3>
<ul>
@@ -957,7 +968,7 @@ The initial coalition owning the zone.</p>
</dt>
<dd>
<p>Empty Asynchronous Trigger for ZONE<em>CAPTURE</em>COALITION</p>
<p>Empty Asynchronous Trigger for ZONE_CAPTURE_COALITION</p>
<h3>Parameter</h3>
<ul>
@@ -978,7 +989,7 @@ The initial coalition owning the zone.</p>
</dt>
<dd>
<p>Guard Asynchronous Trigger for ZONE<em>CAPTURE</em>COALITION</p>
<p>Guard Asynchronous Trigger for ZONE_CAPTURE_COALITION</p>
<h3>Parameter</h3>
<ul>