Fixed friendlies nearby calculation

* Added DETECTION_BASE:FilterFriendliesCategory() method, which allows
to filter friendlies based on the category of the units found. This
method was required to be added to avoid counting airborne units as
friendlies in A2G missions.

Moose Development/Moose/AI/AI_A2A_Dispatcher.lua

@@ -1239,7 +1239,7 @@ do -- AI_A2A_DISPATCHER
 
 
   --- Set the default CAP limit for squadrons, which will be used to determine how many CAP can be airborne at the same time for the squadron.
-  -- The default CAP time interval is 1 CAP.
+  -- The default CAP limit is 1 CAP, which means one CAP group being spawned.
   -- @param #AI_A2A_DISPATCHER self
   -- @param #number CapLimit The maximum amount of CAP that can be airborne at the same time for the squadron.
   -- @return #AI_A2A_DISPATCHER
@@ -1497,7 +1497,7 @@ do -- AI_A2A_DISPATCHER
   end
 
   
-  ---
+  --- Set a CAP for a Squadron.
   -- @param #AI_A2A_DISPATCHER self
   -- @param #string SquadronName The squadron name.
   -- @param Core.Zone#ZONE_BASE Zone The @{Zone} object derived from @{Zone#ZONE_BASE} that defines the zone wherein the CAP will be executed.
@@ -1549,9 +1549,13 @@ do -- AI_A2A_DISPATCHER
     return self
   end
   
-  ---
+  --- Set the squadron CAP parameters.  
   -- @param #AI_A2A_DISPATCHER self
   -- @param #string SquadronName The squadron name.
+  -- @param #number CapLimit (optional) The maximum amount of CAP groups to be spawned. Note that a CAP is a group, so can consist out of 1 to 4 airplanes. The default is 1 CAP group.
+  -- @param #number LowInterval (optional) The minimum time boundary in seconds when a new CAP will be spawned. The default is 180 seconds.
+  -- @param #number HighInterval (optional) The maximum time boundary in seconds when a new CAP will be spawned. The default is 600 seconds.
+  -- @param #number Probability Is not in use, you can skip this parameter.
   -- @return #AI_A2A_DISPATCHER
   -- @usage
   -- 
@@ -1577,10 +1581,10 @@ do -- AI_A2A_DISPATCHER
 
     local Cap = self.DefenderSquadrons[SquadronName].Cap
     if Cap then
-      Cap.LowInterval = LowInterval or 300
+      Cap.LowInterval = LowInterval or 180
       Cap.HighInterval = HighInterval or 600
       Cap.Probability = Probability or 1
-      Cap.CapLimit = CapLimit
+      Cap.CapLimit = CapLimit or 1
       Cap.Scheduler = Cap.Scheduler or SCHEDULER:New( self ) 
       local Scheduler = Cap.Scheduler -- Core.Scheduler#SCHEDULER
       local ScheduleID = Cap.ScheduleID

Moose Development/Moose/Functional/Detection.lua

@@ -1140,7 +1140,7 @@ do -- DETECTION_BASE
   
   end
   
-  do -- Threat
+  do -- NearBy calculations
   
     --- Returns if there are friendlies nearby the FAC units ...
     -- @param #DETECTION_BASE self
@@ -1158,6 +1158,15 @@ do -- DETECTION_BASE
       return DetectedItem.FriendliesNearBy
     end
     
+    --- Filters friendly units by unit category.
+    -- @param #DETECTION_BASE self
+    -- @param FriendliesCategory
+    -- @return #DETECTION_BASE
+    function DETECTION_BASE:FilterFriendliesCategory( FriendliesCategory )
+      self.FriendliesCategory = FriendliesCategory
+      return self
+    end
+  
     --- Returns if there are friendlies nearby the intercept ...
     -- @param #DETECTION_BASE self
     -- @return #boolean trhe if there are friendlies near the intercept.
@@ -1245,15 +1254,18 @@ do -- DETECTION_BASE
           --self:F( { "Friendlies search:", FoundUnitName, FoundUnitCoalition, EnemyUnitName, EnemyCoalition, FoundUnitInReportSetGroup } )
           
           if FoundUnitCoalition ~= EnemyCoalition and FoundUnitInReportSetGroup == false then
-            DetectedItem.FriendliesNearBy = DetectedItem.FriendliesNearBy or {}
             local FriendlyUnit = UNIT:Find( FoundDCSUnit )
             local FriendlyUnitName = FriendlyUnit:GetName()
+            local FriendlyUnitCategory = FriendlyUnit:GetDesc().category
+            self:T( { FriendlyUnitCategory = FriendlyUnitCategory, FriendliesCategory = self.FriendliesCategory } )
             
-            DetectedItem.FriendliesNearBy[FriendlyUnitName] = FriendlyUnit
+            if ( not self.FriendliesCategory ) or ( self.FriendliesCategory and ( self.FriendliesCategory == FriendlyUnitCategory ) ) then
-            
+              DetectedItem.FriendliesNearBy = DetectedItem.FriendliesNearBy or {}
-            local Distance = DetectedUnitCoord:Get2DDistance( FriendlyUnit:GetCoordinate() )
+              DetectedItem.FriendliesNearBy[FriendlyUnitName] = FriendlyUnit
-            DetectedItem.FriendliesDistance = DetectedItem.FriendliesDistance or {}
+              local Distance = DetectedUnitCoord:Get2DDistance( FriendlyUnit:GetCoordinate() )
-            DetectedItem.FriendliesDistance[Distance] = FriendlyUnit
+              DetectedItem.FriendliesDistance = DetectedItem.FriendliesDistance or {}
+              DetectedItem.FriendliesDistance[Distance] = FriendlyUnit
+            end
             return true
           end
           
@@ -1269,23 +1281,28 @@ do -- DETECTION_BASE
           --- @param Wrapper.Unit#UNIT PlayerUnit
           function( PlayerUnitName )
             local PlayerUnit = UNIT:FindByName( PlayerUnitName )
+            local PlayerUnitCategory = PlayerUnit:GetDesc().category
 
             if PlayerUnit and PlayerUnit:IsInZone(DetectionZone) then
     
-              DetectedItem.FriendliesNearBy = DetectedItem.FriendliesNearBy or {}
+              if ( not self.FriendliesCategory ) or ( self.FriendliesCategory and ( self.FriendliesCategory == PlayerUnitCategory ) ) then
-              local PlayerUnitName = PlayerUnit:GetName()
 
-              DetectedItem.PlayersNearBy = DetectedItem.PlayersNearBy or {}
+                DetectedItem.FriendliesNearBy = DetectedItem.FriendliesNearBy or {}
-              DetectedItem.PlayersNearBy[PlayerUnitName] = PlayerUnit
+                local PlayerUnitName = PlayerUnit:GetName()
       
-              DetectedItem.FriendliesNearBy = DetectedItem.FriendliesNearBy or {}
+                DetectedItem.PlayersNearBy = DetectedItem.PlayersNearBy or {}
-              DetectedItem.FriendliesNearBy[PlayerUnitName] = PlayerUnit
+                DetectedItem.PlayersNearBy[PlayerUnitName] = PlayerUnit
       
-              local CenterCoord = DetectedUnit:GetCoordinate()
+                DetectedItem.FriendliesNearBy = DetectedItem.FriendliesNearBy or {}
+                DetectedItem.FriendliesNearBy[PlayerUnitName] = PlayerUnit
       
-              local Distance = CenterCoord:Get2DDistance( PlayerUnit:GetCoordinate() )
+                local CenterCoord = DetectedUnit:GetCoordinate()
-              DetectedItem.FriendliesDistance = DetectedItem.FriendliesDistance or {}
+  
-              DetectedItem.FriendliesDistance[Distance] = PlayerUnit
+                local Distance = CenterCoord:Get2DDistance( PlayerUnit:GetCoordinate() )
+                DetectedItem.FriendliesDistance = DetectedItem.FriendliesDistance or {}
+                DetectedItem.FriendliesDistance[Distance] = PlayerUnit
+
+              end
             end
           end
         )

Moose Development/Moose/Tasking/Task_A2G_Dispatcher.lua

@@ -59,6 +59,7 @@ do -- TASK_A2G_DISPATCHER
     self.Mission = Mission
     
     self.Detection:FilterCategories( Unit.Category.GROUND_UNIT, Unit.Category.SHIP )
+    self.Detection:FilterFriendliesCategory( Unit.Category.GROUND_UNIT )
     
     self:AddTransition( "Started", "Assign", "Started" )
     

docs/Documentation/AI_A2A_Dispatcher.html

@@ -757,13 +757,13 @@ Per one, two, three, four?</p>
 		<tr>
 		<td class="name" nowrap="nowrap"><a href="##(AI_A2A_DISPATCHER).SetSquadronCap">AI_A2A_DISPATCHER:SetSquadronCap(SquadronName, Zone, FloorAltitude, CeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, EngageMinSpeed, EngageMaxSpeed, AltType)</a></td>
 		<td class="summary">
-
+<p>Set a CAP for a Squadron.</p>
 </td>
 		</tr>
 		<tr>
 		<td class="name" nowrap="nowrap"><a href="##(AI_A2A_DISPATCHER).SetSquadronCapInterval">AI_A2A_DISPATCHER:SetSquadronCapInterval(SquadronName, CapLimit, LowInterval, HighInterval, Probability)</a></td>
 		<td class="summary">
-
+<p>Set the squadron CAP parameters.</p>
 </td>
 		</tr>
 		<tr>
@@ -3293,7 +3293,7 @@ or
 <p>Set the default CAP limit for squadrons, which will be used to determine how many CAP can be airborne at the same time for the squadron.</p>
 
 	
-<p>The default CAP time interval is 1 CAP.</p>
+<p>The default CAP limit is 1 CAP, which means one CAP group being spawned.</p>
 
 		<h3>Parameter</h3>
 		<ul>
@@ -4251,7 +4251,7 @@ If you have only one prefix name for a squadron, you don't need to use the <code
 </dt>
 <dd>
 	
-
+<p>Set a CAP for a Squadron.</p>
 
 		<h3>Parameters</h3>
 		<ul>
@@ -4342,8 +4342,11 @@ The altitude type, which is a string "BARO" defining Barometric or "RADIO" defin
 </dt>
 <dd>
 	
+<p>Set the squadron CAP parameters.</p>
 
 	
+<p> </p>
+
 		<h3>Parameters</h3>
 		<ul>
 				<li>
@@ -4354,22 +4357,26 @@ The squadron name.</p>
 				</li>
 				<li>
 				
-<p><code><em> CapLimit </em></code>: </p>
+<p><code><em>#number CapLimit </em></code>: 
+(optional) The maximum amount of CAP groups to be spawned. Note that a CAP is a group, so can consist out of 1 to 4 airplanes. The default is 1 CAP group.</p>
 
 				</li>
 				<li>
 				
-<p><code><em> LowInterval </em></code>: </p>
+<p><code><em>#number LowInterval </em></code>: 
+(optional) The minimum time boundary in seconds when a new CAP will be spawned. The default is 180 seconds.</p>
 
 				</li>
 				<li>
 				
-<p><code><em> HighInterval </em></code>: </p>
+<p><code><em>#number HighInterval </em></code>: 
+(optional) The maximum time boundary in seconds when a new CAP will be spawned. The default is 600 seconds.</p>
 
 				</li>
 				<li>
 				
-<p><code><em> Probability </em></code>: </p>
+<p><code><em>#number Probability </em></code>: 
+Is not in use, you can skip this parameter.</p>
 
 				</li>
 		</ul>

docs/Documentation/Cargo.html

@@ -3542,7 +3542,6 @@ 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

@@ -1130,6 +1130,7 @@ 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

@@ -2619,7 +2619,7 @@ The group to generate the report for.</p>
 		<dl class="function">
 <dt>
 
-		<em></em>
+		<em>#number</em>
 <a id="#(DETECTION_BASE).DetectionInterval" >
 <strong>DETECTION_BASE.DetectionInterval</strong>
 </a>

docs/Documentation/Fsm.html

@@ -1598,7 +1598,7 @@ A string defining the start state.</p>
 		<dl class="function">
 <dt>
 
-		<em>#string</em>
+		<em></em>
 <a id="#(FSM)._StartState" >
 <strong>FSM._StartState</strong>
 </a>
@@ -1897,6 +1897,7 @@ 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

@@ -227,7 +227,6 @@ on defined intervals (currently every minute).</p>
 		<dl class="function">
 <dt>
 
-		<em>#number</em>
 <a id="#(MOVEMENT).AliveUnits" >
 <strong>MOVEMENT.AliveUnits</strong>
 </a>
@@ -236,9 +235,6 @@ 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

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

docs/Documentation/Positionable.html

@@ -1836,7 +1836,6 @@ The height in meters to add to the altitude of the positionable.</p>
 		<dl class="function">
 <dt>
 
-		<em><a href="Core.Spot.html##(SPOT)">Core.Spot#SPOT</a></em>
 <a id="#(POSITIONABLE).Spot" >
 <strong>POSITIONABLE.Spot</strong>
 </a>

docs/Documentation/Settings.html

@@ -1093,7 +1093,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

@@ -3150,7 +3150,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
 
 
 	
-<p> Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.</p>
+<p> When the first Spawn executes, all the Groups need to be made visible before start.</p>
 
 </dd>
 </dl>

docs/Documentation/Spot.html

@@ -765,6 +765,7 @@ true if it is lasing</p>
 		<dl class="function">
 <dt>
 
+		<em></em>
 <a id="#(SPOT).ScheduleID" >
 <strong>SPOT.ScheduleID</strong>
 </a>
@@ -778,6 +779,7 @@ true if it is lasing</p>
 		<dl class="function">
 <dt>
 
+		<em></em>
 <a id="#(SPOT).SpotIR" >
 <strong>SPOT.SpotIR</strong>
 </a>
@@ -791,6 +793,7 @@ true if it is lasing</p>
 		<dl class="function">
 <dt>
 
+		<em></em>
 <a id="#(SPOT).SpotLaser" >
 <strong>SPOT.SpotLaser</strong>
 </a>
@@ -804,6 +807,7 @@ 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

@@ -552,7 +552,7 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
 		<dl class="function">
 <dt>
 
-		<em><a href="Core.Cargo.html##(CARGO_GROUP)">Core.Cargo#CARGO_GROUP</a></em>
+		<em><a href="Core.Cargo.html##(CARGO)">Core.Cargo#CARGO</a></em>
 <a id="#(FSM_PROCESS).Cargo" >
 <strong>FSM_PROCESS.Cargo</strong>
 </a>
@@ -631,7 +631,7 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
 		<dl class="function">
 <dt>
 
-		<em>#number</em>
+		<em></em>
 <a id="#(TASK_CARGO).CargoLimit" >
 <strong>TASK_CARGO.CargoLimit</strong>
 </a>