Fixed and documentation of ZONE_CAPTURE_COALITION

Moose Development/Moose/Functional/ZoneCaptureCoalition.lua

@@ -58,6 +58,13 @@ do -- ZoneGoal
   -- @param Core.Zone#ZONE Zone A @{Zone} object with the goal to be achieved.
   -- @param DCSCoalition.DCSCoalition#coalition Coalition The initial coalition owning the zone.
   -- @return #ZONE_CAPTURE_COALITION
+  -- @usage
+  -- 
+  --  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.
+  --  
   function ZONE_CAPTURE_COALITION:New( Zone, Coalition )
   
     local self = BASE:Inherit( self, ZONE_GOAL_COALITION:New( Zone, Coalition ) ) -- #ZONE_CAPTURE_COALITION
@@ -247,6 +254,10 @@ do -- ZoneGoal
     -- @param #ZONE_CAPTURE_COALITION self
     -- @param #number Delay
 
+    if not self.ScheduleStatusZone then
+      self.ScheduleStatusZone = self:ScheduleRepeat( 15, 15, 0.1, nil, self.StatusZone, self )
+    end
+
     return self
   end
   
@@ -370,9 +381,6 @@ do -- ZoneGoal
     if not self.SmokeScheduler then
       self.SmokeScheduler = self:ScheduleRepeat( 1, 1, 0.1, nil, self.StatusSmoke, self )
     end
-    if not self.ScheduleStatusZone then
-      self.ScheduleStatusZone = self:ScheduleRepeat( 15, 15, 0.1, nil, self.StatusZone, self )
-    end
   end
 
 

docs/Documentation/AI_A2A.html

@@ -672,6 +672,7 @@
 		<dl class="function">
 <dt>
 
+		<em>#number</em>
 <a id="#(AI_A2A).IdleCount" >
 <strong>AI_A2A.IdleCount</strong>
 </a>

docs/Documentation/Cargo.html

@@ -2270,7 +2270,6 @@ The amount of seconds to delay the action.</p>
 		<dl class="function">
 <dt>
 
-		<em></em>
 <a id="#(CARGO_CRATE).CargoCarrier" >
 <strong>CARGO_CRATE.CargoCarrier</strong>
 </a>
@@ -3806,6 +3805,7 @@ The range till cargo will board.</p>
 		<dl class="function">
 <dt>
 
+		<em>#number</em>
 <a id="#(CARGO_UNIT).RunCount" >
 <strong>CARGO_UNIT.RunCount</strong>
 </a>

docs/Documentation/Designate.html

@@ -1107,7 +1107,7 @@ function below will use the range 1-7 just in case</p>
 		<dl class="function">
 <dt>
 
-		<em></em>
+		<em>#number</em>
 <a id="#(DESIGNATE).LaseDuration" >
 <strong>DESIGNATE.LaseDuration</strong>
 </a>
@@ -1161,7 +1161,6 @@ function below will use the range 1-7 just in case</p>
 		<dl class="function">
 <dt>
 
-		<em></em>
 <a id="#(DESIGNATE).LaserCodes" >
 <strong>DESIGNATE.LaserCodes</strong>
 </a>

docs/Documentation/Detection.html

@@ -4062,7 +4062,7 @@ Return false to cancel Transition.</p>
 		<dl class="function">
 <dt>
 
-		<em></em>
+		<em>#number</em>
 <a id="#(DETECTION_BASE).RefreshTimeInterval" >
 <strong>DETECTION_BASE.RefreshTimeInterval</strong>
 </a>

docs/Documentation/Fsm.html

@@ -1609,7 +1609,7 @@ A string defining the start state.</p>
 		<dl class="function">
 <dt>
 
-		<em></em>
+		<em>#string</em>
 <a id="#(FSM)._StartState" >
 <strong>FSM._StartState</strong>
 </a>
@@ -1908,7 +1908,6 @@ A string defining the start state.</p>
 		<dl class="function">
 <dt>
 
-		<em></em>
 <a id="#(FSM).current" >
 <strong>FSM.current</strong>
 </a>

docs/Documentation/Movement.html

@@ -238,6 +238,7 @@ on defined intervals (currently every minute).</p>
 		<dl class="function">
 <dt>
 
+		<em>#number</em>
 <a id="#(MOVEMENT).AliveUnits" >
 <strong>MOVEMENT.AliveUnits</strong>
 </a>
@@ -246,6 +247,9 @@ on defined intervals (currently every minute).</p>
 	
 
 
+	
+<p> Contains the counter how many units are currently alive</p>
+
 </dd>
 </dl>
 		<dl class="function">

docs/Documentation/Point.html

@@ -3496,6 +3496,7 @@ The y coordinate.</p>
 		<dl class="function">
 <dt>
 
+		<em></em>
 <a id="#(POINT_VEC2).z" >
 <strong>POINT_VEC2.z</strong>
 </a>

docs/Documentation/Rat.html

@@ -1363,18 +1363,6 @@
 		<td class="name" nowrap="nowrap"><a href="##(RAT).wp">RAT.wp</a></td>
 		<td class="summary">
 <p>RAT waypoint type.</p>
-</td>
-		</tr>
-		<tr>
-		<td class="name" nowrap="nowrap"><a href="##(RAT).wp_final">RAT.wp_final</a></td>
-		<td class="summary">
-<p>Index of the final waypoint.</p>
-</td>
-		</tr>
-		<tr>
-		<td class="name" nowrap="nowrap"><a href="##(RAT).wp_holding">RAT.wp_holding</a></td>
-		<td class="summary">
-<p>Index of the holding waypoint.</p>
 </td>
 		</tr>
 	</table>
@@ -5659,34 +5647,6 @@ True if zone exsits, false otherwise. </p>
 	
 <p>RAT waypoint type.</p>
 
-</dd>
-</dl>
-		<dl class="function">
-<dt>
-
-		<em>#number</em>
-<a id="#(RAT).wp_final" >
-<strong>RAT.wp_final</strong>
-</a>
-</dt>
-<dd>
-	
-<p>Index of the final waypoint.</p>
-
-</dd>
-</dl>
-		<dl class="function">
-<dt>
-
-		<em>#number</em>
-<a id="#(RAT).wp_holding" >
-<strong>RAT.wp_holding</strong>
-</a>
-</dt>
-<dd>
-	
-<p>Index of the holding waypoint.</p>
-
 </dd>
 </dl>
 

docs/Documentation/Settings.html

@@ -1251,7 +1251,7 @@ true if metric.</p>
 		<dl class="function">
 <dt>
 
-		<em>#boolean</em>
+		<em></em>
 <a id="#(SETTINGS).Metric" >
 <strong>SETTINGS.Metric</strong>
 </a>

docs/Documentation/Spawn.html

@@ -849,12 +849,6 @@ and any spaces before and after the resulting name are removed.</p>
 		<td class="name" nowrap="nowrap"><a href="##(SPAWN)._TranslateRotate">SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle)</a></td>
 		<td class="summary">
 
-</td>
-		</tr>
-		<tr>
-		<td class="name" nowrap="nowrap"><a href="##(SPAWN).uncontrolled">SPAWN.uncontrolled</a></td>
-		<td class="summary">
-
 </td>
 		</tr>
 	</table>
@@ -3387,7 +3381,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
 		<dl class="function">
 <dt>
 
-		<em></em>
+		<em>#boolean</em>
 <a id="#(SPAWN).SpawnUnControlled" >
 <strong>SPAWN.SpawnUnControlled</strong>
 </a>
@@ -3991,20 +3985,6 @@ True = Continue Scheduler</p>
 
 				</li>
 		</ul>
-</dd>
-</dl>
-		<dl class="function">
-<dt>
-
-		<em></em>
-<a id="#(SPAWN).uncontrolled" >
-<strong>SPAWN.uncontrolled</strong>
-</a>
-</dt>
-<dd>
-	
-
-
 </dd>
 </dl>
 

docs/Documentation/Spot.html

@@ -776,7 +776,6 @@ true if it is lasing</p>
 		<dl class="function">
 <dt>
 
-		<em></em>
 <a id="#(SPOT).ScheduleID" >
 <strong>SPOT.ScheduleID</strong>
 </a>
@@ -790,7 +789,6 @@ true if it is lasing</p>
 		<dl class="function">
 <dt>
 
-		<em></em>
 <a id="#(SPOT).SpotIR" >
 <strong>SPOT.SpotIR</strong>
 </a>
@@ -804,7 +802,6 @@ true if it is lasing</p>
 		<dl class="function">
 <dt>
 
-		<em></em>
 <a id="#(SPOT).SpotLaser" >
 <strong>SPOT.SpotLaser</strong>
 </a>
@@ -818,7 +815,6 @@ true if it is lasing</p>
 		<dl class="function">
 <dt>
 
-		<em></em>
 <a id="#(SPOT).Target" >
 <strong>SPOT.Target</strong>
 </a>

docs/Documentation/Task_Cargo.html

@@ -563,7 +563,7 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
 		<dl class="function">
 <dt>
 
-		<em></em>
+		<em><a href="Core.Cargo.html##(CARGO_GROUP)">Core.Cargo#CARGO_GROUP</a></em>
 <a id="#(FSM_PROCESS).Cargo" >
 <strong>FSM_PROCESS.Cargo</strong>
 </a>
@@ -577,6 +577,7 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
 		<dl class="function">
 <dt>
 
+		<em></em>
 <a id="#(FSM_PROCESS).DeployZone" >
 <strong>FSM_PROCESS.DeployZone</strong>
 </a>

docs/Documentation/ZoneCaptureCoalition.html

@@ -573,6 +573,14 @@ The initial coalition owning the zone.</p>
 <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">

docs/README.md

@@ -123,6 +123,9 @@ MOOSE Functional Classes provide various functions that are useful in mission de
   * [ATC_GROUND](Documentation/ATC_Ground.html#ATC_GROUND_NEVADA): ATC Ground operations for Nevada.
   * [ATC_GROUND](Documentation/ATC_Ground.html#ATC_GROUND_NORMANDY): ATC Ground operations for Normandy.
 
+* [ZONE\_CAPTURE\_COALITION](Documentation/ZoneCaptureCoalition.html): Create a zone capturing process around a zone! Zones can be guarded, attacked, empty or captured.
+
+
 ## 2.4. MOOSE Wrapper Classes
 
 MOOSE Wrapper Classes provide an object oriented hierarchical mechanism to manage the DCS objects within the simulator.