Merge pull request #1224 from FlightControl-Master/FF/Develop

RANGE v2.2.0

Moose Development/Moose/AI/AI_A2A_Cap.lua

@@ -10,7 +10,8 @@
 -- @image AI_Combat_Air_Patrol.JPG
 
 --- @type AI_A2A_CAP
--- @extends AI.AI_A2A_Patrol#AI_A2A_PATROL
+-- @extends AI.AI_Air_Patrol#AI_AIR_PATROL
+-- @extends AI.AI_Air_Engage#AI_AIR_ENGAGE
 
 
 --- The AI_A2A_CAP class implements the core functions to patrol a @{Zone} by an AI @{Wrapper.Group} or @{Wrapper.Group} 
@@ -97,6 +98,37 @@ AI_A2A_CAP = {
   ClassName = "AI_A2A_CAP",
 }
 
+--- Creates a new AI_A2A_CAP object
+-- @param #AI_A2A_CAP self
+-- @param Wrapper.Group#GROUP AICap
+-- @param DCS#Speed  EngageMinSpeed The minimum speed of the @{Wrapper.Group} in km/h when engaging a target.
+-- @param DCS#Speed  EngageMaxSpeed The maximum speed of the @{Wrapper.Group} in km/h when engaging a target.
+-- @param DCS#Altitude EngageFloorAltitude The lowest altitude in meters where to execute the engagement.
+-- @param DCS#Altitude EngageCeilingAltitude The highest altitude in meters where to execute the engagement.
+-- @param DCS#AltitudeType EngageAltType The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to "RADIO".
+-- @param Core.Zone#ZONE_BASE PatrolZone The @{Zone} where the patrol needs to be executed.
+-- @param DCS#Speed  PatrolMinSpeed The minimum speed of the @{Wrapper.Group} in km/h.
+-- @param DCS#Speed  PatrolMaxSpeed The maximum speed of the @{Wrapper.Group} in km/h.
+-- @param DCS#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
+-- @param DCS#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
+-- @param DCS#AltitudeType PatrolAltType The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to "RADIO".
+-- @return #AI_A2A_CAP
+function AI_A2A_CAP:New2( AICap, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, EngageAltType, PatrolZone, PatrolMinSpeed, PatrolMaxSpeed, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolAltType )
+
+  -- Multiple inheritance ... :-)
+  local AI_Air = AI_AIR:New( AICap )
+  local AI_Air_Patrol = AI_AIR_PATROL:New( AI_Air, AICap, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType ) -- #AI_AIR_PATROL
+  local AI_Air_Engage = AI_AIR_ENGAGE:New( AI_Air_Patrol, AICap, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, EngageAltType )
+  local self = BASE:Inherit( self, AI_Air_Engage )
+
+  self:SetFuelThreshold( .2, 60 )
+  self:SetDamageThreshold( 0.4 )
+  self:SetDisengageRadius( 70000 )
+  
+
+  return self
+end
+
 --- Creates a new AI_A2A_CAP object
 -- @param #AI_A2A_CAP self
 -- @param Wrapper.Group#GROUP AICap
@@ -111,184 +143,19 @@ AI_A2A_CAP = {
 -- @return #AI_A2A_CAP
 function AI_A2A_CAP:New( AICap, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, EngageMinSpeed, EngageMaxSpeed, PatrolAltType )
 
-  -- Inherits from BASE
-  local self = BASE:Inherit( self, AI_A2A_PATROL:New( AICap, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType ) ) -- #AI_A2A_CAP
+  return self:New2( AICap, EngageMinSpeed, EngageMaxSpeed, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolZone, PatrolMinSpeed, PatrolMaxSpeed, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolAltType, PatrolAltType )
 
-  self.Accomplished = false
-  self.Engaging = false
-  
-  self.EngageMinSpeed = EngageMinSpeed
-  self.EngageMaxSpeed = EngageMaxSpeed
-  
-  self:AddTransition( { "Patrolling", "Engaging", "Returning", "Airborne" }, "Engage", "Engaging" ) -- FSM_CONTROLLABLE Transition for type #AI_A2A_CAP.
-
-  --- OnBefore Transition Handler for Event Engage.
-  -- @function [parent=#AI_A2A_CAP] OnBeforeEngage
-  -- @param #AI_A2A_CAP self
-  -- @param Wrapper.Group#GROUP AICap The Group Object managed by the FSM.
-  -- @param #string From The From State string.
-  -- @param #string Event The Event string.
-  -- @param #string To The To State string.
-  -- @return #boolean Return false to cancel Transition.
-  
-  --- OnAfter Transition Handler for Event Engage.
-  -- @function [parent=#AI_A2A_CAP] OnAfterEngage
-  -- @param #AI_A2A_CAP self
-  -- @param Wrapper.Group#GROUP AICap The Group Object managed by the FSM.
-  -- @param #string From The From State string.
-  -- @param #string Event The Event string.
-  -- @param #string To The To State string.
-  	
-  --- Synchronous Event Trigger for Event Engage.
-  -- @function [parent=#AI_A2A_CAP] Engage
-  -- @param #AI_A2A_CAP self
-  
-  --- Asynchronous Event Trigger for Event Engage.
-  -- @function [parent=#AI_A2A_CAP] __Engage
-  -- @param #AI_A2A_CAP self
-  -- @param #number Delay The delay in seconds.
-
---- OnLeave Transition Handler for State Engaging.
--- @function [parent=#AI_A2A_CAP] OnLeaveEngaging
--- @param #AI_A2A_CAP self
--- @param Wrapper.Group#GROUP AICap The Group Object managed by the FSM.
--- @param #string From The From State string.
--- @param #string Event The Event string.
--- @param #string To The To State string.
--- @return #boolean Return false to cancel Transition.
-
---- OnEnter Transition Handler for State Engaging.
--- @function [parent=#AI_A2A_CAP] OnEnterEngaging
--- @param #AI_A2A_CAP self
--- @param Wrapper.Group#GROUP AICap The Group Object managed by the FSM.
--- @param #string From The From State string.
--- @param #string Event The Event string.
--- @param #string To The To State string.
-
-  self:AddTransition( "Engaging", "Fired", "Engaging" ) -- FSM_CONTROLLABLE Transition for type #AI_A2A_CAP.
-  
-  --- OnBefore Transition Handler for Event Fired.
-  -- @function [parent=#AI_A2A_CAP] OnBeforeFired
-  -- @param #AI_A2A_CAP self
-  -- @param Wrapper.Group#GROUP AICap The Group Object managed by the FSM.
-  -- @param #string From The From State string.
-  -- @param #string Event The Event string.
-  -- @param #string To The To State string.
-  -- @return #boolean Return false to cancel Transition.
-  
-  --- OnAfter Transition Handler for Event Fired.
-  -- @function [parent=#AI_A2A_CAP] OnAfterFired
-  -- @param #AI_A2A_CAP self
-  -- @param Wrapper.Group#GROUP AICap The Group Object managed by the FSM.
-  -- @param #string From The From State string.
-  -- @param #string Event The Event string.
-  -- @param #string To The To State string.
-  	
-  --- Synchronous Event Trigger for Event Fired.
-  -- @function [parent=#AI_A2A_CAP] Fired
-  -- @param #AI_A2A_CAP self
-  
-  --- Asynchronous Event Trigger for Event Fired.
-  -- @function [parent=#AI_A2A_CAP] __Fired
-  -- @param #AI_A2A_CAP self
-  -- @param #number Delay The delay in seconds.
-
-  self:AddTransition( "*", "Destroy", "*" ) -- FSM_CONTROLLABLE Transition for type #AI_A2A_CAP.
-
-  --- OnBefore Transition Handler for Event Destroy.
-  -- @function [parent=#AI_A2A_CAP] OnBeforeDestroy
-  -- @param #AI_A2A_CAP self
-  -- @param Wrapper.Group#GROUP AICap The Group Object managed by the FSM.
-  -- @param #string From The From State string.
-  -- @param #string Event The Event string.
-  -- @param #string To The To State string.
-  -- @return #boolean Return false to cancel Transition.
-  
-  --- OnAfter Transition Handler for Event Destroy.
-  -- @function [parent=#AI_A2A_CAP] OnAfterDestroy
-  -- @param #AI_A2A_CAP self
-  -- @param Wrapper.Group#GROUP AICap The Group Object managed by the FSM.
-  -- @param #string From The From State string.
-  -- @param #string Event The Event string.
-  -- @param #string To The To State string.
-  	
-  --- Synchronous Event Trigger for Event Destroy.
-  -- @function [parent=#AI_A2A_CAP] Destroy
-  -- @param #AI_A2A_CAP self
-  
-  --- Asynchronous Event Trigger for Event Destroy.
-  -- @function [parent=#AI_A2A_CAP] __Destroy
-  -- @param #AI_A2A_CAP self
-  -- @param #number Delay The delay in seconds.
-
-
-  self:AddTransition( "Engaging", "Abort", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_A2A_CAP.
-
-  --- OnBefore Transition Handler for Event Abort.
-  -- @function [parent=#AI_A2A_CAP] OnBeforeAbort
-  -- @param #AI_A2A_CAP self
-  -- @param Wrapper.Group#GROUP AICap The Group Object managed by the FSM.
-  -- @param #string From The From State string.
-  -- @param #string Event The Event string.
-  -- @param #string To The To State string.
-  -- @return #boolean Return false to cancel Transition.
-  
-  --- OnAfter Transition Handler for Event Abort.
-  -- @function [parent=#AI_A2A_CAP] OnAfterAbort
-  -- @param #AI_A2A_CAP self
-  -- @param Wrapper.Group#GROUP AICap The Group Object managed by the FSM.
-  -- @param #string From The From State string.
-  -- @param #string Event The Event string.
-  -- @param #string To The To State string.
-  	
-  --- Synchronous Event Trigger for Event Abort.
-  -- @function [parent=#AI_A2A_CAP] Abort
-  -- @param #AI_A2A_CAP self
-  
-  --- Asynchronous Event Trigger for Event Abort.
-  -- @function [parent=#AI_A2A_CAP] __Abort
-  -- @param #AI_A2A_CAP self
-  -- @param #number Delay The delay in seconds.
-
-  self:AddTransition( "Engaging", "Accomplish", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_A2A_CAP.
-
-  --- OnBefore Transition Handler for Event Accomplish.
-  -- @function [parent=#AI_A2A_CAP] OnBeforeAccomplish
-  -- @param #AI_A2A_CAP self
-  -- @param Wrapper.Group#GROUP AICap The Group Object managed by the FSM.
-  -- @param #string From The From State string.
-  -- @param #string Event The Event string.
-  -- @param #string To The To State string.
-  -- @return #boolean Return false to cancel Transition.
-  
-  --- OnAfter Transition Handler for Event Accomplish.
-  -- @function [parent=#AI_A2A_CAP] OnAfterAccomplish
-  -- @param #AI_A2A_CAP self
-  -- @param Wrapper.Group#GROUP AICap The Group Object managed by the FSM.
-  -- @param #string From The From State string.
-  -- @param #string Event The Event string.
-  -- @param #string To The To State string.
-  	
-  --- Synchronous Event Trigger for Event Accomplish.
-  -- @function [parent=#AI_A2A_CAP] Accomplish
-  -- @param #AI_A2A_CAP self
-  
-  --- Asynchronous Event Trigger for Event Accomplish.
-  -- @function [parent=#AI_A2A_CAP] __Accomplish
-  -- @param #AI_A2A_CAP self
-  -- @param #number Delay The delay in seconds.  
-
-  return self
 end
 
 --- onafter State Transition for Event Patrol.
--- @param #AI_A2A_GCI self
+-- @param #AI_A2A_CAP self
 -- @param Wrapper.Group#GROUP AICap The AI Group managed by the FSM.
 -- @param #string From The From State string.
 -- @param #string Event The Event string.
 -- @param #string To The To State string.
 function AI_A2A_CAP:onafterStart( AICap, From, Event, To )
 
+  self:GetParent( self, AI_A2A_CAP ).onafterStart( self, AICap, From, Event, To )
   AICap:HandleEvent( EVENTS.Takeoff, nil, self )
 
 end
@@ -321,167 +188,27 @@ function AI_A2A_CAP:SetEngageRange( EngageRange )
   end
 end
 
---- onafter State Transition for Event Patrol.
+--- Evaluate the attack and create an AttackUnitTask list. 
 -- @param #AI_A2A_CAP self
--- @param Wrapper.Group#GROUP AICap The AI Group managed by the FSM.
--- @param #string From The From State string.
--- @param #string Event The Event string.
--- @param #string To The To State string.
-function AI_A2A_CAP:onafterPatrol( AICap, From, Event, To )
+-- @param Core.Set#SET_UNIT AttackSetUnit The set of units to attack.
+-- @param Wrappper.Group#GROUP DefenderGroup The group of defenders.
+-- @param #number EngageAltitude The altitude to engage the targets.
+-- @return #AI_A2A_CAP self
+function AI_A2A_CAP:CreateAttackUnitTasks( AttackSetUnit, DefenderGroup, EngageAltitude )
 
-  -- Call the parent Start event handler
-  self:GetParent(self).onafterPatrol( self, AICap, From, Event, To )
-  self:HandleEvent( EVENTS.Dead )
+  local AttackUnitTasks = {}
 
-end
-
--- todo: need to fix this global function
-
---- @param Wrapper.Group#GROUP AICap
-function AI_A2A_CAP.AttackRoute( AICap, Fsm )
-
-  AICap:F( { "AI_A2A_CAP.AttackRoute:", AICap:GetName() } )
-
-  if AICap:IsAlive() then
-    Fsm:__Engage( 0.5 )
-  end
-end
-
---- @param #AI_A2A_CAP self
--- @param Wrapper.Group#GROUP AICap The Group Object managed by the FSM.
--- @param #string From The From State string.
--- @param #string Event The Event string.
--- @param #string To The To State string.
-function AI_A2A_CAP:onbeforeEngage( AICap, From, Event, To )
-  
-  if self.Accomplished == true then
-    return false
-  end
-end
-
---- @param #AI_A2A_CAP self
--- @param Wrapper.Group#GROUP AICap The AI Group managed by the FSM.
--- @param #string From The From State string.
--- @param #string Event The Event string.
--- @param #string To The To State string.
-function AI_A2A_CAP:onafterAbort( AICap, From, Event, To )
-  AICap:ClearTasks()
-  self:__Route( 0.5 )
-end
-
-
---- @param #AI_A2A_CAP self
--- @param Wrapper.Group#GROUP AICap The AICap Object managed by the FSM.
--- @param #string From The From State string.
--- @param #string Event The Event string.
--- @param #string To The To State string.
-function AI_A2A_CAP:onafterEngage( AICap, From, Event, To, AttackSetUnit )
-
-  self:F( { AICap, From, Event, To, AttackSetUnit} )
-
-  self.AttackSetUnit = AttackSetUnit or self.AttackSetUnit -- Core.Set#SET_UNIT
-  
-  local FirstAttackUnit = self.AttackSetUnit:GetFirst() -- Wrapper.Unit#UNIT
-  
-  if FirstAttackUnit and FirstAttackUnit:IsAlive() then -- If there is no attacker anymore, stop the engagement.
-  
-    if AICap:IsAlive() then
-
-      local EngageRoute = {}
-
-      --- Calculate the target route point.
-      local CurrentCoord = AICap:GetCoordinate()
-      local ToTargetCoord = self.AttackSetUnit:GetFirst():GetCoordinate()
-      local ToTargetSpeed = math.random( self.EngageMinSpeed, self.EngageMaxSpeed )
-      local ToInterceptAngle = CurrentCoord:GetAngleDegrees( CurrentCoord:GetDirectionVec3( ToTargetCoord ) )
-      
-      --- Create a route point of type air.
-      local ToPatrolRoutePoint = CurrentCoord:Translate( 5000, ToInterceptAngle ):WaypointAir( 
-        self.PatrolAltType, 
-        POINT_VEC3.RoutePointType.TurningPoint, 
-        POINT_VEC3.RoutePointAction.TurningPoint, 
-        ToTargetSpeed, 
-        true 
-      )
-  
-      self:F( { Angle = ToInterceptAngle, ToTargetSpeed = ToTargetSpeed } )
-      self:T2( { self.MinSpeed, self.MaxSpeed, ToTargetSpeed } )
-      
-      EngageRoute[#EngageRoute+1] = ToPatrolRoutePoint
-      EngageRoute[#EngageRoute+1] = ToPatrolRoutePoint
-
-      local AttackTasks = {}
-  
-      for AttackUnitID, AttackUnit in pairs( self.AttackSetUnit:GetSet() ) do
-        local AttackUnit = AttackUnit -- Wrapper.Unit#UNIT
-        self:T( { "Attacking Unit:", AttackUnit:GetName(), AttackUnit:IsAlive(), AttackUnit:IsAir() } )
-        if AttackUnit:IsAlive() and AttackUnit:IsAir() then
-          AttackTasks[#AttackTasks+1] = AICap:TaskAttackUnit( AttackUnit )
-        end
-      end
-  
-      if #AttackTasks == 0 then
-        self:E("No targets found -> Going back to Patrolling")
-        self:__Abort( 0.5 )
-      else
-        AICap:OptionROEOpenFire()
-        AICap:OptionROTEvadeFire()
-
-        AttackTasks[#AttackTasks+1] = AICap:TaskFunction( "AI_A2A_CAP.AttackRoute", self )
-        EngageRoute[#EngageRoute].task = AICap:TaskCombo( AttackTasks )
-      end
-      
-      AICap:Route( EngageRoute, 0.5 )
+  for AttackUnitID, AttackUnit in pairs( self.AttackSetUnit:GetSet() ) do
+    local AttackUnit = AttackUnit -- Wrapper.Unit#UNIT
+    self:T( { "Attacking Unit:", AttackUnit:GetName(), AttackUnit:IsAlive(), AttackUnit:IsAir() } )
+    if AttackUnit:IsAlive() and AttackUnit:IsAir() then
+      -- TODO: Add coalition check? Only attack units of if AttackUnit:GetCoalition()~=AICap:GetCoalition()
+      -- Maybe the detected set also contains 
+      self:T( { "Attacking Task:", AttackUnit:GetName(), AttackUnit:IsAlive(), AttackUnit:IsAir() } )
+      AttackUnitTasks[#AttackUnitTasks+1] = DefenderGroup:TaskAttackUnit( AttackUnit )
     end
-  else
-    self:E("No targets found -> Going back to Patrolling")
-    self:__Abort( 0.5 )
-  end
-end
-
---- @param #AI_A2A_CAP self
--- @param Wrapper.Group#GROUP AICap The Group Object managed by the FSM.
--- @param #string From The From State string.
--- @param #string Event The Event string.
--- @param #string To The To State string.
-function AI_A2A_CAP:onafterAccomplish( AICap, From, Event, To )
-  self.Accomplished = true
-  self:SetDetectionOff()
-end
-
---- @param #AI_A2A_CAP self
--- @param Wrapper.Group#GROUP AICap The Group Object managed by the FSM.
--- @param #string From The From State string.
--- @param #string Event The Event string.
--- @param #string To The To State string.
--- @param Core.Event#EVENTDATA EventData
-function AI_A2A_CAP:onafterDestroy( AICap, From, Event, To, EventData )
-
-  if EventData.IniUnit then
-    self.AttackUnits[EventData.IniUnit] = nil
-  end
-end
-
---- @param #AI_A2A_CAP self
--- @param Core.Event#EVENTDATA EventData
-function AI_A2A_CAP:OnEventDead( EventData )
-  self:F( { "EventDead", EventData } )
-
-  if EventData.IniDCSUnit then
-    if self.AttackUnits and self.AttackUnits[EventData.IniUnit] then
-      self:__Destroy( 1, EventData )
-    end
-  end  
-end
-
---- @param Wrapper.Group#GROUP AICap
-function AI_A2A_CAP.Resume( AICap )
-
-  AICap:F( { "AI_A2A_CAP.Resume:", AICap:GetName() } )
-  if AICap:IsAlive() then
-    local _AI_A2A = AICap:GetState( AICap, "AI_A2A" ) -- #AI_A2A
-      _AI_A2A:__Reset( 1 )
-      _AI_A2A:__Route( 5 )
   end
   
+  return AttackUnitTasks
 end
+

Moose Development/Moose/AI/AI_A2A_Gci.lua

@@ -105,183 +105,39 @@ AI_A2A_GCI = {
 --- Creates a new AI_A2A_GCI object
 -- @param #AI_A2A_GCI self
 -- @param Wrapper.Group#GROUP AIIntercept
+-- @param DCS#Speed  EngageMinSpeed The minimum speed of the @{Wrapper.Group} in km/h when engaging a target.
+-- @param DCS#Speed  EngageMaxSpeed The maximum speed of the @{Wrapper.Group} in km/h when engaging a target.
+-- @param DCS#Altitude EngageFloorAltitude The lowest altitude in meters where to execute the engagement.
+-- @param DCS#Altitude EngageCeilingAltitude The highest altitude in meters where to execute the engagement.
+-- @param DCS#AltitudeType EngageAltType The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to "RADIO".
 -- @return #AI_A2A_GCI
-function AI_A2A_GCI:New( AIIntercept, EngageMinSpeed, EngageMaxSpeed )
+function AI_A2A_GCI:New2( AIIntercept, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, EngageAltType )
 
-  -- Inherits from BASE
-  local self = BASE:Inherit( self, AI_A2A:New( AIIntercept ) ) -- #AI_A2A_GCI
-
-  self.Accomplished = false
-  self.Engaging = false
+  local AI_Air = AI_AIR:New( AIIntercept )
+  local AI_Air_Engage = AI_AIR_ENGAGE:New( AI_Air, AIIntercept, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, EngageAltType )
+  local self = BASE:Inherit( self, AI_Air_Engage ) -- #AI_A2A_GCI
   
-  self.EngageMinSpeed = EngageMinSpeed
-  self.EngageMaxSpeed = EngageMaxSpeed
-  self.PatrolMinSpeed = EngageMinSpeed
-  self.PatrolMaxSpeed = EngageMaxSpeed
-  
-  self.PatrolAltType = "RADIO"
-  
-  self:AddTransition( { "Started", "Engaging", "Returning", "Airborne" }, "Engage", "Engaging" ) -- FSM_CONTROLLABLE Transition for type #AI_A2A_GCI.
-
-  --- OnBefore Transition Handler for Event Engage.
-  -- @function [parent=#AI_A2A_GCI] OnBeforeEngage
-  -- @param #AI_A2A_GCI self
-  -- @param Wrapper.Group#GROUP AIIntercept The Group Object managed by the FSM.
-  -- @param #string From The From State string.
-  -- @param #string Event The Event string.
-  -- @param #string To The To State string.
-  -- @return #boolean Return false to cancel Transition.
-  
-  --- OnAfter Transition Handler for Event Engage.
-  -- @function [parent=#AI_A2A_GCI] OnAfterEngage
-  -- @param #AI_A2A_GCI self
-  -- @param Wrapper.Group#GROUP AIIntercept The Group Object managed by the FSM.
-  -- @param #string From The From State string.
-  -- @param #string Event The Event string.
-  -- @param #string To The To State string.
-  	
-  --- Synchronous Event Trigger for Event Engage.
-  -- @function [parent=#AI_A2A_GCI] Engage
-  -- @param #AI_A2A_GCI self
-  
-  --- Asynchronous Event Trigger for Event Engage.
-  -- @function [parent=#AI_A2A_GCI] __Engage
-  -- @param #AI_A2A_GCI self
-  -- @param #number Delay The delay in seconds.
-
---- OnLeave Transition Handler for State Engaging.
--- @function [parent=#AI_A2A_GCI] OnLeaveEngaging
--- @param #AI_A2A_GCI self
--- @param Wrapper.Group#GROUP AIIntercept The Group Object managed by the FSM.
--- @param #string From The From State string.
--- @param #string Event The Event string.
--- @param #string To The To State string.
--- @return #boolean Return false to cancel Transition.
-
---- OnEnter Transition Handler for State Engaging.
--- @function [parent=#AI_A2A_GCI] OnEnterEngaging
--- @param #AI_A2A_GCI self
--- @param Wrapper.Group#GROUP AIIntercept The Group Object managed by the FSM.
--- @param #string From The From State string.
--- @param #string Event The Event string.
--- @param #string To The To State string.
-
-  self:AddTransition( "Engaging", "Fired", "Engaging" ) -- FSM_CONTROLLABLE Transition for type #AI_A2A_GCI.
-  
-  --- OnBefore Transition Handler for Event Fired.
-  -- @function [parent=#AI_A2A_GCI] OnBeforeFired
-  -- @param #AI_A2A_GCI self
-  -- @param Wrapper.Group#GROUP AIIntercept The Group Object managed by the FSM.
-  -- @param #string From The From State string.
-  -- @param #string Event The Event string.
-  -- @param #string To The To State string.
-  -- @return #boolean Return false to cancel Transition.
-  
-  --- OnAfter Transition Handler for Event Fired.
-  -- @function [parent=#AI_A2A_GCI] OnAfterFired
-  -- @param #AI_A2A_GCI self
-  -- @param Wrapper.Group#GROUP AIIntercept The Group Object managed by the FSM.
-  -- @param #string From The From State string.
-  -- @param #string Event The Event string.
-  -- @param #string To The To State string.
-  	
-  --- Synchronous Event Trigger for Event Fired.
-  -- @function [parent=#AI_A2A_GCI] Fired
-  -- @param #AI_A2A_GCI self
-  
-  --- Asynchronous Event Trigger for Event Fired.
-  -- @function [parent=#AI_A2A_GCI] __Fired
-  -- @param #AI_A2A_GCI self
-  -- @param #number Delay The delay in seconds.
-
-  self:AddTransition( "*", "Destroy", "*" ) -- FSM_CONTROLLABLE Transition for type #AI_A2A_GCI.
-
-  --- OnBefore Transition Handler for Event Destroy.
-  -- @function [parent=#AI_A2A_GCI] OnBeforeDestroy
-  -- @param #AI_A2A_GCI self
-  -- @param Wrapper.Group#GROUP AIIntercept The Group Object managed by the FSM.
-  -- @param #string From The From State string.
-  -- @param #string Event The Event string.
-  -- @param #string To The To State string.
-  -- @return #boolean Return false to cancel Transition.
-  
-  --- OnAfter Transition Handler for Event Destroy.
-  -- @function [parent=#AI_A2A_GCI] OnAfterDestroy
-  -- @param #AI_A2A_GCI self
-  -- @param Wrapper.Group#GROUP AIIntercept The Group Object managed by the FSM.
-  -- @param #string From The From State string.
-  -- @param #string Event The Event string.
-  -- @param #string To The To State string.
-  	
-  --- Synchronous Event Trigger for Event Destroy.
-  -- @function [parent=#AI_A2A_GCI] Destroy
-  -- @param #AI_A2A_GCI self
-  
-  --- Asynchronous Event Trigger for Event Destroy.
-  -- @function [parent=#AI_A2A_GCI] __Destroy
-  -- @param #AI_A2A_GCI self
-  -- @param #number Delay The delay in seconds.
-
-
-  self:AddTransition( "Engaging", "Abort", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_A2A_GCI.
-
-  --- OnBefore Transition Handler for Event Abort.
-  -- @function [parent=#AI_A2A_GCI] OnBeforeAbort
-  -- @param #AI_A2A_GCI self
-  -- @param Wrapper.Group#GROUP AIIntercept The Group Object managed by the FSM.
-  -- @param #string From The From State string.
-  -- @param #string Event The Event string.
-  -- @param #string To The To State string.
-  -- @return #boolean Return false to cancel Transition.
-  
-  --- OnAfter Transition Handler for Event Abort.
-  -- @function [parent=#AI_A2A_GCI] OnAfterAbort
-  -- @param #AI_A2A_GCI self
-  -- @param Wrapper.Group#GROUP AIIntercept The Group Object managed by the FSM.
-  -- @param #string From The From State string.
-  -- @param #string Event The Event string.
-  -- @param #string To The To State string.
-  	
-  --- Synchronous Event Trigger for Event Abort.
-  -- @function [parent=#AI_A2A_GCI] Abort
-  -- @param #AI_A2A_GCI self
-  
-  --- Asynchronous Event Trigger for Event Abort.
-  -- @function [parent=#AI_A2A_GCI] __Abort
-  -- @param #AI_A2A_GCI self
-  -- @param #number Delay The delay in seconds.
-
-  self:AddTransition( "Engaging", "Accomplish", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_A2A_GCI.
-
-  --- OnBefore Transition Handler for Event Accomplish.
-  -- @function [parent=#AI_A2A_GCI] OnBeforeAccomplish
-  -- @param #AI_A2A_GCI self
-  -- @param Wrapper.Group#GROUP AIIntercept The Group Object managed by the FSM.
-  -- @param #string From The From State string.
-  -- @param #string Event The Event string.
-  -- @param #string To The To State string.
-  -- @return #boolean Return false to cancel Transition.
-  
-  --- OnAfter Transition Handler for Event Accomplish.
-  -- @function [parent=#AI_A2A_GCI] OnAfterAccomplish
-  -- @param #AI_A2A_GCI self
-  -- @param Wrapper.Group#GROUP AIIntercept The Group Object managed by the FSM.
-  -- @param #string From The From State string.
-  -- @param #string Event The Event string.
-  -- @param #string To The To State string.
-  	
-  --- Synchronous Event Trigger for Event Accomplish.
-  -- @function [parent=#AI_A2A_GCI] Accomplish
-  -- @param #AI_A2A_GCI self
-  
-  --- Asynchronous Event Trigger for Event Accomplish.
-  -- @function [parent=#AI_A2A_GCI] __Accomplish
-  -- @param #AI_A2A_GCI self
-  -- @param #number Delay The delay in seconds.  
+  self:SetFuelThreshold( .2, 60 )
+  self:SetDamageThreshold( 0.4 )
+  self:SetDisengageRadius( 70000 )
 
   return self
 end
 
+--- Creates a new AI_A2A_GCI object
+-- @param #AI_A2A_GCI self
+-- @param Wrapper.Group#GROUP AIIntercept
+-- @param DCS#Speed  EngageMinSpeed The minimum speed of the @{Wrapper.Group} in km/h when engaging a target.
+-- @param DCS#Speed  EngageMaxSpeed The maximum speed of the @{Wrapper.Group} in km/h when engaging a target.
+-- @param DCS#Altitude EngageFloorAltitude The lowest altitude in meters where to execute the engagement.
+-- @param DCS#Altitude EngageCeilingAltitude The highest altitude in meters where to execute the engagement.
+-- @param DCS#AltitudeType EngageAltType The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to "RADIO".
+-- @return #AI_A2A_GCI
+function AI_A2A_GCI:New( AIIntercept, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, EngageAltType )
+
+  return self:New2( AIIntercept, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, EngageAltType )
+end
+
 --- onafter State Transition for Event Patrol.
 -- @param #AI_A2A_GCI self
 -- @param Wrapper.Group#GROUP AIIntercept The AI Group managed by the FSM.
@@ -290,172 +146,33 @@ end
 -- @param #string To The To State string.
 function AI_A2A_GCI:onafterStart( AIIntercept, From, Event, To )
 
-  AIIntercept:HandleEvent( EVENTS.Takeoff, nil, self )
-
+  self:GetParent( self, AI_A2A_GCI ).onafterStart( self, AIIntercept, From, Event, To )
 end
 
 
-
---- onafter State Transition for Event Patrol.
+--- Evaluate the attack and create an AttackUnitTask list. 
 -- @param #AI_A2A_GCI self
--- @param Wrapper.Group#GROUP AIIntercept The AI Group managed by the FSM.
--- @param #string From The From State string.
--- @param #string Event The Event string.
--- @param #string To The To State string.
-function AI_A2A_GCI:onafterEngage( AIIntercept, From, Event, To )
+-- @param Core.Set#SET_UNIT AttackSetUnit The set of units to attack.
+-- @param Wrappper.Group#GROUP DefenderGroup The group of defenders.
+-- @param #number EngageAltitude The altitude to engage the targets.
+-- @return #AI_A2A_GCI self
+function AI_A2A_GCI:CreateAttackUnitTasks( AttackSetUnit, DefenderGroup, EngageAltitude )
 
-  self:HandleEvent( EVENTS.Dead )
+  local AttackUnitTasks = {}
 
-end
-
--- todo: need to fix this global function
-
---- @param Wrapper.Group#GROUP AIControllable
-function AI_A2A_GCI.InterceptRoute( AIIntercept, Fsm )
-
-  AIIntercept:F( { "AI_A2A_GCI.InterceptRoute:", AIIntercept:GetName() } )
-  
-  if AIIntercept:IsAlive() then
-    Fsm:__Engage( 0.5 )
-  
-    --local Task = AIIntercept:TaskOrbitCircle( 4000, 400 )
-    --AIIntercept:SetTask( Task )
-  end
-end
-
---- @param #AI_A2A_GCI self
--- @param Wrapper.Group#GROUP AIIntercept The Group Object managed by the FSM.
--- @param #string From The From State string.
--- @param #string Event The Event string.
--- @param #string To The To State string.
-function AI_A2A_GCI:onbeforeEngage( AIIntercept, From, Event, To )
-  
-  if self.Accomplished == true then
-    return false
-  end
-end
-
---- @param #AI_A2A_GCI self
--- @param Wrapper.Group#GROUP AIIntercept The AI Group managed by the FSM.
--- @param #string From The From State string.
--- @param #string Event The Event string.
--- @param #string To The To State string.
-function AI_A2A_GCI:onafterAbort( AIIntercept, From, Event, To )
-  AIIntercept:ClearTasks()
-  self:Return()
-  self:__RTB( 0.5 )
-end
-
-
---- @param #AI_A2A_GCI self
--- @param Wrapper.Group#GROUP AIIntercept The GroupGroup managed by the FSM.
--- @param #string From The From State string.
--- @param #string Event The Event string.
--- @param #string To The To State string.
-function AI_A2A_GCI:onafterEngage( AIIntercept, From, Event, To, AttackSetUnit )
-
-  self:F( { AIIntercept, From, Event, To, AttackSetUnit} )
-
-  self.AttackSetUnit = AttackSetUnit or self.AttackSetUnit -- Core.Set#SET_UNIT
-  
-  local FirstAttackUnit = self.AttackSetUnit:GetFirst()
-  
-  if FirstAttackUnit and FirstAttackUnit:IsAlive() then
-
-    if AIIntercept:IsAlive() then
-  
-      local EngageRoute = {}
-      
-      local CurrentCoord = AIIntercept:GetCoordinate()
-  
-      --- Calculate the target route point.
-      
-      local CurrentCoord = AIIntercept:GetCoordinate()
-      
-      local ToTargetCoord = self.AttackSetUnit:GetFirst():GetCoordinate()
-      self:SetTargetDistance( ToTargetCoord ) -- For RTB status check
-      
-      local ToTargetSpeed = math.random( self.EngageMinSpeed, self.EngageMaxSpeed )
-      local ToInterceptAngle = CurrentCoord:GetAngleDegrees( CurrentCoord:GetDirectionVec3( ToTargetCoord ) )
-      
-      --- Create a route point of type air.
-      local ToPatrolRoutePoint = CurrentCoord:Translate( 15000, ToInterceptAngle ):WaypointAir( 
-        self.PatrolAltType, 
-        POINT_VEC3.RoutePointType.TurningPoint, 
-        POINT_VEC3.RoutePointAction.TurningPoint, 
-        ToTargetSpeed, 
-        true 
-      )
-  
-      self:F( { Angle = ToInterceptAngle, ToTargetSpeed = ToTargetSpeed } )
-      self:F( { self.EngageMinSpeed, self.EngageMaxSpeed, ToTargetSpeed } )
-      
-      EngageRoute[#EngageRoute+1] = ToPatrolRoutePoint
-      EngageRoute[#EngageRoute+1] = ToPatrolRoutePoint
-      
-      local AttackTasks = {}
-  
-      for AttackUnitID, AttackUnit in pairs( self.AttackSetUnit:GetSet() ) do
-        local AttackUnit = AttackUnit -- Wrapper.Unit#UNIT
-        if AttackUnit:IsAlive() and AttackUnit:IsAir() then
-          self:T( { "Intercepting Unit:", AttackUnit:GetName(), AttackUnit:IsAlive(), AttackUnit:IsAir() } )
-          AttackTasks[#AttackTasks+1] = AIIntercept:TaskAttackUnit( AttackUnit )
-        end
-      end
-        
-      if #AttackTasks == 0 then
-        self:E("No targets found -> Going RTB")
-        self:Return()
-        self:__RTB( 0.5 )
-      else
-        AIIntercept:OptionROEOpenFire()
-        AIIntercept:OptionROTEvadeFire()
-
-        AttackTasks[#AttackTasks+1] = AIIntercept:TaskFunction( "AI_A2A_GCI.InterceptRoute", self )
-        EngageRoute[#EngageRoute].task = AIIntercept:TaskCombo( AttackTasks )
-      end
-      
-      AIIntercept:Route( EngageRoute, 0.5 )
-    
+  for AttackUnitID, AttackUnit in pairs( self.AttackSetUnit:GetSet() ) do
+    local AttackUnit = AttackUnit -- Wrapper.Unit#UNIT
+    self:T( { "Attacking Unit:", AttackUnit:GetName(), AttackUnit:IsAlive(), AttackUnit:IsAir() } )
+    if AttackUnit:IsAlive() and AttackUnit:IsAir() then
+      -- TODO: Add coalition check? Only attack units of if AttackUnit:GetCoalition()~=AICap:GetCoalition()
+      -- Maybe the detected set also contains 
+      AttackUnitTasks[#AttackUnitTasks+1] = DefenderGroup:TaskAttackUnit( AttackUnit )
     end
-  else
-    self:E("No targets found -> Going RTB")
-    self:Return()
-    self:__RTB( 0.5 )
   end
+  
+  return AttackUnitTasks
 end
 
---- @param #AI_A2A_GCI self
--- @param Wrapper.Group#GROUP AIIntercept The Group Object managed by the FSM.
--- @param #string From The From State string.
--- @param #string Event The Event string.
--- @param #string To The To State string.
-function AI_A2A_GCI:onafterAccomplish( AIIntercept, From, Event, To )
-  self.Accomplished = true
-  self:SetDetectionOff()
-end
 
---- @param #AI_A2A_GCI self
--- @param Wrapper.Group#GROUP AIIntercept The Group Object managed by the FSM.
--- @param #string From The From State string.
--- @param #string Event The Event string.
--- @param #string To The To State string.
--- @param Core.Event#EVENTDATA EventData
-function AI_A2A_GCI:onafterDestroy( AIIntercept, From, Event, To, EventData )
 
-  if EventData.IniUnit then
-    self.AttackUnits[EventData.IniUnit] = nil
-  end
-end
 
---- @param #AI_A2A_GCI self
--- @param Core.Event#EVENTDATA EventData
-function AI_A2A_GCI:OnEventDead( EventData )
-  self:F( { "EventDead", EventData } )
-
-  if EventData.IniDCSUnit then
-    if self.AttackUnits and self.AttackUnits[EventData.IniUnit] then
-      self:__Destroy( 1, EventData )
-    end
-  end  
-end

Moose Development/Moose/AI/AI_A2A_Patrol.lua

@@ -136,8 +136,14 @@ AI_A2A_PATROL = {
 -- PatrolArea = AI_A2A_PATROL:New( PatrolZone, 3000, 6000, 600, 900 )
 function AI_A2A_PATROL:New( AIPatrol, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType )
 
-  -- Inherits from BASE
-  local self = BASE:Inherit( self, AI_A2A:New( AIPatrol ) ) -- #AI_A2A_PATROL
+  local AI_Air = AI_AIR:New( AIPatrol )
+  local AI_Air_Patrol = AI_A2A_PATROL:New( AI_Air, AIPatrol, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType  )
+  local self = BASE:Inherit( self, AI_Air_Patrol ) -- #AI_A2A_PATROL
+  
+  self:SetFuelThreshold( .2, 60 )
+  self:SetDamageThreshold( 0.4 )
+  self:SetDisengageRadius( 70000 )
+
   
   self.PatrolZone = PatrolZone
   self.PatrolFloorAltitude = PatrolFloorAltitude
@@ -312,7 +318,7 @@ function AI_A2A_PATROL:onafterRoute( AIPatrol, From, Event, To )
   end
 
   
-  if AIPatrol:IsAlive() then
+  if AIPatrol and AIPatrol:IsAlive() then
     
     local PatrolRoute = {}
 
@@ -320,44 +326,80 @@ function AI_A2A_PATROL:onafterRoute( AIPatrol, From, Event, To )
     
     local CurrentCoord = AIPatrol:GetCoordinate()
     
-    local ToTargetCoord = self.PatrolZone:GetRandomPointVec2()
-    ToTargetCoord:SetAlt( math.random( self.PatrolFloorAltitude, self.PatrolCeilingAltitude ) )
-    self:SetTargetDistance( ToTargetCoord ) -- For RTB status check
+    -- Random altitude.
+    local altitude=math.random(self.PatrolFloorAltitude, self.PatrolCeilingAltitude)
+      
+    -- Random speed in km/h.
+    local speedkmh = math.random(self.PatrolMinSpeed, self.PatrolMaxSpeed)
     
-    local ToTargetSpeed = math.random( self.PatrolMinSpeed, self.PatrolMaxSpeed )
+    -- First waypoint is current position.
+    PatrolRoute[1]=CurrentCoord:WaypointAirTurningPoint(nil, speedkmh, {}, "Current")    
     
-    --- Create a route point of type air.
-    local ToPatrolRoutePoint = ToTargetCoord:WaypointAir( 
-      self.PatrolAltType, 
-      POINT_VEC3.RoutePointType.TurningPoint, 
-      POINT_VEC3.RoutePointAction.TurningPoint, 
-      ToTargetSpeed, 
-      true 
-    )
+    if self.racetrack then
+      
+      -- Random heading.
+      local heading = math.random(self.racetrackheadingmin, self.racetrackheadingmax)
+      
+      -- Random leg length.
+      local leg=math.random(self.racetracklegmin, self.racetracklegmax)
+      
+      -- Random duration if any.
+      local duration = self.racetrackdurationmin
+      if self.racetrackdurationmax then
+        duration=math.random(self.racetrackdurationmin, self.racetrackdurationmax)
+      end
+      
+      -- CAP coordinate.
+      local c0=self.PatrolZone:GetRandomCoordinate()
+      if self.racetrackcapcoordinates and #self.racetrackcapcoordinates>0 then
+        c0=self.racetrackcapcoordinates[math.random(#self.racetrackcapcoordinates)]
+      end
+      
+      -- Race track points.
+      local c1=c0:SetAltitude(altitude) --Core.Point#COORDINATE
+      local c2=c1:Translate(leg, heading):SetAltitude(altitude)
+      
+      self:SetTargetDistance(c0) -- For RTB status check
+      
+      -- Debug:
+      self:T(string.format("Patrol zone race track: v=%.1f knots, h=%.1f ft, heading=%03d, leg=%d m, t=%s sec", UTILS.KmphToKnots(speedkmh), UTILS.MetersToFeet(altitude), heading, leg, tostring(duration)))
+      --c1:MarkToAll("Race track c1")
+      --c2:MarkToAll("Race track c2")
 
-    PatrolRoute[#PatrolRoute+1] = ToPatrolRoutePoint
-    PatrolRoute[#PatrolRoute+1] = ToPatrolRoutePoint
-    
-    local Tasks = {}
-    Tasks[#Tasks+1] = AIPatrol:TaskFunction( "AI_A2A_PATROL.PatrolRoute", self )
-    PatrolRoute[#PatrolRoute].task = AIPatrol:TaskCombo( Tasks )
-    
+      -- Task to orbit.              
+      local taskOrbit=AIPatrol:TaskOrbit(c1, altitude, UTILS.KmphToMps(speedkmh), c2)
+      
+      -- Task function to redo the patrol at other random position.
+      local taskPatrol=AIPatrol:TaskFunction("AI_A2A_PATROL.PatrolRoute", self)
+      
+      -- Controlled task with task condition.
+      local taskCond=AIPatrol:TaskCondition(nil, nil, nil, nil, duration, nil)
+      local taskCont=AIPatrol:TaskControlled(taskOrbit, taskCond)
+      
+      -- Second waypoint
+      PatrolRoute[2]=c1:WaypointAirTurningPoint(self.PatrolAltType, speedkmh, {taskCont, taskPatrol}, "CAP Orbit")
+
+    else
+
+      -- Target coordinate.        
+      local ToTargetCoord=self.PatrolZone:GetRandomCoordinate() --Core.Point#COORDINATE
+      ToTargetCoord:SetAltitude(altitude)
+      
+      self:SetTargetDistance( ToTargetCoord ) -- For RTB status check
+      
+      local taskReRoute=AIPatrol:TaskFunction( "AI_A2A_PATROL.PatrolRoute", self )
+      
+      PatrolRoute[2]=ToTargetCoord:WaypointAirTurningPoint(self.PatrolAltType, speedkmh, {taskReRoute}, "Patrol Point")
+            
+    end
+
+    -- ROE    
     AIPatrol:OptionROEReturnFire()
     AIPatrol:OptionROTEvadeFire()
-
-    AIPatrol:Route( PatrolRoute, 0.5 )
-  end
-
-end
-
---- @param Wrapper.Group#GROUP AIPatrol
-function AI_A2A_PATROL.Resume( AIPatrol )
-
-  AIPatrol:F( { "AI_A2A_PATROL.Resume:", AIPatrol:GetName() } )
-  if AIPatrol:IsAlive() then
-    local _AI_A2A = AIPatrol:GetState( AIPatrol, "AI_A2A" ) -- AI.AI_A2A#AI_A2A
-      _AI_A2A:__Reset( 1 )
-      _AI_A2A:__Route( 5 )
-  end
   
+    -- Patrol.
+    AIPatrol:Route( PatrolRoute, 0.5)
+  end
+
 end
+

Moose Development/Moose/AI/AI_A2G_BAI.lua

@@ -0,0 +1,99 @@
+--- **AI** -- Models the process of air to ground BAI engagement for airplanes and helicopters.
+--
+-- This is a class used in the @{AI_A2G_Dispatcher}.
+-- 
+-- ===
+-- 
+-- ### Author: **FlightControl**
+-- 
+-- ===       
+--
+-- @module AI.AI_A2G_BAI
+-- @image AI_Air_To_Ground_Engage.JPG
+
+
+
+--- @type AI_A2G_BAI
+-- @extends AI.AI_A2A_Engage#AI_A2A_Engage
+
+
+--- Implements the core functions to intercept intruders. Use the Engage trigger to intercept intruders.
+-- 
+-- ===
+-- 
+-- @field #AI_A2G_BAI
+AI_A2G_BAI = {
+  ClassName = "AI_A2G_BAI",
+}
+
+
+
+--- Creates a new AI_A2G_BAI object
+-- @param #AI_A2G_BAI self
+-- @param Wrapper.Group#GROUP AIGroup
+-- @param DCS#Speed  EngageMinSpeed The minimum speed of the @{Wrapper.Group} in km/h when engaging a target.
+-- @param DCS#Speed  EngageMaxSpeed The maximum speed of the @{Wrapper.Group} in km/h when engaging a target.
+-- @param DCS#Altitude EngageFloorAltitude The lowest altitude in meters where to execute the engagement.
+-- @param DCS#Altitude EngageCeilingAltitude The highest altitude in meters where to execute the engagement.
+-- @param DCS#AltitudeType EngageAltType The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to "RADIO".
+-- @param Core.Zone#ZONE_BASE PatrolZone The @{Zone} where the patrol needs to be executed.
+-- @param DCS#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
+-- @param DCS#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
+-- @param DCS#Speed  PatrolMinSpeed The minimum speed of the @{Wrapper.Group} in km/h.
+-- @param DCS#Speed  PatrolMaxSpeed The maximum speed of the @{Wrapper.Group} in km/h.
+-- @param DCS#AltitudeType PatrolAltType The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to RADIO
+-- @return #AI_A2G_BAI
+function AI_A2G_BAI:New2( AIGroup, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, EngageAltType, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType )
+
+  local AI_Air = AI_AIR:New( AIGroup )
+  local AI_Air_Patrol = AI_AIR_PATROL:New( AI_Air, AIGroup, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType ) -- #AI_AIR_PATROL
+  local AI_Air_Engage = AI_AIR_ENGAGE:New( AI_Air_Patrol, AIGroup, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, EngageAltType )
+  local self = BASE:Inherit( self, AI_Air_Engage )
+
+  return self
+end
+
+
+--- Creates a new AI_A2G_BAI object
+-- @param #AI_A2G_BAI self
+-- @param Wrapper.Group#GROUP AIGroup
+-- @param DCS#Speed  EngageMinSpeed The minimum speed of the @{Wrapper.Group} in km/h when engaging a target.
+-- @param DCS#Speed  EngageMaxSpeed The maximum speed of the @{Wrapper.Group} in km/h when engaging a target.
+-- @param DCS#Altitude EngageFloorAltitude The lowest altitude in meters where to execute the engagement.
+-- @param DCS#Altitude EngageCeilingAltitude The highest altitude in meters where to execute the engagement.
+-- @param Core.Zone#ZONE_BASE PatrolZone The @{Zone} where the patrol needs to be executed.
+-- @param DCS#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
+-- @param DCS#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
+-- @param DCS#Speed  PatrolMinSpeed The minimum speed of the @{Wrapper.Group} in km/h.
+-- @param DCS#Speed  PatrolMaxSpeed The maximum speed of the @{Wrapper.Group} in km/h.
+-- @param DCS#AltitudeType PatrolAltType The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to RADIO
+-- @return #AI_A2G_BAI
+function AI_A2G_BAI:New( AIGroup, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType )
+
+  return self:New2( AIGroup, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, PatrolAltType, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType)
+end
+
+--- Evaluate the attack and create an AttackUnitTask list. 
+-- @param #AI_A2G_BAI self
+-- @param Core.Set#SET_UNIT AttackSetUnit The set of units to attack.
+-- @param Wrappper.Group#GROUP DefenderGroup The group of defenders.
+-- @param #number EngageAltitude The altitude to engage the targets.
+-- @return #AI_A2G_BAI self
+function AI_A2G_BAI:CreateAttackUnitTasks( AttackSetUnit, DefenderGroup, EngageAltitude )
+
+  local AttackUnitTasks = {}
+
+  local AttackSetUnitPerThreatLevel = AttackSetUnit:GetSetPerThreatLevel( 10, 0 )
+  for AttackUnitIndex, AttackUnit in ipairs( AttackSetUnitPerThreatLevel or {} ) do
+    if AttackUnit then
+      if AttackUnit:IsAlive() and AttackUnit:IsGround() then
+        self:T( { "BAI Unit:", AttackUnit:GetName() } )
+        AttackUnitTasks[#AttackUnitTasks+1] = DefenderGroup:TaskAttackUnit( AttackUnit, true, false, nil, nil, EngageAltitude )
+      end
+    end
+  end
+  
+  return AttackUnitTasks
+end
+
+

Moose Development/Moose/AI/AI_A2G_CAS.lua

@@ -0,0 +1,100 @@
+--- **AI** -- Models the process of air to ground engagement for airplanes and helicopters.
+--
+-- This is a class used in the @{AI_A2G_Dispatcher}.
+-- 
+-- ===
+-- 
+-- ### Author: **FlightControl**
+-- 
+-- ===       
+--
+-- @module AI.AI_A2G_CAS
+-- @image AI_Air_To_Ground_Engage.JPG
+
+
+
+--- @type AI_A2G_CAS
+-- @extends AI.AI_A2G_Patrol#AI_AIR_PATROL
+
+
+--- Implements the core functions to intercept intruders. Use the Engage trigger to intercept intruders.
+-- 
+-- ===
+-- 
+-- @field #AI_A2G_CAS
+AI_A2G_CAS = {
+  ClassName = "AI_A2G_CAS",
+}
+
+
+
+--- Creates a new AI_A2G_CAS object
+-- @param #AI_A2G_CAS self
+-- @param Wrapper.Group#GROUP AIGroup
+-- @param DCS#Speed  EngageMinSpeed The minimum speed of the @{Wrapper.Group} in km/h when engaging a target.
+-- @param DCS#Speed  EngageMaxSpeed The maximum speed of the @{Wrapper.Group} in km/h when engaging a target.
+-- @param DCS#Altitude EngageFloorAltitude The lowest altitude in meters where to execute the engagement.
+-- @param DCS#Altitude EngageCeilingAltitude The highest altitude in meters where to execute the engagement.
+-- @param DCS#AltitudeType EngageAltType The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to "RADIO".
+-- @param Core.Zone#ZONE_BASE PatrolZone The @{Zone} where the patrol needs to be executed.
+-- @param DCS#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
+-- @param DCS#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
+-- @param DCS#Speed  PatrolMinSpeed The minimum speed of the @{Wrapper.Group} in km/h.
+-- @param DCS#Speed  PatrolMaxSpeed The maximum speed of the @{Wrapper.Group} in km/h.
+-- @param DCS#AltitudeType PatrolAltType The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to RADIO
+-- @return #AI_A2G_CAS
+function AI_A2G_CAS:New2( AIGroup, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, EngageAltType, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType )
+
+  local AI_Air = AI_AIR:New( AIGroup )
+  local AI_Air_Patrol = AI_AIR_PATROL:New( AI_Air, AIGroup, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType ) -- #AI_AIR_PATROL
+  local AI_Air_Engage = AI_AIR_ENGAGE:New( AI_Air_Patrol, AIGroup, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, EngageAltType )
+  local self = BASE:Inherit( self, AI_Air_Engage )
+
+  return self
+end
+
+
+--- Creates a new AI_A2G_CAS object
+-- @param #AI_A2G_CAS self
+-- @param Wrapper.Group#GROUP AIGroup
+-- @param DCS#Speed  EngageMinSpeed The minimum speed of the @{Wrapper.Group} in km/h when engaging a target.
+-- @param DCS#Speed  EngageMaxSpeed The maximum speed of the @{Wrapper.Group} in km/h when engaging a target.
+-- @param DCS#Altitude EngageFloorAltitude The lowest altitude in meters where to execute the engagement.
+-- @param DCS#Altitude EngageCeilingAltitude The highest altitude in meters where to execute the engagement.
+-- @param Core.Zone#ZONE_BASE PatrolZone The @{Zone} where the patrol needs to be executed.
+-- @param DCS#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
+-- @param DCS#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
+-- @param DCS#Speed  PatrolMinSpeed The minimum speed of the @{Wrapper.Group} in km/h.
+-- @param DCS#Speed  PatrolMaxSpeed The maximum speed of the @{Wrapper.Group} in km/h.
+-- @param DCS#AltitudeType PatrolAltType The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to RADIO
+-- @return #AI_A2G_CAS
+function AI_A2G_CAS:New( AIGroup, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType )
+
+  return self:New2( AIGroup, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, PatrolAltType, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType)
+end
+
+--- Evaluate the attack and create an AttackUnitTask list. 
+-- @param #AI_A2G_CAS self
+-- @param Core.Set#SET_UNIT AttackSetUnit The set of units to attack.
+-- @param Wrappper.Group#GROUP DefenderGroup The group of defenders.
+-- @param #number EngageAltitude The altitude to engage the targets.
+-- @return #AI_A2G_CAS self
+function AI_A2G_CAS:CreateAttackUnitTasks( AttackSetUnit, DefenderGroup, EngageAltitude )
+
+  local AttackUnitTasks = {}
+  
+  local AttackSetUnitPerThreatLevel = AttackSetUnit:GetSetPerThreatLevel( 10, 0 )
+  for AttackUnitIndex, AttackUnit in ipairs( AttackSetUnitPerThreatLevel or {} ) do
+    if AttackUnit then
+      if AttackUnit:IsAlive() and AttackUnit:IsGround() then
+        self:T( { "CAS Unit:", AttackUnit:GetName() } )
+        AttackUnitTasks[#AttackUnitTasks+1] = DefenderGroup:TaskAttackUnit( AttackUnit, true, false, nil, nil, EngageAltitude )
+      end
+    end
+  end
+  
+  return AttackUnitTasks
+end
+
+
+

Moose Development/Moose/AI/AI_A2G_SEAD.lua

@@ -0,0 +1,152 @@
+--- **AI** -- Models the process of air to ground SEAD engagement for airplanes and helicopters.
+--
+-- This is a class used in the @{AI_A2G_Dispatcher}.
+-- 
+-- ===
+-- 
+-- ### Author: **FlightControl**
+-- 
+-- ===       
+--
+-- @module AI.AI_A2G_SEAD
+-- @image AI_Air_To_Ground_Engage.JPG
+
+
+
+--- @type AI_A2G_SEAD
+-- @extends AI.AI_A2G_Patrol#AI_AIR_PATROL
+
+
+--- Implements the core functions to SEAD intruders. Use the Engage trigger to intercept intruders.
+-- 
+-- ![Process](..\Presentations\AI_GCI\Dia3.JPG)
+-- 
+-- The AI_A2G_SEAD is assigned a @{Wrapper.Group} and this must be done before the AI_A2G_SEAD process can be started using the **Start** event.
+-- 
+-- ![Process](..\Presentations\AI_GCI\Dia4.JPG)
+-- 
+-- The AI will fly towards the random 3D point within the patrol zone, using a random speed within the given altitude and speed limits.
+-- Upon arrival at the 3D point, a new random 3D point will be selected within the patrol zone using the given limits.
+-- 
+-- ![Process](..\Presentations\AI_GCI\Dia5.JPG)
+-- 
+-- This cycle will continue.
+-- 
+-- ![Process](..\Presentations\AI_GCI\Dia6.JPG)
+-- 
+-- During the patrol, the AI will detect enemy targets, which are reported through the **Detected** event.
+--
+-- ![Process](..\Presentations\AI_GCI\Dia9.JPG)
+-- 
+-- When enemies are detected, the AI will automatically engage the enemy.
+-- 
+-- ![Process](..\Presentations\AI_GCI\Dia10.JPG)
+-- 
+-- Until a fuel or damage treshold has been reached by the AI, or when the AI is commanded to RTB.
+-- When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
+-- 
+-- ![Process](..\Presentations\AI_GCI\Dia13.JPG)
+-- 
+-- ## 1. AI_A2G_SEAD constructor
+--   
+--   * @{#AI_A2G_SEAD.New}(): Creates a new AI_A2G_SEAD object.
+--
+-- ## 3. Set the Range of Engagement
+-- 
+-- ![Range](..\Presentations\AI_GCI\Dia11.JPG)
+-- 
+-- An optional range can be set in meters, 
+-- that will define when the AI will engage with the detected airborne enemy targets.
+-- The range can be beyond or smaller than the range of the Patrol Zone.
+-- The range is applied at the position of the AI.
+-- Use the method @{AI.AI_GCI#AI_A2G_SEAD.SetEngageRange}() to define that range.
+--
+-- ## 4. Set the Zone of Engagement
+-- 
+-- ![Zone](..\Presentations\AI_GCI\Dia12.JPG)
+-- 
+-- An optional @{Zone} can be set, 
+-- that will define when the AI will engage with the detected airborne enemy targets.
+-- Use the method @{AI.AI_Cap#AI_A2G_SEAD.SetEngageZone}() to define that Zone.
+--  
+-- ===
+-- 
+-- @field #AI_A2G_SEAD
+AI_A2G_SEAD = {
+  ClassName = "AI_A2G_SEAD",
+}
+
+
+
+--- Creates a new AI_A2G_SEAD object
+-- @param #AI_A2G_SEAD self
+-- @param Wrapper.Group#GROUP AIGroup
+-- @param DCS#Speed  EngageMinSpeed The minimum speed of the @{Wrapper.Group} in km/h when engaging a target.
+-- @param DCS#Speed  EngageMaxSpeed The maximum speed of the @{Wrapper.Group} in km/h when engaging a target.
+-- @param DCS#Altitude EngageFloorAltitude The lowest altitude in meters where to execute the engagement.
+-- @param DCS#Altitude EngageCeilingAltitude The highest altitude in meters where to execute the engagement.
+-- @param DCS#AltitudeType EngageAltType The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to "RADIO".
+-- @param Core.Zone#ZONE_BASE PatrolZone The @{Zone} where the patrol needs to be executed.
+-- @param DCS#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
+-- @param DCS#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
+-- @param DCS#Speed  PatrolMinSpeed The minimum speed of the @{Wrapper.Group} in km/h.
+-- @param DCS#Speed  PatrolMaxSpeed The maximum speed of the @{Wrapper.Group} in km/h.
+-- @param DCS#AltitudeType PatrolAltType The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to RADIO
+-- @return #AI_A2G_SEAD
+function AI_A2G_SEAD:New2( AIGroup, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, EngageAltType, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType )
+
+  local AI_Air = AI_AIR:New( AIGroup )
+  local AI_Air_Patrol = AI_AIR_PATROL:New( AI_Air, AIGroup, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType ) -- #AI_AIR_PATROL
+  local AI_Air_Engage = AI_AIR_ENGAGE:New( AI_Air_Patrol, AIGroup, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, EngageAltType )
+  local self = BASE:Inherit( self, AI_Air_Engage )
+
+  return self
+end
+
+
+--- Creates a new AI_A2G_SEAD object
+-- @param #AI_A2G_SEAD self
+-- @param Wrapper.Group#GROUP AIGroup
+-- @param DCS#Speed  EngageMinSpeed The minimum speed of the @{Wrapper.Group} in km/h when engaging a target.
+-- @param DCS#Speed  EngageMaxSpeed The maximum speed of the @{Wrapper.Group} in km/h when engaging a target.
+-- @param DCS#Altitude EngageFloorAltitude The lowest altitude in meters where to execute the engagement.
+-- @param DCS#Altitude EngageCeilingAltitude The highest altitude in meters where to execute the engagement.
+-- @param Core.Zone#ZONE_BASE PatrolZone The @{Zone} where the patrol needs to be executed.
+-- @param DCS#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
+-- @param DCS#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
+-- @param DCS#Speed  PatrolMinSpeed The minimum speed of the @{Wrapper.Group} in km/h.
+-- @param DCS#Speed  PatrolMaxSpeed The maximum speed of the @{Wrapper.Group} in km/h.
+-- @param DCS#AltitudeType PatrolAltType The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to RADIO
+-- @return #AI_A2G_SEAD
+function AI_A2G_SEAD:New( AIGroup, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType )
+
+  return self:New2( AIGroup, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, PatrolAltType, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType )
+end
+
+
+--- Evaluate the attack and create an AttackUnitTask list. 
+-- @param #AI_A2G_SEAD self
+-- @param Core.Set#SET_UNIT AttackSetUnit The set of units to attack.
+-- @param Wrappper.Group#GROUP DefenderGroup The group of defenders.
+-- @param #number EngageAltitude The altitude to engage the targets.
+-- @return #AI_A2G_SEAD self
+function AI_A2G_SEAD:CreateAttackUnitTasks( AttackSetUnit, DefenderGroup, EngageAltitude )
+
+  local AttackUnitTasks = {}
+  
+  local AttackSetUnitPerThreatLevel = AttackSetUnit:GetSetPerThreatLevel( 10, 0 )
+  for AttackUnitID, AttackUnit in ipairs( AttackSetUnitPerThreatLevel ) do
+    if AttackUnit then
+      if AttackUnit:IsAlive() and AttackUnit:IsGround() then
+        local HasRadar = AttackUnit:HasSEAD() 
+        if HasRadar then
+          self:F( { "SEAD Unit:", AttackUnit:GetName() } )
+          AttackUnitTasks[#AttackUnitTasks+1] = DefenderGroup:TaskAttackUnit( AttackUnit, true, false, nil, nil, EngageAltitude )
+        end
+      end
+    end
+  end
+  
+  return AttackUnitTasks
+end
+

Moose Development/Moose/AI/AI_Air.lua

@@ -1,4 +1,4 @@
---- **AI** -- (R2.2) - Models the process of air operations for airplanes.
+--- **AI** -- Models the process of AI air operations.
 -- 
 -- ===
 -- 
@@ -6,102 +6,99 @@
 -- 
 -- ===
 -- 
--- @module AI.AI_A2A
--- @image AI_Air_To_Air_Dispatching.JPG
+-- @module AI.AI_Air
+-- @image MOOSE.JPG
 
---BASE:TraceClass("AI_A2A")
-
-
---- @type AI_A2A
+--- @type AI_AIR
 -- @extends Core.Fsm#FSM_CONTROLLABLE
 
---- The AI_A2A class implements the core functions to operate an AI @{Wrapper.Group} A2A tasking.
+--- The AI_AIR class implements the core functions to operate an AI @{Wrapper.Group}.
 -- 
 -- 
--- ## AI_A2A constructor
+-- # 1) AI_AIR constructor
 --   
---   * @{#AI_A2A.New}(): Creates a new AI_A2A object.
+--   * @{#AI_AIR.New}(): Creates a new AI_AIR object.
 -- 
--- ## 2. AI_A2A is a FSM
+-- # 2) AI_AIR is a Finite State Machine.
 -- 
--- ![Process](..\Presentations\AI_PATROL\Dia2.JPG)
+-- This section must be read as follows. Each of the rows indicate a state transition, triggered through an event, and with an ending state of the event was executed.
+-- The first column is the **From** state, the second column the **Event**, and the third column the **To** state.
 -- 
--- ### 2.1. AI_A2A States
+-- So, each of the rows have the following structure.
 -- 
---   * **None** ( Group ): The process is not started yet.
---   * **Patrolling** ( Group ): The AI is patrolling the Patrol Zone.
---   * **Returning** ( Group ): The AI is returning to Base.
---   * **Stopped** ( Group ): The process is stopped.
---   * **Crashed** ( Group ): The AI has crashed or is dead.
+--   * **From** => **Event** => **To**
 -- 
--- ### 2.2. AI_A2A Events
+-- Important to know is that an event can only be executed if the **current state** is the **From** state.
+-- This, when an **Event** that is being triggered has a **From** state that is equal to the **Current** state of the state machine, the event will be executed,
+-- and the resulting state will be the **To** state.
 -- 
---   * **Start** ( Group ): Start the process.
---   * **Stop** ( Group ): Stop the process.
---   * **Route** ( Group ): Route the AI to a new random 3D point within the Patrol Zone.
---   * **RTB** ( Group ): Route the AI to the home base.
---   * **Detect** ( Group ): The AI is detecting targets.
---   * **Detected** ( Group ): The AI has detected new targets.
---   * **Status** ( Group ): The AI is checking status (fuel and damage). When the tresholds have been reached, the AI will RTB.
---    
--- ## 3. Set or Get the AI controllable
+-- These are the different possible state transitions of this state machine implementation: 
 -- 
---   * @{#AI_A2A.SetControllable}(): Set the AIControllable.
---   * @{#AI_A2A.GetControllable}(): Get the AIControllable.
+--   * Idle => Start => Monitoring
 --
--- @field #AI_A2A
-AI_A2A = {
-  ClassName = "AI_A2A",
+-- ## 2.1) AI_AIR States.
+-- 
+--   * **Idle**: The process is idle.
+-- 
+-- ## 2.2) AI_AIR Events.
+-- 
+--   * **Start**: Start the transport process.
+--   * **Stop**: Stop the transport process.
+--   * **Monitor**: Monitor and take action.
+--
+-- @field #AI_AIR
+AI_AIR = {
+  ClassName = "AI_AIR",
 }
 
---- Creates a new AI_A2A object
--- @param #AI_A2A self
--- @param Wrapper.Group#GROUP AIGroup The GROUP object to receive the A2A Process.
--- @return #AI_A2A
-function AI_A2A:New( AIGroup )
+AI_AIR.TaskDelay = 0.5 -- The delay of each task given to the AI.
+
+--- Creates a new AI_AIR process.
+-- @param #AI_AIR self
+-- @param Wrapper.Group#GROUP AIGroup The group object to receive the A2G Process.
+-- @return #AI_AIR
+function AI_AIR:New( AIGroup )
 
   -- Inherits from BASE
-  local self = BASE:Inherit( self, FSM_CONTROLLABLE:New() ) -- #AI_A2A
+  local self = BASE:Inherit( self, FSM_CONTROLLABLE:New() ) -- #AI_AIR
   
   self:SetControllable( AIGroup )
   
-  self:SetFuelThreshold( .2, 60 )
-  self:SetDamageThreshold( 0.4 )
-  self:SetDisengageRadius( 70000 )
-
   self:SetStartState( "Stopped" ) 
-  
+
+  self:AddTransition( "*", "Queue", "Queued" )
+
   self:AddTransition( "*", "Start", "Started" )
   
-  --- Start Handler OnBefore for AI_A2A
-  -- @function [parent=#AI_A2A] OnBeforeStart
-  -- @param #AI_A2A self
+  --- Start Handler OnBefore for AI_AIR
+  -- @function [parent=#AI_AIR] OnBeforeStart
+  -- @param #AI_AIR self
   -- @param #string From
   -- @param #string Event
   -- @param #string To
   -- @return #boolean
   
-  --- Start Handler OnAfter for AI_A2A
-  -- @function [parent=#AI_A2A] OnAfterStart
-  -- @param #AI_A2A self
+  --- Start Handler OnAfter for AI_AIR
+  -- @function [parent=#AI_AIR] OnAfterStart
+  -- @param #AI_AIR self
   -- @param #string From
   -- @param #string Event
   -- @param #string To
   
-  --- Start Trigger for AI_A2A
-  -- @function [parent=#AI_A2A] Start
-  -- @param #AI_A2A self
+  --- Start Trigger for AI_AIR
+  -- @function [parent=#AI_AIR] Start
+  -- @param #AI_AIR self
   
-  --- Start Asynchronous Trigger for AI_A2A
-  -- @function [parent=#AI_A2A] __Start
-  -- @param #AI_A2A self
+  --- Start Asynchronous Trigger for AI_AIR
+  -- @function [parent=#AI_AIR] __Start
+  -- @param #AI_AIR self
   -- @param #number Delay
 
   self:AddTransition( "*", "Stop", "Stopped" )
 
 --- OnLeave Transition Handler for State Stopped.
--- @function [parent=#AI_A2A] OnLeaveStopped
--- @param #AI_A2A self
+-- @function [parent=#AI_AIR] OnLeaveStopped
+-- @param #AI_AIR self
 -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM.
 -- @param #string From The From State string.
 -- @param #string Event The Event string.
@@ -109,16 +106,16 @@ function AI_A2A:New( AIGroup )
 -- @return #boolean Return false to cancel Transition.
 
 --- OnEnter Transition Handler for State Stopped.
--- @function [parent=#AI_A2A] OnEnterStopped
--- @param #AI_A2A self
+-- @function [parent=#AI_AIR] OnEnterStopped
+-- @param #AI_AIR self
 -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM.
 -- @param #string From The From State string.
 -- @param #string Event The Event string.
 -- @param #string To The To State string.
 
 --- OnBefore Transition Handler for Event Stop.
--- @function [parent=#AI_A2A] OnBeforeStop
--- @param #AI_A2A self
+-- @function [parent=#AI_AIR] OnBeforeStop
+-- @param #AI_AIR self
 -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM.
 -- @param #string From The From State string.
 -- @param #string Event The Event string.
@@ -126,27 +123,27 @@ function AI_A2A:New( AIGroup )
 -- @return #boolean Return false to cancel Transition.
 
 --- OnAfter Transition Handler for Event Stop.
--- @function [parent=#AI_A2A] OnAfterStop
--- @param #AI_A2A self
+-- @function [parent=#AI_AIR] OnAfterStop
+-- @param #AI_AIR self
 -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM.
 -- @param #string From The From State string.
 -- @param #string Event The Event string.
 -- @param #string To The To State string.
 	
 --- Synchronous Event Trigger for Event Stop.
--- @function [parent=#AI_A2A] Stop
--- @param #AI_A2A self
+-- @function [parent=#AI_AIR] Stop
+-- @param #AI_AIR self
 
 --- Asynchronous Event Trigger for Event Stop.
--- @function [parent=#AI_A2A] __Stop
--- @param #AI_A2A self
+-- @function [parent=#AI_AIR] __Stop
+-- @param #AI_AIR self
 -- @param #number Delay The delay in seconds.
 
-  self:AddTransition( "*", "Status", "*" ) -- FSM_CONTROLLABLE Transition for type #AI_A2A.
+  self:AddTransition( "*", "Status", "*" ) -- FSM_CONTROLLABLE Transition for type #AI_AIR.
 
 --- OnBefore Transition Handler for Event Status.
--- @function [parent=#AI_A2A] OnBeforeStatus
--- @param #AI_A2A self
+-- @function [parent=#AI_AIR] OnBeforeStatus
+-- @param #AI_AIR self
 -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM.
 -- @param #string From The From State string.
 -- @param #string Event The Event string.
@@ -154,27 +151,27 @@ function AI_A2A:New( AIGroup )
 -- @return #boolean Return false to cancel Transition.
 
 --- OnAfter Transition Handler for Event Status.
--- @function [parent=#AI_A2A] OnAfterStatus
--- @param #AI_A2A self
+-- @function [parent=#AI_AIR] OnAfterStatus
+-- @param #AI_AIR self
 -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM.
 -- @param #string From The From State string.
 -- @param #string Event The Event string.
 -- @param #string To The To State string.
 	
 --- Synchronous Event Trigger for Event Status.
--- @function [parent=#AI_A2A] Status
--- @param #AI_A2A self
+-- @function [parent=#AI_AIR] Status
+-- @param #AI_AIR self
 
 --- Asynchronous Event Trigger for Event Status.
--- @function [parent=#AI_A2A] __Status
--- @param #AI_A2A self
+-- @function [parent=#AI_AIR] __Status
+-- @param #AI_AIR self
 -- @param #number Delay The delay in seconds.
 
-  self:AddTransition( "*", "RTB", "*" ) -- FSM_CONTROLLABLE Transition for type #AI_A2A.
+  self:AddTransition( "*", "RTB", "*" ) -- FSM_CONTROLLABLE Transition for type #AI_AIR.
 
 --- OnBefore Transition Handler for Event RTB.
--- @function [parent=#AI_A2A] OnBeforeRTB
--- @param #AI_A2A self
+-- @function [parent=#AI_AIR] OnBeforeRTB
+-- @param #AI_AIR self
 -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM.
 -- @param #string From The From State string.
 -- @param #string Event The Event string.
@@ -182,25 +179,25 @@ function AI_A2A:New( AIGroup )
 -- @return #boolean Return false to cancel Transition.
 
 --- OnAfter Transition Handler for Event RTB.
--- @function [parent=#AI_A2A] OnAfterRTB
--- @param #AI_A2A self
+-- @function [parent=#AI_AIR] OnAfterRTB
+-- @param #AI_AIR self
 -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM.
 -- @param #string From The From State string.
 -- @param #string Event The Event string.
 -- @param #string To The To State string.
 	
 --- Synchronous Event Trigger for Event RTB.
--- @function [parent=#AI_A2A] RTB
--- @param #AI_A2A self
+-- @function [parent=#AI_AIR] RTB
+-- @param #AI_AIR self
 
 --- Asynchronous Event Trigger for Event RTB.
--- @function [parent=#AI_A2A] __RTB
--- @param #AI_A2A self
+-- @function [parent=#AI_AIR] __RTB
+-- @param #AI_AIR self
 -- @param #number Delay The delay in seconds.
 
 --- OnLeave Transition Handler for State Returning.
--- @function [parent=#AI_A2A] OnLeaveReturning
--- @param #AI_A2A self
+-- @function [parent=#AI_AIR] OnLeaveReturning
+-- @param #AI_AIR self
 -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM.
 -- @param #string From The From State string.
 -- @param #string Event The Event string.
@@ -208,8 +205,8 @@ function AI_A2A:New( AIGroup )
 -- @return #boolean Return false to cancel Transition.
 
 --- OnEnter Transition Handler for State Returning.
--- @function [parent=#AI_A2A] OnEnterReturning
--- @param #AI_A2A self
+-- @function [parent=#AI_AIR] OnEnterReturning
+-- @param #AI_AIR self
 -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM.
 -- @param #string From The From State string.
 -- @param #string Event The Event string.
@@ -217,30 +214,30 @@ function AI_A2A:New( AIGroup )
 
   self:AddTransition( "Patrolling", "Refuel", "Refuelling" ) 
 
-  --- Refuel Handler OnBefore for AI_A2A
-  -- @function [parent=#AI_A2A] OnBeforeRefuel
-  -- @param #AI_A2A self
+  --- Refuel Handler OnBefore for AI_AIR
+  -- @function [parent=#AI_AIR] OnBeforeRefuel
+  -- @param #AI_AIR self
   -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM.
   -- @param #string From
   -- @param #string Event
   -- @param #string To
   -- @return #boolean
   
-  --- Refuel Handler OnAfter for AI_A2A
-  -- @function [parent=#AI_A2A] OnAfterRefuel
-  -- @param #AI_A2A self
+  --- Refuel Handler OnAfter for AI_AIR
+  -- @function [parent=#AI_AIR] OnAfterRefuel
+  -- @param #AI_AIR self
   -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM.
   -- @param #string From
   -- @param #string Event
   -- @param #string To
   
-  --- Refuel Trigger for AI_A2A
-  -- @function [parent=#AI_A2A] Refuel
-  -- @param #AI_A2A self
+  --- Refuel Trigger for AI_AIR
+  -- @function [parent=#AI_AIR] Refuel
+  -- @param #AI_AIR self
   
-  --- Refuel Asynchronous Trigger for AI_A2A
-  -- @function [parent=#AI_A2A] __Refuel
-  -- @param #AI_A2A self
+  --- Refuel Asynchronous Trigger for AI_AIR
+  -- @function [parent=#AI_AIR] __Refuel
+  -- @param #AI_AIR self
   -- @param #number Delay
 
   self:AddTransition( "*", "Takeoff", "Airborne" )
@@ -266,15 +263,17 @@ function GROUP:OnEventTakeoff( EventData, Fsm )
   self:UnHandleEvent( EVENTS.Takeoff )
 end
 
-function AI_A2A:SetDispatcher( Dispatcher )
+
+
+function AI_AIR:SetDispatcher( Dispatcher )
   self.Dispatcher = Dispatcher
 end
 
-function AI_A2A:GetDispatcher()
+function AI_AIR:GetDispatcher()
   return self.Dispatcher
 end
 
-function AI_A2A:SetTargetDistance( Coordinate )
+function AI_AIR:SetTargetDistance( Coordinate )
 
   local CurrentCoord = self.Controllable:GetCoordinate()
   self.TargetDistance = CurrentCoord:Get2DDistance( Coordinate )
@@ -283,7 +282,7 @@ function AI_A2A:SetTargetDistance( Coordinate )
 end
 
 
-function AI_A2A:ClearTargetDistance()
+function AI_AIR:ClearTargetDistance()
 
   self.TargetDistance = nil
   self.ClosestTargetDistance = nil
@@ -291,11 +290,11 @@ end
 
 
 --- Sets (modifies) the minimum and maximum speed of the patrol.
--- @param #AI_A2A self
+-- @param #AI_AIR self
 -- @param DCS#Speed  PatrolMinSpeed The minimum speed of the @{Wrapper.Controllable} in km/h.
 -- @param DCS#Speed  PatrolMaxSpeed The maximum speed of the @{Wrapper.Controllable} in km/h.
--- @return #AI_A2A self
-function AI_A2A:SetSpeed( PatrolMinSpeed, PatrolMaxSpeed )
+-- @return #AI_AIR self
+function AI_AIR:SetSpeed( PatrolMinSpeed, PatrolMaxSpeed )
   self:F2( { PatrolMinSpeed, PatrolMaxSpeed } )
   
   self.PatrolMinSpeed = PatrolMinSpeed
@@ -303,12 +302,25 @@ function AI_A2A:SetSpeed( PatrolMinSpeed, PatrolMaxSpeed )
 end
 
 
+--- Sets (modifies) the minimum and maximum RTB speed of the patrol.
+-- @param #AI_AIR self
+-- @param DCS#Speed  RTBMinSpeed The minimum speed of the @{Wrapper.Controllable} in km/h.
+-- @param DCS#Speed  RTBMaxSpeed The maximum speed of the @{Wrapper.Controllable} in km/h.
+-- @return #AI_AIR self
+function AI_AIR:SetRTBSpeed( RTBMinSpeed, RTBMaxSpeed )
+  self:F( { RTBMinSpeed, RTBMaxSpeed } )
+  
+  self.RTBMinSpeed = RTBMinSpeed
+  self.RTBMaxSpeed = RTBMaxSpeed
+end
+
+
 --- Sets the floor and ceiling altitude of the patrol.
--- @param #AI_A2A self
+-- @param #AI_AIR self
 -- @param DCS#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
 -- @param DCS#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
--- @return #AI_A2A self
-function AI_A2A:SetAltitude( PatrolFloorAltitude, PatrolCeilingAltitude )
+-- @return #AI_AIR self
+function AI_AIR:SetAltitude( PatrolFloorAltitude, PatrolCeilingAltitude )
   self:F2( { PatrolFloorAltitude, PatrolCeilingAltitude } )
   
   self.PatrolFloorAltitude = PatrolFloorAltitude
@@ -317,20 +329,20 @@ end
 
 
 --- Sets the home airbase.
--- @param #AI_A2A self
+-- @param #AI_AIR self
 -- @param Wrapper.Airbase#AIRBASE HomeAirbase
--- @return #AI_A2A self
-function AI_A2A:SetHomeAirbase( HomeAirbase )
+-- @return #AI_AIR self
+function AI_AIR:SetHomeAirbase( HomeAirbase )
   self:F2( { HomeAirbase } )
   
   self.HomeAirbase = HomeAirbase
 end
 
 --- Sets to refuel at the given tanker.
--- @param #AI_A2A self
+-- @param #AI_AIR self
 -- @param Wrapper.Group#GROUP TankerName The group name of the tanker as defined within the Mission Editor or spawned.
--- @return #AI_A2A self
-function AI_A2A:SetTanker( TankerName )
+-- @return #AI_AIR self
+function AI_AIR:SetTanker( TankerName )
   self:F2( { TankerName } )
   
   self.TankerName = TankerName
@@ -338,19 +350,19 @@ end
 
 
 --- Sets the disengage range, that when engaging a target beyond the specified range, the engagement will be cancelled and the plane will RTB.
--- @param #AI_A2A self
+-- @param #AI_AIR self
 -- @param #number DisengageRadius The disengage range.
--- @return #AI_A2A self
-function AI_A2A:SetDisengageRadius( DisengageRadius )
+-- @return #AI_AIR self
+function AI_AIR:SetDisengageRadius( DisengageRadius )
   self:F2( { DisengageRadius } )
   
   self.DisengageRadius = DisengageRadius
 end
 
 --- Set the status checking off.
--- @param #AI_A2A self
--- @return #AI_A2A self
-function AI_A2A:SetStatusOff()
+-- @param #AI_AIR self
+-- @return #AI_AIR self
+function AI_AIR:SetStatusOff()
   self:F2()
   
   self.CheckStatus = false
@@ -359,16 +371,16 @@ end
 
 --- When the AI is out of fuel, it is required that a new AI is started, before the old AI can return to the home base.
 -- Therefore, with a parameter and a calculation of the distance to the home base, the fuel treshold is calculated.
--- When the fuel treshold is reached, the AI will continue for a given time its patrol task in orbit, while a new AIControllable is targetted to the AI_A2A.
+-- When the fuel treshold is reached, the AI will continue for a given time its patrol task in orbit, while a new AIControllable is targetted to the AI_AIR.
 -- Once the time is finished, the old AI will return to the base.
--- @param #AI_A2A self
--- @param #number PatrolFuelThresholdPercentage The treshold in percentage (between 0 and 1) when the AIControllable is considered to get out of fuel.
--- @param #number PatrolOutOfFuelOrbitTime The amount of seconds the out of fuel AIControllable will orbit before returning to the base.
--- @return #AI_A2A self
-function AI_A2A:SetFuelThreshold( PatrolFuelThresholdPercentage, PatrolOutOfFuelOrbitTime )
+-- @param #AI_AIR self
+-- @param #number FuelThresholdPercentage The treshold in percentage (between 0 and 1) when the AIControllable is considered to get out of fuel.
+-- @param #number OutOfFuelOrbitTime The amount of seconds the out of fuel AIControllable will orbit before returning to the base.
+-- @return #AI_AIR self
+function AI_AIR:SetFuelThreshold( FuelThresholdPercentage, OutOfFuelOrbitTime )
 
-  self.PatrolFuelThresholdPercentage = PatrolFuelThresholdPercentage
-  self.PatrolOutOfFuelOrbitTime = PatrolOutOfFuelOrbitTime
+  self.FuelThresholdPercentage = FuelThresholdPercentage
+  self.OutOfFuelOrbitTime = OutOfFuelOrbitTime
   
   self.Controllable:OptionRTBBingoFuel( false )
   
@@ -381,10 +393,10 @@ end
 -- the AI will return immediately to the home base (RTB).
 -- Note that for groups, the average damage of the complete group will be calculated.
 -- So, in a group of 4 airplanes, 2 lost and 2 with damage 0.2, the damage treshold will be 0.25.
--- @param #AI_A2A self
+-- @param #AI_AIR self
 -- @param #number PatrolDamageThreshold The treshold in percentage (between 0 and 1) when the AI is considered to be damaged.
--- @return #AI_A2A self
-function AI_A2A:SetDamageThreshold( PatrolDamageThreshold )
+-- @return #AI_AIR self
+function AI_AIR:SetDamageThreshold( PatrolDamageThreshold )
 
   self.PatrolManageDamage = true
   self.PatrolDamageThreshold = PatrolDamageThreshold
@@ -392,15 +404,16 @@ function AI_A2A:SetDamageThreshold( PatrolDamageThreshold )
   return self
 end
 
+
+
 --- Defines a new patrol route using the @{Process_PatrolZone} parameters and settings.
--- @param #AI_A2A self
--- @return #AI_A2A self
+-- @param #AI_AIR self
+-- @return #AI_AIR self
 -- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM.
 -- @param #string From The From State string.
 -- @param #string Event The Event string.
 -- @param #string To The To State string.
-function AI_A2A:onafterStart( Controllable, From, Event, To )
-  self:F2()
+function AI_AIR:onafterStart( Controllable, From, Event, To )
 
   self:__Status( 10 ) -- Check status status every 30 seconds.
   
@@ -412,18 +425,27 @@ function AI_A2A:onafterStart( Controllable, From, Event, To )
   Controllable:OptionROTVertical()
 end
 
+--- Coordinates the approriate returning action.
+-- @param #AI_AIR self
+-- @return #AI_AIR self
+-- @param Wrapper.Controllable#CONTROLLABLE Controllable The Controllable Object managed by the FSM.
+-- @param #string From The From State string.
+-- @param #string Event The Event string.
+-- @param #string To The To State string.
+function AI_AIR:onafterReturn( Controllable, From, Event, To )
 
+  self:__RTB( self.TaskDelay )
+  
+end
 
---- @param #AI_A2A self
-function AI_A2A:onbeforeStatus()
+--- @param #AI_AIR self
+function AI_AIR:onbeforeStatus()
 
   return self.CheckStatus
 end
 
---- @param #AI_A2A self
-function AI_A2A:onafterStatus()
-
-  self:F( " Checking Status" )
+--- @param #AI_AIR self
+function AI_AIR:onafterStatus()
 
   if self.Controllable and self.Controllable:IsAlive() then
   
@@ -433,66 +455,80 @@ function AI_A2A:onafterStatus()
     
     if not self:Is( "Holding" ) and not self:Is( "Returning" ) then
       local DistanceFromHomeBase = self.HomeAirbase:GetCoordinate():Get2DDistance( self.Controllable:GetCoordinate() )
-      self:F({DistanceFromHomeBase=DistanceFromHomeBase})
       
       if DistanceFromHomeBase > self.DisengageRadius then
-        self:E( self.Controllable:GetName() .. " is too far from home base, RTB!" )
+        self:I( self.Controllable:GetName() .. " is too far from home base, RTB!" )
         self:Hold( 300 )
         RTB = false
       end
     end
-    
-    if self:Is( "Fuel" ) or self:Is( "Damaged" ) or self:Is( "LostControl" ) then
-      if DistanceFromHomeBase < 5000 then
-        self:E( self.Controllable:GetName() .. " is too far from home base, RTB!" )
-        self:Home( "Destroy" )
-      end
-    end
+
+-- I think this code is not requirement anymore after release 2.5.    
+--    if self:Is( "Fuel" ) or self:Is( "Damaged" ) or self:Is( "LostControl" ) then
+--      if DistanceFromHomeBase < 5000 then
+--        self:E( self.Controllable:GetName() .. " is near the home base, RTB!" )
+--        self:Home( "Destroy" )
+--      end
+--    end
     
 
-    if not self:Is( "Fuel" ) and not self:Is( "Home" ) then
+    if not self:Is( "Fuel" ) and not self:Is( "Home" ) and not self:is( "Refuelling" )then
+      
       local Fuel = self.Controllable:GetFuelMin()
-      self:F({Fuel=Fuel})
-      if Fuel < self.PatrolFuelThresholdPercentage then
+      
+      -- If the fuel in the controllable is below the treshold percentage,
+      -- then send for refuel in case of a tanker, otherwise RTB.
+      if Fuel < self.FuelThresholdPercentage then
+      
         if self.TankerName then
-          self:E( self.Controllable:GetName() .. " is out of fuel: " .. Fuel .. " ... Refuelling at Tanker!" )
+          self:I( self.Controllable:GetName() .. " is out of fuel: " .. Fuel .. " ... Refuelling at Tanker!" )
           self:Refuel()
         else
-          self:E( self.Controllable:GetName() .. " is out of fuel: " .. Fuel .. " ... RTB!" )
+          self:I( self.Controllable:GetName() .. " is out of fuel: " .. Fuel .. " ... RTB!" )
           local OldAIControllable = self.Controllable
           
           local OrbitTask = OldAIControllable:TaskOrbitCircle( math.random( self.PatrolFloorAltitude, self.PatrolCeilingAltitude ), self.PatrolMinSpeed )
-          local TimedOrbitTask = OldAIControllable:TaskControlled( OrbitTask, OldAIControllable:TaskCondition(nil,nil,nil,nil,self.PatrolOutOfFuelOrbitTime,nil ) )
+          local TimedOrbitTask = OldAIControllable:TaskControlled( OrbitTask, OldAIControllable:TaskCondition(nil,nil,nil,nil,self.OutOfFuelOrbitTime,nil ) )
           OldAIControllable:SetTask( TimedOrbitTask, 10 )
     
           self:Fuel()
-          RTB = true
         end
       else
       end
     end
+
+    if self:Is( "Fuel" ) and not self:Is( "Home" ) and not self:is( "Refuelling" ) then
+      RTB = true
+    end
     
     -- TODO: Check GROUP damage function.
     local Damage = self.Controllable:GetLife()
     local InitialLife = self.Controllable:GetLife0()
-    self:F( { Damage = Damage, InitialLife = InitialLife, DamageThreshold = self.PatrolDamageThreshold } )
+    
+    -- If the group is damaged, then RTB.
+    -- Note that a group can consist of more units, so if one unit is damaged of a group, the mission may continue.
+    -- The damaged unit will RTB due to DCS logic, and the others will continue to engage.
     if ( Damage / InitialLife ) < self.PatrolDamageThreshold then
-      self:E( self.Controllable:GetName() .. " is damaged: " .. Damage .. " ... RTB!" )
+      self:I( self.Controllable:GetName() .. " is damaged: " .. Damage .. " ... RTB!" )
       self:Damaged()
       RTB = true
       self:SetStatusOff()
     end
-
+    
     -- Check if planes went RTB and are out of control.
+    -- We only check if planes are out of control, when they are in duty.
     if self.Controllable:HasTask() == false then
       if not self:Is( "Started" ) and 
          not self:Is( "Stopped" ) and
+         not self:Is( "Fuel" ) and 
+         not self:Is( "Damaged" ) and 
          not self:Is( "Home" ) then
-        if self.IdleCount >= 2 then
+        if self.IdleCount >= 10 then
           if Damage ~= InitialLife then
             self:Damaged()
           else  
-            self:E( self.Controllable:GetName() .. " control lost! " )
+            self:I( self.Controllable:GetName() .. " control lost! " )
+            
             self:LostControl()
           end
         else
@@ -504,31 +540,34 @@ function AI_A2A:onafterStatus()
     end
 
     if RTB == true then
-      self:__RTB( 0.5 )
+      self:__RTB( self.TaskDelay )
+    end
+
+    if not self:Is("Home") then
+      self:__Status( 10 )
     end
     
-    self:__Status( 10 )
   end
 end
 
 
 --- @param Wrapper.Group#GROUP AIGroup
-function AI_A2A.RTBRoute( AIGroup, Fsm )
+function AI_AIR.RTBRoute( AIGroup, Fsm )
 
-  AIGroup:F( { "AI_A2A.RTBRoute:", AIGroup:GetName() } )
+  AIGroup:F( { "AI_AIR.RTBRoute:", AIGroup:GetName() } )
   
   if AIGroup:IsAlive() then
-    Fsm:__RTB( 0.5 )
+    Fsm:RTB()
   end
   
 end
 
 --- @param Wrapper.Group#GROUP AIGroup
-function AI_A2A.RTBHold( AIGroup, Fsm )
+function AI_AIR.RTBHold( AIGroup, Fsm )
 
-  AIGroup:F( { "AI_A2A.RTBHold:", AIGroup:GetName() } )
+  AIGroup:F( { "AI_AIR.RTBHold:", AIGroup:GetName() } )
   if AIGroup:IsAlive() then
-    Fsm:__RTB( 0.5 )
+    Fsm:__RTB( Fsm.TaskDelay )
     Fsm:Return()
     local Task = AIGroup:TaskOrbitCircle( 4000, 400 )
     AIGroup:SetTask( Task )
@@ -537,74 +576,92 @@ function AI_A2A.RTBHold( AIGroup, Fsm )
 end
 
 
---- @param #AI_A2A self
+--- @param #AI_AIR self
 -- @param Wrapper.Group#GROUP AIGroup
-function AI_A2A:onafterRTB( AIGroup, From, Event, To )
+function AI_AIR:onafterRTB( AIGroup, From, Event, To )
   self:F( { AIGroup, From, Event, To } )
 
   
   if AIGroup and AIGroup:IsAlive() then
 
-    self:E( "Group " .. AIGroup:GetName() .. " ... RTB! ( " .. self:GetState() .. " )" )
+    self:I( "Group " .. AIGroup:GetName() .. " ... RTB! ( " .. self:GetState() .. " )" )
     
     self:ClearTargetDistance()
-    AIGroup:ClearTasks()
+    --AIGroup:ClearTasks()
 
     local EngageRoute = {}
 
     --- Calculate the target route point.
     
-    local CurrentCoord = AIGroup:GetCoordinate()
+    local FromCoord = AIGroup:GetCoordinate()
     local ToTargetCoord = self.HomeAirbase:GetCoordinate()
-    local ToTargetSpeed = math.random( self.PatrolMinSpeed, self.PatrolMaxSpeed )
-    local ToAirbaseAngle = CurrentCoord:GetAngleDegrees( CurrentCoord:GetDirectionVec3( ToTargetCoord ) )
 
-    local Distance = CurrentCoord:Get2DDistance( ToTargetCoord )
+    if not self.RTBMinSpeed and not self.RTBMaxSpeed then    
+      local RTBSpeedMax = AIGroup:GetSpeedMax()
+      self:SetRTBSpeed( RTBSpeedMax * 0.25, RTBSpeedMax * 0.25 )  
+    end
     
-    local ToAirbaseCoord = CurrentCoord:Translate( 5000, ToAirbaseAngle )
+    local RTBSpeed = math.random( self.RTBMinSpeed, self.RTBMaxSpeed )
+    local ToAirbaseAngle = FromCoord:GetAngleDegrees( FromCoord:GetDirectionVec3( ToTargetCoord ) )
+
+    local Distance = FromCoord:Get2DDistance( ToTargetCoord )
+    
+    local ToAirbaseCoord = FromCoord:Translate( 5000, ToAirbaseAngle )
     if Distance < 5000 then
-      self:E( "RTB and near the airbase!" )
+      self:I( "RTB and near the airbase!" )
       self:Home()
       return
     end
+    
+    if not AIGroup:InAir() == true then
+      self:I( "Not anymore in the air, considered Home." )
+      self:Home()
+      return
+    end
+      
+    
+    --- Create a route point of type air.
+    local FromRTBRoutePoint = FromCoord:WaypointAir( 
+      self.PatrolAltType, 
+      POINT_VEC3.RoutePointType.TurningPoint, 
+      POINT_VEC3.RoutePointAction.TurningPoint, 
+      RTBSpeed, 
+      true 
+    )
+
     --- Create a route point of type air.
     local ToRTBRoutePoint = ToAirbaseCoord:WaypointAir( 
       self.PatrolAltType, 
       POINT_VEC3.RoutePointType.TurningPoint, 
       POINT_VEC3.RoutePointAction.TurningPoint, 
-      ToTargetSpeed, 
+      RTBSpeed, 
       true 
     )
 
-    self:F( { Angle = ToAirbaseAngle, ToTargetSpeed = ToTargetSpeed } )
-    self:T2( { self.MinSpeed, self.MaxSpeed, ToTargetSpeed } )
-    
-    EngageRoute[#EngageRoute+1] = ToRTBRoutePoint
+    EngageRoute[#EngageRoute+1] = FromRTBRoutePoint
     EngageRoute[#EngageRoute+1] = ToRTBRoutePoint
     
+    local Tasks = {}
+    Tasks[#Tasks+1] = AIGroup:TaskFunction( "AI_AIR.RTBRoute", self )
+    
+    EngageRoute[#EngageRoute].task = AIGroup:TaskCombo( Tasks )
+
     AIGroup:OptionROEHoldFire()
     AIGroup:OptionROTEvadeFire()
 
-    --- Now we're going to do something special, we're going to call a function from a waypoint action at the AIControllable...
-    AIGroup:WayPointInitialize( EngageRoute )
-  
-    local Tasks = {}
-    Tasks[#Tasks+1] = AIGroup:TaskFunction( "AI_A2A.RTBRoute", self )
-    EngageRoute[#EngageRoute].task = AIGroup:TaskCombo( Tasks )
-
     --- NOW ROUTE THE GROUP!
-    AIGroup:Route( EngageRoute, 0.5 )
+    AIGroup:Route( EngageRoute, self.TaskDelay )
       
   end
     
 end
 
---- @param #AI_A2A self
+--- @param #AI_AIR self
 -- @param Wrapper.Group#GROUP AIGroup
-function AI_A2A:onafterHome( AIGroup, From, Event, To )
+function AI_AIR:onafterHome( AIGroup, From, Event, To )
   self:F( { AIGroup, From, Event, To } )
 
-  self:E( "Group " .. self.Controllable:GetName() .. " ... Home! ( " .. self:GetState() .. " )" )
+  self:I( "Group " .. self.Controllable:GetName() .. " ... Home! ( " .. self:GetState() .. " )" )
   
   if AIGroup and AIGroup:IsAlive() then
   end
@@ -613,22 +670,22 @@ end
 
 
 
---- @param #AI_A2A self
+--- @param #AI_AIR self
 -- @param Wrapper.Group#GROUP AIGroup
-function AI_A2A:onafterHold( AIGroup, From, Event, To, HoldTime )
+function AI_AIR:onafterHold( AIGroup, From, Event, To, HoldTime )
   self:F( { AIGroup, From, Event, To } )
 
-  self:E( "Group " .. self.Controllable:GetName() .. " ... Holding! ( " .. self:GetState() .. " )" )
+  self:I( "Group " .. self.Controllable:GetName() .. " ... Holding! ( " .. self:GetState() .. " )" )
   
   if AIGroup and AIGroup:IsAlive() then
     local OrbitTask = AIGroup:TaskOrbitCircle( math.random( self.PatrolFloorAltitude, self.PatrolCeilingAltitude ), self.PatrolMinSpeed )
     local TimedOrbitTask = AIGroup:TaskControlled( OrbitTask, AIGroup:TaskCondition( nil, nil, nil, nil, HoldTime , nil ) )
     
-    local RTBTask = AIGroup:TaskFunction( "AI_A2A.RTBHold", self )
+    local RTBTask = AIGroup:TaskFunction( "AI_AIR.RTBHold", self )
     
     local OrbitHoldTask = AIGroup:TaskOrbitCircle( 4000, self.PatrolMinSpeed )
     
-    --AIGroup:SetState( AIGroup, "AI_A2A", self )
+    --AIGroup:SetState( AIGroup, "AI_AIR", self )
     
     AIGroup:SetTask( AIGroup:TaskCombo( { TimedOrbitTask, RTBTask, OrbitHoldTask } ), 1 )
   end
@@ -636,36 +693,47 @@ function AI_A2A:onafterHold( AIGroup, From, Event, To, HoldTime )
 end
 
 --- @param Wrapper.Group#GROUP AIGroup
-function AI_A2A.Resume( AIGroup, Fsm )
+function AI_AIR.Resume( AIGroup, Fsm )
 
-  AIGroup:F( { "AI_A2A.Resume:", AIGroup:GetName() } )
+  AIGroup:I( { "AI_AIR.Resume:", AIGroup:GetName() } )
   if AIGroup:IsAlive() then
-    Fsm:__RTB( 0.5 )
+    Fsm:__RTB( Fsm.TaskDelay )
   end
   
 end
 
---- @param #AI_A2A self
+--- @param #AI_AIR self
 -- @param Wrapper.Group#GROUP AIGroup
-function AI_A2A:onafterRefuel( AIGroup, From, Event, To )
+function AI_AIR:onafterRefuel( AIGroup, From, Event, To )
   self:F( { AIGroup, From, Event, To } )
 
-  self:E( "Group " .. self.Controllable:GetName() .. " ... Refuelling! ( " .. self:GetState() .. " )" )
   
   if AIGroup and AIGroup:IsAlive() then
     local Tanker = GROUP:FindByName( self.TankerName )
+
     if Tanker:IsAlive() and Tanker:IsAirPlane() then
 
+      self:I( "Group " .. self.Controllable:GetName() .. " ... Refuelling! ( " .. self:GetState() .. "), at tanker " .. self.TankerName )
+
       local RefuelRoute = {}
   
       --- Calculate the target route point.
       
-      local CurrentCoord = AIGroup:GetCoordinate()
+      local FromRefuelCoord = AIGroup:GetCoordinate()
       local ToRefuelCoord = Tanker:GetCoordinate()
       local ToRefuelSpeed = math.random( self.PatrolMinSpeed, self.PatrolMaxSpeed )
       
       --- Create a route point of type air.
-      local ToRefuelRoutePoint = ToRefuelCoord:WaypointAir( 
+      local FromRefuelRoutePoint = FromRefuelCoord:WaypointAir( 
+        self.PatrolAltType, 
+        POINT_VEC3.RoutePointType.TurningPoint, 
+        POINT_VEC3.RoutePointAction.TurningPoint, 
+        ToRefuelSpeed, 
+        true 
+      )
+
+      --- Create a route point of type air.
+      local ToRefuelRoutePoint = FromRefuelCoord:WaypointAir( 
         self.PatrolAltType, 
         POINT_VEC3.RoutePointType.TurningPoint, 
         POINT_VEC3.RoutePointAction.TurningPoint, 
@@ -675,8 +743,8 @@ function AI_A2A:onafterRefuel( AIGroup, From, Event, To )
   
       self:F( { ToRefuelSpeed = ToRefuelSpeed } )
       
-      RefuelRoute[#RefuelRoute+1] = ToRefuelRoutePoint
-      RefuelRoute[#RefuelRoute+1] = ToRefuelRoutePoint
+      RefuelRoute[#RefuelRoute+1] = FromRefuelRoutePoint
+      --RefuelRoute[#RefuelRoute+1] = ToRefuelRoutePoint
       
       AIGroup:OptionROEHoldFire()
       AIGroup:OptionROTEvadeFire()
@@ -686,7 +754,7 @@ function AI_A2A:onafterRefuel( AIGroup, From, Event, To )
       Tasks[#Tasks+1] = AIGroup:TaskFunction( self:GetClassName() .. ".Resume", self )
       RefuelRoute[#RefuelRoute].task = AIGroup:TaskCombo( Tasks )
   
-      AIGroup:Route( RefuelRoute, 0.5 )
+      AIGroup:Route( RefuelRoute, self.TaskDelay )
     else
       self:RTB()
     end
@@ -696,38 +764,37 @@ end
     
 
 
---- @param #AI_A2A self
-function AI_A2A:onafterDead()
+--- @param #AI_AIR self
+function AI_AIR:onafterDead()
   self:SetStatusOff()
 end
 
 
---- @param #AI_A2A self
+--- @param #AI_AIR self
 -- @param Core.Event#EVENTDATA EventData
-function AI_A2A:OnCrash( EventData )
+function AI_AIR:OnCrash( EventData )
 
   if self.Controllable:IsAlive() and EventData.IniDCSGroupName == self.Controllable:GetName() then
-    self:E( self.Controllable:GetUnits() )
     if #self.Controllable:GetUnits() == 1 then
-      self:__Crash( 1, EventData )
+      self:__Crash( self.TaskDelay, EventData )
     end
   end
 end
 
---- @param #AI_A2A self
+--- @param #AI_AIR self
 -- @param Core.Event#EVENTDATA EventData
-function AI_A2A:OnEjection( EventData )
+function AI_AIR:OnEjection( EventData )
 
   if self.Controllable:IsAlive() and EventData.IniDCSGroupName == self.Controllable:GetName() then
-    self:__Eject( 1, EventData )
+    self:__Eject( self.TaskDelay, EventData )
   end
 end
 
---- @param #AI_A2A self
+--- @param #AI_AIR self
 -- @param Core.Event#EVENTDATA EventData
-function AI_A2A:OnPilotDead( EventData )
+function AI_AIR:OnPilotDead( EventData )
 
   if self.Controllable:IsAlive() and EventData.IniDCSGroupName == self.Controllable:GetName() then
-    self:__PilotDead( 1, EventData )
+    self:__PilotDead( self.TaskDelay, EventData )
   end
 end

Moose Development/Moose/AI/AI_Air_Engage.lua

@@ -0,0 +1,613 @@
+--- **AI** -- Models the process of air to ground engagement for airplanes and helicopters.
+--
+-- This is a class used in the @{AI_A2G_Dispatcher}.
+-- 
+-- ===
+-- 
+-- ### Author: **FlightControl**
+-- 
+-- ===       
+--
+-- @module AI.AI_Air_Engage
+-- @image AI_Air_To_Ground_Engage.JPG
+
+
+
+--- @type AI_AIR_ENGAGE
+-- @extends AI.AI_AIR#AI_AIR
+
+
+--- Implements the core functions to intercept intruders. Use the Engage trigger to intercept intruders.
+-- 
+-- ![Process](..\Presentations\AI_GCI\Dia3.JPG)
+-- 
+-- The AI_AIR_ENGAGE is assigned a @{Wrapper.Group} and this must be done before the AI_AIR_ENGAGE process can be started using the **Start** event.
+-- 
+-- ![Process](..\Presentations\AI_GCI\Dia4.JPG)
+-- 
+-- The AI will fly towards the random 3D point within the patrol zone, using a random speed within the given altitude and speed limits.
+-- Upon arrival at the 3D point, a new random 3D point will be selected within the patrol zone using the given limits.
+-- 
+-- ![Process](..\Presentations\AI_GCI\Dia5.JPG)
+-- 
+-- This cycle will continue.
+-- 
+-- ![Process](..\Presentations\AI_GCI\Dia6.JPG)
+-- 
+-- During the patrol, the AI will detect enemy targets, which are reported through the **Detected** event.
+--
+-- ![Process](..\Presentations\AI_GCI\Dia9.JPG)
+-- 
+-- When enemies are detected, the AI will automatically engage the enemy.
+-- 
+-- ![Process](..\Presentations\AI_GCI\Dia10.JPG)
+-- 
+-- Until a fuel or damage treshold has been reached by the AI, or when the AI is commanded to RTB.
+-- When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
+-- 
+-- ![Process](..\Presentations\AI_GCI\Dia13.JPG)
+-- 
+-- ## 1. AI_AIR_ENGAGE constructor
+--   
+--   * @{#AI_AIR_ENGAGE.New}(): Creates a new AI_AIR_ENGAGE object.
+--
+-- ## 3. Set the Range of Engagement
+-- 
+-- ![Range](..\Presentations\AI_GCI\Dia11.JPG)
+-- 
+-- An optional range can be set in meters, 
+-- that will define when the AI will engage with the detected airborne enemy targets.
+-- The range can be beyond or smaller than the range of the Patrol Zone.
+-- The range is applied at the position of the AI.
+-- Use the method @{AI.AI_GCI#AI_AIR_ENGAGE.SetEngageRange}() to define that range.
+--
+-- ## 4. Set the Zone of Engagement
+-- 
+-- ![Zone](..\Presentations\AI_GCI\Dia12.JPG)
+-- 
+-- An optional @{Zone} can be set, 
+-- that will define when the AI will engage with the detected airborne enemy targets.
+-- Use the method @{AI.AI_Cap#AI_AIR_ENGAGE.SetEngageZone}() to define that Zone.
+--  
+-- ===
+-- 
+-- @field #AI_AIR_ENGAGE
+AI_AIR_ENGAGE = {
+  ClassName = "AI_AIR_ENGAGE",
+}
+
+
+
+--- Creates a new AI_AIR_ENGAGE object
+-- @param #AI_AIR_ENGAGE self
+-- @param Wrapper.Group#GROUP AIGroup
+-- @param DCS#Speed EngageMinSpeed (optional, default = 50% of max speed) The minimum speed of the @{Wrapper.Group} in km/h when engaging a target.
+-- @param DCS#Speed  EngageMaxSpeed (optional, default = 75% of max speed) The maximum speed of the @{Wrapper.Group} in km/h when engaging a target.
+-- @param DCS#Altitude EngageFloorAltitude (optional, default = 1000m ) The lowest altitude in meters where to execute the engagement.
+-- @param DCS#Altitude EngageCeilingAltitude (optional, default = 1500m ) The highest altitude in meters where to execute the engagement.
+-- @param DCS#AltitudeType EngageAltType The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to "RADIO".
+-- @return #AI_AIR_ENGAGE
+function AI_AIR_ENGAGE:New( AI_Air, AIGroup, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, EngageAltType )
+
+  -- Inherits from BASE
+  local self = BASE:Inherit( self, AI_Air ) -- #AI_AIR_ENGAGE
+
+  self.Accomplished = false
+  self.Engaging = false
+  
+  local SpeedMax = AIGroup:GetSpeedMax()
+  
+  self.EngageMinSpeed = EngageMinSpeed or SpeedMax * 0.5
+  self.EngageMaxSpeed = EngageMaxSpeed or SpeedMax * 0.75
+  self.EngageFloorAltitude = EngageFloorAltitude or 1000
+  self.EngageCeilingAltitude = EngageCeilingAltitude or 1500
+  self.EngageAltType = EngageAltType or "RADIO"
+  
+  self:AddTransition( { "Started", "Engaging", "Returning", "Airborne", "Patrolling" }, "EngageRoute", "Engaging" ) -- FSM_CONTROLLABLE Transition for type #AI_AIR_ENGAGE.
+
+  --- OnBefore Transition Handler for Event EngageRoute.
+  -- @function [parent=#AI_AIR_ENGAGE] OnBeforeEngageRoute
+  -- @param #AI_AIR_ENGAGE self
+  -- @param Wrapper.Group#GROUP AIGroup The Group Object managed by the FSM.
+  -- @param #string From The From State string.
+  -- @param #string Event The Event string.
+  -- @param #string To The To State string.
+  -- @return #boolean Return false to cancel Transition.
+  
+  --- OnAfter Transition Handler for Event EngageRoute.
+  -- @function [parent=#AI_AIR_ENGAGE] OnAfterEngageRoute
+  -- @param #AI_AIR_ENGAGE self
+  -- @param Wrapper.Group#GROUP AIGroup The Group Object managed by the FSM.
+  -- @param #string From The From State string.
+  -- @param #string Event The Event string.
+  -- @param #string To The To State string.
+  	
+  --- Synchronous Event Trigger for Event EngageRoute.
+  -- @function [parent=#AI_AIR_ENGAGE] EngageRoute
+  -- @param #AI_AIR_ENGAGE self
+  
+  --- Asynchronous Event Trigger for Event EngageRoute.
+  -- @function [parent=#AI_AIR_ENGAGE] __EngageRoute
+  -- @param #AI_AIR_ENGAGE self
+  -- @param #number Delay The delay in seconds.
+
+--- OnLeave Transition Handler for State Engaging.
+-- @function [parent=#AI_AIR_ENGAGE] OnLeaveEngaging
+-- @param #AI_AIR_ENGAGE self
+-- @param Wrapper.Group#GROUP AIGroup The Group Object managed by the FSM.
+-- @param #string From The From State string.
+-- @param #string Event The Event string.
+-- @param #string To The To State string.
+-- @return #boolean Return false to cancel Transition.
+
+--- OnEnter Transition Handler for State Engaging.
+-- @function [parent=#AI_AIR_ENGAGE] OnEnterEngaging
+-- @param #AI_AIR_ENGAGE self
+-- @param Wrapper.Group#GROUP AIGroup The Group Object managed by the FSM.
+-- @param #string From The From State string.
+-- @param #string Event The Event string.
+-- @param #string To The To State string.
+
+  self:AddTransition( { "Started", "Engaging", "Returning", "Airborne", "Patrolling" }, "Engage", "Engaging" ) -- FSM_CONTROLLABLE Transition for type #AI_AIR_ENGAGE.
+
+  --- OnBefore Transition Handler for Event Engage.
+  -- @function [parent=#AI_AIR_ENGAGE] OnBeforeEngage
+  -- @param #AI_AIR_ENGAGE self
+  -- @param Wrapper.Group#GROUP AIGroup The Group Object managed by the FSM.
+  -- @param #string From The From State string.
+  -- @param #string Event The Event string.
+  -- @param #string To The To State string.
+  -- @return #boolean Return false to cancel Transition.
+  
+  --- OnAfter Transition Handler for Event Engage.
+  -- @function [parent=#AI_AIR_ENGAGE] OnAfterEngage
+  -- @param #AI_AIR_ENGAGE self
+  -- @param Wrapper.Group#GROUP AIGroup The Group Object managed by the FSM.
+  -- @param #string From The From State string.
+  -- @param #string Event The Event string.
+  -- @param #string To The To State string.
+    
+  --- Synchronous Event Trigger for Event Engage.
+  -- @function [parent=#AI_AIR_ENGAGE] Engage
+  -- @param #AI_AIR_ENGAGE self
+  
+  --- Asynchronous Event Trigger for Event Engage.
+  -- @function [parent=#AI_AIR_ENGAGE] __Engage
+  -- @param #AI_AIR_ENGAGE self
+  -- @param #number Delay The delay in seconds.
+
+--- OnLeave Transition Handler for State Engaging.
+-- @function [parent=#AI_AIR_ENGAGE] OnLeaveEngaging
+-- @param #AI_AIR_ENGAGE self
+-- @param Wrapper.Group#GROUP AIGroup The Group Object managed by the FSM.
+-- @param #string From The From State string.
+-- @param #string Event The Event string.
+-- @param #string To The To State string.
+-- @return #boolean Return false to cancel Transition.
+
+--- OnEnter Transition Handler for State Engaging.
+-- @function [parent=#AI_AIR_ENGAGE] OnEnterEngaging
+-- @param #AI_AIR_ENGAGE self
+-- @param Wrapper.Group#GROUP AIGroup The Group Object managed by the FSM.
+-- @param #string From The From State string.
+-- @param #string Event The Event string.
+-- @param #string To The To State string.
+
+  self:AddTransition( "Engaging", "Fired", "Engaging" ) -- FSM_CONTROLLABLE Transition for type #AI_AIR_ENGAGE.
+  
+  --- OnBefore Transition Handler for Event Fired.
+  -- @function [parent=#AI_AIR_ENGAGE] OnBeforeFired
+  -- @param #AI_AIR_ENGAGE self
+  -- @param Wrapper.Group#GROUP AIGroup The Group Object managed by the FSM.
+  -- @param #string From The From State string.
+  -- @param #string Event The Event string.
+  -- @param #string To The To State string.
+  -- @return #boolean Return false to cancel Transition.
+  
+  --- OnAfter Transition Handler for Event Fired.
+  -- @function [parent=#AI_AIR_ENGAGE] OnAfterFired
+  -- @param #AI_AIR_ENGAGE self
+  -- @param Wrapper.Group#GROUP AIGroup The Group Object managed by the FSM.
+  -- @param #string From The From State string.
+  -- @param #string Event The Event string.
+  -- @param #string To The To State string.
+  	
+  --- Synchronous Event Trigger for Event Fired.
+  -- @function [parent=#AI_AIR_ENGAGE] Fired
+  -- @param #AI_AIR_ENGAGE self
+  
+  --- Asynchronous Event Trigger for Event Fired.
+  -- @function [parent=#AI_AIR_ENGAGE] __Fired
+  -- @param #AI_AIR_ENGAGE self
+  -- @param #number Delay The delay in seconds.
+
+  self:AddTransition( "*", "Destroy", "*" ) -- FSM_CONTROLLABLE Transition for type #AI_AIR_ENGAGE.
+
+  --- OnBefore Transition Handler for Event Destroy.
+  -- @function [parent=#AI_AIR_ENGAGE] OnBeforeDestroy
+  -- @param #AI_AIR_ENGAGE self
+  -- @param Wrapper.Group#GROUP AIGroup The Group Object managed by the FSM.
+  -- @param #string From The From State string.
+  -- @param #string Event The Event string.
+  -- @param #string To The To State string.
+  -- @return #boolean Return false to cancel Transition.
+  
+  --- OnAfter Transition Handler for Event Destroy.
+  -- @function [parent=#AI_AIR_ENGAGE] OnAfterDestroy
+  -- @param #AI_AIR_ENGAGE self
+  -- @param Wrapper.Group#GROUP AIGroup The Group Object managed by the FSM.
+  -- @param #string From The From State string.
+  -- @param #string Event The Event string.
+  -- @param #string To The To State string.
+  	
+  --- Synchronous Event Trigger for Event Destroy.
+  -- @function [parent=#AI_AIR_ENGAGE] Destroy
+  -- @param #AI_AIR_ENGAGE self
+  
+  --- Asynchronous Event Trigger for Event Destroy.
+  -- @function [parent=#AI_AIR_ENGAGE] __Destroy
+  -- @param #AI_AIR_ENGAGE self
+  -- @param #number Delay The delay in seconds.
+
+
+  self:AddTransition( "Engaging", "Abort", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_AIR_ENGAGE.
+
+  --- OnBefore Transition Handler for Event Abort.
+  -- @function [parent=#AI_AIR_ENGAGE] OnBeforeAbort
+  -- @param #AI_AIR_ENGAGE self
+  -- @param Wrapper.Group#GROUP AIGroup The Group Object managed by the FSM.
+  -- @param #string From The From State string.
+  -- @param #string Event The Event string.
+  -- @param #string To The To State string.
+  -- @return #boolean Return false to cancel Transition.
+  
+  --- OnAfter Transition Handler for Event Abort.
+  -- @function [parent=#AI_AIR_ENGAGE] OnAfterAbort
+  -- @param #AI_AIR_ENGAGE self
+  -- @param Wrapper.Group#GROUP AIGroup The Group Object managed by the FSM.
+  -- @param #string From The From State string.
+  -- @param #string Event The Event string.
+  -- @param #string To The To State string.
+  	
+  --- Synchronous Event Trigger for Event Abort.
+  -- @function [parent=#AI_AIR_ENGAGE] Abort
+  -- @param #AI_AIR_ENGAGE self
+  
+  --- Asynchronous Event Trigger for Event Abort.
+  -- @function [parent=#AI_AIR_ENGAGE] __Abort
+  -- @param #AI_AIR_ENGAGE self
+  -- @param #number Delay The delay in seconds.
+
+  self:AddTransition( "Engaging", "Accomplish", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_AIR_ENGAGE.
+
+  --- OnBefore Transition Handler for Event Accomplish.
+  -- @function [parent=#AI_AIR_ENGAGE] OnBeforeAccomplish
+  -- @param #AI_AIR_ENGAGE self
+  -- @param Wrapper.Group#GROUP AIGroup The Group Object managed by the FSM.
+  -- @param #string From The From State string.
+  -- @param #string Event The Event string.
+  -- @param #string To The To State string.
+  -- @return #boolean Return false to cancel Transition.
+  
+  --- OnAfter Transition Handler for Event Accomplish.
+  -- @function [parent=#AI_AIR_ENGAGE] OnAfterAccomplish
+  -- @param #AI_AIR_ENGAGE self
+  -- @param Wrapper.Group#GROUP AIGroup The Group Object managed by the FSM.
+  -- @param #string From The From State string.
+  -- @param #string Event The Event string.
+  -- @param #string To The To State string.
+  	
+  --- Synchronous Event Trigger for Event Accomplish.
+  -- @function [parent=#AI_AIR_ENGAGE] Accomplish
+  -- @param #AI_AIR_ENGAGE self
+  
+  --- Asynchronous Event Trigger for Event Accomplish.
+  -- @function [parent=#AI_AIR_ENGAGE] __Accomplish
+  -- @param #AI_AIR_ENGAGE self
+  -- @param #number Delay The delay in seconds.  
+
+  self:AddTransition( { "Patrolling", "Engaging" }, "Refuel", "Refuelling" ) 
+
+  return self
+end
+
+--- onafter event handler for Start event.
+-- @param #AI_AIR_ENGAGE self
+-- @param Wrapper.Group#GROUP AIGroup The AI group managed by the FSM.
+-- @param #string From The From State string.
+-- @param #string Event The Event string.
+-- @param #string To The To State string.
+function AI_AIR_ENGAGE:onafterStart( AIGroup, From, Event, To )
+
+  self:GetParent( self, AI_AIR_ENGAGE ).onafterStart( self, AIGroup, From, Event, To )
+
+  AIGroup:HandleEvent( EVENTS.Takeoff, nil, self )
+
+end
+
+
+
+--- onafter event handler for Engage event.
+-- @param #AI_AIR_ENGAGE self
+-- @param Wrapper.Group#GROUP AIGroup The AI Group managed by the FSM.
+-- @param #string From The From State string.
+-- @param #string Event The Event string.
+-- @param #string To The To State string.
+function AI_AIR_ENGAGE:onafterEngage( AIGroup, From, Event, To )
+
+  self:HandleEvent( EVENTS.Dead )
+
+end
+
+-- todo: need to fix this global function
+
+
+--- onbefore event handler for Engage event.
+-- @param #AI_AIR_ENGAGE self
+-- @param Wrapper.Group#GROUP AIGroup The group Object managed by the FSM.
+-- @param #string From The From State string.
+-- @param #string Event The Event string.
+-- @param #string To The To State string.
+function AI_AIR_ENGAGE:onbeforeEngage( AIGroup, From, Event, To )
+  
+  if self.Accomplished == true then
+    return false
+  end
+end
+
+--- onafter event handler for Abort event.
+-- @param #AI_AIR_ENGAGE self
+-- @param Wrapper.Group#GROUP AIGroup The AI Group managed by the FSM.
+-- @param #string From The From State string.
+-- @param #string Event The Event string.
+-- @param #string To The To State string.
+function AI_AIR_ENGAGE:onafterAbort( AIGroup, From, Event, To )
+  AIGroup:ClearTasks()
+  self:Return()
+end
+
+
+--- @param #AI_AIR_ENGAGE self
+-- @param Wrapper.Group#GROUP AIGroup The Group Object managed by the FSM.
+-- @param #string From The From State string.
+-- @param #string Event The Event string.
+-- @param #string To The To State string.
+function AI_AIR_ENGAGE:onafterAccomplish( AIGroup, From, Event, To )
+  self.Accomplished = true
+  self:SetDetectionOff()
+end
+
+--- @param #AI_AIR_ENGAGE self
+-- @param Wrapper.Group#GROUP AIGroup The Group Object managed by the FSM.
+-- @param #string From The From State string.
+-- @param #string Event The Event string.
+-- @param #string To The To State string.
+-- @param Core.Event#EVENTDATA EventData
+function AI_AIR_ENGAGE:onafterDestroy( AIGroup, From, Event, To, EventData )
+
+  if EventData.IniUnit then
+    self.AttackUnits[EventData.IniUnit] = nil
+  end
+end
+
+--- @param #AI_AIR_ENGAGE self
+-- @param Core.Event#EVENTDATA EventData
+function AI_AIR_ENGAGE:OnEventDead( EventData )
+  self:F( { "EventDead", EventData } )
+
+  if EventData.IniDCSUnit then
+    if self.AttackUnits and self.AttackUnits[EventData.IniUnit] then
+      self:__Destroy( self.TaskDelay, EventData )
+    end
+  end  
+end
+
+
+--- @param Wrapper.Group#GROUP AIControllable
+function AI_AIR_ENGAGE.___EngageRoute( AIGroup, Fsm, AttackSetUnit )
+
+  Fsm:I( { "AI_AIR_ENGAGE.___EngageRoute:", AIGroup:GetName() } )
+  
+  if AIGroup:IsAlive() then
+    Fsm:__EngageRoute( Fsm.TaskDelay, AttackSetUnit )
+  
+    --local Task = AIGroup:TaskOrbitCircle( 4000, 400 )
+    --AIGroup:SetTask( Task )
+  end
+end
+
+
+--- @param #AI_AIR_ENGAGE self
+-- @param Wrapper.Group#GROUP DefenderGroup The GroupGroup managed by the FSM.
+-- @param #string From The From State string.
+-- @param #string Event The Event string.
+-- @param #string To The To State string.
+function AI_AIR_ENGAGE:onafterEngageRoute( DefenderGroup, From, Event, To, AttackSetUnit )
+
+  self:I( { DefenderGroup, From, Event, To, AttackSetUnit } )
+  
+  local DefenderGroupName = DefenderGroup:GetName()
+
+  self.AttackSetUnit = AttackSetUnit -- Kept in memory in case of resume from refuel in air!
+
+  local AttackCount = AttackSetUnit:Count()
+  
+  if AttackCount > 0 then
+
+    if DefenderGroup:IsAlive() then
+
+      local EngageAltitude = math.random( self.EngageFloorAltitude, self.EngageCeilingAltitude )
+      local EngageSpeed = math.random( self.EngageMinSpeed, self.EngageMaxSpeed )
+
+      -- Determine the distance to the target.
+      -- If it is less than 10km, then attack without a route.
+      -- Otherwise perform a route attack.
+
+      local DefenderCoord = DefenderGroup:GetPointVec3()
+      DefenderCoord:SetY( EngageAltitude ) -- Ground targets don't have an altitude.
+
+      local TargetCoord = AttackSetUnit:GetFirst():GetPointVec3()
+      TargetCoord:SetY( EngageAltitude ) -- Ground targets don't have an altitude.
+      
+      local TargetDistance = DefenderCoord:Get2DDistance( TargetCoord )
+      local EngageDistance = ( DefenderGroup:IsHelicopter() and 5000 ) or ( DefenderGroup:IsAirPlane() and 10000 ) 
+      
+      if TargetDistance <= EngageDistance * 3 then
+
+        self:__Engage( 0.1, AttackSetUnit )
+
+      else
+
+        local EngageRoute = {}
+        local AttackTasks = {}
+        
+        --- Calculate the target route point.
+        
+        local FromWP = DefenderCoord:WaypointAir( 
+          self.PatrolAltType or "RADIO", 
+          POINT_VEC3.RoutePointType.TurningPoint, 
+          POINT_VEC3.RoutePointAction.TurningPoint, 
+          EngageSpeed, 
+          true 
+        )
+        
+        EngageRoute[#EngageRoute+1] = FromWP
+  
+        self:SetTargetDistance( TargetCoord ) -- For RTB status check
+        
+        local FromEngageAngle = DefenderCoord:GetAngleDegrees( DefenderCoord:GetDirectionVec3( TargetCoord ) )
+        local ToWP = DefenderCoord:Translate( EngageDistance, FromEngageAngle, true ):WaypointAir( 
+          self.PatrolAltType or "RADIO", 
+          POINT_VEC3.RoutePointType.TurningPoint, 
+          POINT_VEC3.RoutePointAction.TurningPoint, 
+          EngageSpeed, 
+          true 
+        )
+  
+        EngageRoute[#EngageRoute+1] = ToWP
+
+        AttackTasks[#AttackTasks+1] = DefenderGroup:TaskFunction( "AI_AIR_ENGAGE.___EngageRoute", self, AttackSetUnit )
+        EngageRoute[#EngageRoute].task = DefenderGroup:TaskCombo( AttackTasks )
+        
+        DefenderGroup:OptionROEReturnFire()
+        DefenderGroup:OptionROTEvadeFire()
+        
+        DefenderGroup:Route( EngageRoute, self.TaskDelay )
+      end
+
+    end
+  else
+    self:I( DefenderGroupName .. ": No targets found -> Going RTB")
+    self:Return()
+  end
+end
+
+
+--- @param Wrapper.Group#GROUP AIControllable
+function AI_AIR_ENGAGE.___Engage( AIGroup, Fsm, AttackSetUnit )
+
+  Fsm:I( { "AI_AIR_ENGAGE.___Engage:", AIGroup:GetName() } )
+  
+  if AIGroup:IsAlive() then
+    Fsm:__Engage( Fsm.TaskDelay, AttackSetUnit )
+  end
+end
+
+
+--- @param #AI_AIR_ENGAGE self
+-- @param Wrapper.Group#GROUP DefenderGroup The GroupGroup managed by the FSM.
+-- @param #string From The From State string.
+-- @param #string Event The Event string.
+-- @param #string To The To State string.
+function AI_AIR_ENGAGE:onafterEngage( DefenderGroup, From, Event, To, AttackSetUnit )
+
+  self:F( { DefenderGroup, From, Event, To, AttackSetUnit} )
+  
+  local DefenderGroupName = DefenderGroup:GetName()
+
+  self.AttackSetUnit = AttackSetUnit -- Kept in memory in case of resume from refuel in air!
+
+  local AttackCount = AttackSetUnit:Count()
+  self:I({AttackCount = AttackCount})
+  
+  if AttackCount > 0 then
+
+    if DefenderGroup:IsAlive() then
+
+      local EngageAltitude = math.random( self.EngageFloorAltitude or 500, self.EngageCeilingAltitude or 1000 )
+      local EngageSpeed = math.random( self.EngageMinSpeed, self.EngageMaxSpeed )
+
+      local DefenderCoord = DefenderGroup:GetPointVec3()
+      DefenderCoord:SetY( EngageAltitude ) -- Ground targets don't have an altitude.
+
+      local TargetCoord = AttackSetUnit:GetFirst():GetPointVec3()
+      TargetCoord:SetY( EngageAltitude ) -- Ground targets don't have an altitude.
+      
+      local TargetDistance = DefenderCoord:Get2DDistance( TargetCoord )
+      local EngageDistance = ( DefenderGroup:IsHelicopter() and 5000 ) or ( DefenderGroup:IsAirPlane() and 10000 )
+      
+      local EngageRoute = {}
+      local AttackTasks = {}
+      
+      local FromWP = DefenderCoord:WaypointAir( 
+        self.EngageAltType or "RADIO", 
+        POINT_VEC3.RoutePointType.TurningPoint, 
+        POINT_VEC3.RoutePointAction.TurningPoint, 
+        EngageSpeed, 
+        true 
+      )
+      EngageRoute[#EngageRoute+1] = FromWP
+
+      self:SetTargetDistance( TargetCoord ) -- For RTB status check
+
+      local FromEngageAngle = DefenderCoord:GetAngleDegrees( DefenderCoord:GetDirectionVec3( TargetCoord ) )
+      local ToWP = DefenderCoord:Translate( EngageDistance, FromEngageAngle, true ):WaypointAir( 
+        self.EngageAltType or "RADIO", 
+        POINT_VEC3.RoutePointType.TurningPoint, 
+        POINT_VEC3.RoutePointAction.TurningPoint, 
+        EngageSpeed, 
+        true 
+      )
+      EngageRoute[#EngageRoute+1] = ToWP
+      
+      if TargetDistance <= EngageDistance * 3 then
+      
+        local AttackUnitTasks = self:CreateAttackUnitTasks( AttackSetUnit, DefenderGroup, EngageAltitude ) -- Polymorphic
+        
+        if #AttackUnitTasks == 0 then
+          self:I( DefenderGroupName .. ": No valid targets found -> Going RTB")
+          self:Return()
+          return
+        else
+          self:I( DefenderGroupName .. ": Engaging targets " )
+          DefenderGroup:OptionROEOpenFire()
+          DefenderGroup:OptionROTEvadeFire()
+          DefenderGroup:OptionKeepWeaponsOnThreat()
+  
+          AttackTasks[#AttackTasks+1] = DefenderGroup:TaskCombo( AttackUnitTasks )
+        end
+      end
+
+      AttackTasks[#AttackTasks+1] = DefenderGroup:TaskFunction( "AI_AIR_ENGAGE.___Engage", self, AttackSetUnit )
+      EngageRoute[#EngageRoute].task = DefenderGroup:TaskCombo( AttackTasks )
+      
+      DefenderGroup:Route( EngageRoute, self.TaskDelay )
+      
+    end
+  else
+    self:I( DefenderGroupName .. ": No targets found -> returning.")
+    self:Return()
+    return
+  end
+end
+
+--- @param Wrapper.Group#GROUP AIEngage
+function AI_AIR_ENGAGE.Resume( AIEngage, Fsm )
+
+  AIEngage:F( { "Resume:", AIEngage:GetName() } )
+  if AIEngage:IsAlive() then
+    Fsm:__Reset( Fsm.TaskDelay )
+    Fsm:__EngageRoute( Fsm.TaskDelay, Fsm.AttackSetUnit )
+  end
+  
+end

Moose Development/Moose/AI/AI_Air_Patrol.lua

@@ -0,0 +1,409 @@
+--- **AI** -- Models the process of A2G patrolling and engaging ground targets for airplanes and helicopters.
+--
+-- ===
+-- 
+-- ### Author: **FlightControl**
+-- 
+-- ===       
+--
+-- @module AI.AI_Air_Patrol
+-- @image AI_Air_To_Ground_Patrol.JPG
+
+--- @type AI_AIR_PATROL
+-- @extends AI.AI_Air#AI_AIR
+
+
+--- The AI_AIR_PATROL class implements the core functions to patrol a @{Zone} by an AI @{Wrapper.Group} or @{Wrapper.Group} 
+-- and automatically engage any airborne enemies that are within a certain range or within a certain zone.
+-- 
+-- ![Process](..\Presentations\AI_CAP\Dia3.JPG)
+-- 
+-- The AI_AIR_PATROL is assigned a @{Wrapper.Group} and this must be done before the AI_AIR_PATROL process can be started using the **Start** event.
+-- 
+-- ![Process](..\Presentations\AI_CAP\Dia4.JPG)
+-- 
+-- The AI will fly towards the random 3D point within the patrol zone, using a random speed within the given altitude and speed limits.
+-- Upon arrival at the 3D point, a new random 3D point will be selected within the patrol zone using the given limits.
+-- 
+-- ![Process](..\Presentations\AI_CAP\Dia5.JPG)
+-- 
+-- This cycle will continue.
+-- 
+-- ![Process](..\Presentations\AI_CAP\Dia6.JPG)
+-- 
+-- During the patrol, the AI will detect enemy targets, which are reported through the **Detected** event.
+--
+-- ![Process](..\Presentations\AI_CAP\Dia9.JPG)
+-- 
+-- When enemies are detected, the AI will automatically engage the enemy.
+-- 
+-- ![Process](..\Presentations\AI_CAP\Dia10.JPG)
+-- 
+-- Until a fuel or damage treshold has been reached by the AI, or when the AI is commanded to RTB.
+-- When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
+-- 
+-- ![Process](..\Presentations\AI_CAP\Dia13.JPG)
+-- 
+-- ## 1. AI_AIR_PATROL constructor
+--   
+--   * @{#AI_AIR_PATROL.New}(): Creates a new AI_AIR_PATROL object.
+-- 
+-- ## 2. AI_AIR_PATROL is a FSM
+-- 
+-- ![Process](..\Presentations\AI_CAP\Dia2.JPG)
+-- 
+-- ### 2.1 AI_AIR_PATROL States
+-- 
+--   * **None** ( Group ): The process is not started yet.
+--   * **Patrolling** ( Group ): The AI is patrolling the Patrol Zone.
+--   * **Engaging** ( Group ): The AI is engaging the bogeys.
+--   * **Returning** ( Group ): The AI is returning to Base..
+-- 
+-- ### 2.2 AI_AIR_PATROL Events
+-- 
+--   * **@{AI.AI_Patrol#AI_PATROL_ZONE.Start}**: Start the process.
+--   * **@{AI.AI_Patrol#AI_PATROL_ZONE.PatrolRoute}**: Route the AI to a new random 3D point within the Patrol Zone.
+--   * **@{#AI_AIR_PATROL.Engage}**: Let the AI engage the bogeys.
+--   * **@{#AI_AIR_PATROL.Abort}**: Aborts the engagement and return patrolling in the patrol zone.
+--   * **@{AI.AI_Patrol#AI_PATROL_ZONE.RTB}**: Route the AI to the home base.
+--   * **@{AI.AI_Patrol#AI_PATROL_ZONE.Detect}**: The AI is detecting targets.
+--   * **@{AI.AI_Patrol#AI_PATROL_ZONE.Detected}**: The AI has detected new targets.
+--   * **@{#AI_AIR_PATROL.Destroy}**: The AI has destroyed a bogey @{Wrapper.Unit}.
+--   * **@{#AI_AIR_PATROL.Destroyed}**: The AI has destroyed all bogeys @{Wrapper.Unit}s assigned in the CAS task.
+--   * **Status** ( Group ): The AI is checking status (fuel and damage). When the tresholds have been reached, the AI will RTB.
+--
+-- ## 3. Set the Range of Engagement
+-- 
+-- ![Range](..\Presentations\AI_CAP\Dia11.JPG)
+-- 
+-- An optional range can be set in meters, 
+-- that will define when the AI will engage with the detected airborne enemy targets.
+-- The range can be beyond or smaller than the range of the Patrol Zone.
+-- The range is applied at the position of the AI.
+-- Use the method @{AI.AI_CAP#AI_AIR_PATROL.SetEngageRange}() to define that range.
+--
+-- ## 4. Set the Zone of Engagement
+-- 
+-- ![Zone](..\Presentations\AI_CAP\Dia12.JPG)
+-- 
+-- An optional @{Zone} can be set, 
+-- that will define when the AI will engage with the detected airborne enemy targets.
+-- Use the method @{AI.AI_Cap#AI_AIR_PATROL.SetEngageZone}() to define that Zone.
+--  
+-- ===
+-- 
+-- @field #AI_AIR_PATROL
+AI_AIR_PATROL = {
+  ClassName = "AI_AIR_PATROL",
+}
+
+--- Creates a new AI_AIR_PATROL object
+-- @param #AI_AIR_PATROL self
+-- @param Wrapper.Group#GROUP AIGroup
+-- @param Core.Zone#ZONE_BASE PatrolZone The @{Zone} where the patrol needs to be executed.
+-- @param DCS#Altitude PatrolFloorAltitude (optional, default = 1000m ) The lowest altitude in meters where to execute the patrol.
+-- @param DCS#Altitude PatrolCeilingAltitude (optional, default = 1500m ) The highest altitude in meters where to execute the patrol.
+-- @param DCS#Speed  PatrolMinSpeed (optional, default = 50% of max speed) The minimum speed of the @{Wrapper.Group} in km/h.
+-- @param DCS#Speed  PatrolMaxSpeed (optional, default = 75% of max speed) The maximum speed of the @{Wrapper.Group} in km/h.
+-- @param DCS#AltitudeType PatrolAltType The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to RADIO.
+-- @return #AI_AIR_PATROL
+function AI_AIR_PATROL:New( AI_Air, AIGroup, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType )
+
+  -- Inherits from BASE
+  local self = BASE:Inherit( self, AI_Air ) -- #AI_AIR_PATROL
+
+  local SpeedMax = AIGroup:GetSpeedMax()
+  
+  self.PatrolZone = PatrolZone
+  
+  self.PatrolFloorAltitude = PatrolFloorAltitude or 1000
+  self.PatrolCeilingAltitude = PatrolCeilingAltitude or 1500
+  self.PatrolMinSpeed = PatrolMinSpeed or SpeedMax * 0.5
+  self.PatrolMaxSpeed = PatrolMaxSpeed or SpeedMax * 0.75
+  
+  -- defafult PatrolAltType to "RADIO" if not specified
+  self.PatrolAltType = PatrolAltType or "RADIO"
+  
+  self:AddTransition( { "Started", "Airborne", "Refuelling" }, "Patrol", "Patrolling" )
+
+  --- OnBefore Transition Handler for Event Patrol.
+  -- @function [parent=#AI_AIR_PATROL] OnBeforePatrol
+  -- @param #AI_AIR_PATROL self
+  -- @param Wrapper.Group#GROUP AIPatrol The Group Object managed by the FSM.
+  -- @param #string From The From State string.
+  -- @param #string Event The Event string.
+  -- @param #string To The To State string.
+  -- @return #boolean Return false to cancel Transition.
+  
+  --- OnAfter Transition Handler for Event Patrol.
+  -- @function [parent=#AI_AIR_PATROL] OnAfterPatrol
+  -- @param #AI_AIR_PATROL self
+  -- @param Wrapper.Group#GROUP AIPatrol The Group Object managed by the FSM.
+  -- @param #string From The From State string.
+  -- @param #string Event The Event string.
+  -- @param #string To The To State string.
+    
+  --- Synchronous Event Trigger for Event Patrol.
+  -- @function [parent=#AI_AIR_PATROL] Patrol
+  -- @param #AI_AIR_PATROL self
+  
+  --- Asynchronous Event Trigger for Event Patrol.
+  -- @function [parent=#AI_AIR_PATROL] __Patrol
+  -- @param #AI_AIR_PATROL self
+  -- @param #number Delay The delay in seconds.
+  
+  --- OnLeave Transition Handler for State Patrolling.
+  -- @function [parent=#AI_AIR_PATROL] OnLeavePatrolling
+  -- @param #AI_AIR_PATROL self
+  -- @param Wrapper.Group#GROUP AIPatrol The Group Object managed by the FSM.
+  -- @param #string From The From State string.
+  -- @param #string Event The Event string.
+  -- @param #string To The To State string.
+  -- @return #boolean Return false to cancel Transition.
+  
+  --- OnEnter Transition Handler for State Patrolling.
+  -- @function [parent=#AI_AIR_PATROL] OnEnterPatrolling
+  -- @param #AI_AIR_PATROL self
+  -- @param Wrapper.Group#GROUP AIPatrol The Group Object managed by the FSM.
+  -- @param #string From The From State string.
+  -- @param #string Event The Event string.
+  -- @param #string To The To State string.
+  
+    self:AddTransition( "Patrolling", "PatrolRoute", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_AIR_PATROL.
+  
+  --- OnBefore Transition Handler for Event PatrolRoute.
+  -- @function [parent=#AI_AIR_PATROL] OnBeforePatrolRoute
+  -- @param #AI_AIR_PATROL self
+  -- @param Wrapper.Group#GROUP AIPatrol The Group Object managed by the FSM.
+  -- @param #string From The From State string.
+  -- @param #string Event The Event string.
+  -- @param #string To The To State string.
+  -- @return #boolean Return false to cancel Transition.
+  
+  --- OnAfter Transition Handler for Event PatrolRoute.
+  -- @function [parent=#AI_AIR_PATROL] OnAfterPatrolRoute
+  -- @param #AI_AIR_PATROL self
+  -- @param Wrapper.Group#GROUP AIPatrol The Group Object managed by the FSM.
+  -- @param #string From The From State string.
+  -- @param #string Event The Event string.
+  -- @param #string To The To State string.
+    
+  --- Synchronous Event Trigger for Event PatrolRoute.
+  -- @function [parent=#AI_AIR_PATROL] PatrolRoute
+  -- @param #AI_AIR_PATROL self
+  
+  --- Asynchronous Event Trigger for Event PatrolRoute.
+  -- @function [parent=#AI_AIR_PATROL] __PatrolRoute
+  -- @param #AI_AIR_PATROL self
+  -- @param #number Delay The delay in seconds.
+
+
+  self:AddTransition( "*", "Reset", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_AIR_PATROL.
+
+  return self
+end
+
+
+--- Set the Engage Range when the AI will engage with airborne enemies. 
+-- @param #AI_AIR_PATROL self
+-- @param #number EngageRange The Engage Range.
+-- @return #AI_AIR_PATROL self
+function AI_AIR_PATROL:SetEngageRange( EngageRange )
+  self:F2()
+
+  if EngageRange then  
+    self.EngageRange = EngageRange
+  else
+    self.EngageRange = nil
+  end
+end
+
+--- Set race track parameters. CAP flights will perform race track patterns rather than randomly patrolling the zone.
+-- @param #AI_AIR_PATROL self
+-- @param #number LegMin Min Length of the race track leg in meters. Default 10,000 m.
+-- @param #number LegMax Max length of the race track leg in meters. Default 15,000 m.
+-- @param #number HeadingMin Min heading of the race track in degrees. Default 0 deg, i.e. from South to North.
+-- @param #number HeadingMax Max heading of the race track in degrees. Default 180 deg, i.e. from South to North.
+-- @param #number DurationMin (Optional) Min duration before switching the orbit position. Default is keep same orbit until RTB or engage.
+-- @param #number DurationMax (Optional) Max duration before switching the orbit position. Default is keep same orbit until RTB or engage.
+-- @param #table CapCoordinates Table of coordinates of first race track point. Second point is determined by leg length and heading. 
+-- @return #AI_AIR_PATROL self
+function AI_AIR_PATROL:SetRaceTrackPattern(LegMin, LegMax, HeadingMin, HeadingMax, DurationMin, DurationMax, CapCoordinates)
+  
+  self.racetrack=true
+  self.racetracklegmin=LegMin or 10000
+  self.racetracklegmax=LegMax or 15000
+  self.racetrackheadingmin=HeadingMin or 0
+  self.racetrackheadingmax=HeadingMax or 180
+  self.racetrackdurationmin=DurationMin
+  self.racetrackdurationmax=DurationMax
+  
+  if self.racetrackdurationmax and not self.racetrackdurationmin then
+    self.racetrackdurationmin=self.racetrackdurationmax
+  end
+  
+  self.racetrackcapcoordinates=CapCoordinates
+  
+end
+
+
+
+--- Defines a new patrol route using the @{Process_PatrolZone} parameters and settings.
+-- @param #AI_AIR_PATROL self
+-- @return #AI_AIR_PATROL self
+-- @param Wrapper.Group#GROUP AIPatrol The Group Object managed by the FSM.
+-- @param #string From The From State string.
+-- @param #string Event The Event string.
+-- @param #string To The To State string.
+function AI_AIR_PATROL:onafterPatrol( AIPatrol, From, Event, To )
+  self:F2()
+
+  self:ClearTargetDistance()
+
+  self:__PatrolRoute( self.TaskDelay )
+  
+  AIPatrol:OnReSpawn(
+    function( PatrolGroup )
+      self:__Reset( self.TaskDelay )
+      self:__PatrolRoute( self.TaskDelay )
+    end
+  )
+end
+
+--- @param Wrapper.Group#GROUP AIPatrol
+-- This statis method is called from the route path within the last task at the last waaypoint of the AIPatrol.
+-- Note that this method is required, as triggers the next route when patrolling for the AIPatrol.
+function AI_AIR_PATROL.___PatrolRoute( AIPatrol, Fsm )
+
+  AIPatrol:F( { "AI_AIR_PATROL.___PatrolRoute:", AIPatrol:GetName() } )
+
+  if AIPatrol:IsAlive() then
+    Fsm:PatrolRoute()
+  end
+  
+end
+
+--- Defines a new patrol route using the @{Process_PatrolZone} parameters and settings.
+-- @param #AI_AIR_PATROL self
+-- @param Wrapper.Group#GROUP AIPatrol The Group managed by the FSM.
+-- @param #string From The From State string.
+-- @param #string Event The Event string.
+-- @param #string To The To State string.
+function AI_AIR_PATROL:onafterPatrolRoute( AIPatrol, From, Event, To )
+
+  self:F2()
+
+  -- When RTB, don't allow anymore the routing.
+  if From == "RTB" then
+    return
+  end
+
+  
+  if AIPatrol:IsAlive() then
+    
+    local PatrolRoute = {}
+
+    --- Calculate the target route point.
+    
+    local CurrentCoord = AIPatrol:GetCoordinate()
+    
+    local altitude= math.random( self.PatrolFloorAltitude, self.PatrolCeilingAltitude )
+    
+    local ToTargetCoord = self.PatrolZone:GetRandomPointVec2()
+    ToTargetCoord:SetAlt( altitude )
+    self:SetTargetDistance( ToTargetCoord ) -- For RTB status check
+    
+    local ToTargetSpeed = math.random( self.PatrolMinSpeed, self.PatrolMaxSpeed )
+    local speedkmh=ToTargetSpeed
+
+    local FromWP = CurrentCoord:WaypointAir( 
+      self.PatrolAltType or "RADIO", 
+      POINT_VEC3.RoutePointType.TurningPoint, 
+      POINT_VEC3.RoutePointAction.TurningPoint, 
+      ToTargetSpeed, 
+      true 
+    )
+    PatrolRoute[#PatrolRoute+1] = FromWP
+
+    if self.racetrack then
+      
+      -- Random heading.
+      local heading = math.random(self.racetrackheadingmin, self.racetrackheadingmax)
+      
+      -- Random leg length.
+      local leg=math.random(self.racetracklegmin, self.racetracklegmax)
+      
+      -- Random duration if any.
+      local duration = self.racetrackdurationmin
+      if self.racetrackdurationmax then
+        duration=math.random(self.racetrackdurationmin, self.racetrackdurationmax)
+      end
+      
+      -- CAP coordinate.
+      local c0=self.PatrolZone:GetRandomCoordinate()
+      if self.racetrackcapcoordinates and #self.racetrackcapcoordinates>0 then
+        c0=self.racetrackcapcoordinates[math.random(#self.racetrackcapcoordinates)]
+      end
+      
+      -- Race track points.
+      local c1=c0:SetAltitude(altitude) --Core.Point#COORDINATE
+      local c2=c1:Translate(leg, heading):SetAltitude(altitude)
+      
+      self:SetTargetDistance(c0) -- For RTB status check
+      
+      -- Debug:
+      self:T(string.format("Patrol zone race track: v=%.1f knots, h=%.1f ft, heading=%03d, leg=%d m, t=%s sec", UTILS.KmphToKnots(speedkmh), UTILS.MetersToFeet(altitude), heading, leg, tostring(duration)))
+      --c1:MarkToAll("Race track c1")
+      --c2:MarkToAll("Race track c2")
+
+      -- Task to orbit.              
+      local taskOrbit=AIPatrol:TaskOrbit(c1, altitude, UTILS.KmphToMps(speedkmh), c2)
+      
+      -- Task function to redo the patrol at other random position.
+      local taskPatrol=AIPatrol:TaskFunction("AI_A2A_PATROL.PatrolRoute", self)
+      
+      -- Controlled task with task condition.
+      local taskCond=AIPatrol:TaskCondition(nil, nil, nil, nil, duration, nil)
+      local taskCont=AIPatrol:TaskControlled(taskOrbit, taskCond)
+      
+      -- Second waypoint
+      PatrolRoute[2]=c1:WaypointAirTurningPoint(self.PatrolAltType, speedkmh, {taskCont, taskPatrol}, "CAP Orbit")
+
+    else
+    
+      --- Create a route point of type air.
+      local ToWP = ToTargetCoord:WaypointAir( 
+        self.PatrolAltType, 
+        POINT_VEC3.RoutePointType.TurningPoint, 
+        POINT_VEC3.RoutePointAction.TurningPoint, 
+        ToTargetSpeed, 
+        true 
+      )
+  
+      PatrolRoute[#PatrolRoute+1] = ToWP
+      
+      local Tasks = {}
+      Tasks[#Tasks+1] = AIPatrol:TaskFunction( "AI_AIR_PATROL.___PatrolRoute", self )
+      PatrolRoute[#PatrolRoute].task = AIPatrol:TaskCombo( Tasks )
+      
+    end
+    
+    AIPatrol:OptionROEReturnFire()
+    AIPatrol:OptionROTEvadeFire()
+  
+    AIPatrol:Route( PatrolRoute, self.TaskDelay )
+    
+  end
+
+end
+
+--- @param Wrapper.Group#GROUP AIPatrol
+function AI_AIR_PATROL.Resume( AIPatrol, Fsm )
+
+  AIPatrol:F( { "AI_AIR_PATROL.Resume:", AIPatrol:GetName() } )
+  if AIPatrol:IsAlive() then
+    Fsm:__Reset( Fsm.TaskDelay )
+    Fsm:__PatrolRoute( Fsm.TaskDelay )
+  end
+  
+end

Moose Development/Moose/AI/AI_Air_Squadron.lua

@@ -0,0 +1,289 @@
+--- **AI** -- Models squadrons for airplanes and helicopters.
+--
+-- This is a class used in the @{AI_Air_Dispatcher} and derived dispatcher classes.
+-- 
+-- ===
+-- 
+-- ### Author: **FlightControl**
+-- 
+-- ===       
+--
+-- @module AI.AI_Air_Squadron
+-- @image AI_Air_To_Air_Engage.JPG
+
+
+
+--- @type AI_AIR_SQUADRON
+-- @extends Core.Base#BASE
+
+
+--- Implements the core functions modeling squadrons for airplanes and helicopters.
+-- 
+-- ===
+-- 
+-- @field #AI_AIR_SQUADRON
+AI_AIR_SQUADRON = {
+  ClassName = "AI_AIR_SQUADRON",
+}
+
+
+
+--- Creates a new AI_AIR_SQUADRON object
+-- @param #AI_AIR_SQUADRON self
+-- @return #AI_AIR_SQUADRON
+function AI_AIR_SQUADRON:New( SquadronName, AirbaseName, TemplatePrefixes, ResourceCount )
+
+  self:I( { Air_Squadron = { SquadronName, AirbaseName, TemplatePrefixes, ResourceCount } } )
+
+  local AI_Air_Squadron = BASE:New() -- #AI_AIR_SQUADRON
+  
+  AI_Air_Squadron.Name = SquadronName
+  AI_Air_Squadron.Airbase = AIRBASE:FindByName( AirbaseName )
+  AI_Air_Squadron.AirbaseName = AI_Air_Squadron.Airbase:GetName()
+  if not AI_Air_Squadron.Airbase then
+    error( "Cannot find airbase with name:" .. AirbaseName )
+  end
+  
+  AI_Air_Squadron.Spawn = {}
+  if type( TemplatePrefixes ) == "string" then
+    local SpawnTemplate = TemplatePrefixes
+    self.DefenderSpawns[SpawnTemplate] = self.DefenderSpawns[SpawnTemplate] or SPAWN:New( SpawnTemplate ) -- :InitCleanUp( 180 )
+    AI_Air_Squadron.Spawn[1] = self.DefenderSpawns[SpawnTemplate]
+  else
+    for TemplateID, SpawnTemplate in pairs( TemplatePrefixes ) do
+      self.DefenderSpawns[SpawnTemplate] = self.DefenderSpawns[SpawnTemplate] or SPAWN:New( SpawnTemplate ) -- :InitCleanUp( 180 )
+      AI_Air_Squadron.Spawn[#AI_Air_Squadron.Spawn+1] = self.DefenderSpawns[SpawnTemplate]
+    end
+  end
+  AI_Air_Squadron.ResourceCount = ResourceCount
+  AI_Air_Squadron.TemplatePrefixes = TemplatePrefixes
+  AI_Air_Squadron.Captured = false -- Not captured. This flag will be set to true, when the airbase where the squadron is located, is captured.
+
+  self:SetSquadronLanguage( SquadronName, "EN" ) -- Squadrons speak English by default.
+
+  return AI_Air_Squadron
+end
+
+--- Set the Name of the Squadron.
+-- @param #AI_AIR_SQUADRON self
+-- @param #string Name The Squadron Name.
+-- @return #AI_AIR_SQUADRON The Squadron.
+function AI_AIR_SQUADRON:SetName( Name )
+
+  self.Name = Name
+  
+  return self
+end
+
+--- Get the Name of the Squadron.
+-- @param #AI_AIR_SQUADRON self
+-- @return #string The Squadron Name.
+function AI_AIR_SQUADRON:GetName()
+
+  return self.Name
+end
+
+--- Set the ResourceCount of the Squadron.
+-- @param #AI_AIR_SQUADRON self
+-- @param #number ResourceCount The Squadron ResourceCount.
+-- @return #AI_AIR_SQUADRON The Squadron.
+function AI_AIR_SQUADRON:SetResourceCount( ResourceCount )
+
+  self.ResourceCount = ResourceCount
+  
+  return self
+end
+
+--- Get the ResourceCount of the Squadron.
+-- @param #AI_AIR_SQUADRON self
+-- @return #number The Squadron ResourceCount.
+function AI_AIR_SQUADRON:GetResourceCount()
+
+  return self.ResourceCount
+end
+
+--- Add Resources to the Squadron.
+-- @param #AI_AIR_SQUADRON self
+-- @param #number Resources The Resources to be added.
+-- @return #AI_AIR_SQUADRON The Squadron.
+function AI_AIR_SQUADRON:AddResources( Resources )
+
+  self.ResourceCount = self.ResourceCount + Resources
+  
+  return self
+end
+
+--- Remove Resources to the Squadron.
+-- @param #AI_AIR_SQUADRON self
+-- @param #number Resources The Resources to be removed.
+-- @return #AI_AIR_SQUADRON The Squadron.
+function AI_AIR_SQUADRON:RemoveResources( Resources )
+
+  self.ResourceCount = self.ResourceCount - Resources
+  
+  return self
+end
+ 
+--- Set the Overhead of the Squadron.
+-- @param #AI_AIR_SQUADRON self
+-- @param #number Overhead The Squadron Overhead.
+-- @return #AI_AIR_SQUADRON The Squadron.
+function AI_AIR_SQUADRON:SetOverhead( Overhead )
+
+  self.Overhead = Overhead
+  
+  return self
+end
+
+--- Get the Overhead of the Squadron.
+-- @param #AI_AIR_SQUADRON self
+-- @return #number The Squadron Overhead.
+function AI_AIR_SQUADRON:GetOverhead()
+
+  return self.Overhead
+end
+
+--- Set the Grouping of the Squadron.
+-- @param #AI_AIR_SQUADRON self
+-- @param #number Grouping The Squadron Grouping.
+-- @return #AI_AIR_SQUADRON The Squadron.
+function AI_AIR_SQUADRON:SetGrouping( Grouping )
+
+  self.Grouping = Grouping
+  
+  return self
+end
+
+--- Get the Grouping of the Squadron.
+-- @param #AI_AIR_SQUADRON self
+-- @return #number The Squadron Grouping.
+function AI_AIR_SQUADRON:GetGrouping()
+
+  return self.Grouping
+end
+
+--- Set the FuelThreshold of the Squadron.
+-- @param #AI_AIR_SQUADRON self
+-- @param #number FuelThreshold The Squadron FuelThreshold.
+-- @return #AI_AIR_SQUADRON The Squadron.
+function AI_AIR_SQUADRON:SetFuelThreshold( FuelThreshold )
+
+  self.FuelThreshold = FuelThreshold
+  
+  return self
+end
+
+--- Get the FuelThreshold of the Squadron.
+-- @param #AI_AIR_SQUADRON self
+-- @return #number The Squadron FuelThreshold.
+function AI_AIR_SQUADRON:GetFuelThreshold()
+
+  return self.FuelThreshold
+end
+
+--- Set the EngageProbability of the Squadron.
+-- @param #AI_AIR_SQUADRON self
+-- @param #number EngageProbability The Squadron EngageProbability.
+-- @return #AI_AIR_SQUADRON The Squadron.
+function AI_AIR_SQUADRON:SetEngageProbability( EngageProbability )
+
+  self.EngageProbability = EngageProbability
+  
+  return self
+end
+
+--- Get the EngageProbability of the Squadron.
+-- @param #AI_AIR_SQUADRON self
+-- @return #number The Squadron EngageProbability.
+function AI_AIR_SQUADRON:GetEngageProbability()
+
+  return self.EngageProbability
+end
+
+--- Set the Takeoff of the Squadron.
+-- @param #AI_AIR_SQUADRON self
+-- @param #number Takeoff The Squadron Takeoff.
+-- @return #AI_AIR_SQUADRON The Squadron.
+function AI_AIR_SQUADRON:SetTakeoff( Takeoff )
+
+  self.Takeoff = Takeoff
+  
+  return self
+end
+
+--- Get the Takeoff of the Squadron.
+-- @param #AI_AIR_SQUADRON self
+-- @return #number The Squadron Takeoff.
+function AI_AIR_SQUADRON:GetTakeoff()
+
+  return self.Takeoff
+end
+
+--- Set the Landing of the Squadron.
+-- @param #AI_AIR_SQUADRON self
+-- @param #number Landing The Squadron Landing.
+-- @return #AI_AIR_SQUADRON The Squadron.
+function AI_AIR_SQUADRON:SetLanding( Landing )
+
+  self.Landing = Landing
+  
+  return self
+end
+
+--- Get the Landing of the Squadron.
+-- @param #AI_AIR_SQUADRON self
+-- @return #number The Squadron Landing.
+function AI_AIR_SQUADRON:GetLanding()
+
+  return self.Landing
+end
+
+--- Set the TankerName of the Squadron.
+-- @param #AI_AIR_SQUADRON self
+-- @param #string TankerName The Squadron Tanker Name.
+-- @return #AI_AIR_SQUADRON The Squadron.
+function AI_AIR_SQUADRON:SetTankerName( TankerName )
+
+  self.TankerName = TankerName
+  
+  return self
+end
+
+--- Get the Tanker Name of the Squadron.
+-- @param #AI_AIR_SQUADRON self
+-- @return #string The Squadron Tanker Name.
+function AI_AIR_SQUADRON:GetTankerName()
+
+  return self.TankerName
+end
+
+
+--- Set the Radio of the Squadron.
+-- @param #AI_AIR_SQUADRON self
+-- @param #number RadioFrequency The frequency of communication.
+-- @param #number RadioModulation The modulation of communication.
+-- @param #number RadioPower The power in Watts of communication.
+-- @param #string Language The language of the radio speech.
+-- @return #AI_AIR_SQUADRON The Squadron.
+function AI_AIR_SQUADRON:SetRadio( RadioFrequency, RadioModulation, RadioPower, Language )
+
+  self.RadioFrequency = RadioFrequency
+  self.RadioModulation = RadioModulation or radio.modulation.AM 
+  self.RadioPower = RadioPower or 100
+
+  if self.RadioSpeech then
+    self.RadioSpeech:Stop()
+  end
+
+  self.RadioSpeech = nil
+
+  self.RadioSpeech = RADIOSPEECH:New( RadioFrequency, RadioModulation )
+  self.RadioSpeech.power = RadioPower
+  self.RadioSpeech:Start( 0.5 )
+
+  self.RadioSpeech:SetLanguage( Language )
+  
+  return self
+end
+
+

Moose Development/Moose/AI/AI_Cargo.lua

@@ -0,0 +1,568 @@
+--- **AI** -- (R2.4) - Models the intelligent transportation of infantry and other cargo.
+--
+-- ===
+-- 
+-- ### Author: **FlightControl**
+-- 
+-- ===       
+--
+-- @module AI.AI_Cargo
+-- @image Cargo.JPG
+
+--- @type AI_CARGO
+-- @extends Core.Fsm#FSM_CONTROLLABLE
+
+
+--- Base class for the dynamic cargo handling capability for AI groups.
+-- 
+-- Carriers can be mobilized to intelligently transport infantry and other cargo within the simulation.
+-- The AI_CARGO module uses the @{Cargo.Cargo} capabilities within the MOOSE framework.
+-- CARGO derived objects must be declared within the mission to make the AI_CARGO object recognize the cargo.
+-- Please consult the @{Cargo.Cargo} module for more information. 
+-- 
+-- The derived classes from this module are:
+-- 
+--    * @{AI.AI_Cargo_APC} - Cargo transportation using APCs and other vehicles between zones.
+--    * @{AI.AI_Cargo_Helicopter} - Cargo transportation using helicopters between zones.
+--    * @{AI.AI_Cargo_Airplane} - Cargo transportation using airplanes to and from airbases.
+--    
+-- @field #AI_CARGO
+AI_CARGO = {
+  ClassName = "AI_CARGO",
+  Coordinate = nil, -- Core.Point#COORDINATE,
+  Carrier_Cargo = {},
+}
+
+--- Creates a new AI_CARGO object.
+-- @param #AI_CARGO self
+-- @param Wrapper.Group#GROUP Carrier
+-- @param Core.Set#SET_CARGO CargoSet
+-- @param #number CombatRadius
+-- @return #AI_CARGO
+function AI_CARGO:New( Carrier, CargoSet )
+
+  local self = BASE:Inherit( self, FSM_CONTROLLABLE:New( Carrier ) ) -- #AI_CARGO
+
+  self.CargoSet = CargoSet -- Core.Set#SET_CARGO
+  self.CargoCarrier = Carrier -- Wrapper.Group#GROUP
+
+  self:SetStartState( "Unloaded" )
+  
+  self:AddTransition( "Unloaded", "Pickup", "*" )
+  self:AddTransition( "Loaded", "Deploy", "*" )
+  
+  self:AddTransition( "*", "Load", "Boarding" )
+  self:AddTransition( { "Boarding", "Loaded" }, "Board", "Boarding" )
+  self:AddTransition( "Boarding", "Loaded", "Boarding" )
+  self:AddTransition( "Boarding", "PickedUp", "Loaded" )
+  
+  self:AddTransition( "Loaded", "Unload", "Unboarding" )
+  self:AddTransition( "Unboarding", "Unboard", "Unboarding" )
+  self:AddTransition( "Unboarding", "Unloaded", "Unboarding" )
+  self:AddTransition( "Unboarding", "Deployed", "Unloaded" )
+  
+  --- Pickup Handler OnBefore for AI_CARGO
+  -- @function [parent=#AI_CARGO] OnBeforePickup
+  -- @param #AI_CARGO self
+  -- @param #string From
+  -- @param #string Event
+  -- @param #string To
+  -- @param Core.Point#COORDINATE Coordinate
+  -- @param #number Speed Speed in km/h. Default is 50% of max possible speed the group can do. 
+  -- @return #boolean
+  
+  --- Pickup Handler OnAfter for AI_CARGO
+  -- @function [parent=#AI_CARGO] OnAfterPickup
+  -- @param #AI_CARGO self
+  -- @param #string From
+  -- @param #string Event
+  -- @param #string To
+  -- @param Core.Point#COORDINATE Coordinate
+  -- @param #number Speed Speed in km/h. Default is 50% of max possible speed the group can do.
+  
+  --- Pickup Trigger for AI_CARGO
+  -- @function [parent=#AI_CARGO] Pickup
+  -- @param #AI_CARGO self
+  -- @param Core.Point#COORDINATE Coordinate
+  -- @param #number Speed Speed in km/h. Default is 50% of max possible speed the group can do.
+  
+  --- Pickup Asynchronous Trigger for AI_CARGO
+  -- @function [parent=#AI_CARGO] __Pickup
+  -- @param #AI_CARGO self
+  -- @param #number Delay
+  -- @param Core.Point#COORDINATE Coordinate Pickup place. If not given, loading starts at the current location.
+  -- @param #number Speed Speed in km/h. Default is 50% of max possible speed the group can do.
+  
+  --- Deploy Handler OnBefore for AI_CARGO
+  -- @function [parent=#AI_CARGO] OnBeforeDeploy
+  -- @param #AI_CARGO self
+  -- @param #string From
+  -- @param #string Event
+  -- @param #string To
+  -- @param Core.Point#COORDINATE Coordinate
+  -- @param #number Speed Speed in km/h. Default is 50% of max possible speed the group can do.
+  -- @return #boolean
+  
+  --- Deploy Handler OnAfter for AI_CARGO
+  -- @function [parent=#AI_CARGO] OnAfterDeploy
+  -- @param #AI_CARGO self
+  -- @param #string From
+  -- @param #string Event
+  -- @param #string To
+  -- @param Core.Point#COORDINATE Coordinate
+  -- @param #number Speed Speed in km/h. Default is 50% of max possible speed the group can do.
+  
+  --- Deploy Trigger for AI_CARGO
+  -- @function [parent=#AI_CARGO] Deploy
+  -- @param #AI_CARGO self
+  -- @param Core.Point#COORDINATE Coordinate
+  -- @param #number Speed Speed in km/h. Default is 50% of max possible speed the group can do.
+  
+  --- Deploy Asynchronous Trigger for AI_CARGO
+  -- @function [parent=#AI_CARGO] __Deploy
+  -- @param #AI_CARGO self
+  -- @param #number Delay
+  -- @param Core.Point#COORDINATE Coordinate
+  -- @param #number Speed Speed in km/h. Default is 50% of max possible speed the group can do.
+
+  
+  --- Loaded Handler OnAfter for AI_CARGO
+  -- @function [parent=#AI_CARGO] OnAfterLoaded
+  -- @param #AI_CARGO self
+  -- @param Wrapper.Group#GROUP Carrier
+  -- @param #string From
+  -- @param #string Event
+  -- @param #string To
+  
+  --- Unloaded Handler OnAfter for AI_CARGO
+  -- @function [parent=#AI_CARGO] OnAfterUnloaded
+  -- @param #AI_CARGO self
+  -- @param Wrapper.Group#GROUP Carrier
+  -- @param #string From
+  -- @param #string Event
+  -- @param #string To
+  
+  for _, CarrierUnit in pairs( Carrier:GetUnits() ) do
+    local CarrierUnit = CarrierUnit -- Wrapper.Unit#UNIT
+    CarrierUnit:SetCargoBayWeightLimit()
+  end
+  
+  self.Transporting = false
+  self.Relocating = false
+  
+  return self
+end
+
+
+
+function AI_CARGO:IsTransporting()
+
+  return self.Transporting == true
+end
+
+function AI_CARGO:IsRelocating()
+
+  return self.Relocating == true
+end
+
+
+--- On after Pickup event.
+-- @param #AI_CARGO self
+-- @param Wrapper.Group#GROUP APC
+-- @param From
+-- @param Event
+-- @param To
+-- @param Core.Point#COORDINATE Coordinate of the pickup point.
+-- @param #number Speed Speed in km/h to drive to the pickup coordinate. Default is 50% of max possible speed the unit can go.
+-- @param #number Height Height in meters to move to the home coordinate.
+-- @param Core.Zone#ZONE PickupZone (optional) The zone where the cargo will be picked up. The PickupZone can be nil, if there wasn't any PickupZoneSet provided.
+function AI_CARGO:onafterPickup( APC, From, Event, To, Coordinate, Speed, Height, PickupZone )
+
+  self.Transporting = false
+  self.Relocating = true
+  
+end
+
+
+--- On after Deploy event.
+-- @param #AI_CARGO self
+-- @param Wrapper.Group#GROUP APC
+-- @param From
+-- @param Event
+-- @param To
+-- @param Core.Point#COORDINATE Coordinate Deploy place.
+-- @param #number Speed Speed in km/h to drive to the depoly coordinate. Default is 50% of max possible speed the unit can go.
+-- @param #number Height Height in meters to move to the deploy coordinate.
+-- @param Core.Zone#ZONE DeployZone The zone where the cargo will be deployed.
+function AI_CARGO:onafterDeploy( APC, From, Event, To, Coordinate, Speed, Height, DeployZone )
+
+  self.Relocating = false
+  self.Transporting = true
+  
+end
+
+--- On before Load event.
+-- @param #AI_CARGO self
+-- @param Wrapper.Group#GROUP Carrier
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @param #string To To state.
+-- @param Core.Zone#ZONE PickupZone (optional) The zone where the cargo will be picked up. The PickupZone can be nil, if there wasn't any PickupZoneSet provided.
+function AI_CARGO:onbeforeLoad( Carrier, From, Event, To, PickupZone )
+  self:F( { Carrier, From, Event, To } )
+
+  local Boarding = false
+
+  local LoadInterval = 2
+  local LoadDelay = 1
+  local Carrier_List = {}
+  local Carrier_Weight = {}
+
+  if Carrier and Carrier:IsAlive() then
+    self.Carrier_Cargo = {}
+    for _, CarrierUnit in pairs( Carrier:GetUnits() ) do
+      local CarrierUnit = CarrierUnit -- Wrapper.Unit#UNIT
+      
+      local CargoBayFreeWeight = CarrierUnit:GetCargoBayFreeWeight()
+      self:F({CargoBayFreeWeight=CargoBayFreeWeight})
+      
+      Carrier_List[#Carrier_List+1] = CarrierUnit
+      Carrier_Weight[CarrierUnit] = CargoBayFreeWeight
+    end
+
+    local Carrier_Count = #Carrier_List
+    local Carrier_Index = 1
+      
+    local Loaded = false
+
+    for _, Cargo in UTILS.spairs( self.CargoSet:GetSet(), function( t, a, b ) return t[a]:GetWeight() > t[b]:GetWeight() end ) do
+      local Cargo = Cargo -- Cargo.Cargo#CARGO
+
+      self:F( { IsUnLoaded = Cargo:IsUnLoaded(), IsDeployed = Cargo:IsDeployed(), Cargo:GetName(), Carrier:GetName() } )
+
+      -- Try all Carriers, but start from the one according the Carrier_Index
+      for Carrier_Loop = 1, #Carrier_List do
+
+        local CarrierUnit = Carrier_List[Carrier_Index] -- Wrapper.Unit#UNIT
+
+        -- This counters loop through the available Carriers.
+        Carrier_Index = Carrier_Index + 1
+        if Carrier_Index > Carrier_Count then
+          Carrier_Index = 1
+        end
+        
+        if Cargo:IsUnLoaded() and not Cargo:IsDeployed() then
+          if Cargo:IsInLoadRadius( CarrierUnit:GetCoordinate() ) then
+            self:F( { "In radius", CarrierUnit:GetName() } )
+            
+            local CargoWeight = Cargo:GetWeight()
+  
+            -- Only when there is space within the bay to load the next cargo item!
+            if Carrier_Weight[CarrierUnit] > CargoWeight then --and CargoBayFreeVolume > CargoVolume then
+              Carrier:RouteStop()
+              --Cargo:Ungroup()
+              Cargo:__Board( -LoadDelay, CarrierUnit )
+              self:__Board( LoadDelay, Cargo, CarrierUnit, PickupZone )
+
+              LoadDelay = LoadDelay + Cargo:GetCount() * LoadInterval
+
+              -- So now this CarrierUnit has Cargo that is being loaded.
+              -- This will be used further in the logic to follow and to check cargo status.
+              self.Carrier_Cargo[Cargo] = CarrierUnit
+              Boarding = true
+              Carrier_Weight[CarrierUnit] = Carrier_Weight[CarrierUnit] - CargoWeight
+              Loaded = true
+              
+              -- Ok, we loaded a cargo, now we can stop the loop.
+              break
+            end
+          end
+        end
+        
+      end
+
+    end
+    
+    if not Loaded == true then
+      -- No loading happened, so we need to pickup something else.
+      self.Relocating = false
+    end
+  end
+
+  return Boarding
+  
+end
+
+
+--- On before Reload event.
+-- @param #AI_CARGO self
+-- @param Wrapper.Group#GROUP Carrier
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @param #string To To state.
+-- @param Core.Zone#ZONE PickupZone (optional) The zone where the cargo will be picked up. The PickupZone can be nil, if there wasn't any PickupZoneSet provided.
+function AI_CARGO:onbeforeReload( Carrier, From, Event, To )
+  self:F( { Carrier, From, Event, To } )
+
+  local Boarding = false
+
+  local LoadInterval = 2
+  local LoadDelay = 1
+  local Carrier_List = {}
+  local Carrier_Weight = {}
+
+  if Carrier and Carrier:IsAlive() then
+    for _, CarrierUnit in pairs( Carrier:GetUnits() ) do
+      local CarrierUnit = CarrierUnit -- Wrapper.Unit#UNIT
+      
+      Carrier_List[#Carrier_List+1] = CarrierUnit
+    end
+
+    local Carrier_Count = #Carrier_List
+    local Carrier_Index = 1
+      
+    local Loaded = false
+
+    for Cargo, CarrierUnit in pairs( self.Carrier_Cargo ) do
+      local Cargo = Cargo -- Cargo.Cargo#CARGO
+
+      self:F( { IsUnLoaded = Cargo:IsUnLoaded(), IsDeployed = Cargo:IsDeployed(), Cargo:GetName(), Carrier:GetName() } )
+
+      -- Try all Carriers, but start from the one according the Carrier_Index
+      for Carrier_Loop = 1, #Carrier_List do
+
+        local CarrierUnit = Carrier_List[Carrier_Index] -- Wrapper.Unit#UNIT
+
+        -- This counters loop through the available Carriers.
+        Carrier_Index = Carrier_Index + 1
+        if Carrier_Index > Carrier_Count then
+          Carrier_Index = 1
+        end
+        
+        if Cargo:IsUnLoaded() and not Cargo:IsDeployed() then
+          Carrier:RouteStop()
+          Cargo:__Board( -LoadDelay, CarrierUnit )
+          self:__Board( LoadDelay, Cargo, CarrierUnit )
+
+          LoadDelay = LoadDelay + Cargo:GetCount() * LoadInterval
+
+          -- So now this CarrierUnit has Cargo that is being loaded.
+          -- This will be used further in the logic to follow and to check cargo status.
+          self.Carrier_Cargo[Cargo] = CarrierUnit
+          Boarding = true
+          Loaded = true
+        end
+        
+      end
+
+    end
+    
+    if not Loaded == true then
+      -- No loading happened, so we need to pickup something else.
+      self.Relocating = false
+    end
+  end
+
+  return Boarding
+  
+end
+
+--- On after Board event.
+-- @param #AI_CARGO self
+-- @param Wrapper.Group#GROUP Carrier
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @param #string To To state.
+-- @param Cargo.Cargo#CARGO Cargo Cargo object.
+-- @param Wrapper.Unit#UNIT CarrierUnit
+-- @param Core.Zone#ZONE PickupZone (optional) The zone where the cargo will be picked up. The PickupZone can be nil, if there wasn't any PickupZoneSet provided.
+function AI_CARGO:onafterBoard( Carrier, From, Event, To, Cargo, CarrierUnit, PickupZone )
+  self:F( { Carrier, From, Event, To, Cargo, CarrierUnit:GetName() } )
+
+  if Carrier and Carrier:IsAlive() then
+    self:F({ IsLoaded = Cargo:IsLoaded(), Cargo:GetName(), Carrier:GetName() } )
+    if not Cargo:IsLoaded() and not Cargo:IsDestroyed() then
+      self:__Board( -10, Cargo, CarrierUnit, PickupZone )
+      return
+    end
+  end
+
+  self:__Loaded( 0.1, Cargo, CarrierUnit, PickupZone )
+  
+end
+
+--- On after Loaded event.
+-- @param #AI_CARGO self
+-- @param Wrapper.Group#GROUP Carrier
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @param #string To To state.
+-- @return #boolean Cargo loaded.
+-- @param Core.Zone#ZONE PickupZone (optional) The zone where the cargo will be picked up. The PickupZone can be nil, if there wasn't any PickupZoneSet provided.
+function AI_CARGO:onafterLoaded( Carrier, From, Event, To, Cargo, PickupZone )
+  self:F( { Carrier, From, Event, To } )
+
+  local Loaded = true
+
+  if Carrier and Carrier:IsAlive() then
+    for Cargo, CarrierUnit in pairs( self.Carrier_Cargo ) do
+      local Cargo = Cargo -- Cargo.Cargo#CARGO
+      self:F( { IsLoaded = Cargo:IsLoaded(), IsDestroyed = Cargo:IsDestroyed(), Cargo:GetName(), Carrier:GetName() } )
+      if not Cargo:IsLoaded() and not Cargo:IsDestroyed() then
+        Loaded = false
+      end
+    end
+  end
+  
+  if Loaded then
+    self:__PickedUp( 0.1, PickupZone )
+  end
+  
+end
+
+--- On after PickedUp event.
+-- @param #AI_CARGO self
+-- @param Wrapper.Group#GROUP Carrier
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @param #string To To state.
+-- @param Core.Zone#ZONE PickupZone (optional) The zone where the cargo will be picked up. The PickupZone can be nil, if there wasn't any PickupZoneSet provided.
+function AI_CARGO:onafterPickedUp( Carrier, From, Event, To, PickupZone )
+  self:F( { Carrier, From, Event, To } )
+
+  Carrier:RouteResume()
+
+  local HasCargo = false
+  if Carrier and Carrier:IsAlive() then
+    for Cargo, CarrierUnit in pairs( self.Carrier_Cargo ) do
+      HasCargo = true
+      break
+    end
+  end
+
+  self.Relocating = false
+  if HasCargo then
+    self:F( "Transporting" )
+    self.Transporting = true
+  end
+  
+end
+
+
+
+
+--- On after Unload event.
+-- @param #AI_CARGO self
+-- @param Wrapper.Group#GROUP Carrier
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @param #string To To state.
+-- @param Core.Zone#ZONE DeployZone The zone wherein the cargo is deployed. This can be any zone type, like a ZONE, ZONE_GROUP, ZONE_AIRBASE.
+function AI_CARGO:onafterUnload( Carrier, From, Event, To, DeployZone, Defend )
+  self:F( { Carrier, From, Event, To, DeployZone, Defend = Defend } )
+
+  local UnboardInterval = 5
+  local UnboardDelay = 5
+
+  if Carrier and Carrier:IsAlive() then
+    for _, CarrierUnit in pairs( Carrier:GetUnits() ) do
+      local CarrierUnit = CarrierUnit -- Wrapper.Unit#UNIT
+      Carrier:RouteStop()
+      for _, Cargo in pairs( CarrierUnit:GetCargo() ) do
+        self:F( { Cargo = Cargo:GetName(), Isloaded = Cargo:IsLoaded() } )
+        if Cargo:IsLoaded() then
+          Cargo:__UnBoard( UnboardDelay )
+          UnboardDelay = UnboardDelay + Cargo:GetCount() * UnboardInterval
+          self:__Unboard( UnboardDelay, Cargo, CarrierUnit, DeployZone, Defend )
+          if not Defend == true then
+            Cargo:SetDeployed( true )
+          end
+        end 
+      end
+    end
+  end
+  
+end
+
+--- On after Unboard event.
+-- @param #AI_CARGO self
+-- @param Wrapper.Group#GROUP Carrier
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @param #string To To state.
+-- @param #string Cargo.Cargo#CARGO Cargo Cargo object.
+-- @param Core.Zone#ZONE DeployZone The zone wherein the cargo is deployed. This can be any zone type, like a ZONE, ZONE_GROUP, ZONE_AIRBASE.
+function AI_CARGO:onafterUnboard( Carrier, From, Event, To, Cargo, CarrierUnit, DeployZone, Defend )
+  self:F( { Carrier, From, Event, To, Cargo:GetName(), DeployZone = DeployZone, Defend = Defend } )
+
+  if Carrier and Carrier:IsAlive() then
+    if not Cargo:IsUnLoaded() then
+      self:__Unboard( 10, Cargo, CarrierUnit, DeployZone, Defend ) 
+      return
+    end
+  end
+
+  self:Unloaded( Cargo, CarrierUnit, DeployZone, Defend )
+  
+end
+
+--- On after Unloaded event.
+-- @param #AI_CARGO self
+-- @param Wrapper.Group#GROUP Carrier
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @param #string To To state.
+-- @param #string Cargo.Cargo#CARGO Cargo Cargo object.
+-- @param #boolean Deployed Cargo is deployed.
+-- @param Core.Zone#ZONE DeployZone The zone wherein the cargo is deployed. This can be any zone type, like a ZONE, ZONE_GROUP, ZONE_AIRBASE.
+function AI_CARGO:onafterUnloaded( Carrier, From, Event, To, Cargo, CarrierUnit, DeployZone, Defend )
+  self:F( { Carrier, From, Event, To, Cargo:GetName(), DeployZone = DeployZone, Defend = Defend } )
+
+  local AllUnloaded = true
+
+  --Cargo:Regroup()
+
+  if Carrier and Carrier:IsAlive() then
+    for _, CarrierUnit in pairs( Carrier:GetUnits() ) do
+      local CarrierUnit = CarrierUnit -- Wrapper.Unit#UNIT
+      local IsEmpty = CarrierUnit:IsCargoEmpty()
+      self:I({ IsEmpty = IsEmpty })
+      if not IsEmpty then
+        AllUnloaded = false
+        break
+      end
+    end
+    
+    if AllUnloaded == true then
+      if DeployZone == true then
+        self.Carrier_Cargo = {}
+      end
+      self.CargoCarrier = Carrier
+    end
+  end
+
+  if AllUnloaded == true then
+    self:__Deployed( 5, DeployZone, Defend )
+  end
+  
+end
+
+--- On after Deployed event.
+-- @param #AI_CARGO self
+-- @param Wrapper.Group#GROUP Carrier
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @param #string To To state.
+-- @param Core.Zone#ZONE DeployZone The zone wherein the cargo is deployed. This can be any zone type, like a ZONE, ZONE_GROUP, ZONE_AIRBASE.
+function AI_CARGO:onafterDeployed( Carrier, From, Event, To, DeployZone, Defend )
+  self:F( { Carrier, From, Event, To, DeployZone = DeployZone, Defend = Defend } )
+
+  if not Defend == true then
+    self.Transporting = false
+  else
+    self:F( "Defending" )
+    
+  end
+
+end
+

Moose Development/Moose/AI/AI_Cargo_APC.lua

@@ -1,4 +1,4 @@
---- **AI** -- (R2.3) - Models the intelligent transportation of infantry and other cargo.
+--- **AI** -- (R2.4) - Models the intelligent transportation of infantry and other cargo.
 --
 -- ===
 -- 
@@ -10,23 +10,26 @@
 -- @image AI_Cargo_Dispatching_For_APC.JPG
 
 --- @type AI_CARGO_APC
--- @extends Core.Fsm#FSM_CONTROLLABLE
+-- @extends AI.AI_Cargo#AI_CARGO
 
 
---- Brings a dynamic cargo handling capability for AI groups.
+--- Brings a dynamic cargo handling capability for an AI vehicle group.
 -- 
 -- Armoured Personnel Carriers (APC), Trucks, Jeeps and other ground based carrier equipment can be mobilized to intelligently transport infantry and other cargo within the simulation.
--- The AI\_CARGO\APC module uses the @{Cargo} capabilities within the MOOSE framework.
--- CARGO derived objects must be declared within the mission to make the AI\_CARGO\APC object recognize the cargo.
--- Please consult the @{Cargo} module for more information. 
+-- 
+-- The AI_CARGO_APC class uses the @{Cargo.Cargo} capabilities within the MOOSE framework.
+-- @{Cargo.Cargo} must be declared within the mission to make the AI_CARGO_APC object recognize the cargo.
+-- Please consult the @{Cargo.Cargo} module for more information. 
 -- 
 -- ## Cargo loading.
 -- 
--- The module will load automatically cargo when the APCs are within boarding or loading range.
--- The boarding or loading range is specified when the cargo is created in the simulation, and therefore, this range depends on the type of cargo
--- and the specified boarding range.
+-- The module will load automatically cargo when the APCs are within boarding or loading radius.
+-- The boarding or loading radius is specified when the cargo is created in the simulation, and therefore, this radius depends on the type of cargo
+-- and the specified boarding radius.
 -- 
--- ## Enemies nearby.
+-- ## **Defending** the APCs when enemies nearby.
+-- 
+-- Cargo will defend the carrier with its available arms, and to avoid cargo being lost within the battlefield.
 --  
 -- When the APCs are approaching enemy units, something special is happening. 
 -- The APCs will stop moving, and the loaded infantry will unboard and follow the APCs and will help to defend the group.
@@ -34,13 +37,17 @@
 -- to ensure that the APCs are not too far away from the following running infantry.
 -- Once all enemies are cleared, the infantry will board again automatically into the APCs. Once boarded, the APCs will follow its pre-defined route.
 -- 
--- A combat range needs to be specified in meters at the @{#AI_CARGO_APC.New}() method. 
--- This combat range will trigger the unboarding of troops when enemies are within the combat range around the APCs.
--- During my tests, I've noticed that there is a balance between ensuring that the infantry is within sufficient hit range (effectiveness) versus
+-- A combat radius needs to be specified in meters at the @{#AI_CARGO_APC.New}() method. 
+-- This combat radius will trigger the unboarding of troops when enemies are within the combat radius around the APCs.
+-- During my tests, I've noticed that there is a balance between ensuring that the infantry is within sufficient hit radius (effectiveness) versus
 -- vulnerability of the infantry. It all depends on the kind of enemies that are expected to be encountered. 
--- A combat range of 350 meters to 500 meters has been proven to be the most effective and efficient.
+-- A combat radius of 350 meters to 500 meters has been proven to be the most effective and efficient.
 -- 
--- ## Infantry health.
+-- However, when the defense of the carrier, is not required, it must be switched off.
+-- This is done by disabling the defense of the carrier using the method @{#AI_CARGO_APC.SetCombatRadius}(), and providing a combat radius of 0 meters.
+-- It can be switched on later when required by reenabling the defense using the method and providing a combat radius larger than 0.
+-- 
+-- ## Infantry or cargo **health**.
 -- 
 -- When infantry is unboarded from the APCs, the infantry is actually respawned into the battlefield. 
 -- As a result, the unboarding infantry is very _healthy_ every time it unboards.
@@ -74,122 +81,29 @@
 AI_CARGO_APC = {
   ClassName = "AI_CARGO_APC",
   Coordinate = nil, -- Core.Point#COORDINATE,
-  APC_Cargo = {},
 }
 
 --- Creates a new AI_CARGO_APC object.
 -- @param #AI_CARGO_APC self
--- @param Wrapper.Group#GROUP APC
--- @param Core.Set#SET_CARGO CargoSet
--- @param #number CombatRadius
+-- @param Wrapper.Group#GROUP APC The carrier APC group.
+-- @param Core.Set#SET_CARGO CargoSet The set of cargo to be transported.
+-- @param #number CombatRadius Provide the combat radius to defend the carrier by unboarding the cargo when enemies are nearby. When the combat radius is 0, no defense will happen of the carrier.
 -- @return #AI_CARGO_APC
 function AI_CARGO_APC:New( APC, CargoSet, CombatRadius )
 
-  local self = BASE:Inherit( self, FSM_CONTROLLABLE:New() ) -- #AI_CARGO_APC
+  local self = BASE:Inherit( self, AI_CARGO:New( APC, CargoSet ) ) -- #AI_CARGO_APC
 
-  self.CargoSet = CargoSet -- Core.Set#SET_CARGO
-  self.CombatRadius = CombatRadius
-
-  self:SetStartState( "Unloaded" ) 
-  
-  self:AddTransition( "Unloaded", "Pickup", "*" )
-  self:AddTransition( "Loaded", "Deploy", "*" )
-  
-  self:AddTransition( "*", "Load", "Boarding" )
-  self:AddTransition( "Boarding", "Board", "Boarding" )
-  self:AddTransition( "Boarding", "Loaded", "Loaded" )
-  self:AddTransition( "Loaded", "Unload", "Unboarding" )
-  self:AddTransition( "Unboarding", "Unboard", "Unboarding" )
-  self:AddTransition( { "Unboarding", "Unloaded" }, "Unloaded", "Unloaded" )
-  
   self:AddTransition( "*", "Monitor", "*" )
   self:AddTransition( "*", "Follow", "Following" )
   self:AddTransition( "*", "Guard", "Unloaded" )
   self:AddTransition( "*", "Home", "*" )
+  self:AddTransition( "*", "Reload", "Boarding" )
   
   self:AddTransition( "*", "Destroyed", "Destroyed" )
 
-
-  --- Pickup Handler OnBefore for AI_CARGO_APC
-  -- @function [parent=#AI_CARGO_APC] OnBeforePickup
-  -- @param #AI_CARGO_APC self
-  -- @param #string From
-  -- @param #string Event
-  -- @param #string To
-  -- @param Core.Point#COORDINATE Coordinate
-  -- @return #boolean
-  
-  --- Pickup Handler OnAfter for AI_CARGO_APC
-  -- @function [parent=#AI_CARGO_APC] OnAfterPickup
-  -- @param #AI_CARGO_APC self
-  -- @param #string From
-  -- @param #string Event
-  -- @param #string To
-  -- @param Core.Point#COORDINATE Coordinate
-  
-  --- Pickup Trigger for AI_CARGO_APC
-  -- @function [parent=#AI_CARGO_APC] Pickup
-  -- @param #AI_CARGO_APC self
-  -- @param Core.Point#COORDINATE Coordinate
-  
-  --- Pickup Asynchronous Trigger for AI_CARGO_APC
-  -- @function [parent=#AI_CARGO_APC] __Pickup
-  -- @param #AI_CARGO_APC self
-  -- @param #number Delay
-  -- @param Core.Point#COORDINATE Coordinate
-  
-  --- Deploy Handler OnBefore for AI_CARGO_APC
-  -- @function [parent=#AI_CARGO_APC] OnBeforeDeploy
-  -- @param #AI_CARGO_APC self
-  -- @param #string From
-  -- @param #string Event
-  -- @param #string To
-  -- @param Core.Point#COORDINATE Coordinate
-  -- @return #boolean
-  
-  --- Deploy Handler OnAfter for AI_CARGO_APC
-  -- @function [parent=#AI_CARGO_APC] OnAfterDeploy
-  -- @param #AI_CARGO_APC self
-  -- @param #string From
-  -- @param #string Event
-  -- @param #string To
-  -- @param Core.Point#COORDINATE Coordinate
-  
-  --- Deploy Trigger for AI_CARGO_APC
-  -- @function [parent=#AI_CARGO_APC] Deploy
-  -- @param #AI_CARGO_APC self
-  -- @param Core.Point#COORDINATE Coordinate
-  
-  --- Deploy Asynchronous Trigger for AI_CARGO_APC
-  -- @function [parent=#AI_CARGO_APC] __Deploy
-  -- @param #AI_CARGO_APC self
-  -- @param Core.Point#COORDINATE Coordinate
-  -- @param #number Delay
-
-  
-  --- Loaded Handler OnAfter for AI_CARGO_APC
-  -- @function [parent=#AI_CARGO_APC] OnAfterLoaded
-  -- @param #AI_CARGO_APC self
-  -- @param Wrapper.Group#GROUP APC
-  -- @param #string From
-  -- @param #string Event
-  -- @param #string To
-  
-  --- Unloaded Handler OnAfter for AI_CARGO_APC
-  -- @function [parent=#AI_CARGO_APC] OnAfterUnloaded
-  -- @param #AI_CARGO_APC self
-  -- @param Wrapper.Group#GROUP APC
-  -- @param #string From
-  -- @param #string Event
-  -- @param #string To
-  
-
-  self:__Monitor( 1 )
-
+  self:SetCombatRadius( CombatRadius )
 
   self:SetCarrier( APC )
-  self.Transporting = false
-  self.Relocating = false
   
   return self
 end
@@ -205,7 +119,6 @@ function AI_CARGO_APC:SetCarrier( CargoCarrier )
   self.CargoCarrier:SetState( self.CargoCarrier, "AI_CARGO_APC", self )
 
   CargoCarrier:HandleEvent( EVENTS.Dead )
-  CargoCarrier:HandleEvent( EVENTS.Hit )
   
   function CargoCarrier:OnEventDead( EventData )
     self:F({"dead"})
@@ -214,23 +127,25 @@ function AI_CARGO_APC:SetCarrier( CargoCarrier )
     if AICargoTroops then
       self:F({})
       if not AICargoTroops:Is( "Loaded" ) then
-        -- There are enemies within combat range. Unload the CargoCarrier.
+        -- There are enemies within combat radius. Unload the CargoCarrier.
         AICargoTroops:Destroyed()
       end
     end
   end
-  
-  function CargoCarrier:OnEventHit( EventData )
-    self:F({"hit"})
-    local AICargoTroops = self:GetState( self, "AI_CARGO_APC" )
-    if AICargoTroops then
-      self:F( { OnHitLoaded = AICargoTroops:Is( "Loaded" ) } )
-      if AICargoTroops:Is( "Loaded" ) or AICargoTroops:Is( "Boarding" ) then
-        -- There are enemies within combat range. Unload the CargoCarrier.
-        AICargoTroops:Unload( false )
-      end
-    end
-  end
+
+--  CargoCarrier:HandleEvent( EVENTS.Hit )
+--  
+--  function CargoCarrier:OnEventHit( EventData )
+--    self:F({"hit"})
+--    local AICargoTroops = self:GetState( self, "AI_CARGO_APC" )
+--    if AICargoTroops then
+--      self:F( { OnHitLoaded = AICargoTroops:Is( "Loaded" ) } )
+--      if AICargoTroops:Is( "Loaded" ) or AICargoTroops:Is( "Boarding" ) then
+--        -- There are enemies within combat radius. Unload the CargoCarrier.
+--        AICargoTroops:Unload( false )
+--      end
+--    end
+--  end
   
   self.Zone = ZONE_UNIT:New( self.CargoCarrier:GetName() .. "-Zone", self.CargoCarrier, self.CombatRadius )
   self.Coalition = self.CargoCarrier:GetCoalition()
@@ -243,17 +158,7 @@ function AI_CARGO_APC:SetCarrier( CargoCarrier )
 end
 
 
-function AI_CARGO_APC:IsTransporting()
-
-  return self.Transporting == true
-end
-
-function AI_CARGO_APC:IsRelocating()
-
-  return self.Relocating == true
-end
-
---- Find a free Carrier within a range.
+--- Find a free Carrier within a radius.
 -- @param #AI_CARGO_APC self
 -- @param Core.Point#COORDINATE Coordinate
 -- @param #number Radius
@@ -278,6 +183,30 @@ function AI_CARGO_APC:FindCarrier( Coordinate, Radius )
 
 end
 
+--- Enable/Disable unboarding of cargo (infantry) when enemies are nearby (to help defend the carrier).
+-- This is only valid for APCs and trucks etc, thus ground vehicles.
+-- @param #AI_CARGO_APC self
+-- @param #number CombatRadius Provide the combat radius to defend the carrier by unboarding the cargo when enemies are nearby. 
+-- When the combat radius is 0, no defense will happen of the carrier. 
+-- When the combat radius is not provided, no defense will happen!
+-- @return #AI_CARGO_APC
+-- @usage
+-- 
+-- -- Disembark the infantry when the carrier is under attack.
+-- AICargoAPC:SetCombatRadius( true )
+-- 
+-- -- Keep the cargo in the carrier when the carrier is under attack.
+-- AICargoAPC:SetCombatRadius( false )
+function AI_CARGO_APC:SetCombatRadius( CombatRadius )
+
+  self.CombatRadius = CombatRadius or 0
+
+  if self.CombatRadius > 0 then
+    self:__Monitor( -5 )
+  end
+
+  return self
+end
 
 
 --- Follow Infantry to the Carrier.
@@ -335,41 +264,51 @@ function AI_CARGO_APC:FollowToCarrier( Me, APCUnit, CargoGroup )
 end
 
 
---- @param #AI_CARGO_APC self
+--- On after Monitor event.
+-- @param #AI_CARGO_APC self
 -- @param Wrapper.Group#GROUP APC
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @param #string To To state.
 function AI_CARGO_APC:onafterMonitor( APC, From, Event, To )
-  self:F( { APC, From, Event, To } )
+  self:F( { APC, From, Event, To, IsTransporting = self:IsTransporting() } )
 
-  if APC and APC:IsAlive() then
-    if self.CarrierCoordinate then
-      if self:IsRelocating() == true then
-        local Coordinate = APC:GetCoordinate()
-        self.Zone:Scan( { Object.Category.UNIT } )
-        if self.Zone:IsAllInZoneOfCoalition( self.Coalition ) then
-          if self:Is( "Unloaded" ) or self:Is( "Following" ) then
-            -- There are no enemies within combat range. Load the CargoCarrier.
-            self:Load()
-          end
-        else
-          if self:Is( "Loaded" ) then
-            -- There are enemies within combat range. Unload the CargoCarrier.
-            self:__Unload( 1, false )
-          else
-            if self:Is( "Unloaded" ) then
-              self:Follow()
-            end
-            if self:Is( "Following" ) then
-              for APCUnit, Cargo in pairs( self.APC_Cargo ) do
-                local Cargo = Cargo -- Cargo.Cargo#CARGO
-                if Cargo:IsAlive() then
-                  if not Cargo:IsNear( APCUnit, 40 ) then
-                    APCUnit:RouteStop()
-                    self.CarrierStopped = true
-                  else
-                    if self.CarrierStopped then
-                      if Cargo:IsNear( APCUnit, 25 ) then
-                        APCUnit:RouteResume()
-                        self.CarrierStopped = nil
+  if self.CombatRadius > 0 then
+    if APC and APC:IsAlive() then
+      if self.CarrierCoordinate then
+        if self:IsTransporting() == true then
+          local Coordinate = APC:GetCoordinate()
+          if self:Is( "Unloaded" ) or self:Is( "Loaded" ) then
+            self.Zone:Scan( { Object.Category.UNIT } )
+            if self.Zone:IsAllInZoneOfCoalition( self.Coalition ) then
+              if self:Is( "Unloaded" ) then
+                -- There are no enemies within combat radius. Reload the CargoCarrier.
+                self:Reload()
+              end
+            else
+              if self:Is( "Loaded" ) then
+                -- There are enemies within combat radius. Unload the CargoCarrier.
+                self:__Unload( 1, nil, true ) -- The 2nd parameter is true, which means that the unload is for defending the carrier, not to deploy!
+              else
+                if self:Is( "Unloaded" ) then
+                  --self:Follow()
+                end
+                self:F( "I am here" .. self:GetCurrentState() )
+                if self:Is( "Following" ) then
+                  for Cargo, APCUnit in pairs( self.Carrier_Cargo ) do
+                    local Cargo = Cargo -- Cargo.Cargo#CARGO
+                    local APCUnit = APCUnit -- Wrapper.Unit#UNIT
+                    if Cargo:IsAlive() then
+                      if not Cargo:IsNear( APCUnit, 40 ) then
+                        APCUnit:RouteStop()
+                        self.CarrierStopped = true
+                      else
+                        if self.CarrierStopped then
+                          if Cargo:IsNear( APCUnit, 25 ) then
+                            APCUnit:RouteResume()
+                            self.CarrierStopped = nil
+                          end
+                        end
                       end
                     end
                   end
@@ -378,180 +317,29 @@ function AI_CARGO_APC:onafterMonitor( APC, From, Event, To )
             end
           end
         end
+        
       end
-      
+      self.CarrierCoordinate = APC:GetCoordinate()
     end
-    self.CarrierCoordinate = APC:GetCoordinate()
-  end
   
-  self:__Monitor( -5 )
-
-end
-
-
---- @param #AI_CARGO_APC self
--- @param Wrapper.Group#GROUP APC
-function AI_CARGO_APC:onbeforeLoad( APC, From, Event, To )
-  self:F( { APC, From, Event, To } )
-
-  local Boarding = false
-  self.BoardingCount = 0
-
-  if APC and APC:IsAlive() then
-    self.APC_Cargo = {}
-    for _, APCUnit in pairs( APC:GetUnits() ) do
-      local APCUnit = APCUnit -- Wrapper.Unit#UNIT
-      for _, Cargo in pairs( self.CargoSet:GetSet() ) do
-        local Cargo = Cargo -- Cargo.Cargo#CARGO
-        self:F( { IsUnLoaded = Cargo:IsUnLoaded(), IsDeployed = Cargo:IsDeployed(), Cargo:GetName(), APC:GetName() } )
-        if Cargo:IsUnLoaded() and not Cargo:IsDeployed() then
-          if Cargo:IsInLoadRadius( APCUnit:GetCoordinate() ) then
-            self:F( { "In radius", APCUnit:GetName() } )
-            APC:RouteStop()
-            --Cargo:Ungroup()
-            Cargo:Board( APCUnit, 25 )
-            self:__Board( 1, Cargo )
-            Boarding = true
-            
-            -- So now this APCUnit has Cargo that is being loaded.
-            -- This will be used further in the logic to follow and to check cargo status.
-            self.APC_Cargo[APCUnit] = Cargo
-            break
-          end
-        end
-      end
-    end
-  end
-
-  return Boarding
-  
-end
-
---- @param #AI_CARGO_APC self
--- @param Wrapper.Group#GROUP APC
-function AI_CARGO_APC:onafterBoard( APC, From, Event, To, Cargo )
-  self:F( { APC, From, Event, To, Cargo } )
-
-  if APC and APC:IsAlive() then
-    self:F({ IsLoaded = Cargo:IsLoaded(), Cargo:GetName(), APC:GetName() } )
-    if not Cargo:IsLoaded() then
-      self:__Board( 10, Cargo )
-    else
-      self:__Loaded( 1 )
-    end
+    self:__Monitor( -5 )
   end
   
 end
 
---- @param #AI_CARGO_APC self
--- @param Wrapper.Group#GROUP APC
-function AI_CARGO_APC:onbeforeLoaded( APC, From, Event, To )
-  self:F( { APC, From, Event, To } )
-
-  local Loaded = true
-
-  if APC and APC:IsAlive() then
-    for APCUnit, Cargo in pairs( self.APC_Cargo ) do
-      local Cargo = Cargo -- Cargo.Cargo#CARGO
-      self:F( { IsLoaded = Cargo:IsLoaded(), IsDestroyed = Cargo:IsDestroyed(), Cargo:GetName(), APC:GetName() } )
-      if not Cargo:IsLoaded() and not Cargo:IsDestroyed() then
-        Loaded = false
-      end
-    end
-    
-  end
-  
-  if Loaded == true then
-    APC:RouteResume()
-  end
-  
-  return Loaded
-  
-end
-
-
---- @param #AI_CARGO_APC self
--- @param Wrapper.Group#GROUP APC
-function AI_CARGO_APC:onafterUnload( APC, From, Event, To, Deployed )
-  self:F( { APC, From, Event, To, Deployed } )
-
-  if APC and APC:IsAlive() then
-    for _, APCUnit in pairs( APC:GetUnits() ) do
-      local APCUnit = APCUnit -- Wrapper.Unit#UNIT
-      APC:RouteStop()
-      for _, Cargo in pairs( APCUnit:GetCargo() ) do
-        Cargo:UnBoard()
-        self:__Unboard( 10, Cargo, Deployed )
-      end 
-    end
-  end
-  
-end
-
---- @param #AI_CARGO_APC self
--- @param Wrapper.Group#GROUP APC
-function AI_CARGO_APC:onafterUnboard( APC, From, Event, To, Cargo, Deployed )
-  self:F( { APC, From, Event, To, Cargo:GetName() } )
-
-  if APC and APC:IsAlive() then
-    if not Cargo:IsUnLoaded() then
-      self:__Unboard( 10, Cargo, Deployed ) 
-    else
-      self:__Unloaded( 1, Cargo, Deployed )
-    end
-  end
-  
-end
-
---- @param #AI_CARGO_APC self
--- @param Wrapper.Group#GROUP APC
-function AI_CARGO_APC:onbeforeUnloaded( APC, From, Event, To, Cargo, Deployed )
-  self:F( { APC, From, Event, To, Cargo:GetName(), Deployed = Deployed } )
-
-  local AllUnloaded = true
-
-  --Cargo:Regroup()
-
-  if APC and APC:IsAlive() then
-    for _, APCUnit in pairs( APC:GetUnits() ) do
-      local APCUnit = APCUnit -- Wrapper.Unit#UNIT
-      local CargoCheck = self.APC_Cargo[APCUnit]
-      if CargoCheck then
-        self:F( { CargoCheck:GetName(), IsUnLoaded = CargoCheck:IsUnLoaded() } )
-        if CargoCheck:IsUnLoaded() == false then
-          AllUnloaded = false
-          break
-        end
-      end
-    end
-    
-    if AllUnloaded == true then
-      if Deployed == true then
-        for APCUnit, Cargo in pairs( self.APC_Cargo ) do
-          local Cargo = Cargo -- Cargo.Cargo#CARGO
-          Cargo:SetDeployed( true )
-        end
-        self.APC_Cargo = {}
-      end
-      self:Guard()
-      self.CargoCarrier = APC
-    end
-  end
-  
-  self:F( { AllUnloaded = AllUnloaded } )
-  return AllUnloaded
-  
-end
-
-
---- @param #AI_CARGO_APC self
+
+--- On after Follow event.
+-- @param #AI_CARGO_APC self
 -- @param Wrapper.Group#GROUP APC
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @param #string To To state.
 function AI_CARGO_APC:onafterFollow( APC, From, Event, To )
   self:F( { APC, From, Event, To } )
 
   self:F( "Follow" )
   if APC and APC:IsAlive() then
-    for APCUnit, Cargo in pairs( self.APC_Cargo ) do
+    for Cargo, APCUnit in pairs( self.Carrier_Cargo ) do
       local Cargo = Cargo -- Cargo.Cargo#CARGO
       if Cargo:IsUnLoaded() then
         self:FollowToCarrier( self, APCUnit, Cargo )
@@ -565,40 +353,38 @@ end
 
 --- @param #AI_CARGO_APC 
 -- @param Wrapper.Group#GROUP APC
-function AI_CARGO_APC._Pickup( APC, self )
+function AI_CARGO_APC._Pickup( APC, self, Coordinate, Speed, PickupZone )
 
   APC:F( { "AI_CARGO_APC._Pickup:", APC:GetName() } )
 
   if APC:IsAlive() then
-    self:Load()
-    self.Relocating = true
+    self:Load( PickupZone )
   end
 end
 
 
---- @param #AI_CARGO_APC 
--- @param Wrapper.Group#GROUP APC
-function AI_CARGO_APC._Deploy( APC, self )
+function AI_CARGO_APC._Deploy( APC, self, Coordinate, DeployZone )
 
   APC:F( { "AI_CARGO_APC._Deploy:", APC } )
 
   if APC:IsAlive() then
-    self:Unload( true )
-    self.Transporting = false
-    self.Relocating = false
+    self:Unload( DeployZone )
   end
 end
 
 
 
---- @param #AI_CARGO_APC self
+--- On after Pickup event.
+-- @param #AI_CARGO_APC self
 -- @param Wrapper.Group#GROUP APC
 -- @param From
 -- @param Event
 -- @param To
 -- @param Core.Point#COORDINATE Coordinate of the pickup point.
 -- @param #number Speed Speed in km/h to drive to the pickup coordinate. Default is 50% of max possible speed the unit can go.
-function AI_CARGO_APC:onafterPickup( APC, From, Event, To, Coordinate, Speed )
+-- @param #number Height Height in meters to move to the pickup coordinate. This parameter is ignored for APCs.
+-- @param Core.Zone#ZONE PickupZone (optional) The zone where the cargo will be picked up. The PickupZone can be nil, if there wasn't any PickupZoneSet provided.
+function AI_CARGO_APC:onafterPickup( APC, From, Event, To, Coordinate, Speed, Height, PickupZone )
 
   if APC and APC:IsAlive() then
 
@@ -609,7 +395,7 @@ function AI_CARGO_APC:onafterPickup( APC, From, Event, To, Coordinate, Speed )
       
       local Waypoints = APC:TaskGroundOnRoad( Coordinate, _speed, "Line abreast", true )
   
-      local TaskFunction = APC:TaskFunction( "AI_CARGO_APC._Pickup", self )
+      local TaskFunction = APC:TaskFunction( "AI_CARGO_APC._Pickup", self, Coordinate, Speed, PickupZone )
       
       self:F({Waypoints = Waypoints})
       local Waypoint = Waypoints[#Waypoints]
@@ -617,23 +403,26 @@ function AI_CARGO_APC:onafterPickup( APC, From, Event, To, Coordinate, Speed )
     
       APC:Route( Waypoints, 1 ) -- Move after a random seconds to the Route. See the Route method for details.
     else
-      AI_CARGO_APC._Pickup( APC, self )
+      AI_CARGO_APC._Pickup( APC, self, Coordinate, Speed, PickupZone )
     end
-    
-    self.Transporting = true
+
+    self:GetParent( self, AI_CARGO_APC ).onafterPickup( self, APC, From, Event, To, Coordinate, Speed, Height, PickupZone )
   end
   
 end
 
 
---- @param #AI_CARGO_APC self
+--- On after Deploy event.
+-- @param #AI_CARGO_APC self
 -- @param Wrapper.Group#GROUP APC
 -- @param From
 -- @param Event
 -- @param To
--- @param Core.Point#COORDINATE Coordinate
--- @param #number Speed Speed in km/h to drive to the pickup coordinate. Default is 50% of max possible speed the unit can go.
-function AI_CARGO_APC:onafterDeploy( APC, From, Event, To, Coordinate, Speed )
+-- @param Core.Point#COORDINATE Coordinate Deploy place.
+-- @param #number Speed Speed in km/h to drive to the depoly coordinate. Default is 50% of max possible speed the unit can go.
+-- @param #number Height Height in meters to move to the deploy coordinate. This parameter is ignored for APCs.
+-- @param Core.Zone#ZONE DeployZone The zone where the cargo will be deployed.
+function AI_CARGO_APC:onafterDeploy( APC, From, Event, To, Coordinate, Speed, Height, DeployZone )
 
   if APC and APC:IsAlive() then
 
@@ -643,34 +432,94 @@ function AI_CARGO_APC:onafterDeploy( APC, From, Event, To, Coordinate, Speed )
      
     local Waypoints = APC:TaskGroundOnRoad( Coordinate, _speed, "Line abreast", true )
 
-    local TaskFunction = APC:TaskFunction( "AI_CARGO_APC._Deploy", self )
+    local TaskFunction = APC:TaskFunction( "AI_CARGO_APC._Deploy", self, Coordinate, DeployZone )
     
     self:F({Waypoints = Waypoints})
     local Waypoint = Waypoints[#Waypoints]
     APC:SetTaskWaypoint( Waypoint, TaskFunction ) -- Set for the given Route at Waypoint 2 the TaskRouteToZone.
   
     APC:Route( Waypoints, 1 ) -- Move after a random seconds to the Route. See the Route method for details.
+
+    self:GetParent( self, AI_CARGO_APC ).onafterDeploy( self, APC, From, Event, To, Coordinate, Speed, Height, DeployZone )
+
   end
   
 end
 
+--- On after Unloaded event.
+-- @param #AI_CARGO_APC self
+-- @param Wrapper.Group#GROUP Carrier
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @param #string To To state.
+-- @param #string Cargo.Cargo#CARGO Cargo Cargo object.
+-- @param #boolean Deployed Cargo is deployed.
+-- @param Core.Zone#ZONE DeployZone The zone wherein the cargo is deployed. This can be any zone type, like a ZONE, ZONE_GROUP, ZONE_AIRBASE.
+function AI_CARGO_APC:onafterUnloaded( Carrier, From, Event, To, Cargo, CarrierUnit, DeployZone, Defend )
+  self:F( { Carrier, From, Event, To, DeployZone = DeployZone, Defend = Defend } )
 
---- @param #AI_CARGO_APC self
+
+  self:GetParent( self, AI_CARGO_APC ).onafterUnloaded( self, Carrier, From, Event, To, Cargo, CarrierUnit, DeployZone, Defend  )
+
+  -- If Defend == true then we need to scan for possible enemies within combat zone and engage only ground forces.
+  if Defend == true then
+    self.Zone:Scan( { Object.Category.UNIT } )
+    if not self.Zone:IsAllInZoneOfCoalition( self.Coalition ) then
+      -- OK, enemies nearby, now find the enemies and attack them.
+      local AttackUnits = self.Zone:GetScannedUnits() -- #list<DCS#Unit>
+      local Move = {}
+      local CargoGroup = Cargo.CargoObject -- Wrapper.Group#GROUP
+      Move[#Move+1] = CargoGroup:GetCoordinate():WaypointGround( 70, "Custom" )
+      for UnitId, AttackUnit in pairs( AttackUnits ) do
+        local MooseUnit = UNIT:Find( AttackUnit )
+        if MooseUnit:GetCoalition() ~= CargoGroup:GetCoalition() then
+          Move[#Move+1] = MooseUnit:GetCoordinate():WaypointGround( 70, "Line abreast" )
+          --MoveTo.Task = CargoGroup:TaskCombo( CargoGroup:TaskAttackUnit( MooseUnit, true ) )
+          self:F( { MooseUnit = MooseUnit:GetName(), CargoGroup = CargoGroup:GetName() } )
+        end
+      end
+      CargoGroup:RoutePush( Move, 0.1 )
+    end
+  
+  end
+
+end
+
+--- On after Deployed event.
+-- @param #AI_CARGO_APC self
+-- @param Wrapper.Group#GROUP Carrier
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @param #string To To state.
+-- @param Core.Zone#ZONE DeployZone The zone wherein the cargo is deployed. This can be any zone type, like a ZONE, ZONE_GROUP, ZONE_AIRBASE.
+function AI_CARGO_APC:onafterDeployed( APC, From, Event, To, DeployZone, Defend )
+  self:F( { APC, From, Event, To, DeployZone = DeployZone, Defend = Defend } )
+
+  self:__Guard( 0.1 )
+
+  self:GetParent( self, AI_CARGO_APC ).onafterDeployed( self, APC, From, Event, To, DeployZone, Defend )
+
+end
+
+
+--- On after Home event.
+-- @param #AI_CARGO_APC self
 -- @param Wrapper.Group#GROUP APC
 -- @param From
 -- @param Event
 -- @param To
--- @param Core.Point#COORDINATE Coordinate
+-- @param Core.Point#COORDINATE Coordinate Home place.
 -- @param #number Speed Speed in km/h to drive to the pickup coordinate. Default is 50% of max possible speed the unit can go.
-function AI_CARGO_APC:onafterHome( APC, From, Event, To, Coordinate, Speed )
+-- @param #number Height Height in meters to move to the home coordinate. This parameter is ignored for APCs.
+function AI_CARGO_APC:onafterHome( APC, From, Event, To, Coordinate, Speed, Height, HomeZone )
 
   if APC and APC:IsAlive() ~= nil then
 
     self.RouteHome = true
     
-    local _speed=Speed or APC:GetSpeedMax()*0.5
+    Speed = Speed or APC:GetSpeedMax()*0.5
     
-    local Waypoints = APC:TaskGroundOnRoad( Coordinate, _speed, "Line abreast", true )
+    local Waypoints = APC:TaskGroundOnRoad( Coordinate, Speed, "Line abreast", true )
 
     self:F({Waypoints = Waypoints})
     local Waypoint = Waypoints[#Waypoints]

Moose Development/Moose/AI/AI_Cargo_Airplane.lua

@@ -1,4 +1,4 @@
---- **AI** -- (R2.3) - Models the intelligent transportation of infantry (cargo).
+--- **AI** -- (R2.4) - Models the intelligent transportation of infantry (cargo).
 --
 -- ===
 -- 
@@ -13,108 +13,142 @@
 -- @extends Core.Fsm#FSM_CONTROLLABLE
 
 
---- Implements the transportation of cargo by airplanes.
+--- Brings a dynamic cargo handling capability for an AI airplane group.
+--  
+-- Airplane carrier equipment can be mobilized to intelligently transport infantry and other cargo within the simulation between airbases.
+-- 
+-- The AI_CARGO_AIRPLANE module uses the @{Cargo.Cargo} capabilities within the MOOSE framework.
+-- @{Cargo.Cargo} must be declared within the mission to make AI_CARGO_AIRPLANE recognize the cargo.
+-- Please consult the @{Cargo.Cargo} module for more information. 
+-- 
+-- ## Cargo pickup.
+--  
+-- Using the @{#AI_CARGO_AIRPLANE.Pickup}() method, you are able to direct the helicopters towards a point on the battlefield to board/load the cargo at the specific coordinate. 
+-- Ensure that the landing zone is horizontally flat, and that trees cannot be found in the landing vicinity, or the helicopters won't land or will even crash!
+-- 
+-- ## Cargo deployment.
+--  
+-- Using the @{#AI_CARGO_AIRPLANE.Deploy}() method, you are able to direct the helicopters towards a point on the battlefield to unboard/unload the cargo at the specific coordinate. 
+-- Ensure that the landing zone is horizontally flat, and that trees cannot be found in the landing vicinity, or the helicopters won't land or will even crash!
+-- 
+-- ## Infantry health.
+-- 
+-- When infantry is unboarded from the APCs, the infantry is actually respawned into the battlefield. 
+-- As a result, the unboarding infantry is very _healthy_ every time it unboards.
+-- This is due to the limitation of the DCS simulator, which is not able to specify the health of new spawned units as a parameter.
+-- However, infantry that was destroyed when unboarded, won't be respawned again. Destroyed is destroyed.
+-- As a result, there is some additional strength that is gained when an unboarding action happens, but in terms of simulation balance this has
+-- marginal impact on the overall battlefield simulation. Fortunately, the firing strength of infantry is limited, and thus, respacing healthy infantry every
+-- time is not so much of an issue ... 
+-- 
 -- 
 -- @field #AI_CARGO_AIRPLANE
 AI_CARGO_AIRPLANE = {
   ClassName = "AI_CARGO_AIRPLANE",
-  Coordinate = nil -- Core.Point#COORDINATE,
+  Coordinate = nil, -- Core.Point#COORDINATE
 }
 
 --- Creates a new AI_CARGO_AIRPLANE object.
 -- @param #AI_CARGO_AIRPLANE self
--- @param Wrapper.Group#GROUP Airplane
--- @param Core.Set#SET_CARGO CargoSet
+-- @param Wrapper.Group#GROUP Airplane Plane used for transportation of cargo.
+-- @param Core.Set#SET_CARGO CargoSet Cargo set to be transported.
 -- @return #AI_CARGO_AIRPLANE
 function AI_CARGO_AIRPLANE:New( Airplane, CargoSet )
 
-  local self = BASE:Inherit( self, FSM_CONTROLLABLE:New() ) -- #AI_CARGO_AIRPLANE
-
-  self.CargoSet = CargoSet -- Cargo.CargoGroup#CARGO_GROUP
-
-  self:SetStartState( "Unloaded" ) 
-  
-  self:AddTransition( "Unloaded", "Pickup", "*" )
-  self:AddTransition( "Loaded", "Deploy", "*" )
-  
-  self:AddTransition( "Unloaded", "Load", "Boarding" )
-  self:AddTransition( "Boarding", "Board", "Boarding" )
-  self:AddTransition( "Boarding", "Loaded", "Loaded" )
-  self:AddTransition( "Loaded", "Unload", "Unboarding" )
-  self:AddTransition( "Unboarding", "Unboard", "Unboarding" )
-  self:AddTransition( "Unboarding", "Unloaded", "Unloaded" )
+  local self = BASE:Inherit( self, AI_CARGO:New( Airplane, CargoSet ) ) -- #AI_CARGO_AIRPLANE
 
   self:AddTransition( "*", "Landed", "*" )
+  self:AddTransition( "*", "Home" ,  "*" ) 
   
   self:AddTransition( "*", "Destroyed", "Destroyed" )
 
   --- Pickup Handler OnBefore for AI_CARGO_AIRPLANE
   -- @function [parent=#AI_CARGO_AIRPLANE] OnBeforePickup
   -- @param #AI_CARGO_AIRPLANE self
-  -- @param #string From
-  -- @param #string Event
-  -- @param #string To
-  -- @param Wrapper.Airbase#AIRBASE Airbase
+  -- @param Wrapper.Group#GROUP Airplane Cargo transport plane.
+  -- @param #string From From state.
+  -- @param #string Event Event.
+  -- @param #string To To state.
+  -- @param Wrapper.Airbase#AIRBASE Airbase Airbase where troops are picked up.
+  -- @param #number Speed in km/h for travelling to pickup base.
   -- @return #boolean
   
   --- Pickup Handler OnAfter for AI_CARGO_AIRPLANE
   -- @function [parent=#AI_CARGO_AIRPLANE] OnAfterPickup
   -- @param #AI_CARGO_AIRPLANE self
+  -- @param Wrapper.Group#GROUP Airplane Cargo plane.
   -- @param #string From
   -- @param #string Event
   -- @param #string To
-  -- @param Wrapper.Airbase#AIRBASE Airbase
+  -- @param Wrapper.Airbase#AIRBASE Airbase Airbase where troops are picked up.
+  -- @param #number Speed in km/h for travelling to pickup base.
   
   --- Pickup Trigger for AI_CARGO_AIRPLANE
   -- @function [parent=#AI_CARGO_AIRPLANE] Pickup
   -- @param #AI_CARGO_AIRPLANE self
-  -- @param Wrapper.Airbase#AIRBASE Airbase
+  -- @param Wrapper.Airbase#AIRBASE Airbase Airbase where troops are picked up.
+  -- @param #number Speed in km/h for travelling to pickup base.
   
   --- Pickup Asynchronous Trigger for AI_CARGO_AIRPLANE
   -- @function [parent=#AI_CARGO_AIRPLANE] __Pickup
   -- @param #AI_CARGO_AIRPLANE self
-  -- @param #number Delay
-  -- @param Wrapper.Airbase#AIRBASE Airbase
+  -- @param #number Delay Delay in seconds.
+  -- @param Wrapper.Airbase#AIRBASE Airbase Airbase where troops are picked up.
+  -- @param #number Speed in km/h for travelling to pickup base.
   
   --- Deploy Handler OnBefore for AI_CARGO_AIRPLANE
   -- @function [parent=#AI_CARGO_AIRPLANE] OnBeforeDeploy
   -- @param #AI_CARGO_AIRPLANE self
+  -- @param Wrapper.Group#GROUP Airplane Cargo plane.
   -- @param #string From
   -- @param #string Event
   -- @param #string To
-  -- @param Wrapper.Airbase#AIRBASE Airbase
+  -- @param Wrapper.Airbase#AIRBASE Airbase Destination airbase where troops are deployed.
+  -- @param #number Speed Speed in km/h for travelling to deploy base.
   -- @return #boolean
   
   --- Deploy Handler OnAfter for AI_CARGO_AIRPLANE
   -- @function [parent=#AI_CARGO_AIRPLANE] OnAfterDeploy
   -- @param #AI_CARGO_AIRPLANE self
+  -- @param Wrapper.Group#GROUP Airplane Cargo plane.
   -- @param #string From
   -- @param #string Event
   -- @param #string To
-  -- @param Wrapper.Airbase#AIRBASE Airbase
+  -- @param Wrapper.Airbase#AIRBASE Airbase Destination airbase where troops are deployed.
+  -- @param #number Speed Speed in km/h for travelling to deploy base.
   
   --- Deploy Trigger for AI_CARGO_AIRPLANE
   -- @function [parent=#AI_CARGO_AIRPLANE] Deploy
   -- @param #AI_CARGO_AIRPLANE self
-  -- @param Wrapper.Airbase#AIRBASE Airbase
+  -- @param Wrapper.Airbase#AIRBASE Airbase Destination airbase where troops are deployed.
+  -- @param #number Speed Speed in km/h for travelling to deploy base.
   
   --- Deploy Asynchronous Trigger for AI_CARGO_AIRPLANE
   -- @function [parent=#AI_CARGO_AIRPLANE] __Deploy
   -- @param #AI_CARGO_AIRPLANE self
-  -- @param Wrapper.Airbase#AIRBASE Airbase
-  -- @param #number Delay
-
+  -- @param #number Delay Delay in seconds.
+  -- @param Wrapper.Airbase#AIRBASE Airbase Destination airbase where troops are deployed.
+  -- @param #number Speed Speed in km/h for travelling to deploy base.
 
+  --- On after Loaded event, i.e. triggered when the cargo is inside the carrier.
+  -- @function [parent=#AI_CARGO_AIRPLANE] OnAfterLoaded
+  -- @param #AI_CARGO_AIRPLANE self
+  -- @param Wrapper.Group#GROUP Airplane Cargo plane.
+  -- @param From
+  -- @param Event
+  -- @param To
+  
+  -- Set carrier. 
   self:SetCarrier( Airplane )
   
   return self
 end
 
 
---- Set the Carrier.
+--- Set the Carrier (controllable). Also initializes events for carrier and defines the coalition.
 -- @param #AI_CARGO_AIRPLANE self
--- @param Wrapper.Group#GROUP Airplane
--- @return #AI_CARGO_AIRPLANE
+-- @param Wrapper.Group#GROUP Airplane Transport plane.
+-- @return #AI_CARGO_AIRPLANE self
 function AI_CARGO_AIRPLANE:SetCarrier( Airplane )
 
   local AICargo = self
@@ -155,7 +189,8 @@ function AI_CARGO_AIRPLANE:SetCarrier( Airplane )
   
   
   function Airplane:OnEventEngineShutdown( EventData )
-    AICargo:Landed()
+    AICargo.Relocating = false
+    AICargo:Landed( self.Airplane )
   end
   
   self.Coalition = self.Airplane:GetCoalition()
@@ -168,7 +203,7 @@ end
 
 --- Find a free Carrier within a range.
 -- @param #AI_CARGO_AIRPLANE self
-  -- @param Wrapper.Airbase#AIRBASE Airbase
+-- @param Wrapper.Airbase#AIRBASE Airbase
 -- @param #number Radius
 -- @return Wrapper.Group#GROUP NewCarrier
 function AI_CARGO_AIRPLANE:FindCarrier( Coordinate, Radius )
@@ -190,22 +225,24 @@ function AI_CARGO_AIRPLANE:FindCarrier( Coordinate, Radius )
 
 end
 
---- @param #AI_CARGO_AIRPLANE self
--- @param Wrapper.Group#GROUP Airplane
+--- On after "Landed" event. Called on engine shutdown and initiates the pickup mission or unloading event.
+-- @param #AI_CARGO_AIRPLANE self
+-- @param Wrapper.Group#GROUP Airplane Cargo transport plane.
 -- @param From
 -- @param Event
 -- @param To
-  -- @param Wrapper.Airbase#AIRBASE Airbase
--- @param #number Speed
 function AI_CARGO_AIRPLANE:onafterLanded( Airplane, From, Event, To )
 
-  if Airplane and Airplane:IsAlive() then
+  self:F({Airplane, From, Event, To})
 
+  if Airplane and Airplane:IsAlive()~=nil then
+
+    -- Aircraft was sent to this airbase to pickup troops. Initiate loadling.
     if self.RoutePickup == true then
-      self:Load( Airplane:GetPointVec2() )
-      self.RoutePickup = false
+      self:Load( self.PickupZone )
     end
     
+    -- Aircraft was send to this airbase to deploy troops. Initiate unloading.
     if self.RouteDeploy == true then
       self:Unload()
       self.RouteDeploy = false
@@ -216,231 +253,232 @@ function AI_CARGO_AIRPLANE:onafterLanded( Airplane, From, Event, To )
 end
 
 
-
---- @param #AI_CARGO_AIRPLANE self
--- @param Wrapper.Group#GROUP Airplane
--- @param From
--- @param Event
--- @param To
--- @param Wrapper.Airbase#AIRBASE Airbase
--- @param #number Speed
-function AI_CARGO_AIRPLANE:onafterPickup( Airplane, From, Event, To, Airbase, Speed )
+--- On after "Pickup" event. Routes transport to pickup airbase.
+-- @param #AI_CARGO_AIRPLANE self
+-- @param Wrapper.Group#GROUP Airplane Cargo transport plane.
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @param #string To To state.
+-- @param Core.Point#COORDINATE Coordinate
+-- @param #number Speed in km/h for travelling to pickup base.
+-- @param #number Height Height in meters to move to the pickup coordinate.
+-- @param Core.Zone#ZONE_AIRBASE (optional) PickupZone The zone where the cargo will be picked up.
+function AI_CARGO_AIRPLANE:onafterPickup( Airplane, From, Event, To, Coordinate, Speed, Height, PickupZone )
 
   if Airplane and Airplane:IsAlive() then
-    self:Route( Airplane, Airbase, Speed )
-    self.RoutePickup = true
-    self.Airbase = Airbase
+    
+    self.PickupZone = PickupZone
+  
+    -- Get closest airbase of current position.
+    local ClosestAirbase, DistToAirbase=Airplane:GetCoordinate():GetClosestAirbase()
+  
+    -- Two cases. Aircraft spawned in air or at an airbase.
+    if Airplane:InAir() then
+      self.Airbase=nil  --> route will start in air
+    else      
+      self.Airbase=ClosestAirbase
+    end
+    
+    -- Set pickup airbase.
+    local Airbase = PickupZone:GetAirbase()
+    
+    -- Distance from closest to pickup airbase ==> we need to know if we are already at the pickup airbase. 
+    local Dist = Airbase:GetCoordinate():Get2DDistance(ClosestAirbase:GetCoordinate())
+    --env.info("Distance closest to pickup airbase = "..Dist)
+    
+    if Airplane:InAir() or Dist>500 then
+    
+      -- Route aircraft to pickup airbase.
+      self:Route( Airplane, Airbase, Speed, Height ) 
+          
+      -- Set airbase as starting point in the next Route() call.
+      self.Airbase = Airbase
+      
+      -- Aircraft is on a pickup mission.
+      self.RoutePickup = true
+      
+    else
+    
+      -- We are already at the right airbase ==> Landed ==> triggers loading of troops. Is usually called at engine shutdown event.
+      self.RoutePickup=true
+      self:Landed()
+      
+    end
+
+    self:GetParent( self, AI_CARGO_AIRPLANE ).onafterPickup( self, Airplane, From, Event, To, Coordinate, Speed, Height, PickupZone )
+    
   end
+
   
 end
 
+--- On after Depoly event. Routes plane to the airbase where the troops are deployed.
+-- @param #AI_CARGO_AIRPLANE self
+-- @param Wrapper.Group#GROUP Airplane Cargo transport plane.
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @param #string To To state.
+-- @param Core.Point#COORDINATE Coordinate
+-- @param #number Speed in km/h for travelling to pickup base.
+-- @param #number Height Height in meters to move to the home coordinate.
+-- @param Core.Zone#ZONE_AIRBASE DeployZone The zone where the cargo will be deployed.
+function AI_CARGO_AIRPLANE:onafterDeploy( Airplane, From, Event, To, Coordinate, Speed, Height, DeployZone )
 
---- @param #AI_CARGO_AIRPLANE self
--- @param Wrapper.Group#GROUP Airplane
--- @param From
--- @param Event
--- @param To
--- @param Wrapper.Airbase#AIRBASE Airbase
--- @param #number Speed
-function AI_CARGO_AIRPLANE:onafterDeploy( Airplane, From, Event, To, Airbase, Speed )
-
-  if Airplane and Airplane:IsAlive() then
-    self:Route( Airplane, Airbase, Speed )
+  if Airplane and Airplane:IsAlive()~=nil then
+    
+    local Airbase = DeployZone:GetAirbase()
+    
+    -- Activate uncontrolled airplane.
+    if Airplane:IsAlive()==false then
+      Airplane:SetCommand({id = 'Start', params = {}})
+    end
+    
+    -- Route to destination airbase.
+    self:Route( Airplane, Airbase, Speed, Height )
+    
+    -- Aircraft is on a depoly mission.
     self.RouteDeploy = true
+    
+    -- Set destination airbase for next :Route() command.
     self.Airbase = Airbase
+    
+    self:GetParent( self, AI_CARGO_AIRPLANE ).onafterDeploy( self, Airplane, From, Event, To, Coordinate, Speed, Height, DeployZone )
   end
   
 end
 
 
---- @param #AI_CARGO_AIRPLANE self
--- @param Wrapper.Group#GROUP Airplane
-function AI_CARGO_AIRPLANE:onafterLoad( Airplane, From, Event, To, Coordinate )
+--- On after Unload event. Cargo is beeing unloaded, i.e. the unboarding process is started.
+-- @param #AI_CARGO_AIRPLANE self
+-- @param Wrapper.Group#GROUP Airplane Cargo transport plane.
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @param #string To To state.
+function AI_CARGO_AIRPLANE:onafterUnload( Airplane, From, Event, To, DeployZone )
+
+  local UnboardInterval = 10
+  local UnboardDelay = 10
 
   if Airplane and Airplane:IsAlive() then
-  
-    for _, Cargo in pairs( self.CargoSet:GetSet() ) do
-      if Cargo:IsInLoadRadius( Coordinate ) then
-        self:__Board( 5 )
-        Cargo:Board( Airplane, 25 )
-        self.Cargo = Cargo
-        break
+    for _, AirplaneUnit in pairs( Airplane:GetUnits() ) do
+      local Cargos = AirplaneUnit:GetCargo()
+      for CargoID, Cargo in pairs( Cargos ) do
+      
+        local Angle = 180
+        local CargoCarrierHeading = Airplane:GetHeading() -- Get Heading of object in degrees.
+        local CargoDeployHeading = ( ( CargoCarrierHeading + Angle ) >= 360 ) and ( CargoCarrierHeading + Angle - 360 ) or ( CargoCarrierHeading + Angle )
+        self:T( { CargoCarrierHeading, CargoDeployHeading } )
+        local CargoDeployCoordinate = Airplane:GetPointVec2():Translate( 150, CargoDeployHeading )
+      
+         Cargo:__UnBoard( UnboardDelay, CargoDeployCoordinate )
+         UnboardDelay = UnboardDelay + UnboardInterval
+         Cargo:SetDeployed( true )
+         self:__Unboard( UnboardDelay, Cargo, AirplaneUnit, DeployZone ) 
       end
     end
   end
   
 end
 
---- @param #AI_CARGO_AIRPLANE self
--- @param Wrapper.Group#GROUP Airplane
-function AI_CARGO_AIRPLANE:onafterBoard( Airplane, From, Event, To )
-
-  if Airplane and Airplane:IsAlive() then
-    self:F({ IsLoaded = self.Cargo:IsLoaded() } )
-    if not self.Cargo:IsLoaded() then
-      self:__Board( 10 )
-    else
-      self:__Loaded( 1 )
-    end
-  end
-  
-end
-
---- @param #AI_CARGO_AIRPLANE self
--- @param Wrapper.Group#GROUP Airplane
-function AI_CARGO_AIRPLANE:onafterLoaded( Airplane, From, Event, To )
-
-  if Airplane and Airplane:IsAlive() then
-  end
-  
-end
 
 
---- @param #AI_CARGO_AIRPLANE self
--- @param Wrapper.Group#GROUP Airplane
-function AI_CARGO_AIRPLANE:onafterUnload( Airplane, From, Event, To )
 
-  if Airplane and Airplane:IsAlive() then
-    self.Cargo:UnBoard()
-    self:__Unboard( 10 ) 
-  end
-  
-end
-
---- @param #AI_CARGO_AIRPLANE self
--- @param Wrapper.Group#GROUP Airplane
-function AI_CARGO_AIRPLANE:onafterUnboard( Airplane, From, Event, To )
-
-  if Airplane and Airplane:IsAlive() then
-    if not self.Cargo:IsUnLoaded() then
-      self:__Unboard( 10 ) 
-    else
-      self:__Unloaded( 1 )
-    end
-  end
-  
-end
-
---- @param #AI_CARGO_AIRPLANE self
--- @param Wrapper.Group#GROUP Airplane
-function AI_CARGO_AIRPLANE:onafterUnloaded( Airplane, From, Event, To )
-
-  if Airplane and Airplane:IsAlive() then
-    self.Airplane = Airplane
-  end
-  
-end
-
-
---- @param #AI_CARGO_AIRPLANE self
--- @param Wrapper.Group#GROUP Airplane
--- @param Wrapper.Airbase#AIRBASE Airbase
--- @param #number Speed
-function AI_CARGO_AIRPLANE:Route( Airplane, Airbase, Speed )
+--- Route the airplane from one airport or it's current position to another airbase.
+-- @param #AI_CARGO_AIRPLANE self
+-- @param Wrapper.Group#GROUP Airplane Airplane group to be routed.
+-- @param Wrapper.Airbase#AIRBASE Airbase Destination airbase.
+-- @param #number Speed Speed in km/h. Default is 80% of max possible speed the group can do.
+-- @param #number Height Height in meters to move to the Airbase.
+-- @param #boolean Uncontrolled If true, spawn group in uncontrolled state.
+function AI_CARGO_AIRPLANE:Route( Airplane, Airbase, Speed, Height, Uncontrolled )
 
   if Airplane and Airplane:IsAlive() then
 
-    local PointVec3 = Airplane:GetPointVec3()
-  
-    local Takeoff = SPAWN.Takeoff.Hot
+    -- Set takeoff type.
+    local Takeoff = SPAWN.Takeoff.Cold
     
+    -- Get template of group.
     local Template = Airplane:GetTemplate()
-  
-    if Template then
+    
+    -- Nil check
+    if Template==nil then
+      return
+    end
 
-      local Points = {}
-      
-      if self.Airbase then
-  
-        local FromWaypoint = Template.route.points[1] 
+    -- Waypoints of the route.
+    local Points={}
     
-        -- These are only for ships.
-        FromWaypoint.linkUnit = nil
-        FromWaypoint.helipadId = nil
-        FromWaypoint.airdromeId = nil
+    -- To point.
+    local AirbasePointVec2 = Airbase:GetPointVec2()
+    local ToWaypoint = AirbasePointVec2:WaypointAir(
+      POINT_VEC3.RoutePointAltType.BARO,
+      "Land",
+      "Landing", 
+      Speed or Airplane:GetSpeedMax()*0.8
+    )    
+    ToWaypoint["airdromeId"]   = Airbase:GetID()
+    ToWaypoint["speed_locked"] = true
     
-        local AirbaseID = self.Airbase:GetID()
-        local AirbaseCategory = self.Airbase:GetDesc().category
-        
-        FromWaypoint.airdromeId = AirbaseID
-    
-        FromWaypoint.alt = 0
-                
-        FromWaypoint.type = GROUPTEMPLATE.Takeoff[Takeoff][1] -- type
-        FromWaypoint.action = GROUPTEMPLATE.Takeoff[Takeoff][2] -- action
-        
-    
-        -- Translate the position of the Group Template to the Vec3.
-        for UnitID = 1, #Template.units do
-          self:T( 'Before Translation SpawnTemplate.units['..UnitID..'].x = ' .. Template.units[UnitID].x .. ', SpawnTemplate.units['..UnitID..'].y = ' .. Template.units[UnitID].y )
-    
-          -- These cause a lot of confusion.
-          local UnitTemplate = Template.units[UnitID]
-    
-          UnitTemplate.parking = 15
-          UnitTemplate.parking_id = "1"
-          UnitTemplate.alt = 0
-    
-          local SX = UnitTemplate.x
-          local SY = UnitTemplate.y 
-          local BX = FromWaypoint.x
-          local BY = FromWaypoint.y
-          local TX = PointVec3.x + ( SX - BX )
-          local TY = PointVec3.z + ( SY - BY )
-          
-          UnitTemplate.x = TX
-          UnitTemplate.y = TY
-          
-          self:T( 'After Translation SpawnTemplate.units['..UnitID..'].x = ' .. UnitTemplate.x .. ', SpawnTemplate.units['..UnitID..'].y = ' .. UnitTemplate.y )
-        end
-        
-        FromWaypoint.x = PointVec3.x
-        FromWaypoint.y = PointVec3.z
 
-        Points[#Points+1] = FromWaypoint
-      else
-        
-        local GroupPoint = Airplane:GetVec2()
-        local GroupVelocity = Airplane:GetUnit(1):GetDesc().speedMax
+    -- If self.Airbase~=nil then group is currently at an airbase, where it should be respawned.        
+    if self.Airbase then
     
-        local FromWaypoint = {}
-        FromWaypoint.x = GroupPoint.x
-        FromWaypoint.y = GroupPoint.y
-        FromWaypoint.type = "Turning Point"
-        FromWaypoint.action = "Turning Point"
-        FromWaypoint.speed = GroupVelocity
+      -- Second point of the route. First point is done in RespawnAtCurrentAirbase() routine.
+      Template.route.points[2] = ToWaypoint
+    
+      -- Respawn group at the current airbase.
+      Airplane:RespawnAtCurrentAirbase(Template, Takeoff, Uncontrolled)
+      
+    else
+  
+      -- From point.
+      local GroupPoint = Airplane:GetVec2()
+      local FromWaypoint = {}
+      FromWaypoint.x      = GroupPoint.x
+      FromWaypoint.y      = GroupPoint.y
+      FromWaypoint.type   = "Turning Point"
+      FromWaypoint.action = "Turning Point"
+      FromWaypoint.speed  = Airplane:GetSpeedMax()*0.8
+ 
+      -- The two route points. 
+      Points[1] = FromWaypoint
+      Points[2] = ToWaypoint
 
-        Points[#Points+1] = FromWaypoint
-      end
-      
-      local AirbasePointVec2 = Airbase:GetPointVec2()
-      local ToWaypoint = AirbasePointVec2:WaypointAir(
-        POINT_VEC3.RoutePointAltType.BARO,
-        "Land",
-        "Landing", 
-        Speed or Airplane:GetUnit(1):GetDesc().speedMax
-      )
-      
-      ToWaypoint["airdromeId"] = Airbase:GetID()
-      ToWaypoint["speed_locked"] = true,
-  
-      self:F( ToWaypoint )
-      
-      Points[#Points+1] = ToWaypoint
-  
+      local PointVec3 = Airplane:GetPointVec3()
       Template.x = PointVec3.x
       Template.y = PointVec3.z
-      
-      self:T3( Points )
+ 
       Template.route.points = Points
-
-      --self:Respawn( Template )
-
-      local GroupSpawned = Airplane:Respawn( Template )
-      
-      return GroupSpawned
+            
+      local GroupSpawned = Airplane:Respawn(Template)
+    
     end
+  end
+end
 
+--- On after Home event. Aircraft will be routed to their home base.
+-- @param #AI_CARGO_AIRPLANE self
+-- @param Wrapper.Group#GROUP Airplane The cargo plane.
+-- @param From From state.
+-- @param Event Event.
+-- @param To To State.
+-- @param Core.Point#COORDINATE Coordinate Home place (not used).
+-- @param #number Speed Speed in km/h to fly to the home airbase (zone). Default is 80% of max possible speed the unit can go.
+-- @param #number Height Height in meters to move to the home coordinate.
+-- @param Core.Zone#ZONE_AIRBASE HomeZone The home airbase (zone) where the plane should return to.
+function AI_CARGO_AIRPLANE:onafterHome(Airplane, From, Event, To, Coordinate, Speed, Height, HomeZone )
+  if Airplane and Airplane:IsAlive() then
+
+    -- We are going home!
+    self.RouteHome = true
+       
+    -- Home Base.
+    local HomeBase=HomeZone:GetAirbase()
+    self.Airbase=HomeBase
+    
+    -- Now route the airplane home
+   self:Route( Airplane, HomeBase, Speed, Height )
+    
   end
   
 end

Moose Development/Moose/AI/AI_Cargo_Dispatcher_APC.lua

@@ -1,6 +1,6 @@
---- **AI** -- Models the intelligent transportation of infantry and other cargo using APCs.
+--- **AI** -- (2.4) - Models the intelligent transportation of infantry and other cargo using APCs.
 --
--- **Features:**
+-- ## Features:
 -- 
 --   * Quickly transport cargo to various deploy zones using ground vehicles (APCs, trucks ...).
 --   * Various @{Cargo.Cargo#CARGO} types can be transported. These are infantry groups and crates.
@@ -14,6 +14,15 @@
 --  
 -- ===
 -- 
+-- ## Test Missions:
+-- 
+-- Test missions can be located on the main GITHUB site.
+-- 
+-- [FlightControl-Master/MOOSE_MISSIONS/AID - AI Dispatching/AID-CGO - AI Cargo Dispatching/]  
+-- (https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/AID%20-%20AI%20Dispatching/AID-CGO%20-%20AI%20Cargo%20Dispatching)
+-- 
+-- ===
+-- 
 -- ### Author: **FlightControl**
 -- 
 -- ===       
@@ -28,54 +37,104 @@
 --- A dynamic cargo transportation capability for AI groups.
 -- 
 -- Armoured Personnel APCs (APC), Trucks, Jeeps and other carrier equipment can be mobilized to intelligently transport infantry and other cargo within the simulation.
--- The AI\_CARGO\_DISPATCHER\_APC module uses the @{Cargo} capabilities within the MOOSE framework.
--- CARGO derived objects must be declared within the mission to make the AI\_CARGO\_DISPATCHER\_APC object recognize the cargo.
--- Please consult the @{Cargo} module for more information. 
 -- 
--- ## 1. AI\_CARGO\_DISPATCHER\_APC constructor
+-- The AI_CARGO_DISPATCHER_APC module is derived from the AI_CARGO_DISPATCHER module.
+-- 
+-- ## Note! In order to fully understand the mechanisms of the AI_CARGO_DISPATCHER_APC class, it is recommended that you first consult and READ the documentation of the @{AI.AI_Cargo_Dispatcher} module!!!
+-- 
+-- Especially to learn how to **Tailor the different cargo handling events**, this will be very useful!
+-- 
+-- On top, the AI_CARGO_DISPATCHER_APC class uses the @{Cargo.Cargo} capabilities within the MOOSE framework.
+-- Also ensure that you fully understand how to declare and setup Cargo objects within the MOOSE framework before using this class.
+-- CARGO derived objects must be declared within the mission to make the AI_CARGO_DISPATCHER_HELICOPTER object recognize the cargo.
+-- 
+-- 
+-- # 1) AI_CARGO_DISPATCHER_APC constructor.
 --   
---   * @{#AI_CARGO_DISPATCHER\_APC.New}(): Creates a new AI\_CARGO\_DISPATCHER\_APC object.
+--   * @{#AI_CARGO_DISPATCHER_APC.New}(): Creates a new AI_CARGO_DISPATCHER_APC object.
 -- 
--- ## 2. AI\_CARGO\_DISPATCHER\_APC is a FSM
+-- ---
 -- 
--- ![Process](..\Presentations\AI_CARGO_DISPATCHER_APC\Dia3.JPG)
+-- # 2) AI_CARGO_DISPATCHER_APC is a Finite State Machine.
 -- 
--- ### 2.1. AI\_CARGO\_DISPATCHER\_APC States
+-- This section must be read as follows. Each of the rows indicate a state transition, triggered through an event, and with an ending state of the event was executed.
+-- The first column is the **From** state, the second column the **Event**, and the third column the **To** state.
+-- 
+-- So, each of the rows have the following structure.
+-- 
+--   * **From** => **Event** => **To**
+-- 
+-- Important to know is that an event can only be executed if the **current state** is the **From** state.
+-- This, when an **Event** that is being triggered has a **From** state that is equal to the **Current** state of the state machine, the event will be executed,
+-- and the resulting state will be the **To** state.
+-- 
+-- These are the different possible state transitions of this state machine implementation: 
+-- 
+--   * Idle => Start => Monitoring
+--   * Monitoring => Monitor => Monitoring
+--   * Monitoring => Stop => Idle
+--      
+--   * Monitoring => Pickup => Monitoring
+--   * Monitoring => Load => Monitoring
+--   * Monitoring => Loading => Monitoring
+--   * Monitoring => Loaded => Monitoring
+--   * Monitoring => PickedUp => Monitoring
+--   * Monitoring => Deploy => Monitoring
+--   * Monitoring => Unload => Monitoring
+--   * Monitoring => Unloaded => Monitoring
+--   * Monitoring => Deployed => Monitoring
+--   * Monitoring => Home => Monitoring
+-- 
+--      
+-- ## 2.1) AI_CARGO_DISPATCHER States.
 -- 
 --   * **Monitoring**: The process is dispatching.
 --   * **Idle**: The process is idle.
 -- 
--- ### 2.2. AI\_CARGO\_DISPATCHER\_APC Events
+-- ## 2.2) AI_CARGO_DISPATCHER Events.
 -- 
---   * **Monitor**: Monitor and take action.
 --   * **Start**: Start the transport process.
 --   * **Stop**: Stop the transport process.
+--   * **Monitor**: Monitor and take action.
+--   
 --   * **Pickup**: Pickup cargo.
 --   * **Load**: Load the cargo.
+--   * **Loading**: The dispatcher is coordinating the loading of a cargo.
 --   * **Loaded**: Flag that the cargo is loaded.
+--   * **PickedUp**: The dispatcher has loaded all requested cargo into the CarrierGroup.
 --   * **Deploy**: Deploy cargo to a location.
 --   * **Unload**: Unload the cargo.
 --   * **Unloaded**: Flag that the cargo is unloaded.
---   * **Home**: A APC is going home.
+--   * **Deployed**: All cargo is unloaded from the carriers in the group.
+--   * **Home**: A Carrier is going home.
 -- 
--- ## 3. Set the pickup parameters.
+-- ## 2.3) Enhance your mission scripts with **Tailored** Event Handling!
+-- 
+-- Within your mission, you can capture these events when triggered, and tailor the events with your own code!
+-- Check out the @{AI.AI_Cargo_Dispatcher#AI_CARGO_DISPATCHER} class at chapter 3 for details on the different event handlers that are available and how to use them.
+-- 
+-- **There are a lot of templates available that allows you to quickly setup an event handler for a specific event type!**
+-- 
+-- ---
+-- 
+-- # 3) Set the pickup parameters.
 -- 
 -- Several parameters can be set to pickup cargo:
 -- 
---    * @{#AI_CARGO_DISPATCHER\_APC.SetPickupRadius}(): Sets or randomizes the pickup location for the APC around the cargo coordinate in a radius defined an outer and optional inner radius. 
---    * @{#AI_CARGO_DISPATCHER\_APC.SetPickupSpeed}(): Set the speed or randomizes the speed in km/h to pickup the cargo.
+--    * @{#AI_CARGO_DISPATCHER_APC.SetPickupRadius}(): Sets or randomizes the pickup location for the APC around the cargo coordinate in a radius defined an outer and optional inner radius. 
+--    * @{#AI_CARGO_DISPATCHER_APC.SetPickupSpeed}(): Set the speed or randomizes the speed in km/h to pickup the cargo.
 --    
--- ## 4. Set the deploy parameters.
+-- # 4) Set the deploy parameters.
 -- 
 -- Several parameters can be set to deploy cargo:
 -- 
---    * @{#AI_CARGO_DISPATCHER\_APC.SetDeployRadius}(): Sets or randomizes the deploy location for the APC around the cargo coordinate in a radius defined an outer and an optional inner radius. 
---    * @{#AI_CARGO_DISPATCHER\_APC.SetDeploySpeed}(): Set the speed or randomizes the speed in km/h to deploy the cargo.
+--    * @{#AI_CARGO_DISPATCHER_APC.SetDeployRadius}(): Sets or randomizes the deploy location for the APC around the cargo coordinate in a radius defined an outer and an optional inner radius. 
+--    * @{#AI_CARGO_DISPATCHER_APC.SetDeploySpeed}(): Set the speed or randomizes the speed in km/h to deploy the cargo.
 -- 
--- ## 5. Set the home zone when there isn't any more cargo to pickup.
+-- # 5) Set the home zone when there isn't any more cargo to pickup.
 -- 
 -- A home zone can be specified to where the APCs will move when there isn't any cargo left for pickup.
--- Use @{#AI_CARGO_DISPATCHER\_APC.SetHomeZone}() to specify the home zone.
+-- Use @{#AI_CARGO_DISPATCHER_APC.SetHomeZone}() to specify the home zone.
 -- 
 -- If no home zone is specified, the APCs will wait near the deploy zone for a new pickup command.   
 -- 
@@ -88,35 +147,63 @@ AI_CARGO_DISPATCHER_APC = {
 
 --- Creates a new AI_CARGO_DISPATCHER_APC object.
 -- @param #AI_CARGO_DISPATCHER_APC self
--- @param Core.Set#SET_GROUP SetAPC The collection of APC @{Wrapper.Group}s.
--- @param Core.Set#SET_CARGO SetCargo The collection of @{Cargo} derived objects.
--- @param Core.Set#SET_ZONE SetDeployZone The collection of deploy @{Zone}s, which are used to where the cargo will be deployed by the APCs. 
+-- @param Core.Set#SET_GROUP APCSet The set of @{Wrapper.Group#GROUP} objects of vehicles, trucks, APCs that will transport the cargo.
+-- @param Core.Set#SET_CARGO CargoSet The set of @{Cargo.Cargo#CARGO} objects, which can be CARGO_GROUP, CARGO_CRATE, CARGO_SLINGLOAD objects.
+-- @param Core.Set#SET_ZONE PickupZoneSet (optional) The set of pickup zones, which are used to where the cargo can be picked up by the APCs. If nil, then cargo can be picked up everywhere. 
+-- @param Core.Set#SET_ZONE DeployZoneSet The set of deploy zones, which are used to where the cargo will be deployed by the APCs. 
 -- @param DCS#Distance CombatRadius The cargo will be unloaded from the APC and engage the enemy if the enemy is within CombatRadius range. The radius is in meters, the default value is 500 meters.
 -- @return #AI_CARGO_DISPATCHER_APC
 -- @usage
 -- 
--- -- Create a new cargo dispatcher for the set of APCs, with a combatradius of 500.
--- SetAPC = SET_GROUP:New():FilterPrefixes( "APC" ):FilterStart()
--- SetCargo = SET_CARGO:New():FilterTypes( "Infantry" ):FilterStart()
--- SetDeployZone = SET_ZONE:New():FilterPrefixes( "Deploy" ):FilterStart()
--- AICargoDispatcher = AI_CARGO_DISPATCHER_APC:New( SetAPC, SetCargo, SetDeployZone, 500 )
+--      -- An AI dispatcher object for a vehicle squadron, moving infantry from pickup zones to deploy zones.
 -- 
-function AI_CARGO_DISPATCHER_APC:New( SetAPC, SetCargo, SetDeployZone, CombatRadius )
+--      local SetCargoInfantry = SET_CARGO:New():FilterTypes( "Infantry" ):FilterStart()
+--      local SetAPC = SET_GROUP:New():FilterPrefixes( "APC" ):FilterStart()
+--      local SetDeployZones = SET_ZONE:New():FilterPrefixes( "Deploy" ):FilterStart()
+--      
+--      AICargoDispatcherAPC = AI_CARGO_DISPATCHER_APC:New( SetAPC, SetCargoInfantry, nil, SetDeployZones ) 
+--      AICargoDispatcherAPC:Start()
+-- 
+function AI_CARGO_DISPATCHER_APC:New( APCSet, CargoSet, PickupZoneSet, DeployZoneSet, CombatRadius )
 
-  local self = BASE:Inherit( self, AI_CARGO_DISPATCHER:New( SetAPC, SetCargo, SetDeployZone ) ) -- #AI_CARGO_DISPATCHER_APC
+  local self = BASE:Inherit( self, AI_CARGO_DISPATCHER:New( APCSet, CargoSet, PickupZoneSet, DeployZoneSet ) ) -- #AI_CARGO_DISPATCHER_APC
 
-  self.CombatRadius = CombatRadius or 500
-
-  self:SetDeploySpeed( 70, 120 )
-  self:SetPickupSpeed( 70, 120 )
+  self:SetDeploySpeed( 120, 70 )
+  self:SetPickupSpeed( 120, 70 )
   self:SetPickupRadius( 0, 0 )
   self:SetDeployRadius( 0, 0 )
+  
+  self:SetPickupHeight()
+  self:SetDeployHeight()
+  
+  self:SetCombatRadius( CombatRadius )
 
   return self
 end
 
+function AI_CARGO_DISPATCHER_APC:AICargo( APC, CargoSet )
 
-function AI_CARGO_DISPATCHER_APC:AICargo( APC, SetCargo )
-
-  return AI_CARGO_APC:New( APC, SetCargo, self.CombatRadius )
+  return AI_CARGO_APC:New( APC, CargoSet, self.CombatRadius )
 end
+
+--- Enable/Disable unboarding of cargo (infantry) when enemies are nearby (to help defend the carrier).
+-- This is only valid for APCs and trucks etc, thus ground vehicles.
+-- @param #AI_CARGO_DISPATCHER_APC self
+-- @param #number CombatRadius Provide the combat radius to defend the carrier by unboarding the cargo when enemies are nearby. 
+-- When the combat radius is 0, no defense will happen of the carrier. 
+-- When the combat radius is not provided, no defense will happen!
+-- @return #AI_CARGO_DISPATCHER_APC
+-- @usage
+-- 
+-- -- Disembark the infantry when the carrier is under attack.
+-- AICargoDispatcher:SetCombatRadius( true )
+-- 
+-- -- Keep the cargo in the carrier when the carrier is under attack.
+-- AICargoDispatcher:SetCombatRadius( false )
+function AI_CARGO_DISPATCHER_APC:SetCombatRadius( CombatRadius )
+
+  self.CombatRadius = CombatRadius or 0
+
+  return self
+end
+

Moose Development/Moose/AI/AI_Cargo_Dispatcher_Airplane.lua

@@ -1,5 +1,19 @@
 --- **AI** -- (R2.4) - Models the intelligent transportation of infantry and other cargo using Planes.
 --
+-- ## Features:
+--
+--   * The airplanes will fly towards the pickup airbases to pickup the cargo.
+--   * The airplanes will fly towards the deploy airbases to deploy the cargo.
+--   
+-- ===
+-- 
+-- ## Test Missions:
+-- 
+-- Test missions can be located on the main GITHUB site.
+-- 
+-- [FlightControl-Master/MOOSE_MISSIONS/AID - AI Dispatching/AID-CGO - AI Cargo Dispatching/]  
+-- (https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/AID%20-%20AI%20Dispatching/AID-CGO%20-%20AI%20Cargo%20Dispatching)
+-- 
 -- ===
 -- 
 -- ### Author: **FlightControl**
@@ -8,7 +22,8 @@
 --
 -- @module AI.AI_Cargo_Dispatcher_Airplane
 -- @image AI_Cargo_Dispatching_For_Airplanes.JPG
--- 
+
+
 --- @type AI_CARGO_DISPATCHER_AIRPLANE
 -- @extends AI.AI_Cargo_Dispatcher#AI_CARGO_DISPATCHER
 
@@ -16,9 +31,82 @@
 --- Brings a dynamic cargo handling capability for AI groups.
 -- 
 -- Airplanes can be mobilized to intelligently transport infantry and other cargo within the simulation.
--- The AI\_CARGO\_DISPATCHER\_AIRPLANE module uses the @{Cargo} capabilities within the MOOSE framework.
--- CARGO derived objects must be declared within the mission to make the AI\_CARGO\_DISPATCHER\_AIRPLANE object recognize the cargo.
--- Please consult the @{Cargo} module for more information. 
+-- 
+-- The AI_CARGO_DISPATCHER_AIRPLANE module is derived from the AI_CARGO_DISPATCHER module.
+-- 
+-- ## Note! In order to fully understand the mechanisms of the AI_CARGO_DISPATCHER_AIRPLANE class, it is recommended that you first consult and READ the documentation of the @{AI.AI_Cargo_Dispatcher} module!!!**
+-- 
+-- Especially to learn how to **Tailor the different cargo handling events**, this will be very useful!
+-- 
+-- On top, the AI_CARGO_DISPATCHER_AIRPLANE class uses the @{Cargo.Cargo} capabilities within the MOOSE framework.
+-- Also ensure that you fully understand how to declare and setup Cargo objects within the MOOSE framework before using this class.
+-- CARGO derived objects must be declared within the mission to make the AI_CARGO_DISPATCHER_HELICOPTER object recognize the cargo.
+-- 
+-- # 1) AI_CARGO_DISPATCHER_AIRPLANE constructor.
+--   
+--   * @{#AI_CARGO_DISPATCHER_AIRPLANE.New}(): Creates a new AI_CARGO_DISPATCHER_AIRPLANE object.
+-- 
+-- ---
+-- 
+-- # 2) AI_CARGO_DISPATCHER_AIRPLANE is a Finite State Machine.
+-- 
+-- This section must be read as follows. Each of the rows indicate a state transition, triggered through an event, and with an ending state of the event was executed.
+-- The first column is the **From** state, the second column the **Event**, and the third column the **To** state.
+-- 
+-- So, each of the rows have the following structure.
+-- 
+--   * **From** => **Event** => **To**
+-- 
+-- Important to know is that an event can only be executed if the **current state** is the **From** state.
+-- This, when an **Event** that is being triggered has a **From** state that is equal to the **Current** state of the state machine, the event will be executed,
+-- and the resulting state will be the **To** state.
+-- 
+-- These are the different possible state transitions of this state machine implementation: 
+-- 
+--   * Idle => Start => Monitoring
+--   * Monitoring => Monitor => Monitoring
+--   * Monitoring => Stop => Idle
+--      
+--   * Monitoring => Pickup => Monitoring
+--   * Monitoring => Load => Monitoring
+--   * Monitoring => Loading => Monitoring
+--   * Monitoring => Loaded => Monitoring
+--   * Monitoring => PickedUp => Monitoring
+--   * Monitoring => Deploy => Monitoring
+--   * Monitoring => Unload => Monitoring
+--   * Monitoring => Unloaded => Monitoring
+--   * Monitoring => Deployed => Monitoring
+--   * Monitoring => Home => Monitoring
+-- 
+--      
+-- ## 2.1) AI_CARGO_DISPATCHER States.
+-- 
+--   * **Monitoring**: The process is dispatching.
+--   * **Idle**: The process is idle.
+-- 
+-- ## 2.2) AI_CARGO_DISPATCHER Events.
+-- 
+--   * **Start**: Start the transport process.
+--   * **Stop**: Stop the transport process.
+--   * **Monitor**: Monitor and take action.
+--   
+--   * **Pickup**: Pickup cargo.
+--   * **Load**: Load the cargo.
+--   * **Loading**: The dispatcher is coordinating the loading of a cargo.
+--   * **Loaded**: Flag that the cargo is loaded.
+--   * **PickedUp**: The dispatcher has loaded all requested cargo into the CarrierGroup.
+--   * **Deploy**: Deploy cargo to a location.
+--   * **Unload**: Unload the cargo.
+--   * **Unloaded**: Flag that the cargo is unloaded.
+--   * **Deployed**: All cargo is unloaded from the carriers in the group.
+--   * **Home**: A Carrier is going home.
+-- 
+-- ## 2.3) Enhance your mission scripts with **Tailored** Event Handling!
+-- 
+-- Within your mission, you can capture these events when triggered, and tailor the events with your own code!
+-- Check out the @{AI.AI_Cargo_Dispatcher#AI_CARGO_DISPATCHER} class at chapter 3 for details on the different event handlers that are available and how to use them.
+-- 
+-- **There are a lot of templates available that allows you to quickly setup an event handler for a specific event type!**
 -- 
 -- 
 -- 
@@ -29,23 +117,48 @@ AI_CARGO_DISPATCHER_AIRPLANE = {
 
 --- Creates a new AI_CARGO_DISPATCHER_AIRPLANE object.
 -- @param #AI_CARGO_DISPATCHER_AIRPLANE self
--- @param Core.Set#SET_GROUP SetAirplane
--- @param Core.Set#SET_CARGO SetCargo
--- @param Core.Set#SET_ZONE SetDeployZone
--- @return #AI_CARGO_DISPATCHER_AIRPLANE
+-- @param Core.Set#SET_GROUP AirplaneSet The set of @{Wrapper.Group#GROUP} objects of airplanes that will transport the cargo.
+-- @param Core.Set#SET_CARGO CargoSet The set of @{Cargo.Cargo#CARGO} objects, which can be CARGO_GROUP, CARGO_CRATE, CARGO_SLINGLOAD objects.
+-- @param Core.Zone#SET_ZONE PickupZoneSet The set of zone airbases where the cargo has to be picked up.
+-- @param Core.Zone#SET_ZONE DeployZoneSet The set of zone airbases where the cargo is deployed. Choice for each cargo is random.
+-- @return #AI_CARGO_DISPATCHER_AIRPLANE self
 -- @usage
 -- 
--- -- Create a new cargo dispatcher
--- SetAirplane = SET_GROUP:New():FilterPrefixes( "Airplane" ):FilterStart()
--- SetCargo = SET_CARGO:New():FilterTypes( "Infantry" ):FilterStart()
--- SetDeployZone = SET_ZONE:New():FilterPrefixes( "Deploy" ):FilterStart()
--- AICargoDispatcher = AI_CARGO_DISPATCHER_AIRPLANE:New( SetAirplane, SetCargo )
+--      -- An AI dispatcher object for an airplane squadron, moving infantry and vehicles from pickup airbases to deploy airbases.
+--   
+--      local CargoInfantrySet = SET_CARGO:New():FilterTypes( "Infantry" ):FilterStart()
+--      local AirplanesSet = SET_GROUP:New():FilterPrefixes( "Airplane" ):FilterStart()
+--      local PickupZoneSet = SET_ZONE:New()
+--      local DeployZoneSet = SET_ZONE:New()
+--      
+--      PickupZoneSet:AddZone( ZONE_AIRBASE:New( AIRBASE.Caucasus.Gudauta ) )
+--      DeployZoneSet:AddZone( ZONE_AIRBASE:New( AIRBASE.Caucasus.Sochi_Adler ) )
+--      DeployZoneSet:AddZone( ZONE_AIRBASE:New( AIRBASE.Caucasus.Maykop_Khanskaya ) )
+--      DeployZoneSet:AddZone( ZONE_AIRBASE:New( AIRBASE.Caucasus.Mineralnye_Vody ) )
+--      DeployZoneSet:AddZone( ZONE_AIRBASE:New( AIRBASE.Caucasus.Vaziani ) )
+--      
+--      AICargoDispatcherAirplanes = AI_CARGO_DISPATCHER_AIRPLANE:New( AirplanesSet, CargoInfantrySet, PickupZoneSet, DeployZoneSet ) 
+--      AICargoDispatcherAirplanes:Start()
 -- 
-function AI_CARGO_DISPATCHER_AIRPLANE:New( SetAirplane, SetCargo, SetDeployZones )
+function AI_CARGO_DISPATCHER_AIRPLANE:New( AirplaneSet, CargoSet, PickupZoneSet, DeployZoneSet )
 
-  local self = BASE:Inherit( self, AI_CARGO_DISPATCHER:New( SetAirplane, SetCargo, SetDeployZones ) ) -- #AI_CARGO_DISPATCHER_AIRPLANE
+  local self = BASE:Inherit( self, AI_CARGO_DISPATCHER:New( AirplaneSet, CargoSet, PickupZoneSet, DeployZoneSet ) ) -- #AI_CARGO_DISPATCHER_AIRPLANE
+
+  self:SetPickupSpeed( 1200, 600 )
+  self:SetDeploySpeed( 1200, 600 )
+  
+  self:SetPickupRadius( 0, 0 )
+  self:SetDeployRadius( 0, 0 )
+
+  self:SetPickupHeight( 8000, 6000 )  
+  self:SetDeployHeight( 8000, 6000 )
+    
+  self:SetMonitorTimeInterval( 600 )
 
   return self
 end
 
+function AI_CARGO_DISPATCHER_AIRPLANE:AICargo( Airplane, CargoSet )
 
+  return AI_CARGO_AIRPLANE:New( Airplane, CargoSet )
+end

Moose Development/Moose/AI/AI_Cargo_Dispatcher_Helicopter.lua

@@ -1,7 +1,21 @@
---- **AI** -- Models the intelligent transportation of infantry and other cargo using Helicopters.
---
--- The @{#AI_CARGO_DISPATCHER_HELICOPTER} classes implements the dynamic dispatching of cargo transportation tasks for helicopters.
+--- **AI** -- (2.4) - Models the intelligent transportation of infantry and other cargo using Helicopters.
 --
+-- ## Features:
+-- 
+--   * The helicopters will fly towards the pickup locations to pickup the cargo.
+--   * The helicopters will fly towards the deploy zones to deploy the cargo.
+--   * Precision deployment as well as randomized deployment within the deploy zones are possible.
+--   * Helicopters will orbit the deploy zones when there is no space for landing until the deploy zone is free.
+--   
+-- ===
+-- 
+-- ## Test Missions:
+-- 
+-- Test missions can be located on the main GITHUB site.
+-- 
+-- [FlightControl-Master/MOOSE_MISSIONS/AID - AI Dispatching/AID-CGO - AI Cargo Dispatching/]  
+-- (https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/AID%20-%20AI%20Dispatching/AID-CGO%20-%20AI%20Cargo%20Dispatching)
+-- 
 -- ===
 -- 
 -- ### Author: **FlightControl**
@@ -18,39 +32,85 @@
 --- A dynamic cargo handling capability for AI helicopter groups.
 -- 
 -- Helicopters can be mobilized to intelligently transport infantry and other cargo within the simulation.
--- The AI\_CARGO\_DISPATCHER\_HELICOPTER module uses the @{Cargo} capabilities within the MOOSE framework.
--- CARGO derived objects must be declared within the mission to make the AI\_CARGO\_DISPATCHER\_HELICOPTER object recognize the cargo.
--- Please consult the @{Cargo} module for more information. 
+-- 
+-- 
+-- The AI_CARGO_DISPATCHER_HELICOPTER module is derived from the AI_CARGO_DISPATCHER module.
+-- 
+-- ## Note! In order to fully understand the mechanisms of the AI_CARGO_DISPATCHER_HELICOPTER class, it is recommended that you first consult and READ the documentation of the @{AI.AI_Cargo_Dispatcher} module!!!**
+-- 
+-- Especially to learn how to **Tailor the different cargo handling events**, this will be very useful!
+-- 
+-- On top, the AI_CARGO_DISPATCHER_HELICOPTER class uses the @{Cargo.Cargo} capabilities within the MOOSE framework.
+-- Also ensure that you fully understand how to declare and setup Cargo objects within the MOOSE framework before using this class.
+-- CARGO derived objects must be declared within the mission to make the AI_CARGO_DISPATCHER_HELICOPTER object recognize the cargo.
 -- 
 -- ---
 -- 
--- ## 1. AI\_CARGO\_DISPATCHER\_HELICOPTER constructor
+-- # 1. AI\_CARGO\_DISPATCHER\_HELICOPTER constructor.
 --   
 --   * @{#AI_CARGO_DISPATCHER\_HELICOPTER.New}(): Creates a new AI\_CARGO\_DISPATCHER\_HELICOPTER object.
 -- 
 -- ---
 -- 
--- ## 2. AI\_CARGO\_DISPATCHER\_HELICOPTER is a FSM
+-- # 2. AI\_CARGO\_DISPATCHER\_HELICOPTER is a Finite State Machine.
 -- 
--- ![Process](..\Presentations\AI_CARGO_DISPATCHER_HELICOPTER\Dia3.JPG)
+-- This section must be read as follows. Each of the rows indicate a state transition, triggered through an event, and with an ending state of the event was executed.
+-- The first column is the **From** state, the second column the **Event**, and the third column the **To** state.
 -- 
--- ### 2.1. AI\_CARGO\_DISPATCHER\_HELICOPTER States
+-- So, each of the rows have the following structure.
+-- 
+--   * **From** => **Event** => **To**
+-- 
+-- Important to know is that an event can only be executed if the **current state** is the **From** state.
+-- This, when an **Event** that is being triggered has a **From** state that is equal to the **Current** state of the state machine, the event will be executed,
+-- and the resulting state will be the **To** state.
+-- 
+-- These are the different possible state transitions of this state machine implementation: 
+-- 
+--   * Idle => Start => Monitoring
+--   * Monitoring => Monitor => Monitoring
+--   * Monitoring => Stop => Idle
+--      
+--   * Monitoring => Pickup => Monitoring
+--   * Monitoring => Load => Monitoring
+--   * Monitoring => Loading => Monitoring
+--   * Monitoring => Loaded => Monitoring
+--   * Monitoring => PickedUp => Monitoring
+--   * Monitoring => Deploy => Monitoring
+--   * Monitoring => Unload => Monitoring
+--   * Monitoring => Unloaded => Monitoring
+--   * Monitoring => Deployed => Monitoring
+--   * Monitoring => Home => Monitoring
+-- 
+--      
+-- ## 2.1) AI_CARGO_DISPATCHER States.
 -- 
 --   * **Monitoring**: The process is dispatching.
 --   * **Idle**: The process is idle.
 -- 
--- ### 2.2. AI\_CARGO\_DISPATCHER\_HELICOPTER Events
+-- ## 2.2) AI_CARGO_DISPATCHER Events.
 -- 
---   * **Monitor**: Monitor and take action.
 --   * **Start**: Start the transport process.
 --   * **Stop**: Stop the transport process.
+--   * **Monitor**: Monitor and take action.
+--   
 --   * **Pickup**: Pickup cargo.
 --   * **Load**: Load the cargo.
+--   * **Loading**: The dispatcher is coordinating the loading of a cargo.
 --   * **Loaded**: Flag that the cargo is loaded.
+--   * **PickedUp**: The dispatcher has loaded all requested cargo into the CarrierGroup.
 --   * **Deploy**: Deploy cargo to a location.
 --   * **Unload**: Unload the cargo.
 --   * **Unloaded**: Flag that the cargo is unloaded.
---   * **Home**: A Helicopter is going home.
+--   * **Deployed**: All cargo is unloaded from the carriers in the group.
+--   * **Home**: A Carrier is going home.
+-- 
+-- ## 2.3) Enhance your mission scripts with **Tailored** Event Handling!
+-- 
+-- Within your mission, you can capture these events when triggered, and tailor the events with your own code!
+-- Check out the @{AI.AI_Cargo_Dispatcher#AI_CARGO_DISPATCHER} class at chapter 3 for details on the different event handlers that are available and how to use them.
+-- 
+-- **There are a lot of templates available that allows you to quickly setup an event handler for a specific event type!**
 -- 
 -- ---
 -- 
@@ -58,8 +118,9 @@
 -- 
 -- Several parameters can be set to pickup cargo:
 -- 
---    * @{#AI_CARGO_DISPATCHER\_HELICOPTER.SetPickupRadius}(): Sets or randomizes the pickup location for the helicopter around the cargo coordinate in a radius defined an outer and optional inner radius. 
---    * @{#AI_CARGO_DISPATCHER\_HELICOPTER.SetPickupSpeed}(): Set the speed or randomizes the speed in km/h to pickup the cargo.
+--    * @{#AI_CARGO_DISPATCHER_HELICOPTER.SetPickupRadius}(): Sets or randomizes the pickup location for the helicopter around the cargo coordinate in a radius defined an outer and optional inner radius. 
+--    * @{#AI_CARGO_DISPATCHER_HELICOPTER.SetPickupSpeed}(): Set the speed or randomizes the speed in km/h to pickup the cargo.
+--    * @{#AI_CARGO_DISPATCHER_HELICOPTER.SetPickupHeight}(): Set the height or randomizes the height in meters to pickup the cargo.
 -- 
 -- ---   
 --    
@@ -67,15 +128,16 @@
 -- 
 -- Several parameters can be set to deploy cargo:
 -- 
---    * @{#AI_CARGO_DISPATCHER\_HELICOPTER.SetDeployRadius}(): Sets or randomizes the deploy location for the helicopter around the cargo coordinate in a radius defined an outer and an optional inner radius. 
---    * @{#AI_CARGO_DISPATCHER\_HELICOPTER.SetDeploySpeed}(): Set the speed or randomizes the speed in km/h to deploy the cargo.
+--    * @{#AI_CARGO_DISPATCHER_HELICOPTER.SetDeployRadius}(): Sets or randomizes the deploy location for the helicopter around the cargo coordinate in a radius defined an outer and an optional inner radius. 
+--    * @{#AI_CARGO_DISPATCHER_HELICOPTER.SetDeploySpeed}(): Set the speed or randomizes the speed in km/h to deploy the cargo.
+--    * @{#AI_CARGO_DISPATCHER_HELICOPTER.SetDeployHeight}(): Set the height or randomizes the height in meters to deploy the cargo.
 -- 
 -- ---
 -- 
 -- ## 5. Set the home zone when there isn't any more cargo to pickup.
 -- 
 -- A home zone can be specified to where the Helicopters will move when there isn't any cargo left for pickup.
--- Use @{#AI_CARGO_DISPATCHER\_HELICOPTER.SetHomeZone}() to specify the home zone.
+-- Use @{#AI_CARGO_DISPATCHER_HELICOPTER.SetHomeZone}() to specify the home zone.
 -- 
 -- If no home zone is specified, the helicopters will wait near the deploy zone for a new pickup command.   
 -- 
@@ -88,32 +150,42 @@ AI_CARGO_DISPATCHER_HELICOPTER = {
 
 --- Creates a new AI_CARGO_DISPATCHER_HELICOPTER object.
 -- @param #AI_CARGO_DISPATCHER_HELICOPTER self
--- @param Core.Set#SET_GROUP SetHelicopter The collection of Helicopter @{Wrapper.Group}s.
--- @param Core.Set#SET_CARGO SetCargo The collection of @{Cargo} derived objects.
--- @param Core.Set#SET_ZONE SetDeployZones The collection of deploy @{Zone}s, which are used to where the cargo will be deployed by the Helicopters. 
+-- @param Core.Set#SET_GROUP HelicopterSet The set of @{Wrapper.Group#GROUP} objects of helicopters that will transport the cargo.
+-- @param Core.Set#SET_CARGO CargoSet The set of @{Cargo.Cargo#CARGO} objects, which can be CARGO_GROUP, CARGO_CRATE, CARGO_SLINGLOAD objects.
+-- @param Core.Set#SET_ZONE PickupZoneSet (optional) The set of pickup zones, which are used to where the cargo can be picked up by the APCs. If nil, then cargo can be picked up everywhere. 
+-- @param Core.Set#SET_ZONE DeployZoneSet The set of deploy zones, which are used to where the cargo will be deployed by the Helicopters. 
 -- @return #AI_CARGO_DISPATCHER_HELICOPTER
 -- @usage
 -- 
--- -- Create a new cargo dispatcher
--- SetHelicopter = SET_GROUP:New():FilterPrefixes( "Helicopter" ):FilterStart()
--- SetCargo = SET_CARGO:New():FilterTypes( "Infantry" ):FilterStart()
--- SetDeployZone = SET_ZONE:New():FilterPrefixes( "Deploy" ):FilterStart()
--- AICargoDispatcher = AI_CARGO_DISPATCHER_HELICOPTER:New( SetHelicopter, SetCargo )
+--      -- An AI dispatcher object for a helicopter squadron, moving infantry from pickup zones to deploy zones.
 -- 
-function AI_CARGO_DISPATCHER_HELICOPTER:New( SetHelicopter, SetCargo, SetDeployZones )
+--      local SetCargoInfantry = SET_CARGO:New():FilterTypes( "Infantry" ):FilterStart()
+--      local SetHelicopter = SET_GROUP:New():FilterPrefixes( "Helicopter" ):FilterStart()
+--      local SetPickupZones = SET_ZONE:New():FilterPrefixes( "Pickup" ):FilterStart()
+--      local SetDeployZones = SET_ZONE:New():FilterPrefixes( "Deploy" ):FilterStart()
+--      
+--      AICargoDispatcherHelicopter = AI_CARGO_DISPATCHER_HELICOPTER:New( SetHelicopter, SetCargoInfantry, SetPickupZones, SetDeployZones ) 
+--      AICargoDispatcherHelicopter:Start()
+-- 
+function AI_CARGO_DISPATCHER_HELICOPTER:New( HelicopterSet, CargoSet, PickupZoneSet, DeployZoneSet )
 
-  local self = BASE:Inherit( self, AI_CARGO_DISPATCHER:New( SetHelicopter, SetCargo, SetDeployZones ) ) -- #AI_CARGO_DISPATCHER_HELICOPTER
+  local self = BASE:Inherit( self, AI_CARGO_DISPATCHER:New( HelicopterSet, CargoSet, PickupZoneSet, DeployZoneSet ) ) -- #AI_CARGO_DISPATCHER_HELICOPTER
+
+  self:SetPickupSpeed( 350, 150 )
+  self:SetDeploySpeed( 350, 150 )
 
-  self:SetDeploySpeed( 200, 150 )
-  self:SetPickupSpeed( 200, 150 )
   self:SetPickupRadius( 0, 0 )
   self:SetDeployRadius( 0, 0 )
   
+  self:SetPickupHeight( 500, 200 )
+  self:SetDeployHeight( 500, 200 )
+  
   return self
 end
 
-function AI_CARGO_DISPATCHER_HELICOPTER:AICargo( Helicopter, SetCargo )
 
-  return AI_CARGO_HELICOPTER:New( Helicopter, SetCargo )
+function AI_CARGO_DISPATCHER_HELICOPTER:AICargo( Helicopter, CargoSet )
+
+  return AI_CARGO_HELICOPTER:New( Helicopter, CargoSet )
 end
 

Moose Development/Moose/AI/AI_Cargo_Helicopter.lua

@@ -1,4 +1,4 @@
---- **AI** -- (R2.3) - Models the intelligent transportation of infantry (cargo).
+--- **AI** -- (R2.4) - Models the intelligent transportation of infantry (cargo).
 --
 -- ===
 -- 
@@ -13,14 +13,41 @@
 -- @extends Core.Fsm#FSM_CONTROLLABLE
 
 
---- # AI\_CARGO\_TROOPS class, extends @{Core.Fsm#FSM_CONTROLLABLE}
+--- Brings a dynamic cargo handling capability for an AI helicopter group.
+--  
+-- Helicopter carriers can be mobilized to intelligently transport infantry and other cargo within the simulation.
+-- 
+-- The AI_CARGO_HELICOPTER class uses the @{Cargo.Cargo} capabilities within the MOOSE framework.
+-- @{Cargo.Cargo} must be declared within the mission to make the AI_CARGO_HELICOPTER object recognize the cargo.
+-- Please consult the @{Cargo.Cargo} module for more information. 
+-- 
+-- ## Cargo pickup.
+--  
+-- Using the @{#AI_CARGO_HELICOPTER.Pickup}() method, you are able to direct the helicopters towards a point on the battlefield to board/load the cargo at the specific coordinate. 
+-- Ensure that the landing zone is horizontally flat, and that trees cannot be found in the landing vicinity, or the helicopters won't land or will even crash!
+-- 
+-- ## Cargo deployment.
+--  
+-- Using the @{#AI_CARGO_HELICOPTER.Deploy}() method, you are able to direct the helicopters towards a point on the battlefield to unboard/unload the cargo at the specific coordinate. 
+-- Ensure that the landing zone is horizontally flat, and that trees cannot be found in the landing vicinity, or the helicopters won't land or will even crash!
+-- 
+-- ## Infantry health.
+-- 
+-- When infantry is unboarded from the APCs, the infantry is actually respawned into the battlefield. 
+-- As a result, the unboarding infantry is very _healthy_ every time it unboards.
+-- This is due to the limitation of the DCS simulator, which is not able to specify the health of new spawned units as a parameter.
+-- However, infantry that was destroyed when unboarded, won't be respawned again. Destroyed is destroyed.
+-- As a result, there is some additional strength that is gained when an unboarding action happens, but in terms of simulation balance this has
+-- marginal impact on the overall battlefield simulation. Fortunately, the firing strength of infantry is limited, and thus, respacing healthy infantry every
+-- time is not so much of an issue ... 
+-- 
 -- 
 -- ===
 -- 
 -- @field #AI_CARGO_HELICOPTER
 AI_CARGO_HELICOPTER = {
   ClassName = "AI_CARGO_HELICOPTER",
-  Coordinate = nil -- Core.Point#COORDINATE,
+  Coordinate = nil, -- Core.Point#COORDINATE,
 }
 
 AI_CARGO_QUEUE = {}
@@ -32,10 +59,8 @@ AI_CARGO_QUEUE = {}
 -- @return #AI_CARGO_HELICOPTER
 function AI_CARGO_HELICOPTER:New( Helicopter, CargoSet )
 
-  local self = BASE:Inherit( self, FSM_CONTROLLABLE:New() ) -- #AI_CARGO_HELICOPTER
+  local self = BASE:Inherit( self, AI_CARGO:New( Helicopter, CargoSet ) ) -- #AI_CARGO_HELICOPTER
 
-  self.CargoSet = CargoSet -- Cargo.CargoGroup#CARGO_GROUP
-  
   self.Zone = ZONE_GROUP:New( Helicopter:GetName(), Helicopter, 300 )
 
   self:SetStartState( "Unloaded" ) 
@@ -43,12 +68,14 @@ function AI_CARGO_HELICOPTER:New( Helicopter, CargoSet )
   self:AddTransition( "Unloaded", "Pickup", "*" )
   self:AddTransition( "Loaded", "Deploy", "*" )
   
-  self:AddTransition( "Unloaded", "Load", "Boarding" )
+  self:AddTransition( { "Unloaded", "Loading" }, "Load", "Boarding" )
   self:AddTransition( "Boarding", "Board", "Boarding" )
-  self:AddTransition( "Boarding", "Loaded", "Loaded" )
+  self:AddTransition( "Boarding", "Loaded", "Boarding" )
+  self:AddTransition( "Boarding", "PickedUp", "Loaded" )
   self:AddTransition( "Loaded", "Unload", "Unboarding" )
   self:AddTransition( "Unboarding", "Unboard", "Unboarding" )
-  self:AddTransition( "Unboarding", "Unloaded", "Unloaded" )
+  self:AddTransition( "Unboarding", "Unloaded", "Unboarding" )
+  self:AddTransition( "Unboarding", "Deployed", "Unloaded" )
 
   self:AddTransition( "*", "Landed", "*" )
   self:AddTransition( "*", "Queue", "*" )
@@ -73,17 +100,20 @@ function AI_CARGO_HELICOPTER:New( Helicopter, CargoSet )
   -- @param #string Event
   -- @param #string To
   -- @param Core.Point#COORDINATE Coordinate
+  -- @param #number Speed Speed in km/h to drive to the pickup coordinate. Default is 50% of max possible speed the unit can go.
   
   --- Pickup Trigger for AI_CARGO_HELICOPTER
   -- @function [parent=#AI_CARGO_HELICOPTER] Pickup
   -- @param #AI_CARGO_HELICOPTER self
   -- @param Core.Point#COORDINATE Coordinate
+  -- @param #number Speed Speed in km/h to drive to the pickup coordinate. Default is 50% of max possible speed the unit can go.
   
   --- Pickup Asynchronous Trigger for AI_CARGO_HELICOPTER
   -- @function [parent=#AI_CARGO_HELICOPTER] __Pickup
   -- @param #AI_CARGO_HELICOPTER self
-  -- @param #number Delay
+  -- @param #number Delay Delay in seconds.
   -- @param Core.Point#COORDINATE Coordinate
+  -- @param #number Speed Speed in km/h to go to the pickup coordinate. Default is 50% of max possible speed the unit can go.
   
   --- Deploy Handler OnBefore for AI_CARGO_HELICOPTER
   -- @function [parent=#AI_CARGO_HELICOPTER] OnBeforeDeploy
@@ -91,7 +121,8 @@ function AI_CARGO_HELICOPTER:New( Helicopter, CargoSet )
   -- @param #string From
   -- @param #string Event
   -- @param #string To
-  -- @param Core.Point#COORDINATE Coordinate
+  -- @param Core.Point#COORDINATE Coordinate Place at which cargo is deployed.
+  -- @param #number Speed Speed in km/h to drive to the pickup coordinate. Default is 50% of max possible speed the unit can go.
   -- @return #boolean
   
   --- Deploy Handler OnAfter for AI_CARGO_HELICOPTER
@@ -101,18 +132,21 @@ function AI_CARGO_HELICOPTER:New( Helicopter, CargoSet )
   -- @param #string Event
   -- @param #string To
   -- @param Core.Point#COORDINATE Coordinate
+  -- @param #number Speed Speed in km/h to drive to the pickup coordinate. Default is 50% of max possible speed the unit can go.
   
   --- Deploy Trigger for AI_CARGO_HELICOPTER
   -- @function [parent=#AI_CARGO_HELICOPTER] Deploy
   -- @param #AI_CARGO_HELICOPTER self
-  -- @param Core.Point#COORDINATE Coordinate
+  -- @param Core.Point#COORDINATE Coordinate Place at which the cargo is deployed.
+  -- @param #number Speed Speed in km/h to drive to the pickup coordinate. Default is 50% of max possible speed the unit can go.
   
   --- Deploy Asynchronous Trigger for AI_CARGO_HELICOPTER
   -- @function [parent=#AI_CARGO_HELICOPTER] __Deploy
+  -- @param #number Delay Delay in seconds.
   -- @param #AI_CARGO_HELICOPTER self
-  -- @param Core.Point#COORDINATE Coordinate
-  -- @param #number Delay
-
+  -- @param Core.Point#COORDINATE Coordinate Place at which the cargo is deployed.
+  -- @param #number Speed Speed in km/h to drive to the pickup coordinate. Default is 50% of max possible speed the unit can go.
+  
 
   -- We need to capture the Crash events for the helicopters.
   -- The helicopter reference is used in the semaphore AI_CARGO_QUEUE.
@@ -142,15 +176,8 @@ function AI_CARGO_HELICOPTER:New( Helicopter, CargoSet )
   return self
 end
 
-function AI_CARGO_HELICOPTER:IsTransporting()
 
-  return self.Transporting == true
-end
 
-function AI_CARGO_HELICOPTER:IsRelocating()
-
-  return self.Relocating == true
-end
 
 
 --- Set the Carrier.
@@ -200,8 +227,6 @@ end
 -- @param From
 -- @param Event
 -- @param To
--- @param Core.Point#COORDINATE Coordinate
--- @param #number Speed
 function AI_CARGO_HELICOPTER:onafterLanded( Helicopter, From, Event, To )
 
   Helicopter:F( { Name = Helicopter:GetName() } )
@@ -219,18 +244,16 @@ function AI_CARGO_HELICOPTER:onafterLanded( Helicopter, From, Event, To )
 
     if self.RoutePickup == true then
       if Helicopter:GetHeight( true ) <= 5 and Helicopter:GetVelocityKMH() < 10 then
-        self:Load( Helicopter:GetPointVec2() )
+        --self:Load( Helicopter:GetPointVec2() )
+        self:Load( self.PickupZone )
         self.RoutePickup = false
-        self.Relocating = true
       end
     end
     
     if self.RouteDeploy == true then
       if Helicopter:GetHeight( true ) <= 5 and Helicopter:GetVelocityKMH() < 10 then
-        self:Unload( true )
+        self:Unload( self.DeployZone )
         self.RouteDeploy = false
-        self.Transporting = false
-        self.Relocating = false
       end
     end
      
@@ -245,7 +268,7 @@ end
 -- @param To
 -- @param Core.Point#COORDINATE Coordinate
 -- @param #number Speed
-function AI_CARGO_HELICOPTER:onafterQueue( Helicopter, From, Event, To, Coordinate )
+function AI_CARGO_HELICOPTER:onafterQueue( Helicopter, From, Event, To, Coordinate, Speed, DeployZone )
 
   local HelicopterInZone = false
 
@@ -254,7 +277,7 @@ function AI_CARGO_HELICOPTER:onafterQueue( Helicopter, From, Event, To, Coordina
     local Distance = Coordinate:DistanceFromPointVec2( Helicopter:GetCoordinate() )
     
     if Distance > 2000 then
-      self:__Queue( -10, Coordinate )
+      self:__Queue( -10, Coordinate, Speed, DeployZone )
     else
     
       local ZoneFree = true
@@ -303,8 +326,12 @@ function AI_CARGO_HELICOPTER:onafterQueue( Helicopter, From, Event, To, Coordina
     
         -- Now route the helicopter
         Helicopter:Route( Route, 0 )
+        
+        -- Keep the DeployZone, because when the helo has landed, we want to provide the DeployZone to the mission designer as part of the Unloaded event.
+        self.DeployZone = DeployZone
+        
       else
-        self:__Queue( -10, Coordinate )
+        self:__Queue( -10, Coordinate, Speed, DeployZone )
       end
     end
   else
@@ -324,193 +351,51 @@ function AI_CARGO_HELICOPTER:onafterOrbit( Helicopter, From, Event, To, Coordina
 
   if Helicopter and Helicopter:IsAlive() then
     
-    if not self:IsTransporting() then
-      local Route = {}
-      
-  --          local CoordinateFrom = Helicopter:GetCoordinate()
-  --          local WaypointFrom = CoordinateFrom:WaypointAir( 
-  --            "RADIO", 
-  --            POINT_VEC3.RoutePointType.TurningPoint, 
-  --            POINT_VEC3.RoutePointAction.TurningPoint, 
-  --            Speed, 
-  --            true 
-  --          )
-  --          Route[#Route+1] = WaypointFrom
-      local CoordinateTo   = Coordinate
-      local WaypointTo = CoordinateTo:WaypointAir( 
-        "RADIO", 
-        POINT_VEC3.RoutePointType.TurningPoint, 
-        POINT_VEC3.RoutePointAction.TurningPoint, 
-        50, 
-        true 
-      )
-      Route[#Route+1] = WaypointTo
-      
-      local Tasks = {}
-      Tasks[#Tasks+1] = Helicopter:TaskOrbitCircle( math.random( 30, 80 ), 150, CoordinateTo:GetRandomCoordinateInRadius( 800, 500 ) )
-      Route[#Route].task = Helicopter:TaskCombo( Tasks )
-  
-      Route[#Route+1] = WaypointTo
-  
-      -- Now route the helicopter
-      Helicopter:Route( Route, 0 )
-    end
-  end
-end
-
-
-
---- @param #AI_CARGO_HELICOPTER self
--- @param Wrapper.Group#GROUP Helicopter
-function AI_CARGO_HELICOPTER:onbeforeLoad( Helicopter, From, Event, To, Coordinate )
-
-  local Boarding = false
-
-  if Helicopter and Helicopter:IsAlive() then
-  
-    self.BoardingCount = 0
-  
-    if Helicopter and Helicopter:IsAlive() then
-      self.Helicopter_Cargo = {}
-      for _, HelicopterUnit in pairs( Helicopter:GetUnits() ) do
-        local HelicopterUnit = HelicopterUnit -- Wrapper.Unit#UNIT
-        for _, Cargo in pairs( self.CargoSet:GetSet() ) do
-          local Cargo = Cargo -- Cargo.Cargo#CARGO
-          self:F( { IsUnLoaded = Cargo:IsUnLoaded() } )
-          if Cargo:IsUnLoaded() then
-            if Cargo:IsInLoadRadius( HelicopterUnit:GetCoordinate() ) then
-              self:F( { "In radius", HelicopterUnit:GetName() } )
-              --Cargo:Ungroup()
-              Cargo:Board( HelicopterUnit, 25 )
-              self:__Board( 1, Cargo )
-              Boarding = true
-              
-              -- So now this APCUnit has Cargo that is being loaded.
-              -- This will be used further in the logic to follow and to check cargo status.
-              self.Helicopter_Cargo[HelicopterUnit] = Cargo
-              break
-            end
-          end
-        end
-      end
-    end
-  end
-
-  return Boarding
-  
-end
-
---- @param #AI_CARGO_HELICOPTER self
--- @param Wrapper.Group#GROUP Helicopter
-function AI_CARGO_HELICOPTER:onafterBoard( Helicopter, From, Event, To, Cargo )
-  self:F( { APC, From, Event, To, Cargo } )
-
-  if Helicopter and Helicopter:IsAlive() then
-    self:F({ IsLoaded = Cargo:IsLoaded() } )
-    if not Cargo:IsLoaded() then
-      self:__Board( 10, Cargo )
-    else
-      self:__Loaded( 1, Cargo )
-    end
-  end
-  
-end
-
---- @param #AI_CARGO_HELICOPTER self
--- @param Wrapper.Group#GROUP Helicopter
-function AI_CARGO_HELICOPTER:onbeforeLoaded( Helicopter, From, Event, To, Cargo )
-  self:F( { APC, From, Event, To } )
-  
-  local Loaded = true
-
-  if Helicopter and Helicopter:IsAlive() then
-    for HelicopterUnit, Cargo in pairs( self.Helicopter_Cargo ) do
-      local Cargo = Cargo -- Cargo.Cargo#CARGO
-      self:F( { IsLoaded = Cargo:IsLoaded(), IsDestroyed = Cargo:IsDestroyed() } )
-      if not Cargo:IsLoaded() and not Cargo:IsDestroyed() then
-        Loaded = false
-      end
-    end
+    local Route = {}
     
-  end
-  
-  return Loaded
-
-end
-
-
---- @param #AI_CARGO_HELICOPTER self
--- @param Wrapper.Group#GROUP Helicopter
-function AI_CARGO_HELICOPTER:onafterUnload( Helicopter, From, Event, To, Deployed )
-
-  if Helicopter and Helicopter:IsAlive() then
-    for _, HelicopterUnit in pairs( Helicopter:GetUnits() ) do
-      local HelicopterUnit = HelicopterUnit -- Wrapper.Unit#UNIT
-      for _, Cargo in pairs( HelicopterUnit:GetCargo() ) do
-        Cargo:UnBoard()
-        Cargo:SetDeployed( true )
-        self:__Unboard( 10, Cargo, Deployed )
-      end 
-    end
-  end
-
-  
-end
-
---- @param #AI_CARGO_HELICOPTER self
--- @param Wrapper.Group#GROUP Helicopter
-function AI_CARGO_HELICOPTER:onafterUnboard( Helicopter, From, Event, To, Cargo, Deployed )
-
-  if Helicopter and Helicopter:IsAlive() then
-    if not Cargo:IsUnLoaded() then
-      self:__Unboard( 10, Cargo, Deployed ) 
-    else
-      self:__Unloaded( 1, Cargo, Deployed )
-    end
-  end
-  
-end
-
---- @param #AI_CARGO_HELICOPTER self
--- @param Wrapper.Group#GROUP Helicopter
-function AI_CARGO_HELICOPTER:onbeforeUnloaded( Helicopter, From, Event, To, Cargo, Deployed )
-  self:F( { APC, From, Event, To, Cargo:GetName(), Deployed = Deployed } )
-
-  local AllUnloaded = true
-
-  --Cargo:Regroup()
-
-  if Helicopter and Helicopter:IsAlive() then
-    for _, HelicopterUnit in pairs( Helicopter:GetUnits() ) do
-      local CargoCheck = self.Helicopter_Cargo[HelicopterUnit] -- Cargo.Cargo#CARGO
-      if CargoCheck then
-        self:F( { CargoCheck:GetName(), IsUnLoaded = CargoCheck:IsUnLoaded() } )
-        if CargoCheck:IsUnLoaded() == false then
-          AllUnloaded = false
-          break
-        end
-      end
-    end
+--          local CoordinateFrom = Helicopter:GetCoordinate()
+--          local WaypointFrom = CoordinateFrom:WaypointAir( 
+--            "RADIO", 
+--            POINT_VEC3.RoutePointType.TurningPoint, 
+--            POINT_VEC3.RoutePointAction.TurningPoint, 
+--            Speed, 
+--            true 
+--          )
+--          Route[#Route+1] = WaypointFrom
+    local CoordinateTo   = Coordinate
+    local WaypointTo = CoordinateTo:WaypointAir( 
+      "RADIO", 
+      POINT_VEC3.RoutePointType.TurningPoint, 
+      POINT_VEC3.RoutePointAction.TurningPoint, 
+      50, 
+      true 
+    )
+    Route[#Route+1] = WaypointTo
     
-    if AllUnloaded == true then
-      if Deployed == true then
-        for HelicopterUnit, Cargo in pairs( self.Helicopter_Cargo ) do
-          local Cargo = Cargo -- Cargo.Cargo#CARGO
-        end
-        self.Helicopter_Cargo = {}
-      end
-      self.Helicopter = Helicopter
-    end
+    local Tasks = {}
+    Tasks[#Tasks+1] = Helicopter:TaskOrbitCircle( math.random( 30, 80 ), 150, CoordinateTo:GetRandomCoordinateInRadius( 800, 500 ) )
+    Route[#Route].task = Helicopter:TaskCombo( Tasks )
+
+    Route[#Route+1] = WaypointTo
+
+    -- Now route the helicopter
+    Helicopter:Route( Route, 0 )
   end
-  
-  self:F( { AllUnloaded = AllUnloaded } )
-  return AllUnloaded
-  
 end
 
---- @param #AI_CARGO_HELICOPTER self
+
+
+--- On after Deployed event.
+-- @param #AI_CARGO_HELICOPTER self
 -- @param Wrapper.Group#GROUP Helicopter
-function AI_CARGO_HELICOPTER:onafterUnloaded( Helicopter, From, Event, To, Cargo, Deployed )
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @param #string To To state.
+-- @param Cargo.Cargo#CARGO Cargo Cargo object.
+-- @param #boolean Deployed Cargo is deployed.
+-- @return #boolean True if all cargo has been unloaded.
+function AI_CARGO_HELICOPTER:onafterDeployed( Helicopter, From, Event, To, DeployZone )
+  self:F( { Helicopter, From, Event, To, DeployZone = DeployZone } )
 
   self:Orbit( Helicopter:GetCoordinate(), 50 )
 
@@ -520,24 +405,30 @@ function AI_CARGO_HELICOPTER:onafterUnloaded( Helicopter, From, Event, To, Cargo
       AI_CARGO_QUEUE[Helicopter] = nil
     end, Helicopter
   )
-
+  
+  self:GetParent( self, AI_CARGO_HELICOPTER ).onafterDeployed( self, Helicopter, From, Event, To, DeployZone )
+  
+  
 end
 
---- @param #AI_CARGO_HELICOPTER self
+--- On after Pickup event.
+-- @param #AI_CARGO_HELICOPTER self
 -- @param Wrapper.Group#GROUP Helicopter
 -- @param From
 -- @param Event
 -- @param To
--- @param Core.Point#COORDINATE Coordinate
+-- @param Core.Point#COORDINATE Coordinate Pickup place.
 -- @param #number Speed Speed in km/h to drive to the pickup coordinate. Default is 50% of max possible speed the unit can go.
-function AI_CARGO_HELICOPTER:onafterPickup( Helicopter, From, Event, To, Coordinate, Speed )
+-- @param #number Height Height in meters to move to the pickup coordinate. This parameter is ignored for APCs.
+-- @param Core.Zone#ZONE PickupZone (optional) The zone where the cargo will be picked up. The PickupZone can be nil, if there wasn't any PickupZoneSet provided.
+function AI_CARGO_HELICOPTER:onafterPickup( Helicopter, From, Event, To, Coordinate, Speed, Height, PickupZone )
 
   if Helicopter and Helicopter:IsAlive() ~= nil then
 
     Helicopter:Activate()
 
     self.RoutePickup = true
-    Coordinate.y = math.random( 50, 200 )
+    Coordinate.y = Height
     
     local _speed=Speed or Helicopter:GetSpeedMax()*0.5        
      
@@ -580,25 +471,33 @@ function AI_CARGO_HELICOPTER:onafterPickup( Helicopter, From, Event, To, Coordin
 
     -- Now route the helicopter
     Helicopter:Route( Route, 1 )
+    
+    self.PickupZone = PickupZone
+
+    self:GetParent( self, AI_CARGO_HELICOPTER ).onafterPickup( self, Helicopter, From, Event, To, Coordinate, Speed, Height, PickupZone )
 
-    self.Transporting = true
   end
   
 end
 
-
-function AI_CARGO_HELICOPTER:_Deploy( AICargoHelicopter, Coordinate )
-  AICargoHelicopter:__Queue( -10, Coordinate, 100 )
+--- Depoloy function and queue.
+-- @param #AI_CARGO_HELICOPTER self
+-- @param Wrapper.Group#GROUP AICargoHelicopter
+-- @param Core.Point#COORDINATE Coordinate Coordinate
+function AI_CARGO_HELICOPTER:_Deploy( AICargoHelicopter, Coordinate, DeployZone )
+  AICargoHelicopter:__Queue( -10, Coordinate, 100, DeployZone )
 end
 
---- @param #AI_CARGO_HELICOPTER self
--- @param Wrapper.Group#GROUP Helicopter
+--- On after Deploy event.
+-- @param #AI_CARGO_HELICOPTER self
+-- @param Wrapper.Group#GROUP Helicopter Transport helicopter.
 -- @param From
 -- @param Event
 -- @param To
--- @param Core.Point#COORDINATE Coordinate
+-- @param Core.Point#COORDINATE Coordinate Place at which the cargo is deployed.
 -- @param #number Speed Speed in km/h to drive to the pickup coordinate. Default is 50% of max possible speed the unit can go.
-function AI_CARGO_HELICOPTER:onafterDeploy( Helicopter, From, Event, To, Coordinate, Speed )
+-- @param #number Height Height in meters to move to the deploy coordinate.
+function AI_CARGO_HELICOPTER:onafterDeploy( Helicopter, From, Event, To, Coordinate, Speed, Height, DeployZone )
 
   if Helicopter and Helicopter:IsAlive() ~= nil then
 
@@ -609,7 +508,7 @@ function AI_CARGO_HELICOPTER:onafterDeploy( Helicopter, From, Event, To, Coordin
     
     --- Calculate the target route point.
 
-    Coordinate.y = math.random( 50, 200 )  
+    Coordinate.y = Height
     
     local _speed=Speed or Helicopter:GetSpeedMax()*0.5      
 
@@ -643,7 +542,7 @@ function AI_CARGO_HELICOPTER:onafterDeploy( Helicopter, From, Event, To, Coordin
   
     local Tasks = {}
     
-    Tasks[#Tasks+1] = Helicopter:TaskFunction( "AI_CARGO_HELICOPTER._Deploy", self, Coordinate )
+    Tasks[#Tasks+1] = Helicopter:TaskFunction( "AI_CARGO_HELICOPTER._Deploy", self, Coordinate, DeployZone )
     Tasks[#Tasks+1] = Helicopter:TaskOrbitCircle( math.random( 30, 100 ), _speed, CoordinateTo:GetRandomCoordinateInRadius( 800, 500 ) )
     
     --Tasks[#Tasks+1] = Helicopter:TaskLandAtVec2( CoordinateTo:GetVec2() )
@@ -653,20 +552,24 @@ function AI_CARGO_HELICOPTER:onafterDeploy( Helicopter, From, Event, To, Coordin
 
     -- Now route the helicopter
     Helicopter:Route( Route, 0 )
-    
+
+    self:GetParent( self, AI_CARGO_HELICOPTER ).onafterDeploy( self, Helicopter, From, Event, To, Coordinate, Speed, Height, DeployZone )
   end
   
 end
 
 
---- @param #AI_CARGO_HELICOPTER self
+--- On after Home event.
+-- @param #AI_CARGO_HELICOPTER self
 -- @param Wrapper.Group#GROUP Helicopter
 -- @param From
 -- @param Event
 -- @param To
--- @param Core.Point#COORDINATE Coordinate
+-- @param Core.Point#COORDINATE Coordinate Home place.
 -- @param #number Speed Speed in km/h to drive to the pickup coordinate. Default is 50% of max possible speed the unit can go.
-function AI_CARGO_HELICOPTER:onafterHome( Helicopter, From, Event, To, Coordinate, Speed )
+-- @param #number Height Height in meters to move to the home coordinate.
+-- @param Core.Zone#ZONE HomeZone The zone wherein the carrier will return when all cargo has been transported. This can be any zone type, like a ZONE, ZONE_GROUP, ZONE_AIRBASE.
+function AI_CARGO_HELICOPTER:onafterHome( Helicopter, From, Event, To, Coordinate, Speed, Height, HomeZone )
 
   if Helicopter and Helicopter:IsAlive() ~= nil then
 
@@ -676,9 +579,9 @@ function AI_CARGO_HELICOPTER:onafterHome( Helicopter, From, Event, To, Coordinat
     
     --- Calculate the target route point.
 
-    Coordinate.y = math.random( 50, 200 )    
+    Coordinate.y = Height
     
-    local _speed=Speed or Helicopter:GetSpeedMax()*0.5          
+    Speed = Speed or Helicopter:GetSpeedMax()*0.5          
 
     --- Create a route point of type air.
     local CoordinateFrom = Helicopter:GetCoordinate()
@@ -686,7 +589,7 @@ function AI_CARGO_HELICOPTER:onafterHome( Helicopter, From, Event, To, Coordinat
       "RADIO", 
       POINT_VEC3.RoutePointType.TurningPoint, 
       POINT_VEC3.RoutePointAction.TurningPoint, 
-      _speed, 
+      Speed , 
       true 
     )
     Route[#Route+1] = WaypointFrom
@@ -697,7 +600,7 @@ function AI_CARGO_HELICOPTER:onafterHome( Helicopter, From, Event, To, Coordinat
       "RADIO", 
       POINT_VEC3.RoutePointType.TurningPoint, 
       POINT_VEC3.RoutePointAction.TurningPoint, 
-      _speed, 
+      Speed , 
       true 
     )
 

Moose Development/Moose/AI/AI_Escort_Dispatcher.lua

@@ -0,0 +1,185 @@
+--- **AI** -- (R2.5) - Models the automatic assignment of AI escorts to player flights.
+--
+-- ## Features:
+-- --     
+--   * Provides the facilities to trigger escorts when players join flight slots.
+--   * 
+-- 
+-- ===
+-- 
+-- ### Author: **FlightControl**
+-- 
+-- ===       
+--
+-- @module AI.AI_Escort_Dispatcher
+-- @image AI_Escort_Dispatcher.JPG
+
+
+--- @type AI_ESCORT_DISPATCHER
+-- @extends Core.Fsm#FSM
+
+
+--- Models the automatic assignment of AI escorts to player flights.
+-- 
+-- ===
+--   
+-- @field #AI_ESCORT_DISPATCHER
+AI_ESCORT_DISPATCHER = {
+  ClassName = "AI_ESCORT_DISPATCHER",
+}
+
+--- @field #list 
+AI_ESCORT_DISPATCHER.AI_Escorts = {}
+
+
+--- Creates a new AI_ESCORT_DISPATCHER object.
+-- @param #AI_ESCORT_DISPATCHER self
+-- @param Core.Set#SET_GROUP CarrierSet The set of @{Wrapper.Group#GROUP} objects of carriers for which escorts are spawned in.
+-- @param Core.Spawn#SPAWN EscortSpawn The spawn object that will spawn in the Escorts.
+-- @param Wrapper.Airbase#AIRBASE EscortAirbase The airbase where the escorts are spawned.
+-- @param #string EscortName Name of the escort, which will also be the name of the escort menu.
+-- @param #string EscortBriefing A text showing the briefing to the player. Note that if no EscortBriefing is provided, the default briefing will be shown.
+-- @return #AI_ESCORT_DISPATCHER
+-- @usage
+-- 
+-- -- Create a new escort when a player joins an SU-25T plane.
+-- Create a carrier set, which contains the player slots that can be joined by the players, for which escorts will be defined.
+-- local Red_SU25T_CarrierSet = SET_GROUP:New():FilterPrefixes( "Red A2G Player Su-25T" ):FilterStart()
+-- 
+-- -- Create a spawn object that will spawn in the escorts, once the player has joined the player slot.
+-- local Red_SU25T_EscortSpawn = SPAWN:NewWithAlias( "Red A2G Su-25 Escort", "Red AI A2G SU-25 Escort" ):InitLimit( 10, 10 )
+-- 
+-- -- Create an airbase object, where the escorts will be spawned.
+-- local Red_SU25T_Airbase = AIRBASE:FindByName( AIRBASE.Caucasus.Maykop_Khanskaya )
+-- 
+-- -- Park the airplanes at the airbase, visible before start.
+-- Red_SU25T_EscortSpawn:ParkAtAirbase( Red_SU25T_Airbase, AIRBASE.TerminalType.OpenMedOrBig )
+-- 
+-- -- New create the escort dispatcher, using the carrier set, the escort spawn object at the escort airbase.
+-- -- Provide a name of the escort, which will be also the name appearing on the radio menu for the group.
+-- -- And a briefing to appear when the player joins the player slot.
+-- Red_SU25T_EscortDispatcher = AI_ESCORT_DISPATCHER:New( Red_SU25T_CarrierSet, Red_SU25T_EscortSpawn, Red_SU25T_Airbase, "Escort Su-25", "You Su-25T is escorted by one Su-25. Use the radio menu to control the escorts." )
+-- 
+-- -- The dispatcher needs to be started using the :Start() method.
+-- Red_SU25T_EscortDispatcher:Start()
+function AI_ESCORT_DISPATCHER:New( CarrierSet, EscortSpawn, EscortAirbase, EscortName, EscortBriefing )
+
+  local self = BASE:Inherit( self, FSM:New() ) -- #AI_ESCORT_DISPATCHER
+
+  self.CarrierSet = CarrierSet
+  self.EscortSpawn = EscortSpawn
+  self.EscortAirbase = EscortAirbase
+  self.EscortName = EscortName
+  self.EscortBriefing = EscortBriefing
+
+  self:SetStartState( "Idle" ) 
+  
+  self:AddTransition( "Monitoring", "Monitor", "Monitoring" )
+
+  self:AddTransition( "Idle", "Start", "Monitoring" )
+  self:AddTransition( "Monitoring", "Stop", "Idle" )
+  
+  -- Put a Dead event handler on CarrierSet, to ensure that when a carrier is destroyed, that all internal parameters are reset.
+  function self.CarrierSet.OnAfterRemoved( CarrierSet, From, Event, To, CarrierName, Carrier )
+    self:F( { Carrier = Carrier:GetName() } )
+  end
+  
+  return self
+end
+
+function AI_ESCORT_DISPATCHER:onafterStart( From, Event, To )
+
+  self:HandleEvent( EVENTS.Birth )
+  
+  self:HandleEvent( EVENTS.PlayerLeaveUnit, self.OnEventExit )
+  self:HandleEvent( EVENTS.Crash, self.OnEventExit )
+  self:HandleEvent( EVENTS.Dead, self.OnEventExit )
+
+end
+
+--- @param #AI_ESCORT_DISPATCHER self
+-- @param Core.Event#EVENTDATA EventData
+function AI_ESCORT_DISPATCHER:OnEventExit( EventData )
+
+  local PlayerGroupName = EventData.IniGroupName
+  local PlayerGroup = EventData.IniGroup
+  local PlayerUnit = EventData.IniUnit
+  
+  self:I({EscortAirbase= self.EscortAirbase } )
+  self:I({PlayerGroupName = PlayerGroupName } )
+  self:I({PlayerGroup = PlayerGroup})
+  self:I({FirstGroup = self.CarrierSet:GetFirst()})
+  self:I({FindGroup = self.CarrierSet:FindGroup( PlayerGroupName )})
+  
+  if self.CarrierSet:FindGroup( PlayerGroupName ) then
+    if self.AI_Escorts[PlayerGroupName] then
+      self.AI_Escorts[PlayerGroupName]:Stop()
+      self.AI_Escorts[PlayerGroupName] = nil
+    end
+  end
+      
+end
+
+--- @param #AI_ESCORT_DISPATCHER self
+-- @param Core.Event#EVENTDATA EventData
+function AI_ESCORT_DISPATCHER:OnEventBirth( EventData )
+
+  local PlayerGroupName = EventData.IniGroupName
+  local PlayerGroup = EventData.IniGroup
+  local PlayerUnit = EventData.IniUnit
+  
+  self:I({EscortAirbase= self.EscortAirbase } )
+  self:I({PlayerGroupName = PlayerGroupName } )
+  self:I({PlayerGroup = PlayerGroup})
+  self:I({FirstGroup = self.CarrierSet:GetFirst()})
+  self:I({FindGroup = self.CarrierSet:FindGroup( PlayerGroupName )})
+  
+  if self.CarrierSet:FindGroup( PlayerGroupName ) then
+    if not self.AI_Escorts[PlayerGroupName] then
+      local LeaderUnit = PlayerUnit
+      local EscortGroup = self.EscortSpawn:SpawnAtAirbase( self.EscortAirbase, SPAWN.Takeoff.Hot )
+      self:I({EscortGroup = EscortGroup})
+      
+      self:ScheduleOnce( 1,
+        function( EscortGroup )
+          local EscortSet = SET_GROUP:New()
+          EscortSet:AddGroup( EscortGroup )
+          self.AI_Escorts[PlayerGroupName] = AI_ESCORT:New( LeaderUnit, EscortSet, self.EscortName, self.EscortBriefing )
+          self.AI_Escorts[PlayerGroupName]:FormationTrail( 0, 100, 0 )
+          if EscortGroup:IsHelicopter() then
+            self.AI_Escorts[PlayerGroupName]:MenusHelicopters()
+          else
+            self.AI_Escorts[PlayerGroupName]:MenusAirplanes()
+          end
+          self.AI_Escorts[PlayerGroupName]:__Start( 0.1 )
+        end, EscortGroup
+      )
+    end
+  end
+
+end
+
+
+--- Start Trigger for AI_ESCORT_DISPATCHER
+-- @function [parent=#AI_ESCORT_DISPATCHER] Start
+-- @param #AI_ESCORT_DISPATCHER self
+
+--- Start Asynchronous Trigger for AI_ESCORT_DISPATCHER
+-- @function [parent=#AI_ESCORT_DISPATCHER] __Start
+-- @param #AI_ESCORT_DISPATCHER self
+-- @param #number Delay
+
+--- Stop Trigger for AI_ESCORT_DISPATCHER
+-- @function [parent=#AI_ESCORT_DISPATCHER] Stop
+-- @param #AI_ESCORT_DISPATCHER self
+
+--- Stop Asynchronous Trigger for AI_ESCORT_DISPATCHER
+-- @function [parent=#AI_ESCORT_DISPATCHER] __Stop
+-- @param #AI_ESCORT_DISPATCHER self
+-- @param #number Delay
+
+
+
+
+
+

Moose Development/Moose/AI/AI_Escort_Dispatcher_Request.lua

@@ -0,0 +1,146 @@
+--- **AI** -- (R2.5) - Models the assignment of AI escorts to player flights upon request using the radio menu.
+--
+-- ## Features:
+--     
+--   * Provides the facilities to trigger escorts when players join flight units.
+--   * Provide a menu for which escorts can be requested.
+-- 
+-- ===
+-- 
+-- ### Author: **FlightControl**
+-- 
+-- ===       
+--
+-- @module AI.AI_ESCORT_DISPATCHER_REQUEST
+-- @image AI_ESCORT_DISPATCHER_REQUEST.JPG
+
+
+--- @type AI_ESCORT_DISPATCHER_REQUEST
+-- @extends Core.Fsm#FSM
+
+
+--- Models the assignment of AI escorts to player flights upon request using the radio menu.
+-- 
+-- ===
+--   
+-- @field #AI_ESCORT_DISPATCHER_REQUEST
+AI_ESCORT_DISPATCHER_REQUEST = {
+  ClassName = "AI_ESCORT_DISPATCHER_REQUEST",
+}
+
+--- @field #list 
+AI_ESCORT_DISPATCHER_REQUEST.AI_Escorts = {}
+
+
+--- Creates a new AI_ESCORT_DISPATCHER_REQUEST object.
+-- @param #AI_ESCORT_DISPATCHER_REQUEST self
+-- @param Core.Set#SET_GROUP CarrierSet The set of @{Wrapper.Group#GROUP} objects of carriers for which escorts are requested. 
+-- @param Core.Spawn#SPAWN EscortSpawn The spawn object that will spawn in the Escorts.
+-- @param Wrapper.Airbase#AIRBASE EscortAirbase The airbase where the escorts are spawned.
+-- @param #string EscortName Name of the escort, which will also be the name of the escort menu.
+-- @param #string EscortBriefing A text showing the briefing to the player. Note that if no EscortBriefing is provided, the default briefing will be shown.
+-- @return #AI_ESCORT_DISPATCHER_REQUEST
+function AI_ESCORT_DISPATCHER_REQUEST:New( CarrierSet, EscortSpawn, EscortAirbase, EscortName, EscortBriefing )
+
+  local self = BASE:Inherit( self, FSM:New() ) -- #AI_ESCORT_DISPATCHER_REQUEST
+
+  self.CarrierSet = CarrierSet
+  self.EscortSpawn = EscortSpawn
+  self.EscortAirbase = EscortAirbase
+  self.EscortName = EscortName
+  self.EscortBriefing = EscortBriefing
+
+  self:SetStartState( "Idle" ) 
+  
+  self:AddTransition( "Monitoring", "Monitor", "Monitoring" )
+
+  self:AddTransition( "Idle", "Start", "Monitoring" )
+  self:AddTransition( "Monitoring", "Stop", "Idle" )
+  
+  -- Put a Dead event handler on CarrierSet, to ensure that when a carrier is destroyed, that all internal parameters are reset.
+  function self.CarrierSet.OnAfterRemoved( CarrierSet, From, Event, To, CarrierName, Carrier )
+    self:F( { Carrier = Carrier:GetName() } )
+  end
+  
+  return self
+end
+
+function AI_ESCORT_DISPATCHER_REQUEST:onafterStart( From, Event, To )
+
+  self:HandleEvent( EVENTS.Birth )
+  
+  self:HandleEvent( EVENTS.PlayerLeaveUnit, self.OnEventExit )
+  self:HandleEvent( EVENTS.Crash, self.OnEventExit )
+  self:HandleEvent( EVENTS.Dead, self.OnEventExit )
+
+end
+
+--- @param #AI_ESCORT_DISPATCHER_REQUEST self
+-- @param Core.Event#EVENTDATA EventData
+function AI_ESCORT_DISPATCHER_REQUEST:OnEventExit( EventData )
+
+  local PlayerGroupName = EventData.IniGroupName
+  local PlayerGroup = EventData.IniGroup
+  local PlayerUnit = EventData.IniUnit
+  
+  if self.CarrierSet:FindGroup( PlayerGroupName ) then
+    if self.AI_Escorts[PlayerGroupName] then
+      self.AI_Escorts[PlayerGroupName]:Stop()
+      self.AI_Escorts[PlayerGroupName] = nil
+    end
+  end
+      
+end
+
+--- @param #AI_ESCORT_DISPATCHER_REQUEST self
+-- @param Core.Event#EVENTDATA EventData
+function AI_ESCORT_DISPATCHER_REQUEST:OnEventBirth( EventData )
+
+  local PlayerGroupName = EventData.IniGroupName
+  local PlayerGroup = EventData.IniGroup
+  local PlayerUnit = EventData.IniUnit
+  
+  if self.CarrierSet:FindGroup( PlayerGroupName ) then
+    if not self.AI_Escorts[PlayerGroupName] then
+      local LeaderUnit = PlayerUnit
+      self:ScheduleOnce( 0.1,
+        function()
+          self.AI_Escorts[PlayerGroupName] = AI_ESCORT_REQUEST:New( LeaderUnit, self.EscortSpawn, self.EscortAirbase, self.EscortName, self.EscortBriefing )
+          self.AI_Escorts[PlayerGroupName]:FormationTrail( 0, 100, 0 )
+          if PlayerGroup:IsHelicopter() then
+            self.AI_Escorts[PlayerGroupName]:MenusHelicopters()
+          else
+            self.AI_Escorts[PlayerGroupName]:MenusAirplanes()
+          end
+          self.AI_Escorts[PlayerGroupName]:__Start( 0.1 )
+        end
+      )
+    end
+  end
+
+end
+
+
+--- Start Trigger for AI_ESCORT_DISPATCHER_REQUEST
+-- @function [parent=#AI_ESCORT_DISPATCHER_REQUEST] Start
+-- @param #AI_ESCORT_DISPATCHER_REQUEST self
+
+--- Start Asynchronous Trigger for AI_ESCORT_DISPATCHER_REQUEST
+-- @function [parent=#AI_ESCORT_DISPATCHER_REQUEST] __Start
+-- @param #AI_ESCORT_DISPATCHER_REQUEST self
+-- @param #number Delay
+
+--- Stop Trigger for AI_ESCORT_DISPATCHER_REQUEST
+-- @function [parent=#AI_ESCORT_DISPATCHER_REQUEST] Stop
+-- @param #AI_ESCORT_DISPATCHER_REQUEST self
+
+--- Stop Asynchronous Trigger for AI_ESCORT_DISPATCHER_REQUEST
+-- @function [parent=#AI_ESCORT_DISPATCHER_REQUEST] __Stop
+-- @param #AI_ESCORT_DISPATCHER_REQUEST self
+-- @param #number Delay
+
+
+
+
+
+

Moose Development/Moose/AI/AI_Escort_Request.lua

@@ -0,0 +1,316 @@
+--- **Functional** -- Taking the lead of AI escorting your flight or of other AI, upon request using the menu.
+-- 
+-- ===
+-- 
+-- ## Features:
+-- 
+--   * Escort navigation commands.
+--   * Escort hold at position commands.
+--   * Escorts reporting detected targets.
+--   * Escorts scanning targets in advance.
+--   * Escorts attacking specific targets.
+--   * Request assistance from other groups for attack.
+--   * Manage rule of engagement of escorts.
+--   * Manage the allowed evasion techniques of escorts.
+--   * Make escort to execute a defined mission or path.
+--   * Escort tactical situation reporting.
+-- 
+-- ===
+-- 
+-- ## Missions:
+-- 
+-- [ESC - Escorting](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/ESC%20-%20Escorting)
+-- 
+-- ===
+-- 
+-- Allows you to interact with escorting AI on your flight and take the lead.
+-- 
+-- Each escorting group can be commanded with a complete set of radio commands (radio menu in your flight, and then F10).
+--
+-- The radio commands will vary according the category of the group. The richest set of commands are with helicopters and airPlanes.
+-- Ships and Ground troops will have a more limited set, but they can provide support through the bombing of targets designated by the other escorts.
+-- 
+-- Escorts detect targets using a built-in detection mechanism. The detected targets are reported at a specified time interval.
+-- Once targets are reported, each escort has these targets as menu options to command the attack of these targets.
+-- Targets are by default grouped per area of 5000 meters, but the kind of detection and the grouping range can be altered.
+-- 
+-- Different formations can be selected in the Flight menu: Trail, Stack, Left Line, Right Line, Left Wing, Right Wing, Central Wing and Boxed formations are available.
+-- The Flight menu also allows for a mass attack, where all of the escorts are commanded to attack a target.
+-- 
+-- Escorts can emit flares to reports their location. They can be commanded to hold at a location, which can be their current or the leader location.
+-- In this way, you can spread out the escorts over the battle field before a coordinated attack.
+-- 
+-- But basically, the escort class provides 4 modes of operation, and depending on the mode, you are either leading the flight, or following the flight.
+-- 
+-- ## Leading the flight
+-- 
+-- When leading the flight, you are expected to guide the escorts towards the target areas, 
+-- and carefully coordinate the attack based on the threat levels reported, and the available weapons
+-- carried by the escorts. Ground ships or ground troops can execute A-assisted attacks, when they have long-range ground precision weapons for attack.
+-- 
+-- ## Following the flight
+-- 
+-- Escorts can be commanded to execute a specific mission path. In this mode, the escorts are in the lead.
+-- You as a player, are following the escorts, and are commanding them to progress the mission while
+-- ensuring that the escorts survive. You are joining the escorts in the battlefield. They will detect and report targets
+-- and you will ensure that the attacks are well coordinated, assigning the correct escort type for the detected target
+-- type. Once the attack is finished, the escort will resume the mission it was assigned.
+-- In other words, you can use the escorts for reconnaissance, and for guiding the attack.
+-- Imagine you as a mi-8 pilot, assigned to pickup cargo. Two ka-50s are guiding the way, and you are
+-- following. You are in control. The ka-50s detect targets, report them, and you command how the attack
+-- will commence and from where. You can control where the escorts are holding position and which targets
+-- are attacked first. You are in control how the ka-50s will follow their mission path.
+-- 
+-- Escorts can act as part of a AI A2G dispatcher offensive. In this way, You was a player are in control.
+-- The mission is defined by the A2G dispatcher, and you are responsible to join the flight and ensure that the
+-- attack is well coordinated.
+-- 
+-- It is with great proud that I present you this class, and I hope you will enjoy the functionality and the dynamism
+-- it brings in your DCS world simulations.
+-- 
+-- # RADIO MENUs that can be created:
+-- 
+-- Find a summary below of the current available commands:
+--
+-- ## Navigation ...:
+-- 
+-- Escort group navigation functions:
+--
+--   * **"Join-Up":** The escort group fill follow you in the assigned formation.
+--   * **"Flare":** Provides menu commands to let the escort group shoot a flare in the air in a color.
+--   * **"Smoke":** Provides menu commands to let the escort group smoke the air in a color. Note that smoking is only available for ground and naval troops.
+--
+-- ## Hold position ...:
+-- 
+-- Escort group navigation functions:
+--
+--   * **"At current location":** The escort group will hover above the ground at the position they were. The altitude can be specified as a parameter.
+--   * **"At my location":** The escort group will hover or orbit at the position where you are. The escort will fly to your location and hold position. The altitude can be specified as a parameter.
+--
+-- ## Report targets ...:
+-- 
+-- Report targets will make the escort group to report any target that it identifies within detection range. Any detected target can be attacked using the "Attack Targets" menu function. (see below).
+--
+--   * **"Report now":** Will report the current detected targets.
+--   * **"Report targets on":** Will make the escorts to report the detected targets and will fill the "Attack Targets" menu list.
+--   * **"Report targets off":** Will stop detecting targets.
+--
+-- ## Attack targets ...:
+-- 
+-- This menu item will list all detected targets within a 15km range. Depending on the level of detection (known/unknown) and visuality, the targets type will also be listed.
+-- This menu will be available in Flight menu or in each Escort menu.
+--
+-- ## Scan targets ...:
+-- 
+-- Menu items to pop-up the escort group for target scanning. After scanning, the escort group will resume with the mission or rejoin formation.
+--
+--   * **"Scan targets 30 seconds":** Scan 30 seconds for targets.
+--   * **"Scan targets 60 seconds":** Scan 60 seconds for targets.
+--
+-- ## Request assistance from ...:
+-- 
+-- This menu item will list all detected targets within a 15km range, similar as with the menu item **Attack Targets**.
+-- This menu item allows to request attack support from other ground based escorts supporting the current escort.
+-- eg. the function allows a player to request support from the Ship escort to attack a target identified by the Plane escort with its Tomahawk missiles.
+-- eg. the function allows a player to request support from other Planes escorting to bomb the unit with illumination missiles or bombs, so that the main plane escort can attack the area.
+--
+-- ## ROE ...:
+-- 
+-- Sets the Rules of Engagement (ROE) of the escort group when in flight.
+--
+--   * **"Hold Fire":** The escort group will hold fire.
+--   * **"Return Fire":** The escort group will return fire.
+--   * **"Open Fire":** The escort group will open fire on designated targets.
+--   * **"Weapon Free":** The escort group will engage with any target.
+--
+-- ## Evasion ...:
+-- 
+-- Will define the evasion techniques that the escort group will perform during flight or combat.
+--
+--   * **"Fight until death":** The escort group will have no reaction to threats.
+--   * **"Use flares, chaff and jammers":** The escort group will use passive defense using flares and jammers. No evasive manoeuvres are executed.
+--   * **"Evade enemy fire":** The rescort group will evade enemy fire before firing.
+--   * **"Go below radar and evade fire":** The escort group will perform evasive vertical manoeuvres.
+--
+-- ## Resume Mission ...:
+-- 
+-- Escort groups can have their own mission. This menu item will allow the escort group to resume their Mission from a given waypoint.
+-- Note that this is really fantastic, as you now have the dynamic of taking control of the escort groups, and allowing them to resume their path or mission.
+--
+-- ===
+-- 
+-- ### Authors: **FlightControl** 
+-- 
+-- ===
+--
+-- @module AI.AI_Escort
+-- @image Escorting.JPG
+
+
+
+--- @type AI_ESCORT_REQUEST
+-- @extends AI.AI_Escort#AI_ESCORT
+
+--- AI_ESCORT_REQUEST class
+-- 
+-- # AI_ESCORT_REQUEST construction methods.
+-- 
+-- Create a new AI_ESCORT_REQUEST object with the @{#AI_ESCORT_REQUEST.New} method:
+--
+--  * @{#AI_ESCORT_REQUEST.New}: Creates a new AI_ESCORT_REQUEST object from a @{Wrapper.Group#GROUP} for a @{Wrapper.Client#CLIENT}, with an optional briefing text.
+--
+-- @usage
+-- -- Declare a new EscortPlanes object as follows:
+-- 
+-- -- First find the GROUP object and the CLIENT object.
+-- local EscortUnit = CLIENT:FindByName( "Unit Name" ) -- The Unit Name is the name of the unit flagged with the skill Client in the mission editor.
+-- local EscortGroup = GROUP:FindByName( "Group Name" ) -- The Group Name is the name of the group that will escort the Escort Client.
+-- 
+-- -- Now use these 2 objects to construct the new EscortPlanes object.
+-- EscortPlanes = AI_ESCORT_REQUEST:New( EscortUnit, EscortGroup, "Desert", "Welcome to the mission. You are escorted by a plane with code name 'Desert', which can be instructed through the F10 radio menu." )
+--
+-- @field #AI_ESCORT_REQUEST
+AI_ESCORT_REQUEST = {
+  ClassName = "AI_ESCORT_REQUEST",
+}
+
+--- AI_ESCORT_REQUEST.Mode class
+-- @type AI_ESCORT_REQUEST.MODE
+-- @field #number FOLLOW
+-- @field #number MISSION
+
+--- MENUPARAM type
+-- @type MENUPARAM
+-- @field #AI_ESCORT_REQUEST ParamSelf
+-- @field #Distance ParamDistance
+-- @field #function ParamFunction
+-- @field #string ParamMessage
+
+--- AI_ESCORT_REQUEST class constructor for an AI group
+-- @param #AI_ESCORT_REQUEST self
+-- @param Wrapper.Client#CLIENT EscortUnit The client escorted by the EscortGroup.
+-- @param Core.Spawn#SPAWN EscortSpawn The spawn object of AI, escorting the EscortUnit.
+-- @param Wrapper.Airbase#AIRBASE EscortAirbase The airbase where escorts will be spawned once requested.
+-- @param #string EscortName Name of the escort.
+-- @param #string EscortBriefing A text showing the AI_ESCORT_REQUEST briefing to the player. Note that if no EscortBriefing is provided, the default briefing will be shown.
+-- @return #AI_ESCORT_REQUEST
+-- @usage
+-- EscortSpawn = SPAWN:NewWithAlias( "Red A2G Escort Template", "Red A2G Escort AI" ):InitLimit( 10, 10 )
+-- EscortSpawn:ParkAtAirbase( AIRBASE:FindByName( AIRBASE.Caucasus.Sochi_Adler ), AIRBASE.TerminalType.OpenBig )
+--
+-- local EscortUnit = UNIT:FindByName( "Red A2G Pilot" )
+--
+-- Escort = AI_ESCORT_REQUEST:New( EscortUnit, EscortSpawn, AIRBASE:FindByName(AIRBASE.Caucasus.Sochi_Adler), "A2G", "Briefing" )
+-- Escort:FormationTrail( 50, 100, 100 )
+-- Escort:Menus()
+-- Escort:__Start( 5 )
+function AI_ESCORT_REQUEST:New( EscortUnit, EscortSpawn, EscortAirbase, EscortName, EscortBriefing )
+  
+  local EscortGroupSet = SET_GROUP:New():FilterDeads():FilterCrashes()
+  local self = BASE:Inherit( self, AI_ESCORT:New( EscortUnit, EscortGroupSet, EscortName, EscortBriefing ) ) -- #AI_ESCORT_REQUEST
+
+  self.EscortGroupSet = EscortGroupSet
+  self.EscortSpawn = EscortSpawn
+  self.EscortAirbase = EscortAirbase
+
+  self.LeaderGroup = self.PlayerUnit:GetGroup()
+
+  self.Detection = DETECTION_AREAS:New( self.EscortGroupSet, 5000 )
+  self.Detection:__Start( 30 )
+  
+  self.SpawnMode = self.__Enum.Mode.Mission
+  
+  return self
+end
+
+--- @param #AI_ESCORT_REQUEST self
+function AI_ESCORT_REQUEST:SpawnEscort()
+
+  local EscortGroup = self.EscortSpawn:SpawnAtAirbase( self.EscortAirbase, SPAWN.Takeoff.Hot )
+
+  self:ScheduleOnce( 0.1,
+    function( EscortGroup )
+
+      EscortGroup:OptionROTVertical()
+      EscortGroup:OptionROEHoldFire()
+  
+      self.EscortGroupSet:AddGroup( EscortGroup )
+
+      local LeaderEscort = self.EscortGroupSet:GetFirst() -- Wrapper.Group#GROUP
+      local Report = REPORT:New()
+      Report:Add( "Joining Up " .. self.EscortGroupSet:GetUnitTypeNames():Text( ", " ) .. " from " .. LeaderEscort:GetCoordinate():ToString( self.EscortUnit ) )
+      LeaderEscort:MessageTypeToGroup( Report:Text(),  MESSAGE.Type.Information, self.PlayerUnit )
+
+      self:SetFlightModeFormation( EscortGroup )
+      self:FormationTrail()
+
+      self:_InitFlightMenus()
+      self:_InitEscortMenus( EscortGroup )
+      self:_InitEscortRoute( EscortGroup )
+
+      --- @param #AI_ESCORT self
+      -- @param Core.Event#EVENTDATA EventData
+      function EscortGroup:OnEventDeadOrCrash( EventData )
+        self:F( { "EventDead", EventData } )
+        self.EscortMenu:Remove()
+      end
+
+      EscortGroup:HandleEvent( EVENTS.Dead, EscortGroup.OnEventDeadOrCrash )
+      EscortGroup:HandleEvent( EVENTS.Crash, EscortGroup.OnEventDeadOrCrash )
+
+    end, EscortGroup
+  )
+
+end
+
+--- @param #AI_ESCORT_REQUEST self
+-- @param Core.Set#SET_GROUP EscortGroupSet
+function AI_ESCORT_REQUEST:onafterStart( EscortGroupSet )
+
+  self:F()
+
+  if not self.MenuRequestEscort then
+    self.MainMenu = MENU_GROUP:New( self.PlayerGroup, self.EscortName )
+    self.MenuRequestEscort = MENU_GROUP_COMMAND:New( self.LeaderGroup, "Request new escort ", self.MainMenu, 
+      function()
+        self:SpawnEscort()
+      end
+      )
+  end
+
+  self:GetParent( self ).onafterStart( self, EscortGroupSet )
+
+  self:HandleEvent( EVENTS.Dead, self.OnEventDeadOrCrash )
+  self:HandleEvent( EVENTS.Crash, self.OnEventDeadOrCrash )
+    
+end
+
+--- @param #AI_ESCORT_REQUEST self
+-- @param Core.Set#SET_GROUP EscortGroupSet
+function AI_ESCORT_REQUEST:onafterStop( EscortGroupSet )
+
+  self:F()
+  
+  EscortGroupSet:ForEachGroup(
+    --- @param Core.Group#GROUP EscortGroup
+    function( EscortGroup )
+      EscortGroup:WayPointInitialize()
+    
+      EscortGroup:OptionROTVertical()
+      EscortGroup:OptionROEOpenFire()
+    end
+  )
+
+  self.Detection:Stop()
+    
+  self.MainMenu:Remove()
+  
+end
+
+--- Set the spawn mode to be mission execution.
+-- @param #AI_ESCORT_REQUEST self
+function AI_ESCORT_REQUEST:SetEscortSpawnMission()
+
+  self.SpawnMode = self.__Enum.Mode.Mission
+    
+end

Moose Development/Moose/AI/AI_Formation.lua

@@ -36,6 +36,7 @@
 -- @field #boolean ReportTargets If true, nearby targets are reported.
 -- @Field DCSTypes#AI.Option.Air.val.ROE OptionROE Which ROE is set to the FollowGroup.
 -- @field DCSTypes#AI.Option.Air.val.REACTION_ON_THREAT OptionReactionOnThreat Which REACTION_ON_THREAT is set to the FollowGroup.
+-- @field #number dtFollow Time step between position updates.
 
 
 --- Build large formations, make AI follow a @{Wrapper.Client#CLIENT} (player) leader or a @{Wrapper.Unit#UNIT} (AI) leader.
@@ -106,12 +107,59 @@ AI_FORMATION = {
   FollowScheduler = nil,
   OptionROE = AI.Option.Air.val.ROE.OPEN_FIRE,
   OptionReactionOnThreat = AI.Option.Air.val.REACTION_ON_THREAT.ALLOW_ABORT_MISSION,
+  dtFollow = 0.5,
 }
 
---- AI_FORMATION.Mode class
--- @type AI_FORMATION.MODE
--- @field #number FOLLOW
--- @field #number MISSION
+AI_FORMATION.__Enum = {}
+
+--- @type AI_FORMATION.__Enum.Formation
+-- @field #number None
+-- @field #number Line
+-- @field #number Trail
+-- @field #number Stack
+-- @field #number LeftLine
+-- @field #number RightLine
+-- @field #number LeftWing
+-- @field #number RightWing
+-- @field #number Vic
+-- @field #number Box
+AI_FORMATION.__Enum.Formation = {
+  None = 0,
+  Mission = 1,
+  Line = 2,
+  Trail = 3,
+  Stack = 4,
+  LeftLine = 5,
+  RightLine = 6,
+  LeftWing = 7,
+  RightWing = 8,
+  Vic = 9,
+  Box = 10,
+}
+
+--- @type AI_FORMATION.__Enum.Mode
+-- @field #number Mission
+-- @field #number Formation
+AI_FORMATION.__Enum.Mode = {
+  Mission = "M",
+  Formation = "F",
+  Attack = "A",
+  Reconnaissance = "R",
+}
+
+--- @type AI_FORMATION.__Enum.ReportType
+-- @field #number All
+-- @field #number Airborne
+-- @field #number GroundRadar
+-- @field #number Ground
+AI_FORMATION.__Enum.ReportType = {
+  Airborne = "*",
+  Airborne = "A",
+  GroundRadar = "R",
+  Ground = "G",
+}
+
+
 
 --- MENUPARAM type
 -- @type MENUPARAM
@@ -125,6 +173,7 @@ AI_FORMATION = {
 -- @param Wrapper.Unit#UNIT FollowUnit The UNIT leading the FolllowGroupSet.
 -- @param Core.Set#SET_GROUP FollowGroupSet The group AI escorting the FollowUnit.
 -- @param #string FollowName Name of the escort.
+-- @param #string FollowBriefing Briefing.
 -- @return #AI_FORMATION self
 function AI_FORMATION:New( FollowUnit, FollowGroupSet, FollowName, FollowBriefing ) --R2.1
   local self = BASE:Inherit( self, FSM_SET:New( FollowGroupSet ) )
@@ -133,13 +182,20 @@ function AI_FORMATION:New( FollowUnit, FollowGroupSet, FollowName, FollowBriefin
   self.FollowUnit = FollowUnit -- Wrapper.Unit#UNIT
   self.FollowGroupSet = FollowGroupSet -- Core.Set#SET_GROUP
   
+  self.FollowGroupSet:ForEachGroup(
+    function( FollowGroup )
+      self:E("Following")
+      FollowGroup:SetState( self, "Mode", self.__Enum.Mode.Formation )
+    end
+  )
+  
   self:SetFlightRandomization( 2 )
   
   self:SetStartState( "None" ) 
 
   self:AddTransition( "*", "Stop", "Stopped" )
 
-  self:AddTransition( "None", "Start", "Following" )
+  self:AddTransition( {"None", "Stopped"}, "Start", "Following" )
 
   self:AddTransition( "*", "FormationLine", "*" )
   --- FormationLine Handler OnBefore for AI_FORMATION
@@ -620,6 +676,16 @@ function AI_FORMATION:New( FollowUnit, FollowGroupSet, FollowName, FollowBriefin
   return self
 end
 
+
+--- Set time interval between updates of the formation.
+-- @param #AI_FORMATION self
+-- @param #number dt Time step in seconds between formation updates. Default is every 0.5 seconds.
+-- @return #AI_FORMATION
+function AI_FORMATION:SetFollowTimeInterval(dt) --R2.1
+  self.dtFollow=dt or 0.5
+  return self
+end
+
 --- This function is for test, it will put on the frequency of the FollowScheduler a red smoke at the direction vector calculated for the escort to fly to.
 -- This allows to visualize where the escort is flying to.
 -- @param #AI_FORMATION self
@@ -643,14 +709,21 @@ end
 -- @param #nubmer ZStart The start position on the Z-axis in meters for the first group.
 -- @param #number ZSpace The space between groups on the Z-axis in meters for each sequent group.
 -- @return #AI_FORMATION
-function AI_FORMATION:onafterFormationLine( FollowGroupSet, From , Event , To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace ) --R2.1
-  self:F( { FollowGroupSet, From , Event ,To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace } )
+function AI_FORMATION:onafterFormationLine( FollowGroupSet, From , Event , To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace, Formation ) --R2.1
+  self:F( { FollowGroupSet, From , Event ,To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace, Formation } )
+
+  XStart = XStart or self.XStart
+  XSpace = XSpace or self.XSpace
+  YStart = YStart or self.YStart
+  YSpace = YSpace or self.YSpace
+  ZStart = ZStart or self.ZStart
+  ZSpace = ZSpace or self.ZSpace
 
   FollowGroupSet:Flush( self )
   
   local FollowSet = FollowGroupSet:GetSet()
   
-  local i = 0
+  local i = 1  --FF i=0 caused first unit to have no XSpace! Probably needs further adjustments. This is just a quick work around.
   
   for FollowID, FollowGroup in pairs( FollowSet ) do
   
@@ -662,6 +735,8 @@ function AI_FORMATION:onafterFormationLine( FollowGroupSet, From , Event , To, X
     local Vec3 = PointVec3:GetVec3()
     FollowGroup:SetState( self, "FormationVec3", Vec3 )
     i = i + 1
+
+    FollowGroup:SetState( FollowGroup, "Formation", Formation )
   end
   
   return self
@@ -680,7 +755,7 @@ end
 -- @return #AI_FORMATION
 function AI_FORMATION:onafterFormationTrail( FollowGroupSet, From , Event , To, XStart, XSpace, YStart ) --R2.1
 
-  self:onafterFormationLine(FollowGroupSet,From,Event,To,XStart,XSpace,YStart,0,0,0)
+  self:onafterFormationLine(FollowGroupSet,From,Event,To,XStart,XSpace,YStart,0,0,0, self.__Enum.Formation.Trail )
 
   return self
 end
@@ -699,7 +774,7 @@ end
 -- @return #AI_FORMATION
 function AI_FORMATION:onafterFormationStack( FollowGroupSet, From , Event , To, XStart, XSpace, YStart, YSpace ) --R2.1
 
-  self:onafterFormationLine(FollowGroupSet,From,Event,To,XStart,XSpace,YStart,YSpace,0,0)
+  self:onafterFormationLine(FollowGroupSet,From,Event,To,XStart,XSpace,YStart,YSpace,0,0, self.__Enum.Formation.Stack )
 
   return self
 end
@@ -720,7 +795,7 @@ end
 -- @return #AI_FORMATION
 function AI_FORMATION:onafterFormationLeftLine( FollowGroupSet, From , Event , To, XStart, YStart, ZStart, ZSpace ) --R2.1
 
-  self:onafterFormationLine(FollowGroupSet,From,Event,To,XStart,0,YStart,0,ZStart,ZSpace)
+  self:onafterFormationLine(FollowGroupSet,From,Event,To,XStart,0,YStart,0,-ZStart,-ZSpace, self.__Enum.Formation.LeftLine )
 
   return self
 end
@@ -739,7 +814,7 @@ end
 -- @return #AI_FORMATION
 function AI_FORMATION:onafterFormationRightLine( FollowGroupSet, From , Event , To, XStart, YStart, ZStart, ZSpace ) --R2.1
 
-  self:onafterFormationLine(FollowGroupSet,From,Event,To,XStart,0,YStart,0,-ZStart,-ZSpace)
+  self:onafterFormationLine(FollowGroupSet,From,Event,To,XStart,0,YStart,0,ZStart,ZSpace,self.__Enum.Formation.RightLine)
 
   return self
 end
@@ -758,7 +833,7 @@ end
 -- @param #number ZSpace The space between groups on the Z-axis in meters for each sequent group.
 function AI_FORMATION:onafterFormationLeftWing( FollowGroupSet, From , Event , To, XStart, XSpace, YStart, ZStart, ZSpace ) --R2.1
 
-  self:onafterFormationLine(FollowGroupSet,From,Event,To,XStart,XSpace,YStart,0,ZStart,ZSpace)
+  self:onafterFormationLine(FollowGroupSet,From,Event,To,XStart,XSpace,YStart,0,-ZStart,-ZSpace,self.__Enum.Formation.LeftWing)
 
   return self
 end
@@ -778,7 +853,7 @@ end
 -- @param #number ZSpace The space between groups on the Z-axis in meters for each sequent group.
 function AI_FORMATION:onafterFormationRightWing( FollowGroupSet, From , Event , To, XStart, XSpace, YStart, ZStart, ZSpace ) --R2.1
 
-  self:onafterFormationLine(FollowGroupSet,From,Event,To,XStart,XSpace,YStart,0,-ZStart,-ZSpace)
+  self:onafterFormationLine(FollowGroupSet,From,Event,To,XStart,XSpace,YStart,0,ZStart,ZSpace,self.__Enum.Formation.RightWing)
 
   return self
 end
@@ -816,6 +891,7 @@ function AI_FORMATION:onafterFormationCenterWing( FollowGroupSet, From , Event ,
     local Vec3 = PointVec3:GetVec3()
     FollowGroup:SetState( self, "FormationVec3", Vec3 )
     i = i + 1
+    FollowGroup:SetState( FollowGroup, "Formation", self.__Enum.Formation.Vic )
   end
   
   return self
@@ -875,6 +951,7 @@ function AI_FORMATION:onafterFormationBox( FollowGroupSet, From , Event , To, XS
     local Vec3 = PointVec3:GetVec3()
     FollowGroup:SetState( self, "FormationVec3", Vec3 )
     i = i + 1
+    FollowGroup:SetState( FollowGroup, "Formation", self.__Enum.Formation.Box )
   end
 
   return self
@@ -893,17 +970,126 @@ function AI_FORMATION:SetFlightRandomization( FlightRandomization ) --R2.1
 end
 
 
---- @param Follow#AI_FORMATION self
-function AI_FORMATION:onenterFollowing( FollowGroupSet ) --R2.1
-  self:F( )
+--- Gets your escorts to flight mode.
+-- @param #AI_FORMATION self
+-- @param Wrapper.Group#GROUP FollowGroup FollowGroup.
+-- @return #AI_FORMATION
+function AI_FORMATION:GetFlightMode( FollowGroup )
+
+  if FollowGroup then
+    FollowGroup:SetState( FollowGroup, "PreviousMode", FollowGroup:GetState( FollowGroup, "Mode" ) )
+    FollowGroup:SetState( FollowGroup, "Mode", self.__Enum.Mode.Mission )
+  end
+  
+  
+  return FollowGroup:GetState( FollowGroup, "Mode" )
+end
+
+
+
+--- This sets your escorts to fly a mission.
+-- @param #AI_FORMATION self
+-- @param Wrapper.Group#GROUP FollowGroup FollowGroup.
+-- @return #AI_FORMATION
+function AI_FORMATION:SetFlightModeMission( FollowGroup )
+
+  if FollowGroup then
+    FollowGroup:SetState( FollowGroup, "PreviousMode", FollowGroup:GetState( FollowGroup, "Mode" ) )
+    FollowGroup:SetState( FollowGroup, "Mode", self.__Enum.Mode.Mission )
+  else
+    self.EscortGroupSet:ForSomeGroupAlive(
+      --- @param Core.Group#GROUP EscortGroup
+      function( FollowGroup )
+        FollowGroup:SetState( FollowGroup, "PreviousMode", FollowGroup:GetState( FollowGroup, "Mode" ) )
+        FollowGroup:SetState( FollowGroup, "Mode", self.__Enum.Mode.Mission )
+      end
+    )
+  end
+  
+  
+  return self
+end
+
+
+--- This sets your escorts to execute an attack.
+-- @param #AI_FORMATION self
+-- @param Wrapper.Group#GROUP FollowGroup FollowGroup.
+-- @return #AI_FORMATION
+function AI_FORMATION:SetFlightModeAttack( FollowGroup )
+
+  if FollowGroup then
+    FollowGroup:SetState( FollowGroup, "PreviousMode", FollowGroup:GetState( FollowGroup, "Mode" ) )
+    FollowGroup:SetState( FollowGroup, "Mode", self.__Enum.Mode.Attack )
+  else
+    self.EscortGroupSet:ForSomeGroupAlive(
+      --- @param Core.Group#GROUP EscortGroup
+      function( FollowGroup )
+        FollowGroup:SetState( FollowGroup, "PreviousMode", FollowGroup:GetState( FollowGroup, "Mode" ) )
+        FollowGroup:SetState( FollowGroup, "Mode", self.__Enum.Mode.Attack )
+      end
+    )
+  end
+  
+  
+  return self
+end
+
+
+--- This sets your escorts to fly in a formation.
+-- @param #AI_FORMATION self
+-- @param Wrapper.Group#GROUP FollowGroup FollowGroup.
+-- @return #AI_FORMATION
+function AI_FORMATION:SetFlightModeFormation( FollowGroup )
+
+  if FollowGroup then
+    FollowGroup:SetState( FollowGroup, "PreviousMode", FollowGroup:GetState( FollowGroup, "Mode" ) )
+    FollowGroup:SetState( FollowGroup, "Mode", self.__Enum.Mode.Formation )
+  else
+    self.EscortGroupSet:ForSomeGroupAlive(
+      --- @param Core.Group#GROUP EscortGroup
+      function( FollowGroup )
+        FollowGroup:SetState( FollowGroup, "PreviousMode", FollowGroup:GetState( FollowGroup, "Mode" ) )
+        FollowGroup:SetState( FollowGroup, "Mode", self.__Enum.Mode.Formation )
+      end
+    )
+  end
+  
+  return self
+end
+
+
+
+
+--- Stop function. Formation will not be updated any more.
+-- @param #AI_FORMATION self
+-- @param Core.Set#SET_GROUP FollowGroupSet The following set of groups.
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @pram #string To The to state.
+function AI_FORMATION:onafterStop(FollowGroupSet, From, Event, To) --R2.1
+  self:E("Stopping formation.")
+end
+
+--- Follow event fuction. Check if coming from state "stopped". If so the transition is rejected.
+-- @param #AI_FORMATION self
+-- @param Core.Set#SET_GROUP FollowGroupSet The following set of groups.
+-- @param #string From From state.
+-- @param #string Event Event.
+-- @pram #string To The to state.
+function AI_FORMATION:onbeforeFollow( FollowGroupSet, From, Event, To ) --R2.1
+  if From=="Stopped" then
+    return false  -- Deny transition.
+  end
+  return true
+end
+
+--- @param #AI_FORMATION self
+function AI_FORMATION:onenterFollowing( FollowGroupSet ) --R2.1
 
-  self:T( { self.FollowUnit.UnitName, self.FollowUnit:IsAlive() } )
   if self.FollowUnit:IsAlive() then
 
     local ClientUnit = self.FollowUnit
 
-    self:T( {ClientUnit.UnitName } )
-
     local CT1, CT2, CV1, CV2
     CT1 = ClientUnit:GetState( self, "CT1" )
 
@@ -920,120 +1106,139 @@ function AI_FORMATION:onenterFollowing( FollowGroupSet ) --R2.1
       ClientUnit:SetState( self, "CV1", CV2 )
     end
         
-    FollowGroupSet:ForEachGroup(
+    FollowGroupSet:ForEachGroupAlive(
       --- @param Wrapper.Group#GROUP FollowGroup
       -- @param Wrapper.Unit#UNIT ClientUnit
       function( FollowGroup, Formation, ClientUnit, CT1, CV1, CT2, CV2 )
+      
+        if FollowGroup:GetState( FollowGroup, "Mode" ) == self.__Enum.Mode.Formation then
         
-        FollowGroup:OptionROTEvadeFire()
-        FollowGroup:OptionROEReturnFire()
+          self:T({Mode=FollowGroup:GetState( FollowGroup, "Mode" )})
 
-        local GroupUnit = FollowGroup:GetUnit( 1 )
-        local FollowFormation = FollowGroup:GetState( self, "FormationVec3" )
-        if FollowFormation then
-          local FollowDistance = FollowFormation.x
-          
-          local GT1 = GroupUnit:GetState( self, "GT1" )
-      
-          if CT1 == nil or CT1 == 0 or GT1 == nil or GT1 == 0 then
-            GroupUnit:SetState( self, "GV1", GroupUnit:GetPointVec3() )
-            GroupUnit:SetState( self, "GT1", timer.getTime() ) 
-          else
-            local CD = ( ( CV2.x - CV1.x )^2 + ( CV2.y - CV1.y )^2 + ( CV2.z - CV1.z )^2 ) ^ 0.5
-            local CT = CT2 - CT1
-      
-            local CS = ( 3600 / CT ) * ( CD / 1000 ) / 3.6
-
-            local CDv = { x = CV2.x - CV1.x, y = CV2.y - CV1.y, z = CV2.z - CV1.z }
-            local Ca = math.atan2( CDv.x, CDv.z )
-      
+          FollowGroup:OptionROTEvadeFire()
+          FollowGroup:OptionROEReturnFire()
+  
+          local GroupUnit = FollowGroup:GetUnit( 1 )
+          local FollowFormation = FollowGroup:GetState( self, "FormationVec3" )
+          if FollowFormation then
+            local FollowDistance = FollowFormation.x
+            
             local GT1 = GroupUnit:GetState( self, "GT1" )
-            local GT2 = timer.getTime()
-            local GV1 = GroupUnit:GetState( self, "GV1" )
-            local GV2 = GroupUnit:GetPointVec3()
-            GV2:AddX( math.random( -Formation.FlightRandomization / 2, Formation.FlightRandomization / 2 ) )
-            GV2:AddY( math.random( -Formation.FlightRandomization / 2, Formation.FlightRandomization / 2 ) )
-            GV2:AddZ( math.random( -Formation.FlightRandomization / 2, Formation.FlightRandomization / 2 ) )
-            GroupUnit:SetState( self, "GT1", GT2 )
-            GroupUnit:SetState( self, "GV1", GV2 )
-            
-      
-            local GD = ( ( GV2.x - GV1.x )^2 + ( GV2.y - GV1.y )^2 + ( GV2.z - GV1.z )^2 ) ^ 0.5
-            local GT = GT2 - GT1
-      
+        
+            if CT1 == nil or CT1 == 0 or GT1 == nil or GT1 == 0 then
+              GroupUnit:SetState( self, "GV1", GroupUnit:GetPointVec3() )
+              GroupUnit:SetState( self, "GT1", timer.getTime() ) 
+            else
+              local CD = ( ( CV2.x - CV1.x )^2 + ( CV2.y - CV1.y )^2 + ( CV2.z - CV1.z )^2 ) ^ 0.5
+              local CT = CT2 - CT1
+        
+              local CS = ( 3600 / CT ) * ( CD / 1000 ) / 3.6
+  
+              local CDv = { x = CV2.x - CV1.x, y = CV2.y - CV1.y, z = CV2.z - CV1.z }
+              local Ca = math.atan2( CDv.x, CDv.z )
+        
+              local GT1 = GroupUnit:GetState( self, "GT1" )
+              local GT2 = timer.getTime()
+              local GV1 = GroupUnit:GetState( self, "GV1" )
+              local GV2 = GroupUnit:GetPointVec3()
+              GV2:AddX( math.random( -Formation.FlightRandomization / 2, Formation.FlightRandomization / 2 ) )
+              GV2:AddY( math.random( -Formation.FlightRandomization / 2, Formation.FlightRandomization / 2 ) )
+              GV2:AddZ( math.random( -Formation.FlightRandomization / 2, Formation.FlightRandomization / 2 ) )
+              GroupUnit:SetState( self, "GT1", GT2 )
+              GroupUnit:SetState( self, "GV1", GV2 )
+              
+        
+              local GD = ( ( GV2.x - GV1.x )^2 + ( GV2.y - GV1.y )^2 + ( GV2.z - GV1.z )^2 ) ^ 0.5
+              local GT = GT2 - GT1
+        
+  
+              -- Calculate the distance
+              local GDv =  { x = GV2.x - CV1.x, y =  GV2.y - CV1.y, z = GV2.z - CV1.z }
+              local Alpha_T = math.atan2( GDv.x, GDv.z ) - math.atan2( CDv.x, CDv.z ) 
+              local Alpha_R = ( Alpha_T < 0 ) and Alpha_T + 2 * math.pi or Alpha_T
+              local Position = math.cos( Alpha_R )
+              local GD = ( ( GDv.x )^2 + ( GDv.z )^2 ) ^ 0.5
+              local Distance = GD * Position + - CS * 0.5
+        
+              -- Calculate the group direction vector
+              local GV = { x = GV2.x - CV2.x, y = GV2.y - CV2.y, z = GV2.z - CV2.z  }
+        
+              -- Calculate GH2, GH2 with the same height as CV2.
+              local GH2 = { x = GV2.x, y = CV2.y + FollowFormation.y, z = GV2.z }
+        
+              -- Calculate the angle of GV to the orthonormal plane
+              local alpha = math.atan2( GV.x, GV.z )
+        
+              local GVx = FollowFormation.z * math.cos( Ca ) + FollowFormation.x * math.sin( Ca )
+              local GVz = FollowFormation.x * math.cos( Ca ) - FollowFormation.z * math.sin( Ca )
+  
+  
+              -- Now we calculate the intersecting vector between the circle around CV2 with radius FollowDistance and GH2.
+              -- From the GeoGebra model: CVI = (x(CV2) + FollowDistance cos(alpha), y(GH2) + FollowDistance sin(alpha), z(CV2))
+              local Inclination = ( Distance + FollowFormation.x ) / 10
+              if Inclination < -30 then
+                Inclination = - 30
+              end
+              local CVI = { x = CV2.x + CS * 10 * math.sin(Ca),
+                y = GH2.y + Inclination, -- + FollowFormation.y,
+                y = GH2.y,
+                z = CV2.z + CS * 10 * math.cos(Ca),
+              }
+        
+              -- Calculate the direction vector DV of the escort group. We use CVI as the base and CV2 as the direction.
+              local DV = { x = CV2.x - CVI.x, y = CV2.y - CVI.y, z = CV2.z - CVI.z }
+        
+              -- We now calculate the unary direction vector DVu, so that we can multiply DVu with the speed, which is expressed in meters / s.
+              -- We need to calculate this vector to predict the point the escort group needs to fly to according its speed.
+              -- The distance of the destination point should be far enough not to have the aircraft starting to swipe left to right...
+              local DVu = { x = DV.x / FollowDistance, y = DV.y, z = DV.z / FollowDistance }
+        
+              -- Now we can calculate the group destination vector GDV.
+              local GDV = { x = CVI.x, y = CVI.y, z = CVI.z }
+              
+              local ADDx = FollowFormation.x * math.cos(alpha) - FollowFormation.z * math.sin(alpha)
+              local ADDz = FollowFormation.z * math.cos(alpha) + FollowFormation.x * math.sin(alpha)
+              
+              local GDV_Formation = { 
+                x = GDV.x - GVx, 
+                y = GDV.y, 
+                z = GDV.z - GVz
+              }
+              
+              if self.SmokeDirectionVector == true then
+                trigger.action.smoke( GDV, trigger.smokeColor.Green )
+                trigger.action.smoke( GDV_Formation, trigger.smokeColor.White )
+              end
+              
+              
+              
+              local Time = 120
+              
+              local Speed = - ( Distance + FollowFormation.x ) / Time
 
-            -- Calculate the distance
-            local GDv =  { x = GV2.x - CV1.x, y =  GV2.y - CV1.y, z = GV2.z - CV1.z }
-            local Alpha_T = math.atan2( GDv.x, GDv.z ) - math.atan2( CDv.x, CDv.z ) 
-            local Alpha_R = ( Alpha_T < 0 ) and Alpha_T + 2 * math.pi or Alpha_T
-            local Position = math.cos( Alpha_R )
-            local GD = ( ( GDv.x )^2 + ( GDv.z )^2 ) ^ 0.5
-            local Distance = GD * Position + - CS * 0.5
-      
-            -- Calculate the group direction vector
-            local GV = { x = GV2.x - CV2.x, y = GV2.y - CV2.y, z = GV2.z - CV2.z  }
-      
-            -- Calculate GH2, GH2 with the same height as CV2.
-            local GH2 = { x = GV2.x, y = CV2.y + FollowFormation.y, z = GV2.z }
-      
-            -- Calculate the angle of GV to the orthonormal plane
-            local alpha = math.atan2( GV.x, GV.z )
-      
-            local GVx = FollowFormation.z * math.cos( Ca ) + FollowFormation.x * math.sin( Ca )
-            local GVz = FollowFormation.x * math.cos( Ca ) - FollowFormation.z * math.sin( Ca )
+              if Distance > -10000 then
+                Speed = - ( Distance + FollowFormation.x ) / 60
+              end
+ 
+              if Distance > -2500 then
+                Speed = - ( Distance + FollowFormation.x ) / 20
+              end
+              
+              local GS = Speed + CS
 
-
-            -- Now we calculate the intersecting vector between the circle around CV2 with radius FollowDistance and GH2.
-            -- From the GeoGebra model: CVI = (x(CV2) + FollowDistance cos(alpha), y(GH2) + FollowDistance sin(alpha), z(CV2))
-            local CVI = { x = CV2.x + CS * 10 * math.sin(Ca),
-              y = GH2.y - ( Distance + FollowFormation.x ) / 5, -- + FollowFormation.y,
-              z = CV2.z + CS * 10 * math.cos(Ca),
-            }
-      
-            -- Calculate the direction vector DV of the escort group. We use CVI as the base and CV2 as the direction.
-            local DV = { x = CV2.x - CVI.x, y = CV2.y - CVI.y, z = CV2.z - CVI.z }
-      
-            -- We now calculate the unary direction vector DVu, so that we can multiply DVu with the speed, which is expressed in meters / s.
-            -- We need to calculate this vector to predict the point the escort group needs to fly to according its speed.
-            -- The distance of the destination point should be far enough not to have the aircraft starting to swipe left to right...
-            local DVu = { x = DV.x / FollowDistance, y = DV.y, z = DV.z / FollowDistance }
-      
-            -- Now we can calculate the group destination vector GDV.
-            local GDV = { x = CVI.x, y = CVI.y, z = CVI.z }
-            
-            local ADDx = FollowFormation.x * math.cos(alpha) - FollowFormation.z * math.sin(alpha)
-            local ADDz = FollowFormation.z * math.cos(alpha) + FollowFormation.x * math.sin(alpha)
-            
-            local GDV_Formation = { 
-              x = GDV.x - GVx, 
-              y = GDV.y, 
-              z = GDV.z - GVz
-            }
-            
-            if self.SmokeDirectionVector == true then
-              trigger.action.smoke( GDV, trigger.smokeColor.Green )
-              trigger.action.smoke( GDV_Formation, trigger.smokeColor.White )
+              self:F( { Distance = Distance, Speed = Speed, CS = CS, GS = GS } )
+              
+  
+              -- Now route the escort to the desired point with the desired speed.
+              FollowGroup:RouteToVec3( GDV_Formation, GS ) -- DCS models speed in Mps (Miles per second)
             end
-            
-            
-            
-            local Time = 60
-            
-            local Speed = - ( Distance + FollowFormation.x ) / Time
-            local GS = Speed + CS
-            if Speed < 0 then
-              Speed = 0
-            end
-
-            -- Now route the escort to the desired point with the desired speed.
-            FollowGroup:RouteToVec3( GDV_Formation, GS ) -- DCS models speed in Mps (Miles per second)
           end
         end
       end,
       self, ClientUnit, CT1, CV1, CT2, CV2
     )
-
-    self:__Follow( -0.5 )
+    
+    self:__Follow( -self.dtFollow )
   end
   
 end

Moose Development/Moose/AI/AI_Patrol.lua

@@ -825,7 +825,7 @@ function AI_PATROL_ZONE:onafterStatus()
     
     local Fuel = self.Controllable:GetFuelMin()
     if Fuel < self.PatrolFuelThresholdPercentage then
-      self:E( self.Controllable:GetName() .. " is out of fuel:" .. Fuel .. ", RTB!" )
+      self:I( self.Controllable:GetName() .. " is out of fuel:" .. Fuel .. ", RTB!" )
       local OldAIControllable = self.Controllable
       
       local OrbitTask = OldAIControllable:TaskOrbitCircle( math.random( self.PatrolFloorAltitude, self.PatrolCeilingAltitude ), self.PatrolMinSpeed )
@@ -839,7 +839,7 @@ function AI_PATROL_ZONE:onafterStatus()
     -- TODO: Check GROUP damage function.
     local Damage = self.Controllable:GetLife()
     if Damage <= self.PatrolDamageThreshold then
-      self:E( self.Controllable:GetName() .. " is damaged:" .. Damage .. ", RTB!" )
+      self:I( self.Controllable:GetName() .. " is damaged:" .. Damage .. ", RTB!" )
       RTB = true
     end
     
@@ -900,7 +900,6 @@ end
 function AI_PATROL_ZONE:OnCrash( EventData )
 
   if self.Controllable:IsAlive() and EventData.IniDCSGroupName == self.Controllable:GetName() then
-    self:E( self.Controllable:GetUnits() )
     if #self.Controllable:GetUnits() == 1 then
       self:__Crash( 1, EventData )
     end

Moose Development/Moose/Actions/Act_Assign.lua

@@ -167,7 +167,7 @@ do -- ACT_ASSIGN_ACCEPT
   -- @param #string Event
   -- @param #string From
   -- @param #string To
-  function ACT_ASSIGN_ACCEPT:onenterAssigned( ProcessUnit, Task, From, Event, To )
+  function ACT_ASSIGN_ACCEPT:onenterAssigned( ProcessUnit, Task, From, Event, To, TaskGroup )
   
     self.Task:Assign( ProcessUnit, ProcessUnit:GetPlayerName() )
   end

Moose Development/Moose/Actions/Act_Route.lua

@@ -362,7 +362,7 @@ do -- ACT_ROUTE_POINT
       local Distance = self.Coordinate:Get2DDistance( ProcessUnit:GetCoordinate() )
       
       if Distance <= self.Range then
-        local RouteText = "You have arrived."
+        local RouteText = "Task \"" .. self:GetTask():GetName() .. "\", you have arrived."
         self:GetCommandCenter():MessageTypeToGroup( RouteText, ProcessUnit:GetGroup(), MESSAGE.Type.Information )
         return true
       end
@@ -381,7 +381,7 @@ do -- ACT_ROUTE_POINT
   -- @param #string To
   function ACT_ROUTE_POINT:onafterReport( ProcessUnit, From, Event, To )
   
-    local RouteText = self:GetRouteText( ProcessUnit )
+    local RouteText = "Task \"" .. self:GetTask():GetName() .. "\", " .. self:GetRouteText( ProcessUnit )
     
     self:GetCommandCenter():MessageTypeToGroup( RouteText, ProcessUnit:GetGroup(), MESSAGE.Type.Update )
   end
@@ -453,7 +453,7 @@ do -- ACT_ROUTE_ZONE
   function ACT_ROUTE_ZONE:onfuncHasArrived( ProcessUnit )
 
     if ProcessUnit:IsInZone( self.Zone ) then
-      local RouteText = "You have arrived within the zone."
+      local RouteText = "Task \"" .. self:GetTask():GetName() .. "\", you have arrived within the zone."
       self:GetCommandCenter():MessageTypeToGroup( RouteText, ProcessUnit:GetGroup(), MESSAGE.Type.Information )
     end
 
@@ -471,7 +471,7 @@ do -- ACT_ROUTE_ZONE
   function ACT_ROUTE_ZONE:onafterReport( ProcessUnit, From, Event, To )
     self:F( { ProcessUnit = ProcessUnit } )
   
-    local RouteText = self:GetRouteText( ProcessUnit )
+    local RouteText = "Task \"" .. self:GetTask():GetName() .. "\", " .. self:GetRouteText( ProcessUnit )
     self:GetCommandCenter():MessageTypeToGroup( RouteText, ProcessUnit:GetGroup(), MESSAGE.Type.Update )
   end
 

Moose Development/Moose/Cargo/Cargo.lua

@@ -122,7 +122,7 @@
 -- 
 -- The cargo sets are extremely important for the AI cargo transportation dispatchers and the cargo transporation tasking.
 -- 
--- # 5) Declare MOOSE cargo within the mission editor!!!
+-- # 5) Declare cargo directly in the mission editor!
 -- 
 -- But I am not finished! There is something more, that is even more great!
 -- Imagine the mission designers having to code all these lines every time it wants to embed cargo within a mission.
@@ -137,13 +137,23 @@
 -- This would be extremely tiring and a huge overload.
 -- However, the MOOSE framework allows to declare MOOSE cargo objects within the mission editor!!!
 -- 
--- So, at mission startup, MOOSE will search for objects following a special naming convention, and will create for you dynamically
--- cargo objects at mission start!!!
--- These cargo objects can then be automatically incorporated within cargo set(s)!!!
--- In other words, your mission would be reduced to about a few lines of code, providing you with a full dynamic cargo handling mission!
+-- So, at mission startup, MOOSE will search for objects following a special naming convention, and will **create** for you **dynamically
+-- cargo objects** at **mission start**!!! -- These cargo objects can then be automatically incorporated within cargo set(s)!!!
+-- In other words, your mission will be reduced to about a few lines of code, providing you with a full dynamic cargo handling mission!
+-- 
+-- ## 5.1) Use \#CARGO tags in the mission editor:
+-- 
+-- MOOSE can create automatically cargo objects, if the name of the cargo contains the **\#CARGO** tag.
+-- When a mission starts, MOOSE will scan all group and static objects it found for the presence of the \#CARGO tag.
+-- When found, MOOSE will declare the object as cargo (create in the background a CARGO_ object, like CARGO_GROUP, CARGO_CRATE or CARGO_SLINGLOAD.
+-- The creation of these CARGO_ objects will allow to be filtered and automatically added in SET_CARGO objects.
+-- In other words, with very minimal code as explained in the above code section, you are able to create vast amounts of cargo objects just from within the editor.
 -- 
 -- What I talk about is this:
 -- 
+--      -- BEFORE THIS SCRIPT STARTS, MOOSE WILL ALREADY HAVE SCANNED FOR OBJECTS WITH THE #CARGO TAG IN THE NAME.
+--      -- FOR EACH OF THESE OBJECT, MOOSE WILL HAVE CREATED CARGO_ OBJECTS LIKE CARGO_GROUP, CARGO_CRATE AND CARGO_SLINGLOAD.
+-- 
 --      HQ = GROUP:FindByName( "HQ", "Bravo" )
 --      
 --      CommandCenter = COMMANDCENTER
@@ -156,34 +166,71 @@
 --      
 --      TaskDispatcher = TASK_CARGO_DISPATCHER:New( Mission, TransportGroups )
 --      
---      
 --      -- This is the most important now. You setup a new SET_CARGO filtering the relevant type.
 --      -- The actual cargo objects are now created by MOOSE in the background.
---      -- Each cargo is setup in the Mission Editor using the ~CARGO tag in the group name.
+--      -- Each cargo is setup in the Mission Editor using the #CARGO tag in the group name.
 --      -- This allows a truly dynamic setup.
 --      local CargoSetWorkmaterials = SET_CARGO:New():FilterTypes( "Workmaterials" ):FilterStart()
 --      
 --      local WorkplaceTask = TaskDispatcher:AddTransportTask( "Build a Workplace", CargoSetWorkmaterials, "Transport the workers, engineers and the equipment near the Workplace." )
 --      TaskDispatcher:SetTransportDeployZone( WorkplaceTask, ZONE:New( "Workplace" ) )
 --      
---      Helos = { SPAWN:New( "Helicopters 1" ), SPAWN:New( "Helicopters 2" ), SPAWN:New( "Helicopters 3" ), SPAWN:New( "Helicopters 4" ), SPAWN:New( "Helicopters 5" ) }
---      
---      EnemyHelos = { SPAWN:New( "Enemy Helicopters 1" ), SPAWN:New( "Enemy Helicopters 2" ), SPAWN:New( "Enemy Helicopters 3" ) }
---      
---      function WorkplaceTask:OnAfterCargoDeployed( From, Event, To, TaskUnit, Cargo, DeployZone )
---        Helos[ math.random(1,#Helos) ]:Spawn()
---        EnemyHelos[ math.random(1,#EnemyHelos) ]:Spawn()
---      
---      end
--- 
--- Here the `CargoSetWorkmaterials` is provided as a parameter to the cargo task dispatcher object WorkplaceTask`.
+-- The above code example has the `CargoSetWorkmaterials`, which is a SET_CARGO collection and will include the CARGO_ objects of the type "Workmaterials".    
 -- And there is NO cargo object actually declared within the script! However, if you would open the mission, there would be hundreds of cargo objects...
 -- 
--- HOW? => Through a naming convention introduced. Name infantry groups in a special manner, and it can behave as MOOSE cargo!
+-- The \#CARGO tag even allows for several options to be specified, which are important to learn.
 -- 
--- 5.1) Name MOOSE cargo objects within the mission editor!
+-- ## 5.2) The \#CARGO tag to create CARGO_GROUP objects:
 -- 
+-- You can also use the \#CARGO tag on **group** objects of the mission editor.
 -- 
+-- For example, the following #CARGO naming in the **group name** of the object, will create a CARGO_GROUP object when the mission starts.
+-- 
+--   `Infantry #CARGO(T=Workmaterials,RR=500,NR=25)`
+-- 
+-- This will create a CARGO_GROUP object:
+-- 
+--    * with the group name `Infantry #CARGO`
+--    * is of type `Workmaterials`
+--    * will report when a carrier is within 500 meters
+--    * will board to carriers when the carrier is within 500 meters from the cargo object
+--    * will dissapear when the cargo is within 25 meters from the carrier during boarding
+-- 
+-- So the overall syntax of the #CARGO naming tag and arguments are:
+-- 
+--   `GroupName #CARGO(T=CargoTypeName,RR=Range,NR=Range)`
+-- 
+--    * **T=** Provide a text that contains the type name of the cargo object. This type name can be used to filter cargo within a SET_CARGO object.
+--    * **RR=** Provide the minimal range in meters when the report to the carrier, and board to the carrier.
+--      Note that this option is optional, so can be omitted. The default value of the RR is 250 meters.
+--    * **NR=** Provide the maximum range in meters when the cargo units will be boarded within the carrier during boarding.
+--      Note that this option is optional, so can be omitted. The default value of the RR is 10 meters.
+-- 
+-- ## 5.2) The \#CARGO tag to create CARGO_CRATE objects:
+-- 
+-- You can also use the \#CARGO tag on **static** objects, including **static cargo** objects of the mission editor.
+-- 
+-- For example, the following #CARGO naming in the **static name** of the object, will create a CARGO_CRATE object when the mission starts.
+-- 
+--   `Static #CARGO(T=Workmaterials,RR=500,NR=25)`
+-- 
+-- This will create a CARGO_CRATE object:
+-- 
+--    * with the group name `Static #CARGO`
+--    * is of type `Workmaterials`
+--    * will report when a carrier is within 500 meters
+--    * will board to carriers when the carrier is within 500 meters from the cargo object
+--    * will dissapear when the cargo is within 25 meters from the carrier during boarding
+-- 
+-- So the overall syntax of the #CARGO naming tag and arguments are:
+-- 
+--   `StaticName #CARGO(T=CargoTypeName,RR=Range,NR=Range)`
+-- 
+--    * **T=** Provide a text that contains the type name of the cargo object. This type name can be used to filter cargo within a SET_CARGO object.
+--    * **RR=** Provide the minimal range in meters when the report to the carrier, and board to the carrier.
+--      Note that this option is optional, so can be omitted. The default value of the RR is 250 meters.
+--    * **NR=** Provide the maximum range in meters when the cargo units will be boarded within the carrier during boarding.
+--      Note that this option is optional, so can be omitted. The default value of the RR is 10 meters.
 -- 
 -- ===
 -- 
@@ -424,7 +471,7 @@ do -- CARGO
     self.CargoLimit = 0
     
     self.LoadRadius = LoadRadius or 500
-    self.NearRadius = NearRadius or 25
+    --self.NearRadius = NearRadius or 25
     
     self:SetDeployed( false )
   
@@ -516,7 +563,7 @@ do -- CARGO
   -- @param #CARGO self
   function CARGO:Destroy()
     if self.CargoObject then
-      self.CargoObject:Destroy( false )
+      self.CargoObject:Destroy()
     end
     self:Destroyed()
   end
@@ -779,7 +826,8 @@ do -- CARGO
   
     local Distance = 0
     if self:IsUnLoaded() then
-      Distance = Coordinate:Get2DDistance( self.CargoObject:GetCoordinate() )
+      local CargoCoordinate = self.CargoObject:GetCoordinate()
+      Distance = Coordinate:Get2DDistance( CargoCoordinate )
       self:T( Distance )
       if Distance <= self.LoadRadius then
         return true
@@ -810,7 +858,7 @@ do -- CARGO
   end
 
 
-  --- Check if CargoCarrier is near the Cargo to be Loaded.
+  --- Check if CargoCarrier is near the coordinate within NearRadius.
   -- @param #CARGO self
   -- @param Core.Point#COORDINATE Coordinate
   -- @param #number NearRadius The radius when the cargo will board the Carrier (to avoid collision).
@@ -824,7 +872,7 @@ do -- CARGO
       --self:F( { CargoObjectVec2 = self.CargoObject:GetVec2() } )
       --self:F( { PointVec2 = PointVec2:GetVec2() } )
       local Distance = Coordinate:Get2DDistance( self.CargoObject:GetCoordinate() )
-      --self:F( Distance )
+      --self:F( { Distance = Distance, NearRadius = NearRadius or "nil" }  )
       
       if Distance <= NearRadius then
         --self:F( { PointVec2 = PointVec2, NearRadius = NearRadius, IsNear = true } )
@@ -875,6 +923,13 @@ do -- CARGO
     return self.CargoObject:GetCoordinate()
   end
   
+  --- Get the weight of the cargo.
+  -- @param #CARGO self
+  -- @return #number Weight The weight in kg.
+  function CARGO:GetWeight()
+    return self.Weight 
+  end
+  
   --- Set the weight of the cargo.
   -- @param #CARGO self
   -- @param #number Weight The weight in kg.
@@ -884,6 +939,22 @@ do -- CARGO
     return self
   end
   
+  --- Get the volume of the cargo.
+  -- @param #CARGO self
+  -- @return #number Volume The volume in kg.
+  function CARGO:GetVolume()
+    return self.Volume 
+  end
+  
+  --- Set the volume of the cargo.
+  -- @param #CARGO self
+  -- @param #number Volume The volume in kg.
+  -- @return #CARGO
+  function CARGO:SetVolume( Volume )
+    self.Volume = Volume
+    return self
+  end
+  
   --- Send a CC message to a @{Wrapper.Group}.
   -- @param #CARGO self
   -- @param #string Message
@@ -997,13 +1068,31 @@ do -- CARGO_REPRESENTABLE
   -- @param #CARGO_REPRESENTABLE self
   -- @param #string Type
   -- @param #string Name
-  -- @param #number Weight
   -- @param #number LoadRadius (optional)
   -- @param #number NearRadius (optional)
   -- @return #CARGO_REPRESENTABLE
-  function CARGO_REPRESENTABLE:New( CargoObject, Type, Name, Weight, LoadRadius, NearRadius )
-    local self = BASE:Inherit( self, CARGO:New( Type, Name, Weight, LoadRadius, NearRadius ) ) -- #CARGO_REPRESENTABLE
-    self:F( { Type, Name, Weight, LoadRadius, NearRadius } )
+  function CARGO_REPRESENTABLE:New( CargoObject, Type, Name, LoadRadius, NearRadius )
+    local self = BASE:Inherit( self, CARGO:New( Type, Name, 0, LoadRadius, NearRadius ) ) -- #CARGO_REPRESENTABLE
+    self:F( { Type, Name, LoadRadius, NearRadius } )
+
+    local Desc = CargoObject:GetDesc()
+    self:I( { Desc = Desc } )
+    local Weight = math.random( 80, 120 )
+    if Desc then
+      if Desc.typeName == "2B11 mortar" then
+        Weight = 210
+      else
+        Weight = Desc.massEmpty
+      end
+    end
+
+    self:SetWeight( Weight )      
+
+--      local Box = CargoUnit:GetBoundingBox()
+--      local VolumeUnit = ( Box.max.x - Box.min.x ) * ( Box.max.y - Box.min.y ) * ( Box.max.z - Box.min.z ) 
+--      self:I( { VolumeUnit = VolumeUnit, WeightUnit = WeightUnit } )
+    --self:SetVolume( VolumeUnit )
+
     
     return self
   end
@@ -1203,6 +1292,10 @@ end
 -- @param #string From
 -- @param #string To
 -- @param Wrapper.Unit#UNIT CargoCarrier
+-- @param #number Speed
+-- @param #number BoardDistance
+-- @param #number LoadDistance
+-- @param #number Angle
 function CARGO_PACKAGE:onafterOnBoarded( From, Event, To, CargoCarrier, Speed, BoardDistance, LoadDistance, Angle )
   self:F()
 
@@ -1218,6 +1311,7 @@ end
 -- @param #string Event
 -- @param #string From
 -- @param #string To
+-- @param Wrapper.Unit#UNIT CargoCarrier
 -- @param #number Speed
 -- @param #number UnLoadDistance
 -- @param #number UnBoardDistance
@@ -1261,6 +1355,7 @@ end
 -- @param #string From
 -- @param #string To
 -- @param Wrapper.Unit#UNIT CargoCarrier
+-- @param #number Speed
 function CARGO_PACKAGE:onafterUnBoarded( From, Event, To, CargoCarrier, Speed )
   self:F()
 
@@ -1304,6 +1399,8 @@ end
 -- @param #string Event
 -- @param #string From
 -- @param #string To
+-- @param Wrapper.Unit#UNIT CargoCarrier
+-- @param #number Speed
 -- @param #number Distance
 -- @param #number Angle
 function CARGO_PACKAGE:onafterUnLoad( From, Event, To, CargoCarrier, Speed, Distance, Angle )

Moose Development/Moose/Cargo/CargoCrate.lua

@@ -25,6 +25,18 @@ do -- CARGO_CRATE
   --- Defines a cargo that is represented by a UNIT object within the simulator, and can be transported by a carrier.
   -- Use the event functions as described above to Load, UnLoad, Board, UnBoard the CARGO\_CRATE objects to and from carriers.
   -- 
+  -- The above cargo classes are used by the following AI_CARGO_ classes to allow AI groups to transport cargo:
+  -- 
+  --   * AI Armoured Personnel Carriers to transport cargo and engage in battles, using the @{AI.AI_Cargo_APC} module.
+  --   * AI Helicopters to transport cargo, using the @{AI.AI_Cargo_Helicopter} module.
+  --   * AI Planes to transport cargo, using the @{AI.AI_Cargo_Airplane} module.
+  --   * AI Ships is planned.
+  -- 
+  -- The above cargo classes are also used by the TASK_CARGO_ classes to allow human players to transport cargo as part of a tasking:
+  -- 
+  --   * @{Tasking.Task_Cargo_Transport#TASK_CARGO_TRANSPORT} to transport cargo by human players.
+  --   * @{Tasking.Task_Cargo_Transport#TASK_CARGO_CSAR} to transport downed pilots by human players.
+  -- 
   -- ===
   -- 
   -- @field #CARGO_CRATE
@@ -51,9 +63,12 @@ do -- CARGO_CRATE
     
     self:HandleEvent( EVENTS.Dead, self.OnEventCargoDead )
     self:HandleEvent( EVENTS.Crash, self.OnEventCargoDead )
+    --self:HandleEvent( EVENTS.RemoveUnit, self.OnEventCargoDead )
     self:HandleEvent( EVENTS.PlayerLeaveUnit, self.OnEventCargoDead )
     
     self:SetEventPriority( 4 )
+    
+    self.NearRadius = NearRadius or 25
   
     return self
   end
@@ -141,7 +156,7 @@ do -- CARGO_CRATE
     if self.CargoObject then
       self:T("Destroying")
       self.NoDestroy = true
-      self.CargoObject:Destroy()
+      self.CargoObject:Destroy( false ) -- Do not generate a remove unit event, because we want to keep the template for later respawn in the database.
       --local Coordinate = self.CargoObject:GetCoordinate():GetRandomCoordinateInRadius( 50, 20 )
       --self.CargoObject:ReSpawnAt( Coordinate, 0 )
     end
@@ -159,6 +174,12 @@ do -- CARGO_CRATE
     return false
   end
 
+  --- Check if the cargo can be sling loaded.
+  -- @param #CARGO_CRATE self
+  function CARGO_CRATE:CanSlingload()
+    return false
+  end
+
   --- Check if Cargo Crate is in the radius for the Cargo to be reported.
   -- @param #CARGO_CRATE self
   -- @param Core.Point#COORDINATE Coordinate

Moose Development/Moose/Cargo/CargoGroup.lua

@@ -1,10 +1,6 @@
 --- **Cargo** -- Management of grouped cargo logistics, which are based on a @{Wrapper.Group} object.
 --
 -- ===
---
--- ![Banner Image](..\Presentations\CARGO\Dia1.JPG)
---
--- ===
 -- 
 -- ### [Demo Missions]()
 -- 
@@ -24,27 +20,25 @@
 do -- CARGO_GROUP
 
   --- @type CARGO_GROUP
-  -- @extends Cargo.Cargo#CARGO_REPORTABLE
   -- @field Core.Set#SET_CARGO CargoSet The collection of derived CARGO objects.
   -- @field #string GroupName The name of the CargoGroup.
+  -- @extends Cargo.Cargo#CARGO_REPORTABLE
   
   --- Defines a cargo that is represented by a @{Wrapper.Group} object within the simulator.
   -- The cargo can be Loaded, UnLoaded, Boarded, UnBoarded to and from Carriers.
   -- 
-  -- The above cargo classes are used by the AI\_CARGO\_ classes to allow AI groups to transport cargo:
+  -- The above cargo classes are used by the following AI_CARGO_ classes to allow AI groups to transport cargo:
   -- 
-  --   * AI Armoured Personnel Carriers to transport cargo and engage in battles, using the @{AI.AI_Cargo_APC#AI_CARGO_APC} class.
-  --   * AI Helicopters to transport cargo, using the @{AI.AI_Cargo_Helicopter#AI_CARGO_HELICOPTER} class.
-  --   * AI Planes to transport cargo, using the @{AI.AI_Cargo_Plane#AI_CARGO_PLANE} class.
+  --   * AI Armoured Personnel Carriers to transport cargo and engage in battles, using the @{AI.AI_Cargo_APC} module.
+  --   * AI Helicopters to transport cargo, using the @{AI.AI_Cargo_Helicopter} module.
+  --   * AI Planes to transport cargo, using the @{AI.AI_Cargo_Airplane} module.
   --   * AI Ships is planned.
   -- 
-  -- The above cargo classes are also used by the TASK\_CARGO\_ classes to allow human players to transport cargo as part of a tasking:
+  -- The above cargo classes are also used by the TASK_CARGO_ classes to allow human players to transport cargo as part of a tasking:
   -- 
   --   * @{Tasking.Task_Cargo_Transport#TASK_CARGO_TRANSPORT} to transport cargo by human players.
   --   * @{Tasking.Task_Cargo_Transport#TASK_CARGO_CSAR} to transport downed pilots by human players.
   -- 
-  -- The
-  --
   -- @field #CARGO_GROUP CARGO_GROUP
   -- 
   CARGO_GROUP = {
@@ -55,14 +49,14 @@ do -- CARGO_GROUP
   -- This make a new CARGO_GROUP from a @{Wrapper.Group} object.
   -- It will "ungroup" the group object within the sim, and will create a @{Set} of individual Unit objects.
   -- @param #CARGO_GROUP self
-  -- @param Wrapper.Group#GROUP CargoGroup
-  -- @param #string Type
-  -- @param #string Name
-  -- @param #number LoadRadius (optional)
-  -- @param #number NearRadius (optional)
-  -- @return #CARGO_GROUP
-  function CARGO_GROUP:New( CargoGroup, Type, Name, LoadRadius )
-    local self = BASE:Inherit( self, CARGO_REPORTABLE:New( Type, Name, 0, LoadRadius ) ) -- #CARGO_GROUP
+  -- @param Wrapper.Group#GROUP CargoGroup Group to be transported as cargo.
+  -- @param #string Type Cargo type, e.g. "Infantry". This is the type used in SET_CARGO:New():FilterTypes("Infantry") to define the valid cargo groups of the set.
+  -- @param #string Name A user defined name of the cargo group. This name CAN be the same as the group object but can also have a different name. This name MUST be unique!
+  -- @param #number LoadRadius (optional) Distance in meters until which a cargo is loaded into the carrier. Cargo outside this radius has to be routed by other means to within the radius to be loaded.
+  -- @param #number NearRadius (optional) Once the units are within this radius of the carrier, they are actually loaded, i.e. disappear from the scene.
+  -- @return #CARGO_GROUP Cargo group object.
+  function CARGO_GROUP:New( CargoGroup, Type, Name, LoadRadius, NearRadius )
+    local self = BASE:Inherit( self, CARGO_REPORTABLE:New( Type, Name, 0, LoadRadius, NearRadius ) ) -- #CARGO_GROUP
     self:F( { Type, Name, LoadRadius } )
   
     self.CargoSet = SET_CARGO:New()
@@ -70,46 +64,57 @@ do -- CARGO_GROUP
     self.Grouped = true
     self.CargoUnitTemplate = {}
     
+    self.NearRadius = NearRadius
+    
     self:SetDeployed( false )
     
     local WeightGroup = 0
+    local VolumeGroup = 0
     
-    self.CargoGroup:Destroy()
+    self.CargoGroup:Destroy() -- destroy and generate a unit removal event, so that the database gets cleaned, and the linked sets get properly cleaned.
 
     local GroupName = CargoGroup:GetName()
     self.CargoName = Name
     self.CargoTemplate = UTILS.DeepCopy( _DATABASE:GetGroupTemplate( GroupName ) )
 
-    local GroupTemplate = UTILS.DeepCopy( self.CargoTemplate )
-    GroupTemplate.name = self.CargoName .. "#CARGO"
-    GroupTemplate.groupId = nil
+    self.GroupTemplate = UTILS.DeepCopy( self.CargoTemplate )
+    self.GroupTemplate.name = self.CargoName .. "#CARGO"
+    self.GroupTemplate.groupId = nil
     
-    GroupTemplate.units = {}
+    self.GroupTemplate.units = {}
     
     for UnitID, UnitTemplate in pairs( self.CargoTemplate.units ) do
       UnitTemplate.name = UnitTemplate.name .. "#CARGO"
-      local CargoUnitName = UnitTemplate.name 
+      local CargoUnitName = UnitTemplate.name
       self.CargoUnitTemplate[CargoUnitName] = UnitTemplate      
 
-       GroupTemplate.units[#GroupTemplate.units+1] = self.CargoUnitTemplate[CargoUnitName]
-       GroupTemplate.units[#GroupTemplate.units].unitId = nil
+       self.GroupTemplate.units[#self.GroupTemplate.units+1] = self.CargoUnitTemplate[CargoUnitName]
+       self.GroupTemplate.units[#self.GroupTemplate.units].unitId = nil
       
       -- And we register the spawned unit as part of the CargoSet.
       local Unit = UNIT:Register( CargoUnitName )
-      --local WeightUnit = Unit:GetDesc().massEmpty
-      --WeightGroup = WeightGroup + WeightUnit
-      local CargoUnit = CARGO_UNIT:New( Unit, Type, CargoUnitName, 10 )
-      self.CargoSet:Add( CargoUnitName, CargoUnit )
+      
     end
 
     -- Then we register the new group in the database
-    self.CargoGroup = GROUP:NewTemplate( GroupTemplate, GroupTemplate.CoalitionID, GroupTemplate.CategoryID, GroupTemplate.CountryID)
+    self.CargoGroup = GROUP:NewTemplate( self.GroupTemplate, self.GroupTemplate.CoalitionID, self.GroupTemplate.CategoryID, self.GroupTemplate.CountryID )
     
     -- Now we spawn the new group based on the template created.
-    self.CargoObject = _DATABASE:Spawn( GroupTemplate )
+    self.CargoObject = _DATABASE:Spawn( self.GroupTemplate )
+    
+    for CargoUnitID, CargoUnit in pairs( self.CargoObject:GetUnits() ) do
+      
+
+      local CargoUnitName = CargoUnit:GetName()
+
+      local Cargo = CARGO_UNIT:New( CargoUnit, Type, CargoUnitName, LoadRadius, NearRadius )
+      self.CargoSet:Add( CargoUnitName, Cargo )
+
+      WeightGroup = WeightGroup + Cargo:GetWeight()
+
+    end
   
     self:SetWeight( WeightGroup )
-    self.CargoLimit = 10
     
     self:T( { "Weight Cargo", WeightGroup } )
   
@@ -118,6 +123,7 @@ do -- CARGO_GROUP
     
     self:HandleEvent( EVENTS.Dead, self.OnEventCargoDead )
     self:HandleEvent( EVENTS.Crash, self.OnEventCargoDead )
+    --self:HandleEvent( EVENTS.RemoveUnit, self.OnEventCargoDead )
     self:HandleEvent( EVENTS.PlayerLeaveUnit, self.OnEventCargoDead )
     
     self:SetEventPriority( 4 )
@@ -125,6 +131,35 @@ do -- CARGO_GROUP
     return self
   end
 
+
+  --- Respawn the CargoGroup.
+  -- @param #CARGO_GROUP self
+  function CARGO_GROUP:Respawn()
+
+    self:F( { "Respawning" } )
+
+    for CargoID, CargoData in pairs( self.CargoSet:GetSet() ) do
+      local Cargo = CargoData -- Cargo.Cargo#CARGO
+      Cargo:Destroy() -- Destroy the cargo and generate a remove unit event to update the sets.
+      Cargo:SetStartState( "UnLoaded" )
+    end
+
+    -- Now we spawn the new group based on the template created.
+    _DATABASE:Spawn( self.GroupTemplate )
+      
+    for CargoUnitID, CargoUnit in pairs( self.CargoObject:GetUnits() ) do
+
+      local CargoUnitName = CargoUnit:GetName()
+
+      local Cargo = CARGO_UNIT:New( CargoUnit, self.Type, CargoUnitName, self.LoadRadius )
+      self.CargoSet:Add( CargoUnitName, Cargo )
+
+    end
+  
+    self:SetDeployed( false )
+    self:SetStartState( "UnLoaded" )
+    
+  end
   
   --- Ungroup the cargo group into individual groups with one unit.
   -- This is required because by default a group will move in formation and this is really an issue for group control.
@@ -225,7 +260,8 @@ do -- CARGO_GROUP
   --- @param #CARGO_GROUP self
   -- @param Core.Event#EVENTDATA EventData 
   function CARGO_GROUP:OnEventCargoDead( EventData )
-    self:I( EventData )
+  
+    self:E(EventData)
 
     local Destroyed = false
   
@@ -255,28 +291,29 @@ do -- CARGO_GROUP
   
   end
 
-  --- Enter Boarding State.
+  --- After Board Event.
   -- @param #CARGO_GROUP self
-  -- @param Wrapper.Unit#UNIT CargoCarrier
   -- @param #string Event
   -- @param #string From
   -- @param #string To
-  function CARGO_GROUP:onenterBoarding( From, Event, To, CargoCarrier, NearRadius, ... )
-    --self:F( { CargoCarrier.UnitName, From, Event, To } )
+  -- @param Wrapper.Unit#UNIT CargoCarrier
+  -- @param #number NearRadius If distance is smaller than this number, cargo is loaded into the carrier.
+  function CARGO_GROUP:onafterBoard( From, Event, To, CargoCarrier, NearRadius, ... )
+    self:F( { CargoCarrier.UnitName, From, Event, To, NearRadius = NearRadius } )
     
-    local NearRadius = NearRadius or 25
+    NearRadius = NearRadius or self.NearRadius
     
-    if From == "UnLoaded" then
-  
-      -- For each Cargo object within the CARGO_GROUPED, route each object to the CargoLoadPointVec2
-      self.CargoSet:ForEach(
-        function( Cargo, ... )
-          Cargo:__Board( 1, CargoCarrier, NearRadius, ... )
-        end, ...
-      )
-      
-      self:__Boarding( 1, CargoCarrier, NearRadius, ... )
-    end
+    -- For each Cargo object within the CARGO_GROUPED, route each object to the CargoLoadPointVec2
+    self.CargoSet:ForEach(
+      function( Cargo, ... )
+        self:F( { "Board Unit", Cargo:GetName( ), Cargo:IsDestroyed(), Cargo.CargoObject:IsAlive() } )
+        local CargoGroup = Cargo.CargoObject --Wrapper.Group#GROUP
+        CargoGroup:OptionAlarmStateGreen()
+        Cargo:__Board( 1, CargoCarrier, NearRadius, ... )
+      end, ...
+    )
+    
+    self:__Boarding( -1, CargoCarrier, NearRadius, ... )
     
   end
 
@@ -286,13 +323,15 @@ do -- CARGO_GROUP
   -- @param #string From
   -- @param #string To
   -- @param Wrapper.Unit#UNIT CargoCarrier
-  function CARGO_GROUP:onenterLoaded( From, Event, To, CargoCarrier, ... )
+  function CARGO_GROUP:onafterLoad( From, Event, To, CargoCarrier, ... )
     --self:F( { From, Event, To, CargoCarrier, ...} )
     
     if From == "UnLoaded" then
       -- For each Cargo object within the CARGO_GROUP, load each cargo to the CargoCarrier.
       for CargoID, Cargo in pairs( self.CargoSet:GetSet() ) do
-        Cargo:Load( CargoCarrier )
+        if not Cargo:IsDestroyed() then
+          Cargo:Load( CargoCarrier )
+        end
       end
     end
     
@@ -303,16 +342,15 @@ do -- CARGO_GROUP
   end
 
   --- Leave Boarding State.
-  -- @param #CARGO_GROUP self
-  -- @param Wrapper.Unit#UNIT CargoCarrier
+  -- @param #CARGO_GROUP self  
   -- @param #string Event
   -- @param #string From
   -- @param #string To
+  -- @param Wrapper.Unit#UNIT CargoCarrier
+  -- @param #number NearRadius If distance is smaller than this number, cargo is loaded into the carrier.
   function CARGO_GROUP:onafterBoarding( From, Event, To, CargoCarrier, NearRadius, ... )
     --self:F( { CargoCarrier.UnitName, From, Event, To } )
   
-    local NearRadius = NearRadius or 100
-  
     local Boarded = true
     local Cancelled = false
     local Dead = true
@@ -321,10 +359,10 @@ do -- CARGO_GROUP
   
     -- For each Cargo object within the CARGO_GROUP, route each object to the CargoLoadPointVec2
     for CargoID, Cargo in pairs( self.CargoSet:GetSet() ) do
-      self:T( { Cargo:GetName(), Cargo.current } )
+      --self:T( { Cargo:GetName(), Cargo.current } )
       
       
-      if not Cargo:is( "Loaded" ) 
+      if not Cargo:is( "Loaded" )
       and (not Cargo:is( "Destroyed" )) then -- If one or more units of a group defined as CARGO_GROUP died, the CARGO_GROUP:Board() command does not trigger the CARGO_GRUOP:OnEnterLoaded() function.
         Boarded = false
       end
@@ -343,7 +381,7 @@ do -- CARGO_GROUP
   
       if not Cancelled then
         if not Boarded then
-          self:__Boarding( 1, CargoCarrier, NearRadius, ... )
+          self:__Boarding( -5, CargoCarrier, NearRadius, ... )
         else
           self:F("Group Cargo is loaded")
           self:__Load( 1, CargoCarrier, ... )
@@ -359,11 +397,12 @@ do -- CARGO_GROUP
 
   --- Enter UnBoarding State.
   -- @param #CARGO_GROUP self
-  -- @param Core.Point#POINT_VEC2 ToPointVec2
   -- @param #string Event
   -- @param #string From
   -- @param #string To
-  function CARGO_GROUP:onenterUnBoarding( From, Event, To, ToPointVec2, NearRadius, ... )
+  -- @param Core.Point#POINT_VEC2 ToPointVec2
+  -- @param #number NearRadius If distance is smaller than this number, cargo is loaded into the carrier.
+  function CARGO_GROUP:onafterUnBoard( From, Event, To, ToPointVec2, NearRadius, ... )
     self:F( {From, Event, To, ToPointVec2, NearRadius } )
   
     NearRadius = NearRadius or 25
@@ -388,7 +427,7 @@ do -- CARGO_GROUP
               ToVec=ToPointVec2
             end
             Cargo:__UnBoard( Timer, ToVec, NearRadius )
-            Timer = Timer + 3
+            Timer = Timer + 1
           end
         end, { NearRadius }
       )
@@ -401,11 +440,12 @@ do -- CARGO_GROUP
 
   --- Leave UnBoarding State.
   -- @param #CARGO_GROUP self
-  -- @param Core.Point#POINT_VEC2 ToPointVec2
   -- @param #string Event
   -- @param #string From
   -- @param #string To
-  function CARGO_GROUP:onleaveUnBoarding( From, Event, To, ToPointVec2, NearRadius, ... )
+  -- @param Core.Point#POINT_VEC2 ToPointVec2
+  -- @param #number NearRadius If distance is smaller than this number, cargo is loaded into the carrier.
+  function CARGO_GROUP:onafterUnBoarding( From, Event, To, ToPointVec2, NearRadius, ... )
     --self:F( { From, Event, To, ToPointVec2, NearRadius } )
   
     --local NearRadius = NearRadius or 25
@@ -426,7 +466,7 @@ do -- CARGO_GROUP
       end
     
       if UnBoarded then
-        return true
+        self:__UnLoad( 1, ToPointVec2, ... )
       else
         self:__UnBoarding( 1, ToPointVec2, NearRadius, ... )
       end
@@ -436,29 +476,13 @@ do -- CARGO_GROUP
     
   end
 
-  --- UnBoard Event.
-  -- @param #CARGO_GROUP self
-  -- @param Core.Point#POINT_VEC2 ToPointVec2
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  function CARGO_GROUP:onafterUnBoarding( From, Event, To, ToPointVec2, NearRadius, ... )
-    --self:F( { From, Event, To, ToPointVec2, NearRadius } )
-  
-    --local NearRadius = NearRadius or 25
-  
-    self:__UnLoad( 1, ToPointVec2, ... )
-  end
-
-
-
   --- Enter UnLoaded State.
   -- @param #CARGO_GROUP self
-  -- @param Core.Point#POINT_VEC2
   -- @param #string Event
   -- @param #string From
   -- @param #string To
-  function CARGO_GROUP:onenterUnLoaded( From, Event, To, ToPointVec2, ... )
+  -- @param Core.Point#POINT_VEC2
+  function CARGO_GROUP:onafterUnLoad( From, Event, To, ToPointVec2, ... )
     --self:F( { From, Event, To, ToPointVec2 } )
   
     if From == "Loaded" then
@@ -467,8 +491,8 @@ do -- CARGO_GROUP
       self.CargoSet:ForEach(
         function( Cargo )
           --Cargo:UnLoad( ToPointVec2 )
-          local RandomVec2=ToPointVec2:GetRandomPointVec2InRadius(10)
-          Cargo:UnLoad( RandomVec2 )
+          local RandomVec2=ToPointVec2:GetRandomPointVec2InRadius(20, 10)
+          Cargo:UnBoard( RandomVec2 )
         end
       )
   
@@ -485,8 +509,6 @@ do -- CARGO_GROUP
   -- @return Core.Point#COORDINATE The current Coordinate of the first Cargo of the CargoGroup.
   -- @return #nil There is no valid Cargo in the CargoGroup.
   function CARGO_GROUP:GetCoordinate()
-    self:F()
-
     local Cargo = self:GetFirstAlive() -- Cargo.Cargo#CARGO
     
     if Cargo then
@@ -592,8 +614,7 @@ do -- CARGO_GROUP
   -- @param #CARGO_GROUP self
   -- @param Wrapper.Group#GROUP CargoCarrier
   -- @param #number NearRadius
-  -- @return #boolean The Cargo is near to the Carrier.
-  -- @return #nil The Cargo is not near to the Carrier.
+  -- @return #boolean The Cargo is near to the Carrier or #nil if the Cargo is not near to the Carrier.
   function CARGO_GROUP:IsNear( CargoCarrier, NearRadius )
     self:F( {NearRadius = NearRadius } )
     
@@ -621,10 +642,18 @@ do -- CARGO_GROUP
 
     if Cargo then
       local Distance = 0
+      local CargoCoordinate
       if Cargo:IsLoaded() then
-        Distance = Coordinate:Get2DDistance( Cargo.CargoCarrier:GetCoordinate() )
+        CargoCoordinate = Cargo.CargoCarrier:GetCoordinate()
       else
-        Distance = Coordinate:Get2DDistance( Cargo.CargoObject:GetCoordinate() )
+        CargoCoordinate = Cargo.CargoObject:GetCoordinate()
+      end
+
+      -- FF check if coordinate could be obtained. This was commented out for some (unknown) reason. But the check seems valid!      
+      if CargoCoordinate then
+        Distance = Coordinate:Get2DDistance( CargoCoordinate )
+      else
+        return false
       end
       
       self:F( { Distance = Distance, LoadRadius = self.LoadRadius } )
@@ -665,53 +694,6 @@ do -- CARGO_GROUP
   
   end
 
-  --- Respawn the CargoGroup.
-  -- @param #CARGO_GROUP self
-  function CARGO_GROUP:Respawn()
-
-    self:F( { "Respawning" } )
-
-    for CargoID, CargoData in pairs( self.CargoSet:GetSet() ) do
-      local Cargo = CargoData -- Cargo.Cargo#CARGO
-      Cargo:Destroy()
-      Cargo:SetStartState( "UnLoaded" )
-    end
-
-    
-    -- We iterate through the group template and for each unit in the template, we create a new group with one unit.
-    for UnitID, UnitTemplate in pairs( self.CargoTemplate.units ) do
-      
-      local GroupTemplate = UTILS.DeepCopy( self.CargoTemplate )
-      local GroupName = env.getValueDictByKey( GroupTemplate.name )
-      
-      -- We create a new group object with one unit...
-      -- First we prepare the template...
-      GroupTemplate.name = GroupName .. "#CARGO#" .. UnitID
-      GroupTemplate.groupId = nil
-      GroupTemplate.units = {}
-      GroupTemplate.units[1] = UnitTemplate
-      local UnitName = UnitTemplate.name .. "#CARGO"
-      GroupTemplate.units[1].name = UnitTemplate.name .. "#CARGO"
-  
-  
-      -- Then we register the new group in the database
-      local CargoGroup = GROUP:NewTemplate( GroupTemplate, GroupTemplate.CoalitionID, GroupTemplate.CategoryID, GroupTemplate.CountryID)
-      
-      -- Now we spawn the new group based on the template created.
-      _DATABASE:Spawn( GroupTemplate )
-      
-      -- And we register the spawned unit as part of the CargoSet.
-      local Unit = UNIT:FindByName( UnitName )
-      --local WeightUnit = Unit:GetDesc().massEmpty
-      --WeightGroup = WeightGroup + WeightUnit
-      local CargoUnit = CARGO_UNIT:New( Unit, Type, UnitName, 10 )
-      self.CargoSet:Add( UnitName, CargoUnit )
-    end
-
-    self:SetDeployed( false )
-    self:SetStartState( "UnLoaded" )
-    
-  end
 
   --- Signal a flare at the position of the CargoGroup.
   -- @param #CARGO_GROUP self

Moose Development/Moose/Cargo/CargoSlingload.lua

@@ -25,6 +25,11 @@ do -- CARGO_SLINGLOAD
   
   --- Defines a cargo that is represented by a UNIT object within the simulator, and can be transported by a carrier.
   -- 
+  -- The above cargo classes are also used by the TASK_CARGO_ classes to allow human players to transport cargo as part of a tasking:
+  -- 
+  --   * @{Tasking.Task_Cargo_Transport#TASK_CARGO_TRANSPORT} to transport cargo by human players.
+  --   * @{Tasking.Task_Cargo_Transport#TASK_CARGO_CSAR} to transport downed pilots by human players.
+  -- 
   -- ===
   -- 
   -- @field #CARGO_SLINGLOAD
@@ -51,9 +56,12 @@ do -- CARGO_SLINGLOAD
     
     self:HandleEvent( EVENTS.Dead, self.OnEventCargoDead )
     self:HandleEvent( EVENTS.Crash, self.OnEventCargoDead )
+    --self:HandleEvent( EVENTS.RemoveUnit, self.OnEventCargoDead )
     self:HandleEvent( EVENTS.PlayerLeaveUnit, self.OnEventCargoDead )
     
     self:SetEventPriority( 4 )
+    
+    self.NearRadius = NearRadius or 25
   
     return self
   end

Moose Development/Moose/Cargo/CargoUnit.lua

@@ -23,7 +23,10 @@ do -- CARGO_UNIT
   -- @extends Cargo.Cargo#CARGO_REPRESENTABLE
   
   --- Defines a cargo that is represented by a UNIT object within the simulator, and can be transported by a carrier.
-  -- Use the event functions as described above to Load, UnLoad, Board, UnBoard the CARGO\_UNIT objects to and from carriers.
+  -- Use the event functions as described above to Load, UnLoad, Board, UnBoard the CARGO_UNIT objects to and from carriers.
+  -- Note that ground forces behave in a group, and thus, act in formation, regardless if one unit is commanded to move.
+  -- 
+  -- This class is used in CARGO_GROUP, and is not meant to be used by mission designers individually.
   -- 
   -- ===
   -- 
@@ -42,9 +45,9 @@ do -- CARGO_UNIT
   -- @param #number LoadRadius (optional)
   -- @param #number NearRadius (optional)
   -- @return #CARGO_UNIT
-  function CARGO_UNIT:New( CargoUnit, Type, Name, Weight, NearRadius )
-    local self = BASE:Inherit( self, CARGO_REPRESENTABLE:New( CargoUnit, Type, Name, Weight, NearRadius ) ) -- #CARGO_UNIT
-    self:I( { Type, Name, Weight, NearRadius } )
+  function CARGO_UNIT:New( CargoUnit, Type, Name, LoadRadius, NearRadius )
+    local self = BASE:Inherit( self, CARGO_REPRESENTABLE:New( CargoUnit, Type, Name, LoadRadius, NearRadius ) ) -- #CARGO_UNIT
+    self:I( { Type, Name, LoadRadius, NearRadius } )
   
     self:T( CargoUnit )
     self.CargoObject = CargoUnit
@@ -62,11 +65,10 @@ do -- CARGO_UNIT
   -- @param #string From
   -- @param #string To
   -- @param Core.Point#POINT_VEC2 ToPointVec2
+  -- @param #number NearRadius (optional) Defaut 25 m.
   function CARGO_UNIT:onenterUnBoarding( From, Event, To, ToPointVec2, NearRadius )
     self:F( { From, Event, To, ToPointVec2, NearRadius } )
   
-    NearRadius = NearRadius or 25
-  
     local Angle = 180
     local Speed = 60
     local DeployDistance = 9
@@ -131,11 +133,10 @@ do -- CARGO_UNIT
   -- @param #string From
   -- @param #string To
   -- @param Core.Point#POINT_VEC2 ToPointVec2
+  -- @param #number NearRadius (optional) Defaut 100 m.
   function CARGO_UNIT:onleaveUnBoarding( From, Event, To, ToPointVec2, NearRadius )
     self:F( { From, Event, To, ToPointVec2, NearRadius } )
   
-    NearRadius = NearRadius or 100
-  
     local Angle = 180
     local Speed = 10
     local Distance = 5
@@ -158,11 +159,10 @@ do -- CARGO_UNIT
   -- @param #string From
   -- @param #string To
   -- @param Core.Point#POINT_VEC2 ToPointVec2
+  -- @param #number NearRadius (optional) Defaut 100 m.
   function CARGO_UNIT:onafterUnBoarding( From, Event, To, ToPointVec2, NearRadius )
     self:F( { From, Event, To, ToPointVec2, NearRadius } )
   
-    NearRadius = NearRadius or 100
-  
     self.CargoInAir = self.CargoObject:InAir()
   
     self:T( self.CargoInAir )
@@ -220,58 +220,60 @@ do -- CARGO_UNIT
   -- @param #string Event
   -- @param #string From
   -- @param #string To
+  -- @param Wrapper.Group#GROUP CargoCarrier
+  -- @param #number NearRadius
   function CARGO_UNIT:onafterBoard( From, Event, To, CargoCarrier, NearRadius, ... )
-    self:F( { From, Event, To, CargoCarrier, NearRadius } )
+    self:F( { From, Event, To, CargoCarrier, NearRadius = NearRadius } )
   
-    local NearRadius = NearRadius or 25
-    
     self.CargoInAir = self.CargoObject:InAir()
     
     local Desc = self.CargoObject:GetDesc()
     local MaxSpeed = Desc.speedMaxOffRoad
     local TypeName = Desc.typeName
     
-    self:T( self.CargoInAir )
-  
-    -- Only move the group to the carrier when the cargo is not in the air
-    -- (eg. cargo can be on a oil derrick, moving the cargo on the oil derrick will drop the cargo on the sea).
-    if not self.CargoInAir then
-      if self:IsNear( CargoCarrier:GetPointVec2(), NearRadius ) then
-        self:Load( CargoCarrier, NearRadius, ... )
-      else
-        if MaxSpeed and MaxSpeed == 0 or TypeName and TypeName == "Stinger comm" then
+    --self:F({Unit=self.CargoObject:GetName()})
+    
+    -- A cargo unit can only be boarded if it is not dead
+    
+      -- Only move the group to the carrier when the cargo is not in the air
+      -- (eg. cargo can be on a oil derrick, moving the cargo on the oil derrick will drop the cargo on the sea).
+      if not self.CargoInAir then
+        -- If NearRadius is given, then use the given NearRadius, otherwise calculate the NearRadius 
+        -- based upon the Carrier bounding radius, which is calculated from the bounding rectangle on the Y axis.
+        local NearRadius = NearRadius or CargoCarrier:GetBoundingRadius() + 5
+        if self:IsNear( CargoCarrier:GetPointVec2(), NearRadius ) then
           self:Load( CargoCarrier, NearRadius, ... )
         else
+          if MaxSpeed and MaxSpeed == 0 or TypeName and TypeName == "Stinger comm" then
+            self:Load( CargoCarrier, NearRadius, ... )
+          else
+            
+            local Speed = 90
+            local Angle = 180
+            local Distance = 0
+            
+            local CargoCarrierPointVec2 = CargoCarrier:GetPointVec2()
+            local CargoCarrierHeading = CargoCarrier:GetHeading() -- Get Heading of object in degrees.
+            local CargoDeployHeading = ( ( CargoCarrierHeading + Angle ) >= 360 ) and ( CargoCarrierHeading + Angle - 360 ) or ( CargoCarrierHeading + Angle )
+            local CargoDeployPointVec2 = CargoCarrierPointVec2:Translate( Distance, CargoDeployHeading )
+            
+            -- Set the CargoObject to state Green to ensure it is boarding!
+            self.CargoObject:OptionAlarmStateGreen()
+            
+            local Points = {}
           
-          local Speed = 90
-          local Angle = 180
-          local Distance = 5
+            local PointStartVec2 = self.CargoObject:GetPointVec2()
           
-          NearRadius = NearRadius or 25
-        
-          local CargoCarrierPointVec2 = CargoCarrier:GetPointVec2()
-          local CargoCarrierHeading = CargoCarrier:GetHeading() -- Get Heading of object in degrees.
-          local CargoDeployHeading = ( ( CargoCarrierHeading + Angle ) >= 360 ) and ( CargoCarrierHeading + Angle - 360 ) or ( CargoCarrierHeading + Angle )
-          local CargoDeployPointVec2 = CargoCarrierPointVec2:Translate( Distance, CargoDeployHeading )
-          
-          -- Set the CargoObject to state Green to ensure it is boarding!
-          self.CargoObject:OptionAlarmStateGreen()
-          
-          local Points = {}
-        
-          local PointStartVec2 = self.CargoObject:GetPointVec2()
-        
-          Points[#Points+1] = PointStartVec2:WaypointGround( Speed )
-          Points[#Points+1] = CargoDeployPointVec2:WaypointGround( Speed )
-          
-          local TaskRoute = self.CargoObject:TaskRoute( Points )
-          self.CargoObject:SetTask( TaskRoute, 2 )
-          self:__Boarding( -1, CargoCarrier, NearRadius )
-          self.RunCount = 0
+            Points[#Points+1] = PointStartVec2:WaypointGround( Speed )
+            Points[#Points+1] = CargoDeployPointVec2:WaypointGround( Speed )
+            
+            local TaskRoute = self.CargoObject:TaskRoute( Points )
+            self.CargoObject:SetTask( TaskRoute, 2 )
+            self:__Boarding( -5, CargoCarrier, NearRadius, ... )
+            self.RunCount = 0
+          end
         end
       end
-    end
-    
   end
   
   
@@ -281,50 +283,57 @@ do -- CARGO_UNIT
   -- @param #string From
   -- @param #string To
   -- @param Wrapper.Client#CLIENT CargoCarrier
-  -- @param #number NearRadius
+  -- @param #number NearRadius Default 25 m.
   function CARGO_UNIT:onafterBoarding( From, Event, To, CargoCarrier, NearRadius, ... )
-    --self:F( { From, Event, To, CargoCarrier.UnitName, NearRadius } )
+    self:F( { From, Event, To, CargoCarrier:GetName(), NearRadius = NearRadius } )
     
+    self:F( { IsAlive=self.CargoObject:IsAlive() }  )
     
-    if CargoCarrier and CargoCarrier:IsAlive() and self.CargoObject and self.CargoObject:IsAlive() then 
-      if CargoCarrier:InAir() == false then
-        if self:IsNear( CargoCarrier:GetPointVec2(), NearRadius ) then
-          self:__Load( 1, CargoCarrier, ... )
-        else
-          self:__Boarding( -1, CargoCarrier, NearRadius, ... )
-          self.RunCount = self.RunCount + 1
-          if self.RunCount >= 40 then
-            self.RunCount = 0
-            local Speed = 90
-            local Angle = 180
-            local Distance = 5
+      if CargoCarrier and CargoCarrier:IsAlive() then -- and self.CargoObject and self.CargoObject:IsAlive() then 
+        if (CargoCarrier:IsAir() and not CargoCarrier:InAir()) or true then
+          local NearRadius = NearRadius or CargoCarrier:GetBoundingRadius( NearRadius ) + 5
+          if self:IsNear( CargoCarrier:GetPointVec2(), NearRadius ) then
+            self:__Load( -1, CargoCarrier, ... )
+          else
+            if self:IsNear( CargoCarrier:GetPointVec2(), 20 ) then
+              self:__Boarding( -1, CargoCarrier, NearRadius, ... )
+              self.RunCount = self.RunCount + 1
+            else
+              self:__Boarding( -2, CargoCarrier, NearRadius, ... )
+              self.RunCount = self.RunCount + 2
+            end
+            if self.RunCount >= 40 then
+              self.RunCount = 0
+              local Speed = 90
+              local Angle = 180
+              local Distance = 0
+              
+              --self:F({Unit=self.CargoObject:GetName()})
+  
+              local CargoCarrierPointVec2 = CargoCarrier:GetPointVec2()
+              local CargoCarrierHeading = CargoCarrier:GetHeading() -- Get Heading of object in degrees.
+              local CargoDeployHeading = ( ( CargoCarrierHeading + Angle ) >= 360 ) and ( CargoCarrierHeading + Angle - 360 ) or ( CargoCarrierHeading + Angle )
+              local CargoDeployPointVec2 = CargoCarrierPointVec2:Translate( Distance, CargoDeployHeading )
             
-            NearRadius = NearRadius or 25
-          
-            local CargoCarrierPointVec2 = CargoCarrier:GetPointVec2()
-            local CargoCarrierHeading = CargoCarrier:GetHeading() -- Get Heading of object in degrees.
-            local CargoDeployHeading = ( ( CargoCarrierHeading + Angle ) >= 360 ) and ( CargoCarrierHeading + Angle - 360 ) or ( CargoCarrierHeading + Angle )
-            local CargoDeployPointVec2 = CargoCarrierPointVec2:Translate( Distance, CargoDeployHeading )
-          
-            -- Set the CargoObject to state Green to ensure it is boarding!
-            self.CargoObject:OptionAlarmStateGreen()
-
-            local Points = {}
-          
-            local PointStartVec2 = self.CargoObject:GetPointVec2()
-          
-            Points[#Points+1] = PointStartVec2:WaypointGround( Speed, "Off road" )
-            Points[#Points+1] = CargoDeployPointVec2:WaypointGround( Speed, "Off road" )
-          
-            local TaskRoute = self.CargoObject:TaskRoute( Points )
-            self.CargoObject:SetTask( TaskRoute, 0.2 )
+              -- Set the CargoObject to state Green to ensure it is boarding!
+              self.CargoObject:OptionAlarmStateGreen()
+  
+              local Points = {}
+            
+              local PointStartVec2 = self.CargoObject:GetPointVec2()
+            
+              Points[#Points+1] = PointStartVec2:WaypointGround( Speed, "Off road" )
+              Points[#Points+1] = CargoDeployPointVec2:WaypointGround( Speed, "Off road" )
+            
+              local TaskRoute = self.CargoObject:TaskRoute( Points )
+              self.CargoObject:SetTask( TaskRoute, 0.2 )
+            end
           end
+        else
+          self.CargoObject:MessageToGroup( "Cancelling Boarding... Get back on the ground!", 5, CargoCarrier:GetGroup(), self:GetName() )
+          self:CancelBoarding( CargoCarrier, NearRadius, ... )
+          self.CargoObject:SetCommand( self.CargoObject:CommandStopRoute( true ) )
         end
-      else
-        self.CargoObject:MessageToGroup( "Cancelling Boarding... Get back on the ground!", 5, CargoCarrier:GetGroup(), self:GetName() )
-        self:CancelBoarding( CargoCarrier, NearRadius, ... )
-        self.CargoObject:SetCommand( self.CargoObject:CommandStopRoute( true ) )
-      end
     else
       self:E("Something is wrong")
     end
@@ -332,27 +341,6 @@ do -- CARGO_UNIT
   end
   
   
-  --- Enter Boarding State.
-  -- @param #CARGO_UNIT self
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  -- @param Wrapper.Unit#UNIT CargoCarrier
-  function CARGO_UNIT:onenterBoarding( From, Event, To, CargoCarrier, NearRadius, ... )
-    --self:F( { From, Event, To, CargoCarrier.UnitName, NearRadius } )
-    
-    local Speed = 90
-    local Angle = 180
-    local Distance = 5
-    
-    local NearRadius = NearRadius or 25
-  
-    if From == "UnLoaded" or From == "Boarding" then
-    
-    end
-    
-  end
-  
   --- Loaded State.
   -- @param #CARGO_UNIT self
   -- @param #string Event
@@ -364,10 +352,11 @@ do -- CARGO_UNIT
   
     self.CargoCarrier = CargoCarrier
     
-    -- Only destroy the CargoObject is if there is a CargoObject (packages don't have CargoObjects).
+    --self:F({Unit=self.CargoObject:GetName()})
+    
+    -- Only destroy the CargoObject if there is a CargoObject (packages don't have CargoObjects).
     if self.CargoObject then
-      self:T("Destroying")
-      self.CargoObject:Destroy()
+      self.CargoObject:Destroy( false )
       --self.CargoObject:ReSpawnAt( COORDINATE:NewFromVec2( {x=0,y=0} ), 0 )
     end
   end

Moose Development/Moose/Core/Base.lua

@@ -1,4 +1,22 @@
---- **Core** -- BASE forms **the basis of the MOOSE framework**. Each class within the MOOSE framework derives from BASE.
+--- **Core** - The base class within the framework.
+-- 
+-- ===
+-- 
+-- ## Features:
+-- 
+--   * The construction and inheritance of MOOSE classes.
+--   * The class naming and numbering system.
+--   * The class hierarchy search system.
+--   * The tracing of information or objects during mission execution for debuggin purposes.
+--   * The subscription to DCS events for event handling in MOOSE objects.
+--   * Object inspection.
+-- 
+-- ===
+-- 
+-- All classes within the MOOSE framework are derived from the BASE class.
+-- Note: The BASE class is an abstract class and is not meant to be used directly.
+-- 
+-- ===
 -- 
 -- ### Author: **FlightControl**
 -- ### Contributions: 
@@ -23,24 +41,14 @@ local _ClassID = 0
 -- @field ClassID The ID number of the class.
 -- @field ClassNameAndID The name of the class concatenated with the ID number of the class.
 
---- All classes within the MOOSE framework are derived from the BASE class. 
---  
--- BASE provides facilities for :
--- 
---   * The construction and inheritance of MOOSE classes.
---   * The class naming and numbering system.
---   * The class hierarchy search system.
---   * The tracing of information or objects during mission execution for debuggin purposes.
---   * The subscription to DCS events for event handling in MOOSE objects.
--- 
--- Note: The BASE class is an abstract class and is not meant to be used directly.
--- 
--- ## 1.1) BASE constructor
+--- BASE class
+--
+-- # 1. BASE constructor.
 -- 
 -- Any class derived from BASE, will use the @{Core.Base#BASE.New} constructor embedded in the @{Core.Base#BASE.Inherit} method. 
 -- See an example at the @{Core.Base#BASE.New} method how this is done.
 -- 
--- ## 1.2) Trace information for debugging
+-- # 2. Trace information for debugging.
 -- 
 -- The BASE class contains trace methods to trace progress within a mission execution of a certain object.
 -- These trace methods are inherited by each MOOSE class interiting BASE, soeach object created from derived class from BASE can use the tracing methods to trace its execution.
@@ -71,7 +79,7 @@ local _ClassID = 0
 -- 
 -- Below a more detailed explanation of the different method types for tracing.
 -- 
--- ### 1.2.1) Tracing methods categories
+-- ## 2.1. Tracing methods categories.
 --
 -- There are basically 3 types of tracing methods available:
 -- 
@@ -79,9 +87,9 @@ local _ClassID = 0
 --   * @{#BASE.T}: Used to trace further logic within a function giving optional variables or parameters. A T is indicated at column 44 in the DCS.log file.
 --   * @{#BASE.E}: Used to always trace information giving optional variables or parameters. An E is indicated at column 44 in the DCS.log file.
 -- 
--- ### 1.2.2) Tracing levels
+-- ## 2.2 Tracing levels.
 --
--- There are 3 tracing levels within MOOSE.  
+-- There are 3 tracing levels within MOOSE.    
 -- These tracing levels were defined to avoid bulks of tracing to be generated by lots of objects.
 -- 
 -- As such, the F and T methods have additional variants to trace level 2 and 3 respectively:
@@ -91,7 +99,7 @@ local _ClassID = 0
 --   * @{#BASE.T2}: Trace further logic within a function giving optional variables or parameters with tracing level 2.
 --   * @{#BASE.T3}: Trace further logic within a function giving optional variables or parameters with tracing level 3.
 -- 
--- ### 1.2.3) Trace activation.
+-- ## 2.3. Trace activation.
 -- 
 -- Tracing can be activated in several ways:
 -- 
@@ -101,16 +109,17 @@ local _ClassID = 0
 --   * Activate only the tracing of a certain method of a certain class through the @{#BASE.TraceClassMethod}() method.
 --   * Activate only the tracing of a certain level through the @{#BASE.TraceLevel}() method.
 -- 
--- ### 1.2.4) Check if tracing is on.
+-- ## 2.4. Check if tracing is on.
 -- 
 -- The method @{#BASE.IsTrace}() will validate if tracing is activated or not.
 -- 
--- ## 1.3 DCS simulator Event Handling
+-- 
+-- # 3. DCS simulator Event Handling.
 -- 
 -- The BASE class provides methods to catch DCS Events. These are events that are triggered from within the DCS simulator, 
 -- and handled through lua scripting. MOOSE provides an encapsulation to handle these events more efficiently.
 -- 
--- ### 1.3.1 Subscribe / Unsubscribe to DCS Events
+-- ## 3.1. Subscribe / Unsubscribe to DCS Events.
 -- 
 -- At first, the mission designer will need to **Subscribe** to a specific DCS event for the class.
 -- So, when the DCS event occurs, the class will be notified of that event.
@@ -119,7 +128,7 @@ local _ClassID = 0
 --   * @{#BASE.HandleEvent}(): Subscribe to a DCS Event.
 --   * @{#BASE.UnHandleEvent}(): Unsubscribe from a DCS Event.
 -- 
--- ### 1.3.2 Event Handling of DCS Events
+-- ## 3.2. Event Handling of DCS Events.
 -- 
 -- Once the class is subscribed to the event, an **Event Handling** method on the object or class needs to be written that will be called
 -- when the DCS event occurs. The Event Handling method receives an @{Core.Event#EVENTDATA} structure, which contains a lot of information
@@ -154,7 +163,7 @@ local _ClassID = 0
 -- 
 -- See the @{Event} module for more information about event handling.
 -- 
--- ## 1.4) Class identification methods
+-- # 4. Class identification methods.
 -- 
 -- BASE provides methods to get more information of each object:
 -- 
@@ -162,7 +171,7 @@ local _ClassID = 0
 --   * @{#BASE.GetClassName}(): Gets the name of the object, which is the name of the class the object was instantiated from.
 --   * @{#BASE.GetClassNameAndID}(): Gets the name and ID of the object.
 -- 
--- ## 1.5) All objects derived from BASE can have "States"
+-- # 5. All objects derived from BASE can have "States".
 -- 
 -- A mechanism is in place in MOOSE, that allows to let the objects administer **states**.  
 -- States are essentially properties of objects, which are identified by a **Key** and a **Value**.  
@@ -177,7 +186,7 @@ local _ClassID = 0
 -- Thus, if the state is to be set for the same object as the object for which the method is used, then provide the same
 -- object name to the method.
 -- 
--- ## 1.10) Inheritance
+-- # 6. Inheritance.
 -- 
 -- The following methods are available to implement inheritance
 -- 
@@ -186,8 +195,7 @@ local _ClassID = 0
 -- 
 -- ===
 -- 
--- @field #BASE BASE
--- 
+-- @field #BASE
 BASE = {
   ClassName = "BASE",
   ClassID = 0,
@@ -587,18 +595,36 @@ do -- Event Handling
   -- @param Core.Event#EVENTDATA EventData The EventData structure.
 
   --- Occurs when any unit begins firing a weapon that has a high rate of fire. Most common with aircraft cannons (GAU-8), autocannons, and machine guns.
-  -- initiator : The unit that is doing the shooing.
+  -- initiator : The unit that is doing the shooting.
   -- target: The unit that is being targeted. 
   -- @function [parent=#BASE] OnEventShootingStart
   -- @param #BASE self
   -- @param Core.Event#EVENTDATA EventData The EventData structure.
 
   --- Occurs when any unit stops firing its weapon. Event will always correspond with a shooting start event.
-  -- initiator : The unit that was doing the shooing. 
+  -- initiator : The unit that was doing the shooting. 
   -- @function [parent=#BASE] OnEventShootingEnd
   -- @param #BASE self
   -- @param Core.Event#EVENTDATA EventData The EventData structure.
 
+  --- Occurs when a new mark was added.
+  -- MarkID: ID of the mark. 
+  -- @function [parent=#BASE] OnEventMarkAdded
+  -- @param #BASE self
+  -- @param Core.Event#EVENTDATA EventData The EventData structure.
+
+  --- Occurs when a mark was removed.
+  -- MarkID: ID of the mark. 
+  -- @function [parent=#BASE] OnEventMarkRemoved
+  -- @param #BASE self
+  -- @param Core.Event#EVENTDATA EventData The EventData structure.
+
+  --- Occurs when a mark text was changed.
+  -- MarkID: ID of the mark. 
+  -- @function [parent=#BASE] OnEventMarkChange
+  -- @param #BASE self
+  -- @param Core.Event#EVENTDATA EventData The EventData structure.
+
 end
  
 
@@ -656,6 +682,22 @@ function BASE:CreateEventDead( EventTime, Initiator )
   world.onEvent( Event )
 end
 
+--- Creation of a Remove Unit Event.
+-- @param #BASE self
+-- @param DCS#Time EventTime The time stamp of the event.
+-- @param DCS#Object Initiator The initiating object of the event.
+function BASE:CreateEventRemoveUnit( EventTime, Initiator )
+  self:F( { EventTime, Initiator } )
+
+  local Event = {
+    id = EVENTS.RemoveUnit,
+    time = EventTime,
+    initiator = Initiator,
+    }
+
+  world.onEvent( Event )
+end
+
 --- Creation of a Takeoff Event.
 -- @param #BASE self
 -- @param DCS#Time EventTime The time stamp of the event.
@@ -763,15 +805,17 @@ do -- Scheduling
     end
     
     self.Scheduler.SchedulerObject = self.Scheduler
+    --self.MasterObject = self
     
-    local ScheduleID = _SCHEDULEDISPATCHER:AddSchedule( 
+    local ScheduleID = self.Scheduler:Schedule( 
       self, 
       SchedulerFunction,
       { ... },
       Start,
       Repeat,
       RandomizeFactor,
-      Stop
+      Stop,
+      4
     )
     
     self._.Schedules[#self._.Schedules+1] = ScheduleID
@@ -785,8 +829,10 @@ do -- Scheduling
   function BASE:ScheduleStop( SchedulerFunction )
   
     self:F3( { "ScheduleStop:" } )
-    
-  _SCHEDULEDISPATCHER:Stop( self.Scheduler, self._.Schedules[SchedulerFunction] )
+  
+    if self.Scheduler then
+      _SCHEDULEDISPATCHER:Stop( self.Scheduler, self._.Schedules[SchedulerFunction] )
+    end
   end
 
 end
@@ -798,8 +844,7 @@ end
 -- @param Object The object that will hold the Value set by the Key.
 -- @param Key The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!
 -- @param Value The value to is stored in the object.
--- @return The Value set.
--- @return #nil The Key was not found and thus the Value could not be retrieved.
+-- @return The Value set. 
 function BASE:SetState( Object, Key, Value )
 
   local ClassNameAndID = Object:GetClassNameAndID()
@@ -816,7 +861,7 @@ end
 -- @param #BASE self
 -- @param Object The object that holds the Value set by the Key.
 -- @param Key The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!
--- @return The Value retrieved.
+-- @return The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.
 function BASE:GetState( Object, Key )
 
   local ClassNameAndID = Object:GetClassNameAndID()
@@ -829,6 +874,10 @@ function BASE:GetState( Object, Key )
   return nil
 end
 
+--- Clear the state of an object.
+-- @param #BASE self
+-- @param Object The object that holds the Value set by the Key.
+-- @param StateName The key that is should be cleared.
 function BASE:ClearState( Object, StateName )
 
   local ClassNameAndID = Object:GetClassNameAndID()
@@ -842,6 +891,26 @@ end
 -- Log a trace (only shown when trace is on)
 -- TODO: Make trace function using variable parameters.
 
+--- Set trace on.
+-- @param #BASE self
+-- @usage
+-- -- Switch the tracing On
+-- BASE:TraceOn()
+function BASE:TraceOn()
+  self:TraceOnOff( true )
+end
+
+--- Set trace off.
+-- @param #BASE self
+-- @usage
+-- -- Switch the tracing Off
+-- BASE:TraceOff()
+function BASE:TraceOff()
+  self:TraceOnOff( false )
+end
+
+
+
 --- Set trace on or off
 -- Note that when trace is off, no BASE.Debug statement is performed, increasing performance!
 -- When Moose is loaded statically, (as one file), tracing is switched off by default.
@@ -856,7 +925,7 @@ end
 -- -- Switch the tracing Off
 -- BASE:TraceOnOff( false )
 function BASE:TraceOnOff( TraceOnOff )
-  _TraceOnOff = TraceOnOff
+  _TraceOnOff = TraceOnOff or true
 end
 
 
@@ -876,8 +945,8 @@ end
 -- @param #BASE self
 -- @param #number Level
 function BASE:TraceLevel( Level )
-  _TraceLevel = Level
-  self:E( "Tracing level " .. Level )
+  _TraceLevel = Level or 1
+  self:I( "Tracing level " .. _TraceLevel )
 end
 
 --- Trace all methods in MOOSE
@@ -885,12 +954,12 @@ end
 -- @param #boolean TraceAll true = trace all methods in MOOSE.
 function BASE:TraceAll( TraceAll )
   
-  _TraceAll = TraceAll
+  _TraceAll = TraceAll or true
   
   if _TraceAll then
-    self:E( "Tracing all methods in MOOSE " )
+    self:I( "Tracing all methods in MOOSE " )
   else
-    self:E( "Switched off tracing all methods in MOOSE" )
+    self:I( "Switched off tracing all methods in MOOSE" )
   end
 end
 
@@ -900,7 +969,7 @@ end
 function BASE:TraceClass( Class )
   _TraceClass[Class] = true
   _TraceClassMethod[Class] = {}
-  self:E( "Tracing class " .. Class )
+  self:I( "Tracing class " .. Class )
 end
 
 --- Set tracing for a specific method of  class
@@ -913,7 +982,7 @@ function BASE:TraceClassMethod( Class, Method )
     _TraceClassMethod[Class].Method = {}
   end
   _TraceClassMethod[Class].Method[Method] = true
-  self:E( "Tracing method " .. Method .. " of class " .. Class )
+  self:I( "Tracing method " .. Method .. " of class " .. Class )
 end
 
 --- Trace a function call. This function is private.
@@ -940,7 +1009,7 @@ function BASE:_F( Arguments, DebugInfoCurrentParam, DebugInfoFromParam )
       if DebugInfoFrom then
         LineFrom = DebugInfoFrom.currentline
       end
-      env.info( string.format( "%6d(%6d)/%1s:%20s%05d.%s(%s)" , LineCurrent, LineFrom, "F", self.ClassName, self.ClassID, Function, routines.utils.oneLineSerialize( Arguments ) ) )
+      env.info( string.format( "%6d(%6d)/%1s:%30s%05d.%s(%s)" , LineCurrent, LineFrom, "F", self.ClassName, self.ClassID, Function, routines.utils.oneLineSerialize( Arguments ) ) )
     end
   end
 end
@@ -1015,7 +1084,7 @@ function BASE:_T( Arguments, DebugInfoCurrentParam, DebugInfoFromParam )
   		if DebugInfoFrom then
   		  LineFrom = DebugInfoFrom.currentline
   	  end
-  		env.info( string.format( "%6d(%6d)/%1s:%20s%05d.%s" , LineCurrent, LineFrom, "T", self.ClassName, self.ClassID, routines.utils.oneLineSerialize( Arguments ) ) )
+  		env.info( string.format( "%6d(%6d)/%1s:%30s%05d.%s" , LineCurrent, LineFrom, "T", self.ClassName, self.ClassID, routines.utils.oneLineSerialize( Arguments ) ) )
     end
 	end
 end
@@ -1086,9 +1155,9 @@ function BASE:E( Arguments )
   	  LineFrom = DebugInfoFrom.currentline
   	end
   
-  	env.info( string.format( "%6d(%6d)/%1s:%20s%05d.%s(%s)" , LineCurrent, LineFrom, "E", self.ClassName, self.ClassID, Function, routines.utils.oneLineSerialize( Arguments ) ) )
+  	env.info( string.format( "%6d(%6d)/%1s:%30s%05d.%s(%s)" , LineCurrent, LineFrom, "E", self.ClassName, self.ClassID, Function, routines.utils.oneLineSerialize( Arguments ) ) )
   else
-    env.info( string.format( "%1s:%20s%05d(%s)" , "E", self.ClassName, self.ClassID, routines.utils.oneLineSerialize( Arguments ) ) )
+    env.info( string.format( "%1s:%30s%05d(%s)" , "E", self.ClassName, self.ClassID, routines.utils.oneLineSerialize( Arguments ) ) )
   end
   
 end
@@ -1114,9 +1183,9 @@ function BASE:I( Arguments )
       LineFrom = DebugInfoFrom.currentline
     end
   
-    env.info( string.format( "%6d(%6d)/%1s:%20s%05d.%s(%s)" , LineCurrent, LineFrom, "I", self.ClassName, self.ClassID, Function, routines.utils.oneLineSerialize( Arguments ) ) )
+    env.info( string.format( "%6d(%6d)/%1s:%30s%05d.%s(%s)" , LineCurrent, LineFrom, "I", self.ClassName, self.ClassID, Function, routines.utils.oneLineSerialize( Arguments ) ) )
   else
-    env.info( string.format( "%1s:%20s%05d(%s)" , "I", self.ClassName, self.ClassID, routines.utils.oneLineSerialize( Arguments ) ) )
+    env.info( string.format( "%1s:%30s%05d(%s)" , "I", self.ClassName, self.ClassID, routines.utils.oneLineSerialize( Arguments ) ) )
   end
   
 end

Moose Development/Moose/Core/Database.lua

@@ -1,4 +1,25 @@
---- **Core** -- DATABASE manages the database of mission objects. 
+--- **Core** - Manages several databases containing templates, mission objects, and mission information. 
+-- 
+-- ===
+-- 
+-- ## Features:
+-- 
+--   * During mission startup, scan the mission environment, and create / instantiate intelligently the different objects as defined within the mission.
+--   * Manage database of DCS Group templates (as modelled using the mission editor).
+--     - Group templates.
+--     - Unit templates.
+--     - Statics templates.
+--   * Manage database of @{Wrapper.Group#GROUP} objects alive in the mission.
+--   * Manage database of @{Wrapper.Unit#UNIT} objects alive in the mission.
+--   * Manage database of @{Wrapper.Static#STATIC} objects alive in the mission.
+--   * Manage database of players.
+--   * Manage database of client slots defined using the mission editor.
+--   * Manage database of airbases on the map, and from FARPs and ships as defined using the mission editor.
+--   * Manage database of countries.
+--   * Manage database of zone names.
+--   * Manage database of hits to units and statics.
+--   * Manage database of destroys of units and statics.
+--   * Manage database of @{Core.Zone#ZONE_BASE} objects.
 -- 
 -- ===
 -- 
@@ -60,6 +81,7 @@ DATABASE = {
   HITS = {},
   DESTROYS = {},
   ZONES = {},
+  ZONES_GOAL = {},
 }
 
 local _DATABASECoalition =
@@ -95,6 +117,7 @@ function DATABASE:New()
   self:HandleEvent( EVENTS.Birth, self._EventOnBirth )
   self:HandleEvent( EVENTS.Dead, self._EventOnDeadOrCrash )
   self:HandleEvent( EVENTS.Crash, self._EventOnDeadOrCrash )
+  self:HandleEvent( EVENTS.RemoveUnit, self._EventOnDeadOrCrash )
   self:HandleEvent( EVENTS.Hit, self.AccountHits )
   self:HandleEvent( EVENTS.NewCargo )
   self:HandleEvent( EVENTS.DeleteCargo )
@@ -164,6 +187,7 @@ end
 function DATABASE:AddUnit( DCSUnitName )
 
   if not  self.UNITS[DCSUnitName] then
+    self:I( { "Add UNIT:", DCSUnitName } )
     local UnitRegister = UNIT:Register( DCSUnitName )
     self.UNITS[DCSUnitName] = UNIT:Register( DCSUnitName )
     
@@ -187,7 +211,10 @@ function DATABASE:AddStatic( DCSStaticName )
 
   if not self.STATICS[DCSStaticName] then
     self.STATICS[DCSStaticName] = STATIC:Register( DCSStaticName )
+    return self.STATICS[DCSStaticName]
   end
+  
+  return nil
 end
 
 
@@ -279,16 +306,6 @@ do -- Zones
   
     self.ZONES[ZoneName] = nil 
   end
-  
-  --- Finds an @{Zone} based on the zone name in the DATABASE.
-  -- @param #DATABASE self
-  -- @param #string ZoneName
-  -- @return Core.Zone#ZONE_BASE The found @{Zone}.
-  function DATABASE:FindZone( ZoneName )
-  
-    local ZoneFound = self.ZONES[ZoneName]
-    return ZoneFound
-  end
 
 
   --- Private method that registers new ZONE_BASE derived objects within the DATABASE Object.
@@ -306,9 +323,9 @@ do -- Zones
     end
   
     for ZoneGroupName, ZoneGroup in pairs( self.GROUPS ) do
-      if ZoneGroupName:match("~ZONE_POLYGON") then
-        local ZoneName1 = ZoneGroupName:match("(.*)~ZONE_POLYGON")
-        local ZoneName2 = ZoneGroupName:match(".*~ZONE_POLYGON(.*)")
+      if ZoneGroupName:match("#ZONE_POLYGON") then
+        local ZoneName1 = ZoneGroupName:match("(.*)#ZONE_POLYGON")
+        local ZoneName2 = ZoneGroupName:match(".*#ZONE_POLYGON(.*)")
         local ZoneName = ZoneName1 .. ( ZoneName2 or "" )
         
         self:I( { "Register ZONE_POLYGON:", Name = ZoneName } )
@@ -323,7 +340,39 @@ do -- Zones
 
 end -- zone
 
+do -- Zone_Goal
 
+  --- Finds a @{Zone} based on the zone name.
+  -- @param #DATABASE self
+  -- @param #string ZoneName The name of the zone.
+  -- @return Core.Zone#ZONE_BASE The found ZONE.
+  function DATABASE:FindZoneGoal( ZoneName )
+  
+    local ZoneFound = self.ZONES_GOAL[ZoneName]
+    return ZoneFound
+  end
+  
+  --- Adds a @{Zone} based on the zone name in the DATABASE.
+  -- @param #DATABASE self
+  -- @param #string ZoneName The name of the zone.
+  -- @param Core.Zone#ZONE_BASE Zone The zone.
+  function DATABASE:AddZoneGoal( ZoneName, Zone )
+  
+    if not self.ZONES_GOAL[ZoneName] then
+      self.ZONES_GOAL[ZoneName] = Zone
+    end
+  end
+  
+  
+  --- Deletes a @{Zone} from the DATABASE based on the zone name.
+  -- @param #DATABASE self
+  -- @param #string ZoneName The name of the zone.
+  function DATABASE:DeleteZoneGoal( ZoneName )
+  
+    self.ZONES_GOAL[ZoneName] = nil 
+  end
+
+end -- Zone_Goal
 do -- cargo
 
   --- Adds a Cargo based on the Cargo Name in the DATABASE.
@@ -355,7 +404,7 @@ do -- cargo
     return CargoFound
   end
   
-  --- Checks if the Template name has a ~CARGO tag.
+  --- Checks if the Template name has a #CARGO tag.
   -- If yes, the group is a cargo.
   -- @param #DATABASE self
   -- @param #string TemplateName
@@ -364,7 +413,7 @@ do -- cargo
 
     TemplateName = env.getValueDictByKey( TemplateName )
   
-    local Cargo = TemplateName:match( "~(CARGO)" )
+    local Cargo = TemplateName:match( "#(CARGO)" )
 
     return Cargo and Cargo == "CARGO"    
   end
@@ -374,14 +423,15 @@ do -- cargo
   -- @return #DATABASE self
   function DATABASE:_RegisterCargos()
 
+    local Groups = UTILS.DeepCopy( self.GROUPS ) -- This is a very important statement. CARGO_GROUP:New creates a new _DATABASE.GROUP entry, which will confuse the loop. I searched 4 hours on this to find the bug!
   
-    for CargoGroupName, CargoGroup in pairs( self.GROUPS ) do
+    for CargoGroupName, CargoGroup in pairs( Groups ) do
+      self:I( { Cargo = CargoGroupName } )
       if self:IsCargo( CargoGroupName ) then
-        local CargoInfo = CargoGroupName:match("~CARGO(.*)")
+        local CargoInfo = CargoGroupName:match("#CARGO(.*)")
         local CargoParam = CargoInfo and CargoInfo:match( "%((.*)%)")
-        local CargoName1 = CargoGroupName:match("(.*)~CARGO%(.*%)")
-        local CargoName2 = CargoGroupName:match(".*~CARGO%(.*%)(.*)")
-        self:E({CargoName1 = CargoName1, CargoName2 = CargoName2 })
+        local CargoName1 = CargoGroupName:match("(.*)#CARGO%(.*%)")
+        local CargoName2 = CargoGroupName:match(".*#CARGO%(.*%)(.*)")
         local CargoName = CargoName1 .. ( CargoName2 or "" )
         local Type = CargoParam and CargoParam:match( "T=([%a%d ]+),?")
         local Name = CargoParam and CargoParam:match( "N=([%a%d]+),?") or CargoName
@@ -395,9 +445,9 @@ do -- cargo
     
     for CargoStaticName, CargoStatic in pairs( self.STATICS ) do
       if self:IsCargo( CargoStaticName ) then
-        local CargoInfo = CargoStaticName:match("~CARGO(.*)")
+        local CargoInfo = CargoStaticName:match("#CARGO(.*)")
         local CargoParam = CargoInfo and CargoInfo:match( "%((.*)%)")
-        local CargoName = CargoStaticName:match("(.*)~CARGO")
+        local CargoName = CargoStaticName:match("(.*)#CARGO")
         local Type = CargoParam and CargoParam:match( "T=([%a%d ]+),?")
         local Category = CargoParam and CargoParam:match( "C=([%a%d ]+),?")
         local Name = CargoParam and CargoParam:match( "N=([%a%d]+),?") or CargoName
@@ -459,7 +509,7 @@ end
 function DATABASE:AddGroup( GroupName )
 
   if not self.GROUPS[GroupName] then
-    self:E( { "Add GROUP:", GroupName } )
+    self:I( { "Add GROUP:", GroupName } )
     self.GROUPS[GroupName] = GROUP:Register( GroupName )
   end  
   
@@ -471,7 +521,7 @@ end
 function DATABASE:AddPlayer( UnitName, PlayerName )
 
   if PlayerName then
-    self:E( { "Add player for unit:", UnitName, PlayerName } )
+    self:I( { "Add player for unit:", UnitName, PlayerName } )
     self.PLAYERS[PlayerName] = UnitName
     self.PLAYERUNITS[PlayerName] = self:FindUnit( UnitName )
     self.PLAYERSJOINED[PlayerName] = PlayerName
@@ -483,7 +533,7 @@ end
 function DATABASE:DeletePlayer( UnitName, PlayerName )
 
   if PlayerName then
-    self:E( { "Clean player:", PlayerName } )
+    self:I( { "Clean player:", PlayerName } )
     self.PLAYERS[PlayerName] = nil
     self.PLAYERUNITS[PlayerName] = nil
   end
@@ -533,8 +583,8 @@ end
 -- SpawnCountryID, SpawnCategoryID
 -- This method is used by the SPAWN class.
 -- @param #DATABASE self
--- @param #table SpawnTemplate
--- @return #DATABASE self
+-- @param #table SpawnTemplate Template of the group to spawn.
+-- @return Wrapper.Group#GROUP Spawned group.
 function DATABASE:Spawn( SpawnTemplate )
   self:F( SpawnTemplate.name )
 
@@ -667,10 +717,12 @@ end
 
 --- Private method that registers new Static Templates within the DATABASE Object.
 -- @param #DATABASE self
--- @param #table GroupTemplate
+-- @param #table StaticTemplate
 -- @return #DATABASE self
 function DATABASE:_RegisterStaticTemplate( StaticTemplate, CoalitionID, CategoryID, CountryID )
 
+  local StaticTemplate = UTILS.DeepCopy( StaticTemplate )
+
   local StaticTemplateName = env.getValueDictByKey(StaticTemplate.name)
   
   self.Templates.Statics[StaticTemplateName] = self.Templates.Statics[StaticTemplateName] or {}
@@ -699,11 +751,17 @@ end
 
 
 --- @param #DATABASE self
-function DATABASE:GetStaticUnitTemplate( StaticName )
-  local StaticTemplate = self.Templates.Statics[StaticName].UnitTemplate
+function DATABASE:GetStaticGroupTemplate( StaticName )
+  local StaticTemplate = self.Templates.Statics[StaticName].GroupTemplate
   return StaticTemplate, self.Templates.Statics[StaticName].CoalitionID, self.Templates.Statics[StaticName].CategoryID, self.Templates.Statics[StaticName].CountryID
 end
 
+--- @param #DATABASE self
+function DATABASE:GetStaticUnitTemplate( StaticName )
+  local UnitTemplate = self.Templates.Statics[StaticName].UnitTemplate
+  return UnitTemplate, self.Templates.Statics[StaticName].CoalitionID, self.Templates.Statics[StaticName].CategoryID, self.Templates.Statics[StaticName].CountryID
+end
+
 
 function DATABASE:GetGroupNameFromUnitName( UnitName )
   return self.Templates.Units[UnitName].GroupName
@@ -750,7 +808,7 @@ function DATABASE:_RegisterPlayers()
         local UnitName = UnitData:getName()
         local PlayerName = UnitData:getPlayerName()
         if not self.PLAYERS[PlayerName] then
-          self:E( { "Add player for unit:", UnitName, PlayerName } )
+          self:I( { "Add player for unit:", UnitName, PlayerName } )
           self:AddPlayer( UnitName, PlayerName )
         end
       end
@@ -773,13 +831,13 @@ function DATABASE:_RegisterGroupsAndUnits()
       if DCSGroup:isExist() then
         local DCSGroupName = DCSGroup:getName()
   
-        self:E( { "Register Group:", DCSGroupName } )
+        self:I( { "Register Group:", DCSGroupName } )
         self:AddGroup( DCSGroupName )
 
         for DCSUnitId, DCSUnit in pairs( DCSGroup:getUnits() ) do
   
           local DCSUnitName = DCSUnit:getName()
-          self:E( { "Register Unit:", DCSUnitName } )
+          self:I( { "Register Unit:", DCSUnitName } )
           self:AddUnit( DCSUnitName )
         end
       else
@@ -788,6 +846,11 @@ function DATABASE:_RegisterGroupsAndUnits()
       
     end
   end
+  
+  self:I("Groups:")
+  for GroupName, Group in pairs( self.GROUPS ) do
+    self:I( { "Group:", GroupName } )
+  end
 
   return self
 end
@@ -798,7 +861,7 @@ end
 function DATABASE:_RegisterClients()
 
   for ClientName, ClientTemplate in pairs( self.Templates.ClientsByName ) do
-    self:E( { "Register Client:", ClientName } )
+    self:I( { "Register Client:", ClientName } )
     self:AddClient( ClientName )
   end
   
@@ -809,14 +872,14 @@ end
 function DATABASE:_RegisterStatics()
 
   local CoalitionsData = { GroupsRed = coalition.getStaticObjects( coalition.side.RED ), GroupsBlue = coalition.getStaticObjects( coalition.side.BLUE ) }
-  self:E( { Statics = CoalitionsData } )
+  self:I( { Statics = CoalitionsData } )
   for CoalitionId, CoalitionData in pairs( CoalitionsData ) do
     for DCSStaticId, DCSStatic in pairs( CoalitionData ) do
 
       if DCSStatic:isExist() then
         local DCSStaticName = DCSStatic:getName()
   
-        self:E( { "Register Static:", DCSStaticName } )
+        self:I( { "Register Static:", DCSStaticName } )
         self:AddStatic( DCSStaticName )
       else
         self:E( { "Static does not exist: ",  DCSStatic } )
@@ -836,7 +899,7 @@ function DATABASE:_RegisterAirbases()
 
       local DCSAirbaseName = DCSAirbase:getName()
 
-      self:E( { "Register Airbase:", DCSAirbaseName, DCSAirbase:getID() } )
+      self:I( { "Register Airbase:", DCSAirbaseName, DCSAirbase:getID() } )
       self:AddAirbase( DCSAirbaseName )
     end
   end
@@ -851,7 +914,7 @@ end
 -- @param #DATABASE self
 -- @param Core.Event#EVENTDATA Event
 function DATABASE:_EventOnBirth( Event )
-  self:F2( { Event } )
+  self:F( { Event } )
 
   if Event.IniDCSUnit then
     if Event.IniObjectCategory == 3 then
@@ -860,15 +923,21 @@ function DATABASE:_EventOnBirth( Event )
       if Event.IniObjectCategory == 1 then
         self:AddUnit( Event.IniDCSUnitName )
         self:AddGroup( Event.IniDCSGroupName )
+        -- Add airbase if it was spawned later in the mission.
+        local DCSAirbase = Airbase.getByName(Event.IniDCSUnitName)
+        if DCSAirbase then
+          self:I(string.format("Adding airbase %s", tostring(Event.IniDCSUnitName)))
+          self:AddAirbase(Event.IniDCSUnitName)
+        end
       end
     end
     if Event.IniObjectCategory == 1 then
       Event.IniUnit = self:FindUnit( Event.IniDCSUnitName )
       Event.IniGroup = self:FindGroup( Event.IniDCSGroupName )
       local PlayerName = Event.IniUnit:GetPlayerName()
-      self:E( { "PlayerName:", PlayerName } )
       if PlayerName then
-        self:E( { "Player Joined:", PlayerName } )
+        self:I( { "Player Joined:", PlayerName } )
+        self:AddClient( Event.IniDCSUnitName )
         if not self.PLAYERS[PlayerName] then
           self:AddPlayer( Event.IniUnitName, PlayerName )
         end
@@ -937,7 +1006,7 @@ function DATABASE:_EventOnPlayerLeaveUnit( Event )
     if Event.IniObjectCategory == 1 then
       local PlayerName = Event.IniUnit:GetPlayerName()
       if PlayerName and self.PLAYERS[PlayerName] then
-        self:E( { "Player Left:", PlayerName } )
+        self:I( { "Player Left:", PlayerName } )
         local Settings = SETTINGS:Set( PlayerName )
         Settings:RemovePlayerMenu( Event.IniUnit )
         self:DeletePlayer( Event.IniUnit, PlayerName )
@@ -989,7 +1058,8 @@ function DATABASE:ForEach( IteratorFunction, FinalizeFunction, arg, Set )
     return false
   end
 
-  local Scheduler = SCHEDULER:New( self, Schedule, {}, 0.001, 0.001, 0 )
+  --local Scheduler = SCHEDULER:New( self, Schedule, {}, 0.001, 0.001, 0 )
+  Schedule()
   
   return self
 end
@@ -1128,7 +1198,7 @@ function DATABASE:OnEventNewZone( EventData )
   self:F2( { EventData } )
 
   if EventData.Zone then
-    self:AddZone( EventData.Zone )
+    self:AddZone( EventData.Zone.ZoneName, EventData.Zone )
   end
 end
 
@@ -1184,7 +1254,7 @@ function DATABASE:_RegisterTemplates()
       
       local CoalitionSide = coalition.side[string.upper(CoalitionName)]
       if CoalitionName=="red" then
-        CoalitionSide=coalition.side.NEUTRAL
+        CoalitionSide=coalition.side.RED
       elseif CoalitionName=="blue" then
         CoalitionSide=coalition.side.BLUE
       else
@@ -1292,7 +1362,7 @@ end
       -- What is he hitting?
       if Event.TgtCategory then
   
-        if Event.IniCoalition then -- A coalition object was hit, probably a static.
+        if Event.WeaponCoalition then -- A coalition object was hit, probably a static.
           -- A target got hit
           self.HITS[Event.TgtUnitName] = self.HITS[Event.TgtUnitName] or {}
           local Hit = self.HITS[Event.TgtUnitName]
@@ -1342,18 +1412,12 @@ end
       self:T( { TargetUnitName, TargetGroupName, TargetPlayerName, TargetCoalition, TargetCategory, TargetType } )
     end
   
-    self:T( "Something got destroyed" )
-
     local Destroyed = false
 
     -- What is the player destroying?
     if self.HITS[Event.IniUnitName] then -- Was there a hit for this unit for this player before registered???
-      
-
       self.DESTROYS[Event.IniUnitName] = self.DESTROYS[Event.IniUnitName] or {}
-      
       self.DESTROYS[Event.IniUnitName] = true
-
     end
   end
 

Moose Development/Moose/Core/Event.lua

@@ -1,8 +1,15 @@
---- **Core** -- EVENT models DCS **event dispatching** using a **publish-subscribe** model.
+--- **Core** - Models DCS event dispatching using a publish-subscribe model.
 -- 
 -- ===
 -- 
--- # 1) Event Handling Overview
+-- ## Features:
+-- 
+--   * Capture DCS events and dispatch them to the subscribed objects.
+--   * Generate DCS events to the subscribed objects from within the code.
+-- 
+-- ===
+-- 
+-- # Event Handling Overview
 -- 
 -- ![Objects](..\Presentations\EVENT\Dia2.JPG)
 -- 
@@ -14,7 +21,7 @@
 -- Objects can subscribe to different events. The Event dispatcher will publish the received DCS events to the subscribed MOOSE objects, in a specified order.
 -- In this way, the subscribed MOOSE objects are kept in sync with your evolving running mission.
 -- 
--- ## 1.1) Event Dispatching
+-- ## 1. Event Dispatching
 -- 
 -- ![Objects](..\Presentations\EVENT\Dia4.JPG)
 -- 
@@ -41,7 +48,7 @@
 -- 
 -- But for some DCS events, the publishing order is reversed. This is due to the fact that objects need to be **erased** instead of added.
 -- 
--- ## 1.2) Event Handling
+-- # 2. Event Handling
 -- 
 -- ![Objects](..\Presentations\EVENT\Dia8.JPG)
 -- 
@@ -53,7 +60,7 @@
 -- The BASE class provides methods to catch DCS Events. These are events that are triggered from within the DCS simulator, 
 -- and handled through lua scripting. MOOSE provides an encapsulation to handle these events more efficiently.
 -- 
--- ### 1.2.1 Subscribe / Unsubscribe to DCS Events
+-- ## 2.1. Subscribe to / Unsubscribe from DCS Events.
 -- 
 -- At first, the mission designer will need to **Subscribe** to a specific DCS event for the class.
 -- So, when the DCS event occurs, the class will be notified of that event.
@@ -69,7 +76,7 @@
 -- So if a UNIT within the mission has the subscribed event for that object, 
 -- then the object event handler will receive the event for that UNIT!
 -- 
--- ### 1.3.2 Event Handling of DCS Events
+-- ## 2.2 Event Handling of DCS Events
 -- 
 -- Once the class is subscribed to the event, an **Event Handling** method on the object or class needs to be written that will be called
 -- when the DCS event occurs. The Event Handling method receives an @{Core.Event#EVENTDATA} structure, which contains a lot of information
@@ -100,19 +107,19 @@
 --        self:SmokeBlue()
 --      end
 -- 
--- ### 1.3.3 Event Handling methods that are automatically called upon subscribed DCS events
+-- ## 2.3 Event Handling methods that are automatically called upon subscribed DCS events.
 -- 
 -- ![Objects](..\Presentations\EVENT\Dia10.JPG)
 -- 
 -- The following list outlines which EVENTS item in the structure corresponds to which Event Handling method.
 -- Always ensure that your event handling methods align with the events being subscribed to, or nothing will be executed.
 -- 
--- # 2) EVENTS type
+-- # 3. EVENTS type
 -- 
 -- The EVENTS structure contains names for all the different DCS events that objects can subscribe to using the 
 -- @{Core.Base#BASE.HandleEvent}() method.
 -- 
--- # 3) EVENTDATA type
+-- # 4. EVENTDATA type
 -- 
 -- The @{Core.Event#EVENTDATA} structure contains all the fields that are populated with event information before 
 -- an Event Handler method is being called by the event dispatcher.
@@ -166,11 +173,12 @@
 -- @image Core_Event.JPG
 
 
---- The EVENT structure
--- 
--- @type EVENT
+--- @type EVENT
 -- @field #EVENT.Events Events
 -- @extends Core.Base#BASE
+
+--- The EVENT class
+-- @field #EVENT
 EVENT = {
   ClassName = "EVENT",
   ClassID = 0,
@@ -181,6 +189,10 @@ world.event.S_EVENT_NEW_CARGO = world.event.S_EVENT_MAX + 1000
 world.event.S_EVENT_DELETE_CARGO = world.event.S_EVENT_MAX + 1001
 world.event.S_EVENT_NEW_ZONE = world.event.S_EVENT_MAX + 1002
 world.event.S_EVENT_DELETE_ZONE = world.event.S_EVENT_MAX + 1003
+world.event.S_EVENT_NEW_ZONE_GOAL = world.event.S_EVENT_MAX + 1004
+world.event.S_EVENT_DELETE_ZONE_GOAL = world.event.S_EVENT_MAX + 1005
+world.event.S_EVENT_REMOVE_UNIT = world.event.S_EVENT_MAX + 1006
+
 
 --- The different types of events supported by MOOSE.
 -- Use this structure to subscribe to events using the @{Core.Base#BASE.HandleEvent}() method.
@@ -216,6 +228,9 @@ EVENTS = {
   DeleteCargo =       world.event.S_EVENT_DELETE_CARGO,
   NewZone =           world.event.S_EVENT_NEW_ZONE,
   DeleteZone =        world.event.S_EVENT_DELETE_ZONE,
+  NewZoneGoal =       world.event.S_EVENT_NEW_ZONE_GOAL,
+  DeleteZoneGoal =    world.event.S_EVENT_DELETE_ZONE_GOAL,
+  RemoveUnit =        world.event.S_EVENT_REMOVE_UNIT,
 }
 
 --- The Event structure
@@ -257,10 +272,20 @@ EVENTS = {
 -- @field DCS#Unit.Category TgtCategory (UNIT) The category of the target.
 -- @field #string TgtTypeName (UNIT) The type name of the target.
 -- 
--- @field weapon The weapon used during the event.
--- @field Weapon
--- @field WeaponName
--- @field WeaponTgtDCSUnit
+-- @field DCS#Airbase place The @{DCS#Airbase}
+-- @field Wrapper.Airbase#AIRBASE Place The MOOSE airbase object.
+-- @field #string PlaceName The name of the airbase.
+-- 
+-- @field #table weapon The weapon used during the event.
+-- @field #table Weapon
+-- @field #string WeaponName Name of the weapon.
+-- @field DCS#Unit WeaponTgtDCSUnit Target DCS unit of the weapon.
+-- 
+-- @field Cargo.Cargo#CARGO Cargo The cargo object.
+-- @field #string CargoName The name of the cargo object.
+-- 
+-- @field Core.ZONE#ZONE Zone The zone object.
+-- @field #string ZoneName The name of the zone.
 
 
 
@@ -441,6 +466,21 @@ local _EVENTMETA = {
      Event = "OnEventDeleteZone",
      Text = "S_EVENT_DELETE_ZONE" 
    },
+   [EVENTS.NewZoneGoal] = {
+     Order = 1,
+     Event = "OnEventNewZoneGoal",
+     Text = "S_EVENT_NEW_ZONE_GOAL" 
+   },
+   [EVENTS.DeleteZoneGoal] = {
+     Order = 1,
+     Event = "OnEventDeleteZoneGoal",
+     Text = "S_EVENT_DELETE_ZONE_GOAL" 
+   },
+   [EVENTS.RemoveUnit] = {
+     Order = -1,
+     Event = "OnEventRemoveUnit",
+     Text = "S_EVENT_REMOVE_UNIT" 
+   },
 }
 
 
@@ -495,7 +535,6 @@ function EVENT:RemoveEvent( EventClass, EventID  )
   self.Events = self.Events or {}
   self.Events[EventID] = self.Events[EventID] or {}
   self.Events[EventID][EventPriority] = self.Events[EventID][EventPriority] or {}  
-  self.Events[EventID][EventPriority][EventClass] = self.Events[EventID][EventPriority][EventClass]
     
   self.Events[EventID][EventPriority][EventClass] = nil
   
@@ -719,7 +758,7 @@ do -- Event Creation
   -- @param #EVENT self
   -- @param AI.AI_Cargo#AI_CARGO Cargo The Cargo created.
   function EVENT:CreateEventNewCargo( Cargo )
-    self:F( { Cargo } )
+    self:I( { Cargo } )
   
     local Event = {
       id = EVENTS.NewCargo,
@@ -775,6 +814,38 @@ do -- Event Creation
     world.onEvent( Event )
   end
 
+  --- Creation of a New ZoneGoal Event.
+  -- @param #EVENT self
+  -- @param Core.Functional#ZONE_GOAL ZoneGoal The ZoneGoal created.
+  function EVENT:CreateEventNewZoneGoal( ZoneGoal )
+    self:F( { ZoneGoal } )
+  
+    local Event = {
+      id = EVENTS.NewZoneGoal,
+      time = timer.getTime(),
+      ZoneGoal = ZoneGoal,
+      }
+  
+    world.onEvent( Event )
+  end
+
+
+  --- Creation of a ZoneGoal Deletion Event.
+  -- @param #EVENT self
+  -- @param Core.ZoneGoal#ZONE_GOAL ZoneGoal The ZoneGoal created.
+  function EVENT:CreateEventDeleteZoneGoal( ZoneGoal )
+    self:F( { ZoneGoal } )
+  
+    local Event = {
+      id = EVENTS.DeleteZoneGoal,
+      time = timer.getTime(),
+      ZoneGoal = ZoneGoal,
+      }
+  
+    world.onEvent( Event )
+  end
+
+
   --- Creation of a S_EVENT_PLAYER_ENTER_UNIT Event.
   -- @param #EVENT self
   -- @param Wrapper.Unit#UNIT PlayerUnit.
@@ -839,9 +910,9 @@ function EVENT:onEvent( Event )
         if Event.IniDCSGroup and Event.IniDCSGroup:isExist() then
           Event.IniDCSGroupName = Event.IniDCSGroup:getName()
           Event.IniGroup = GROUP:FindByName( Event.IniDCSGroupName )
-          if Event.IniGroup then
+          --if Event.IniGroup then
             Event.IniGroupName = Event.IniDCSGroupName
-          end
+          --end
         end
         Event.IniPlayerName = Event.IniDCSUnit:getPlayerName()
         Event.IniCoalition = Event.IniDCSUnit:getCoalition()
@@ -893,9 +964,9 @@ function EVENT:onEvent( Event )
         if Event.TgtDCSGroup and Event.TgtDCSGroup:isExist() then
           Event.TgtDCSGroupName = Event.TgtDCSGroup:getName()
           Event.TgtGroup = GROUP:FindByName( Event.TgtDCSGroupName )
-          if Event.TgtGroup then
+          --if Event.TgtGroup then
             Event.TgtGroupName = Event.TgtDCSGroupName
-          end
+          --end
         end
         Event.TgtPlayerName = Event.TgtDCSUnit:getPlayerName()
         Event.TgtCoalition = Event.TgtDCSUnit:getCoalition()
@@ -933,9 +1004,14 @@ function EVENT:onEvent( Event )
       Event.WeaponTypeName = Event.WeaponUNIT and Event.Weapon:getTypeName()
       --Event.WeaponTgtDCSUnit = Event.Weapon:getTarget()
     end
+    
+    -- Place should be given for takeoff and landing events as well as base captured. It should be a DCS airbase. 
+    if Event.place then      
+      Event.Place=AIRBASE:Find(Event.place)
+      Event.PlaceName=Event.Place:GetName()
+    end
 
---  @FC: something like this should be added.
---[[    
+    --  Mark points.
     if Event.idx then
       Event.MarkID=Event.idx
       Event.MarkVec3=Event.pos
@@ -944,7 +1020,6 @@ function EVENT:onEvent( Event )
       Event.MarkCoalition=Event.coalition
       Event.MarkGroupID = Event.groupID
     end
-]]
     
     if Event.cargo then
       Event.Cargo = Event.cargo
@@ -961,7 +1036,7 @@ function EVENT:onEvent( Event )
     local PriorityEnd = PriorityOrder == -1 and 1 or 5
 
     if Event.IniObjectCategory ~= Object.Category.STATIC then
-      self:E( { EventMeta.Text, Event, Event.IniDCSUnitName, Event.TgtDCSUnitName, PriorityOrder } )
+      self:F( { EventMeta.Text, Event, Event.IniDCSUnitName, Event.TgtDCSUnitName, PriorityOrder } )
     end
     
     for EventPriority = PriorityBegin, PriorityEnd, PriorityOrder do
@@ -985,7 +1060,8 @@ function EVENT:onEvent( Event )
             if EventClass:IsAlive() or
                Event.id == EVENTS.PlayerEnterUnit or 
                Event.id == EVENTS.Crash or 
-               Event.id == EVENTS.Dead then
+               Event.id == EVENTS.Dead or 
+               Event.id == EVENTS.RemoveUnit then
             
               local UnitName = EventClass:GetName()
 
@@ -1035,7 +1111,8 @@ function EVENT:onEvent( Event )
               if EventClass:IsAlive() or
                  Event.id == EVENTS.PlayerEnterUnit or
                  Event.id == EVENTS.Crash or
-                 Event.id == EVENTS.Dead then
+                 Event.id == EVENTS.Dead or
+                 Event.id == EVENTS.RemoveUnit then
 
                 -- We can get the name of the EventClass, which is now always a GROUP object.
                 local GroupName = EventClass:GetName()

Moose Development/Moose/Core/Fsm.lua

@@ -1,5 +1,18 @@
---- **Core** -- The **FSM** (**F**inite **S**tate **M**achine) class and derived **FSM\_** classes 
--- are design patterns allowing efficient (long-lasting) processes and workflows.
+--- **Core** - FSM (Finite State Machine) are objects that model and control long lasting business processes and workflow.
+-- 
+-- ===
+-- 
+-- ## Features:
+-- 
+--   * Provide a base class to model your own state machines.
+--   * Trigger events synchronously.
+--   * Trigger events asynchronously.
+--   * Handle events before or after the event was triggered.
+--   * Handle state transitions as a result of event before and after the state change.
+--   * For internal moose purposes, further state machines have been designed:
+--     - to handle controllables (groups and units).
+--     - to handle tasks.
+--     - to handle processes.
 -- 
 -- ===
 -- 
@@ -325,7 +338,7 @@ do -- FSM
   --
   -- ===
   -- 
-  -- @field #FSM FSM
+  -- @field #FSM
   -- 
   FSM = {
     ClassName = "FSM",
@@ -581,7 +594,17 @@ do -- FSM
       return errmsg
     end
     if self[handler] then
-      self:T( "*** FSM ***    " .. step .. " *** " .. params[1] .. " --> " .. params[2] .. " --> " .. params[3] )
+      if step == "onafter" or step == "OnAfter" then
+        self:T( ":::>" .. step .. params[2] .. " : " .. params[1] .. " >> " .. params[2] .. ">" .. step .. params[2] .. "()" .. " >> " .. params[3] )
+      elseif step == "onbefore" or step == "OnBefore" then
+        self:T( ":::>" .. step .. params[2] .. " : " .. params[1] .. " >> " .. step .. params[2] .. "()" .. ">" .. params[2] .. " >> " .. params[3] )
+      elseif step == "onenter" or step == "OnEnter" then
+        self:T( ":::>" .. step .. params[3] .. " : " .. params[1] .. " >> " .. params[2] .. " >> "  .. step .. params[3] .. "()" .. ">" .. params[3] )
+      elseif step == "onleave" or step == "OnLeave" then
+        self:T( ":::>" .. step .. params[1] .. " : " .. params[1] .. ">" .. step .. params[1] .. "()" .. " >> " .. params[2] .. " >> " .. params[3] )
+      else
+        self:T( ":::>" .. step .. " : " .. params[1] .. " >> " .. params[2] .. " >> " .. params[3] )
+      end      
       self._EventSchedules[EventName] = nil
       local Result, Value = xpcall( function() return self[handler]( self, unpack( params ) ) end, ErrorHandler )
       return Value
@@ -705,13 +728,13 @@ do -- FSM
         if DelaySeconds < 0 then -- Only call the event ONCE!
           DelaySeconds = math.abs( DelaySeconds )
           if not self._EventSchedules[EventName] then
-            CallID = self.CallScheduler:Schedule( self, self._handler, { EventName, ... }, DelaySeconds or 1 )
+            CallID = self.CallScheduler:Schedule( self, self._handler, { EventName, ... }, DelaySeconds or 1, nil, nil, nil, 4, true )
             self._EventSchedules[EventName] = CallID
           else
             -- reschedule
           end
         else
-          CallID = self.CallScheduler:Schedule( self, self._handler, { EventName, ... }, DelaySeconds or 1 )
+          CallID = self.CallScheduler:Schedule( self, self._handler, { EventName, ... }, DelaySeconds or 1, nil, nil, nil, 4, true )
         end
       else
         error( "FSM: An asynchronous event trigger requires a DelaySeconds parameter!!! This can be positive or negative! Sorry, but will not process this." )
@@ -805,8 +828,7 @@ do -- FSM_CONTROLLABLE
   -- 
   -- ===
   -- 
-  -- @field #FSM_CONTROLLABLE FSM_CONTROLLABLE
-  -- 
+  -- @field #FSM_CONTROLLABLE
   FSM_CONTROLLABLE = {
     ClassName = "FSM_CONTROLLABLE",
   }
@@ -981,8 +1003,9 @@ do -- FSM_PROCESS
         self:T( "*** FSM ***    " .. step .. " *** " .. params[1] .. " --> " .. params[2] .. " --> " .. params[3] .. " *** Task: " .. self.Task:GetName() .. ", TaskUnit: " .. self.Controllable:GetName() )
       end
       self._EventSchedules[EventName] = nil
+      local Result, Value
       if self.Controllable and self.Controllable:IsAlive() == true then
-        local Result, Value = xpcall( function() return self[handler]( self, self.Controllable, self.Task, unpack( params ) ) end, ErrorHandler )
+        Result, Value = xpcall( function() return self[handler]( self, self.Controllable, self.Task, unpack( params ) ) end, ErrorHandler )
       end
       return Value
       --return self[handler]( self, self.Controllable, unpack( params ) )
@@ -1204,10 +1227,22 @@ do -- FSM_TASK
   function FSM_TASK:_call_handler( step, trigger, params, EventName )
     local handler = step .. trigger
     
+    local ErrorHandler = function( errmsg )
+  
+      env.info( "Error in SCHEDULER function:" .. errmsg )
+      if BASE.Debug ~= nil then
+        env.info( BASE.Debug.traceback() )
+      end
+      
+      return errmsg
+    end
+
     if self[handler] then
       self:T( "*** FSM ***    " .. step .. " *** " .. params[1] .. " --> " .. params[2] .. " --> " .. params[3] .. " *** Task: " .. self.TaskName )
       self._EventSchedules[EventName] = nil
-      return self[handler]( self, unpack( params ) )
+      --return self[handler]( self, unpack( params ) )
+      local Result, Value = xpcall( function() return self[handler]( self, unpack( params ) ) end, ErrorHandler )
+      return Value
     end
   end
 

Moose Development/Moose/Core/Goal.lua

@@ -1,8 +1,16 @@
---- **Core (WIP)** -- Base class to allow the modeling of processes to achieve Goals.
+--- **Core** - Models the process to achieve goal(s).
 --
 -- ===
 -- 
--- GOAL models processes that have an objective with a defined achievement. Derived classes implement the ways how the achievements can be realized.
+-- ## Features:
+-- 
+--   * Define the goal.
+--   * Monitor the goal achievement.
+--   * Manage goal contribution by players.
+-- 
+-- ===
+-- 
+-- Classes that implement a goal achievement, will derive from GOAL to implement the ways how the achievements can be realized.
 -- 
 -- ===
 -- 
@@ -13,6 +21,7 @@
 -- @module Core.Goal
 -- @image Core_Goal.JPG
 
+
 do -- Goal
 
   --- @type GOAL
@@ -21,21 +30,43 @@ do -- Goal
 
   --- Models processes that have an objective with a defined achievement. Derived classes implement the ways how the achievements can be realized.
   -- 
-  -- ## 1. GOAL constructor
+  -- # 1. GOAL constructor
   --   
   --   * @{#GOAL.New}(): Creates a new GOAL object.
   -- 
-  -- ## 2. GOAL is a finite state machine (FSM).
+  -- # 2. GOAL is a finite state machine (FSM).
   -- 
-  -- ### 2.1 GOAL States
+  -- ## 2.1. GOAL States
   -- 
   --   * **Pending**: The goal object is in progress.
   --   * **Achieved**: The goal objective is Achieved.
   -- 
-  -- ### 2.2 GOAL Events
+  -- ## 2.2. GOAL Events
   -- 
   --   * **Achieved**: Set the goal objective to Achieved.
   -- 
+  -- # 3. Player contributions.
+  -- 
+  -- Goals are most of the time achieved by players. These player achievements can be registered as part of the goal achievement.
+  -- Use @{#GOAL.AddPlayerContribution}() to add a player contribution to the goal.
+  -- The player contributions are based on a points system, an internal counter per player.
+  -- So once the goal has been achieved, the player contributions can be queried using @{#GOAL.GetPlayerContributions}(), 
+  -- that retrieves all contributions done by the players. For one player, the contribution can be queried using @{#GOAL.GetPlayerContribution}().
+  -- The total amount of player contributions can be queried using @{#GOAL.GetTotalContributions}().
+  -- 
+  -- # 4. Goal achievement.
+  -- 
+  -- Once the goal is achieved, the mission designer will need to trigger the goal achievement using the **Achieved** event.
+  -- The underlying 2 examples will achieve the goals for the `Goal` object:
+  -- 
+  --       Goal:Achieved() -- Achieve the goal immediately.
+  --       Goal:__Achieved( 30 ) -- Achieve the goal within 30 seconds.
+  -- 
+  -- # 5. Check goal achievement.
+  -- 
+  -- The method @{#GOAL.IsAchieved}() will return true if the goal is achieved (the trigger **Achieved** was executed).
+  -- You can use this method to check asynchronously if a goal has been achieved, for example using a scheduler.
+  -- 
   -- @field #GOAL
   GOAL = {
     ClassName = "GOAL",
@@ -107,9 +138,11 @@ do -- Goal
   end
   
   
-  --- @param #GOAL self
-  -- @param #string PlayerName
+  --- Add a new contribution by a player.
+  -- @param #GOAL self
+  -- @param #string PlayerName The name of the player.
   function GOAL:AddPlayerContribution( PlayerName )
+    self:F({PlayerName})
     self.Players[PlayerName] = self.Players[PlayerName] or 0
     self.Players[PlayerName] = self.Players[PlayerName] + 1
     self.TotalContributions = self.TotalContributions + 1
@@ -123,21 +156,28 @@ do -- Goal
   end
 
   
-  --- @param #GOAL self
+  --- Get the players who contributed to achieve the goal.
+  -- The result is a list of players, sorted by the name of the players.
+  -- @param #GOAL self
+  -- @return #list The list of players, indexed by the player name.
   function GOAL:GetPlayerContributions()
     return self.Players or {}
   end
 
   
-  --- @param #GOAL self
+  --- Gets the total contributions that happened to achieve the goal.
+  -- The result is a number.
+  -- @param #GOAL self
+  -- @return #number The total number of contributions. 0 is returned if there were no contributions (yet).
   function GOAL:GetTotalContributions()
     return self.TotalContributions or 0
   end
   
   
   
-  --- @param #GOAL self
-  -- @return #boolean true if the goal is Achieved
+  --- Validates if the goal is achieved.
+  -- @param #GOAL self
+  -- @return #boolean true if the goal is achieved.
   function GOAL:IsAchieved()
     return self:Is( "Achieved" )
   end

Moose Development/Moose/Core/Menu.lua

@@ -1,7 +1,27 @@
---- **Core** -- MENU_ classes model the definition of **hierarchical menu structures** and **commands for players** within a mission.
+--- **Core** - Manage hierarchical menu structures and commands for players within a mission.
 -- 
 -- ===
 -- 
+-- ### Features:
+-- 
+--   * Setup mission sub menus.
+--   * Setup mission command menus.
+--   * Setup coalition sub menus.
+--   * Setup coalition command menus.
+--   * Setup group sub menus.
+--   * Setup group command menus.
+--   * Manage menu creation intelligently, avoid double menu creation.
+--   * Only create or delete menus when required, and keep existing menus persistent.
+--   * Update menu structures.
+--   * Refresh menu structures intelligently, based on a time stamp of updates.
+--     - Delete obscolete menus.
+--     - Create new one where required.
+--     - Don't touch the existing ones.
+--   * Provide a variable amount of parameters to menus.
+--   * Update the parameters and the receiving methods, without updating the menu within DCS!
+--   * Provide a great performance boost in menu management.
+--   * Provide a great tool to manage menus in your code.
+-- 
 -- DCS Menus can be managed using the MENU classes. 
 -- The advantage of using MENU classes is that it hides the complexity of dealing with menu management in more advanced scanerios where you need to 
 -- set menus and later remove them, and later set them again. You'll find while using use normal DCS scripting functions, that setting and removing
@@ -89,11 +109,14 @@ function MENU_INDEX:PrepareCoalition( CoalitionSide )
     self.Coalition[CoalitionSide].Menus = self.Coalition[CoalitionSide].Menus or {}
 end
 
-
+---
+-- @param Wrapper.Group#GROUP Group
 function MENU_INDEX:PrepareGroup( Group )
+  if Group and Group:IsAlive() ~= nil  then -- something was changed here!
     local GroupName = Group:GetName()
     self.Group[GroupName] = self.Group[GroupName] or {}
     self.Group[GroupName].Menus = self.Group[GroupName].Menus or {}
+  end
 end
 
 
@@ -133,14 +156,17 @@ end
 
 
 function MENU_INDEX:HasGroupMenu( Group, Path )
-
-  local MenuGroupName = Group:GetName()
-  return self.Group[MenuGroupName].Menus[Path]
+  if Group and Group:IsAlive() then
+    local MenuGroupName = Group:GetName()
+    return self.Group[MenuGroupName].Menus[Path]
+  end
+  return nil
 end
 
 function MENU_INDEX:SetGroupMenu( Group, Path, Menu )
 
   local MenuGroupName = Group:GetName()
+  Group:F({MenuGroupName=MenuGroupName,Path=Path})
   self.Group[MenuGroupName].Menus[Path] = Menu
 end
 
@@ -212,7 +238,7 @@ do -- MENU_BASE
   	self.Path = ( self.ParentMenu and "@" .. table.concat( self.MenuParentPath or {}, "@" ) or "" ) .. "@" .. self.MenuText
     self.Menus = {}
     self.MenuCount = 0
-    self.MenuTime = timer.getTime()
+    self.MenuStamp = timer.getTime()
     self.MenuRemoveParent = false
   	
     if self.ParentMenu then
@@ -259,13 +285,31 @@ do -- MENU_BASE
   function MENU_BASE:GetMenu( MenuText )
     return self.Menus[MenuText]
   end
+
+  --- Sets a menu stamp for later prevention of menu removal.
+  -- @param #MENU_BASE self
+  -- @param MenuStamp
+  -- @return #MENU_BASE
+  function MENU_BASE:SetStamp( MenuStamp )
+    self.MenuStamp = MenuStamp
+    return self
+  end
+  
+  
+  --- Gets a menu stamp for later prevention of menu removal.
+  -- @param #MENU_BASE self
+  -- @return MenuStamp
+  function MENU_BASE:GetStamp()
+    return timer.getTime()
+  end
+  
   
   --- Sets a time stamp for later prevention of menu removal.
   -- @param #MENU_BASE self
-  -- @param MenuTime
+  -- @param MenuStamp
   -- @return #MENU_BASE
-  function MENU_BASE:SetTime( MenuTime )
-    self.MenuTime = MenuTime
+  function MENU_BASE:SetTime( MenuStamp )
+    self.MenuStamp = MenuStamp
     return self
   end
   
@@ -417,7 +461,7 @@ do -- MENU_MISSION
   --- Removes the main menu and the sub menus recursively of this MENU_MISSION.
   -- @param #MENU_MISSION self
   -- @return #nil
-  function MENU_MISSION:Remove( MenuTime, MenuTag )
+  function MENU_MISSION:Remove( MenuStamp, MenuTag )
   
     MENU_INDEX:PrepareMission()
     local Path = MENU_INDEX:ParentPath( self.ParentMenu, self.MenuText )
@@ -425,7 +469,7 @@ do -- MENU_MISSION
 
     if MissionMenu == self then
       self:RemoveSubMenus()
-      if not MenuTime or self.MenuTime ~= MenuTime then
+      if not MenuStamp or self.MenuStamp ~= MenuStamp then
         if ( not MenuTag ) or ( MenuTag and self.MenuTag and MenuTag == self.MenuTag ) then
           self:F( { Text = self.MenuText, Path = self.MenuPath } )
           if self.MenuPath ~= nil then
@@ -511,7 +555,7 @@ do -- MENU_MISSION_COMMAND
     local MissionMenu = MENU_INDEX:HasMissionMenu( Path )   
 
     if MissionMenu == self then
-      if not MenuTime or self.MenuTime ~= MenuTime then
+      if not MenuStamp or self.MenuStamp ~= MenuStamp then
         if ( not MenuTag ) or ( MenuTag and self.MenuTag and MenuTag == self.MenuTag ) then
           self:F( { Text = self.MenuText, Path = self.MenuPath } )
           if self.MenuPath ~= nil then
@@ -640,7 +684,7 @@ do -- MENU_COALITION
   --- Removes the main menu and the sub menus recursively of this MENU_COALITION.
   -- @param #MENU_COALITION self
   -- @return #nil
-  function MENU_COALITION:Remove( MenuTime, MenuTag )
+  function MENU_COALITION:Remove( MenuStamp, MenuTag )
   
     MENU_INDEX:PrepareCoalition( self.Coalition )
     local Path = MENU_INDEX:ParentPath( self.ParentMenu, self.MenuText )
@@ -648,7 +692,7 @@ do -- MENU_COALITION
 
     if CoalitionMenu == self then
       self:RemoveSubMenus()
-      if not MenuTime or self.MenuTime ~= MenuTime then
+      if not MenuStamp or self.MenuStamp ~= MenuStamp then
         if ( not MenuTag ) or ( MenuTag and self.MenuTag and MenuTag == self.MenuTag ) then
           self:F( { Coalition = self.Coalition, Text = self.MenuText, Path = self.MenuPath } )
           if self.MenuPath ~= nil then
@@ -732,14 +776,14 @@ do -- MENU_COALITION_COMMAND
   --- Removes a radio command item for a coalition
   -- @param #MENU_COALITION_COMMAND self
   -- @return #nil
-  function MENU_COALITION_COMMAND:Remove( MenuTime, MenuTag )
+  function MENU_COALITION_COMMAND:Remove( MenuStamp, MenuTag )
   
     MENU_INDEX:PrepareCoalition( self.Coalition )
     local Path = MENU_INDEX:ParentPath( self.ParentMenu, self.MenuText )
     local CoalitionMenu = MENU_INDEX:HasCoalitionMenu( self.Coalition, Path )   
 
     if CoalitionMenu == self then
-      if not MenuTime or self.MenuTime ~= MenuTime then
+      if not MenuStamp or self.MenuStamp ~= MenuStamp then
         if ( not MenuTag ) or ( MenuTag and self.MenuTag and MenuTag == self.MenuTag ) then
           self:F( { Coalition = self.Coalition, Text = self.MenuText, Path = self.MenuPath } )
           if self.MenuPath ~= nil then
@@ -881,13 +925,13 @@ do
   
   --- Removes the sub menus recursively of this MENU_GROUP.
   -- @param #MENU_GROUP self
-  -- @param MenuTime
+  -- @param MenuStamp
   -- @param MenuTag A Tag or Key to filter the menus to be refreshed with the Tag set.
   -- @return #MENU_GROUP self
-  function MENU_GROUP:RemoveSubMenus( MenuTime, MenuTag )
+  function MENU_GROUP:RemoveSubMenus( MenuStamp, MenuTag )
 
     for MenuText, Menu in pairs( self.Menus or {} ) do
-      Menu:Remove( MenuTime, MenuTag )
+      Menu:Remove( MenuStamp, MenuTag )
     end
     
     self.Menus = nil
@@ -897,18 +941,18 @@ do
 
   --- Removes the main menu and sub menus recursively of this MENU_GROUP.
   -- @param #MENU_GROUP self
-  -- @param MenuTime
+  -- @param MenuStamp
   -- @param MenuTag A Tag or Key to filter the menus to be refreshed with the Tag set.
   -- @return #nil
-  function MENU_GROUP:Remove( MenuTime, MenuTag )
+  function MENU_GROUP:Remove( MenuStamp, MenuTag )
 
     MENU_INDEX:PrepareGroup( self.Group )
     local Path = MENU_INDEX:ParentPath( self.ParentMenu, self.MenuText )
     local GroupMenu = MENU_INDEX:HasGroupMenu( self.Group, Path )   
 
     if GroupMenu == self then
-      self:RemoveSubMenus( MenuTime, MenuTag )
-      if not MenuTime or self.MenuTime ~= MenuTime then
+      self:RemoveSubMenus( MenuStamp, MenuTag )
+      if not MenuStamp or self.MenuStamp ~= MenuStamp then
         if ( not MenuTag ) or ( MenuTag and self.MenuTag and MenuTag == self.MenuTag ) then
           if self.MenuPath ~= nil then
             self:F( { Group = self.GroupID, Text = self.MenuText, Path = self.MenuPath } )
@@ -988,17 +1032,17 @@ do
   
   --- Removes a menu structure for a group.
   -- @param #MENU_GROUP_COMMAND self
-  -- @param MenuTime
+  -- @param MenuStamp
   -- @param MenuTag A Tag or Key to filter the menus to be refreshed with the Tag set.
   -- @return #nil
-  function MENU_GROUP_COMMAND:Remove( MenuTime, MenuTag )
+  function MENU_GROUP_COMMAND:Remove( MenuStamp, MenuTag )
 
     MENU_INDEX:PrepareGroup( self.Group )
     local Path = MENU_INDEX:ParentPath( self.ParentMenu, self.MenuText )
     local GroupMenu = MENU_INDEX:HasGroupMenu( self.Group, Path )   
 
     if GroupMenu == self then
-      if not MenuTime or self.MenuTime ~= MenuTime then
+      if not MenuStamp or self.MenuStamp ~= MenuStamp then
         if ( not MenuTag ) or ( MenuTag and self.MenuTag and MenuTag == self.MenuTag ) then
           if self.MenuPath ~= nil then
            self:F( { Group = self.GroupID, Text = self.MenuText, Path = self.MenuPath } )
@@ -1110,13 +1154,13 @@ do
   
   --- Removes the sub menus recursively of this MENU_GROUP_DELAYED.
   -- @param #MENU_GROUP_DELAYED self
-  -- @param MenuTime
+  -- @param MenuStamp
   -- @param MenuTag A Tag or Key to filter the menus to be refreshed with the Tag set.
   -- @return #MENU_GROUP_DELAYED self
-  function MENU_GROUP_DELAYED:RemoveSubMenus( MenuTime, MenuTag )
+  function MENU_GROUP_DELAYED:RemoveSubMenus( MenuStamp, MenuTag )
 
     for MenuText, Menu in pairs( self.Menus or {} ) do
-      Menu:Remove( MenuTime, MenuTag )
+      Menu:Remove( MenuStamp, MenuTag )
     end
     
     self.Menus = nil
@@ -1126,18 +1170,18 @@ do
 
   --- Removes the main menu and sub menus recursively of this MENU_GROUP.
   -- @param #MENU_GROUP_DELAYED self
-  -- @param MenuTime
+  -- @param MenuStamp
   -- @param MenuTag A Tag or Key to filter the menus to be refreshed with the Tag set.
   -- @return #nil
-  function MENU_GROUP_DELAYED:Remove( MenuTime, MenuTag )
+  function MENU_GROUP_DELAYED:Remove( MenuStamp, MenuTag )
 
     MENU_INDEX:PrepareGroup( self.Group )
     local Path = MENU_INDEX:ParentPath( self.ParentMenu, self.MenuText )
     local GroupMenu = MENU_INDEX:HasGroupMenu( self.Group, Path )   
 
     if GroupMenu == self then
-      self:RemoveSubMenus( MenuTime, MenuTag )
-      if not MenuTime or self.MenuTime ~= MenuTime then
+      self:RemoveSubMenus( MenuStamp, MenuTag )
+      if not MenuStamp or self.MenuStamp ~= MenuStamp then
         if ( not MenuTag ) or ( MenuTag and self.MenuTag and MenuTag == self.MenuTag ) then
           if self.MenuPath ~= nil then
             self:F( { Group = self.GroupID, Text = self.MenuText, Path = self.MenuPath } )
@@ -1237,17 +1281,17 @@ do
   
   --- Removes a menu structure for a group.
   -- @param #MENU_GROUP_COMMAND_DELAYED self
-  -- @param MenuTime
+  -- @param MenuStamp
   -- @param MenuTag A Tag or Key to filter the menus to be refreshed with the Tag set.
   -- @return #nil
-  function MENU_GROUP_COMMAND_DELAYED:Remove( MenuTime, MenuTag )
+  function MENU_GROUP_COMMAND_DELAYED:Remove( MenuStamp, MenuTag )
 
     MENU_INDEX:PrepareGroup( self.Group )
     local Path = MENU_INDEX:ParentPath( self.ParentMenu, self.MenuText )
     local GroupMenu = MENU_INDEX:HasGroupMenu( self.Group, Path )   
 
     if GroupMenu == self then
-      if not MenuTime or self.MenuTime ~= MenuTime then
+      if not MenuStamp or self.MenuStamp ~= MenuStamp then
         if ( not MenuTag ) or ( MenuTag and self.MenuTag and MenuTag == self.MenuTag ) then
           if self.MenuPath ~= nil then
             self:F( { Group = self.GroupID, Text = self.MenuText, Path = self.MenuPath } )

Moose Development/Moose/Core/Message.lua

@@ -1,4 +1,15 @@
---- **Core** -- MESSAGE class takes are of the **real-time notifications** and **messages to players** during a simulation.
+--- **Core** - Informs the players using messages during a simulation.
+-- 
+-- ===
+-- 
+-- ## Features:
+-- 
+--   * A more advanced messaging system using the DCS message system.
+--   * Time messages.
+--   * Send messages based on a message type, which has a pre-defined duration that can be tweaked in SETTINGS.
+--   * Send message to all players.
+--   * Send messages to a coalition.
+--   * Send messages to a specific group.
 -- 
 -- ===
 -- 
@@ -161,6 +172,7 @@ end
 --- Sends a MESSAGE to a Client Group. Note that the Group needs to be defined within the ME with the skillset "Client" or "Player".
 -- @param #MESSAGE self
 -- @param Wrapper.Client#CLIENT Client is the Group of the Client.
+-- @param Core.Settings#SETTINGS Settings Settings used to display the message.
 -- @return #MESSAGE
 -- @usage
 -- -- Send the 2 messages created with the @{New} method to the Client Group.
@@ -200,8 +212,8 @@ end
 
 --- Sends a MESSAGE to a Group. 
 -- @param #MESSAGE self
--- @param Wrapper.Group#GROUP Group is the Group.
--- @return #MESSAGE
+-- @param Wrapper.Group#GROUP Group to which the message is displayed.
+-- @return #MESSAGE Message object.
 function MESSAGE:ToGroup( Group, Settings )
   self:F( Group.GroupName )
 
@@ -261,8 +273,9 @@ end
 
 --- Sends a MESSAGE to a Coalition. 
 -- @param #MESSAGE self
--- @param CoalitionSide needs to be filled out by the defined structure of the standard scripting engine @{coalition.side}. 
--- @return #MESSAGE
+-- @param #DCS.coalition.side CoalitionSide @{#DCS.coalition.side} to which the message is displayed.
+-- @param Core.Settings#SETTINGS Settings (Optional) Settings for message display.
+-- @return #MESSAGE Message object.
 -- @usage
 -- -- Send a message created with the @{New} method to the RED coalition.
 -- MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToCoalition( coalition.side.RED )
@@ -292,8 +305,9 @@ end
 
 --- Sends a MESSAGE to a Coalition if the given Condition is true. 
 -- @param #MESSAGE self
--- @param CoalitionSide needs to be filled out by the defined structure of the standard scripting engine @{coalition.side}. 
--- @return #MESSAGE
+-- @param CoalitionSide needs to be filled out by the defined structure of the standard scripting engine @{coalition.side}.
+-- @param #boolean Condition Sends the message only if the condition is true. 
+-- @return #MESSAGE self
 function MESSAGE:ToCoalitionIf( CoalitionSide, Condition )
   self:F( CoalitionSide )
 
@@ -306,6 +320,7 @@ end
 
 --- Sends a MESSAGE to all players. 
 -- @param #MESSAGE self
+-- @param Core.Settings#Settings Settings (Optional) Settings for message display.
 -- @return #MESSAGE
 -- @usage
 -- -- Send a message created to all players.
@@ -315,7 +330,7 @@ end
 -- or
 -- MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", "End of Mission", 25, "Win" )
 -- MessageAll:ToAll()
-function MESSAGE:ToAll()
+function MESSAGE:ToAll(Settings)
   self:F()
 
   if self.MessageType then

Moose Development/Moose/Core/Point.lua

@@ -1,6 +1,6 @@
---- **Core** -- Defines an **extensive API** to **manage 3D points** in the DCS World 3D simulation space.
+--- **Core** - Defines an extensive API to manage 3D points in the DCS World 3D simulation space.
 --
--- **Features:**
+-- ## Features:
 -- 
 --   * Provides a COORDINATE class, which allows to manage points in 3D space and perform various operations on it.
 --   * Provides a POINT\_VEC2 class, which is derived from COORDINATE, and allows to manage points in 3D space, but from a Lat/Lon and Altitude perspective.
@@ -210,6 +210,7 @@ do -- COORDINATE
     FromParkingAreaHot = "From Parking Area Hot",
     FromRunway = "From Runway",
     Landing = "Landing",
+    LandingReFuAr = "LandingReFuAr",
   }
 
   --- @field COORDINATE.WaypointType 
@@ -219,6 +220,7 @@ do -- COORDINATE
     TakeOff = "TakeOffParkingHot",
     TurningPoint = "Turning Point",
     Land = "Land",
+    LandingReFuAr = "LandingReFuAr",
   }
 
 
@@ -342,18 +344,18 @@ do -- COORDINATE
     return x - Precision <= self.x and x + Precision >= self.x and z - Precision <= self.z and z + Precision >= self.z   
   end
   
-  --- Returns if the 2 coordinates are at the same 2D position.
+  --- Scan/find objects (units, statics, scenery) within a certain radius around the coordinate using the world.searchObjects() DCS API function.
   -- @param #COORDINATE self
   -- @param #number radius (Optional) Scan radius in meters. Default 100 m.
   -- @param #boolean scanunits (Optional) If true scan for units. Default true.
   -- @param #boolean scanstatics (Optional) If true scan for static objects. Default true.
   -- @param #boolean scanscenery (Optional) If true scan for scenery objects. Default false.
-  -- @return True if units were found.
-  -- @return True if statics were found.
-  -- @return True if scenery objects were found.
-  -- @return Unit objects found.
-  -- @return Static objects found.
-  -- @return Scenery objects found.
+  -- @return #boolean True if units were found.
+  -- @return #boolean True if statics were found.
+  -- @return #boolean True if scenery objects were found.
+  -- @return #table Table of MOOSE @[#Wrapper.Unit#UNIT} objects found.
+  -- @return #table Table of DCS static objects found.
+  -- @return #table Table of DCS scenery objects found.
   function COORDINATE:ScanObjects(radius, scanunits, scanstatics, scanscenery)
     self:F(string.format("Scanning in radius %.1f m.", radius))
 
@@ -397,7 +399,7 @@ do -- COORDINATE
     local gotunits=false
     local gotscenery=false
     
-    local function EvaluateZone( ZoneObject )
+    local function EvaluateZone(ZoneObject)
     
       if ZoneObject then
       
@@ -405,18 +407,17 @@ do -- COORDINATE
         local ObjectCategory = ZoneObject:getCategory()
         
         -- Check for unit or static objects
-        --if (ObjectCategory == Object.Category.UNIT and ZoneObject:isExist() and ZoneObject:isActive()) then
-        if (ObjectCategory == Object.Category.UNIT and ZoneObject:isExist()) then
+        if ObjectCategory==Object.Category.UNIT and ZoneObject:isExist() then
         
-          table.insert(Units, ZoneObject)
+          table.insert(Units, UNIT:Find(ZoneObject))
           gotunits=true
           
-        elseif (ObjectCategory == Object.Category.STATIC and ZoneObject:isExist()) then
+        elseif ObjectCategory==Object.Category.STATIC and ZoneObject:isExist() then
         
           table.insert(Statics, ZoneObject)
           gotstatics=true
           
-        elseif ObjectCategory == Object.Category.SCENERY then
+        elseif ObjectCategory==Object.Category.SCENERY then
         
           table.insert(Scenery, ZoneObject)
           gotscenery=true
@@ -432,7 +433,7 @@ do -- COORDINATE
     world.searchObjects(scanobjects, SphereSearch, EvaluateZone)
     
     for _,unit in pairs(Units) do
-      self:T(string.format("Scan found unit %s", unit:getName()))
+      self:T(string.format("Scan found unit %s", unit:GetName()))
     end
     for _,static in pairs(Statics) do
       self:T(string.format("Scan found static %s", static:getName()))
@@ -460,18 +461,47 @@ do -- COORDINATE
   --- Add a Distance in meters from the COORDINATE orthonormal plane, with the given angle, and calculate the new COORDINATE.
   -- @param #COORDINATE self
   -- @param DCS#Distance Distance The Distance to be added in meters.
-  -- @param DCS#Angle Angle The Angle in degrees.
-  -- @return #COORDINATE The new calculated COORDINATE.
-  function COORDINATE:Translate( Distance, Angle )
+  -- @param DCS#Angle Angle The Angle in degrees. Defaults to 0 if not specified (nil).
+  -- @param #boolean Keepalt If true, keep altitude of original coordinate. Default is that the new coordinate is created at the translated land height.
+  -- @return Core.Point#COORDINATE The new calculated COORDINATE.
+  function COORDINATE:Translate( Distance, Angle, Keepalt )
     local SX = self.x
     local SY = self.z
-    local Radians = Angle / 180 * math.pi
+    local Radians = (Angle or 0) / 180 * math.pi
     local TX = Distance * math.cos( Radians ) + SX
     local TY = Distance * math.sin( Radians ) + SY
-
-    return COORDINATE:NewFromVec2( { x = TX, y = TY } )
+  
+    if Keepalt then
+      return COORDINATE:NewFromVec3( { x = TX, y=self.y, z = TY } )
+    else
+      return COORDINATE:NewFromVec2( { x = TX, y = TY } )
+    end
   end
 
+  --- Rotate coordinate in 2D (x,z) space.
+  -- @param #COORDINATE self
+  -- @param DCS#Angle Angle Angle of rotation in degrees.
+  -- @return Core.Point#COORDINATE The rotated coordinate.
+  function COORDINATE:Rotate2D(Angle)
+  
+    if not Angle then
+      return self
+    end
+
+    local phi=math.rad(Angle)
+    
+    local X=self.z
+    local Y=self.x
+    
+    --slocal R=math.sqrt(X*X+Y*Y)
+      
+    local x=X*math.cos(phi)-Y*math.sin(phi)
+    local y=X*math.sin(phi)+Y*math.cos(phi)
+
+    -- Coordinate assignment looks bit strange but is correct.
+    return COORDINATE:NewFromVec3({x=y, y=self.y, z=x})
+  end
+  
   --- Return a random Vec2 within an Outer Radius and optionally NOT within an Inner Radius of the COORDINATE.
   -- @param #COORDINATE self
   -- @param DCS#Distance OuterRadius
@@ -532,7 +562,7 @@ do -- COORDINATE
   
   --- Return the height of the land at the coordinate.
   -- @param #COORDINATE self
-  -- @return #number
+  -- @return #number Land height (ASL) in meters.
   function COORDINATE:GetLandHeight()
     local Vec2 = { x = self.x, y = self.z }
     return land.getHeight( Vec2 )
@@ -729,6 +759,20 @@ do -- COORDINATE
     return nil
   end
   
+  --- Returns the heading from this to another coordinate.
+  -- @param #COORDINATE self
+  -- @param #COORDINATE ToCoordinate
+  -- @return #number Heading in degrees. 
+  function COORDINATE:HeadingTo(ToCoordinate)
+    local dz=ToCoordinate.z-self.z
+    local dx=ToCoordinate.x-self.x
+    local heading=math.deg(math.atan2(dz, dx))
+    if heading < 0 then
+      heading = 360 + heading
+    end
+    return heading
+  end
+  
   --- Returns the wind direction (from) and strength.
   -- @param #COORDINATE self
   -- @param height (Optional) parameter specifying the height ASL. The minimum height will be always be the land height since the wind is zero below the ground.
@@ -753,6 +797,24 @@ do -- COORDINATE
     -- Return wind direction and strength km/h.
     return direction, strength
   end
+  
+  --- Returns the wind direction (from) and strength.
+  -- @param #COORDINATE self
+  -- @param height (Optional) parameter specifying the height ASL. The minimum height will be always be the land height since the wind is zero below the ground.
+  -- @return Direction the wind is blowing from in degrees.
+  function COORDINATE:GetWindWithTurbulenceVec3(height)
+  
+    -- AGL height if 
+    local landheight=self:GetLandHeight()+0.1 -- we at 0.1 meters to be sure to be above ground since wind is zero below ground level.
+    
+    -- Point at which the wind is evaluated. 
+    local point={x=self.x, y=math.max(height or self.y, landheight), z=self.z}
+    
+    -- Get wind velocity vector including turbulences.
+    local vec3 = atmosphere.getWindWithTurbulence(point)
+    
+    return vec3
+  end  
 
 
   --- Returns a text documenting the wind direction (from) and strength according the measurement system @{Settings}.
@@ -805,7 +867,7 @@ do -- COORDINATE
   -- @param #number Precision The precision.
   -- @param Core.Settings#SETTINGS Settings
   -- @return #string The bearing text in degrees.
-  function COORDINATE:GetBearingText( AngleRadians, Precision, Settings )
+  function COORDINATE:GetBearingText( AngleRadians, Precision, Settings, Language )
 
     local Settings = Settings or _SETTINGS -- Core.Settings#SETTINGS
 
@@ -821,16 +883,25 @@ do -- COORDINATE
   -- @param #number Distance The distance in meters.
   -- @param Core.Settings#SETTINGS Settings
   -- @return #string The distance text expressed in the units of measurement.
-  function COORDINATE:GetDistanceText( Distance, Settings )
+  function COORDINATE:GetDistanceText( Distance, Settings, Language )
 
     local Settings = Settings or _SETTINGS -- Core.Settings#SETTINGS
+    local Language = Language or "EN"
 
     local DistanceText
 
     if Settings:IsMetric() then
-      DistanceText = " for " .. UTILS.Round( Distance / 1000, 2 ) .. " km"
+      if     Language == "EN" then
+        DistanceText = " for " .. UTILS.Round( Distance / 1000, 2 ) .. " km"
+      elseif Language == "RU" then
+        DistanceText = " за " .. UTILS.Round( Distance / 1000, 2 ) .. " километров"
+      end
     else
-      DistanceText = " for " .. UTILS.Round( UTILS.MetersToNM( Distance ), 2 ) .. " miles"
+      if     Language == "EN" then
+        DistanceText = " for " .. UTILS.Round( UTILS.MetersToNM( Distance ), 2 ) .. " miles"
+      elseif Language == "RU" then
+        DistanceText = " за " .. UTILS.Round( UTILS.MetersToNM( Distance ), 2 ) .. " миль"
+      end
     end
     
     return DistanceText
@@ -839,14 +910,24 @@ do -- COORDINATE
   --- Return the altitude text of the COORDINATE.
   -- @param #COORDINATE self
   -- @return #string Altitude text.
-  function COORDINATE:GetAltitudeText( Settings )
+  function COORDINATE:GetAltitudeText( Settings, Language )
     local Altitude = self.y
     local Settings = Settings or _SETTINGS
+    local Language = Language or "EN"
+    
     if Altitude ~= 0 then
       if Settings:IsMetric() then
-        return " at " .. UTILS.Round( self.y, -3 ) .. " meters"
+        if     Language == "EN" then
+          return " at " .. UTILS.Round( self.y, -3 ) .. " meters"
+        elseif Language == "RU" then
+          return " в " .. UTILS.Round( self.y, -3 ) .. " метры"
+        end
       else
-        return " at " .. UTILS.Round( UTILS.MetersToFeet( self.y ), -3 ) .. " feet"
+        if     Language == "EN" then
+          return " at " .. UTILS.Round( UTILS.MetersToFeet( self.y ), -3 ) .. " feet"
+        elseif Language == "RU" then
+          return " в " .. UTILS.Round( self.y, -3 ) .. " ноги"
+        end
       end
     else
       return ""
@@ -892,12 +973,12 @@ do -- COORDINATE
   -- @param #number Distance The distance
   -- @param Core.Settings#SETTINGS Settings
   -- @return #string The BR Text
-  function COORDINATE:GetBRText( AngleRadians, Distance, Settings )
+  function COORDINATE:GetBRText( AngleRadians, Distance, Settings, Language )
 
     local Settings = Settings or _SETTINGS -- Core.Settings#SETTINGS
 
-    local BearingText = self:GetBearingText( AngleRadians, 0, Settings )
-    local DistanceText = self:GetDistanceText( Distance, Settings )
+    local BearingText = self:GetBearingText( AngleRadians, 0, Settings, Language )
+    local DistanceText = self:GetDistanceText( Distance, Settings, Language )
     
     local BRText = BearingText .. DistanceText
 
@@ -910,13 +991,13 @@ do -- COORDINATE
   -- @param #number Distance The distance
   -- @param Core.Settings#SETTINGS Settings
   -- @return #string The BRA Text
-  function COORDINATE:GetBRAText( AngleRadians, Distance, Settings )
+  function COORDINATE:GetBRAText( AngleRadians, Distance, Settings, Language )
 
     local Settings = Settings or _SETTINGS -- Core.Settings#SETTINGS
 
-    local BearingText = self:GetBearingText( AngleRadians, 0, Settings )
-    local DistanceText = self:GetDistanceText( Distance, Settings )
-    local AltitudeText = self:GetAltitudeText( Settings )
+    local BearingText = self:GetBearingText( AngleRadians, 0, Settings, Language )
+    local DistanceText = self:GetDistanceText( Distance, Settings, Language  )
+    local AltitudeText = self:GetAltitudeText( Settings, Language  )
 
     local BRAText = BearingText .. DistanceText .. AltitudeText -- When the POINT is a VEC2, there will be no altitude shown.
 
@@ -924,6 +1005,21 @@ do -- COORDINATE
   end
 
 
+  --- Set altitude.
+  -- @param #COORDINATE self
+  -- @param #number altitude New altitude in meters.
+  -- @param #boolean asl Altitude above sea level. Default is above ground level.
+  -- @return #COORDINATE The COORDINATE with adjusted altitude.
+  function COORDINATE:SetAltitude(altitude, asl)
+    local alt=altitude
+    if asl then
+      alt=altitude
+    else
+      alt=self:GetLandHeight()+altitude
+    end
+    self.y=alt
+    return self
+  end
 
   --- Add a Distance in meters from the COORDINATE horizontal plane, with the given angle, and calculate the new COORDINATE.
   -- @param #COORDINATE self
@@ -949,40 +1045,85 @@ do -- COORDINATE
   -- @param #COORDINATE.WaypointAction Action The route point action.
   -- @param DCS#Speed Speed Airspeed in km/h. Default is 500 km/h.
   -- @param #boolean SpeedLocked true means the speed is locked.
+  -- @param Wrapper.Airbase#AIRBASE airbase The airbase for takeoff and landing points.
+  -- @param #table DCSTasks A table of @{DCS#Task} items which are executed at the waypoint.
+  -- @param #string description A text description of the waypoint, which will be shown on the F10 map.
+  -- @param #number timeReFuAr Time in minutes the aircraft stays at the airport for ReFueling and ReArming.
   -- @return #table The route point.
-  function COORDINATE:WaypointAir( AltType, Type, Action, Speed, SpeedLocked )
+  function COORDINATE:WaypointAir( AltType, Type, Action, Speed, SpeedLocked, airbase, DCSTasks, description, timeReFuAr )
     self:F2( { AltType, Type, Action, Speed, SpeedLocked } )
-
+    
+    -- Set alttype or "RADIO" which is AGL.
+    AltType=AltType or "RADIO"
+    
+    -- Speedlocked by default
+    if SpeedLocked==nil then
+      SpeedLocked=true
+    end
+    
+    -- Speed or default 500 km/h.
+    Speed=Speed or 500
+    
+    -- Waypoint array.
     local RoutePoint = {}
+    
+    -- Coordinates.
     RoutePoint.x = self.x
     RoutePoint.y = self.z
+    
+    -- Altitude.
     RoutePoint.alt = self.y
-    RoutePoint.alt_type = AltType or "RADIO"
-
+    RoutePoint.alt_type = AltType
+    
+    -- Waypoint type.
     RoutePoint.type = Type or nil
-    RoutePoint.action = Action or nil
-
-    RoutePoint.speed = ( Speed and Speed / 3.6 ) or ( 500 / 3.6 )
-    RoutePoint.speed_locked = true
-
-    --  ["task"] =
-    --  {
-    --      ["id"] = "ComboTask",
-    --      ["params"] =
-    --      {
-    --          ["tasks"] =
-    --          {
-    --          }, -- end of ["tasks"]
-    --      }, -- end of ["params"]
-    --  }, -- end of ["task"]
-
-
+    RoutePoint.action = Action or nil    
+    
+    -- Speed.
+    RoutePoint.speed = Speed/3.6
+    RoutePoint.speed_locked = SpeedLocked
+    
+    -- ETA.
+    RoutePoint.ETA=0
+    RoutePoint.ETA_locked=true
+    
+    -- Waypoint description.
+    RoutePoint.name=description
+    
+    -- Airbase parameters for takeoff and landing points.
+    if airbase then
+      local AirbaseID = airbase:GetID()
+      local AirbaseCategory = airbase:GetDesc().category
+      if AirbaseCategory == Airbase.Category.SHIP or AirbaseCategory == Airbase.Category.HELIPAD then
+        RoutePoint.linkUnit = AirbaseID
+        RoutePoint.helipadId = AirbaseID
+      elseif AirbaseCategory == Airbase.Category.AIRDROME then
+        RoutePoint.airdromeId = AirbaseID
+      else
+        self:E("ERROR: Unknown airbase category in COORDINATE:WaypointAir()!")
+      end
+    end
+    
+    -- Time in minutes to stay at the airbase before resuming route. 
+    if Type==COORDINATE.WaypointType.LandingReFuAr then
+      RoutePoint.timeReFuAr=timeReFuAr or 10
+    end
+    
+    -- Waypoint tasks.
     RoutePoint.task = {}
     RoutePoint.task.id = "ComboTask"
     RoutePoint.task.params = {}
-    RoutePoint.task.params.tasks = {}
-
+    RoutePoint.task.params.tasks = DCSTasks or {}
+    
+    --RoutePoint.properties={}
+    --RoutePoint.properties.addopt={}
+    
+    --RoutePoint.formation_template=""
 
+    -- Debug.
+    self:T({RoutePoint=RoutePoint})
+    
+    -- Return waypoint.
     return RoutePoint
   end
 
@@ -991,9 +1132,11 @@ do -- COORDINATE
   -- @param #COORDINATE self
   -- @param #COORDINATE.WaypointAltType AltType The altitude type.
   -- @param DCS#Speed Speed Airspeed in km/h.
+  -- @param #table DCSTasks (Optional) A table of @{DCS#Task} items which are executed at the waypoint.
+  -- @param #string description (Optional) A text description of the waypoint, which will be shown on the F10 map.
   -- @return #table The route point.
-  function COORDINATE:WaypointAirTurningPoint( AltType, Speed )
-    return self:WaypointAir( AltType, COORDINATE.WaypointType.TurningPoint, COORDINATE.WaypointAction.TurningPoint, Speed )
+  function COORDINATE:WaypointAirTurningPoint( AltType, Speed, DCSTasks, description )
+    return self:WaypointAir( AltType, COORDINATE.WaypointType.TurningPoint, COORDINATE.WaypointAction.TurningPoint, Speed, true, nil, DCSTasks, description )
   end
 
   
@@ -1040,6 +1183,9 @@ do -- COORDINATE
   --- Build a Waypoint Air "Landing".
   -- @param #COORDINATE self
   -- @param DCS#Speed Speed Airspeed in km/h.
+  -- @param Wrapper.Airbase#AIRBASE airbase The airbase for takeoff and landing points.
+  -- @param #table DCSTasks A table of @{DCS#Task} items which are executed at the waypoint.
+  -- @param #string description A text description of the waypoint, which will be shown on the F10 map.
   -- @return #table The route point.
   -- @usage
   -- 
@@ -1048,11 +1194,21 @@ do -- COORDINATE
   --    LandingWaypoint = LandingCoord:WaypointAirLanding( 60 )
   --    HeliGroup:Route( { LandWaypoint }, 1 ) -- Start landing the helicopter in one second.
   -- 
-  function COORDINATE:WaypointAirLanding( Speed )
-    return self:WaypointAir( nil, COORDINATE.WaypointType.Land, COORDINATE.WaypointAction.Landing, Speed )
+  function COORDINATE:WaypointAirLanding( Speed, airbase, DCSTasks, description )
+    return self:WaypointAir(nil, COORDINATE.WaypointType.Land, COORDINATE.WaypointAction.Landing, Speed, false, airbase, DCSTasks, description)
   end
   
-  
+  --- Build a Waypoint Air "LandingReFuAr". Mimics the aircraft ReFueling and ReArming. 
+  -- @param #COORDINATE self
+  -- @param DCS#Speed Speed Airspeed in km/h.
+  -- @param Wrapper.Airbase#AIRBASE airbase The airbase for takeoff and landing points.
+  -- @param #number timeReFuAr Time in minutes, the aircraft stays at the airbase. Default 10 min.
+  -- @param #table DCSTasks A table of @{DCS#Task} items which are executed at the waypoint.
+  -- @param #string description A text description of the waypoint, which will be shown on the F10 map.
+  -- @return #table The route point.
+  function COORDINATE:WaypointAirLandingReFu( Speed, airbase, timeReFuAr, DCSTasks, description )
+    return self:WaypointAir(nil, COORDINATE.WaypointType.LandingReFuAr, COORDINATE.WaypointAction.LandingReFuAr, Speed, false, airbase, DCSTasks, description, timeReFuAr or 10)
+  end  
   
   
   --- Build an ground type route point.
@@ -1095,6 +1251,46 @@ do -- COORDINATE
 
     return RoutePoint
   end
+
+  --- Gets the nearest airbase with respect to the current coordinates.
+  -- @param #COORDINATE self
+  -- @param #number Category (Optional) Category of the airbase. Enumerator of @{Wrapper.Airbase#AIRBASE.Category}.
+  -- @param #number Coalition (Optional) Coalition of the airbase.
+  -- @return Wrapper.Airbase#AIRBASE Closest Airbase to the given coordinate.
+  -- @return #number Distance to the closest airbase in meters.
+  function COORDINATE:GetClosestAirbase(Category, Coalition)
+  
+    -- Get all airbases of the map.
+    local airbases=AIRBASE.GetAllAirbases(Coalition)
+    
+    local closest=nil
+    local distmin=nil
+    -- Loop over all airbases.
+    for _,_airbase in pairs(airbases) do
+      local airbase=_airbase --Wrapper.Airbase#AIRBASE
+      if airbase then
+        local category=airbase:GetAirbaseCategory()
+        if Category and Category==category or Category==nil then
+
+          -- Distance to airbase.         
+          local dist=self:Get2DDistance(airbase:GetCoordinate())
+          
+          if closest==nil then
+            distmin=dist
+            closest=airbase
+          else
+            if dist<distmin then
+              distmin=dist
+              closest=airbase
+            end 
+          end
+          
+        end
+      end
+    end
+    
+    return closest,distmin
+  end
   
   --- Gets the nearest parking spot.
   -- @param #COORDINATE self
@@ -1104,6 +1300,7 @@ do -- COORDINATE
   -- @return Core.Point#COORDINATE Coordinate of the nearest parking spot.
   -- @return #number Terminal ID.
   -- @return #number Distance to closest parking spot in meters.
+  -- @return Wrapper.Airbase#AIRBASE#ParkingSpot Parking spot table.
   function COORDINATE:GetClosestParkingSpot(airbase, terminaltype, free)
     
     -- Get airbase table.
@@ -1118,6 +1315,7 @@ do -- COORDINATE
     local _closest=nil --Core.Point#COORDINATE
     local _termID=nil
     local _distmin=nil
+    local spot=nil --Wrapper.Airbase#AIRBASE.ParkingSpot
 
     -- Loop over all airbases.
     for _,_airbase in pairs(airbases) do
@@ -1137,11 +1335,13 @@ do -- COORDINATE
             _closest=_coord
             _distmin=_dist
             _termID=_spot.TerminalID
+            spot=_spot
           else    
             if _dist<_distmin then
               _distmin=_dist
               _closest=_coord
               _termID=_spot.TerminalID
+              spot=_spot
             end
           end
                           
@@ -1149,7 +1349,7 @@ do -- COORDINATE
       end
     end
    
-    return _closest, _termID, _distmin
+    return _closest, _termID, _distmin, spot
   end
 
   --- Gets the nearest free parking spot.
@@ -1174,27 +1374,43 @@ do -- COORDINATE
     return self:GetClosestParkingSpot(airbase, terminaltype, false)
   end
     
-  --- Gets the nearest coordinate to a road.
+  --- Gets the nearest coordinate to a road (or railroad).
   -- @param #COORDINATE self
+  -- @param #boolean Railroad (Optional) If true, closest point to railroad is returned rather than closest point to conventional road. Default false. 
   -- @return #COORDINATE Coordinate of the nearest road.
-  function COORDINATE:GetClosestPointToRoad()
-   local x,y = land.getClosestPointOnRoads("roads", self.x, self.z)
-   local vec2={ x = x, y = y }
-   return COORDINATE:NewFromVec2(vec2)
+  function COORDINATE:GetClosestPointToRoad(Railroad)
+    local roadtype="roads"
+    if Railroad==true then
+      roadtype="railroads"
+    end
+    local x,y = land.getClosestPointOnRoads(roadtype, self.x, self.z)
+    local vec2={ x = x, y = y }
+    return COORDINATE:NewFromVec2(vec2)
   end
+  
 
-  --- Returns a table of coordinates to a destination using only roads.
+  --- Returns a table of coordinates to a destination using only roads or railroads.
   -- The first point is the closest point on road of the given coordinate.
   -- By default, the last point is the closest point on road of the ToCoord. Hence, the coordinate itself and the final ToCoord are not necessarily included in the path.
   -- @param #COORDINATE self
   -- @param #COORDINATE ToCoord Coordinate of destination.
   -- @param #boolean IncludeEndpoints (Optional) Include the coordinate itself and the ToCoordinate in the path.
+  -- @param #boolean Railroad (Optional) If true, path on railroad is returned. Default false.
+  -- @param #boolean MarkPath (Optional) If true, place markers on F10 map along the path.
+  -- @param #boolean SmokePath (Optional) If true, put (green) smoke along the  
   -- @return #table Table of coordinates on road. If no path on road can be found, nil is returned or just the endpoints.
-  -- @return #number The length of the total path.
-  function COORDINATE:GetPathOnRoad(ToCoord, IncludeEndpoints)
-
+  -- @return #number Tonal length of path.
+  -- @return #boolean If true a valid path on road/rail was found. If false, only the direct way is possible. 
+  function COORDINATE:GetPathOnRoad(ToCoord, IncludeEndpoints, Railroad, MarkPath, SmokePath)
+  
+    -- Set road type.
+    local RoadType="roads"
+    if Railroad==true then
+      RoadType="railroads"
+    end
+    
     -- DCS API function returning a table of vec2.
-    local path = land.findPathOnRoads("roads", self.x, self.z, ToCoord.x, ToCoord.z)
+    local path = land.findPathOnRoads(RoadType, self.x, self.z, ToCoord.x, ToCoord.z)
     
     -- Array holding the path coordinates.
     local Path={}
@@ -1204,18 +1420,43 @@ do -- COORDINATE
     if IncludeEndpoints then
       Path[1]=self
     end
+    
+    -- Assume we could get a valid path.
+    local GotPath=true
         
     -- Check that DCS routine actually returned a path. There are situations where this is not the case.
     if path then
     
       -- Include all points on road.      
-      for _,_vec2 in ipairs(path) do
-        Path[#Path+1]=COORDINATE:NewFromVec2(_vec2)
-        --COORDINATE:NewFromVec2(_vec2):SmokeGreen()
+      for _i,_vec2 in ipairs(path) do
+      
+        local coord=COORDINATE:NewFromVec2(_vec2)
+        
+        Path[#Path+1]=coord
+        
+        if MarkPath then
+          coord:MarkToAll(string.format("Path segment %d.", _i))
+        end
+        if SmokePath then
+          coord:SmokeGreen()
+        end
+      end
+            
+      -- Mark/smoke endpoints
+      if IncludeEndpoints then
+        if MarkPath then
+          COORDINATE:NewFromVec2(path[1]):MarkToAll("Path Initinal Point")
+          COORDINATE:NewFromVec2(path[1]):MarkToAll("Path Final Point")        
+        end
+        if SmokePath then
+          COORDINATE:NewFromVec2(path[1]):SmokeBlue()
+          COORDINATE:NewFromVec2(path[#path]):SmokeBlue()
+        end
       end
             
     else
       self:E("Path is nil. No valid path on road could be found.")
+      GotPath=false
     end
  
     -- Include end point, which might not be on road.
@@ -1233,7 +1474,7 @@ do -- COORDINATE
       return nil,nil
     end 
         
-    return Path, Way
+    return Path, Way, GotPath
   end
 
   --- Gets the surface type at the coordinate.
@@ -1245,17 +1486,70 @@ do -- COORDINATE
     return surface
   end
 
+  --- Checks if the surface type is on land.
+  -- @param #COORDINATE self
+  -- @return #boolean If true, the surface type at the coordinate is land.
+  function COORDINATE:IsSurfaceTypeLand()
+    return self:GetSurfaceType()==land.SurfaceType.LAND
+  end
+
+  --- Checks if the surface type is road.
+  -- @param #COORDINATE self
+  -- @return #boolean If true, the surface type at the coordinate is land.
+  function COORDINATE:IsSurfaceTypeLand()
+    return self:GetSurfaceType()==land.SurfaceType.LAND
+  end
+
+
+  --- Checks if the surface type is road.
+  -- @param #COORDINATE self
+  -- @return #boolean If true, the surface type at the coordinate is a road.
+  function COORDINATE:IsSurfaceTypeRoad()
+    return self:GetSurfaceType()==land.SurfaceType.ROAD
+  end
+
+  --- Checks if the surface type is runway.
+  -- @param #COORDINATE self
+  -- @return #boolean If true, the surface type at the coordinate is a runway or taxi way.
+  function COORDINATE:IsSurfaceTypeRunway()
+    return self:GetSurfaceType()==land.SurfaceType.RUNWAY
+  end
+
+  --- Checks if the surface type is shallow water.
+  -- @param #COORDINATE self
+  -- @return #boolean If true, the surface type at the coordinate is a shallow water.
+  function COORDINATE:IsSurfaceTypeShallowWater()
+    return self:GetSurfaceType()==land.SurfaceType.SHALLOW_WATER
+  end
+
+  --- Checks if the surface type is water.
+  -- @param #COORDINATE self
+  -- @return #boolean If true, the surface type at the coordinate is a deep water.
+  function COORDINATE:IsSurfaceTypeWater()
+    return self:GetSurfaceType()==land.SurfaceType.WATER
+  end
+
+
   --- Creates an explosion at the point of a certain intensity.
   -- @param #COORDINATE self
-  -- @param #number ExplosionIntensity
-  function COORDINATE:Explosion( ExplosionIntensity )
+  -- @param #number ExplosionIntensity Intensity of the explosion in kg TNT. Default 100 kg.
+  -- @param #number Delay Delay before explosion in seconds.
+  -- @return #COORDINATE self
+  function COORDINATE:Explosion( ExplosionIntensity, Delay )
     self:F2( { ExplosionIntensity } )
-    trigger.action.explosion( self:GetVec3(), ExplosionIntensity )
+    ExplosionIntensity=ExplosionIntensity or 100
+    if Delay and Delay>0 then
+      SCHEDULER:New(nil, self.Explosion, {self,ExplosionIntensity}, Delay)
+    else
+      trigger.action.explosion( self:GetVec3(), ExplosionIntensity )
+    end
+    return self
   end
 
   --- Creates an illumination bomb at the point.
   -- @param #COORDINATE self
-  -- @param #number power
+  -- @param #number power Power of illumination bomb in Candela.
+  -- @return #COORDINATE self
   function COORDINATE:IlluminationBomb(power)
     self:F2()
     trigger.action.illuminationBomb( self:GetVec3(), power )
@@ -1390,7 +1684,7 @@ do -- COORDINATE
   --- Flares the point in a color.
   -- @param #COORDINATE self
   -- @param Utilities.Utils#FLARECOLOR FlareColor
-  -- @param DCS#Azimuth (optional) Azimuth The azimuth of the flare direction. The default azimuth is 0.
+  -- @param DCS#Azimuth Azimuth (optional) The azimuth of the flare direction. The default azimuth is 0.
   function COORDINATE:Flare( FlareColor, Azimuth )
     self:F2( { FlareColor } )
     trigger.action.signalFlare( self:GetVec3(), FlareColor, Azimuth and Azimuth or 0 )
@@ -1398,7 +1692,7 @@ do -- COORDINATE
 
   --- Flare the COORDINATE White.
   -- @param #COORDINATE self
-  -- @param DCS#Azimuth (optional) Azimuth The azimuth of the flare direction. The default azimuth is 0.
+  -- @param DCS#Azimuth Azimuth (optional) The azimuth of the flare direction. The default azimuth is 0.
   function COORDINATE:FlareWhite( Azimuth )
     self:F2( Azimuth )
     self:Flare( FLARECOLOR.White, Azimuth )
@@ -1406,7 +1700,7 @@ do -- COORDINATE
 
   --- Flare the COORDINATE Yellow.
   -- @param #COORDINATE self
-  -- @param DCS#Azimuth (optional) Azimuth The azimuth of the flare direction. The default azimuth is 0.
+  -- @param DCS#Azimuth Azimuth (optional) The azimuth of the flare direction. The default azimuth is 0.
   function COORDINATE:FlareYellow( Azimuth )
     self:F2( Azimuth )
     self:Flare( FLARECOLOR.Yellow, Azimuth )
@@ -1414,7 +1708,7 @@ do -- COORDINATE
 
   --- Flare the COORDINATE Green.
   -- @param #COORDINATE self
-  -- @param DCS#Azimuth (optional) Azimuth The azimuth of the flare direction. The default azimuth is 0.
+  -- @param DCS#Azimuth Azimuth (optional) The azimuth of the flare direction. The default azimuth is 0.
   function COORDINATE:FlareGreen( Azimuth )
     self:F2( Azimuth )
     self:Flare( FLARECOLOR.Green, Azimuth )
@@ -1552,7 +1846,7 @@ do -- COORDINATE
 
   --- Returns if a Coordinate is in a certain Radius of this Coordinate in 2D plane using the X and Z axis.
   -- @param #COORDINATE self
-  -- @param #COORDINATE ToCoordinate The coordinate that will be tested if it is in the radius of this coordinate.
+  -- @param #COORDINATE Coordinate The coordinate that will be tested if it is in the radius of this coordinate.
   -- @param #number Radius The radius of the circle on the 2D plane around this coordinate.
   -- @return #boolean true if in the Radius.
   function COORDINATE:IsInRadius( Coordinate, Radius )
@@ -1585,7 +1879,8 @@ do -- COORDINATE
 
   --- Return a BR string from a COORDINATE to the COORDINATE.
   -- @param #COORDINATE self
-  -- @param #COORDINATE TargetCoordinate The target COORDINATE.
+  -- @param #COORDINATE FromCoordinate The coordinate to measure the distance and the bearing from.
+  -- @param Core.Settings#SETTINGS Settings (optional) The settings. Can be nil, and in this case the default settings are used. If you want to specify your own settings, use the _SETTINGS object.
   -- @return #string The BR text.
   function COORDINATE:ToStringBR( FromCoordinate, Settings )
     local DirectionVec3 = FromCoordinate:GetDirectionVec3( self )
@@ -1596,19 +1891,21 @@ do -- COORDINATE
 
   --- Return a BRAA string from a COORDINATE to the COORDINATE.
   -- @param #COORDINATE self
-  -- @param #COORDINATE TargetCoordinate The target COORDINATE.
+  -- @param #COORDINATE FromCoordinate The coordinate to measure the distance and the bearing from.
+  -- @param Core.Settings#SETTINGS Settings (optional) The settings. Can be nil, and in this case the default settings are used. If you want to specify your own settings, use the _SETTINGS object.
   -- @return #string The BR text.
-  function COORDINATE:ToStringBRA( FromCoordinate, Settings )
+  function COORDINATE:ToStringBRA( FromCoordinate, Settings, Language )
     local DirectionVec3 = FromCoordinate:GetDirectionVec3( self )
     local AngleRadians =  self:GetAngleRadians( DirectionVec3 )
     local Distance = FromCoordinate:Get2DDistance( self )
     local Altitude = self:GetAltitudeText()
-    return "BRA, " .. self:GetBRAText( AngleRadians, Distance, Settings )
+    return "BRA, " .. self:GetBRAText( AngleRadians, Distance, Settings, Language )
   end
 
   --- Return a BULLS string out of the BULLS of the coalition to the COORDINATE.
   -- @param #COORDINATE self
   -- @param DCS#coalition.side Coalition The coalition.
+  -- @param Core.Settings#SETTINGS Settings (optional) The settings. Can be nil, and in this case the default settings are used. If you want to specify your own settings, use the _SETTINGS object.
   -- @return #string The BR text.
   function COORDINATE:ToStringBULLS( Coalition, Settings )
     local BullsCoordinate = COORDINATE:NewFromVec3( coalition.getMainRefPoint( Coalition ) )
@@ -1648,46 +1945,48 @@ do -- COORDINATE
 
   --- Provides a Lat Lon string in Degree Minute Second format.
   -- @param #COORDINATE self
-  -- @param Core.Settings#SETTINGS Settings (optional) Settings
+  -- @param Core.Settings#SETTINGS Settings (optional) The settings. Can be nil, and in this case the default settings are used. If you want to specify your own settings, use the _SETTINGS object.
   -- @return #string The LL DMS Text
   function COORDINATE:ToStringLLDMS( Settings ) 
 
     local LL_Accuracy = Settings and Settings.LL_Accuracy or _SETTINGS.LL_Accuracy
     local lat, lon = coord.LOtoLL( self:GetVec3() )
-    return "LL DMS, " .. UTILS.tostringLL( lat, lon, LL_Accuracy, true )
+    return "LL DMS " .. UTILS.tostringLL( lat, lon, LL_Accuracy, true )
   end
 
   --- Provides a Lat Lon string in Degree Decimal Minute format.
   -- @param #COORDINATE self
-  -- @param Core.Settings#SETTINGS Settings (optional) Settings
+  -- @param Core.Settings#SETTINGS Settings (optional) The settings. Can be nil, and in this case the default settings are used. If you want to specify your own settings, use the _SETTINGS object.
   -- @return #string The LL DDM Text
   function COORDINATE:ToStringLLDDM( Settings )
 
     local LL_Accuracy = Settings and Settings.LL_Accuracy or _SETTINGS.LL_Accuracy
     local lat, lon = coord.LOtoLL( self:GetVec3() )
-    return "LL DDM, " .. UTILS.tostringLL( lat, lon, LL_Accuracy, false )
+    return "LL DDM " .. UTILS.tostringLL( lat, lon, LL_Accuracy, false )
   end
 
   --- Provides a MGRS string
   -- @param #COORDINATE self
-  -- @param Core.Settings#SETTINGS Settings (optional) Settings
+  -- @param Core.Settings#SETTINGS Settings (optional) The settings. Can be nil, and in this case the default settings are used. If you want to specify your own settings, use the _SETTINGS object.
   -- @return #string The MGRS Text
   function COORDINATE:ToStringMGRS( Settings ) --R2.1 Fixes issue #424.
 
     local MGRS_Accuracy = Settings and Settings.MGRS_Accuracy or _SETTINGS.MGRS_Accuracy
     local lat, lon = coord.LOtoLL( self:GetVec3() )
     local MGRS = coord.LLtoMGRS( lat, lon )
-    return "MGRS, " .. UTILS.tostringMGRS( MGRS, MGRS_Accuracy )
+    return "MGRS " .. UTILS.tostringMGRS( MGRS, MGRS_Accuracy )
   end
 
   --- Provides a coordinate string of the point, based on a coordinate format system:
   --   * Uses default settings in COORDINATE.
   --   * Can be overridden if for a GROUP containing x clients, a menu was selected to override the default.
   -- @param #COORDINATE self
+  -- @param #COORDINATE ReferenceCoord The refrence coordinate.
+  -- @param #string ReferenceName The refrence name.
   -- @param Wrapper.Controllable#CONTROLLABLE Controllable
-  -- @param Core.Settings#SETTINGS Settings
+  -- @param Core.Settings#SETTINGS Settings (optional) The settings. Can be nil, and in this case the default settings are used. If you want to specify your own settings, use the _SETTINGS object.
   -- @return #string The coordinate Text in the configured coordinate system.
-  function COORDINATE:ToStringFromRP( ReferenceCoord, ReferenceName, Controllable, Settings ) -- R2.2
+  function COORDINATE:ToStringFromRP( ReferenceCoord, ReferenceName, Controllable, Settings )
   
     self:F2( { ReferenceCoord = ReferenceCoord, ReferenceName = ReferenceName } )
 
@@ -1714,9 +2013,9 @@ do -- COORDINATE
   --- Provides a coordinate string of the point, based on the A2G coordinate format system.
   -- @param #COORDINATE self
   -- @param Wrapper.Controllable#CONTROLLABLE Controllable
-  -- @param Core.Settings#SETTINGS Settings
+  -- @param Core.Settings#SETTINGS Settings (optional) The settings. Can be nil, and in this case the default settings are used. If you want to specify your own settings, use the _SETTINGS object.
   -- @return #string The coordinate Text in the configured coordinate system.
-  function COORDINATE:ToStringA2G( Controllable, Settings ) -- R2.2
+  function COORDINATE:ToStringA2G( Controllable, Settings ) 
   
     self:F2( { Controllable = Controllable and Controllable:GetName() } )
 
@@ -1749,9 +2048,9 @@ do -- COORDINATE
   --- Provides a coordinate string of the point, based on the A2A coordinate format system.
   -- @param #COORDINATE self
   -- @param Wrapper.Controllable#CONTROLLABLE Controllable
-  -- @param Core.Settings#SETTINGS Settings
+  -- @param Core.Settings#SETTINGS Settings (optional) The settings. Can be nil, and in this case the default settings are used. If you want to specify your own settings, use the _SETTINGS object.
   -- @return #string The coordinate Text in the configured coordinate system.
-  function COORDINATE:ToStringA2A( Controllable, Settings ) -- R2.2
+  function COORDINATE:ToStringA2A( Controllable, Settings, Language ) -- R2.2
   
     self:F2( { Controllable = Controllable and Controllable:GetName() } )
 
@@ -1760,23 +2059,23 @@ do -- COORDINATE
     if Settings:IsA2A_BRAA()  then
       if Controllable then
         local Coordinate = Controllable:GetCoordinate()
-        return self:ToStringBRA( Coordinate, Settings ) 
+        return self:ToStringBRA( Coordinate, Settings, Language ) 
       else
-        return self:ToStringMGRS( Settings )
+        return self:ToStringMGRS( Settings, Language )
       end
     end
     if Settings:IsA2A_BULLS() then
       local Coalition = Controllable:GetCoalition()
-      return self:ToStringBULLS( Coalition, Settings )
+      return self:ToStringBULLS( Coalition, Settings, Language )
     end
     if Settings:IsA2A_LL_DMS()  then
-      return self:ToStringLLDMS( Settings )
+      return self:ToStringLLDMS( Settings, Language )
     end
     if Settings:IsA2A_LL_DDM()  then
-      return self:ToStringLLDDM( Settings )
+      return self:ToStringLLDDM( Settings, Language )
     end
     if Settings:IsA2A_MGRS() then
-      return self:ToStringMGRS( Settings )
+      return self:ToStringMGRS( Settings, Language )
     end
 
     return nil
@@ -1787,17 +2086,17 @@ do -- COORDINATE
   --   * Uses default settings in COORDINATE.
   --   * Can be overridden if for a GROUP containing x clients, a menu was selected to override the default.
   -- @param #COORDINATE self
-  -- @param Wrapper.Controllable#CONTROLLABLE Controllable
-  -- @param Core.Settings#SETTINGS Settings
+  -- @param Wrapper.Controllable#CONTROLLABLE Controllable The controllable to retrieve the settings from, otherwise the default settings will be chosen.
+  -- @param Core.Settings#SETTINGS Settings (optional) The settings. Can be nil, and in this case the default settings are used. If you want to specify your own settings, use the _SETTINGS object.
   -- @param Tasking.Task#TASK Task The task for which coordinates need to be calculated.
   -- @return #string The coordinate Text in the configured coordinate system.
-  function COORDINATE:ToString( Controllable, Settings, Task ) -- R2.2
+  function COORDINATE:ToString( Controllable, Settings, Task )
   
-    self:F2( { Controllable = Controllable and Controllable:GetName() } )
+--    self:E( { Controllable = Controllable and Controllable:GetName() } )
 
     local Settings = Settings or ( Controllable and _DATABASE:GetPlayerSettings( Controllable:GetPlayerName() ) ) or _SETTINGS
 
-    local ModeA2A = false
+    local ModeA2A = nil
     
     if Task then
       if Task:IsInstanceOf( TASK_A2A ) then
@@ -1808,13 +2107,17 @@ do -- COORDINATE
         else
           if Task:IsInstanceOf( TASK_CARGO ) then
             ModeA2A = false
-          else
-            ModeA2A = false
           end
+            if Task:IsInstanceOf( TASK_CAPTURE_ZONE ) then
+              ModeA2A = false
+            end
         end
       end
-    else
-      local IsAir = Controllable and Controllable:IsAirPlane() or false
+    end
+    
+   
+    if ModeA2A == nil then
+      local IsAir = Controllable and ( Controllable:IsAirPlane() or Controllable:IsHelicopter() ) or false
       if IsAir  then
         ModeA2A = true
       else
@@ -1838,7 +2141,7 @@ do -- COORDINATE
   --   * Can be overridden if for a GROUP containing x clients, a menu was selected to override the default.
   -- @param #COORDINATE self
   -- @param Wrapper.Controllable#CONTROLLABLE Controllable
-  -- @param Core.Settings#SETTINGS Settings
+  -- @param Core.Settings#SETTINGS Settings (optional) The settings. Can be nil, and in this case the default settings are used. If you want to specify your own settings, use the _SETTINGS object.
   -- @return #string The pressure text in the configured measurement system.
   function COORDINATE:ToStringPressure( Controllable, Settings ) -- R2.3
   
@@ -1854,9 +2157,9 @@ do -- COORDINATE
   --   * Can be overridden if for a GROUP containing x clients, a menu was selected to override the default.
   -- @param #COORDINATE self
   -- @param Wrapper.Controllable#CONTROLLABLE Controllable
-  -- @param Core.Settings#SETTINGS Settings
+  -- @param Core.Settings#SETTINGS Settings (optional) The settings. Can be nil, and in this case the default settings are used. If you want to specify your own settings, use the _SETTINGS object.
   -- @return #string The wind text in the configured measurement system.
-  function COORDINATE:ToStringWind( Controllable, Settings ) -- R2.3
+  function COORDINATE:ToStringWind( Controllable, Settings )
   
     self:F2( { Controllable = Controllable and Controllable:GetName() } )
 
@@ -1870,9 +2173,9 @@ do -- COORDINATE
   --   * Can be overridden if for a GROUP containing x clients, a menu was selected to override the default.
   -- @param #COORDINATE self
   -- @param Wrapper.Controllable#CONTROLLABLE Controllable
-  -- @param Core.Settings#SETTINGS Settings
+  -- @param Core.Settings#SETTINGS 
   -- @return #string The temperature text in the configured measurement system.
-  function COORDINATE:ToStringTemperature( Controllable, Settings ) -- R2.3
+  function COORDINATE:ToStringTemperature( Controllable, Settings )
   
     self:F2( { Controllable = Controllable and Controllable:GetName() } )
 
@@ -1895,7 +2198,7 @@ do -- POINT_VEC3
   -- @field #POINT_VEC3.RoutePointAltType RoutePointAltType
   -- @field #POINT_VEC3.RoutePointType RoutePointType
   -- @field #POINT_VEC3.RoutePointAction RoutePointAction
-  -- @extends Core.Point#COORDINATE
+  -- @extends #COORDINATE
   
   
   --- Defines a 3D point in the simulator and with its methods, you can use or manipulate the point in 3D space.

Moose Development/Moose/Core/Radio.lua

@@ -1,40 +1,45 @@
---- **Core** -- The RADIO Module is responsible for everything that is related to radio transmission and you can hear in DCS, be it TACAN beacons, Radio transmissions...
+--- **Core** - Is responsible for everything that is related to radio transmission and you can hear in DCS, be it TACAN beacons, Radio transmissions.
 -- 
 -- ===
+-- 
+-- ## Features:
+-- 
+--   * Provide radio functionality to broadcast radio transmissions.
+--   * Provide beacon functionality to assist pilots.
 --
 -- The Radio contains 2 classes : RADIO and BEACON
 --  
--- What are radio communications in DCS ?
+-- What are radio communications in DCS?
 -- 
 --   * Radio transmissions consist of **sound files** that are broadcasted on a specific **frequency** (e.g. 115MHz) and **modulation** (e.g. AM),
 --   * They can be **subtitled** for a specific **duration**, the **power** in Watts of the transmiter's antenna can be set, and the transmission can be **looped**.
 -- 
--- How to supply DCS my own Sound Files ?
+-- How to supply DCS my own Sound Files?
 --   
 --   * Your sound files need to be encoded in **.ogg** or .wav,
 --   * Your sound files should be **as tiny as possible**. It is suggested you encode in .ogg with low bitrate and sampling settings,
 --   * They need to be added in .\l10n\DEFAULT\ in you .miz file (wich can be decompressed like a .zip file),
---   * For simplicty sake, you can **let DCS' Mission Editor add the file** itself, by creating a new Trigger with the action "Sound to Country", and choosing your sound file and a country you don't use in your mission.
+--   * For simplicity sake, you can **let DCS' Mission Editor add the file** itself, by creating a new Trigger with the action "Sound to Country", and choosing your sound file and a country you don't use in your mission.
 --   
 -- Due to weird DCS quirks, **radio communications behave differently** if sent by a @{Wrapper.Unit#UNIT} or a @{Wrapper.Group#GROUP} or by any other @{Wrapper.Positionable#POSITIONABLE}
 -- 
---   * If the transmitter is a @{Wrapper.Unit#UNIT} or a @{Wrapper.Group#GROUP}, DCS will set the power of the transmission  automatically,
+--   * If the transmitter is a @{Wrapper.Unit#UNIT} or a @{Wrapper.Group#GROUP}, DCS will set the power of the transmission automatically,
 --   * If the transmitter is any other @{Wrapper.Positionable#POSITIONABLE}, the transmisison can't be subtitled or looped.
 --   
 -- Note that obviously, the **frequency** and the **modulation** of the transmission are important only if the players are piloting an **Advanced System Modelling** enabled aircraft,
 -- like the A10C or the Mirage 2000C. They will **hear the transmission** if they are tuned on the **right frequency and modulation** (and if they are close enough - more on that below).
--- If a FC3 airacraft is used, it will **hear every communication, whatever the frequency and the modulation** is set to. The same is true for TACAN beacons. If your aircaft isn't compatible,
+-- If an FC3 aircraft is used, it will **hear every communication, whatever the frequency and the modulation** is set to. The same is true for TACAN beacons. If your aircraft isn't compatible,
 -- you won't hear/be able to use the TACAN beacon informations.
 --
 -- ===
 --
--- ### Author: Hugues "Grey_Echo" Bousquet
+-- ### Authors: Hugues "Grey_Echo" Bousquet, funkyfranky
 --
 -- @module Core.Radio
 -- @image Core_Radio.JPG
 
 
---- Models the radio capabilty.
+--- Models the radio capability.
 -- 
 -- ## RADIO usage
 -- 
@@ -51,34 +56,35 @@
 --   * @{#RADIO.SetModulation}() : Sets the modulation of your transmission.
 --   * @{#RADIO.SetLoop}() : Choose if you want the transmission to be looped. If you need your transmission to be looped, you might need a @{#BEACON} instead...
 -- 
--- Additional Methods to set relevant parameters if the transmiter is a @{Wrapper.Unit#UNIT} or a @{Wrapper.Group#GROUP}
+-- Additional Methods to set relevant parameters if the transmitter is a @{Wrapper.Unit#UNIT} or a @{Wrapper.Group#GROUP}
 -- 
 --   * @{#RADIO.SetSubtitle}() : Set both the subtitle and its duration,
 --   * @{#RADIO.NewUnitTransmission}() : Shortcut to set all the relevant parameters in one method call
 -- 
--- Additional Methods to set relevant parameters if the transmiter is any other @{Wrapper.Positionable#POSITIONABLE}
+-- Additional Methods to set relevant parameters if the transmitter is any other @{Wrapper.Positionable#POSITIONABLE}
 -- 
 --   * @{#RADIO.SetPower}() : Sets the power of the antenna in Watts
 --   * @{#RADIO.NewGenericTransmission}() : Shortcut to set all the relevant parameters in one method call
 -- 
--- What is this power thing ?
+-- What is this power thing?
 -- 
 --   * If your transmission is sent by a @{Wrapper.Positionable#POSITIONABLE} other than a @{Wrapper.Unit#UNIT} or a @{Wrapper.Group#GROUP}, you can set the power of the antenna,
 --   * Otherwise, DCS sets it automatically, depending on what's available on your Unit,
---   * If the player gets **too far** from the transmiter, or if the antenna is **too weak**, the transmission will **fade** and **become noisyer**,
+--   * If the player gets **too far** from the transmitter, or if the antenna is **too weak**, the transmission will **fade** and **become noisyer**,
 --   * This an automated DCS calculation you have no say on,
---   * For reference, a standard VOR station has a 100W antenna, a standard AA TACAN has a 120W antenna, and civilian ATC's antenna usually range between 300 and 500W,
+--   * For reference, a standard VOR station has a 100 W antenna, a standard AA TACAN has a 120 W antenna, and civilian ATC's antenna usually range between 300 and 500 W,
 --   * Note that if the transmission has a subtitle, it will be readable, regardless of the quality of the transmission. 
 --   
 -- @type RADIO
--- @field Positionable#POSITIONABLE Positionable The transmiter
--- @field #string FileName Name of the sound file
--- @field #number Frequency Frequency of the transmission in Hz
--- @field #number Modulation Modulation of the transmission (either radio.modulation.AM or radio.modulation.FM)
--- @field #string Subtitle Subtitle of the transmission
--- @field #number SubtitleDuration Duration of the Subtitle in seconds
--- @field #number Power Power of the antenna is Watts
--- @field #boolean Loop (default true)
+-- @field Wrapper.Controllable#CONTROLLABLE Positionable The @{#CONTROLLABLE} that will transmit the radio calls.
+-- @field #string FileName Name of the sound file played.
+-- @field #number Frequency Frequency of the transmission in Hz.
+-- @field #number Modulation Modulation of the transmission (either radio.modulation.AM or radio.modulation.FM).
+-- @field #string Subtitle Subtitle of the transmission.
+-- @field #number SubtitleDuration Duration of the Subtitle in seconds.
+-- @field #number Power Power of the antenna is Watts.
+-- @field #boolean Loop Transmission is repeated (default true).
+-- @field #string alias Name of the radio transmitter.
 -- @extends Core.Base#BASE
 RADIO = {
   ClassName = "RADIO",
@@ -88,19 +94,19 @@ RADIO = {
   Subtitle = "",
   SubtitleDuration = 0,
   Power = 100,
-  Loop = true,
+  Loop = false,
+  alias=nil,
 }
 
---- Create a new RADIO Object. This doesn't broadcast a transmission, though, use @{#RADIO.Broadcast} to actually broadcast
--- If you want to create a RADIO, you probably should use @{Wrapper.Positionable#POSITIONABLE.GetRadio}() instead
+--- Create a new RADIO Object. This doesn't broadcast a transmission, though, use @{#RADIO.Broadcast} to actually broadcast.
+-- If you want to create a RADIO, you probably should use @{Wrapper.Positionable#POSITIONABLE.GetRadio}() instead.
 -- @param #RADIO self
 -- @param Wrapper.Positionable#POSITIONABLE Positionable The @{Positionable} that will receive radio capabilities.
--- @return #RADIO Radio
--- @return #nil If Positionable is invalid
+-- @return #RADIO The RADIO object or #nil if Positionable is invalid.
 function RADIO:New(Positionable)
+
+  -- Inherit base
   local self = BASE:Inherit( self, BASE:New() ) -- Core.Radio#RADIO
-  
-  self.Loop = true        -- default Loop to true (not sure the above RADIO definition actually is working)
   self:F(Positionable)
   
   if Positionable:GetPointVec2() then -- It's stupid, but the only way I found to make sure positionable is valid
@@ -108,11 +114,27 @@ function RADIO:New(Positionable)
     return self
   end
   
-  self:E({"The passed positionable is invalid, no RADIO created", Positionable})
+  self:E({error="The passed positionable is invalid, no RADIO created!", positionable=Positionable})
   return nil
 end
 
---- Check validity of the filename passed and sets RADIO.FileName
+--- Set alias of the transmitter.
+-- @param #RADIO self
+-- @param #string alias Name of the radio transmitter.
+-- @return #RADIO self
+function RADIO:SetAlias(alias)
+  self.alias=tostring(alias)
+  return self
+end
+
+--- Get alias of the transmitter.
+-- @param #RADIO self
+-- @return #string Name of the transmitter.
+function RADIO:GetAlias()
+  return tostring(self.alias)
+end
+
+--- Set the file name for the radio transmission.
 -- @param #RADIO self
 -- @param #string FileName File name of the sound file (i.e. "Noise.ogg")
 -- @return #RADIO self
@@ -120,49 +142,63 @@ function RADIO:SetFileName(FileName)
   self:F2(FileName)
   
   if type(FileName) == "string" then
+  
     if FileName:find(".ogg") or FileName:find(".wav") then
       if not FileName:find("l10n/DEFAULT/") then
         FileName = "l10n/DEFAULT/" .. FileName
       end
+      
       self.FileName = FileName
       return self
     end
   end
   
-  self:E({"File name invalid. Maybe something wrong with the extension ?", self.FileName})
+  self:E({"File name invalid. Maybe something wrong with the extension?", FileName})
   return self
 end
 
---- Check validity of the frequency passed and sets RADIO.Frequency
+--- Set the frequency for the radio transmission.
+-- If the transmitting positionable is a unit or group, this also set the command "SetFrequency" with the defined frequency and modulation.
 -- @param #RADIO self
--- @param #number Frequency in MHz (Ranges allowed for radio transmissions in DCS : 30-88 / 108-152 / 225-400MHz)
+-- @param #number Frequency Frequency in MHz. Ranges allowed for radio transmissions in DCS : 30-87.995 / 108-173.995 / 225-399.975MHz.
 -- @return #RADIO self
 function RADIO:SetFrequency(Frequency)
   self:F2(Frequency)
+  
   if type(Frequency) == "number" then
+  
     -- If frequency is in range
-    if (Frequency >= 30 and Frequency < 88) or (Frequency >= 108 and Frequency < 152) or (Frequency >= 225 and Frequency < 400) then
-      self.Frequency = Frequency * 1000000 -- Conversion in Hz
+    if (Frequency >= 30 and Frequency <= 87.995) or (Frequency >= 108 and Frequency <= 173.995) or (Frequency >= 225 and Frequency <= 399.975) then
+    
+      -- Convert frequency from MHz to Hz
+      self.Frequency = Frequency * 1000000
+            
       -- If the RADIO is attached to a UNIT or a GROUP, we need to send the DCS Command "SetFrequency" to change the UNIT or GROUP frequency
       if self.Positionable.ClassName == "UNIT" or self.Positionable.ClassName == "GROUP" then
-        self.Positionable:SetCommand({
+      
+        local commandSetFrequency={
           id = "SetFrequency",
           params = {
-            frequency = self.Frequency,
+            frequency  = self.Frequency,
             modulation = self.Modulation,
           }
-        })
+        }            
+      
+        self:T2(commandSetFrequency)
+        self.Positionable:SetCommand(commandSetFrequency)
       end
+      
       return self
     end
   end
-  self:E({"Frequency is outside of DCS Frequency ranges (30-80, 108-152, 225-400). Frequency unchanged.", self.Frequency})
+  
+  self:E({"Frequency is outside of DCS Frequency ranges (30-80, 108-152, 225-400). Frequency unchanged.", Frequency})
   return self
 end
 
---- Check validity of the frequency passed and sets RADIO.Modulation
+--- Set AM or FM modulation of the radio transmitter.
 -- @param #RADIO self
--- @param #number Modulation either radio.modulation.AM or radio.modulation.FM
+-- @param #number Modulation Modulation is either radio.modulation.AM or radio.modulation.FM.
 -- @return #RADIO self
 function RADIO:SetModulation(Modulation)
   self:F2(Modulation)
@@ -178,23 +214,24 @@ end
 
 --- Check validity of the power passed and sets RADIO.Power
 -- @param #RADIO self
--- @param #number Power in W
+-- @param #number Power Power in W.
 -- @return #RADIO self
 function RADIO:SetPower(Power)
   self:F2(Power)
+  
   if type(Power) == "number" then
     self.Power = math.floor(math.abs(Power)) --TODO Find what is the maximum power allowed by DCS and limit power to that
-    return self
+  else
+    self:E({"Power is invalid. Power unchanged.", self.Power})
   end
-  self:E({"Power is invalid. Power unchanged.", self.Power})
+  
   return self
 end
 
---- Check validity of the loop passed and sets RADIO.Loop
+--- Set message looping on or off.
 -- @param #RADIO self
--- @param #boolean Loop
+-- @param #boolean Loop If true, message is repeated indefinitely.
 -- @return #RADIO self
--- @usage
 function RADIO:SetLoop(Loop)
   self:F2(Loop)
   if type(Loop) == "boolean" then
@@ -227,13 +264,12 @@ function RADIO:SetSubtitle(Subtitle, SubtitleDuration)
     self:E({"Subtitle is invalid. Subtitle reset.", self.Subtitle})
   end
   if type(SubtitleDuration) == "number" then
-    if math.floor(math.abs(SubtitleDuration)) == SubtitleDuration then
-      self.SubtitleDuration = SubtitleDuration
-      return self
-    end
+    self.SubtitleDuration = SubtitleDuration
+  else
+    self.SubtitleDuration = 0
+    self:E({"SubtitleDuration is invalid. SubtitleDuration reset.", self.SubtitleDuration})  
   end
-  self.SubtitleDuration = 0
-  self:E({"SubtitleDuration is invalid. SubtitleDuration reset.", self.SubtitleDuration})
+  return self
 end
 
 --- Create a new transmission, that is to say, populate the RADIO with relevant data
@@ -241,10 +277,10 @@ end
 -- but it will work with a UNIT or a GROUP anyway. 
 -- Only the #RADIO and the Filename are mandatory
 -- @param #RADIO self
--- @param #string FileName
--- @param #number Frequency in MHz
--- @param #number Modulation either radio.modulation.AM or radio.modulation.FM
--- @param #number Power in W
+-- @param #string FileName Name of the sound file that will be transmitted.
+-- @param #number Frequency Frequency in MHz.
+-- @param #number Modulation Modulation of frequency, which is either radio.modulation.AM or radio.modulation.FM.
+-- @param #number Power Power in W.
 -- @return #RADIO self
 function RADIO:NewGenericTransmission(FileName, Frequency, Modulation, Power, Loop)
   self:F({FileName, Frequency, Modulation, Power})
@@ -264,31 +300,43 @@ end
 -- but it will work for any @{Wrapper.Positionable#POSITIONABLE}. 
 -- Only the RADIO and the Filename are mandatory.
 -- @param #RADIO self
--- @param #string FileName
--- @param #string Subtitle
--- @param #number SubtitleDuration in s
--- @param #number Frequency in MHz
--- @param #number Modulation either radio.modulation.AM or radio.modulation.FM
--- @param #boolean Loop
+-- @param #string FileName Name of sound file.
+-- @param #string Subtitle Subtitle to be displayed with sound file.
+-- @param #number SubtitleDuration Duration of subtitle display in seconds.
+-- @param #number Frequency Frequency in MHz.
+-- @param #number Modulation Modulation which can be either radio.modulation.AM or radio.modulation.FM
+-- @param #boolean Loop If true, loop message.
 -- @return #RADIO self
 function RADIO:NewUnitTransmission(FileName, Subtitle, SubtitleDuration, Frequency, Modulation, Loop)
   self:F({FileName, Subtitle, SubtitleDuration, Frequency, Modulation, Loop})
 
+  -- Set file name.
   self:SetFileName(FileName)
-  local Duration = 5
-  if SubtitleDuration then Duration = SubtitleDuration end
-  -- SubtitleDuration argument was missing, adding it
-  if Subtitle then self:SetSubtitle(Subtitle, Duration) end
-  -- self:SetSubtitleDuration is non existent, removing faulty line
-  -- if SubtitleDuration then self:SetSubtitleDuration(SubtitleDuration) end
-  if Frequency then self:SetFrequency(Frequency) end
-  if Modulation then self:SetModulation(Modulation) end
-  if Loop then self:SetLoop(Loop) end
+
+  -- Set modulation AM/FM.
+  if Modulation then
+    self:SetModulation(Modulation)
+  end
+
+  -- Set frequency.
+  if Frequency then 
+    self:SetFrequency(Frequency)
+  end
+  
+  -- Set subtitle.
+  if Subtitle then
+    self:SetSubtitle(Subtitle, SubtitleDuration or 0)
+  end
+ 
+  -- Set Looping.
+  if Loop then 
+    self:SetLoop(Loop)
+  end
   
   return self
 end
 
---- Actually Broadcast the transmission
+--- Broadcast the transmission.
 -- * The Radio has to be populated with the new transmission before broadcasting.
 -- * Please use RADIO setters or either @{#RADIO.NewGenericTransmission} or @{#RADIO.NewUnitTransmission}
 -- * This class is in fact pretty smart, it determines the right DCS function to use depending on the type of POSITIONABLE
@@ -297,31 +345,38 @@ end
 -- * If your POSITIONABLE is a UNIT or a GROUP, the Power is ignored.
 -- * If your POSITIONABLE is not a UNIT or a GROUP, the Subtitle, SubtitleDuration are ignored
 -- @param #RADIO self
+-- @param #boolean viatrigger Use trigger.action.radioTransmission() in any case, i.e. also for UNITS and GROUPS.
 -- @return #RADIO self
-function RADIO:Broadcast()
-  self:F()
+function RADIO:Broadcast(viatrigger)
+  self:F({viatrigger=viatrigger})
   
-  -- If the POSITIONABLE is actually a UNIT or a GROUP, use the more complicated DCS command system
-  if self.Positionable.ClassName == "UNIT" or self.Positionable.ClassName == "GROUP" then
-    self:T2("Broadcasting from a UNIT or a GROUP")
-    self.Positionable:SetCommand({
+  -- If the POSITIONABLE is actually a UNIT or a GROUP, use the more complicated DCS command system.
+  if (self.Positionable.ClassName=="UNIT" or self.Positionable.ClassName=="GROUP") and (not viatrigger) then
+    self:T("Broadcasting from a UNIT or a GROUP")
+
+    local commandTransmitMessage={
       id = "TransmitMessage",
       params = {
         file = self.FileName,
         duration = self.SubtitleDuration,
         subtitle = self.Subtitle,
         loop = self.Loop,
-      }
-    })
+      }}
+    
+    self:T3(commandTransmitMessage)
+    self.Positionable:SetCommand(commandTransmitMessage)
   else
     -- If the POSITIONABLE is anything else, we revert to the general singleton function
     -- I need to give it a unique name, so that the transmission can be stopped later. I use the class ID
-    self:T2("Broadcasting from a POSITIONABLE")
+    self:T("Broadcasting from a POSITIONABLE")
     trigger.action.radioTransmission(self.FileName, self.Positionable:GetPositionVec3(), self.Modulation, self.Loop, self.Frequency, self.Power, tostring(self.ID))
   end
+  
   return self
 end
 
+
+
 --- Stops a transmission
 -- This function is especially usefull to stop the broadcast of looped transmissions
 -- @param #RADIO self
@@ -330,10 +385,10 @@ function RADIO:StopBroadcast()
   self:F()
   -- If the POSITIONABLE is a UNIT or a GROUP, stop the transmission with the DCS "StopTransmission" command 
   if self.Positionable.ClassName == "UNIT" or self.Positionable.ClassName == "GROUP" then
-    self.Positionable:SetCommand({
-      id = "StopTransmission",
-      params = {}
-    })
+  
+    local commandStopTransmission={id="StopTransmission", params={}}
+  
+    self.Positionable:SetCommand(commandStopTransmission)
   else
     -- Else, we use the appropriate singleton funciton
     trigger.action.stopRadioTransmission(tostring(self.ID))
@@ -359,24 +414,91 @@ end
 -- Use @{#BEACON:StopRadioBeacon}() to stop it.
 -- 
 -- @type BEACON
+-- @field #string ClassName Name of the class "BEACON".
+-- @field Wrapper.Controllable#CONTROLLABLE Positionable The @{#CONTROLLABLE} that will receive radio capabilities.
 -- @extends Core.Base#BASE
 BEACON = {
   ClassName = "BEACON",
+  Positionable = nil,
+  name=nil,
 }
 
---- Create a new BEACON Object. This doesn't activate the beacon, though, use @{#BEACON.AATACAN} or @{#BEACON.Generic}
+--- Beacon types supported by DCS. 
+-- @type BEACON.Type
+-- @field #number NULL
+-- @field #number VOR
+-- @field #number DME
+-- @field #number VOR_DME
+-- @field #number TACAN
+-- @field #number VORTAC
+-- @field #number RSBN
+-- @field #number BROADCAST_STATION
+-- @field #number HOMER
+-- @field #number AIRPORT_HOMER
+-- @field #number AIRPORT_HOMER_WITH_MARKER
+-- @field #number ILS_FAR_HOMER
+-- @field #number ILS_NEAR_HOMER
+-- @field #number ILS_LOCALIZER
+-- @field #number ILS_GLIDESLOPE
+-- @field #number NAUTICAL_HOMER
+-- @field #number ICLS
+BEACON.Type={
+  NULL = 0, 
+  VOR = 1,
+  DME = 2,
+  VOR_DME = 3, 
+  TACAN = 4,
+  VORTAC = 5, 
+  RSBN = 32,
+  BROADCAST_STATION = 1024, 
+  HOMER = 8,
+  AIRPORT_HOMER = 4104, 
+  AIRPORT_HOMER_WITH_MARKER = 4136, 
+  ILS_FAR_HOMER = 16408,
+  ILS_NEAR_HOMER = 16456, 
+  ILS_LOCALIZER = 16640,
+  ILS_GLIDESLOPE = 16896, 
+  NAUTICAL_HOMER = 32776,
+  ICLS = 131584,
+}
+
+--- Beacon systems supported by DCS. https://wiki.hoggitworld.com/view/DCS_command_activateBeacon
+-- @type BEACON.System
+-- @field #number PAR_10
+-- @field #number RSBN_5
+-- @field #number TACAN
+-- @field #number TACAN_TANKER
+-- @field #number ILS_LOCALIZER (This is the one to be used for AA TACAN Tanker!)
+-- @field #number ILS_GLIDESLOPE
+-- @field #number BROADCAST_STATION
+BEACON.System={
+  PAR_10 = 1, 
+  RSBN_5 = 2, 
+  TACAN = 3, 
+  TACAN_TANKER = 4, 
+  ILS_LOCALIZER = 5, 
+  ILS_GLIDESLOPE = 6, 
+  BROADCAST_STATION = 7,
+}
+
+--- Create a new BEACON Object. This doesn't activate the beacon, though, use @{#BEACON.ActivateTACAN} etc.
 -- If you want to create a BEACON, you probably should use @{Wrapper.Positionable#POSITIONABLE.GetBeacon}() instead.
 -- @param #BEACON self
 -- @param Wrapper.Positionable#POSITIONABLE Positionable The @{Positionable} that will receive radio capabilities.
--- @return #BEACON Beacon
--- @return #nil If Positionable is invalid
+-- @return #BEACON Beacon object or #nil if the positionable is invalid.
 function BEACON:New(Positionable)
-  local self = BASE:Inherit(self, BASE:New())
+
+  -- Inherit BASE.
+  local self=BASE:Inherit(self, BASE:New()) --#BEACON
   
+  -- Debug.
   self:F(Positionable)
   
+  -- Set positionable.
   if Positionable:GetPointVec2() then -- It's stupid, but the only way I found to make sure positionable is valid
     self.Positionable = Positionable
+    self.name=Positionable:GetName()
+    self:I(string.format("New BEACON %s", tostring(self.name)))
     return self
   end
   
@@ -385,44 +507,95 @@ function BEACON:New(Positionable)
 end
 
 
---- Converts a TACAN Channel/Mode couple into a frequency in Hz
+--- Activates a TACAN BEACON.
 -- @param #BEACON self
--- @param #number TACANChannel
--- @param #string TACANMode
--- @return #number Frequecy
--- @return #nil if parameters are invalid
-function BEACON:_TACANToFrequency(TACANChannel, TACANMode)
-  self:F3({TACANChannel, TACANMode})
-
-  if type(TACANChannel) ~= "number" then
-      if TACANMode ~= "X" and TACANMode ~= "Y" then
-        return nil -- error in arguments
-      end
+-- @param #number Channel TACAN channel, i.e. the "10" part in "10Y".
+-- @param #string Mode TACAN mode, i.e. the "Y" part in "10Y".
+-- @param #string Message The Message that is going to be coded in Morse and broadcasted by the beacon.
+-- @param #boolean Bearing If true, beacon provides bearing information. If false (or nil), only distance information is available.
+-- @param #number Duration How long will the beacon last in seconds. Omit for forever.
+-- @return #BEACON self
+-- @usage
+-- -- Let's create a TACAN Beacon for a tanker
+-- local myUnit = UNIT:FindByName("MyUnit") 
+-- local myBeacon = myUnit:GetBeacon() -- Creates the beacon
+-- 
+-- myBeacon:ActivateTACAN(20, "Y", "TEXACO", true) -- Activate the beacon
+function BEACON:ActivateTACAN(Channel, Mode, Message, Bearing, Duration)
+  self:T({channel=Channel, mode=Mode, callsign=Message, bearing=Bearing, duration=Duration})
+  
+  -- Get frequency.
+  local Frequency=UTILS.TACANToFrequency(Channel, Mode)
+  
+  -- Check.
+  if not Frequency then 
+    self:E({"The passed TACAN channel is invalid, the BEACON is not emitting"})
+    return self
   end
   
--- This code is largely based on ED's code, in DCS World\Scripts\World\Radio\BeaconTypes.lua, line 137.
--- I have no idea what it does but it seems to work
-  local A = 1151 -- 'X', channel >= 64
-  local B = 64   -- channel >= 64
+  -- Beacon type.
+  local Type=BEACON.Type.TACAN
   
-  if TACANChannel < 64 then
-    B = 1
-  end
+  -- Beacon system.  
+  local System=BEACON.System.TACAN
   
-  if TACANMode == 'Y' then
-    A = 1025
-    if TACANChannel < 64 then
-      A = 1088
-    end
-  else -- 'X'
-    if TACANChannel < 64 then
-      A = 962
+  -- Check if unit is an aircraft and set system accordingly.
+  local AA=self.Positionable:IsAir()
+  if AA then
+    System=5 --NOTE: 5 is how you cat the correct tanker behaviour! --BEACON.System.TACAN_TANKER
+    -- Check if "Y" mode is selected for aircraft.
+    if Mode~="Y" then
+      self:E({"WARNING: The POSITIONABLE you want to attach the AA Tacan Beacon is an aircraft: Mode should Y !The BEACON is not emitting.", self.Positionable})
     end
   end
   
-  return (A + TACANChannel - B) * 1000000
+  -- Attached unit.
+  local UnitID=self.Positionable:GetID()
+  
+  -- Debug.
+  self:I({string.format("BEACON Activating TACAN %s: Channel=%d%s, Morse=%s, Bearing=%s, Duration=%s!", tostring(self.name), Channel, Mode, Message, tostring(Bearing), tostring(Duration))})
+    
+  -- Start beacon.
+  self.Positionable:CommandActivateBeacon(Type, System, Frequency, UnitID, Channel, Mode, AA, Message, Bearing)
+      
+  -- Stop sheduler.
+  if Duration then
+    self.Positionable:DeactivateBeacon(Duration)
+  end
+  
+  return self
 end
 
+--- Activates an ICLS BEACON. The unit the BEACON is attached to should be an aircraft carrier supporting this system.
+-- @param #BEACON self
+-- @param #number Channel ICLS channel.
+-- @param #string Callsign The Message that is going to be coded in Morse and broadcasted by the beacon.
+-- @param #number Duration How long will the beacon last in seconds. Omit for forever.
+-- @return #BEACON self
+function BEACON:ActivateICLS(Channel, Callsign, Duration)
+  self:F({Channel=Channel, Callsign=Callsign, Duration=Duration})
+  
+  -- Attached unit.
+  local UnitID=self.Positionable:GetID()
+  
+  -- Debug
+  self:T2({"ICLS BEACON started!"})
+    
+  -- Start beacon.
+  self.Positionable:CommandActivateICLS(Channel, UnitID, Callsign)
+      
+  -- Stop sheduler
+  if Duration then -- Schedule the stop of the BEACON if asked by the MD
+    self.Positionable:DeactivateBeacon(Duration)
+  end
+  
+  return self
+end
+
+
+
+
+
 
 --- Activates a TACAN BEACON on an Aircraft.
 -- @param #BEACON self
@@ -475,7 +648,7 @@ function BEACON:AATACAN(TACANChannel, Message, Bearing, BeaconDuration)
       })
       
     if BeaconDuration then -- Schedule the stop of the BEACON if asked by the MD
-      SCHEDULER:New( nil, 
+      SCHEDULER:New(nil, 
       function()
         self:StopAATACAN()
       end, {}, BeaconDuration)
@@ -586,4 +759,45 @@ function BEACON:StopRadioBeacon()
   self:F()
   -- The unique name of the transmission is the class ID
   trigger.action.stopRadioTransmission(tostring(self.ID))
-end
+  return self
+end
+
+--- Converts a TACAN Channel/Mode couple into a frequency in Hz
+-- @param #BEACON self
+-- @param #number TACANChannel
+-- @param #string TACANMode
+-- @return #number Frequecy
+-- @return #nil if parameters are invalid
+function BEACON:_TACANToFrequency(TACANChannel, TACANMode)
+  self:F3({TACANChannel, TACANMode})
+
+  if type(TACANChannel) ~= "number" then
+    if TACANMode ~= "X" and TACANMode ~= "Y" then
+      return nil -- error in arguments
+    end
+  end
+  
+-- This code is largely based on ED's code, in DCS World\Scripts\World\Radio\BeaconTypes.lua, line 137.
+-- I have no idea what it does but it seems to work
+  local A = 1151 -- 'X', channel >= 64
+  local B = 64   -- channel >= 64
+  
+  if TACANChannel < 64 then
+    B = 1
+  end
+  
+  if TACANMode == 'Y' then
+    A = 1025
+    if TACANChannel < 64 then
+      A = 1088
+    end
+  else -- 'X'
+    if TACANChannel < 64 then
+      A = 962
+    end
+  end
+  
+  return (A + TACANChannel - B) * 1000000
+end
+
+

Moose Development/Moose/Core/RadioQueue.lua

@@ -0,0 +1,567 @@
+--- **Core** - Queues Radio Transmissions.
+-- 
+-- ===
+-- 
+-- ## Features:
+-- 
+--   * Managed Radio Transmissions.
+--
+-- ===
+--
+-- ### Authors: funkyfranky
+--
+-- @module Core.RadioQueue
+-- @image Core_Radio.JPG
+
+--- Manages radio transmissions.
+-- 
+-- @type RADIOQUEUE
+-- @field #string ClassName Name of the class "RADIOQUEUE".
+-- @field #boolean Debug Debug mode. More info.
+-- @field #string lid ID for dcs.log.
+-- @field #number frequency The radio frequency in Hz.
+-- @field #number modulation The radio modulation. Either radio.modulation.AM or radio.modulation.FM.
+-- @field Core.Scheduler#SCHEDULER scheduler The scheduler.
+-- @field #string RQid The radio queue scheduler ID.
+-- @field #table queue The queue of transmissions.
+-- @field #string alias Name of the radio.
+-- @field #number dt Time interval in seconds for checking the radio queue.
+-- @field #number delay Time delay before starting the radio queue. 
+-- @field #number Tlast Time (abs) when the last transmission finished.
+-- @field Core.Point#COORDINATE sendercoord Coordinate from where transmissions are broadcasted.
+-- @field #number sendername Name of the sending unit or static.
+-- @field #boolean senderinit Set frequency was initialized.
+-- @field #number power Power of radio station in Watts. Default 100 W.
+-- @field #table numbers Table of number transmission parameters.
+-- @field #boolean checking Scheduler is checking the radio queue. 
+-- @field #boolean schedonce Call ScheduleOnce instead of normal scheduler.
+-- @extends Core.Base#BASE
+RADIOQUEUE = {
+  ClassName   = "RADIOQUEUE",
+  Debug       = nil,
+  lid         = nil,
+  frequency   = nil,
+  modulation  = nil,
+  scheduler   = nil,
+  RQid        = nil,
+  queue       =  {},
+  alias       = nil,
+  dt          = nil,
+  delay       = nil,
+  Tlast       = nil,
+  sendercoord = nil,
+  sendername  = nil,
+  senderinit  = nil,
+  power       = nil,
+  numbers     =  {},
+  checking    = nil,
+  schedonce   = nil,
+}
+
+--- Radio queue transmission data.
+-- @type RADIOQUEUE.Transmission
+-- @field #string filename Name of the file to be transmitted.
+-- @field #string path Path in miz file where the file is located.
+-- @field #number duration Duration in seconds.
+-- @field #string subtitle Subtitle of the transmission.
+-- @field #number subduration Duration of the subtitle being displayed.
+-- @field #number Tstarted Mission time (abs) in seconds when the transmission started.
+-- @field #boolean isplaying If true, transmission is currently playing.
+-- @field #number Tplay Mission time (abs) in seconds when the transmission should be played.
+-- @field #number interval Interval in seconds before next transmission.
+
+
+--- Create a new RADIOQUEUE object for a given radio frequency/modulation.
+-- @param #RADIOQUEUE self
+-- @param #number frequency The radio frequency in MHz.
+-- @param #number modulation (Optional) The radio modulation. Default radio.modulation.AM.
+-- @param #string alias (Optional) Name of the radio queue.
+-- @return #RADIOQUEUE self The RADIOQUEUE object.
+function RADIOQUEUE:New(frequency, modulation, alias)
+
+  -- Inherit base
+  local self=BASE:Inherit(self, BASE:New()) -- #RADIOQUEUE
+  
+  self.alias=alias or "My Radio"
+  
+  self.lid=string.format("RADIOQUEUE %s | ", self.alias)
+  
+  if frequency==nil then
+    self:E(self.lid.."ERROR: No frequency specified as first parameter!")
+    return nil
+  end
+  
+  -- Frequency in Hz.
+  self.frequency=frequency*1000000
+  
+  -- Modulation.
+  self.modulation=modulation or radio.modulation.AM
+  
+  -- Set radio power.
+  self:SetRadioPower()
+  
+  -- Scheduler.
+  self.scheduler=SCHEDULER:New()
+  self.scheduler:NoTrace()
+  
+  return self
+end
+
+--- Start the radio queue.
+-- @param #RADIOQUEUE self
+-- @param #number delay (Optional) Delay in seconds, before the radio queue is started. Default 1 sec.
+-- @param #number dt (Optional) Time step in seconds for checking the queue. Default 0.01 sec.
+-- @return #RADIOQUEUE self The RADIOQUEUE object.
+function RADIOQUEUE:Start(delay, dt)
+
+  self.delay=delay or 1
+  
+  self.dt=dt or 0.01
+  
+  self:I(self.lid..string.format("Starting RADIOQUEUE %s on Frequency %.2f MHz [modulation=%d] in %.1f seconds (dt=%.3f sec)", self.alias, self.frequency/1000000, self.modulation, delay, dt))
+
+  
+  if self.schedonce then
+    self:_CheckRadioQueueDelayed(self.delta)
+  else
+    --self.RQid=self.scheduler:Schedule(self, self._CheckRadioQueue, {}, delay, dt)
+    self.RQid=self.scheduler:Schedule(nil, RADIOQUEUE._CheckRadioQueue, {self}, delay, dt)
+  end
+  
+  return self
+end
+
+--- Stop the radio queue. Stop scheduler and delete queue.
+-- @param #RADIOQUEUE self
+-- @return #RADIOQUEUE self The RADIOQUEUE object.
+function RADIOQUEUE:Stop()
+  self:I(self.lid.."Stopping RADIOQUEUE.")
+  self.scheduler:Stop(self.RQid)
+  self.queue={}
+  return self
+end
+
+--- Set coordinate from where the transmission is broadcasted.
+-- @param #RADIOQUEUE self
+-- @param Core.Point#COORDINATE coordinate Coordinate of the sender.
+-- @return #RADIOQUEUE self The RADIOQUEUE object.
+function RADIOQUEUE:SetSenderCoordinate(coordinate)
+  self.sendercoord=coordinate
+  return self
+end
+
+--- Set name of unit or static from which transmissions are made.
+-- @param #RADIOQUEUE self
+-- @param #string name Name of the unit or static used for transmissions.
+-- @return #RADIOQUEUE self The RADIOQUEUE object.
+function RADIOQUEUE:SetSenderUnitName(name)
+  self.sendername=name
+  return self
+end
+
+--- Set radio power. Note that this only applies if no relay unit is used.
+-- @param #RADIOQUEUE self
+-- @param #number power Radio power in Watts. Default 100 W.
+-- @return #RADIOQUEUE self The RADIOQUEUE object.
+function RADIOQUEUE:SetRadioPower(power)
+  self.power=power or 100
+  return self
+end
+
+--- Set parameters of a digit.
+-- @param #RADIOQUEUE self
+-- @param #number digit The digit 0-9.
+-- @param #string filename The name of the sound file.
+-- @param #number duration The duration of the sound file in seconds.
+-- @param #string path The directory within the miz file where the sound is located. Default "l10n/DEFAULT/".
+-- @param #string subtitle Subtitle of the transmission.
+-- @param #number subduration Duration [sec] of the subtitle being displayed. Default 5 sec.
+-- @return #RADIOQUEUE self The RADIOQUEUE object.
+function RADIOQUEUE:SetDigit(digit, filename, duration, path, subtitle, subduration)
+
+  local transmission={} --#RADIOQUEUE.Transmission
+  transmission.filename=filename
+  transmission.duration=duration
+  transmission.path=path or "l10n/DEFAULT/"
+  transmission.subtitle=nil
+  transmission.subduration=nil
+  
+  -- Convert digit to string in case it is given as a number.
+  if type(digit)=="number" then
+    digit=tostring(digit)
+  end
+
+  -- Set transmission.
+  self.numbers[digit]=transmission
+  
+  return self
+end
+
+--- Add a transmission to the radio queue.
+-- @param #RADIOQUEUE self
+-- @param #RADIOQUEUE.Transmission transmission The transmission data table. 
+-- @return #RADIOQUEUE self The RADIOQUEUE object.
+function RADIOQUEUE:AddTransmission(transmission)
+  self:F({transmission=transmission})
+  
+  -- Init.
+  transmission.isplaying=false
+  transmission.Tstarted=nil
+
+  -- Add to queue.
+  table.insert(self.queue, transmission)
+  
+  -- Start checking.
+  if self.schedonce and not self.checking then
+    self:_CheckRadioQueueDelayed()
+  end
+
+  return self
+end
+
+--- Add a transmission to the radio queue.
+-- @param #RADIOQUEUE self
+-- @param #string filename Name of the sound file. Usually an ogg or wav file type.
+-- @param #number duration Duration in seconds the file lasts.
+-- @param #number path Directory path inside the miz file where the sound file is located. Default "l10n/DEFAULT/".
+-- @param #number tstart Start time (abs) seconds. Default now.
+-- @param #number interval Interval in seconds after the last transmission finished.
+-- @param #string subtitle Subtitle of the transmission.
+-- @param #number subduration Duration [sec] of the subtitle being displayed. Default 5 sec.
+-- @return #RADIOQUEUE self The RADIOQUEUE object.
+function RADIOQUEUE:NewTransmission(filename, duration, path, tstart, interval, subtitle, subduration)
+
+  -- Sanity checks.
+  if not filename then
+    self:E(self.lid.."ERROR: No filename specified.")
+    return nil
+  end
+  if type(filename)~="string" then
+    self:E(self.lid.."ERROR: Filename specified is NOT a string.")
+    return nil    
+  end
+
+  if not duration then
+    self:E(self.lid.."ERROR: No duration of transmission specified.")
+    return nil
+  end
+  if type(duration)~="number" then
+    self:E(self.lid.."ERROR: Duration specified is NOT a number.")
+    return nil    
+  end
+  
+
+  local transmission={} --#RADIOQUEUE.Transmission
+  transmission.filename=filename
+  transmission.duration=duration
+  transmission.path=path or "l10n/DEFAULT/"
+  transmission.Tplay=tstart or timer.getAbsTime()
+  transmission.subtitle=subtitle
+  transmission.interval=interval or 0
+  if transmission.subtitle then
+    transmission.subduration=subduration or 5
+  else
+    transmission.subduration=nil
+  end
+  
+  -- Add transmission to queue.  
+  self:AddTransmission(transmission)
+  
+  return self
+end
+
+--- Convert a number (as string) into a radio transmission.
+-- E.g. for board number or headings.
+-- @param #RADIOQUEUE self
+-- @param #string number Number string, e.g. "032" or "183".
+-- @param #number delay Delay before transmission in seconds.
+-- @param #number interval Interval between the next call.
+-- @return #number Duration of the call in seconds.
+function RADIOQUEUE:Number2Transmission(number, delay, interval)
+
+  --- Split string into characters.
+  local function _split(str)
+    local chars={}
+    for i=1,#str do
+      local c=str:sub(i,i)
+      table.insert(chars, c)
+    end
+    return chars
+  end
+  
+  -- Split string into characters.
+  local numbers=_split(number)
+
+  local wait=0    
+  for i=1,#numbers do
+  
+    -- Current number
+    local n=numbers[i]
+        
+    -- Radio call.
+    local transmission=UTILS.DeepCopy(self.numbers[n]) --#RADIOQUEUE.Transmission
+    
+    transmission.Tplay=timer.getAbsTime()+(delay or 0)
+    
+    if interval and i==1 then
+      transmission.interval=interval
+    end
+    
+    self:AddTransmission(transmission)
+    
+    -- Add up duration of the number.
+    wait=wait+transmission.duration
+  end
+  
+  -- Return the total duration of the call.
+  return wait
+end
+
+
+--- Broadcast radio message.
+-- @param #RADIOQUEUE self
+-- @param #RADIOQUEUE.Transmission transmission The transmission.
+function RADIOQUEUE:Broadcast(transmission)
+
+  -- Get unit sending the transmission.
+  local sender=self:_GetRadioSender()
+  
+  -- Construct file name.
+  local filename=string.format("%s%s", transmission.path, transmission.filename)
+  
+  if sender then
+    
+    -- Broadcasting from aircraft. Only players tuned in to the right frequency will see the message.
+    self:T(self.lid..string.format("Broadcasting from aircraft %s", sender:GetName()))
+    
+    
+    if not self.senderinit then
+    
+      -- Command to set the Frequency for the transmission.
+      local commandFrequency={
+        id="SetFrequency",
+        params={
+          frequency=self.frequency,  -- Frequency in Hz.
+          modulation=self.modulation,
+        }}
+          
+      -- Set commend for frequency
+      sender:SetCommand(commandFrequency)
+      
+      self.senderinit=true
+    end
+    
+    -- Command to tranmit the call.
+    local commandTransmit={
+      id = "TransmitMessage",
+      params = {
+        file=filename,
+        duration=transmission.subduration,
+        subtitle=transmission.subtitle or "",
+        loop=false,
+      }}    
+    
+    -- Set command for radio transmission. 
+    sender:SetCommand(commandTransmit)
+    
+    -- Debug message.
+    local text=string.format("file=%s, freq=%.2f MHz, duration=%.2f sec, subtitle=%s", filename, self.frequency/1000000, transmission.duration, transmission.subtitle or "")
+    MESSAGE:New(text, 2, "RADIOQUEUE "..self.alias):ToAllIf(self.Debug)
+      
+  else
+    
+    -- Broadcasting from carrier. No subtitle possible. Need to send messages to players.
+    self:T(self.lid..string.format("Broadcasting via trigger.action.radioTransmission()."))
+  
+    -- Position from where to transmit.
+    local vec3=nil
+    
+    -- Try to get positon from sender unit/static.
+    if self.sendername then
+      local coord=self:_GetRadioSenderCoord()
+      if coord then
+        vec3=coord:GetVec3()
+      end
+    end
+    
+    -- Try to get fixed positon.
+    if self.sendercoord and not vec3 then
+      vec3=self.sendercoord:GetVec3()
+    end
+    
+    -- Transmit via trigger.
+    if vec3 then
+      self:T("Sending")
+      self:T( { filename = filename, vec3 = vec3, modulation = self.modulation, frequency = self.frequency, power = self.power } )
+      
+      -- Trigger transmission.
+      trigger.action.radioTransmission(filename, vec3, self.modulation, false, self.frequency, self.power)
+      
+      -- Debug message.
+      local text=string.format("file=%s, freq=%.2f MHz, duration=%.2f sec, subtitle=%s", filename, self.frequency/1000000, transmission.duration, transmission.subtitle or "")
+      MESSAGE:New(string.format(text, filename, transmission.duration, transmission.subtitle or ""), 5, "RADIOQUEUE "..self.alias):ToAllIf(self.Debug)
+    end
+
+  end
+end
+
+--- Start checking the radio queue.
+-- @param #RADIOQUEUE self
+-- @param #number delay Delay in seconds before checking.
+function RADIOQUEUE:_CheckRadioQueueDelayed(delay)
+  self.checking=true
+  self:ScheduleOnce(delay or self.dt, RADIOQUEUE._CheckRadioQueue, self)
+end
+
+--- Check radio queue for transmissions to be broadcasted.
+-- @param #RADIOQUEUE self
+function RADIOQUEUE:_CheckRadioQueue()
+  --env.info("FF check radio queue "..self.alias)
+
+  -- Check if queue is empty.
+  if #self.queue==0 then
+    -- Queue is now empty. Nothing to else to do.
+    self.checking=false
+    return
+  end
+
+  -- Get current abs time.
+  local time=timer.getAbsTime()
+  
+  local playing=false
+  local next=nil  --#RADIOQUEUE.Transmission
+  local remove=nil
+  for i,_transmission in ipairs(self.queue) do
+    local transmission=_transmission  --#RADIOQUEUE.Transmission
+    
+    -- Check if transmission time has passed.
+    if time>=transmission.Tplay then 
+      
+      -- Check if transmission is currently playing.
+      if transmission.isplaying then
+      
+        -- Check if transmission is finished.
+        if time>=transmission.Tstarted+transmission.duration then
+          
+          -- Transmission over.
+          transmission.isplaying=false
+          
+          -- Remove ith element in queue.
+          remove=i
+          
+          -- Store time last transmission finished.
+          self.Tlast=time
+                    
+        else -- still playing
+        
+          -- Transmission is still playing.
+          playing=true
+          
+        end
+      
+      else -- not playing yet
+      
+        local Tlast=self.Tlast
+      
+        if transmission.interval==nil  then
+      
+          -- Not playing ==> this will be next.
+          if next==nil then
+            next=transmission
+          end
+          
+        else
+        
+          if Tlast==nil or time-Tlast>=transmission.interval then
+            next=transmission            
+          else
+            
+          end
+        end
+        
+        -- We got a transmission or one with an interval that is not due yet. No need for anything else.
+        if next or Tlast then
+          break
+        end
+             
+      end
+      
+    else
+      
+        -- Transmission not due yet.
+      
+    end  
+  end
+  
+  -- Found a new transmission.
+  if next~=nil and not playing then
+    self:Broadcast(next)
+    next.isplaying=true
+    next.Tstarted=time
+  end
+  
+  -- Remove completed calls from queue.
+  if remove then
+    table.remove(self.queue, remove)
+  end
+  
+  -- Check queue.
+  if self.schedonce then
+    self:_CheckRadioQueueDelayed()
+  end
+  
+end
+
+--- Get unit from which we want to transmit a radio message. This has to be an aircraft for subtitles to work.
+-- @param #RADIOQUEUE self
+-- @return Wrapper.Unit#UNIT Sending aircraft unit or nil if was not setup, is not an aircraft or is not alive.
+function RADIOQUEUE:_GetRadioSender()
+
+  -- Check if we have a sending aircraft.
+  local sender=nil  --Wrapper.Unit#UNIT
+
+  -- Try the general default.
+  if self.sendername then
+    -- First try to find a unit 
+    sender=UNIT:FindByName(self.sendername)
+
+    -- Check that sender is alive and an aircraft.
+    if sender and sender:IsAlive() and sender:IsAir() then
+      return sender
+    end
+    
+  end
+    
+  return nil
+end
+
+--- Get unit from which we want to transmit a radio message. This has to be an aircraft for subtitles to work.
+-- @param #RADIOQUEUE self
+-- @return Core.Point#COORDINATE Coordinate of the sender unit.
+function RADIOQUEUE:_GetRadioSenderCoord()
+
+  local vec3=nil
+
+  -- Try the general default.
+  if self.sendername then
+  
+    -- First try to find a unit 
+    local sender=UNIT:FindByName(self.sendername)
+
+    -- Check that sender is alive and an aircraft.
+    if sender and sender:IsAlive() then
+      return sender:GetCoordinate()
+    end
+    
+    -- Now try a static. 
+    local sender=STATIC:FindByName( self.sendername, false )
+
+    -- Check that sender is alive and an aircraft.
+    if sender then
+      return sender:GetCoordinate()
+    end
+    
+  end
+    
+  return nil
+end

Moose Development/Moose/Core/RadioSpeech.lua

@@ -0,0 +1,405 @@
+--- **Core** - Makes the radio talk.
+-- 
+-- ===
+-- 
+-- ## Features:
+-- 
+--   * Send text strings using a vocabulary that is converted in spoken language.
+--   * Possiblity to implement multiple language.
+--
+-- ===
+--
+-- ### Authors: FlightControl
+--
+-- @module Core.RadioSpeech
+-- @image Core_Radio.JPG
+
+--- Makes the radio speak.
+-- 
+-- # RADIOSPEECH usage
+-- 
+--   
+-- @type RADIOSPEECH
+-- @extends Core.RadioQueue#RADIOQUEUE
+RADIOSPEECH = {
+  ClassName = "RADIOSPEECH",
+  Vocabulary = {
+    EN = {},
+    DE = {},
+    RU = {},
+  }
+}
+
+
+RADIOSPEECH.Vocabulary.EN = {
+  ["1"] = { "1", 0.25 },
+  ["2"] = { "2", 0.25 },
+  ["3"] = { "3", 0.30 },
+  ["4"] = { "4", 0.35 },
+  ["5"] = { "5", 0.35 },
+  ["6"] = { "6", 0.42 },
+  ["7"] = { "7", 0.38 },
+  ["8"] = { "8", 0.20 },
+  ["9"] = { "9", 0.32 },
+  ["10"] = { "10", 0.35 },
+  ["11"] = { "11", 0.40 },
+  ["12"] = { "12", 0.42 },
+  ["13"] = { "13", 0.38 },
+  ["14"] = { "14", 0.42 },
+  ["15"] = { "15", 0.42 },
+  ["16"] = { "16", 0.52 },
+  ["17"] = { "17", 0.59 },
+  ["18"] = { "18", 0.40 },
+  ["19"] = { "19", 0.47 },
+  ["20"] = { "20", 0.38 },
+  ["30"] = { "30", 0.29 },
+  ["40"] = { "40", 0.35 },
+  ["50"] = { "50", 0.32 },
+  ["60"] = { "60", 0.44 },
+  ["70"] = { "70", 0.48 },
+  ["80"] = { "80", 0.26 },
+  ["90"] = { "90", 0.36 },
+  ["100"] = { "100", 0.55 },    
+  ["200"] = { "200", 0.55 },    
+  ["300"] = { "300", 0.61 },    
+  ["400"] = { "400", 0.60 },    
+  ["500"] = { "500", 0.61 },    
+  ["600"] = { "600", 0.65 },    
+  ["700"] = { "700", 0.70 },    
+  ["800"] = { "800", 0.54 },    
+  ["900"] = { "900", 0.60 },    
+  ["1000"] = { "1000", 0.60 },    
+  ["2000"] = { "2000", 0.61 },    
+  ["3000"] = { "3000", 0.64 },    
+  ["4000"] = { "4000", 0.62 },    
+  ["5000"] = { "5000", 0.69 },    
+  ["6000"] = { "6000", 0.69 },    
+  ["7000"] = { "7000", 0.75 },    
+  ["8000"] = { "8000", 0.59 },    
+  ["9000"] = { "9000", 0.65 },    
+
+  ["chevy"] = { "chevy", 0.35 },
+  ["colt"] = { "colt", 0.35 },
+  ["springfield"] = { "springfield", 0.65 },
+  ["dodge"] = { "dodge", 0.35 },
+  ["enfield"] = { "enfield", 0.5 },
+  ["ford"] = { "ford", 0.32 },
+  ["pontiac"] = { "pontiac", 0.55 },
+  ["uzi"] = { "uzi", 0.28 },
+
+  ["degrees"] = { "degrees", 0.5 },
+  ["kilometers"] = { "kilometers", 0.65 },
+  ["km"] = { "kilometers", 0.65 },
+  ["miles"] = { "miles", 0.45 },
+  ["meters"] = { "meters", 0.41 },
+  ["mi"] = { "miles", 0.45 },
+  ["feet"] = { "feet", 0.29 },
+  
+  ["br"] = { "br", 1.1 },
+  ["bra"] = { "bra", 0.3 },
+  
+
+  ["returning to base"] = { "returning_to_base", 0.85 },
+  ["on route to ground target"] = { "on_route_to_ground_target", 1.05 },
+  ["intercepting bogeys"] = { "intercepting_bogeys", 1.00 },
+  ["engaging ground target"] = { "engaging_ground_target", 1.20 },
+  ["engaging bogeys"] = { "engaging_bogeys", 0.81 },
+  ["wheels up"] = { "wheels_up", 0.42 },
+  ["landing at base"] = { "landing at base", 0.8 },
+  ["patrolling"] = { "patrolling", 0.55 },
+
+  ["for"] = { "for", 0.31 },
+  ["and"] = { "and", 0.31 },
+  ["at"] = { "at", 0.3 },
+  ["dot"] = { "dot", 0.26 },
+  ["defender"] = { "defender", 0.45 },
+}
+
+RADIOSPEECH.Vocabulary.RU = {
+  ["1"] = { "1", 0.34 },
+  ["2"] = { "2", 0.30 },
+  ["3"] = { "3", 0.23 },
+  ["4"] = { "4", 0.51 },
+  ["5"] = { "5", 0.31 },
+  ["6"] = { "6", 0.44 },
+  ["7"] = { "7", 0.25 },
+  ["8"] = { "8", 0.43 },
+  ["9"] = { "9", 0.45 },
+  ["10"] = { "10", 0.53 },
+  ["11"] = { "11", 0.66 },
+  ["12"] = { "12", 0.70 },
+  ["13"] = { "13", 0.66 },
+  ["14"] = { "14", 0.80 },
+  ["15"] = { "15", 0.65 },
+  ["16"] = { "16", 0.75 },
+  ["17"] = { "17", 0.74 },
+  ["18"] = { "18", 0.85 },
+  ["19"] = { "19", 0.80 },
+  ["20"] = { "20", 0.58 },
+  ["30"] = { "30", 0.51 },
+  ["40"] = { "40", 0.51 },
+  ["50"] = { "50", 0.67 },
+  ["60"] = { "60", 0.76 },
+  ["70"] = { "70", 0.68 },
+  ["80"] = { "80", 0.84 },
+  ["90"] = { "90", 0.71 },
+  ["100"] = { "100", 0.35 },    
+  ["200"] = { "200", 0.59 },    
+  ["300"] = { "300", 0.53 },    
+  ["400"] = { "400", 0.70 },    
+  ["500"] = { "500", 0.50 },    
+  ["600"] = { "600", 0.58 },    
+  ["700"] = { "700", 0.64 },    
+  ["800"] = { "800", 0.77 },    
+  ["900"] = { "900", 0.75 },    
+  ["1000"] = { "1000", 0.87 },    
+  ["2000"] = { "2000", 0.83 },    
+  ["3000"] = { "3000", 0.84 },    
+  ["4000"] = { "4000", 1.00 },    
+  ["5000"] = { "5000", 0.77 },    
+  ["6000"] = { "6000", 0.90 },    
+  ["7000"] = { "7000", 0.77 },    
+  ["8000"] = { "8000", 0.92 },    
+  ["9000"] = { "9000", 0.87 },    
+
+  ["степени"] = { "degrees", 0.5 },
+  ["километров"] = { "kilometers", 0.65 },
+  ["km"] = { "kilometers", 0.65 },
+  ["миль"] = { "miles", 0.45 },
+  ["mi"] = { "miles", 0.45 },
+  ["метры"] = { "meters", 0.41 },
+  ["m"] = { "meters", 0.41 },
+  ["ноги"] = { "feet", 0.37 },
+  
+  ["br"] = { "br", 1.1 },
+  ["bra"] = { "bra", 0.3 },
+  
+
+  ["возвращаясь на базу"] = { "returning_to_base", 1.40 },
+  ["на пути к наземной цели"] = { "on_route_to_ground_target", 1.45 },
+  ["перехват самолетов"] = { "intercepting_bogeys", 1.22 },
+  ["поражение наземной цели"] = { "engaging_ground_target", 1.53 },
+  ["захватывающие самолеты"] = { "engaging_bogeys", 1.68 },
+  ["колеса вверх"] = { "wheels_up", 0.92 },
+  ["посадка на базу"] = { "landing at base", 1.04 },
+  ["патрулирующий"] = { "patrolling", 0.96 },
+
+  ["за"] = { "for", 0.27 },
+  ["и"] = { "and", 0.17 },
+  ["в"] = { "at", 0.19 },
+  ["dot"] = { "dot", 0.51 },
+  ["defender"] = { "defender", 0.45 },
+}
+
+--- Create a new RADIOSPEECH object for a given radio frequency/modulation.
+-- @param #RADIOSPEECH self
+-- @param #number frequency The radio frequency in MHz.
+-- @param #number modulation (Optional) The radio modulation. Default radio.modulation.AM.
+-- @return #RADIOSPEECH self The RADIOSPEECH object.
+function RADIOSPEECH:New(frequency, modulation)
+
+  -- Inherit base
+  local self = BASE:Inherit( self, RADIOQUEUE:New( frequency, modulation ) ) -- #RADIOSPEECH
+  
+  self.Language = "EN"
+  
+  self:BuildTree()
+  
+  return self
+end
+
+function RADIOSPEECH:SetLanguage( Langauge )
+
+  self.Language = Langauge
+end
+
+
+--- Add Sentence to the Speech collection.
+-- @param #RADIOSPEECH self
+-- @param #string RemainingSentence The remaining sentence during recursion.
+-- @param #table Speech The speech node.
+-- @param #string Sentence The full sentence.
+-- @param #string Data The speech data.
+-- @return #RADIOSPEECH self The RADIOSPEECH object.
+function RADIOSPEECH:AddSentenceToSpeech( RemainingSentence, Speech, Sentence, Data )
+
+  self:I( { RemainingSentence, Speech, Sentence, Data } )
+
+  local Token, RemainingSentence = RemainingSentence:match( "^ *([^ ]+)(.*)" )
+  self:I( { Token = Token, RemainingSentence = RemainingSentence } )
+
+  -- Is there a Token?
+  if Token then
+
+    -- We check if the Token is already in the Speech collection.
+    if not Speech[Token] then
+
+      -- There is not yet a vocabulary registered for this.
+      Speech[Token] = {}
+
+      if RemainingSentence and RemainingSentence ~= "" then
+        -- We use recursion to iterate through the complete Sentence, and make a chain of Tokens.
+        -- The last Speech node in the collection contains the Sentence and the Data to be spoken.
+        -- This to ensure that during the actual speech:
+        -- - Complete sentences are being understood.
+        -- - Words without speech are ignored.
+        -- - Incorrect sequence of words are ignored.
+        Speech[Token].Next = {}
+        self:AddSentenceToSpeech( RemainingSentence, Speech[Token].Next, Sentence, Data )
+      else
+        -- There is no remaining sentence, so we add speech to the Sentence.
+        -- The recursion stops here.
+        Speech[Token].Sentence = Sentence
+        Speech[Token].Data = Data
+      end
+    end
+  end
+end
+
+--- Build the tree structure based on the language words, in order to find the correct sentences and to ignore incomprehensible words.
+-- @param #RADIOSPEECH self
+-- @return #RADIOSPEECH self The RADIOSPEECH object.
+function RADIOSPEECH:BuildTree()
+
+  self.Speech = {}
+  
+  for Language, Sentences in pairs( self.Vocabulary ) do
+    self:I( { Language = Language, Sentences = Sentences })
+    self.Speech[Language] = {}
+    for Sentence, Data in pairs( Sentences ) do
+      self:I( { Sentence = Sentence, Data = Data } )
+      self:AddSentenceToSpeech( Sentence, self.Speech[Language], Sentence, Data )
+    end
+  end
+  
+  self:I( { Speech = self.Speech } )
+
+  return self
+end
+
+--- Speak a sentence.
+-- @param #RADIOSPEECH self
+-- @param #string Sentence The sentence to be spoken.
+function RADIOSPEECH:SpeakWords( Sentence, Speech, Language )
+
+  local OriginalSentence = Sentence
+
+  -- lua does not parse UTF-8, so the match statement will fail on cyrillic using %a.
+  -- therefore, the only way to parse the statement is to use blank, comma or dot as a delimiter.
+  -- and then check if the character can be converted to a number or not.
+  local Word, RemainderSentence = Sentence:match( "^[., ]*([^ .,]+)(.*)" )
+
+  self:I( { Word = Word, Speech = Speech[Word], RemainderSentence = RemainderSentence } )
+  
+
+  if Word then
+    if Word ~= "" and tonumber(Word) == nil then
+
+      -- Construct of words
+      Word = Word:lower()
+      if Speech[Word] then
+        -- The end of the sentence has been reached. Now Speech.Next should be nil, otherwise there is an error.
+        if Speech[Word].Next == nil then
+          self:I( { Sentence = Speech[Word].Sentence, Data = Speech[Word].Data } )
+          self:NewTransmission( Speech[Word].Data[1] .. ".wav", Speech[Word].Data[2], Language .. "/" )
+        else 
+          if RemainderSentence and RemainderSentence ~= "" then
+            return self:SpeakWords( RemainderSentence, Speech[Word].Next, Language )
+          end
+        end
+      end
+      return RemainderSentence
+    end
+    return OriginalSentence  
+  else
+    return ""
+  end        
+  
+end
+
+--- Speak a sentence.
+-- @param #RADIOSPEECH self
+-- @param #string Sentence The sentence to be spoken.
+function RADIOSPEECH:SpeakDigits( Sentence, Speech, Langauge )
+
+  local OriginalSentence = Sentence
+
+  -- lua does not parse UTF-8, so the match statement will fail on cyrillic using %a.
+  -- therefore, the only way to parse the statement is to use blank, comma or dot as a delimiter.
+  -- and then check if the character can be converted to a number or not.
+  local Digits, RemainderSentence = Sentence:match( "^[., ]*([^ .,]+)(.*)" )
+
+  self:I( { Digits = Digits, Speech = Speech[Digits], RemainderSentence = RemainderSentence } )
+
+  if Digits then
+    if Digits ~= "" and tonumber( Digits ) ~= nil then
+    
+      -- Construct numbers
+      local Number = tonumber( Digits )
+      local Multiple = nil
+      while Number >= 0 do
+        if Number > 1000 then
+          Multiple = math.floor( Number / 1000 ) * 1000
+        elseif Number > 100 then
+          Multiple = math.floor( Number / 100 ) * 100
+        elseif Number > 20 then
+          Multiple = math.floor( Number / 10 ) * 10
+        elseif Number >= 0 then
+          Multiple = Number
+        end
+        Sentence = tostring( Multiple )
+        if Speech[Sentence] then
+          self:I( { Speech = Speech[Sentence].Sentence, Data = Speech[Sentence].Data } )
+          self:NewTransmission( Speech[Sentence].Data[1] .. ".wav", Speech[Sentence].Data[2], Langauge .. "/" )
+        end
+        Number = Number - Multiple
+        Number = ( Number == 0 ) and -1 or Number
+      end
+      return RemainderSentence
+    end
+    return OriginalSentence  
+  else
+    return ""
+  end
+
+end
+
+
+
+--- Speak a sentence.
+-- @param #RADIOSPEECH self
+-- @param #string Sentence The sentence to be spoken.
+function RADIOSPEECH:Speak( Sentence, Language )
+
+  self:I( { Sentence, Language } )
+
+  local Language = Language or "EN"
+  
+  self:I( { Language = Language } )
+  
+  -- If there is no node for Speech, then we start at the first nodes of the language.
+  local Speech = self.Speech[Language]
+  
+  self:I( { Speech = Speech, Language = Language } )
+  
+  self:NewTransmission( "_In.wav", 0.52, Language .. "/" )
+  
+  repeat
+
+    Sentence = self:SpeakWords( Sentence, Speech, Language )
+    
+    self:I( { Sentence = Sentence } )
+
+    Sentence = self:SpeakDigits( Sentence, Speech, Language )
+
+    self:I( { Sentence = Sentence } )
+    
+--    Sentence = self:SpeakSymbols( Sentence, Speech )
+--
+--    self:I( { Sentence = Sentence } )
+
+  until not Sentence or Sentence == ""
+
+  self:NewTransmission( "_Out.wav", 0.28, Language .. "/" )
+
+end

Moose Development/Moose/Core/Report.lua

@@ -1,20 +1,26 @@
---- **Core** -- **REPORT** class provides a handy means to create messages and reports.
+--- **Core** - Provides a handy means to create messages and reports.
 --
 -- ===
+-- 
+-- ## Features:
+-- 
+--   * Create text blocks that are formatted.
+--   * Create automatic indents.
+--   * Variate the delimiters between reporting lines.
+-- 
+-- ===
 --
--- ### Authors:
---
---   * FlightControl : Design & Programming
---
--- ### Contributions:
+-- ### Authors: FlightControl : Design & Programming
 --
 -- @module Core.Report
 -- @image Core_Report.JPG
 
 
---- The REPORT class
--- @type REPORT
+--- @type REPORT
 -- @extends Core.Base#BASE
+
+--- Provides a handy means to create messages and reports.
+-- @field #REPORT
 REPORT = {
   ClassName = "REPORT",
   Title = "",
@@ -64,11 +70,12 @@ function REPORT:Add( Text )
   return self
 end
 
---- Add a new line to a REPORT.
+--- Add a new line to a REPORT, but indented. A separator character can be specified to separate the reported lines visually.
 -- @param #REPORT self
--- @param #string Text
+-- @param #string Text The report text.
+-- @param #string Separator (optional) The start of each report line can begin with an optional separator character. This can be a "-", or "#", or "*". You're free to choose what you find the best.
 -- @return #REPORT
-function REPORT:AddIndent( Text, Separator ) --R2.1
+function REPORT:AddIndent( Text, Separator )
   self.Report[#self.Report+1] = ( ( Separator and Separator .. string.rep( " ", self.Indent - 1 ) ) or string.rep(" ", self.Indent ) ) .. Text:gsub("\n","\n"..string.rep( " ", self.Indent ) )
   return self
 end

Moose Development/Moose/Core/ScheduleDispatcher.lua

@@ -52,8 +52,8 @@ end
 -- Nothing of this code should be modified without testing it thoroughly.
 -- @param #SCHEDULEDISPATCHER self
 -- @param Core.Scheduler#SCHEDULER Scheduler
-function SCHEDULEDISPATCHER:AddSchedule( Scheduler, ScheduleFunction, ScheduleArguments, Start, Repeat, Randomize, Stop )
-  self:F2( { Scheduler, ScheduleFunction, ScheduleArguments, Start, Repeat, Randomize, Stop } )
+function SCHEDULEDISPATCHER:AddSchedule( Scheduler, ScheduleFunction, ScheduleArguments, Start, Repeat, Randomize, Stop, TraceLevel, Fsm )
+  self:F2( { Scheduler, ScheduleFunction, ScheduleArguments, Start, Repeat, Randomize, Stop, TraceLevel } )
 
   self.CallID = self.CallID + 1
   local CallID = self.CallID .. "#" .. ( Scheduler.MasterObject and Scheduler.MasterObject.GetClassNameAndID and Scheduler.MasterObject:GetClassNameAndID() or "" ) or ""
@@ -84,11 +84,52 @@ function SCHEDULEDISPATCHER:AddSchedule( Scheduler, ScheduleFunction, ScheduleAr
   self.Schedule[Scheduler][CallID].Repeat = Repeat or 0
   self.Schedule[Scheduler][CallID].Randomize = Randomize or 0
   self.Schedule[Scheduler][CallID].Stop = Stop
+  
+  
+  -- This section handles the tracing of the scheduled calls.
+  -- Because these calls will be executed with a delay, we inspect the place where these scheduled calls are initiated.
+  -- The Info structure contains the output of the debug.getinfo() calls, which inspects the call stack for the function name, line number and source name.
+  -- The call stack has many levels, and the correct semantical function call depends on where in the code AddSchedule was "used".
+  --   - Using SCHEDULER:New()
+  --   - Using Schedule:AddSchedule()
+  --   - Using Fsm:__Func()
+  --   - Using Class:ScheduleOnce()
+  --   - Using Class:ScheduleRepeat()
+  --   - ...
+  -- So for each of these scheduled call variations, AddSchedule is the workhorse which will schedule the call.
+  -- But the correct level with the correct semantical function location will differ depending on the above scheduled call invocation forms.
+  -- That's where the field TraceLevel contains optionally the level in the call stack where the call information is obtained.
+  -- The TraceLevel field indicates the correct level where the semantical scheduled call was invoked within the source, ensuring that function name, line number and source name are correct.
+  -- There is one quick ...
+  -- The FSM class models scheduled calls using the __Func syntax. However, these functions are "tailed".
+  -- There aren't defined anywhere within the source code, but rather implemented as triggers within the FSM logic, 
+  -- and using the onbefore, onafter, onenter, onleave prefixes. (See the FSM for details).
+  -- Therefore, in the call stack, at the TraceLevel these functions are mentioned as "tail calls", and the Info.name field will be nil as a result.
+  -- To obtain the correct function name for FSM object calls, the function is mentioned in the call stack at a higher stack level.
+  -- So when function name stored in Info.name is nil, then I inspect the function name within the call stack one level higher.
+  -- So this little piece of code does its magic wonderfully, preformance overhead is neglectible, as scheduled calls don't happen that often.
+
+  local Info = {}
+  
+  if debug then
+    TraceLevel = TraceLevel or 2
+    Info = debug.getinfo( TraceLevel, "nlS" )
+    local name_fsm = debug.getinfo( TraceLevel - 1, "n" ).name -- #string
+    if name_fsm then
+      Info.name = name_fsm
+    end
+    --env.info( debug.traceback() )
+  end
 
   self:T3( self.Schedule[Scheduler][CallID] )
 
-  self.Schedule[Scheduler][CallID].CallHandler = function( CallID )
-    --self:E( CallID )
+  self.Schedule[Scheduler][CallID].CallHandler = function( Params )
+    
+    local CallID = Params.CallID
+    local Info = Params.Info
+    local Source = Info.source or "?"
+    local Line = Info.currentline or "?"
+    local Name = Info.name or "?"
 
     local ErrorHandler = function( errmsg )
       env.info( "Error in timer function: " .. errmsg )
@@ -121,16 +162,25 @@ function SCHEDULEDISPATCHER:AddSchedule( Scheduler, ScheduleFunction, ScheduleAr
       local Randomize = Schedule.Randomize or 0
       local Stop = Schedule.Stop or 0
       local ScheduleID = Schedule.ScheduleID
+      local ShowTrace = Scheduler.ShowTrace
+      
+      local Prefix = ( Repeat == 0 ) and "--->" or "+++>"
       
       local Status, Result
       --self:E( { SchedulerObject = SchedulerObject } )
       if SchedulerObject then
         local function Timer()
+          if ShowTrace then
+            SchedulerObject:T( Prefix .. Name .. ":" .. Line .. " (" .. Source .. ")" )
+          end
           return ScheduleFunction( SchedulerObject, unpack( ScheduleArguments ) ) 
         end
         Status, Result = xpcall( Timer, ErrorHandler )
       else
         local function Timer()
+          if ShowTrace then
+            self:T( Prefix .. Name .. ":" .. Line .. " (" .. Source .. ")" )
+          end
           return ScheduleFunction( unpack( ScheduleArguments ) ) 
         end
         Status, Result = xpcall( Timer, ErrorHandler )
@@ -161,13 +211,13 @@ function SCHEDULEDISPATCHER:AddSchedule( Scheduler, ScheduleFunction, ScheduleAr
         self:Stop( Scheduler, CallID )
       end
     else
-      self:E( "Scheduled obsolete call for CallID: " .. CallID )
+      self:I( "<<<>" .. Name .. ":" .. Line .. " (" .. Source .. ")" )
     end
     
     return nil
   end
   
-  self:Start( Scheduler, CallID )
+  self:Start( Scheduler, CallID, Info )
   
   return CallID
 end
@@ -181,7 +231,7 @@ function SCHEDULEDISPATCHER:RemoveSchedule( Scheduler, CallID )
   end
 end
 
-function SCHEDULEDISPATCHER:Start( Scheduler, CallID )
+function SCHEDULEDISPATCHER:Start( Scheduler, CallID, Info )
   self:F2( { Start = CallID, Scheduler = Scheduler } )
 
   if CallID then
@@ -192,13 +242,13 @@ function SCHEDULEDISPATCHER:Start( Scheduler, CallID )
       Schedule[CallID].StartTime = timer.getTime()  -- Set the StartTime field to indicate when the scheduler started.
       Schedule[CallID].ScheduleID = timer.scheduleFunction( 
         Schedule[CallID].CallHandler, 
-        CallID, 
+        { CallID = CallID, Info = Info }, 
         timer.getTime() + Schedule[CallID].Start 
       )
     end
   else
     for CallID, Schedule in pairs( self.Schedule[Scheduler] or {} ) do
-      self:Start( Scheduler, CallID ) -- Recursive
+      self:Start( Scheduler, CallID, Info ) -- Recursive
     end
   end
 end
@@ -229,5 +279,9 @@ function SCHEDULEDISPATCHER:Clear( Scheduler )
   end
 end
 
+function SCHEDULEDISPATCHER:NoTrace( Scheduler )
+  self:F2( { Scheduler = Scheduler } )
 
+  Scheduler.ShowTrace = nil
+end
 

Moose Development/Moose/Core/Scheduler.lua

@@ -1,13 +1,14 @@
---- **Core** -- SCHEDULER prepares and handles the **execution of functions over scheduled time (intervals)**.
+--- **Core** - Prepares and handles the execution of functions over scheduled time (intervals).
 --
 -- ===
 -- 
--- SCHEDULER manages the **scheduling of functions**:
+-- ## Features:
 -- 
---    * optionally in an optional specified time interval, 
---    * optionally **repeating** with a specified time repeat interval, 
---    * optionally **randomizing** with a specified time interval randomization factor, 
---    * optionally **stop** the repeating after a specified time interval. 
+--   * Schedule functions over time,
+--   * optionally in an optional specified time interval, 
+--   * optionally **repeating** with a specified time repeat interval, 
+--   * optionally **randomizing** with a specified time interval randomization factor, 
+--   * optionally **stop** the repeating after a specified time interval. 
 --
 -- ===
 -- 
@@ -213,9 +214,10 @@ function SCHEDULER:New( SchedulerObject, SchedulerFunction, SchedulerArguments,
   local ScheduleID = nil
   
   self.MasterObject = SchedulerObject
+  self.ShowTrace = true
   
   if SchedulerFunction then
-    ScheduleID = self:Schedule( SchedulerObject, SchedulerFunction, SchedulerArguments, Start, Repeat, RandomizeFactor, Stop )
+    ScheduleID = self:Schedule( SchedulerObject, SchedulerFunction, SchedulerArguments, Start, Repeat, RandomizeFactor, Stop, 4 )
   end
 
   return self, ScheduleID
@@ -237,7 +239,7 @@ end
 -- @param #number RandomizeFactor Specifies a randomization factor between 0 and 1 to randomize the Repeat.
 -- @param #number Stop Specifies the amount of seconds when the scheduler will be stopped.
 -- @return #number The ScheduleID of the planned schedule.
-function SCHEDULER:Schedule( SchedulerObject, SchedulerFunction, SchedulerArguments, Start, Repeat, RandomizeFactor, Stop )
+function SCHEDULER:Schedule( SchedulerObject, SchedulerFunction, SchedulerArguments, Start, Repeat, RandomizeFactor, Stop, TraceLevel, Fsm )
   self:F2( { Start, Repeat, RandomizeFactor, Stop } )
   self:T3( { SchedulerArguments } )
 
@@ -255,7 +257,9 @@ function SCHEDULER:Schedule( SchedulerObject, SchedulerFunction, SchedulerArgume
     Start,
     Repeat,
     RandomizeFactor,
-    Stop
+    Stop,
+    TraceLevel or 3,
+    Fsm
   )
   
   self.Schedules[#self.Schedules+1] = ScheduleID
@@ -298,6 +302,14 @@ function SCHEDULER:Clear()
   _SCHEDULEDISPATCHER:Clear( self )
 end
 
+--- No tracing for this scheduler.
+-- @param #SCHEDULER self
+-- @param #number ScheduleID (optional) The ScheduleID of the planned (repeating) schedule.
+function SCHEDULER:NoTrace()
+
+  _SCHEDULEDISPATCHER:NoTrace( self )
+end
+
 
 
 

Moose Development/Moose/Core/Settings.lua

@@ -1,7 +1,19 @@
---- **Core** -- Manages various settings for MOOSE classes.
+--- **Core** - Manages various settings for running missions, consumed by moose classes and provides a menu system for players to tweak settings in running missions.
 --
 -- ===
 -- 
+-- ## Features:
+-- 
+--   * Provide a settings menu system to the players.
+--   * Provide a player settings menu and an overall mission settings menu.
+--   * Mission settings provide default settings, while player settings override mission settings.
+--   * Provide a menu to select between different coordinate formats for A2G coordinates.
+--   * Provide a menu to select between different coordinate formats for A2A coordinates.
+--   * Provide a menu to select between different message time duration options.
+--   * Provide a menu to select between different metric systems.
+-- 
+-- ===
+-- 
 -- The documentation of the SETTINGS class can be found further in this document.
 -- 
 -- ===
@@ -181,7 +193,20 @@
 -- 
 --   - @{#SETTINGS.SetMessageTime}(): Define for a specific @{Message.MESSAGE.MessageType} the duration to be displayed in seconds. 
 --   - @{#SETTINGS.GetMessageTime}(): Retrieves for a specific @{Message.MESSAGE.MessageType} the duration to be displayed in seconds. 
---   
+-- 
+-- ## 3.5) **Era** of the battle
+-- 
+-- The threat level metric is scaled according the era of the battle. A target that is AAA, will pose a much greather threat in WWII than on modern warfare.
+-- Therefore, there are 4 era that are defined within the settings:
+-- 
+--   - **WWII** era: Use for warfare with equipment during the world war II time.
+--   - **Korea** era: Use for warfare with equipment during the Korea war time.
+--   - **Cold War** era: Use for warfare with equipment during the cold war time. 
+--   - **Modern** era: Use for warfare with modern equipment in the 2000s.
+-- 
+-- There are different API defined that you can use with the _SETTINGS object to configure your mission script to work in one of the 4 era: 
+-- @{#SETTINGS.SetEraWWII}(), @{#SETTINGS.SetEraKorea}(), @{#SETTINGS.SetEraCold}(), @{#SETTINGS.SetEraModern}()
+-- 
 -- ===
 -- 
 -- @field #SETTINGS
@@ -190,6 +215,19 @@ SETTINGS = {
   ShowPlayerMenu = true,
 }
 
+SETTINGS.__Enum = {}
+
+--- @type SETTINGS.__Enum.Era
+-- @field #number WWII
+-- @field #number Korea
+-- @field #number Cold
+-- @field #number Modern
+SETTINGS.__Enum.Era = {
+  WWII = 1,
+  Korea = 2,
+  Cold = 3,
+  Modern = 4,
+}
 
 
 do -- SETTINGS
@@ -211,6 +249,7 @@ do -- SETTINGS
       self:SetMessageTime( MESSAGE.Type.Information, 30 )
       self:SetMessageTime( MESSAGE.Type.Overview, 60 )
       self:SetMessageTime( MESSAGE.Type.Update, 15 )
+      self:SetEraModern()
       return self
     else
       local Settings = _DATABASE:GetPlayerSettings( PlayerName )
@@ -364,7 +403,6 @@ do -- SETTINGS
   -- @param #SETTINGS self
   -- @return #boolean true if BRA
   function SETTINGS:IsA2A_BRAA()
-    self:E( { BRA = ( self.A2ASystem and self.A2ASystem == "BRAA" ) or ( not self.A2ASystem and _SETTINGS:IsA2A_BRAA() ) } )
     return ( self.A2ASystem and self.A2ASystem == "BRAA" ) or ( not self.A2ASystem and _SETTINGS:IsA2A_BRAA() )
   end
 
@@ -827,6 +865,47 @@ do -- SETTINGS
     end
   
   end
+  
+  --- Configures the era of the mission to be WWII.
+  -- @param #SETTINGS self
+  -- @return #SETTINGS self
+  function SETTINGS:SetEraWWII()
+  
+    self.Era = SETTINGS.__Enum.Era.WWII
+  
+  end
+  
+  --- Configures the era of the mission to be Korea.
+  -- @param #SETTINGS self
+  -- @return #SETTINGS self
+  function SETTINGS:SetEraKorea()
+  
+    self.Era = SETTINGS.__Enum.Era.Korea
+  
+  end
+  
+  
+  --- Configures the era of the mission to be Cold war.
+  -- @param #SETTINGS self
+  -- @return #SETTINGS self
+  function SETTINGS:SetEraCold()
+  
+    self.Era = SETTINGS.__Enum.Era.Cold
+  
+  end
+  
+
+  --- Configures the era of the mission to be Modern war.
+  -- @param #SETTINGS self
+  -- @return #SETTINGS self
+  function SETTINGS:SetEraModern()
+  
+    self.Era = SETTINGS.__Enum.Era.Modern
+  
+  end
+  
+  
+  
 
 end
 

Moose Development/Moose/Core/SpawnStatic.lua

@@ -1,8 +1,14 @@
---- **Core** -- Spawn dynamically new STATICs in your missions.
+--- **Core** - Spawn new statics in your running missions.
 --  
 -- ===
 -- 
--- SPAWNSTATIC spawns static structures in your missions dynamically. See below the SPAWNSTATIC class documentation.
+-- ## Features:
+-- 
+--   * Spawn new statics from a static already defined using the mission editor.
+--   * Spawn new statics from a given template.
+--   * Spawn new statics from a given type.
+--   * Spawn with a custom heading and location.
+--   * Spawn within a zone.
 -- 
 -- ===
 -- 
@@ -77,20 +83,22 @@ SPAWNSTATIC = {
 --- Creates the main object to spawn a @{Static} defined in the ME.
 -- @param #SPAWNSTATIC self
 -- @param #string SpawnTemplatePrefix is the name of the Group in the ME that defines the Template.  Each new group will have the name starting with SpawnTemplatePrefix.
+-- @param DCS#country.id SpawnCountryID The ID of the country.
+-- @param DCS#coalition.side SpawnCoalitionID The ID of the coalition.
 -- @return #SPAWNSTATIC
-function SPAWNSTATIC:NewFromStatic( SpawnTemplatePrefix, SpawnCountryID ) --R2.1
+function SPAWNSTATIC:NewFromStatic( SpawnTemplatePrefix, SpawnCountryID, SpawnCoalitionID )
 	local self = BASE:Inherit( self, BASE:New() ) -- #SPAWNSTATIC
 	self:F( { SpawnTemplatePrefix } )
   
-	local TemplateStatic, CoalitionID, CategoryID, CountryID = _DATABASE:GetStaticUnitTemplate( SpawnTemplatePrefix )
+	local TemplateStatic, CoalitionID, CategoryID, CountryID = _DATABASE:GetStaticGroupTemplate( SpawnTemplatePrefix )
 	if TemplateStatic then
 		self.SpawnTemplatePrefix = SpawnTemplatePrefix
 		self.CountryID = SpawnCountryID or CountryID
 		self.CategoryID = CategoryID
-		self.CoalitionID = CoalitionID
+		self.CoalitionID = SpawnCoalitionID or CoalitionID
 		self.SpawnIndex = 0
 	else
-		error( "SPAWNSTATIC:New: There is no group declared in the mission editor with SpawnTemplatePrefix = '" .. SpawnTemplatePrefix .. "'" )
+		error( "SPAWNSTATIC:New: There is no static declared in the mission editor with SpawnTemplatePrefix = '" .. SpawnTemplatePrefix .. "'" )
 	end
 
   self:SetEventPriority( 5 )
@@ -102,12 +110,13 @@ end
 -- @param #SPAWNSTATIC self
 -- @param #string SpawnTypeName is the name of the type.
 -- @return #SPAWNSTATIC
-function SPAWNSTATIC:NewFromType( SpawnTypeName, SpawnShapeName, SpawnCategory, CountryID ) --R2.1
+function SPAWNSTATIC:NewFromType( SpawnTypeName, SpawnShapeName, SpawnCategory, SpawnCountryID, SpawnCoalitionID ) 
   local self = BASE:Inherit( self, BASE:New() ) -- #SPAWNSTATIC
   self:F( { SpawnTypeName } )
   
   self.SpawnTypeName = SpawnTypeName
-  self.CountryID = CountryID
+  self.CountryID = SpawnCountryID
+  self.CoalitionID = SpawnCoalitionID
   self.SpawnIndex = 0
 
   self:SetEventPriority( 5 )
@@ -124,32 +133,28 @@ end
 function SPAWNSTATIC:Spawn( Heading, NewName ) --R2.3
   self:F( { Heading, NewName  } )
   
-  local StaticTemplate = _DATABASE:GetStaticUnitTemplate( self.SpawnTemplatePrefix )
+  local StaticTemplate, CoalitionID, CategoryID, CountryID = _DATABASE:GetStaticGroupTemplate( self.SpawnTemplatePrefix )
   
   if StaticTemplate then
   
-    local CountryID = self.CountryID
-    local CountryName = _DATABASE.COUNTRY_NAME[CountryID]
+    local StaticUnitTemplate = StaticTemplate.units[1]
   
     StaticTemplate.name = NewName or string.format("%s#%05d", self.SpawnTemplatePrefix, self.SpawnIndex )
     StaticTemplate.heading = ( Heading / 180 ) * math.pi
     
-    StaticTemplate.CountryID = nil
-    StaticTemplate.CoalitionID = nil
-    StaticTemplate.CategoryID = nil
-    
-    local Static = coalition.addStaticObject( CountryID, StaticTemplate )
+    _DATABASE:_RegisterStaticTemplate( StaticTemplate, CoalitionID, CategoryID, CountryID )
+
+    local Static = coalition.addStaticObject( self.CountryID or CountryID, StaticTemplate.units[1] )
     
     self.SpawnIndex = self.SpawnIndex + 1
   
-    return Static
+    return _DATABASE:FindStatic(Static:getName())
   end
   
   return nil
 end
 
 
-
 --- Creates a new @{Static} from a POINT_VEC2.
 -- @param #SPAWNSTATIC self
 -- @param Core.Point#POINT_VEC2 PointVec2 The 2D coordinate where to spawn the static.
@@ -159,64 +164,96 @@ end
 function SPAWNSTATIC:SpawnFromPointVec2( PointVec2, Heading, NewName ) --R2.1
   self:F( { PointVec2, Heading, NewName  } )
   
-  local StaticTemplate = _DATABASE:GetStaticUnitTemplate( self.SpawnTemplatePrefix )
+  local StaticTemplate, CoalitionID, CategoryID, CountryID = _DATABASE:GetStaticGroupTemplate( self.SpawnTemplatePrefix )
   
   if StaticTemplate then
-
-    local CountryID = self.CountryID
-    local CountryName = _DATABASE.COUNTRY_NAME[CountryID]
-    
-    StaticTemplate.x = PointVec2.x
-    StaticTemplate.y = PointVec2.z
   
-    StaticTemplate.units = nil
+    local StaticUnitTemplate = StaticTemplate.units[1]
+  
+    StaticUnitTemplate.x = PointVec2.x
+    StaticUnitTemplate.y = PointVec2.z
+  
     StaticTemplate.route = nil
     StaticTemplate.groupId = nil
     
     StaticTemplate.name = NewName or string.format("%s#%05d", self.SpawnTemplatePrefix, self.SpawnIndex )
-    StaticTemplate.heading = ( Heading / 180 ) * math.pi
+    StaticUnitTemplate.name = StaticTemplate.name
+    StaticUnitTemplate.heading = ( Heading / 180 ) * math.pi
     
-    StaticTemplate.CountryID = nil
-    StaticTemplate.CoalitionID = nil
-    StaticTemplate.CategoryID = nil
+    _DATABASE:_RegisterStaticTemplate( StaticTemplate, CoalitionID, CategoryID, CountryID)
     
-    local Static = coalition.addStaticObject( CountryID, StaticTemplate )
+    self:F({StaticTemplate = StaticTemplate})
+
+    local Static = coalition.addStaticObject( self.CountryID or CountryID, StaticTemplate.units[1] )
     
     self.SpawnIndex = self.SpawnIndex + 1
-  
-    return Static
+    
+    return _DATABASE:FindStatic(Static:getName())
   end
   
   return nil
 end
 
 
---- Creates the original @{Static} at a POINT_VEC2.
+--- Creates a new @{Static} from a COORDINATE.
 -- @param #SPAWNSTATIC self
--- @param Core.Point#POINT_VEC2 PointVec2 The 2D coordinate where to spawn the static.
--- @param #number Heading The heading of the static, which is a number in degrees from 0 to 360.
--- @param #string (optional) The name of the new static.
+-- @param Core.Point#COORDINATE Coordinate The 3D coordinate where to spawn the static.
+-- @param #number Heading (Optional) Heading The heading of the static, which is a number in degrees from 0 to 360. Default is 0 degrees.
+-- @param #string NewName (Optional) The name of the new static.
 -- @return #SPAWNSTATIC
-function SPAWNSTATIC:ReSpawn()
+function SPAWNSTATIC:SpawnFromCoordinate(Coordinate, Heading, NewName) --R2.4
+  self:F( { PointVec2, Heading, NewName  } )
   
-  local StaticTemplate = _DATABASE:GetStaticUnitTemplate( self.SpawnTemplatePrefix )
+  local StaticTemplate, CoalitionID, CategoryID, CountryID = _DATABASE:GetStaticGroupTemplate( self.SpawnTemplatePrefix )
   
   if StaticTemplate then
-
-    local CountryID = self.CountryID
-    local CountryName = _DATABASE.COUNTRY_NAME[CountryID]
-    
-    StaticTemplate.units = nil
+  
+    Heading=Heading or 0
+  
+    local StaticUnitTemplate = StaticTemplate.units[1]
+  
+    StaticUnitTemplate.x   = Coordinate.x    
+    StaticUnitTemplate.y   = Coordinate.z
+    StaticUnitTemplate.alt = Coordinate.y
+  
     StaticTemplate.route = nil
     StaticTemplate.groupId = nil
     
-    StaticTemplate.CountryID = nil
-    StaticTemplate.CoalitionID = nil
-    StaticTemplate.CategoryID = nil
+    StaticTemplate.name = NewName or string.format("%s#%05d", self.SpawnTemplatePrefix, self.SpawnIndex )
+    StaticUnitTemplate.name = StaticTemplate.name
+    StaticUnitTemplate.heading = ( Heading / 180 ) * math.pi
     
-    local Static = coalition.addStaticObject( CountryID, StaticTemplate )
+    _DATABASE:_RegisterStaticTemplate( StaticTemplate, CoalitionID, CategoryID, CountryID)
     
-    return Static
+    self:F({StaticTemplate = StaticTemplate})
+
+    local Static = coalition.addStaticObject( self.CountryID or CountryID, StaticTemplate.units[1] )
+    
+    self.SpawnIndex = self.SpawnIndex + 1
+    
+    return _DATABASE:FindStatic(Static:getName())
+  end
+  
+  return nil
+end
+
+
+--- Respawns the original @{Static}.
+-- @param #SPAWNSTATIC self
+-- @return #SPAWNSTATIC
+function SPAWNSTATIC:ReSpawn()
+  
+  local StaticTemplate, CoalitionID, CategoryID, CountryID = _DATABASE:GetStaticGroupTemplate( self.SpawnTemplatePrefix )
+  
+  if StaticTemplate then
+
+    local StaticUnitTemplate = StaticTemplate.units[1]
+    StaticTemplate.route = nil
+    StaticTemplate.groupId = nil
+    
+    local Static = coalition.addStaticObject( self.CountryID or CountryID, StaticTemplate.units[1] )
+    
+    return _DATABASE:FindStatic(Static:getName())
   end
   
   return nil
@@ -230,24 +267,20 @@ end
 -- @return #SPAWNSTATIC
 function SPAWNSTATIC:ReSpawnAt( Coordinate, Heading )
   
-  local StaticTemplate = _DATABASE:GetStaticUnitTemplate( self.SpawnTemplatePrefix )
+  local StaticTemplate, CoalitionID, CategoryID, CountryID = _DATABASE:GetStaticGroupTemplate( self.SpawnTemplatePrefix )
   
   if StaticTemplate then
 
-    local CountryID = self.CountryID
-    
-    StaticTemplate.x = Coordinate.x
-    StaticTemplate.y = Coordinate.z
+    local StaticUnitTemplate = StaticTemplate.units[1]
+  
+    StaticUnitTemplate.x = Coordinate.x
+    StaticUnitTemplate.y = Coordinate.z
 
-    StaticTemplate.heading = Heading and ( ( Heading / 180 ) * math.pi ) or StaticTemplate.heading
-
-    StaticTemplate.CountryID = nil
-    StaticTemplate.CoalitionID = nil
-    StaticTemplate.CategoryID = nil
+    StaticUnitTemplate.heading = Heading and ( ( Heading / 180 ) * math.pi ) or StaticTemplate.heading
     
-    local Static = coalition.addStaticObject( CountryID, StaticTemplate )
+    local Static = coalition.addStaticObject( self.CountryID or CountryID, StaticTemplate.units[1] )
     
-    return Static
+    return _DATABASE:FindStatic(Static:getName())
   end
   
   return nil
@@ -258,7 +291,7 @@ end
 -- @param #SPAWNSTATIC self
 -- @param Core.Zone#ZONE_BASE Zone The Zone where to spawn the static.
 -- @param #number Heading The heading of the static, which is a number in degrees from 0 to 360.
--- @param #string (optional) The name of the new static.
+-- @param #string NewName (optional) The name of the new static.
 -- @return #SPAWNSTATIC
 function SPAWNSTATIC:SpawnFromZone( Zone, Heading, NewName ) --R2.1
   self:F( { Zone, Heading, NewName  } )

Moose Development/Moose/Core/Spot.lua

@@ -1,11 +1,12 @@
---- **Core** -- Management of SPOT logistics, that can be transported from and to transportation carriers.
+--- **Core** - Management of spotting logistics, that can be activated and deactivated upon command.
 --
 -- ===
 -- 
 -- SPOT implements the DCS Spot class functionality, but adds additional luxury to be able to:
 -- 
 --   * Spot for a defined duration.
---   * wiggle the spot at the target.
+--   * Updates of laer spot position every 0.2 seconds for moving targets.
+--   * Wiggle the spot at the target.
 --   * Provide a @{Wrapper.Unit} as a target, instead of a point.
 --   * Implement a status machine, LaseOn, LaseOff.
 --
@@ -49,7 +50,8 @@ do
   --- Implements the target spotting or marking functionality, but adds additional luxury to be able to:
   -- 
   --   * Mark targets for a defined duration.
-  --   * wiggle the spot at the target.
+  --   * Updates of laer spot position every 0.2 seconds for moving targets.
+  --   * Wiggle the spot at the target.
   --   * Provide a @{Wrapper.Unit} as a target, instead of a point.
   --   * Implement a status machine, LaseOn, LaseOff.
   -- 
@@ -85,9 +87,7 @@ do
   
   --- SPOT Constructor.
   -- @param #SPOT self
-  -- @param Wrapper.Unit#UNIT Recce
-  -- @param #number LaserCode
-  -- @param #number Duration
+  -- @param Wrapper.Unit#UNIT Recce Unit that is lasing
   -- @return #SPOT
   function SPOT:New( Recce )
   
@@ -115,12 +115,50 @@ do
     --- LaseOn Trigger for SPOT
     -- @function [parent=#SPOT] LaseOn
     -- @param #SPOT self
+    -- @param Wrapper.Positionable#POSITIONABLE Target
+    -- @param #number LaserCode Laser code.
+    -- @param #number Duration Duration of lasing in seconds.
     
     --- LaseOn Asynchronous Trigger for SPOT
     -- @function [parent=#SPOT] __LaseOn
     -- @param #SPOT self
     -- @param #number Delay
+    -- @param Wrapper.Positionable#POSITIONABLE Target
+    -- @param #number LaserCode Laser code.
+    -- @param #number Duration Duration of lasing in seconds.
+
+    self:AddTransition( "Off", "LaseOnCoordinate", "On" )
     
+    --- LaseOnCoordinate Handler OnBefore for SPOT.
+    -- @function [parent=#SPOT] OnBeforeLaseOnCoordinate
+    -- @param #SPOT self
+    -- @param #string From
+    -- @param #string Event
+    -- @param #string To
+    -- @return #boolean
+    
+    --- LaseOnCoordinate Handler OnAfter for SPOT.
+    -- @function [parent=#SPOT] OnAfterLaseOnCoordinate
+    -- @param #SPOT self
+    -- @param #string From
+    -- @param #string Event
+    -- @param #string To
+    
+    --- LaseOnCoordinate Trigger for SPOT.
+    -- @function [parent=#SPOT] LaseOnCoordinate
+    -- @param #SPOT self
+    -- @param Core.Point#COORDINATE Coordinate The coordinate to lase.
+    -- @param #number LaserCode Laser code.
+    -- @param #number Duration Duration of lasing in seconds.
+    
+    --- LaseOn Asynchronous Trigger for SPOT
+    -- @function [parent=#SPOT] __LaseOn
+    -- @param #SPOT self
+    -- @param #number Delay
+    -- @param Wrapper.Positionable#POSITIONABLE Target
+    -- @param #number LaserCode Laser code.
+    -- @param #number Duration Duration of lasing in seconds.
+
     
     
     self:AddTransition( "On",  "Lasing", "On" )
@@ -189,13 +227,14 @@ do
     return self
   end
   
-  --- @param #SPOT self
+  --- On after LaseOn event. Activates the laser spot.
+  -- @param #SPOT self
   -- @param From
   -- @param Event
   -- @param To
-  -- @param Wrapper.Positionable#POSITIONABLE Target
-  -- @param #number LaserCode
-  -- @param #number Duration
+  -- @param Wrapper.Positionable#POSITIONABLE Target Unit that is being lased.
+  -- @param #number LaserCode Laser code.
+  -- @param #number Duration Duration of lasing in seconds.
   function SPOT:onafterLaseOn( From, Event, To, Target, LaserCode, Duration )
     self:F( { "LaseOn", Target, LaserCode, Duration } )
 
@@ -221,6 +260,40 @@ do
     
     self:__Lasing( -1 )
   end
+  
+  
+  --- On after LaseOnCoordinate event. Activates the laser spot.
+  -- @param #SPOT self
+  -- @param From
+  -- @param Event
+  -- @param To
+  -- @param Core.Point#COORDINATE Coordinate The coordinate at which the laser is pointing.
+  -- @param #number LaserCode Laser code.
+  -- @param #number Duration Duration of lasing in seconds.
+  function SPOT:onafterLaseOnCoordinate(From, Event, To, Coordinate, LaserCode, Duration)
+    self:F( { "LaseOnCoordinate", Coordinate, LaserCode, Duration } )
+
+    local function StopLase( self )
+      self:LaseOff()
+    end
+    
+    self.Target = nil
+    self.TargetCoord=Coordinate
+    self.LaserCode = LaserCode
+    
+    self.Lasing = true
+    
+    local RecceDcsUnit = self.Recce:GetDCSObject()
+    
+    self.SpotIR = Spot.createInfraRed( RecceDcsUnit, { x = 0, y = 1, z = 0 }, Coordinate:GetVec3() )
+    self.SpotLaser = Spot.createLaser( RecceDcsUnit, { x = 0, y = 1, z = 0 }, Coordinate:GetVec3(), LaserCode )
+
+    if Duration then
+      self.ScheduleID = self.LaseScheduler:Schedule( self, StopLase, {self}, Duration )
+    end
+    
+    self:__Lasing(-1)
+  end  
 
   --- @param #SPOT self
   -- @param Core.Event#EVENTDATA EventData
@@ -241,10 +314,20 @@ do
   -- @param To
   function SPOT:onafterLasing( From, Event, To )
   
-    if self.Target:IsAlive() then
+    if self.Target and self.Target:IsAlive() then
       self.SpotIR:setPoint( self.Target:GetPointVec3():AddY(1):AddY(math.random(-100,100)/100):AddX(math.random(-100,100)/100):GetVec3() )
       self.SpotLaser:setPoint( self.Target:GetPointVec3():AddY(1):GetVec3() )
       self:__Lasing( -0.2 )
+    elseif self.TargetCoord then
+    
+      -- Wiggle the IR spot a bit.  
+      local irvec3={x=self.TargetCoord.x+math.random(-100,100)/100, y=self.TargetCoord.y+math.random(-100,100)/100, z=self.TargetCoord.z} --#DCS.Vec3
+      local lsvec3={x=self.TargetCoord.x, y=self.TargetCoord.y, z=self.TargetCoord.z} --#DCS.Vec3
+      
+      self.SpotIR:setPoint(irvec3)
+      self.SpotLaser:setPoint(lsvec3)
+      
+      self:__Lasing(-0.25)    
     else
       self:F( { "Target is not alive", self.Target:IsAlive() } )
     end

Moose Development/Moose/Core/UserFlag.lua

@@ -1,8 +1,10 @@
---- **Core (WIP)** -- Manage user flags.
+--- **Core** - Manage user flags to interact with the mission editor trigger system and server side scripts.
 --
 -- ===
 -- 
--- Management of DCS User Flags.
+-- ## Features:
+-- 
+--   * Set or get DCS user flags within running missions.
 -- 
 -- ===
 -- 
@@ -22,7 +24,7 @@ do -- UserFlag
 
   --- Management of DCS User Flags.
   -- 
-  -- ## USERFLAG constructor
+  -- # 1. USERFLAG constructor
   --   
   --   * @{#USERFLAG.New}(): Creates a new USERFLAG object.
   -- 
@@ -55,8 +57,6 @@ do -- UserFlag
   --   
   function USERFLAG:Set( Number ) --R2.3
   
-    self:F( { Number = Number } )
-    
     trigger.action.setUserFlag( self.UserFlagName, Number )
     
     return self
@@ -70,7 +70,7 @@ do -- UserFlag
   --   local BlueVictory = USERFLAG:New( "VictoryBlue" )
   --   local BlueVictoryValue = BlueVictory:Get() -- Get the UserFlag VictoryBlue value.
   --   
-  function USERFLAG:Get( Number ) --R2.3
+  function USERFLAG:Get() --R2.3
     
     return trigger.misc.getUserFlag( self.UserFlagName )
   end  

Moose Development/Moose/Core/UserSound.lua

@@ -1,7 +1,13 @@
---- **Core (WIP)** -- Manage user sound.
+--- **Core** - Manage user sound.
 --
 -- ===
 -- 
+-- ## Features:
+-- 
+--   * Play sounds wihtin running missions.
+-- 
+-- ===
+-- 
 -- Management of DCS User Sound.
 -- 
 -- ===
@@ -112,15 +118,21 @@ do -- UserSound
   --- Play the usersound to the given @{Wrapper.Group}.
   -- @param #USERSOUND self
   -- @param Wrapper.Group#GROUP Group The @{Wrapper.Group} to play the usersound to.
+  -- @param #number Delay (Optional) Delay in seconds, before the sound is played. Default 0.
   -- @return #USERSOUND The usersound instance.
   -- @usage
   --   local BlueVictory = USERSOUND:New( "BlueVictory.ogg" )
   --   local PlayerGroup = GROUP:FindByName( "PlayerGroup" ) -- Search for the active group named "PlayerGroup", that contains a human player.
   --   BlueVictory:ToGroup( PlayerGroup ) -- Play the sound that Blue has won to the player group.
   --   
-  function USERSOUND:ToGroup( Group ) --R2.3
-    
-    trigger.action.outSoundForGroup( Group:GetID(), self.UserSoundFileName )
+  function USERSOUND:ToGroup( Group, Delay ) --R2.3
+  
+    Delay=Delay or 0
+    if Delay>0 then
+      SCHEDULER:New(nil, USERSOUND.ToGroup,{self, Group}, Delay)      
+    else
+      trigger.action.outSoundForGroup( Group:GetID(), self.UserSoundFileName )
+    end
     
     return self
   end  

Moose Development/Moose/Core/Velocity.lua

@@ -1,7 +1,15 @@
---- **Core** -- VELOCITY models a speed, which can be expressed in various formats according the Settings.
+--- **Core** - Models a velocity or speed, which can be expressed in various formats according the settings.
 -- 
 -- ===
 -- 
+-- ## Features:
+-- 
+--   * Convert velocity in various metric systems.
+--   * Set the velocity.
+--   * Create a text in a specific format of a velocity.
+--   
+-- ===
+-- 
 -- ### Author: **FlightControl**
 -- ### Contributions: 
 -- 

Moose Development/Moose/Core/Zone.lua

@@ -1,7 +1,24 @@
---- **Core** -- ZONE classes define **zones** within your mission of **various forms**, with **various capabilities**.
+--- **Core** - Define zones within your mission of various forms, with various capabilities.
 -- 
 -- ===
 -- 
+-- ## Features:
+-- 
+--   * Create radius zones.
+--   * Create trigger zones.
+--   * Create polygon zones.
+--   * Create moving zones around a unit.
+--   * Create moving zones around a group.
+--   * Provide the zone behaviour. Some zones are static, while others are moveable.
+--   * Enquiry if a coordinate is within a zone.
+--   * Smoke zones.
+--   * Set a zone probability to control zone selection.
+--   * Get zone coordinates.
+--   * Get zone properties.
+--   * Get zone bounding box.
+--   * Set/get zone name.
+--   
+-- 
 -- There are essentially two core functions that zones accomodate:
 -- 
 --   * Test if an object is within the zone boundaries.
@@ -103,7 +120,7 @@ ZONE_BASE = {
 -- @param #string ZoneName Name of the zone.
 -- @return #ZONE_BASE self
 function ZONE_BASE:New( ZoneName )
-  local self = BASE:Inherit( self, BASE:New() )
+  local self = BASE:Inherit( self, FSM:New() )
   self:F( ZoneName )
 
   self.ZoneName = ZoneName
@@ -312,12 +329,13 @@ end
 -- @param Utilities.Utils#SMOKECOLOR SmokeColor The smoke color.
 function ZONE_BASE:SmokeZone( SmokeColor )
   self:F2( SmokeColor )
-
+  
 end
 
 --- Set the randomization probability of a zone to be selected.
 -- @param #ZONE_BASE self
--- @param ZoneProbability A value between 0 and 1. 0 = 0% and 1 = 100% probability.
+-- @param #number ZoneProbability A value between 0 and 1. 0 = 0% and 1 = 100% probability.
+-- @return #ZONE_BASE self
 function ZONE_BASE:SetZoneProbability( ZoneProbability )
   self:F( { self:GetName(), ZoneProbability = ZoneProbability } )
   
@@ -329,7 +347,7 @@ end
 -- @param #ZONE_BASE self
 -- @return #number A value between 0 and 1. 0 = 0% and 1 = 100% probability.
 function ZONE_BASE:GetZoneProbability()
-  self:F2()
+  self:F2()  
   
   return self.ZoneProbability
 end
@@ -424,6 +442,33 @@ function ZONE_RADIUS:New( ZoneName, Vec2, Radius )
 	return self
 end
 
+--- Mark the zone with markers on the F10 map.
+-- @param #ZONE_RADIUS self
+-- @param #number Points (Optional) The amount of points in the circle. Default 360.
+-- @return #ZONE_RADIUS self
+function ZONE_RADIUS:MarkZone(Points)
+
+  local Point = {}
+  local Vec2 = self:GetVec2()
+
+  Points = Points and Points or 360
+
+  local Angle
+  local RadialBase = math.pi*2
+  
+  for Angle = 0, 360, (360 / Points ) do
+  
+    local Radial = Angle * RadialBase / 360
+    
+    Point.x = Vec2.x + math.cos( Radial ) * self:GetRadius()
+    Point.y = Vec2.y + math.sin( Radial ) * self:GetRadius()
+    
+    COORDINATE:NewFromVec2(Point):MarkToAll(self:GetName())
+
+  end
+  
+end
+
 --- Bounds the zone with tires.
 -- @param #ZONE_RADIUS self
 -- @param #number Points (optional) The amount of points in the circle. Default 360.
@@ -517,7 +562,7 @@ function ZONE_RADIUS:FlareZone( FlareColor, Points, Azimuth, AddHeight )
   local Vec2 = self:GetVec2()
   
   AddHeight = AddHeight or 0
-
+  
   Points = Points and Points or 360
 
   local Angle
@@ -600,6 +645,9 @@ function ZONE_RADIUS:GetVec3( Height )
 end
 
 
+
+
+
 --- Scan the zone for the presence of units of the given ObjectCategories.
 -- Note that after a zone has been scanned, the zone can be evaluated by:
 -- 
@@ -610,12 +658,12 @@ end
 --   * @{ZONE_RADIUS.IsNoneInZone}(): Scan if the zone is empty.
 -- @{#ZONE_RADIUS.
 -- @param #ZONE_RADIUS self
--- @param ObjectCategories
--- @param Coalition
+-- @param ObjectCategories An array of categories of the objects to find in the zone.
+-- @param UnitCategories An array of unit categories of the objects to find in the zone.
 -- @usage
 --    self.Zone:Scan()
 --    local IsAttacked = self.Zone:IsSomeInZoneOfCoalition( self.Coalition )
-function ZONE_RADIUS:Scan( ObjectCategories )
+function ZONE_RADIUS:Scan( ObjectCategories, UnitCategories )
 
   self.ScanData = {}
   self.ScanData.Coalitions = {}
@@ -642,16 +690,31 @@ function ZONE_RADIUS:Scan( ObjectCategories )
       if ( ObjectCategory == Object.Category.UNIT and ZoneObject:isExist() and ZoneObject:isActive() ) or 
          (ObjectCategory == Object.Category.STATIC and ZoneObject:isExist()) then
         local CoalitionDCSUnit = ZoneObject:getCoalition()
-        self.ScanData.Coalitions[CoalitionDCSUnit] = true
-        self.ScanData.Units[ZoneObject] = ZoneObject
-        self:F( { Name = ZoneObject:getName(), Coalition = CoalitionDCSUnit } )
+        local Include = false
+        if not UnitCategories then
+          Include = true
+        else
+          local CategoryDCSUnit = ZoneObject:getDesc().category
+          for UnitCategoryID, UnitCategory in pairs( UnitCategories ) do
+            if UnitCategory == CategoryDCSUnit then
+              Include = true
+              break
+            end
+          end
+        end
+        if Include then
+          local CoalitionDCSUnit = ZoneObject:getCoalition()
+          self.ScanData.Coalitions[CoalitionDCSUnit] = true
+          self.ScanData.Units[ZoneObject] = ZoneObject
+          self:F2( { Name = ZoneObject:getName(), Coalition = CoalitionDCSUnit } )
+        end
       end
       if ObjectCategory == Object.Category.SCENERY then
         local SceneryType = ZoneObject:getTypeName()
         local SceneryName = ZoneObject:getName()
         self.ScanData.Scenery[SceneryType] = self.ScanData.Scenery[SceneryType] or {}
         self.ScanData.Scenery[SceneryType][SceneryName] = SCENERY:Register( SceneryName, ZoneObject )
-        self:F( { SCENERY =  self.ScanData.Scenery[SceneryType][SceneryName] } )
+        self:F2( { SCENERY =  self.ScanData.Scenery[SceneryType][SceneryName] } )
       end
     end
     return true
@@ -668,6 +731,31 @@ function ZONE_RADIUS:GetScannedUnits()
 end
 
 
+function ZONE_RADIUS:GetScannedSetUnit()
+
+  local SetUnit = SET_UNIT:New()
+
+  if self.ScanData then
+    for ObjectID, UnitObject in pairs( self.ScanData.Units ) do
+      local UnitObject = UnitObject -- DCS#Unit
+      if UnitObject:isExist() then
+        local FoundUnit = UNIT:FindByName( UnitObject:getName() )
+        if FoundUnit then
+          SetUnit:AddUnit( FoundUnit )
+        else
+          local FoundStatic = STATIC:FindByName( UnitObject:getName() )
+          if FoundStatic then
+            SetUnit:AddUnit( FoundStatic )
+          end
+        end
+      end
+    end
+  end
+
+  return SetUnit
+end
+
+
 function ZONE_RADIUS:CountScannedCoalitions()
 
   local Count = 0
@@ -934,7 +1022,7 @@ end
 function ZONE_RADIUS:GetRandomCoordinate( inner, outer )
   self:F( self.ZoneName, inner, outer )
 
-  local Coordinate = COORDINATE:NewFromVec2( self:GetRandomVec2() )
+  local Coordinate = COORDINATE:NewFromVec2( self:GetRandomVec2(inner, outer) )
 
   self:T3( { Coordinate = Coordinate } )
   
@@ -1079,6 +1167,7 @@ function ZONE_UNIT:GetVec2()
   local ZoneVec2 = self.ZoneUNIT:GetVec2()
   if ZoneVec2 then
   
+    local heading
     if self.relative_to_unit then
         heading = ( self.ZoneUNIT:GetHeading() or 0.0 ) * math.pi / 180.0
       else
@@ -1118,7 +1207,8 @@ function ZONE_UNIT:GetRandomVec2()
   self:F( self.ZoneName )
 
   local RandomVec2 = {}
-  local Vec2 = self.ZoneUNIT:GetVec2()
+  --local Vec2 = self.ZoneUNIT:GetVec2()  -- FF: This does not take care of the new offset feature!
+  local Vec2 = self:GetVec2()
   
   if not Vec2 then
     Vec2 = self.LastVec2
@@ -1174,6 +1264,7 @@ function ZONE_GROUP:New( ZoneName, ZoneGROUP, Radius )
   self:F( { ZoneName, ZoneGROUP:GetVec2(), Radius } )
 
   self._.ZoneGROUP = ZoneGROUP
+  self._.ZoneVec2Cache = self._.ZoneGROUP:GetVec2()
 
   -- Zone objects are added to the _DATABASE and SET_ZONE objects.
   _EVENTDISPATCHER:CreateEventNewZone( self )
@@ -1188,7 +1279,14 @@ end
 function ZONE_GROUP:GetVec2()
   self:F( self.ZoneName )
   
-  local ZoneVec2 = self._.ZoneGROUP:GetVec2()
+  local ZoneVec2 = nil
+  
+  if self._.ZoneGROUP:IsAlive() then
+    ZoneVec2 = self._.ZoneGROUP:GetVec2()
+    self._.ZoneVec2Cache = ZoneVec2
+  else
+    ZoneVec2 = self._.ZoneVec2Cache
+  end
 
   self:T( { ZoneVec2 } )
   
@@ -1295,7 +1393,7 @@ end
 function ZONE_POLYGON_BASE:Flush()
   self:F2()
 
-  self:E( { Polygon = self.ZoneName, Coordinates = self._.Polygon } )
+  self:F( { Polygon = self.ZoneName, Coordinates = self._.Polygon } )
 
   return self
 end
@@ -1352,16 +1450,15 @@ end
 --- Smokes the zone boundaries in a color.
 -- @param #ZONE_POLYGON_BASE self
 -- @param Utilities.Utils#SMOKECOLOR SmokeColor The smoke color.
+-- @param #number Segments (Optional) Number of segments within boundary line. Default 10.
 -- @return #ZONE_POLYGON_BASE self
-function ZONE_POLYGON_BASE:SmokeZone( SmokeColor )
+function ZONE_POLYGON_BASE:SmokeZone( SmokeColor, Segments )
   self:F2( SmokeColor )
 
-  local i 
-  local j 
-  local Segments = 10
+  Segments=Segments or 10
   
-  i = 1
-  j = #self._.Polygon
+  local i=1
+  local j=#self._.Polygon
   
   while i <= #self._.Polygon do
     self:T( { i, j, self._.Polygon[i], self._.Polygon[j] } )
@@ -1382,6 +1479,42 @@ function ZONE_POLYGON_BASE:SmokeZone( SmokeColor )
 end
 
 
+--- Flare the zone boundaries in a color.
+-- @param #ZONE_POLYGON_BASE self
+-- @param Utilities.Utils#FLARECOLOR FlareColor The flare color.
+-- @param #number Segments (Optional) Number of segments within boundary line. Default 10.
+-- @param DCS#Azimuth Azimuth (optional) Azimuth The azimuth of the flare.
+-- @param #number AddHeight (optional) The height to be added for the smoke.
+-- @return #ZONE_POLYGON_BASE self
+function ZONE_POLYGON_BASE:FlareZone( FlareColor, Segments, Azimuth, AddHeight )
+  self:F2(FlareColor)
+
+  Segments=Segments or 10
+  
+  AddHeight = AddHeight or 0
+  
+  local i=1
+  local j=#self._.Polygon
+  
+  while i <= #self._.Polygon do
+    self:T( { i, j, self._.Polygon[i], self._.Polygon[j] } )
+    
+    local DeltaX = self._.Polygon[j].x - self._.Polygon[i].x
+    local DeltaY = self._.Polygon[j].y - self._.Polygon[i].y
+    
+    for Segment = 0, Segments do -- We divide each line in 5 segments and smoke a point on the line.
+      local PointX = self._.Polygon[i].x + ( Segment * DeltaX / Segments )
+      local PointY = self._.Polygon[i].y + ( Segment * DeltaY / Segments )
+      POINT_VEC2:New( PointX, PointY, AddHeight ):Flare(FlareColor, Azimuth)
+    end
+    j = i
+    i = i + 1
+  end
+
+  return self
+end
+
+
 
 
 --- Returns if a location is within the zone.
@@ -1550,6 +1683,9 @@ function ZONE_POLYGON:New( ZoneName, ZoneGroup )
   local self = BASE:Inherit( self, ZONE_POLYGON_BASE:New( ZoneName, GroupPoints ) )
   self:F( { ZoneName, ZoneGroup, self._.Polygon } )
 
+  -- Zone objects are added to the _DATABASE and SET_ZONE objects.
+  _EVENTDISPATCHER:CreateEventNewZone( self )
+
   return self
 end
 
@@ -1557,7 +1693,6 @@ end
 --- Constructor to create a ZONE_POLYGON instance, taking the zone name and the **name** of the @{Wrapper.Group#GROUP} defined within the Mission Editor.
 -- The @{Wrapper.Group#GROUP} waypoints define the polygon corners. The first and the last point are automatically connected by ZONE_POLYGON.
 -- @param #ZONE_POLYGON self
--- @param #string ZoneName Name of the zone.
 -- @param #string GroupName The group name of the GROUP defining the waypoints within the Mission Editor to define the polygon shape.
 -- @return #ZONE_POLYGON self
 function ZONE_POLYGON:NewFromGroupName( GroupName )
@@ -1569,6 +1704,9 @@ function ZONE_POLYGON:NewFromGroupName( GroupName )
   local self = BASE:Inherit( self, ZONE_POLYGON_BASE:New( GroupName, GroupPoints ) )
   self:F( { GroupName, ZoneGroup, self._.Polygon } )
 
+  -- Zone objects are added to the _DATABASE and SET_ZONE objects.
+  _EVENTDISPATCHER:CreateEventNewZone( self )
+
   return self
 end
 
@@ -1583,4 +1721,103 @@ function ZONE_POLYGON:FindByName( ZoneName )
   return ZoneFound
 end
 
+do -- ZONE_AIRBASE
 
+  --- @type ZONE_AIRBASE
+  -- @extends #ZONE_RADIUS
+  
+  
+  --- The ZONE_AIRBASE class defines by a zone around a @{Wrapper.Airbase#AIRBASE} with a radius.
+  -- This class implements the inherited functions from @{Core.Zone#ZONE_RADIUS} taking into account the own zone format and properties.
+  -- 
+  -- @field #ZONE_AIRBASE
+  ZONE_AIRBASE = {
+    ClassName="ZONE_AIRBASE",
+    }
+    
+    
+    
+  --- Constructor to create a ZONE_AIRBASE instance, taking the zone name, a zone @{Wrapper.Airbase#AIRBASE} and a radius.
+  -- @param #ZONE_AIRBASE self
+  -- @param #string AirbaseName Name of the airbase.
+  -- @param DCS#Distance Radius (Optional)The radius of the zone in meters. Default 4000 meters.
+  -- @return #ZONE_AIRBASE self
+  function ZONE_AIRBASE:New( AirbaseName, Radius )
+  
+    Radius=Radius or 4000
+  
+    local Airbase = AIRBASE:FindByName( AirbaseName )
+  
+    local self = BASE:Inherit( self, ZONE_RADIUS:New( AirbaseName, Airbase:GetVec2(), Radius ) )
+  
+    self._.ZoneAirbase = Airbase
+    self._.ZoneVec2Cache = self._.ZoneAirbase:GetVec2()
+  
+    -- Zone objects are added to the _DATABASE and SET_ZONE objects.
+    _EVENTDISPATCHER:CreateEventNewZone( self )
+    
+    return self
+  end
+  
+  --- Get the airbase as part of the ZONE_AIRBASE object.
+  -- @param #ZONE_AIRBASE self
+  -- @return Wrapper.Airbase#AIRBASE The airbase.
+  function ZONE_AIRBASE:GetAirbase()
+    return self._.ZoneAirbase
+  end  
+  
+  --- Returns the current location of the @{Wrapper.Group}.
+  -- @param #ZONE_AIRBASE self
+  -- @return DCS#Vec2 The location of the zone based on the @{Wrapper.Group} location.
+  function ZONE_AIRBASE:GetVec2()
+    self:F( self.ZoneName )
+    
+    local ZoneVec2 = nil
+    
+    if self._.ZoneAirbase:IsAlive() then
+      ZoneVec2 = self._.ZoneAirbase:GetVec2()
+      self._.ZoneVec2Cache = ZoneVec2
+    else
+      ZoneVec2 = self._.ZoneVec2Cache
+    end
+  
+    self:T( { ZoneVec2 } )
+    
+    return ZoneVec2
+  end
+  
+  --- Returns a random location within the zone of the @{Wrapper.Group}.
+  -- @param #ZONE_AIRBASE self
+  -- @return DCS#Vec2 The random location of the zone based on the @{Wrapper.Group} location.
+  function ZONE_AIRBASE:GetRandomVec2()
+    self:F( self.ZoneName )
+  
+    local Point = {}
+    local Vec2 = self._.ZoneAirbase:GetVec2()
+  
+    local angle = math.random() * math.pi*2;
+    Point.x = Vec2.x + math.cos( angle ) * math.random() * self:GetRadius();
+    Point.y = Vec2.y + math.sin( angle ) * math.random() * self:GetRadius();
+    
+    self:T( { Point } )
+    
+    return Point
+  end
+  
+  --- Returns a @{Core.Point#POINT_VEC2} object reflecting a random 2D location within the zone.
+  -- @param #ZONE_AIRBASE self
+  -- @param #number inner (optional) Minimal distance from the center of the zone. Default is 0.
+  -- @param #number outer (optional) Maximal distance from the outer edge of the zone. Default is the radius of the zone.
+  -- @return Core.Point#POINT_VEC2 The @{Core.Point#POINT_VEC2} object reflecting the random 3D location within the zone.
+  function ZONE_AIRBASE:GetRandomPointVec2( inner, outer )
+    self:F( self.ZoneName, inner, outer )
+  
+    local PointVec2 = POINT_VEC2:NewFromVec2( self:GetRandomVec2() )
+  
+    self:T3( { PointVec2 } )
+    
+    return PointVec2
+  end
+
+
+end

Moose Development/Moose/Core/Zone_Detection.lua

@@ -0,0 +1,203 @@
+
+--- The ZONE_DETECTION class, defined by a zone name, a detection object and a radius.
+-- @type ZONE_DETECTION
+-- @field DCS#Vec2 Vec2 The current location of the zone.
+-- @field DCS#Distance Radius The radius of the zone.
+-- @extends #ZONE_BASE
+
+--- The ZONE_DETECTION class defined by a zone name, a location and a radius.
+-- This class implements the inherited functions from Core.Zone#ZONE_BASE taking into account the own zone format and properties.
+-- 
+-- ## ZONE_DETECTION constructor
+-- 
+--   * @{#ZONE_DETECTION.New}(): Constructor.
+-- 
+-- @field #ZONE_DETECTION
+ZONE_DETECTION = {
+  ClassName="ZONE_DETECTION",
+  }
+
+--- Constructor of @{#ZONE_DETECTION}, taking the zone name, the zone location and a radius.
+-- @param #ZONE_DETECTION self
+-- @param #string ZoneName Name of the zone.
+-- @param Functional.Detection#DETECTION_BASE Detection The detection object defining the locations of the central detections.
+-- @param DCS#Distance Radius The radius around the detections defining the combined zone.
+-- @return #ZONE_DETECTION self
+function ZONE_DETECTION:New( ZoneName, Detection, Radius )
+  local self = BASE:Inherit( self, ZONE_BASE:New( ZoneName ) ) -- #ZONE_DETECTION
+  self:F( { ZoneName, Detection, Radius } )
+
+  self.Detection = Detection
+  self.Radius = Radius
+  
+  return self
+end
+
+--- Bounds the zone with tires.
+-- @param #ZONE_DETECTION self
+-- @param #number Points (optional) The amount of points in the circle. Default 360.
+-- @param DCS#country.id CountryID The country id of the tire objects, e.g. country.id.USA for blue or country.id.RUSSIA for red.
+-- @param #boolean UnBound (Optional) If true the tyres will be destroyed.
+-- @return #ZONE_DETECTION self
+function ZONE_DETECTION:BoundZone( Points, CountryID, UnBound )
+
+  local Point = {}
+  local Vec2 = self:GetVec2()
+
+  Points = Points and Points or 360
+
+  local Angle
+  local RadialBase = math.pi*2
+  
+  --
+  for Angle = 0, 360, (360 / Points ) do
+    local Radial = Angle * RadialBase / 360
+    Point.x = Vec2.x + math.cos( Radial ) * self:GetRadius()
+    Point.y = Vec2.y + math.sin( Radial ) * self:GetRadius()
+    
+    local CountryName = _DATABASE.COUNTRY_NAME[CountryID]
+    
+    local Tire = {
+        ["country"] = CountryName, 
+        ["category"] = "Fortifications",
+        ["canCargo"] = false,
+        ["shape_name"] = "H-tyre_B_WF",
+        ["type"] = "Black_Tyre_WF",
+        --["unitId"] = Angle + 10000,
+        ["y"] = Point.y,
+        ["x"] = Point.x,
+        ["name"] = string.format( "%s-Tire #%0d", self:GetName(), Angle ),
+        ["heading"] = 0,
+    } -- end of ["group"]
+
+    local Group = coalition.addStaticObject( CountryID, Tire )
+    if UnBound and UnBound == true then
+      Group:destroy()
+    end
+  end
+
+  return self
+end
+
+
+--- Smokes the zone boundaries in a color.
+-- @param #ZONE_DETECTION self
+-- @param Utilities.Utils#SMOKECOLOR SmokeColor The smoke color.
+-- @param #number Points (optional) The amount of points in the circle.
+-- @param #number AddHeight (optional) The height to be added for the smoke.
+-- @param #number AddOffSet (optional) The angle to be added for the smoking start position.
+-- @return #ZONE_DETECTION self
+function ZONE_DETECTION:SmokeZone( SmokeColor, Points, AddHeight, AngleOffset )
+  self:F2( SmokeColor )
+
+  local Point = {}
+  local Vec2 = self:GetVec2()
+  
+  AddHeight = AddHeight or 0
+  AngleOffset = AngleOffset or 0
+
+  Points = Points and Points or 360
+
+  local Angle
+  local RadialBase = math.pi*2
+  
+  for Angle = 0, 360, 360 / Points do
+    local Radial = ( Angle + AngleOffset ) * RadialBase / 360
+    Point.x = Vec2.x + math.cos( Radial ) * self:GetRadius()
+    Point.y = Vec2.y + math.sin( Radial ) * self:GetRadius()
+    POINT_VEC2:New( Point.x, Point.y, AddHeight ):Smoke( SmokeColor )
+  end
+
+  return self
+end
+
+
+--- Flares the zone boundaries in a color.
+-- @param #ZONE_DETECTION self
+-- @param Utilities.Utils#FLARECOLOR FlareColor The flare color.
+-- @param #number Points (optional) The amount of points in the circle.
+-- @param DCS#Azimuth Azimuth (optional) Azimuth The azimuth of the flare.
+-- @param #number AddHeight (optional) The height to be added for the smoke.
+-- @return #ZONE_DETECTION self
+function ZONE_DETECTION:FlareZone( FlareColor, Points, Azimuth, AddHeight )
+  self:F2( { FlareColor, Azimuth } )
+
+  local Point = {}
+  local Vec2 = self:GetVec2()
+  
+  AddHeight = AddHeight or 0
+  
+  Points = Points and Points or 360
+
+  local Angle
+  local RadialBase = math.pi*2
+  
+  for Angle = 0, 360, 360 / Points do
+    local Radial = Angle * RadialBase / 360
+    Point.x = Vec2.x + math.cos( Radial ) * self:GetRadius()
+    Point.y = Vec2.y + math.sin( Radial ) * self:GetRadius()
+    POINT_VEC2:New( Point.x, Point.y, AddHeight ):Flare( FlareColor, Azimuth )
+  end
+
+  return self
+end
+
+--- Returns the radius around the detected locations defining the combine zone.
+-- @param #ZONE_DETECTION self
+-- @return DCS#Distance The radius.
+function ZONE_DETECTION:GetRadius()
+  self:F2( self.ZoneName )
+
+  self:T2( { self.Radius } )
+
+  return self.Radius
+end
+
+--- Sets the radius around the detected locations defining the combine zone.
+-- @param #ZONE_DETECTION self
+-- @param DCS#Distance Radius The radius.
+-- @return #ZONE_DETECTION self
+function ZONE_DETECTION:SetRadius( Radius )
+  self:F2( self.ZoneName )
+
+  self.Radius = Radius
+  self:T2( { self.Radius } )
+
+  return self.Radius
+end
+
+
+
+--- Returns if a location is within the zone.
+-- @param #ZONE_DETECTION self
+-- @param DCS#Vec2 Vec2 The location to test.
+-- @return #boolean true if the location is within the zone.
+function ZONE_DETECTION:IsVec2InZone( Vec2 )
+  self:F2( Vec2 )
+
+  local Coordinates = self.Detection:GetDetectedItemCoordinates() -- This returns a list of coordinates that define the (central) locations of the detections.
+  
+  for CoordinateID, Coordinate in pairs( Coordinates ) do    
+    local ZoneVec2 = Coordinate:GetVec2()    
+    if ZoneVec2 then
+      if (( Vec2.x - ZoneVec2.x )^2 + ( Vec2.y - ZoneVec2.y ) ^2 ) ^ 0.5 <= self:GetRadius() then
+        return true
+      end
+    end
+  end
+  
+  return false
+end
+
+--- Returns if a point is within the zone.
+-- @param #ZONE_DETECTION self
+-- @param DCS#Vec3 Vec3 The point to test.
+-- @return #boolean true if the point is within the zone.
+function ZONE_DETECTION:IsVec3InZone( Vec3 )
+  self:F2( Vec3 )
+
+  local InZone = self:IsVec2InZone( { x = Vec3.x, y = Vec3.z } )
+
+  return InZone
+end
+

Moose Development/Moose/DCS.lua

@@ -1,76 +1,133 @@
 --- DCS API prototypes
+-- See [https://wiki.hoggitworld.com/view/Simulator_Scripting_Engine_Documentation](https://wiki.hoggitworld.com/view/Simulator_Scripting_Engine_Documentation) 
+-- for further explanation and examples.
 -- @module DCS
 -- @image MOOSE.JPG
 
 do -- world
 
-  --- @type world
-  -- @field #world.event event
+  --- [DCS Enum world](https://wiki.hoggitworld.com/view/DCS_enum_world)
+  -- @type world
+  -- @field #world.event event [https://wiki.hoggitworld.com/view/DCS_enum_world](https://wiki.hoggitworld.com/view/DCS_enum_world)
+  -- @field #world.BirthPlace BirthPlace The birthplace enumerator is used to define where an aircraft or helicopter has spawned in association with birth events.
+  -- @field #world.VolumeType VolumeType The volumeType enumerator defines the types of 3d geometery used within the [world.searchObjects](https://wiki.hoggitworld.com/view/DCS_func_searchObjects) function.
+
+  --- The world singleton contains functions centered around two different but extremely useful functions.
+  -- * Events and event handlers are all governed within world.
+  -- * A number of functions to get information about the game world.
+  -- 
+  -- See [https://wiki.hoggitworld.com/view/DCS_singleton_world](https://wiki.hoggitworld.com/view/DCS_singleton_world)
+  -- @field #world world
+  world = {}
   
-  --- @type world.event
-  -- @field S_EVENT_INVALID
-  -- @field S_EVENT_SHOT
-  -- @field S_EVENT_HIT
-  -- @field S_EVENT_TAKEOFF
-  -- @field S_EVENT_LAND
-  -- @field S_EVENT_CRASH
-  -- @field S_EVENT_EJECTION
-  -- @field S_EVENT_REFUELING
-  -- @field S_EVENT_DEAD
-  -- @field S_EVENT_PILOT_DEAD
-  -- @field S_EVENT_BASE_CAPTURED
-  -- @field S_EVENT_MISSION_START
-  -- @field S_EVENT_MISSION_END
-  -- @field S_EVENT_TOOK_CONTROL
-  -- @field S_EVENT_REFUELING_STOP
-  -- @field S_EVENT_BIRTH
-  -- @field S_EVENT_HUMAN_FAILURE
-  -- @field S_EVENT_ENGINE_STARTUP
-  -- @field S_EVENT_ENGINE_SHUTDOWN
-  -- @field S_EVENT_PLAYER_ENTER_UNIT
-  -- @field S_EVENT_PLAYER_LEAVE_UNIT
-  -- @field S_EVENT_PLAYER_COMMENT
-  -- @field S_EVENT_SHOOTING_START
-  -- @field S_EVENT_SHOOTING_END
+  --- [https://wiki.hoggitworld.com/view/DCS_enum_world](https://wiki.hoggitworld.com/view/DCS_enum_world)
+  -- @type world.event
+  -- @field S_EVENT_INVALID 
+  -- @field S_EVENT_SHOT [https://wiki.hoggitworld.com/view/DCS_event_shot](https://wiki.hoggitworld.com/view/DCS_event_shot)
+  -- @field S_EVENT_HIT [https://wiki.hoggitworld.com/view/DCS_event_hit](https://wiki.hoggitworld.com/view/DCS_event_hit)
+  -- @field S_EVENT_TAKEOFF [https://wiki.hoggitworld.com/view/DCS_event_takeoff](https://wiki.hoggitworld.com/view/DCS_event_takeoff)
+  -- @field S_EVENT_LAND [https://wiki.hoggitworld.com/view/DCS_event_land](https://wiki.hoggitworld.com/view/DCS_event_land)
+  -- @field S_EVENT_CRASH [https://wiki.hoggitworld.com/view/DCS_event_crash](https://wiki.hoggitworld.com/view/DCS_event_crash)
+  -- @field S_EVENT_EJECTION [https://wiki.hoggitworld.com/view/DCS_event_ejection](https://wiki.hoggitworld.com/view/DCS_event_ejection)
+  -- @field S_EVENT_REFUELING [https://wiki.hoggitworld.com/view/DCS_event_refueling](https://wiki.hoggitworld.com/view/DCS_event_refueling)
+  -- @field S_EVENT_DEAD [https://wiki.hoggitworld.com/view/DCS_event_dead](https://wiki.hoggitworld.com/view/DCS_event_dead)
+  -- @field S_EVENT_PILOT_DEAD [https://wiki.hoggitworld.com/view/DCS_event_pilot_dead](https://wiki.hoggitworld.com/view/DCS_event_pilot_dead)
+  -- @field S_EVENT_BASE_CAPTURED [https://wiki.hoggitworld.com/view/DCS_event_base_captured](https://wiki.hoggitworld.com/view/DCS_event_base_captured)
+  -- @field S_EVENT_MISSION_START [https://wiki.hoggitworld.com/view/DCS_event_mission_start](https://wiki.hoggitworld.com/view/DCS_event_mission_start)
+  -- @field S_EVENT_MISSION_END [https://wiki.hoggitworld.com/view/DCS_event_mission_end](https://wiki.hoggitworld.com/view/DCS_event_mission_end)
+  -- @field S_EVENT_TOOK_CONTROL 
+  -- @field S_EVENT_REFUELING_STOP [https://wiki.hoggitworld.com/view/DCS_event_refueling_stop](https://wiki.hoggitworld.com/view/DCS_event_refueling_stop)
+  -- @field S_EVENT_BIRTH [https://wiki.hoggitworld.com/view/DCS_event_birth](https://wiki.hoggitworld.com/view/DCS_event_birth)
+  -- @field S_EVENT_HUMAN_FAILURE [https://wiki.hoggitworld.com/view/DCS_event_human_failure](https://wiki.hoggitworld.com/view/DCS_event_human_failure)
+  -- @field S_EVENT_ENGINE_STARTUP [https://wiki.hoggitworld.com/view/DCS_event_engine_startup](https://wiki.hoggitworld.com/view/DCS_event_engine_startup)
+  -- @field S_EVENT_ENGINE_SHUTDOWN [https://wiki.hoggitworld.com/view/DCS_event_engine_shutdown](https://wiki.hoggitworld.com/view/DCS_event_engine_shutdown)
+  -- @field S_EVENT_PLAYER_ENTER_UNIT [https://wiki.hoggitworld.com/view/DCS_event_player_enter_unit](https://wiki.hoggitworld.com/view/DCS_event_player_enter_unit)
+  -- @field S_EVENT_PLAYER_LEAVE_UNIT [https://wiki.hoggitworld.com/view/DCS_event_player_leave_unit](https://wiki.hoggitworld.com/view/DCS_event_player_leave_unit)
+  -- @field S_EVENT_PLAYER_COMMENT 
+  -- @field S_EVENT_SHOOTING_START [https://wiki.hoggitworld.com/view/DCS_event_shooting_start](https://wiki.hoggitworld.com/view/DCS_event_shooting_start)
+  -- @field S_EVENT_SHOOTING_END [https://wiki.hoggitworld.com/view/DCS_event_shooting_end](https://wiki.hoggitworld.com/view/DCS_event_shooting_end)
+  -- @field S_EVENT_MARK ADDED [https://wiki.hoggitworld.com/view/DCS_event_mark_added](https://wiki.hoggitworld.com/view/DCS_event_mark_added)
+  -- @field S_EVENT_MARK CHANGE [https://wiki.hoggitworld.com/view/DCS_event_mark_change](https://wiki.hoggitworld.com/view/DCS_event_mark_change)
+  -- @field S_EVENT_MARK REMOVE [https://wiki.hoggitworld.com/view/DCS_event_mark_remove](https://wiki.hoggitworld.com/view/DCS_event_mark_remove)
   -- @field S_EVENT_MAX
   
-  world = {} --#world
+  --- The birthplace enumerator is used to define where an aircraft or helicopter has spawned in association with birth events.
+  -- @type world.BirthPlace
+  -- @field wsBirthPlace_Air
+  -- @field wsBirthPlace_RunWay
+  -- @field wsBirthPlace_Park
+  -- @field wsBirthPlace_Heliport_Hot
+  -- @field wsBirthPlace_Heliport_Cold
+
+  --- The volumeType enumerator defines the types of 3d geometery used within the #world.searchObjects function.
+  -- @type world.VolumeType
+  -- @field SEGMENT
+  -- @field BOX
+  -- @field SPHERE
+  -- @field PYRAMID
+
+  --- Adds a function as an event handler that executes whenever a simulator event occurs. See [hoggit](https://wiki.hoggitworld.com/view/DCS_func_addEventHandler).
+  -- @function [parent=#world] addEventHandler
+  -- @param #table handler Event handler table.
   
+  --- Removes the specified event handler from handling events.
+  -- @function [parent=#world] removeEventHandler
+  -- @param #table handler Event handler table.
+  
+  --- Returns a table of the single unit object in the game who's skill level is set as "Player". See [hoggit](https://wiki.hoggitworld.com/view/DCS_func_getPlayer).
+  -- There is only a single player unit in a mission and in single player the user will always spawn into this unit automatically unless other client or Combined Arms slots are available.
+  -- @function [parent=#world] getPlayer
+  -- @return DCS#Unit  
+  
+  --- Searches a defined volume of 3d space for the specified objects within it and then can run function on each returned object. See [hoggit](https://wiki.hoggitworld.com/view/DCS_func_searchObjects).
+  -- @function [parent=#world] searchObjects
+  -- @param DCS#Object.Category objectcategory Category (can be a table) of objects to search.
+  -- @param DCS#word.VolumeType volume Shape of the search area/volume.
+  -- @param ObjectSeachHandler handler A function that handles the search.
+  -- @param #table any Additional data.
+  -- @return DCS#Unit  
+  
+  --- Returns a table of mark panels indexed numerically that are present within the mission. See [hoggit](https://wiki.hoggitworld.com/view/DCS_func_getMarkPanels)
+  -- @function [parent=#world] getMarkPanels
+  -- @return #table Table of marks.
+ 
 end -- world
 
 
 do -- env
 
-  --- @type env
-  
+  --- [DCS Singleton env](https://wiki.hoggitworld.com/view/DCS_singleton_env)
+  -- @type env
+
   --- Add message to simulator log with caption "INFO". Message box is optional.
   -- @function [parent=#env] info
-  -- @field #string message message string to add to log.
-  -- @field #boolean showMessageBox If the parameter is true Message Box will appear. Optional.
+  -- @param #string message message string to add to log.
+  -- @param #boolean showMessageBox If the parameter is true Message Box will appear. Optional.
   
   --- Add message to simulator log with caption "WARNING". Message box is optional. 
   -- @function [parent=#env] warning
-  -- @field #string message message string to add to log.
-  -- @field #boolean showMessageBox If the parameter is true Message Box will appear. Optional.
+  -- @param #string message message string to add to log.
+  -- @param #boolean showMessageBox If the parameter is true Message Box will appear. Optional.
   
   --- Add message to simulator log with caption "ERROR". Message box is optional.
   -- @function [parent=#env] error
-  -- @field #string message message string to add to log.
-  -- @field #boolean showMessageBox If the parameter is true Message Box will appear. Optional.
+  -- @param #string message message string to add to log.
+  -- @param #boolean showMessageBox If the parameter is true Message Box will appear. Optional.
   
   --- Enables/disables appearance of message box each time lua error occurs.
   -- @function [parent=#env] setErrorMessageBoxEnabled
-  -- @field #boolean on if true message box appearance is enabled.
-  
-  env = {} --#env
+  -- @param #boolean on if true message box appearance is enabled.
+
+  --- [DCS Singleton env](https://wiki.hoggitworld.com/view/DCS_singleton_env)
+  env = {} --#env 
   
 end -- env
 
 
 do -- timer
 
-  --- @type timer
-  
+  --- [DCS Singleton timer](https://wiki.hoggitworld.com/view/DCS_singleton_timer)
+  -- @type timer
   
   --- Returns model time in seconds.
   -- @function [parent=#timer] getTime
@@ -110,6 +167,7 @@ do -- timer
   -- @function [parent=#timer] removeFunction
   -- @param functionId Function identifier to remove from schedule 
   
+  --- [DCS Singleton timer](https://wiki.hoggitworld.com/view/DCS_singleton_timer)
   timer = {} --#timer
 
 end 
@@ -117,11 +175,12 @@ end
 
 do -- land
 
-  --- @type land
+  --- [DCS Singleton land](https://wiki.hoggitworld.com/view/DCS_singleton_land)
+  -- @type land
   -- @field #land.SurfaceType SurfaceType
   
-  
-  --- @type land.SurfaceType
+  --- [Type of surface enumerator](https://wiki.hoggitworld.com/view/DCS_singleton_land)
+  -- @type land.SurfaceType
   -- @field LAND
   -- @field SHALLOW_WATER
   -- @field WATER
@@ -138,16 +197,20 @@ do -- land
   -- @param #Vec2 point Point on the land. 
   -- @return #land.SurfaceType
   
+  --- [DCS Singleton land](https://wiki.hoggitworld.com/view/DCS_singleton_land)
   land = {} --#land
 
 end -- land
 
 do -- country
 
-  --- @type country
-  -- @field #country.id id
+  --- [DCS Enum country](https://wiki.hoggitworld.com/view/DCS_enum_country)
+  -- @type country
+  -- @field #country.id id 
   
-  --- @type country.id
+  
+  --- [DCS enumerator country](https://wiki.hoggitworld.com/view/DCS_enum_country)
+  -- @type country.id
   -- @field RUSSIA
   -- @field UKRAINE
   -- @field USA
@@ -223,10 +286,11 @@ do -- country
   -- @field OMAN
   -- @field UNITED_ARAB_EMIRATES
 
-  country = {} -- #country
+  country = {} --#country
 
 end -- country
 
+
 do -- Command
 
   --- @type Command
@@ -239,10 +303,12 @@ end -- Command
 
 do -- coalition
 
-  --- @type coalition
+  --- [DCS Enum coalition](https://wiki.hoggitworld.com/view/DCS_enum_coalition)
+  -- @type coalition
   -- @field #coalition.side side
   
-  --- @type coalition.side
+  --- [DCS Enum coalition.side](https://wiki.hoggitworld.com/view/DCS_enum_coalition)
+  -- @type coalition.side
   -- @field NEUTRAL
   -- @field RED
   -- @field BLUE
@@ -349,7 +415,8 @@ do -- Types
   --- @type Time
   -- @extends #number
   
-  --- A task descriptor (internal structure for DCS World)
+  --- A task descriptor (internal structure for DCS World). See [https://wiki.hoggitworld.com/view/Category:Tasks](https://wiki.hoggitworld.com/view/Category:Tasks).
+  -- In MOOSE, these tasks can be accessed via @{Wrapper.Controllable#CONTROLLABLE}.
   -- @type Task
   -- @field #string id
   -- @field #Task.param param
@@ -363,13 +430,17 @@ do -- Types
 
 end --
 
+
+
 do -- Object
 
-  --- @type Object
+  --- [DCS Class Object](https://wiki.hoggitworld.com/view/DCS_Class_Object)
+  -- @type Object
   -- @field #Object.Category Category
   -- @field #Object.Desc Desc
   
-  --- @type Object.Category
+  --- [DCS Enum Object.Category](https://wiki.hoggitworld.com/view/DCS_Class_Object)
+  -- @type Object.Category
   -- @field UNIT
   -- @field WEAPON
   -- @field STATIC
@@ -439,10 +510,10 @@ end -- Object
 
 do -- CoalitionObject
 
-  --- @type CoalitionObject
+  --- [DCS Class CoalitionObject](https://wiki.hoggitworld.com/view/DCS_Class_Coalition_Object)
+  -- @type CoalitionObject
   -- @extends #Object
   
-  
   --- Returns coalition of the object.
   -- @function [parent=#CoalitionObject] getCoalition
   -- @param #CoalitionObject self
@@ -453,14 +524,135 @@ do -- CoalitionObject
   -- @param #CoalitionObject self
   -- @return #country.id
 
-CoalitionObject = {} --#CoalitionObject
+  CoalitionObject = {} --#CoalitionObject
 
 end -- CoalitionObject
 
 
+do -- Weapon
+
+  --- [DCS Class Weapon](https://wiki.hoggitworld.com/view/DCS_Class_Weapon)
+  -- @type Weapon
+  -- @extends #CoalitionObject
+  -- @field #Weapon.flag flag enum stores weapon flags. Some of them are combination of another flags.
+  -- @field #Weapon.Category Category enum that stores weapon categories.
+  -- @field #Weapon.GuidanceType GuidanceType enum that stores guidance methods. Available only for guided weapon (Weapon.Category.MISSILE and some Weapon.Category.BOMB).
+  -- @field #Weapon.MissileCategory MissileCategory enum that stores missile category. Available only for missiles (Weapon.Category.MISSILE). 
+  -- @field #Weapon.WarheadType WarheadType enum that stores warhead types.
+  -- @field #Weapon.Desc Desc The descriptor of a weapon.
+
+  --- enum stores weapon flags. Some of them are combination of another flags.
+  -- @type Weapon.flag
+  -- @field LGB
+  -- @field TvGB
+  -- @field SNSGB
+  -- @field HEBomb
+  -- @field Penetrator
+  -- @field NapalmBomb
+  -- @field FAEBomb
+  -- @field ClusterBomb
+  -- @field Dispencer
+  -- @field CandleBomb
+  -- @field ParachuteBomb
+  -- @field GuidedBomb = LGB + TvGB + SNSGB
+  -- @field AnyUnguidedBomb  = HEBomb + Penetrator + NapalmBomb + FAEBomb + ClusterBomb + Dispencer + CandleBomb + ParachuteBomb
+  -- @field AnyBomb = GuidedBomb + AnyUnguidedBomb
+  -- @field LightRocket
+  -- @field MarkerRocket
+  -- @field CandleRocket
+  -- @field HeavyRocket
+  -- @field AnyRocket = LightRocket + HeavyRocket + MarkerRocket + CandleRocket
+  -- @field AntiRadarMissile
+  -- @field AntiShipMissile
+  -- @field AntiTankMissile
+  -- @field FireAndForgetASM
+  -- @field LaserASM
+  -- @field TeleASM
+  -- @field CruiseMissile
+  -- @field GuidedASM = LaserASM + TeleASM
+  -- @field TacticASM = GuidedASM + FireAndForgetASM 
+  -- @field AnyASM = AntiRadarMissile + AntiShipMissile + AntiTankMissile + FireAndForgetASM + GuidedASM + CruiseMissile
+  -- @field SRAAM
+  -- @field MRAAM 
+  -- @field LRAAM 
+  -- @field IR_AAM 
+  -- @field SAR_AAM 
+  -- @field AR_AAM 
+  -- @field AnyAAM = IR_AAM + SAR_AAM + AR_AAM + SRAAM + MRAAM + LRAAM 
+  -- @field AnyMissile = AnyASM + AnyAAM
+  -- @field AnyAutonomousMissile = IR_AAM + AntiRadarMissile + AntiShipMissile + FireAndForgetASM + CruiseMissile
+  -- @field GUN_POD
+  -- @field BuiltInCannon
+  -- @field Cannons = GUN_POD + BuiltInCannon 
+  -- @field AnyAGWeapon = BuiltInCannon + GUN_POD + AnyBomb + AnyRocket + AnyASM
+  -- @field AnyAAWeapon = BuiltInCannon + GUN_POD + AnyAAM
+  -- @field UnguidedWeapon = Cannons + BuiltInCannon + GUN_POD + AnyUnguidedBomb + AnyRocket
+  -- @field GuidedWeapon = GuidedBomb + AnyASM + AnyAAM
+  -- @field AnyWeapon = AnyBomb + AnyRocket + AnyMissile + Cannons
+  -- @field MarkerWeapon = MarkerRocket + CandleRocket + CandleBomb
+  -- @field ArmWeapon = AnyWeapon - MarkerWeapon
+
+  --- Weapon.Category enum that stores weapon categories.
+  -- @type Weapon.Category
+  -- @field SHELL
+  -- @field MISSILE
+  -- @field ROCKET
+  -- @field BOMB
+  
+
+  --- Weapon.GuidanceType enum that stores guidance methods. Available only for guided weapon (Weapon.Category.MISSILE and some Weapon.Category.BOMB). 
+  -- @type Weapon.GuidanceType
+  -- @field INS
+  -- @field IR
+  -- @field RADAR_ACTIVE
+  -- @field RADAR_SEMI_ACTIVE
+  -- @field RADAR_PASSIVE
+  -- @field TV
+  -- @field LASER
+  -- @field TELE 
+
+  
+  --- Weapon.MissileCategory enum that stores missile category. Available only for missiles (Weapon.Category.MISSILE). 
+  -- @type Weapon.MissileCategory
+  -- @field AAM
+  -- @field SAM
+  -- @field BM
+  -- @field ANTI_SHIP
+  -- @field CRUISE
+  -- @field OTHER
+
+  --- Weapon.WarheadType enum that stores warhead types. 
+  -- @type Weapon.WarheadType
+  -- @field AP
+  -- @field HE
+  -- @field SHAPED_EXPLOSIVE
+  
+  --- Returns the unit that launched the weapon.
+  -- @function [parent=#Weapon] getLauncher
+  -- @param #Weapon self
+  -- @return #Unit
+  
+  --- returns target of the guided weapon. Unguided weapons and guided weapon that is targeted at the point on the ground will return nil. 
+  -- @function [parent=#Weapon] getTarget
+  -- @param #Weapon self
+  -- @return #Object
+  
+  --- returns weapon descriptor. Descriptor type depends on weapon category.  
+  -- @function [parent=#Weapon] getDesc
+  -- @param #Weapon self
+  -- @return #Weapon.Desc
+
+
+
+  Weapon = {} --#Weapon
+
+end -- Weapon
+
+
 do -- Airbase
 
-  --- Represents airbases: airdromes, helipads and ships with flying decks or landing pads.  
+  --- [DCS Class Airbase](https://wiki.hoggitworld.com/view/DCS_Class_Airbase)
+  -- Represents airbases: airdromes, helipads and ships with flying decks or landing pads.  
   -- @type Airbase
   -- @extends #CoalitionObject
   -- @field #Airbase.ID ID Identifier of an airbase. It assigned to an airbase by the Mission Editor automatically. This identifier is used in AI tasks to refer an airbase that exists (spawned and not dead) or not. 
@@ -888,6 +1080,7 @@ do -- Group
   -- @field HELICOPTER
   -- @field GROUND
   -- @field SHIP
+  -- @field TRAIN
   
   -- Static Functions
   
@@ -912,8 +1105,6 @@ do -- Group
   -- @param #Group self 
   -- @return #Group.Category
   
-  --TODO check coalition.side
-  
   --- Returns the coalition of the group.
   -- @function [parent=#Group] getCoalition
   -- @param #Group self 
@@ -962,12 +1153,14 @@ end -- Group
 
 do -- AI
 
-  --- @type AI
+  --- [https://wiki.hoggitworld.com/view/DCS_enum_AI](https://wiki.hoggitworld.com/view/DCS_enum_AI)
+  -- @type AI
   -- @field #AI.Skill Skill
   -- @field #AI.Task Task
   -- @field #AI.Option Option
   
-  --- @type AI.Skill
+  --- [https://wiki.hoggitworld.com/view/DCS_enum_AI](https://wiki.hoggitworld.com/view/DCS_enum_AI)
+  -- @type AI.Skill
   -- @field AVERAGE
   -- @field GOOD
   -- @field HIGH
@@ -975,7 +1168,8 @@ do -- AI
   -- @field PLAYER
   -- @field CLIENT
   
-  --- @type AI.Task
+  --- [https://wiki.hoggitworld.com/view/DCS_enum_AI](https://wiki.hoggitworld.com/view/DCS_enum_AI)
+  -- @type AI.Task
   -- @field #AI.Task.WeaponExpend WeaponExpend
   -- @field #AI.Task.OrbitPattern OrbitPattern
   -- @field #AI.Task.Designation Designation
@@ -984,7 +1178,8 @@ do -- AI
   -- @field #AI.Task.AltitudeType AltitudeType
   -- @field #AI.Task.VehicleFormation VehicleFormation
   
-  --- @type AI.Task.WeaponExpend
+  --- [https://wiki.hoggitworld.com/view/DCS_enum_AI](https://wiki.hoggitworld.com/view/DCS_enum_AI)
+  -- @type AI.Task.WeaponExpend
   -- @field ONE
   -- @field TWO
   -- @field FOUR
@@ -992,11 +1187,13 @@ do -- AI
   -- @field HALF
   -- @field ALL
   
-  --- @type AI.Task.OrbitPattern
+  --- [https://wiki.hoggitworld.com/view/DCS_enum_AI](https://wiki.hoggitworld.com/view/DCS_enum_AI)
+  -- @type AI.Task.OrbitPattern
   -- @field CIRCLE
   -- @field RACE_TRACK
   
-  --- @type AI.Task.Designation
+  --- [https://wiki.hoggitworld.com/view/DCS_enum_AI](https://wiki.hoggitworld.com/view/DCS_enum_AI)
+  -- @type AI.Task.Designation
   -- @field NO
   -- @field AUTO
   -- @field WP
@@ -1121,7 +1318,4 @@ do -- AI
   
   AI = {} --#AI
 
-end -- AI
-
-
-
+end -- AI

Moose Development/Moose/Functional/ATC_Ground.lua

@@ -1,10 +1,20 @@
---- **Functional** -- The ATC\_GROUND classes monitor airbase traffic and regulate speed while taxiing.
+--- **Functional** -- Monitor airbase traffic and regulate speed while taxiing.
 --
 -- ===
+--
+-- ## Features:
 -- 
--- ![Banner Image](..\Presentations\ATC_GROUND\Dia1.JPG)
+--   * Monitor speed of the airplanes of players during taxi.
+--   * Communicate ATC ground operations.
+--   * Kick speeding players during taxi.
 -- 
 -- ===
+-- 
+-- ## Missions:
+-- 
+-- [ABP - Airbase Police](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/ABP%20-%20Airbase%20Police)
+--
+-- ===
 --
 -- ### Contributions: Dutch Baron - Concept & Testing
 -- ### Author: FlightControl - Framework Design &  Programming
@@ -115,6 +125,7 @@ end
 --   Atc_Ground = ATC_GROUND_CAUCAUS:New()
 --   Atc_Ground = ATC_GROUND_NEVADA:New()
 --   Atc_Ground = ATC_GROUND_NORMANDY:New()
+--   Atc_Ground = ATC_GROUND_PERSIANGULF:New()
 --   
 --   -- Then use one of these methods...
 -- 
@@ -180,6 +191,7 @@ end
 --   Atc_Ground = ATC_GROUND_CAUCAUS:New()
 --   Atc_Ground = ATC_GROUND_NEVADA:New()
 --   Atc_Ground = ATC_GROUND_NORMANDY:New()
+--   Atc_Ground = ATC_GROUND_PERSIANGULF:New()
 --   
 --   -- Then use one of these methods...
 -- 
@@ -263,7 +275,7 @@ function ATC_GROUND:_AirbaseMonitor()
                 self:E( Taxi )
                 if Taxi == false then
                   local Velocity = VELOCITY:New( AirbaseMeta.KickSpeed or self.KickSpeed )
-                  Client:Message( "Welcome at " .. AirbaseID .. ". The maximum taxiing speed is " .. 
+                  Client:Message( "Welcome to " .. AirbaseID .. ". The maximum taxiing speed is " .. 
                                   Velocity:ToString() , 20, "ATC" )
                   Client:SetState( self, "Taxi", true )
                 end
@@ -287,7 +299,7 @@ function ATC_GROUND:_AirbaseMonitor()
                   end
                   if Speeding == true then
                     MESSAGE:New( "Penalty! Player " .. Client:GetPlayerName() .. 
-                                 " is kicked, due to a severe airbase traffic rule violation ...", 10, "ATC" ):ToAll()
+                                 " has been kicked, due to a severe airbase traffic rule violation ...", 10, "ATC" ):ToAll()
                     Client:Destroy()
                     Client:SetState( self, "Speeding", false )
                     Client:SetState( self, "Warnings", 0 )
@@ -319,7 +331,7 @@ function ATC_GROUND:_AirbaseMonitor()
                                         Velocity:ToString(), 5, "ATC" )
                         Client:SetState( self, "Warnings", SpeedingWarnings + 1 )
                       else
-                        MESSAGE:New( "Penalty! Player " .. Client:GetPlayerName() .. " is kicked, due to a severe airbase traffic rule violation ...", 10, "ATC" ):ToAll()
+                        MESSAGE:New( "Penalty! Player " .. Client:GetPlayerName() .. " has been kicked, due to a severe airbase traffic rule violation ...", 10, "ATC" ):ToAll()
                         --- @param Wrapper.Client#CLIENT Client
                         Client:Destroy()
                         Client:SetState( self, "Speeding", false )
@@ -351,7 +363,7 @@ function ATC_GROUND:_AirbaseMonitor()
                       Client:Message( "Warning " .. OffRunwayWarnings .. "/3! Airbase traffic rule violation! Get back on the taxi immediately!", 5, "ATC" )
                       Client:SetState( self, "OffRunwayWarnings", OffRunwayWarnings + 1 )
                     else
-                      MESSAGE:New( "Penalty! Player " .. Client:GetPlayerName() .. " is kicked, due to a severe airbase traffic rule violation ...", 10, "ATC" ):ToAll()
+                      MESSAGE:New( "Penalty! Player " .. Client:GetPlayerName() .. " has been kicked, due to a severe airbase traffic rule violation ...", 10, "ATC" ):ToAll()
                       --- @param Wrapper.Client#CLIENT Client
                       Client:Destroy()
                       Client:SetState( self, "IsOffRunway", false )
@@ -776,8 +788,6 @@ function ATC_GROUND_CAUCASUS:New( AirbaseNames )
   -- Inherits from BASE
   local self = BASE:Inherit( self, ATC_GROUND:New( self.Airbases, AirbaseNames ) )
 
-  self.AirbaseMonitor = SCHEDULER:New( self, self._AirbaseMonitor, { self }, 0, 2, 0.05 )
-
   self:SetKickSpeedKmph( 50 )
   self:SetMaximumKickSpeedKmph( 150 )
 
@@ -990,6 +1000,15 @@ function ATC_GROUND_CAUCASUS:New( AirbaseNames )
 end
 
 
+--- Start SCHEDULER for ATC_GROUND_CAUCASUS object.
+-- @param #ATC_GROUND_CAUCASUS self
+-- @param RepeatScanSeconds Time in second for defining occurency of alerts.
+-- @return nothing
+function ATC_GROUND_CAUCASUS:Start( RepeatScanSeconds )
+  RepeatScanSeconds = RepeatScanSeconds or 0.05
+  self.AirbaseMonitor = SCHEDULER:New( self, self._AirbaseMonitor, { self }, 0, 2, RepeatScanSeconds )
+end
+
 
 
 --- @type ATC_GROUND_NEVADA
@@ -1367,8 +1386,6 @@ function ATC_GROUND_NEVADA:New( AirbaseNames )
   -- Inherits from BASE
   local self = BASE:Inherit( self, ATC_GROUND:New( self.Airbases, AirbaseNames ) )
 
-  self.AirbaseMonitor = SCHEDULER:New( self, self._AirbaseMonitor, { self }, 0, 2, 0.05 )
-
   self:SetKickSpeedKmph( 50 )
   self:SetMaximumKickSpeedKmph( 150 )
 
@@ -1532,6 +1549,16 @@ function ATC_GROUND_NEVADA:New( AirbaseNames )
   return self
 end
 
+--- Start SCHEDULER for ATC_GROUND_NEVADA object.
+-- @param #ATC_GROUND_NEVADA self
+-- @param RepeatScanSeconds Time in second for defining occurency of alerts.
+-- @return nothing
+function ATC_GROUND_NEVADA:Start( RepeatScanSeconds )
+  RepeatScanSeconds = RepeatScanSeconds or 0.05
+  self.AirbaseMonitor = SCHEDULER:New( self, self._AirbaseMonitor, { self }, 0, 2, RepeatScanSeconds )
+end
+
+
 --- @type ATC_GROUND_NORMANDY
 -- @extends #ATC_GROUND
 
@@ -1547,7 +1574,7 @@ end
 -- 
 -- ---
 -- 
--- The default maximum speed for the airbases at Caucasus is **40 km/h**. Warnings are given if this speed limit is trespassed.
+-- The default maximum speed for the airbases at Normandy is **40 km/h**. Warnings are given if this speed limit is trespassed.
 -- Players will be immediately kicked when driving faster than **100 km/h** on the taxi way.
 -- 
 -- The ATC\_GROUND\_NORMANDY class monitors the speed of the airplanes at the airbase during taxi.
@@ -2021,8 +2048,6 @@ function ATC_GROUND_NORMANDY:New( AirbaseNames )
 
   -- Inherits from BASE
   local self = BASE:Inherit( self, ATC_GROUND:New( self.Airbases, AirbaseNames ) ) -- #ATC_GROUND_NORMANDY
-
-  self.AirbaseMonitor = SCHEDULER:New( self, self._AirbaseMonitor, { self }, 0, 2, 0.05 )
   
   self:SetKickSpeedKmph( 40 )
   self:SetMaximumKickSpeedKmph( 100 )
@@ -2306,6 +2331,856 @@ function ATC_GROUND_NORMANDY:New( AirbaseNames )
 end
 
      
+--- Start SCHEDULER for ATC_GROUND_NORMANDY object.
+-- @param #ATC_GROUND_NORMANDY self
+-- @param RepeatScanSeconds Time in second for defining occurency of alerts.
+-- @return nothing
+function ATC_GROUND_NORMANDY:Start( RepeatScanSeconds )
+  RepeatScanSeconds = RepeatScanSeconds or 0.05
+  self.AirbaseMonitor = SCHEDULER:New( self, self._AirbaseMonitor, { self }, 0, 2, RepeatScanSeconds )
+end
+
+--- @type ATC_GROUND_PERSIANGULF
+-- @extends #ATC_GROUND
+
+
+--- # ATC\_GROUND\_PERSIANGULF, extends @{#ATC_GROUND}
+-- 
+-- The ATC\_GROUND\_PERSIANGULF class monitors the speed of the airplanes at the airbase during taxi.
+-- The pilots may not drive faster than the maximum speed for the airbase, or they will be despawned.
+-- 
+-- ---
+-- 
+-- ![Banner Image](..\Presentations\ATC_GROUND\Dia1.JPG)
+-- 
+-- ---
+-- 
+-- The default maximum speed for the airbases at Persian Gulf is **50 km/h**. Warnings are given if this speed limit is trespassed.
+-- Players will be immediately kicked when driving faster than **150 km/h** on the taxi way.
+-- 
+-- The ATC\_GROUND\_PERSIANGULF class monitors the speed of the airplanes at the airbase during taxi.
+-- The pilots may not drive faster than the maximum speed for the airbase, or they will be despawned.
+-- 
+-- The pilot will receive 3 times a warning during speeding. After the 3rd warning, if the pilot is still driving
+-- faster than the maximum allowed speed, the pilot will be kicked.
+-- 
+-- Different airbases have different maximum speeds, according safety regulations.
+-- 
+-- # Airbases monitored
+-- 
+-- The following airbases are monitored at the PersianGulf region.
+-- Use the @{Wrapper.Airbase#AIRBASE.PersianGulf} enumeration to select the airbases to be monitored.
+-- 
+--   * `AIRBASE.PersianGulf.Abu_Musa_Island_Airport`
+--   * `AIRBASE.PersianGulf.Al_Dhafra_AB`
+--   * `AIRBASE.PersianGulf.Al_Maktoum_Intl`
+--   * `AIRBASE.PersianGulf.Al_Minhad_AB`
+--   * `AIRBASE.PersianGulf.Bandar_Abbas_Intl`
+--   * `AIRBASE.PersianGulf.Bandar_Lengeh`
+--   * `AIRBASE.PersianGulf.Dubai_Intl`
+--   * `AIRBASE.PersianGulf.Fujairah_Intl`
+--   * `AIRBASE.PersianGulf.Havadarya`
+--   * `AIRBASE.PersianGulf.Kerman_Airport`
+--   * `AIRBASE.PersianGulf.Khasab`
+--   * `AIRBASE.PersianGulf.Lar_Airbase`
+--   * `AIRBASE.PersianGulf.Qeshm_Island`
+--   * `AIRBASE.PersianGulf.Sharjah_Intl`
+--   * `AIRBASE.PersianGulf.Shiraz_International_Airport`
+--   * `AIRBASE.PersianGulf.Sir_Abu_Nuayr`
+--   * `AIRBASE.PersianGulf.Sirri_Island`
+--   * `AIRBASE.PersianGulf.Tunb_Island_AFB`
+--   * `AIRBASE.PersianGulf.Tunb_Kochak`
+--   * `AIRBASE.PersianGulf.Sas_Al_Nakheel_Airport`
+--   * `AIRBASE.PersianGulf.Bandar_e_Jask_airfield`
+--   * `AIRBASE.PersianGulf.Abu_Dhabi_International_Airport`
+--   * `AIRBASE.PersianGulf.Al_Bateen_Airport`
+--   * `AIRBASE.PersianGulf.Kish_International_Airport`
+--   * `AIRBASE.PersianGulf.Al_Ain_International_Airport`
+--   * `AIRBASE.PersianGulf.Lavan_Island_Airport`
+--   * `AIRBASE.PersianGulf.Jiroft_Airport`
+--
+-- # Installation
+-- 
+-- ## In Single Player Missions
+-- 
+-- ATC\_GROUND is fully functional in single player.
+-- 
+-- ## In Multi Player Missions
+-- 
+-- ATC\_GROUND is functional in multi player, however ...
+-- 
+-- Due to a bug in DCS since release 1.5, the despawning of clients are not anymore working in multi player.
+-- To **work around this problem**, a much better solution has been made, using the **slot blocker** script designed
+-- by Ciribob. 
+-- 
+-- With the help of __Ciribob__, this script has been extended to also kick client players while in flight.
+-- ATC\_GROUND is communicating with this modified script to kick players!
+-- 
+-- Install the file **SimpleSlotBlockGameGUI.lua** on the server, following the installation instructions described by Ciribob.
+-- 
+-- [Simple Slot Blocker from Ciribob & FlightControl](https://github.com/ciribob/DCS-SimpleSlotBlock)
+-- 
+-- # Script it!
+-- 
+-- ## 1. ATC_GROUND_PERSIANGULF Constructor
+-- 
+-- Creates a new ATC_GROUND_PERSIANGULF object that will monitor pilots taxiing behaviour.
+-- 
+--     -- This creates a new ATC_GROUND_PERSIANGULF object.
+-- 
+--     -- Monitor for these clients the airbases.
+--     AirbasePoliceCaucasus = ATC_GROUND_PERSIANGULF:New()
+--     
+--     ATC_Ground = ATC_GROUND_PERSIANGULF:New( 
+--       { AIRBASE.PersianGulf.Kerman_Airport,
+--         AIRBASE.PersianGulf.Al_Minhad_AB 
+--       } 
+--     )
+-- 
+--     
+-- ## 2. Set various options
+-- 
+-- There are various methods that you can use to tweak the behaviour of the ATC\_GROUND classes.
+-- 
+-- ### 2.1 Speed limit at an airbase.
+-- 
+--   * @{#ATC_GROUND.SetKickSpeed}(): Set the speed limit allowed at an airbase in meters per second.
+--   * @{#ATC_GROUND.SetKickSpeedKmph}(): Set the speed limit allowed at an airbase in kilometers per hour.
+--   * @{#ATC_GROUND.SetKickSpeedMiph}(): Set the speed limit allowed at an airbase in miles per hour.
+--   
+-- ### 2.2 Prevent Takeoff at an airbase. Players will be kicked immediately.
+-- 
+--   * @{#ATC_GROUND.SetMaximumKickSpeed}(): Set the maximum speed allowed at an airbase in meters per second. 
+--   * @{#ATC_GROUND.SetMaximumKickSpeedKmph}(): Set the maximum speed allowed at an airbase in kilometers per hour.
+--   * @{#ATC_GROUND.SetMaximumKickSpeedMiph}(): Set the maximum speed allowed at an airbase in miles per hour.
+--   
+-- @field #ATC_GROUND_PERSIANGULF
+ATC_GROUND_PERSIANGULF = {
+  ClassName = "ATC_GROUND_PERSIANGULF",
+  Airbases = {
+    [AIRBASE.PersianGulf.Abu_Musa_Island_Airport] = {
+      PointsRunways = {
+        [1] = {
+          [1]={["y"]=-122813.71002344,["x"]=-31689.936027827,},
+          [2]={["y"]=-122827.82488722,["x"]=-31590.105445836,},
+          [3]={["y"]=-122769.5689949,["x"]=-31583.176330891,},
+          [4]={["y"]=-122726.96776968,["x"]=-31614.998932862,},
+          [5]={["y"]=-121293.92414543,["x"]=-31467.947715689,},
+          [6]={["y"]=-121296.4904843,["x"]=-31432.018971528,},
+          [7]={["y"]=-121236.18152088,["x"]=-31424.576588809,},
+          [8]={["y"]=-121190.50068902,["x"]=-31458.452261875,},
+          [9]={["y"]=-119839.83654246,["x"]=-31319.356695194,},
+          [10]={["y"]=-119824.69514313,["x"]=-31423.293419374,},
+          [11]={["y"]=-119886.80054375,["x"]=-31430.22253432,},
+          [12]={["y"]=-119932.22474173,["x"]=-31395.320325706,},
+          [13]={["y"]=-122813.9472789,["x"]=-31689.81193251,},
+        },
+      },
+    },
+    [AIRBASE.PersianGulf.Abu_Musa_Island_Airport] = {
+      PointsRunways = {
+        [1] = {
+          [1]={["y"]=-174672.06004916,["x"]=-209880.97145616,},
+          [2]={["y"]=-174705.15693282,["x"]=-209923.15131918,},
+          [3]={["y"]=-171819.05380065,["x"]=-212172.84298281,},
+          [4]={["y"]=-171785.09826475,["x"]=-212129.87417284,},
+          [5]={["y"]=-174671.96413454,["x"]=-209880.52453983,},
+        },
+      [2] = {
+          [1]={["y"]=-174351.95872272,["x"]=-211813.88516693,},
+          [2]={["y"]=-174381.29169939,["x"]=-211851.81242636,},
+          [3]={["y"]=-171493.65648904,["x"]=-214102.92235002,},
+          [4]={["y"]=-171464.99693831,["x"]=-214062.78788361,},
+          [5]={["y"]=-174351.8628081,["x"]=-211813.4382506,},
+        },
+      },
+    },
+    [AIRBASE.PersianGulf.Al_Maktoum_Intl] = {
+      PointsRunways = {
+        [1] = {
+          [1]={["y"]=-111879.49046471,["x"]=-138953.80105841,},
+          [2]={["y"]=-111917.23447224,["x"]=-139018.2804046,},
+          [3]={["y"]=-108092.98121312,["x"]=-141406.67838426,},
+          [4]={["y"]=-108052.34416748,["x"]=-141341.82058294,},
+          [5]={["y"]=-111879.5412879,["x"]=-138952.87693763,},
+        },
+      },
+    },
+    [AIRBASE.PersianGulf.Al_Minhad_AB] = {
+      PointsRunways = {
+        [1] = {
+          [1]={["y"]=-91070.628933035,["x"]=-125989.64095162,},
+          [2]={["y"]=-91072.346560159,["x"]=-126040.59722299,},
+          [3]={["y"]=-87098.282779771,["x"]=-126039.41747017,},
+          [4]={["y"]=-87099.632735396,["x"]=-125991.26905291,},
+          [5]={["y"]=-91071.031270042,["x"]=-125987.44617225,},
+        },
+      },
+    },
+    [AIRBASE.PersianGulf.Bandar_Abbas_Intl] = {
+      PointsRunways = {
+        [1] = {
+          [1]={["y"]=12988.484058788,["x"]=113979.99250505,},
+          [2]={["y"]=13037.8836239,["x"]=113952.60241152,},
+          [3]={["y"]=14877.313199902,["x"]=117414.37833333,},
+          [4]={["y"]=14828.777486364,["x"]=117439.06043783,},
+          [5]={["y"]=12988.939584604,["x"]=113979.52494386,},
+        },
+        [2] = {
+          [1]={["y"]=13203.406014284,["x"]=113848.44907555,},
+          [2]={["y"]=13258.268500181,["x"]=113818.47303925,},
+          [3]={["y"]=15315.015323566,["x"]=117694.27156647,},
+          [4]={["y"]=15264.815746383,["x"]=117725.22168173,},
+          [5]={["y"]=13203.861540099,["x"]=113847.98151436,},
+        },
+      },
+    },
+    [AIRBASE.PersianGulf.Bandar_Lengeh] = {
+      PointsRunways = {
+        [1] = {
+          [1]={["y"]=-142373.15541415,["x"]=41364.94047809,},
+          [2]={["y"]=-142363.30071107,["x"]=41298.112282592,},
+          [3]={["y"]=-142217.57151662,["x"]=41320.35666061,},
+          [4]={["y"]=-142213.00856728,["x"]=41291.838227254,},
+          [5]={["y"]=-142131.44584788,["x"]=41301.534494595,},
+          [6]={["y"]=-142132.58658522,["x"]=41323.778872613,},
+          [7]={["y"]=-142123.17550221,["x"]=41336.041798956,},
+          [8]={["y"]=-139580.45381288,["x"]=41711.022304533,},
+          [9]={["y"]=-139590.04241918,["x"]=41778.350996659,},
+          [10]={["y"]=-139732.41237808,["x"]=41757.089304408,},
+          [11]={["y"]=-139736.7897853,["x"]=41785.646675372,},
+          [12]={["y"]=-139816.41690726,["x"]=41775.641173137,},
+          [13]={["y"]=-139816.00001133,["x"]=41754.58792885,},
+          [14]={["y"]=-139824.1294819,["x"]=41743.748634761,},
+          [15]={["y"]=-142373.20183966,["x"]=41365.161507021,},
+        },
+      },
+    },
+    [AIRBASE.PersianGulf.Dubai_Intl] = {
+      PointsRunways = {
+        [1] = {
+          [1]={["y"]=-89693.511670714,["x"]=-100490.47082052,},
+          [2]={["y"]=-89731.488328846,["x"]=-100555.50584758,},
+          [3]={["y"]=-85706.437275049,["x"]=-103076.68123933,},
+          [4]={["y"]=-85669.519216262,["x"]=-103010.44994755,},
+          [5]={["y"]=-89693.036962487,["x"]=-100489.9961123,},
+        },
+        [2] = {
+          [1]={["y"]=-90797.505501889,["x"]=-99344.082465487,},
+          [2]={["y"]=-90835.482160021,["x"]=-99409.11749254,},
+          [3]={["y"]=-87210.216900398,["x"]=-101681.72494832,},
+          [4]={["y"]=-87171.474397253,["x"]=-101619.20256393,},
+          [5]={["y"]=-90797.030793662,["x"]=-99343.607757261,},
+        },
+      },
+    },
+    [AIRBASE.PersianGulf.Fujairah_Intl] = {
+      PointsRunways = {
+        [1] = {
+          [1]={["y"]=5808.8716147284,["x"]=-116602.15633995,},
+          [2]={["y"]=5781.9885293892,["x"]=-116666.67574476,},
+          [3]={["y"]=9435.1910907931,["x"]=-118192.91910235,},
+          [4]={["y"]=9459.878635843,["x"]=-118134.40047704,},
+          [5]={["y"]=5808.4078522575,["x"]=-116603.31550719,},
+        },
+      },
+    },
+    [AIRBASE.PersianGulf.Havadarya] = {
+      PointsRunways = {
+        [1] = {
+          [1]={["y"]=-7565.4887830428,["x"]=109074.13162774,},
+          [2]={["y"]=-7557.8281079193,["x"]=109030.65729641,},
+          [3]={["y"]=-4987.3556518085,["x"]=109524.49147773,},
+          [4]={["y"]=-4996.215358578,["x"]=109566.57508489,},
+          [5]={["y"]=-7565.4936338604,["x"]=109074.32262205,},
+        },
+      },
+    },
+    [AIRBASE.PersianGulf.Kerman_Airport] = {
+      PointsRunways = {
+        [1] = {
+          [1]={["y"]=70375.468628778,["x"]=456046.12685302,},
+          [2]={["y"]=70297.050081575,["x"]=456015.1578105,},
+          [3]={["y"]=71814.291673715,["x"]=452165.51037702,},
+          [4]={["y"]=71902.918622452,["x"]=452188.46411914,},
+          [5]={["y"]=70860.465673482,["x"]=454829.89695989,},
+          [6]={["y"]=70862.525255971,["x"]=454892.77675983,},
+          [7]={["y"]=70816.157465062,["x"]=454922.77944807,},
+          [8]={["y"]=70462.749176371,["x"]=455833.38051827,},
+          [9]={["y"]=70483.400377364,["x"]=455901.17880077,},
+          [10]={["y"]=70453.787334431,["x"]=455974.8217628,},
+          [11]={["y"]=70405.860962315,["x"]=455961.57382254,},
+          [12]={["y"]=70374.689338175,["x"]=456046.51649833,},
+        },
+      },
+    },
+    [AIRBASE.PersianGulf.Khasab] = {
+      PointsRunways = {
+        [1] = {
+          [1]={["y"]=-534.81827307392,["x"]=-1495.070060483,},
+          [2]={["y"]=-434.82912685139,["x"]=-1519.8421462589,},
+          [3]={["y"]=-405.55302547993,["x"]=-1413.0969766429,},
+          [4]={["y"]=-424.92029254105,["x"]=-1352.0675653224,},
+          [5]={["y"]=216.05735069389,["x"]=1206.9187095195,},
+          [6]={["y"]=116.42961315781,["x"]=1229.9576238247,},
+          [7]={["y"]=88.253643635887,["x"]=1123.7918160128,},
+          [8]={["y"]=101.1741158476,["x"]=1042.6886109249,},
+          [9]={["y"]=-535.31436058928,["x"]=-1494.8762081291,},
+        },
+      },
+    },
+    [AIRBASE.PersianGulf.Lar_Airbase] = {
+      PointsRunways = {
+        [1] = {
+          [1]={["y"]=-183987.5454359,["x"]=169021.72039309,},
+          [2]={["y"]=-183988.41292374,["x"]=168955.27082471,},
+          [3]={["y"]=-180847.92031188,["x"]=168930.46175795,},
+          [4]={["y"]=-180806.58653731,["x"]=168888.39641215,},
+          [5]={["y"]=-180740.37934087,["x"]=168886.56748407,},
+          [6]={["y"]=-180735.62412787,["x"]=168932.65647164,},
+          [7]={["y"]=-180685.14571291,["x"]=168934.11961411,},
+          [8]={["y"]=-180682.5852136,["x"]=169001.78995301,},
+          [9]={["y"]=-183987.48111493,["x"]=169021.35002828,},
+        },
+      },
+    },
+    [AIRBASE.PersianGulf.Qeshm_Island] = {
+      PointsRunways = {
+        [1] = {
+          [1]={["y"]=-35140.372717152,["x"]=63373.658918509,},
+          [2]={["y"]=-35098.556715749,["x"]=63320.377239302,},
+          [3]={["y"]=-34991.318905699,["x"]=63408.730403557,},
+          [4]={["y"]=-34984.574389344,["x"]=63401.311435566,},
+          [5]={["y"]=-34991.993357335,["x"]=63313.632722947,},
+          [6]={["y"]=-34956.921872287,["x"]=63265.746656824,},
+          [7]={["y"]=-34917.129225791,["x"]=63261.699947011,},
+          [8]={["y"]=-34832.822771349,["x"]=63337.23853019,},
+          [9]={["y"]=-34915.105870884,["x"]=63436.382920614,},
+          [10]={["y"]=-34906.337999622,["x"]=63478.198922017,},
+          [11]={["y"]=-32728.533668488,["x"]=65307.986209216,},
+          [12]={["y"]=-32676.600892552,["x"]=65299.218337954,},
+          [13]={["y"]=-32623.99366498,["x"]=65334.964274638,},
+          [14]={["y"]=-32626.691471522,["x"]=65388.92040548,},
+          [15]={["y"]=-31822.745121968,["x"]=66067.418750826,},
+          [16]={["y"]=-31777.556862387,["x"]=66068.767654097,},
+          [17]={["y"]=-31691.227053039,["x"]=65974.344425122,},
+          [18]={["y"]=-31606.246146962,["x"]=66042.464040311,},
+          [19]={["y"]=-31602.199437148,["x"]=66084.280041714,},
+          [20]={["y"]=-31632.549760747,["x"]=66124.747139846,},
+          [21]={["y"]=-31727.647441358,["x"]=66134.189462744,},
+          [22]={["y"]=-31734.391957713,["x"]=66141.608430735,},
+          [23]={["y"]=-31632.549760747,["x"]=66225.914885176,},
+          [24]={["y"]=-31673.691310515,["x"]=66277.173209477,},
+          [25]={["y"]=-35140.880825624,["x"]=63373.905965825,},
+        },
+      },
+    },
+    [AIRBASE.PersianGulf.Sharjah_Intl] = {
+      PointsRunways = {
+        [1] = {
+          [1]={["y"]=-71668.808658476,["x"]=-93980.156242153,},
+          [2]={["y"]=-75307.847363315,["x"]=-91617.097584505,},
+          [3]={["y"]=-75280.458023829,["x"]=-91574.709321014,},
+          [4]={["y"]=-72249.697184234,["x"]=-93529.134331507,},
+          [5]={["y"]=-72179.919581256,["x"]=-93526.199759419,},
+          [6]={["y"]=-72138.183444896,["x"]=-93597.933743788,},
+          [7]={["y"]=-71638.654062835,["x"]=-93927.584008321,},
+          [8]={["y"]=-71668.325847279,["x"]=-93979.428115206,},
+        },
+        [2] = {
+          [1]={["y"]=-71553.225408723,["x"]=-93775.312323319,},
+          [2]={["y"]=-75168.13829548,["x"]=-91426.51571111,},
+          [3]={["y"]=-75125.388157445,["x"]=-91363.754870166,},
+          [4]={["y"]=-71510.511081666,["x"]=-93703.252275385,},
+          [5]={["y"]=-71552.247218027,["x"]=-93775.638386885,},
+        },
+      },
+    },
+    [AIRBASE.PersianGulf.Shiraz_International_Airport] = {
+      PointsRunways = {
+        [1] = {
+          [1]={["y"]=-353995.75579778,["x"]=382327.42294273,},
+          [2]={["y"]=-354029.77009807,["x"]=382265.46199492,},
+          [3]={["y"]=-349407.98049238,["x"]=379941.14030526,},
+          [4]={["y"]=-349376.87025024,["x"]=380004.69408564,},
+          [5]={["y"]=-353995.71101815,["x"]=382327.59771695,},
+        },
+        [2] = {
+          [1]={["y"]=-354056.29510012,["x"]=381845.97598829,},
+          [2]={["y"]=-354091.48797289,["x"]=381783.6025623,},
+          [3]={["y"]=-349650.64038107,["x"]=379550.92898242,},
+          [4]={["y"]=-349624.41889127,["x"]=379614.92719482,},
+          [5]={["y"]=-354056.25032049,["x"]=381846.15076251,},
+        },
+      },
+    },
+    [AIRBASE.PersianGulf.Sir_Abu_Nuayr] = {
+      PointsRunways = {
+        [1] = {
+          [1]={["y"]=-203367.3128691,["x"]=-103017.22553918,},
+          [2]={["y"]=-203373.59664477,["x"]=-103054.92819323,},
+          [3]={["y"]=-202578.27577922,["x"]=-103188.26018333,},
+          [4]={["y"]=-202571.37254488,["x"]=-103151.01482599,},
+          [5]={["y"]=-203367.65259839,["x"]=-103016.48202662,},
+          [6]={["y"]=-203291.39594004,["x"]=-102985.49774228,},
+        },
+      },
+    },
+    [AIRBASE.PersianGulf.Sirri_Island] = {
+      PointsRunways = {
+        [1] = {
+          [1]={["y"]=-169713.12842428,["x"]=-27766.658020853,},
+          [2]={["y"]=-169682.02009414,["x"]=-27726.583172021,},
+          [3]={["y"]=-169727.21866794,["x"]=-27691.632048154,},
+          [4]={["y"]=-169694.28043602,["x"]=-27650.276268081,},
+          [5]={["y"]=-169763.08474269,["x"]=-27598.490047901,},
+          [6]={["y"]=-169825.30140298,["x"]=-27607.090586235,},
+          [7]={["y"]=-171614.98889813,["x"]=-26246.247907014,},
+          [8]={["y"]=-171620.85326172,["x"]=-26187.105176343,},
+          [9]={["y"]=-171686.10990337,["x"]=-26138.56820961,},
+          [10]={["y"]=-171716.55468456,["x"]=-26178.745338885,},
+          [11]={["y"]=-171764.9668776,["x"]=-26142.810515186,},
+          [12]={["y"]=-171796.29599657,["x"]=-26183.416460911,},
+          [13]={["y"]=-169713.5628285,["x"]=-27766.883787223,},
+        },
+      },
+    },
+    [AIRBASE.PersianGulf.Tunb_Island_AFB] = {
+      PointsRunways = {
+        [1] = {
+          [1]={["y"]=-92923.634698863,["x"]=9547.6862547173,},
+          [2]={["y"]=-92963.030803298,["x"]=9565.7274614215,},
+          [3]={["y"]=-92934.128053782,["x"]=9619.2987996964,},
+          [4]={["y"]=-92970.946842975,["x"]=9640.1014155901,},
+          [5]={["y"]=-92949.591945243,["x"]=9682.8112110532,},
+          [6]={["y"]=-92899.518391942,["x"]=9699.7478540817,},
+          [7]={["y"]=-91969.13471408,["x"]=11464.627292768,},
+          [8]={["y"]=-91983.666755417,["x"]=11515.293058512,},
+          [9]={["y"]=-91960.101282978,["x"]=11557.710908902,},
+          [10]={["y"]=-91921.021874517,["x"]=11539.251288825,},
+          [11]={["y"]=-91893.725202275,["x"]=11589.720675632,},
+          [12]={["y"]=-91859.751646175,["x"]=11571.850192366,},
+          [13]={["y"]=-92922.149728329,["x"]=9547.2937058617,},
+        },
+      },
+    },
+    [AIRBASE.PersianGulf.Tunb_Kochak] = {
+      PointsRunways = {
+        [1] = {
+          [1]={["y"]=-109925.50271188,["x"]=8974.5666013181,},
+          [2]={["y"]=-109905.7382908,["x"]=8937.53274444,},
+          [3]={["y"]=-109009.93726324,["x"]=9072.2234968343,},
+          [4]={["y"]=-109040.82867587,["x"]=9104.9871291834,},
+          [5]={["y"]=-109925.26515172,["x"]=8974.091480998,},
+        },
+      },
+    },
+    [AIRBASE.PersianGulf.Sas_Al_Nakheel_Airport] = {
+      PointsRunways = {
+        [1] = {
+          [1]={["y"]=-176230.75865538,["x"]=-188732.01369812,},
+          [2]={["y"]=-176274.78045186,["x"]=-188744.8049371,},
+          [3]={["y"]=-175692.03171595,["x"]=-190564.17145168,},
+          [4]={["y"]=-175649.7486572,["x"]=-190550.58435053,},
+          [5]={["y"]=-176230.66274076,["x"]=-188731.5667818,},
+        },
+      },
+    },
+    [AIRBASE.PersianGulf.Bandar_e_Jask_airfield] = {
+      PointsRunways = {
+        [1] = {
+          [1]={["y"]=155156.73167657,["x"]=-57837.031277333,},
+          [2]={["y"]=155130.38996239,["x"]=-57790.475605714,},
+          [3]={["y"]=157137.17872571,["x"]=-56710.411783359,},
+          [4]={["y"]=157148.46631801,["x"]=-56688.071756941,},
+          [5]={["y"]=157220.07198163,["x"]=-56649.035500253,},
+          [6]={["y"]=157227.83220133,["x"]=-56662.204357931,},
+          [7]={["y"]=157359.6383572,["x"]=-56590.481115222,},
+          [8]={["y"]=157383.03659539,["x"]=-56633.044744502,},
+          [9]={["y"]=155156.7940421,["x"]=-57837.149989814,},
+        },
+      },
+    },
+    [AIRBASE.PersianGulf.Abu_Dhabi_International_Airport] = {
+      PointsRunways = {
+        [1] = {
+          [1]={["y"]=-163964.56943899,["x"]=-189427.63621921,},
+          [2]={["y"]=-164005.96838287,["x"]=-189478.90226888,},
+          [3]={["y"]=-160798.22080495,["x"]=-192054.59531727,},
+          [4]={["y"]=-160755.05282258,["x"]=-192002.58569997,},
+          [5]={["y"]=-163964.47352437,["x"]=-189427.18930288,},
+        },
+        [2] = {
+          [1]={["y"]=-163615.44952024,["x"]=-187144.00786922,},
+          [2]={["y"]=-163656.84846411,["x"]=-187195.27391888,},
+          [3]={["y"]=-160452.71811093,["x"]=-189764.86593382,},
+          [4]={["y"]=-160411.94568221,["x"]=-189715.47961171,},
+          [5]={["y"]=-163615.35360562,["x"]=-187143.56095289,},
+        },
+      },
+    },
+    [AIRBASE.PersianGulf.Al_Bateen_Airport] = {
+      PointsRunways = {
+        [1] = {
+          [1]={["y"]=-183207.51774197,["x"]=-189871.8319832,},
+          [2]={["y"]=-183240.61462564,["x"]=-189914.01184622,},
+          [3]={["y"]=-180748.88998479,["x"]=-191943.30402837,},
+          [4]={["y"]=-180711.83076051,["x"]=-191896.52435182,},
+          [5]={["y"]=-183207.42182735,["x"]=-189871.38506688,},
+        },
+      },
+    },
+    [AIRBASE.PersianGulf.Kish_International_Airport] = {
+      PointsRunways = {
+        [1] = {
+          [1]={["y"]=-227330.79164594,["x"]=42691.91536494,},
+          [2]={["y"]=-227321.58531968,["x"]=42758.113234714,},
+          [3]={["y"]=-223235.73004619,["x"]=42313.579195302,},
+          [4]={["y"]=-223240.99080406,["x"]=42247.819722016,},
+          [5]={["y"]=-227330.67774245,["x"]=42691.785682556,},
+        },
+        [2] = {
+          [1]={["y"]=-227283.77911886,["x"]=42987.748941936,},
+          [2]={["y"]=-227274.5727926,["x"]=43053.946811711,},
+          [3]={["y"]=-222907.94761294,["x"]=42580.826755904,},
+          [4]={["y"]=-222915.76510871,["x"]=42514.58376547,},
+          [5]={["y"]=-227283.66521537,["x"]=42987.619259553,},
+        },
+      },
+    },
+    [AIRBASE.PersianGulf.Al_Ain_International_Airport] = {
+      PointsRunways = {
+        [1] = {
+          [1]={["y"]=-65165.315648901,["x"]=-209042.45716363,},
+          [2]={["y"]=-65112.933878375,["x"]=-209048.84518442,},
+          [3]={["y"]=-65672.013626755,["x"]=-213019.66479976,},
+          [4]={["y"]=-65722.555424932,["x"]=-213013.91596964,},
+          [5]={["y"]=-65165.400582791,["x"]=-209042.15059908,},
+        },
+      },
+    },
+    [AIRBASE.PersianGulf.Lavan_Island_Airport] = {
+      PointsRunways = {
+        [1] = {
+          [1]={["y"]=-288099.83301495,["x"]=76353.443273049,},
+          [2]={["y"]=-288119.51457685,["x"]=76302.756224611,},
+          [3]={["y"]=-288070.96603401,["x"]=76283.898526152,},
+          [4]={["y"]=-288085.61084238,["x"]=76247.386812114,},
+          [5]={["y"]=-288032.04695421,["x"]=76224.316223573,},
+          [6]={["y"]=-287991.12173627,["x"]=76245.38067398,},
+          [7]={["y"]=-287489.96435675,["x"]=76037.610404141,},
+          [8]={["y"]=-287497.65444594,["x"]=76017.686082159,},
+          [9]={["y"]=-287453.61120787,["x"]=75998.111309685,},
+          [10]={["y"]=-287419.70490555,["x"]=76007.199596905,},
+          [11]={["y"]=-285642.24565503,["x"]=75279.787069797,},
+          [12]={["y"]=-285625.46727862,["x"]=75239.239326815,},
+          [13]={["y"]=-285570.23845628,["x"]=75217.217707782,},
+          [14]={["y"]=-285555.20782742,["x"]=75252.172658628,},
+          [15]={["y"]=-285505.92134673,["x"]=75231.199688121,},
+          [16]={["y"]=-285484.28380792,["x"]=75284.258832895,},
+          [17]={["y"]=-288099.97979219,["x"]=76354.32393647,},
+        },
+      },
+    },
+    [AIRBASE.PersianGulf.Jiroft_Airport] = {
+      PointsRunways = {
+        [1] = {
+          [1]={["y"]=140376.87310595,["x"]=283748.07558774,},
+          [2]={["y"]=140299.43760975,["x"]=283655.81201779,},
+          [3]={["y"]=143008.43807723,["x"]=281517.41347718,},
+          [4]={["y"]=143052.6952428,["x"]=281573.25195709,},
+          [5]={["y"]=142946.60213095,["x"]=281656.5960586,},
+          [6]={["y"]=142975.14179847,["x"]=281687.20381796,},
+          [7]={["y"]=142932.12548801,["x"]=281724.01585287,},
+          [8]={["y"]=142870.49635092,["x"]=281719.05243244,},
+          [9]={["y"]=140437.35783025,["x"]=283640.84253664,},
+          [10]={["y"]=140433.27045062,["x"]=283705.80267729,},
+          [11]={["y"]=140376.77702493,["x"]=283747.8442964,},
+        },
+      },
+    },
+  },
+}
+
+
+--- Creates a new ATC_GROUND_PERSIANGULF object.
+-- @param #ATC_GROUND_PERSIANGULF self
+-- @param AirbaseNames A list {} of airbase names (Use AIRBASE.PersianGulf enumerator).
+-- @return #ATC_GROUND_PERSIANGULF self
+function ATC_GROUND_PERSIANGULF:New( AirbaseNames )
+
+  -- Inherits from BASE
+  local self = BASE:Inherit( self, ATC_GROUND:New( self.Airbases, AirbaseNames ) ) -- #ATC_GROUND_PERSIANGULF
+  
+  self:SetKickSpeedKmph( 50 )
+  self:SetMaximumKickSpeedKmph( 150 )
+
+  -- These lines here are for the demonstration mission.
+  -- They create in the dcs.log the coordinates of the runway polygons, that are then
+  -- taken by the moose designer from the dcs.log and reworked to define the
+  -- Airbases structure, which is part of the class.
+  -- When new airbases are added or airbases are changed on the map,
+  -- the MOOSE designer willde-comment this section and apply the changes in the demo
+  -- mission, and do a re-run to create a new dcs.log, and then add the changed coordinates
+  -- in the Airbases structure.
+  -- So, this needs to stay commented normally once a map has been finished.
+  
+
+  --[[
+  
+  -- Abu_Musa_Island_Airport
+  do
+    local VillagePrefix = "Abu_Musa_Island_Airport" 
+    local Runway1 = GROUP:FindByName( VillagePrefix .. " 1" )
+    local Zone1 = ZONE_POLYGON:New( VillagePrefix .. " 1", Runway1 ):SmokeZone(SMOKECOLOR.Red):Flush()
+  end
+  
+  
+  -- Al_Dhafra_AB
+  do
+    local VillagePrefix = "Al_Dhafra_AB" 
+    local Runway1 = GROUP:FindByName( VillagePrefix .. " 1" )
+    local Zone1 = ZONE_POLYGON:New( VillagePrefix .. " 1", Runway1 ):SmokeZone(SMOKECOLOR.Red):Flush()
+    local Runway2 = GROUP:FindByName( VillagePrefix .. " 2" )
+    local Zone2 = ZONE_POLYGON:New( VillagePrefix .. " 2", Runway2 ):SmokeZone(SMOKECOLOR.Red):Flush()
+  end
+  
+  
+  -- Al_Maktoum_Intl
+  do
+    local VillagePrefix = "Al_Maktoum_Intl" 
+    local Runway1 = GROUP:FindByName( VillagePrefix .. " 1" )
+    local Zone1 = ZONE_POLYGON:New( VillagePrefix .. " 1", Runway1 ):SmokeZone(SMOKECOLOR.Red):Flush()
+  end
+  
+  
+  -- Al_Minhad_AB
+  do
+    local VillagePrefix = "Al_Minhad_AB" 
+    local Runway1 = GROUP:FindByName( VillagePrefix .. " 1" )
+    local Zone1 = ZONE_POLYGON:New( VillagePrefix .. " 1", Runway1 ):SmokeZone(SMOKECOLOR.Red):Flush()
+  end
+  
+  
+  -- Bandar_Abbas_Intl
+  do
+    local VillagePrefix = "Bandar_Abbas_Intl" 
+    local Runway1 = GROUP:FindByName( VillagePrefix .. " 1" )
+    local Zone1 = ZONE_POLYGON:New( VillagePrefix .. " 1", Runway1 ):SmokeZone(SMOKECOLOR.Red):Flush()
+    local Runway2 = GROUP:FindByName( VillagePrefix .. " 2" )
+    local Zone2 = ZONE_POLYGON:New( VillagePrefix .. " 2", Runway2 ):SmokeZone(SMOKECOLOR.Red):Flush()
+  end
+  
+  
+  -- Bandar_Lengeh
+  do
+    local VillagePrefix = "Bandar_Lengeh" 
+    local Runway1 = GROUP:FindByName( VillagePrefix .. " 1" )
+    local Zone1 = ZONE_POLYGON:New( VillagePrefix .. " 1", Runway1 ):SmokeZone(SMOKECOLOR.Red):Flush()
+  end
+  
+  
+  -- Dubai_Intl
+  do
+    local VillagePrefix = "Dubai_Intl" 
+    local Runway1 = GROUP:FindByName( VillagePrefix .. " 1" )
+    local Zone1 = ZONE_POLYGON:New( VillagePrefix .. " 1", Runway1 ):SmokeZone(SMOKECOLOR.Red):Flush()
+    local Runway2 = GROUP:FindByName( VillagePrefix .. " 2" )
+    local Zone2 = ZONE_POLYGON:New( VillagePrefix .. " 2", Runway2 ):SmokeZone(SMOKECOLOR.Red):Flush()
+  end
+  
+  
+  -- Fujairah_Intl
+  do
+    local VillagePrefix = "Fujairah_Intl" 
+    local Runway1 = GROUP:FindByName( VillagePrefix .. " 1" )
+    local Zone1 = ZONE_POLYGON:New( VillagePrefix .. " 1", Runway1 ):SmokeZone(SMOKECOLOR.Red):Flush()
+  end
+  
+  
+  -- Havadarya
+  do
+    local VillagePrefix = "Havadarya" 
+    local Runway1 = GROUP:FindByName( VillagePrefix .. " 1" )
+    local Zone1 = ZONE_POLYGON:New( VillagePrefix .. " 1", Runway1 ):SmokeZone(SMOKECOLOR.Red):Flush()
+  end
+  
+  
+  -- Kerman_Airport
+  do
+    local VillagePrefix = "Kerman_Airport" 
+    local Runway1 = GROUP:FindByName( VillagePrefix .. " 1" )
+    local Zone1 = ZONE_POLYGON:New( VillagePrefix .. " 1", Runway1 ):SmokeZone(SMOKECOLOR.Red):Flush()
+  end
+  
+  
+  -- Khasab
+  do
+    local VillagePrefix = "Khasab" 
+    local Runway1 = GROUP:FindByName( VillagePrefix .. " 1" )
+    local Zone1 = ZONE_POLYGON:New( VillagePrefix .. " 1", Runway1 ):SmokeZone(SMOKECOLOR.Red):Flush()
+  end
+  
+  
+  -- Lar_Airbase
+  do
+    local VillagePrefix = "Lar_Airbase" 
+    local Runway1 = GROUP:FindByName( VillagePrefix .. " 1" )
+    local Zone1 = ZONE_POLYGON:New( VillagePrefix .. " 1", Runway1 ):SmokeZone(SMOKECOLOR.Red):Flush()
+  end
+  
+  
+  -- Qeshm_Island
+  do
+    local VillagePrefix = "Qeshm_Island" 
+    local Runway1 = GROUP:FindByName( VillagePrefix .. " 1" )
+    local Zone1 = ZONE_POLYGON:New( VillagePrefix .. " 1", Runway1 ):SmokeZone(SMOKECOLOR.Red):Flush()
+  end
+  
+  
+  -- Sharjah_Intl
+  do
+    local VillagePrefix = "Sharjah_Intl" 
+    local Runway1 = GROUP:FindByName( VillagePrefix .. " 1" )
+    local Zone1 = ZONE_POLYGON:New( VillagePrefix .. " 1", Runway1 ):SmokeZone(SMOKECOLOR.Red):Flush()
+    local Runway2 = GROUP:FindByName( VillagePrefix .. " 2" )
+    local Zone2 = ZONE_POLYGON:New( VillagePrefix .. " 2", Runway2 ):SmokeZone(SMOKECOLOR.Red):Flush()
+  end
+  
+  
+  -- Shiraz_International_Airport
+  do
+    local VillagePrefix = "Shiraz_International_Airport" 
+    local Runway1 = GROUP:FindByName( VillagePrefix .. " 1" )
+    local Zone1 = ZONE_POLYGON:New( VillagePrefix .. " 1", Runway1 ):SmokeZone(SMOKECOLOR.Red):Flush()
+    local Runway2 = GROUP:FindByName( VillagePrefix .. " 2" )
+    local Zone2 = ZONE_POLYGON:New( VillagePrefix .. " 2", Runway2 ):SmokeZone(SMOKECOLOR.Red):Flush()
+  end
+  
+  
+  -- Sir_Abu_Nuayr
+  do
+    local VillagePrefix = "Sir_Abu_Nuayr" 
+    local Runway1 = GROUP:FindByName( VillagePrefix .. " 1" )
+    local Zone1 = ZONE_POLYGON:New( VillagePrefix .. " 1", Runway1 ):SmokeZone(SMOKECOLOR.Red):Flush()
+  end
+  
+  
+  -- Sirri_Island
+  do
+    local VillagePrefix = "Sirri_Island" 
+    local Runway1 = GROUP:FindByName( VillagePrefix .. " 1" )
+    local Zone1 = ZONE_POLYGON:New( VillagePrefix .. " 1", Runway1 ):SmokeZone(SMOKECOLOR.Red):Flush()
+  end
+  
+  
+  -- Tunb_Island_AFB
+  do
+    local VillagePrefix = "Tunb_Island_AFB" 
+    local Runway1 = GROUP:FindByName( VillagePrefix .. " 1" )
+    local Zone1 = ZONE_POLYGON:New( VillagePrefix .. " 1", Runway1 ):SmokeZone(SMOKECOLOR.Red):Flush()
+  end
+  
+  
+  -- Tunb_Kochak
+  do
+    local VillagePrefix = "Tunb_Kochak" 
+    local Runway1 = GROUP:FindByName( VillagePrefix .. " 1" )
+    local Zone1 = ZONE_POLYGON:New( VillagePrefix .. " 1", Runway1 ):SmokeZone(SMOKECOLOR.Red):Flush()
+  end
+  
+
+  -- Sas_Al_Nakheel_Airport
+  do
+    local VillagePrefix = "Sas_Al_Nakheel_Airport" 
+    local Runway1 = GROUP:FindByName( VillagePrefix .. " 1" )
+    local Zone1 = ZONE_POLYGON:New( VillagePrefix .. " 1", Runway1 ):SmokeZone(SMOKECOLOR.Red):Flush()
+  end
+  
+  
+  -- Bandar_e_Jask_airfield
+  do
+    local VillagePrefix = "Bandar_e_Jask_airfield" 
+    local Runway1 = GROUP:FindByName( VillagePrefix .. " 1" )
+    local Zone1 = ZONE_POLYGON:New( VillagePrefix .. " 1", Runway1 ):SmokeZone(SMOKECOLOR.Red):Flush()
+  end
+  
+  
+  -- Abu_Dhabi_International_Airport
+  do
+    local VillagePrefix = "Abu_Dhabi_International_Airport" 
+    local Runway1 = GROUP:FindByName( VillagePrefix .. " 1" )
+    local Zone1 = ZONE_POLYGON:New( VillagePrefix .. " 1", Runway1 ):SmokeZone(SMOKECOLOR.Red):Flush()
+    local Runway2 = GROUP:FindByName( VillagePrefix .. " 2" )
+    local Zone2 = ZONE_POLYGON:New( VillagePrefix .. " 2", Runway2 ):SmokeZone(SMOKECOLOR.Red):Flush()
+  end
+  
+  
+  -- Al_Bateen_Airport
+  do
+    local VillagePrefix = "Al_Bateen_Airport" 
+    local Runway1 = GROUP:FindByName( VillagePrefix .. " 1" )
+    local Zone1 = ZONE_POLYGON:New( VillagePrefix .. " 1", Runway1 ):SmokeZone(SMOKECOLOR.Red):Flush()
+  end
+  
+  
+  -- Kish_International_Airport
+  do
+    local VillagePrefix = "Kish_International_Airport" 
+    local Runway1 = GROUP:FindByName( VillagePrefix .. " 1" )
+    local Zone1 = ZONE_POLYGON:New( VillagePrefix .. " 1", Runway1 ):SmokeZone(SMOKECOLOR.Red):Flush()
+    local Runway2 = GROUP:FindByName( VillagePrefix .. " 2" )
+    local Zone2 = ZONE_POLYGON:New( VillagePrefix .. " 2", Runway2 ):SmokeZone(SMOKECOLOR.Red):Flush()
+  end
+  
+  
+  -- Al_Ain_International_Airport
+  do
+    local VillagePrefix = "Al_Ain_International_Airport" 
+    local Runway1 = GROUP:FindByName( VillagePrefix .. " 1" )
+    local Zone1 = ZONE_POLYGON:New( VillagePrefix .. " 1", Runway1 ):SmokeZone(SMOKECOLOR.Red):Flush()
+  end
+  
+  
+  -- Lavan_Island_Airport
+  do
+    local VillagePrefix = "Lavan_Island_Airport" 
+    local Runway1 = GROUP:FindByName( VillagePrefix .. " 1" )
+    local Zone1 = ZONE_POLYGON:New( VillagePrefix .. " 1", Runway1 ):SmokeZone(SMOKECOLOR.Red):Flush()
+  end
+  
+  
+  -- Jiroft_Airport
+  do
+    local VillagePrefix = "Jiroft_Airport" 
+    local Runway1 = GROUP:FindByName( VillagePrefix .. " 1" )
+    local Zone1 = ZONE_POLYGON:New( VillagePrefix .. " 1", Runway1 ):SmokeZone(SMOKECOLOR.Red):Flush()
+  end
+  
+  
+  -- Bandar_Abbas_Intl
+  do
+    local VillagePrefix = "Bandar_Abbas_Intl" 
+    local Runway1 = GROUP:FindByName( VillagePrefix .. " 1" )
+    local Zone1 = ZONE_POLYGON:New( VillagePrefix .. " 1", Runway1 ):SmokeZone(SMOKECOLOR.Red):Flush()
+    local Runway2 = GROUP:FindByName( VillagePrefix .. " 2" )
+    local Zone2 = ZONE_POLYGON:New( VillagePrefix .. " 2", Runway2 ):SmokeZone(SMOKECOLOR.Red):Flush()
+  end
+  
+  --]]
+  
+  return self
+end
+
+--- Start SCHEDULER for ATC_GROUND_PERSIANGULF object.
+-- @param #ATC_GROUND_PERSIANGULF self
+-- @param RepeatScanSeconds Time in second for defining occurency of alerts.
+-- @return nothing
+function ATC_GROUND_PERSIANGULF:Start( RepeatScanSeconds )
+  RepeatScanSeconds = RepeatScanSeconds or 0.05
+  self.AirbaseMonitor = SCHEDULER:New( self, self._AirbaseMonitor, { self }, 0, 2, RepeatScanSeconds )
+end
+          
 
 
      

Moose Development/Moose/Functional/CleanUp.lua

@@ -1,23 +1,22 @@
---- **Functional** -- The CLEANUP_AIRBASE class keeps an area clean of crashing or colliding airplanes. It also prevents airplanes from firing within this area.
+--- **Functional** -- Keep airbases clean of crashing or colliding airplanes, and kill missiles when being fired at airbases.
 -- 
 -- ===
 -- 
--- ### Author: **FlightControl**
--- ### Contributions: 
+-- ## Features:
+-- 
+-- 
+--  * Try to keep the airbase clean and operational.
+--  * Prevent airplanes from crashing.
+--  * Clean up obstructing airplanes from the runway that are standing still for a period of time.
+--  * Prevent airplanes firing missiles within the airbase zone.
 -- 
 -- ===
 -- 
--- @module Functional.CleanUp
--- @image CleanUp_Airbases.JPG
-
---- @type CLEANUP_AIRBASE.__ Methods which are not intended for mission designers, but which are used interally by the moose designer :-)
--- @field #map<#string,Wrapper.Airbase#AIRBASE> Airbases Map of Airbases.
--- @extends Core.Base#BASE
-
---- @type CLEANUP_AIRBASE
--- @extends #CLEANUP_AIRBASE.__
-
---- Keeps airbases clean, and tries to guarantee continuous airbase operations, even under combat.
+-- ## Missions:
+-- 
+-- [CLA - CleanUp Airbase](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/CLA%20-%20CleanUp%20Airbase)
+-- 
+-- ===
 -- 
 -- Specific airbases need to be provided that need to be guarded. Each airbase registered, will be guarded within a zone of 8 km around the airbase.
 -- Any unit that fires a missile, or shoots within the zone of an airbase, will be monitored by CLEANUP_AIRBASE.
@@ -43,7 +42,26 @@
 --     
 -- By following the above guidelines, you can add airbase cleanup with acceptable CPU overhead.
 -- 
--- ## 1. CLEANUP_AIRBASE Constructor
+-- ===
+-- 
+-- ### Author: **FlightControl**
+-- ### Contributions: 
+-- 
+-- ===
+-- 
+-- @module Functional.CleanUp
+-- @image CleanUp_Airbases.JPG
+
+--- @type CLEANUP_AIRBASE.__ Methods which are not intended for mission designers, but which are used interally by the moose designer :-)
+-- @field #map<#string,Wrapper.Airbase#AIRBASE> Airbases Map of Airbases.
+-- @extends Core.Base#BASE
+
+--- @type CLEANUP_AIRBASE
+-- @extends #CLEANUP_AIRBASE.__
+
+--- Keeps airbases clean, and tries to guarantee continuous airbase operations, even under combat.
+-- 
+-- # 1. CLEANUP_AIRBASE Constructor
 -- 
 -- Creates the main object which is preventing the airbase to get polluted with debris on the runway, which halts the airbase.
 -- 
@@ -54,12 +72,12 @@
 --      CleanUpTbilisi = CLEANUP_AIRBASE:New( AIRBASE.Caucasus.Tbilisi )
 --      CleanUpKutaisi = CLEANUP_AIRBASE:New( AIRBASE.Caucasus.Kutaisi )
 -- 
--- ## 2. Add or Remove airbases
+-- # 2. Add or Remove airbases
 -- 
 -- The method @{#CLEANUP_AIRBASE.AddAirbase}() to add an airbase to the cleanup validation process.
 -- The method @{#CLEANUP_AIRBASE.RemoveAirbase}() removes an airbase from the cleanup validation process.
 -- 
--- ## 3. Clean missiles and bombs within the airbase zone.
+-- # 3. Clean missiles and bombs within the airbase zone.
 -- 
 -- When missiles or bombs hit the runway, the airbase operations stop.
 -- Use the method @{#CLEANUP_AIRBASE.SetCleanMissiles}() to control the cleaning of missiles, which will prevent airbases to stop.
@@ -112,6 +130,20 @@ function CLEANUP_AIRBASE:New( AirbaseNames )
   self:HandleEvent( EVENTS.PilotDead, self.__.OnEventCrash )
   self:HandleEvent( EVENTS.Dead, self.__.OnEventCrash )
   self:HandleEvent( EVENTS.Crash, self.__.OnEventCrash )
+  
+  for UnitName, Unit in pairs( _DATABASE.UNITS ) do
+    local Unit = Unit -- Wrapper.Unit#UNIT
+    if Unit:IsAlive() ~= nil then
+      if self:IsInAirbase( Unit:GetVec2() ) then
+        self:F( { UnitName = UnitName } )
+        self.CleanUpList[UnitName] = {}
+        self.CleanUpList[UnitName].CleanUpUnit = Unit
+        self.CleanUpList[UnitName].CleanUpGroup = Unit:GetGroup()
+        self.CleanUpList[UnitName].CleanUpGroupName = Unit:GetGroup():GetName()
+        self.CleanUpList[UnitName].CleanUpUnitName = Unit:GetName()
+      end
+    end
+  end
 	
 	return self
 end
@@ -180,7 +212,7 @@ function CLEANUP_AIRBASE.__:DestroyUnit( CleanUpUnit )
 	if CleanUpUnit then
 	  local CleanUpUnitName = CleanUpUnit:GetName()
 		local CleanUpGroup = CleanUpUnit:GetGroup()
-    -- TODO Client bug in 1.5.3
+    -- TODO DCS BUG - Client bug in 1.5.3
 		if CleanUpGroup:IsAlive() then
 			local CleanUpGroupUnits = CleanUpGroup:GetUnits()
 			if #CleanUpGroupUnits == 1 then
@@ -213,11 +245,15 @@ end
 function CLEANUP_AIRBASE.__:OnEventBirth( EventData )
   self:F( { EventData } )
   
-  self.CleanUpList[EventData.IniDCSUnitName] = {}
-  self.CleanUpList[EventData.IniDCSUnitName].CleanUpUnit = EventData.IniUnit
-  self.CleanUpList[EventData.IniDCSUnitName].CleanUpGroup = EventData.IniGroup
-  self.CleanUpList[EventData.IniDCSUnitName].CleanUpGroupName = EventData.IniDCSGroupName
-  self.CleanUpList[EventData.IniDCSUnitName].CleanUpUnitName = EventData.IniDCSUnitName
+  if EventData.IniUnit:IsAlive() ~= nil then
+    if self:IsInAirbase( EventData.IniUnit:GetVec2() ) then
+      self.CleanUpList[EventData.IniDCSUnitName] = {}
+      self.CleanUpList[EventData.IniDCSUnitName].CleanUpUnit = EventData.IniUnit
+      self.CleanUpList[EventData.IniDCSUnitName].CleanUpGroup = EventData.IniGroup
+      self.CleanUpList[EventData.IniDCSUnitName].CleanUpGroupName = EventData.IniDCSGroupName
+      self.CleanUpList[EventData.IniDCSUnitName].CleanUpUnitName = EventData.IniDCSUnitName
+    end
+  end
 
 end
 
@@ -229,7 +265,7 @@ end
 function CLEANUP_AIRBASE.__:OnEventCrash( Event )
 	self:F( { Event } )
 
-  --TODO: This stuff is not working due to a DCS bug. Burning units cannot be destroyed.
+  --TODO: DCS BUG - This stuff is not working due to a DCS bug. Burning units cannot be destroyed.
 	-- self:T("before getGroup")
 	-- local _grp = Unit.getGroup(event.initiator)-- Identify the group that fired 
 	-- self:T("after getGroup")
@@ -349,45 +385,50 @@ function CLEANUP_AIRBASE.__:CleanUpSchedule()
 		local CleanUpGroupName = CleanUpListData.CleanUpGroupName
 
 		if CleanUpUnit:IsAlive() ~= nil then
+		
+		  if self:IsInAirbase( CleanUpUnit:GetVec2() ) then
 
-			if _DATABASE:GetStatusGroup( CleanUpGroupName ) ~= "ReSpawn" then
-
-				local CleanUpCoordinate = CleanUpUnit:GetCoordinate()
-
-        self:T( { "CleanUp Scheduler", CleanUpUnitName } )
-        if CleanUpUnit:GetLife() <= CleanUpUnit:GetLife0() * 0.95 then
-					if CleanUpUnit:IsAboveRunway() then
-						if CleanUpUnit:InAir() then
-
-							local CleanUpLandHeight = CleanUpCoordinate:GetLandHeight()
-							local CleanUpUnitHeight = CleanUpCoordinate.y - CleanUpLandHeight
-							
-							if CleanUpUnitHeight < 100 then
-								self:T( { "CleanUp Scheduler", "Destroy " .. CleanUpUnitName .. " because below safe height and damaged." } )
-								self:DestroyUnit( CleanUpUnit )
-							end
-						else
-							self:T( { "CleanUp Scheduler", "Destroy " .. CleanUpUnitName .. " because on runway and damaged." } )
-							self:DestroyUnit( CleanUpUnit )
-						end
-					end
-				end
-				-- Clean Units which are waiting for a very long time in the CleanUpZone.
-				if CleanUpUnit then
-					local CleanUpUnitVelocity = CleanUpUnit:GetVelocityKMH()
-					if CleanUpUnitVelocity < 1 then
-						if CleanUpListData.CleanUpMoved then
-							if CleanUpListData.CleanUpTime + 180 <= timer.getTime() then
-								self:T( { "CleanUp Scheduler", "Destroy due to not moving anymore " .. CleanUpUnitName } )
-								self:DestroyUnit( CleanUpUnit )
-							end
-						end
-					else
-						CleanUpListData.CleanUpTime = timer.getTime()
-						CleanUpListData.CleanUpMoved = true
-					end
-				end
-				
+  			if _DATABASE:GetStatusGroup( CleanUpGroupName ) ~= "ReSpawn" then
+  
+  				local CleanUpCoordinate = CleanUpUnit:GetCoordinate()
+  
+          self:T( { "CleanUp Scheduler", CleanUpUnitName } )
+          if CleanUpUnit:GetLife() <= CleanUpUnit:GetLife0() * 0.95 then
+  					if CleanUpUnit:IsAboveRunway() then
+  						if CleanUpUnit:InAir() then
+  
+  							local CleanUpLandHeight = CleanUpCoordinate:GetLandHeight()
+  							local CleanUpUnitHeight = CleanUpCoordinate.y - CleanUpLandHeight
+  							
+  							if CleanUpUnitHeight < 100 then
+  								self:T( { "CleanUp Scheduler", "Destroy " .. CleanUpUnitName .. " because below safe height and damaged." } )
+  								self:DestroyUnit( CleanUpUnit )
+  							end
+  						else
+  							self:T( { "CleanUp Scheduler", "Destroy " .. CleanUpUnitName .. " because on runway and damaged." } )
+  							self:DestroyUnit( CleanUpUnit )
+  						end
+  					end
+  				end
+  				-- Clean Units which are waiting for a very long time in the CleanUpZone.
+  				if CleanUpUnit and not CleanUpUnit:GetPlayerName() then
+  					local CleanUpUnitVelocity = CleanUpUnit:GetVelocityKMH()
+  					if CleanUpUnitVelocity < 1 then
+  						if CleanUpListData.CleanUpMoved then
+  							if CleanUpListData.CleanUpTime + 180 <= timer.getTime() then
+  								self:T( { "CleanUp Scheduler", "Destroy due to not moving anymore " .. CleanUpUnitName } )
+  								self:DestroyUnit( CleanUpUnit )
+  							end
+  						end
+  					else
+  						CleanUpListData.CleanUpTime = timer.getTime()
+  						CleanUpListData.CleanUpMoved = true
+  					end
+  				end
+        else
+          -- not anymore in an airbase zone, remove from cleanup list.
+          self.CleanUpList[CleanUpUnitName] = nil
+        end
 			else
 				-- Do nothing ...
 				self.CleanUpList[CleanUpUnitName] = nil

Moose Development/Moose/Functional/Designate.lua

@@ -2,32 +2,181 @@
 --
 -- ===
 --
--- Orchestrate the designation of potential targets executed by a Recce group, 
--- and communicates these to a dedicated attacking group of players, 
--- so that following a dynamically generated menu system, 
--- each detected set of potential targets can be lased or smoked...
+-- ## Features:
 -- 
--- Targets can be:
+--   * Faciliate the communication of detected targets to players.
+--   * Designate targets using lasers, through a menu system.
+--   * Designate targets using smoking, through a menu system.
+--   * Designate targets using illumination, through a menu system.
+--   * Auto lase targets.
+--   * Refresh detection upon specified time intervals.
+--   * Prioritization on threat levels.
+--   * Reporting system of threats.
+--  
+-- ===
+-- 
+-- ## Missions:
+-- 
+-- [DES - Designation](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/DES%20-%20Designation)
+-- 
+-- ===
+--
+-- Targets detected by recce will be communicated to a group of attacking players.  
+-- A menu system is made available that allows to: 
 -- 
 --   * **Lased** for a period of time.
 --   * **Smoked**. Artillery or airplanes with Illuminatino ordonance need to be present. (WIP, but early demo ready.)
 --   * **Illuminated** through an illumination bomb. Artillery or airplanes with Illuminatino ordonance need to be present. (WIP, but early demo ready.
 -- 
--- ===
+-- The following terminology is being used throughout this document:
 -- 
--- # **AUTHORS and CONTRIBUTIONS**
+--   * The **DesignateObject** is the object of the DESIGNATE class, which is this class explained in the document.
+--   * The **DetectionObject** is the object of a DETECTION_ class (DETECTION_TYPES, DETECTION_AREAS, DETECTION_UNITS), which is executing the detection and grouping of Targets into _DetectionItems_.
+--   * **TargetGroups** is the list of detected target groupings by the _DetectionObject_. Each _TargetGroup_ contains a _TargetSet_.
+--   * **TargetGroup** is one element of the __TargetGroups__ list, and contains a _TargetSet_.
+--   * The **TargetSet** is a SET_UNITS collection of _Targets_, that have been detected by the _DetectionObject_.
+--   * A **Target** is a detected UNIT object by the _DetectionObject_.
+--   * A **Threat Level** is a number from 0 to 10 that is calculated based on the threat of the Target in an Air to Ground battle scenario.
+--   * The **RecceSet** is a SET_GROUP collection that contains the **RecceGroups**.
+--   * A **RecceGroup** is a GROUP object containing the **Recces**.
+--   * A **Recce** is a UNIT object executing the reconnaissance as part the _DetectionObject_. A Recce can be of any UNIT type.
+--   * An **AttackGroup** is a GROUP object that contain _Players_.
+--   * A **Player** is an active CLIENT object containing a human player.
+--   * A **Designate Menu** is the menu that is dynamically created during the designation process for each _AttackGroup_.
+-- 
+-- # Player Manual
+-- 
+-- ![Banner Image](..\Presentations\DESIGNATE\Dia3.JPG)
+-- 
+-- A typical mission setup would require Recce (a @{Set} of Recce) to be detecting potential targets.
+-- The DetectionObject will group the detected targets based on the detection method being used.
+-- Possible detection methods could be by Area, by Type or by Unit.
+-- Each grouping will result in a **TargetGroup**, for terminology and clarity we will use this term throughout the document.
+-- 
+-- **Recce** require to have Line of Sight (LOS) towards the targets.
+-- The **Recce** will report any detected targets to the Players (on the picture Observers).
+-- When targets are detected, a menu will be made available that allows those **TargetGroups** to be designated.
+-- Designation can be done by Lasing, Smoking and Illumination.
+-- Smoking is useful during the day, while illumination is recommended to be used during the night.
+-- Smoking can designate specific targets, but not very precise, while lasing is very accurate and allows to
+-- players to attack the targets using laser guided bombs or rockets.
+-- Illumination will lighten up the Target Area.
+-- 
+-- **Recce** can be ground based or airborne. Airborne **Recce** (AFAC) can be really useful to designate a large amount of targets
+-- in a wide open area, as airborne **Recce** has a large LOS.
+-- However, ground based **Recce** are very useful to smoke or illuminate targets, as they can be much closer
+-- to the Target Area.
+-- 
+-- It is recommended to make the **Recce** invisible and immortal using the Mission Editor in DCS World.
+-- This will ensure that the detection process won't be interrupted and that targets can be designated.
+-- However, you don't have to, so to simulate a more real-word situation or simulation, **Recce can also be destroyed**!
+--  
+-- ## 1. Player View (Observer)
+-- 
+-- ![Banner Image](..\Presentations\DESIGNATE\Dia4.JPG)
+-- 
+-- The RecceSet is continuously detecting for potential Targets, 
+-- executing its task as part of the DetectionObject.
+-- Once Targets have been detected, the DesignateObject will trigger the **Detect Event**.
+-- 
+-- In order to prevent an overflow in the DesignateObject of detected targets, 
+-- there is a maximum amount of TargetGroups 
+-- that can be put in **scope** of the DesignateObject.
+-- We call this the **MaximumDesignations** term.
+-- 
+-- ## 2. Designate Menu
+-- 
+-- ![Banner Image](..\Presentations\DESIGNATE\Dia5.JPG)
+-- 
+-- For each detected TargetGroup, there is:
+-- 
+--   * A **Designate Menu** are created and continuously refreshed, containing the **DesignationID** and the **Designation Status**.
+--   * The RecceGroups are reporting to each AttackGroup, sending **Messages** containing the Threat Level and the TargetSet composition.
+-- 
+-- A Player can then select an action from the **Designate Menu**. 
+-- The Designation Status is shown between the (   ).
+-- 
+-- It indicates for each TargetGroup the current active designation action applied:
+-- 
+--   * An "I" for Illumnation designation.
+--   * An "S" for Smoking designation.
+--   * An "L" for Lasing designation.
+--
+-- Note that multiple designation methods can be active at the same time!
+-- Note the **Auto Lase** option. When switched on, the available **Recce** will lase 
+-- Targets when detected.
+-- 
+-- Targets are designated per **Threat Level**. 
+-- The most threatening targets from an Air to Ground perspective, are designated first!
+-- This is for all designation methods.
+-- 
+-- ![Banner Image](..\Presentations\DESIGNATE\Dia6.JPG)
+-- 
+-- Each Designate Menu has a sub menu structure, which allows specific actions to be triggered:
+-- 
+--   * Lase Targets using a specific laser code.
+--   * Smoke Targets using a specific smoke color.
+--   * Illuminate areas.
+-- 
+-- ## 3. Lasing Targets
+-- 
+-- ![Banner Image](..\Presentations\DESIGNATE\Dia7.JPG)
+-- 
+-- Lasing targets is done as expected. Each available Recce can lase only ONE target through!
+-- 
+-- ![Banner Image](..\Presentations\DESIGNATE\Dia8.JPG)
+-- 
+-- Lasing can be done for specific laser codes. The Su-25T requires laser code 1113, while the A-10A requires laser code 1680.
+-- For those, specific menu options can be made available for players to lase with these codes.
+-- Auto Lase (as explained above), will ensure continuous lasing of available targets.
+-- The status report shows which targets are being designated.
+-- 
+-- The following logic is executed when a TargetGroup is selected to be *lased* from the Designation Menu:
+-- 
+--   * The RecceSet is searched for any Recce that is within *designation distance* from a Target in the TargetGroup that is currently not being designated.
+--   * If there is a Recce found that is currently no designating a target, and is within designation distance from the Target, then that Target will be designated.
+--   * During designation, any Recce that does not have Line of Sight (LOS) and is not within disignation distance from the Target, will stop designating the Target, and a report is given.
+--   * When a Recce is designating a Target, and that Target is destroyed, then the Recce will stop designating the Target, and will report the event.
+--   * When a Recce is designating a Target, and that Recce is destroyed, then the Recce will be removed from the RecceSet and designation will stop without reporting.
+--   * When all RecceGroups are destroyed from the RecceSet, then the DesignationObject will stop functioning, and nothing will be reported.
+--   
+-- In this way, DESIGNATE assists players to designate ground targets for a coordinated attack!
+-- 
+-- ## 4. Illuminating Targets
+-- 
+-- ![Banner Image](..\Presentations\DESIGNATE\Dia9.JPG)
+-- 
+-- Illumination bombs are fired between 500 and 700 meters altitude and will burn about 2 minutes, while slowly decending.
+-- Each available recce within range will fire an illumination bomb.
+-- Illumination bombs can be fired in while lasing targets.
+-- When illumination bombs are fired, it will take about 2 minutes until a sequent bomb run can be requested using the menus.
+-- 
+-- ## 5. Smoking Targets
+-- 
+-- ![Banner Image](..\Presentations\DESIGNATE\Dia10.JPG)
+-- 
+-- Smoke will fire for 5 minutes.
+-- Each available recce within range will smoke a target.
+-- Smoking can be requested while lasing targets.
+-- Smoke will appear "around" the targets, because of accuracy limitations.
+-- 
+-- 
+-- Have FUN!
+-- 
+-- ===
 -- 
 -- ### Contributions: 
 -- 
 --   * [**Ciribob**](https://forums.eagle.ru/member.php?u=112175): Showing the way how to lase targets + how laser codes work!!! Explained the autolase script.
 --   * [**EasyEB**](https://forums.eagle.ru/member.php?u=112055): Ideas and Beta Testing
 --   * [**Wingthor**](https://forums.eagle.ru/member.php?u=123698): Beta Testing
---   
 -- 
 -- ### Authors: 
 -- 
 --   * **FlightControl**: Design & Programming
 -- 
+-- ===
+-- 
 -- @module Functional.Designate
 -- @image Designation.JPG
 
@@ -38,161 +187,20 @@ do -- DESIGNATE
 
   --- Manage the designation of detected targets.
   -- 
-  -- Targets detected by recce will be communicated to a group of attacking players.  
-  -- A menu system is made available that allows to: 
   -- 
-  --   * **Lased** for a period of time.
-  --   * **Smoked**. Artillery or airplanes with Illuminatino ordonance need to be present. (WIP, but early demo ready.)
-  --   * **Illuminated** through an illumination bomb. Artillery or airplanes with Illuminatino ordonance need to be present. (WIP, but early demo ready.
-  -- 
-  -- The following terminology is being used throughout this document:
-  -- 
-  --   * The **DesignateObject** is the object of the DESIGNATE class, which is this class explained in the document.
-  --   * The **DetectionObject** is the object of a DETECTION_ class (DETECTION_TYPES, DETECTION_AREAS, DETECTION_UNITS), which is executing the detection and grouping of Targets into _DetectionItems_.
-  --   * **TargetGroups** is the list of detected target groupings by the _DetectionObject_. Each _TargetGroup_ contains a _TargetSet_.
-  --   * **TargetGroup** is one element of the __TargetGroups__ list, and contains a _TargetSet_.
-  --   * The **TargetSet** is a SET_UNITS collection of _Targets_, that have been detected by the _DetectionObject_.
-  --   * A **Target** is a detected UNIT object by the _DetectionObject_.
-  --   * A **Threat Level** is a number from 0 to 10 that is calculated based on the threat of the Target in an Air to Ground battle scenario.
-  --   * The **RecceSet** is a SET_GROUP collection that contains the **RecceGroups**.
-  --   * A **RecceGroup** is a GROUP object containing the **Recces**.
-  --   * A **Recce** is a UNIT object executing the reconnaissance as part the _DetectionObject_. A Recce can be of any UNIT type.
-  --   * An **AttackGroup** is a GROUP object that contain _Players_.
-  --   * A **Player** is an active CLIENT object containing a human player.
-  --   * A **Designate Menu** is the menu that is dynamically created during the designation process for each _AttackGroup_.
-  -- 
-  -- ## 0. Player Manual
-  -- 
-  -- ![Banner Image](..\Presentations\DESIGNATE\Dia3.JPG)
-  -- 
-  -- A typical mission setup would require Recce (a @{Set} of Recce) to be detecting potential targets.
-  -- The DetectionObject will group the detected targets based on the detection method being used.
-  -- Possible detection methods could be by Area, by Type or by Unit.
-  -- Each grouping will result in a **TargetGroup**, for terminology and clarity we will use this term throughout the document.
-  -- 
-  -- **Recce** require to have Line of Sight (LOS) towards the targets.
-  -- The **Recce** will report any detected targets to the Players (on the picture Observers).
-  -- When targets are detected, a menu will be made available that allows those **TargetGroups** to be designated.
-  -- Designation can be done by Lasing, Smoking and Illumination.
-  -- Smoking is useful during the day, while illumination is recommended to be used during the night.
-  -- Smoking can designate specific targets, but not very precise, while lasing is very accurate and allows to
-  -- players to attack the targets using laser guided bombs or rockets.
-  -- Illumination will lighten up the Target Area.
-  -- 
-  -- **Recce** can be ground based or airborne. Airborne **Recce** (AFAC) can be really useful to designate a large amount of targets
-  -- in a wide open area, as airborne **Recce** has a large LOS.
-  -- However, ground based **Recce** are very useful to smoke or illuminate targets, as they can be much closer
-  -- to the Target Area.
-  -- 
-  -- It is recommended to make the **Recce** invisible and immortal using the Mission Editor in DCS World.
-  -- This will ensure that the detection process won't be interrupted and that targets can be designated.
-  -- However, you don't have to, so to simulate a more real-word situation or simulation, **Recce can also be destroyed**!
-  --  
-  -- ### 0.1. Player View (Observer)
-  -- 
-  -- ![Banner Image](..\Presentations\DESIGNATE\Dia4.JPG)
-  -- 
-  -- The RecceSet is continuously detecting for potential Targets, 
-  -- executing its task as part of the DetectionObject.
-  -- Once Targets have been detected, the DesignateObject will trigger the **Detect Event**.
-  -- 
-  -- In order to prevent an overflow in the DesignateObject of detected targets, 
-  -- there is a maximum amount of TargetGroups 
-  -- that can be put in **scope** of the DesignateObject.
-  -- We call this the **MaximumDesignations** term.
-  -- 
-  -- ### 0.2. Designate Menu
-  -- 
-  -- ![Banner Image](..\Presentations\DESIGNATE\Dia5.JPG)
-  -- 
-  -- For each detected TargetGroup, there is:
-  -- 
-  --   * A **Designate Menu** are created and continuously refreshed, containing the **DesignationID** and the **Designation Status**.
-  --   * The RecceGroups are reporting to each AttackGroup, sending **Messages** containing the Threat Level and the TargetSet composition.
-  -- 
-  -- A Player can then select an action from the **Designate Menu**. 
-  -- The Designation Status is shown between the (   ).
-  -- 
-  -- It indicates for each TargetGroup the current active designation action applied:
-  -- 
-  --   * An "I" for Illumnation designation.
-  --   * An "S" for Smoking designation.
-  --   * An "L" for Lasing designation.
-  --
-  -- Note that multiple designation methods can be active at the same time!
-  -- Note the **Auto Lase** option. When switched on, the available **Recce** will lase 
-  -- Targets when detected.
-  -- 
-  -- Targets are designated per **Threat Level**. 
-  -- The most threatening targets from an Air to Ground perspective, are designated first!
-  -- This is for all designation methods.
-  -- 
-  -- ![Banner Image](..\Presentations\DESIGNATE\Dia6.JPG)
-  -- 
-  -- Each Designate Menu has a sub menu structure, which allows specific actions to be triggered:
-  -- 
-  --   * Lase Targets using a specific laser code.
-  --   * Smoke Targets using a specific smoke color.
-  --   * Illuminate areas.
-  -- 
-  -- ### 0.3. Lasing Targets
-  -- 
-  -- ![Banner Image](..\Presentations\DESIGNATE\Dia7.JPG)
-  -- 
-  -- Lasing targets is done as expected. Each available Recce can lase only ONE target through!
-  -- 
-  -- ![Banner Image](..\Presentations\DESIGNATE\Dia8.JPG)
-  -- 
-  -- Lasing can be done for specific laser codes. The Su-25T requires laser code 1113, while the A-10A requires laser code 1680.
-  -- For those, specific menu options can be made available for players to lase with these codes.
-  -- Auto Lase (as explained above), will ensure continuous lasing of available targets.
-  -- The status report shows which targets are being designated.
-  -- 
-  -- The following logic is executed when a TargetGroup is selected to be *lased* from the Designation Menu:
-  -- 
-  --   * The RecceSet is searched for any Recce that is within *designation distance* from a Target in the TargetGroup that is currently not being designated.
-  --   * If there is a Recce found that is currently no designating a target, and is within designation distance from the Target, then that Target will be designated.
-  --   * During designation, any Recce that does not have Line of Sight (LOS) and is not within disignation distance from the Target, will stop designating the Target, and a report is given.
-  --   * When a Recce is designating a Target, and that Target is destroyed, then the Recce will stop designating the Target, and will report the event.
-  --   * When a Recce is designating a Target, and that Recce is destroyed, then the Recce will be removed from the RecceSet and designation will stop without reporting.
-  --   * When all RecceGroups are destroyed from the RecceSet, then the DesignationObject will stop functioning, and nothing will be reported.
-  --   
-  -- In this way, DESIGNATE assists players to designate ground targets for a coordinated attack!
-  -- 
-  -- ### 0.4. Illuminating Targets
-  -- 
-  -- ![Banner Image](..\Presentations\DESIGNATE\Dia9.JPG)
-  -- 
-  -- Illumination bombs are fired between 500 and 700 meters altitude and will burn about 2 minutes, while slowly decending.
-  -- Each available recce within range will fire an illumination bomb.
-  -- Illumination bombs can be fired in while lasing targets.
-  -- When illumination bombs are fired, it will take about 2 minutes until a sequent bomb run can be requested using the menus.
-  -- 
-  -- ### 0.5. Smoking Targets
-  -- 
-  -- ![Banner Image](..\Presentations\DESIGNATE\Dia10.JPG)
-  -- 
-  -- Smoke will fire for 5 minutes.
-  -- Each available recce within range will smoke a target.
-  -- Smoking can be requested while lasing targets.
-  -- Smoke will appear “around” the targets, because of accuracy limitations.
-  -- 
-  -- 
-  -- Have FUN!
-  -- 
-  -- ## 1. DESIGNATE constructor
+  -- # 1. DESIGNATE constructor
   --   
   --   * @{#DESIGNATE.New}(): Creates a new DESIGNATE object.
   -- 
-  -- ## 2. DESIGNATE is a FSM
+  -- # 2. DESIGNATE is a FSM
   -- 
   -- Designate is a finite state machine, which allows for controlled transitions of states.
   -- 
-  -- ### 2.1 DESIGNATE States
+  -- ## 2.1 DESIGNATE States
   -- 
   --   * **Designating** ( Group ): The designation process.
   -- 
-  -- ### 2.2 DESIGNATE Events
+  -- ## 2.2 DESIGNATE Events
   -- 
   --   * **@{#DESIGNATE.Detect}**: Detect targets.
   --   * **@{#DESIGNATE.LaseOn}**: Lase the targets with the specified Index.
@@ -200,7 +208,7 @@ do -- DESIGNATE
   --   * **@{#DESIGNATE.Smoke}**: Smoke the targets with the specified Index.
   --   * **@{#DESIGNATE.Status}**: Report designation status.
   -- 
-  -- ## 3. Maximum Designations
+  -- # 3. Maximum Designations
   -- 
   -- In order to prevent an overflow of designations due to many Detected Targets, there is a 
   -- Maximum Designations scope that is set in the DesignationObject.
@@ -208,9 +216,9 @@ do -- DESIGNATE
   -- The method @{#DESIGNATE.SetMaximumDesignations}() will put a limit on the amount of designations put in scope of the DesignationObject.
   -- Using the menu system, the player can "forget" a designation, so that gradually a new designation can be put in scope when detected.
   -- 
-  -- ## 4. Laser codes
+  -- # 4. Laser codes
   -- 
-  -- ### 4.1. Set possible laser codes
+  -- ## 4.1. Set possible laser codes
   -- 
   -- An array of laser codes can be provided, that will be used by the DESIGNATE when lasing.
   -- The laser code is communicated by the Recce when it is lasing a larget.
@@ -228,11 +236,11 @@ do -- DESIGNATE
   --     
   -- The above sets a collection of possible laser codes that can be assigned. **Note the { } notation!**
   -- 
-  -- ### 4.2. Auto generate laser codes
+  -- ## 4.2. Auto generate laser codes
   -- 
   -- Use the method @{#DESIGNATE.GenerateLaserCodes}() to generate all possible laser codes. Logic implemented and advised by Ciribob!
   -- 
-  -- ### 4.3. Add specific lase codes to the lase menu
+  -- ## 4.3. Add specific lase codes to the lase menu
   -- 
   -- Certain plane types can only drop laser guided ordonnance when targets are lased with specific laser codes.
   -- The SU-25T needs targets to be lased using laser code 1113.
@@ -241,7 +249,7 @@ do -- DESIGNATE
   -- The method @{#DESIGNATE.AddMenuLaserCode}() to allow a player to lase a target using a specific laser code.
   -- Remove such a lase menu option using @{#DESIGNATE.RemoveMenuLaserCode}().
   -- 
-  -- ## 5. Autolase to automatically lase detected targets.
+  -- # 5. Autolase to automatically lase detected targets.
   -- 
   -- DetectionItems can be auto lased once detected by Recces. As such, there is almost no action required from the Players using the Designate Menu.
   -- The **auto lase** function can be activated through the Designation Menu.
@@ -252,7 +260,7 @@ do -- DESIGNATE
   -- 
   -- Activate the auto lasing.
   -- 
-  -- ## 6. Target prioritization on threat level
+  -- # 6. Target prioritization on threat level
   -- 
   -- Targets can be detected of different types in one DetectionItem. Depending on the type of the Target, a different threat level applies in an Air to Ground combat context.
   -- SAMs are of a higher threat than normal tanks. So, if the Target type was recognized, the Recces will select those targets that form the biggest threat first,
@@ -265,12 +273,12 @@ do -- DESIGNATE
   --     
   -- The example will activate the threat level prioritization for this the Designate object. Threats will be marked based on the threat level of the Target.
   -- 
-  -- ## 6. Designate Menu Location for a Mission
+  -- # 7. Designate Menu Location for a Mission
   -- 
   -- You can make DESIGNATE work for a @{Tasking.Mission#MISSION} object. In this way, the designate menu will not appear in the root of the radio menu, but in the menu of the Mission.
   -- Use the method @{#DESIGNATE.SetMission}() to set the @{Mission} object for the designate function.
   -- 
-  -- ## 7. Status Report
+  -- # 8. Status Report
   -- 
   -- A status report is available that displays the current Targets detected, grouped per DetectionItem, and a list of which Targets are currently being marked.
   -- 
@@ -278,9 +286,9 @@ do -- DESIGNATE
   --   * The status report can be automatically flashed by selecting "Status" -> "Flash Status On".
   --   * The automatic flashing of the status report can be deactivated by selecting "Status" -> "Flash Status Off".
   --   * The flashing of the status menu is disabled by default.
-  --   * The method @{#DESIGNATE.FlashStatusMenu}() can be used to enable or disable to flashing of the status menu.
+  --   * The method @{#DESIGNATE.SetFlashStatusMenu}() can be used to enable or disable to flashing of the status menu.
   --   
-  --     Designate:FlashStatusMenu( true )
+  --     Designate:SetFlashStatusMenu( true )
   --     
   -- The example will activate the flashing of the status menu for this Designate object.
   -- 
@@ -461,12 +469,12 @@ do -- DESIGNATE
     self.CC = CC
     self.Detection = Detection
     self.AttackSet = AttackSet
-    self.RecceSet = Detection:GetDetectionSetGroup()
+    self.RecceSet = Detection:GetDetectionSet()
     self.Recces = {}
     self.Designating = {}
     self:SetDesignateName()
     
-    self.LaseDuration = 60
+    self:SetLaseDuration() -- Default is 120 seconds.
     
     self:SetFlashStatusMenu( false )
     self:SetFlashDetectionMessages( true )
@@ -669,6 +677,14 @@ do -- DESIGNATE
     return self
   end
   
+  --- Set the lase duration for designations.
+  -- @param #DESIGNATE self
+  -- @param #number LaseDuration The time in seconds a lase will continue to hold on target. The default is 120 seconds.
+  -- @return #DESIGNATE
+  function DESIGNATE:SetLaseDuration( LaseDuration )
+    self.LaseDuration = LaseDuration or 120
+    return self
+  end
 
   --- Generate an array of possible laser codes.
   -- Each new lase will select a code from this table.
@@ -936,89 +952,112 @@ do -- DESIGNATE
     return self
   end
 
-  --- Sets the Designate Menu.
+
+  --- Sets the Designate Menu for one attack groups.
+  -- @param #DESIGNATE self
+  -- @return #DESIGNATE
+  function DESIGNATE:SetMenu( AttackGroup )
+
+    self.MenuDesignate = self.MenuDesignate or {}
+    
+    local MissionMenu = nil
+    
+    if self.Mission then
+      --MissionMenu = self.Mission:GetRootMenu( AttackGroup )
+      MissionMenu = self.Mission:GetMenu( AttackGroup )
+    end
+    
+    local MenuTime = timer.getTime()
+    
+    self.MenuDesignate[AttackGroup] = MENU_GROUP_DELAYED:New( AttackGroup, self.DesignateName, MissionMenu ):SetTime( MenuTime ):SetTag( self.DesignateName ) 
+    local MenuDesignate = self.MenuDesignate[AttackGroup] -- Core.Menu#MENU_GROUP_DELAYED
+
+    -- Set Menu option for auto lase
+
+    if self.AutoLase then        
+      MENU_GROUP_COMMAND_DELAYED:New( AttackGroup, "Auto Lase Off", MenuDesignate, self.MenuAutoLase, self, false ):SetTime( MenuTime ):SetTag( self.DesignateName )
+    else
+      MENU_GROUP_COMMAND_DELAYED:New( AttackGroup, "Auto Lase On", MenuDesignate, self.MenuAutoLase, self, true ):SetTime( MenuTime ):SetTag( self.DesignateName )
+    end        
+
+    local StatusMenu = MENU_GROUP_DELAYED:New( AttackGroup, "Status", MenuDesignate ):SetTime( MenuTime ):SetTag( self.DesignateName )
+    MENU_GROUP_COMMAND_DELAYED:New( AttackGroup, "Report Status", StatusMenu, self.MenuStatus, self, AttackGroup ):SetTime( MenuTime ):SetTag( self.DesignateName )
+    
+    if self.FlashStatusMenu[AttackGroup] then
+      MENU_GROUP_COMMAND_DELAYED:New( AttackGroup, "Flash Status Report Off", StatusMenu, self.MenuFlashStatus, self, AttackGroup, false ):SetTime( MenuTime ):SetTag( self.DesignateName )
+    else
+       MENU_GROUP_COMMAND_DELAYED:New( AttackGroup, "Flash Status Report On", StatusMenu, self.MenuFlashStatus, self, AttackGroup, true ):SetTime( MenuTime ):SetTag( self.DesignateName )
+    end        
+  
+    local DesignateCount = 0
+  
+    for DesignateIndex, Designating in pairs( self.Designating ) do
+
+      local DetectedItem = self.Detection:GetDetectedItemByIndex( DesignateIndex )
+
+      if DetectedItem then
+      
+        local Coord = self.Detection:GetDetectedItemCoordinate( DetectedItem )
+        local ID = self.Detection:GetDetectedItemID( DetectedItem )
+        local MenuText = ID --.. ", " .. Coord:ToStringA2G( AttackGroup )
+        
+        MenuText = string.format( "(%3s) %s", Designating, MenuText )
+        local DetectedMenu = MENU_GROUP_DELAYED:New( AttackGroup, MenuText, MenuDesignate ):SetTime( MenuTime ):SetTag( self.DesignateName )
+        
+        -- Build the Lasing menu.
+        if string.find( Designating, "L", 1, true ) == nil then
+          MENU_GROUP_COMMAND_DELAYED:New( AttackGroup, "Search other target", DetectedMenu, self.MenuForget, self, DesignateIndex ):SetTime( MenuTime ):SetTag( self.DesignateName )
+          for LaserCode, MenuText in pairs( self.MenuLaserCodes ) do
+            MENU_GROUP_COMMAND_DELAYED:New( AttackGroup, string.format( MenuText, LaserCode ), DetectedMenu, self.MenuLaseCode, self, DesignateIndex, self.LaseDuration, LaserCode ):SetTime( MenuTime ):SetTag( self.DesignateName )
+          end
+          MENU_GROUP_COMMAND_DELAYED:New( AttackGroup, "Lase with random laser code(s)", DetectedMenu, self.MenuLaseOn, self, DesignateIndex, self.LaseDuration ):SetTime( MenuTime ):SetTag( self.DesignateName )
+        else
+          MENU_GROUP_COMMAND_DELAYED:New( AttackGroup, "Stop lasing", DetectedMenu, self.MenuLaseOff, self, DesignateIndex ):SetTime( MenuTime ):SetTag( self.DesignateName )
+        end
+        
+        -- Build the Smoking menu.
+        if string.find( Designating, "S", 1, true ) == nil then
+          MENU_GROUP_COMMAND_DELAYED:New( AttackGroup, "Smoke red", DetectedMenu, self.MenuSmoke, self, DesignateIndex, SMOKECOLOR.Red ):SetTime( MenuTime ):SetTag( self.DesignateName )
+          MENU_GROUP_COMMAND_DELAYED:New( AttackGroup, "Smoke blue", DetectedMenu, self.MenuSmoke, self, DesignateIndex, SMOKECOLOR.Blue ):SetTime( MenuTime ):SetTag( self.DesignateName )
+          MENU_GROUP_COMMAND_DELAYED:New( AttackGroup, "Smoke green", DetectedMenu, self.MenuSmoke, self, DesignateIndex, SMOKECOLOR.Green ):SetTime( MenuTime ):SetTag( self.DesignateName )
+          MENU_GROUP_COMMAND_DELAYED:New( AttackGroup, "Smoke white", DetectedMenu, self.MenuSmoke, self, DesignateIndex, SMOKECOLOR.White ):SetTime( MenuTime ):SetTag( self.DesignateName )
+          MENU_GROUP_COMMAND_DELAYED:New( AttackGroup, "Smoke orange", DetectedMenu, self.MenuSmoke, self, DesignateIndex, SMOKECOLOR.Orange ):SetTime( MenuTime ):SetTag( self.DesignateName )
+        end            
+
+        -- Build the Illuminate menu.
+        if string.find( Designating, "I", 1, true ) == nil then
+          MENU_GROUP_COMMAND_DELAYED:New( AttackGroup, "Illuminate", DetectedMenu, self.MenuIlluminate, self, DesignateIndex ):SetTime( MenuTime ):SetTag( self.DesignateName )
+        end
+      end
+      
+      DesignateCount = DesignateCount + 1
+      if DesignateCount > 10 then
+        break
+      end
+    end
+    MenuDesignate:Remove( MenuTime, self.DesignateName )
+    MenuDesignate:Set()
+  end
+
+
+  --- Sets the Designate Menu for all the attack groups.
   -- @param #DESIGNATE self
   -- @return #DESIGNATE
   function DESIGNATE:SetDesignateMenu()
 
     self.AttackSet:Flush( self )
+    
+    local Delay = 1
 
     self.AttackSet:ForEachGroupAlive(
     
       --- @param Wrapper.Group#GROUP GroupReport
       function( AttackGroup )
-        self.MenuDesignate = self.MenuDesignate or {}
-        
-        local MissionMenu = nil
-        
-        if self.Mission then
-          MissionMenu = self.Mission:GetRootMenu( AttackGroup )
-        end
-        
-        local MenuTime = timer.getTime()
-        
-        self.MenuDesignate[AttackGroup] = MENU_GROUP_DELAYED:New( AttackGroup, self.DesignateName, MissionMenu ):SetTime( MenuTime ):SetTag( self.DesignateName ) 
-        local MenuDesignate = self.MenuDesignate[AttackGroup] -- Core.Menu#MENU_GROUP_DELAYED
-
-        -- Set Menu option for auto lase
-
-        if self.AutoLase then        
-          MENU_GROUP_COMMAND_DELAYED:New( AttackGroup, "Auto Lase Off", MenuDesignate, self.MenuAutoLase, self, false ):SetTime( MenuTime ):SetTag( self.DesignateName )
-        else
-          MENU_GROUP_COMMAND_DELAYED:New( AttackGroup, "Auto Lase On", MenuDesignate, self.MenuAutoLase, self, true ):SetTime( MenuTime ):SetTag( self.DesignateName )
-        end        
-
-        local StatusMenu = MENU_GROUP_DELAYED:New( AttackGroup, "Status", MenuDesignate ):SetTime( MenuTime ):SetTag( self.DesignateName )
-        MENU_GROUP_COMMAND_DELAYED:New( AttackGroup, "Report Status", StatusMenu, self.MenuStatus, self, AttackGroup ):SetTime( MenuTime ):SetTag( self.DesignateName )
-        
-        if self.FlashStatusMenu[AttackGroup] then
-          MENU_GROUP_COMMAND_DELAYED:New( AttackGroup, "Flash Status Report Off", StatusMenu, self.MenuFlashStatus, self, AttackGroup, false ):SetTime( MenuTime ):SetTag( self.DesignateName )
-        else
-           MENU_GROUP_COMMAND_DELAYED:New( AttackGroup, "Flash Status Report On", StatusMenu, self.MenuFlashStatus, self, AttackGroup, true ):SetTime( MenuTime ):SetTag( self.DesignateName )
-        end        
       
-        for DesignateIndex, Designating in pairs( self.Designating ) do
-
-          local DetectedItem = self.Detection:GetDetectedItemByIndex( DesignateIndex )
-
-          if DetectedItem then
-          
-            local Coord = self.Detection:GetDetectedItemCoordinate( DetectedItem )
-            local ID = self.Detection:GetDetectedItemID( DetectedItem )
-            local MenuText = ID --.. ", " .. Coord:ToStringA2G( AttackGroup )
-            
-            MenuText = string.format( "(%3s) %s", Designating, MenuText )
-            local DetectedMenu = MENU_GROUP_DELAYED:New( AttackGroup, MenuText, MenuDesignate ):SetTime( MenuTime ):SetTag( self.DesignateName )
-            
-            -- Build the Lasing menu.
-            if string.find( Designating, "L", 1, true ) == nil then
-              MENU_GROUP_COMMAND_DELAYED:New( AttackGroup, "Search other target", DetectedMenu, self.MenuForget, self, DesignateIndex ):SetTime( MenuTime ):SetTag( self.DesignateName )
-              for LaserCode, MenuText in pairs( self.MenuLaserCodes ) do
-                MENU_GROUP_COMMAND_DELAYED:New( AttackGroup, string.format( MenuText, LaserCode ), DetectedMenu, self.MenuLaseCode, self, DesignateIndex, 60, LaserCode ):SetTime( MenuTime ):SetTag( self.DesignateName )
-              end
-              MENU_GROUP_COMMAND_DELAYED:New( AttackGroup, "Lase with random laser code(s)", DetectedMenu, self.MenuLaseOn, self, DesignateIndex, 60 ):SetTime( MenuTime ):SetTag( self.DesignateName )
-            else
-              MENU_GROUP_COMMAND_DELAYED:New( AttackGroup, "Stop lasing", DetectedMenu, self.MenuLaseOff, self, DesignateIndex ):SetTime( MenuTime ):SetTag( self.DesignateName )
-            end
-            
-            -- Build the Smoking menu.
-            if string.find( Designating, "S", 1, true ) == nil then
-              MENU_GROUP_COMMAND_DELAYED:New( AttackGroup, "Smoke red", DetectedMenu, self.MenuSmoke, self, DesignateIndex, SMOKECOLOR.Red ):SetTime( MenuTime ):SetTag( self.DesignateName )
-              MENU_GROUP_COMMAND_DELAYED:New( AttackGroup, "Smoke blue", DetectedMenu, self.MenuSmoke, self, DesignateIndex, SMOKECOLOR.Blue ):SetTime( MenuTime ):SetTag( self.DesignateName )
-              MENU_GROUP_COMMAND_DELAYED:New( AttackGroup, "Smoke green", DetectedMenu, self.MenuSmoke, self, DesignateIndex, SMOKECOLOR.Green ):SetTime( MenuTime ):SetTag( self.DesignateName )
-              MENU_GROUP_COMMAND_DELAYED:New( AttackGroup, "Smoke white", DetectedMenu, self.MenuSmoke, self, DesignateIndex, SMOKECOLOR.White ):SetTime( MenuTime ):SetTag( self.DesignateName )
-              MENU_GROUP_COMMAND_DELAYED:New( AttackGroup, "Smoke orange", DetectedMenu, self.MenuSmoke, self, DesignateIndex, SMOKECOLOR.Orange ):SetTime( MenuTime ):SetTag( self.DesignateName )
-            end            
-
-            -- Build the Illuminate menu.
-            if string.find( Designating, "I", 1, true ) == nil then
-              MENU_GROUP_COMMAND_DELAYED:New( AttackGroup, "Illuminate", DetectedMenu, self.MenuIlluminate, self, DesignateIndex ):SetTime( MenuTime ):SetTag( self.DesignateName )
-            end
-          end
-        end
-        MenuDesignate:Remove( MenuTime, self.DesignateName )
-        MenuDesignate:Set()
-      end
+        self:ScheduleOnce( Delay, self.SetMenu, self, AttackGroup )
+        Delay = Delay + 1
+      end  
+        
     )
     
     return self
@@ -1129,10 +1168,10 @@ do -- DESIGNATE
   
     if string.find( self.Designating[Index], "L", 1, true ) == nil then
       self.Designating[Index] = self.Designating[Index] .. "L"
+      self.LaseStart = timer.getTime()
+      self.LaseDuration = Duration
+      self:Lasing( Index, Duration, LaserCode )
     end
-    self.LaseStart = timer.getTime()
-    self.LaseDuration = Duration
-    self:Lasing( Index, Duration, LaserCode )
   end
   
 
@@ -1143,7 +1182,7 @@ do -- DESIGNATE
   
   
     local DetectedItem = self.Detection:GetDetectedItemByIndex( Index )
-    local TargetSetUnit = self.Detection:GetDetectedSet( DetectedItem )
+    local TargetSetUnit = self.Detection:GetDetectedItemSet( DetectedItem )
 
     local MarkingCount = 0
     local MarkedTypes = {}
@@ -1291,7 +1330,7 @@ do -- DESIGNATE
       local MarkedLaserCodesText = ReportLaserCodes:Text(', ')
       self.CC:GetPositionable():MessageToSetGroup( "Marking " .. MarkingCount .. " x "  .. MarkedTypesText .. ", code " .. MarkedLaserCodesText .. ".", 5, self.AttackSet, self.DesignateName )
   
-      self:__Lasing( -30, Index, Duration, LaserCodeRequested )
+      self:__Lasing( -self.LaseDuration, Index, Duration, LaserCodeRequested )
       
       self:SetDesignateMenu()
 
@@ -1313,7 +1352,7 @@ do -- DESIGNATE
     end
     
     local DetectedItem = self.Detection:GetDetectedItemByIndex( Index )
-    local TargetSetUnit = self.Detection:GetDetectedSet( DetectedItem )
+    local TargetSetUnit = self.Detection:GetDetectedItemSet( DetectedItem )
     
     local Recces = self.Recces
     
@@ -1338,7 +1377,7 @@ do -- DESIGNATE
   function DESIGNATE:onafterSmoke( From, Event, To, Index, Color )
   
     local DetectedItem = self.Detection:GetDetectedItemByIndex( Index )
-    local TargetSetUnit = self.Detection:GetDetectedSet( DetectedItem )
+    local TargetSetUnit = self.Detection:GetDetectedItemSet( DetectedItem )
     local TargetSetUnitCount = TargetSetUnit:Count()
   
     local MarkedCount = 0
@@ -1354,7 +1393,7 @@ do -- DESIGNATE
           self:F( "Smoking ..." )
 
           local RecceGroup = self.RecceSet:FindNearestGroupFromPointVec2(SmokeUnit:GetPointVec2())
-          local RecceUnit = RecceGroup:GetUnit( 1 )
+          local RecceUnit = RecceGroup:GetUnit( 1 ) -- Wrapper.Unit#UNIT
 
           if RecceUnit then
 
@@ -1383,7 +1422,7 @@ do -- DESIGNATE
   function DESIGNATE:onafterIlluminate( From, Event, To, Index )
   
     local DetectedItem = self.Detection:GetDetectedItemByIndex( Index )
-    local TargetSetUnit = self.Detection:GetDetectedSet( DetectedItem )
+    local TargetSetUnit = self.Detection:GetDetectedItemSet( DetectedItem )
     local TargetUnit = TargetSetUnit:GetFirst()
   
     if TargetUnit then

Moose Development/Moose/Functional/Detection.lua

@@ -2,18 +2,25 @@
 -- 
 -- ===
 -- 
+-- ## Features:
+-- 
+--   * Detection of targets by recce units.
+--   * Group detected targets per unit, type or area (zone).
+--   * Keep persistency of detected targets, if when detection is lost.
+--   * Provide an indication of detected targets.
+--   * Report detected targets.
+--   * Refresh detection upon specified time intervals.
+-- 
+-- ===
+-- 
+-- ## Missions:
+-- 
+-- [DET - Detection](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/DET%20-%20Detection)
+-- 
+-- ===
+-- 
 -- Facilitate the detection of enemy units within the battle zone executed by FACs (Forward Air Controllers) or RECCEs (Reconnassance Units).
--- DETECTION uses the in-built detection capabilities of DCS World, but adds new functionalities.
--- 
--- Find the DETECTION classes documentation further in this document in the globals section.
--- 
--- ===
--- 
--- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/DET%20-%20Detection)
--- 
--- ===
--- 
--- ### [YouTube Playlist](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl3Cf5jpI6BS0sBOVWK__tji)
+-- It uses the in-built detection capabilities of DCS World, but adds new functionalities.
 -- 
 -- ===
 -- 
@@ -25,13 +32,11 @@
 -- 
 --   * FlightControl : Analysis, Design, Programming, Testing
 -- 
+-- ===
+-- 
 -- @module Functional.Detection
 -- @image Detection.JPG
 
-----BASE:TraceClass("DETECTION_BASE")
-----BASE:TraceClass("DETECTION_AREAS")
-----BASE:TraceClass("DETECTION_UNITS")
-----BASE:TraceClass("DETECTION_TYPES")
 
 do -- DETECTION_BASE
 
@@ -286,22 +291,40 @@ do -- DETECTION_BASE
   --- @type DETECTION_BASE.DetectedItems
   -- @list <#DETECTION_BASE.DetectedItem>
   
-  --- @type DETECTION_BASE.DetectedItem
-  -- @field Core.Set#SET_UNIT Set
-  -- @field Core.Set#SET_UNIT Set -- The Set of Units in the detected area.
-  -- @field Core.Zone#ZONE_UNIT Zone -- The Zone of the detected area.
-  -- @field #boolean Changed Documents if the detected area has changes.
+  --- Detected item data structrue.
+  -- @type DETECTION_BASE.DetectedItem
+  -- @field #boolean IsDetected Indicates if the DetectedItem has been detected or not.
+  -- @field Core.Set#SET_UNIT Set The Set of Units in the detected area.
+  -- @field Core.Zone#ZONE_UNIT Zone The Zone of the detected area.
+  -- @field #boolean Changed Documents if the detected area has changed.
   -- @field #table Changes A list of the changes reported on the detected area. (It is up to the user of the detected area to consume those changes).
-  -- @field #number ID -- The identifier of the detected area.
+  -- @field #number ID The identifier of the detected area.
   -- @field #boolean FriendliesNearBy Indicates if there are friendlies within the detected area.
   -- @field Wrapper.Unit#UNIT NearestFAC The nearest FAC near the Area.
   -- @field Core.Point#COORDINATE Coordinate The last known coordinate of the DetectedItem.
+  -- @field Core.Point#COORDINATE InterceptCoord Intercept coordiante.
+  -- @field #number DistanceRecce Distance in meters of the Recce.
+  -- @field #number Index Detected item key. Could also be a string.
+  -- @field #string ItemID ItemPrefix .. "." .. self.DetectedItemMax.
+  -- @field #boolean Locked Lock detected item.
+  -- @field #table PlayersNearBy Table of nearby players.
+  -- @field #table FriendliesDistance Table of distances to friendly units.
+  -- @field #string TypeName Type name of the detected unit.
+  -- @field #string CategoryName Catetory name of the detected unit.
+  -- @field #string Name Name of the detected object.
+  -- @field #boolean IsVisible If true, detected object is visible.
+  -- @field #number LastTime Last time the detected item was seen.
+  -- @field DCS#Vec3 LastPos Last known position of the detected item.
+  -- @field DCS#Vec3 LastVelocity Last recorded 3D velocity vector of the detected item.
+  -- @field #boolean KnowType Type of detected item is known.
+  -- @field #boolean KnowDistance Distance to the detected item is known.
+  -- @field #number Distance Distance to the detected item.
   
   --- DETECTION constructor.
   -- @param #DETECTION_BASE self
-  -- @param Core.Set#SET_GROUP DetectionSetGroup The @{Set} of GROUPs in the Forward Air Controller role.
+  -- @param Core.Set#SET_GROUP DetectionSet The @{Set} of @{Group}s that is used to detect the units.
   -- @return #DETECTION_BASE self
-  function DETECTION_BASE:New( DetectionSetGroup )
+  function DETECTION_BASE:New( DetectionSet )
   
     -- Inherits from BASE
     local self = BASE:Inherit( self, FSM:New() ) -- #DETECTION_BASE
@@ -310,7 +333,7 @@ do -- DETECTION_BASE
     self.DetectedItemMax = 0
     self.DetectedItems = {}
     
-    self.DetectionSetGroup = DetectionSetGroup
+    self.DetectionSet = DetectionSet
     
     self.RefreshTimeInterval = 30
     
@@ -392,7 +415,7 @@ do -- DETECTION_BASE
     -- @param #string To The To State string.
     
     self:AddTransition( "Detecting", "Detect", "Detecting" )
-    self:AddTransition( "Detecting", "DetectionGroup", "Detecting" )
+    self:AddTransition( "Detecting", "Detection", "Detecting" )
     
     --- OnBefore Transition Handler for Event Detect.
     -- @function [parent=#DETECTION_BASE] OnBeforeDetect
@@ -435,17 +458,29 @@ do -- DETECTION_BASE
     -- @param #string From The From State string.
     -- @param #string Event The Event string.
     -- @param #string To The To State string.
+    -- @param #table Units Table of detected units.
     	
     --- Synchronous Event Trigger for Event Detected.
     -- @function [parent=#DETECTION_BASE] Detected
     -- @param #DETECTION_BASE self
+    -- @param #table Units Table of detected units.
     
     --- Asynchronous Event Trigger for Event Detected.
     -- @function [parent=#DETECTION_BASE] __Detected
     -- @param #DETECTION_BASE self
     -- @param #number Delay The delay in seconds.
+    -- @param #table Units Table of detected units.
     
+    self:AddTransition( "Detecting", "DetectedItem", "Detecting" )
     
+    --- OnAfter Transition Handler for Event DetectedItem.
+    -- @function [parent=#DETECTION_BASE] OnAfterDetectedItem
+    -- @param #DETECTION_BASE self
+    -- @param #string From The From State string.
+    -- @param #string Event The Event string.
+    -- @param #string To The To State string.
+    -- @param #table DetectedItem The DetectedItem.
+      
     self:AddTransition( "*", "Stop", "Stopped" )
     
     --- OnBefore Transition Handler for Event Stop.
@@ -513,35 +548,77 @@ do -- DETECTION_BASE
       
       local DetectionTimeStamp = timer.getTime()
       
-      for DetectionGroupID, DetectionGroupData in pairs( self.DetectionSetGroup:GetSet() ) do
-        --self:F( { DetectionGroupData } )
-        self:__DetectionGroup( DetectDelay, DetectionGroupData, DetectionTimeStamp ) -- Process each detection asynchronously.
-        self.DetectionCount = self.DetectionCount + 1
-        DetectDelay = DetectDelay + 1
+      -- Reset detection cache for the next detection run.
+      for DetectionObjectName, DetectedObjectData in pairs( self.DetectedObjects ) do
+        
+        self.DetectedObjects[DetectionObjectName].IsDetected = false
+        self.DetectedObjects[DetectionObjectName].IsVisible = false
+        self.DetectedObjects[DetectionObjectName].KnowDistance = nil
+        self.DetectedObjects[DetectionObjectName].LastTime = nil
+        self.DetectedObjects[DetectionObjectName].LastPos = nil
+        self.DetectedObjects[DetectionObjectName].LastVelocity = nil
+        self.DetectedObjects[DetectionObjectName].Distance = 10000000
+      
       end
+      
+      -- Count alive(!) groups only. Solves issue #1173 https://github.com/FlightControl-Master/MOOSE/issues/1173
+      self.DetectionCount = self:CountAliveRecce()
+      
+      local DetectionInterval = self.DetectionCount / ( self.RefreshTimeInterval - 1 )
+      
+      self:ForEachAliveRecce(
+        function( DetectionGroup )
+          self:__Detection( DetectDelay, DetectionGroup, DetectionTimeStamp ) -- Process each detection asynchronously.
+          DetectDelay = DetectDelay + DetectionInterval
+        end
+      )
+      
+      self:__Detect( -self.RefreshTimeInterval )
+      
     end
+
+    --- @param #DETECTION_BASE self
+    -- @param #number The amount of alive recce.
+    function DETECTION_BASE:CountAliveRecce()
+
+      return self.DetectionSet:CountAlive()
+
+    end    
+    
+    --- @param #DETECTION_BASE self
+    function DETECTION_BASE:ForEachAliveRecce( IteratorFunction, ... )
+      self:F2( arg )
+      
+      self.DetectionSet:ForEachGroupAlive( IteratorFunction, arg )
+    
+      return self
+    end
+  
     
     --- @param #DETECTION_BASE self
     -- @param #string From The From State string.
     -- @param #string Event The Event string.
     -- @param #string To The To State string.
     -- @param Wrapper.Group#GROUP DetectionGroup The Group detecting.
-    function DETECTION_BASE:onafterDetectionGroup( From, Event, To, DetectionGroup, DetectionTimeStamp  )
+    -- @param #number DetectionTimeStamp Time stamp of detection event.
+    function DETECTION_BASE:onafterDetection( From, Event, To, Detection, DetectionTimeStamp  )
+      
+      --self:F( { DetectedObjects = self.DetectedObjects } )
       
       self.DetectionRun = self.DetectionRun + 1
       
       local HasDetectedObjects = false
       
-      if DetectionGroup:IsAlive() then
+      if Detection and Detection:IsAlive() then
     
         --self:T( { "DetectionGroup is Alive", DetectionGroup:GetName() } )
         
-        local DetectionGroupName = DetectionGroup:GetName()
-        local DetectionUnit = DetectionGroup:GetUnit(1)
+        local DetectionGroupName = Detection:GetName()
+        local DetectionUnit = Detection:GetUnit(1)
         
         local DetectedUnits = {}
         
-        local DetectedTargets = DetectionGroup:GetDetectedTargets(
+        local DetectedTargets = Detection:GetDetectedTargets(
           self.DetectVisual,
           self.DetectOptical,
           self.DetectRadar,
@@ -550,13 +627,27 @@ do -- DETECTION_BASE
           self.DetectDLINK
         )
         
-        --self:F( DetectedTargets )
+        self:F( { DetectedTargets = DetectedTargets } )
         
         for DetectionObjectID, Detection in pairs( DetectedTargets ) do
           local DetectedObject = Detection.object -- DCS#Object
           
           if DetectedObject and DetectedObject:isExist() and DetectedObject.id_ < 50000000 then -- and ( DetectedObject:getCategory() == Object.Category.UNIT or DetectedObject:getCategory() == Object.Category.STATIC ) then
-    
+            local DetectedObjectName = DetectedObject:getName()
+            if not self.DetectedObjects[DetectedObjectName] then
+              self.DetectedObjects[DetectedObjectName] = self.DetectedObjects[DetectedObjectName] or {} 
+              self.DetectedObjects[DetectedObjectName].Name = DetectedObjectName
+              self.DetectedObjects[DetectedObjectName].Object = DetectedObject
+            end
+          end
+        end
+        
+        for DetectionObjectName, DetectedObjectData in pairs( self.DetectedObjects ) do
+        
+          local DetectedObject = DetectedObjectData.Object
+          
+          if DetectedObject:isExist() then
+  
             local TargetIsDetected, TargetIsVisible, TargetLastTime, TargetKnowType, TargetKnowDistance, TargetLastPos, TargetLastVelocity = DetectionUnit:IsTargetDetected( 
               DetectedObject,
               self.DetectVisual,
@@ -568,7 +659,7 @@ do -- DETECTION_BASE
             )
             
             --self:T2( { TargetIsDetected = TargetIsDetected, TargetIsVisible = TargetIsVisible, TargetLastTime = TargetLastTime, TargetKnowType = TargetKnowType, TargetKnowDistance = TargetKnowDistance, TargetLastPos = TargetLastPos, TargetLastVelocity = TargetLastVelocity } )
-
+  
             -- Only process if the target is visible. Detection also returns invisible units.
             --if Detection.visible == true then
             
@@ -579,7 +670,7 @@ do -- DETECTION_BASE
       
               local DetectedObjectVec3 = DetectedObject:getPoint()
               local DetectedObjectVec2 = { x = DetectedObjectVec3.x, y = DetectedObjectVec3.z }
-              local DetectionGroupVec3 = DetectionGroup:GetVec3()
+              local DetectionGroupVec3 = Detection:GetVec3()
               local DetectionGroupVec2 = { x = DetectionGroupVec3.x, y = DetectionGroupVec3.z }
       
               local Distance = ( ( DetectedObjectVec3.x - DetectionGroupVec3.x )^2 +
@@ -631,7 +722,7 @@ do -- DETECTION_BASE
               
               -- Calculate additional probabilities
               
-              if not self.DetectedObjects[DetectedObjectName] and Detection.visible and self.DistanceProbability then
+              if not self.DetectedObjects[DetectedObjectName] and TargetIsVisible and self.DistanceProbability then
                 local DistanceFactor = Distance / 4
                 local DistanceProbabilityReversed = ( 1 - self.DistanceProbability ) * DistanceFactor
                 local DistanceProbability = 1 - DistanceProbabilityReversed
@@ -643,7 +734,7 @@ do -- DETECTION_BASE
                 end
               end
               
-              if not self.DetectedObjects[DetectedObjectName] and Detection.visible and self.AlphaAngleProbability then
+              if not self.DetectedObjects[DetectedObjectName] and TargetIsVisible and self.AlphaAngleProbability then
                 local NormalVec2 = { x = DetectedObjectVec2.x - DetectionGroupVec2.x, y = DetectedObjectVec2.y - DetectionGroupVec2.y }
                 local AlphaAngle = math.atan2( NormalVec2.y, NormalVec2.x )
                 local Sinus = math.sin( AlphaAngle )
@@ -660,7 +751,7 @@ do -- DETECTION_BASE
                  
               end
               
-              if not self.DetectedObjects[DetectedObjectName] and Detection.visible and self.ZoneProbability then
+              if not self.DetectedObjects[DetectedObjectName] and TargetIsVisible and self.ZoneProbability then
               
                 for ZoneDataID, ZoneData in pairs( self.ZoneProbability ) do
                   self:F({ZoneData})
@@ -683,33 +774,50 @@ do -- DETECTION_BASE
                 
                 HasDetectedObjects = true
       
-                self.DetectedObjects[DetectedObjectName] = self.DetectedObjects[DetectedObjectName] or {} 
+                self.DetectedObjects[DetectedObjectName] = self.DetectedObjects[DetectedObjectName] or {}
                 self.DetectedObjects[DetectedObjectName].Name = DetectedObjectName
-                self.DetectedObjects[DetectedObjectName].IsDetected = TargetIsDetected
-                self.DetectedObjects[DetectedObjectName].IsVisible = TargetIsVisible 
-                self.DetectedObjects[DetectedObjectName].LastTime = TargetLastTime
-                self.DetectedObjects[DetectedObjectName].LastPos = TargetLastPos
-                self.DetectedObjects[DetectedObjectName].LastVelocity = TargetLastVelocity
-                self.DetectedObjects[DetectedObjectName].KnowType = TargetKnowType
-                self.DetectedObjects[DetectedObjectName].KnowDistance = Detection.distance   -- TargetKnowDistance
-                self.DetectedObjects[DetectedObjectName].Distance = Distance
+  
+                if TargetIsDetected and TargetIsDetected == true then
+                  self.DetectedObjects[DetectedObjectName].IsDetected = TargetIsDetected
+                end
+                
+                if TargetIsDetected and TargetIsVisible and TargetIsVisible == true then
+                  self.DetectedObjects[DetectedObjectName].IsVisible = TargetIsDetected and TargetIsVisible
+                end
+                
+                if TargetIsDetected and not self.DetectedObjects[DetectedObjectName].KnowType then
+                  self.DetectedObjects[DetectedObjectName].KnowType = TargetIsDetected and TargetKnowType
+                end
+                self.DetectedObjects[DetectedObjectName].KnowDistance = TargetKnowDistance -- Detection.distance   -- TargetKnowDistance
+                self.DetectedObjects[DetectedObjectName].LastTime = ( TargetIsDetected and TargetIsVisible == false )  and TargetLastTime
+                self.DetectedObjects[DetectedObjectName].LastPos = ( TargetIsDetected and TargetIsVisible == false )  and TargetLastPos
+                self.DetectedObjects[DetectedObjectName].LastVelocity = ( TargetIsDetected and TargetIsVisible == false )  and TargetLastVelocity
+                
+                if not self.DetectedObjects[DetectedObjectName].Distance or ( Distance and self.DetectedObjects[DetectedObjectName].Distance > Distance ) then
+                  self.DetectedObjects[DetectedObjectName].Distance = Distance
+                end
+  
                 self.DetectedObjects[DetectedObjectName].DetectionTimeStamp = DetectionTimeStamp
                 
-                --self:F( { DetectedObject = self.DetectedObjects[DetectedObjectName] } )
+                self:F( { DetectedObject = self.DetectedObjects[DetectedObjectName] } )
                 
                 local DetectedUnit = UNIT:FindByName( DetectedObjectName )
                 
                 DetectedUnits[DetectedObjectName] = DetectedUnit
               else
                 -- if beyond the DetectionRange then nullify...
+                self:F( { DetectedObject = "No more detection for " .. DetectedObjectName } )
                 if self.DetectedObjects[DetectedObjectName] then
                   self.DetectedObjects[DetectedObjectName] = nil
                 end
               end
-            --end
+            
+            --self:T2( self.DetectedObjects )
+          else
+            -- The previously detected object does not exist anymore, delete from the cache.
+            self:F( "Removing from DetectedObjects: " .. DetectionObjectName )
+            self.DetectedObjects[DetectionObjectName] = nil
           end
-          
-          --self:T2( self.DetectedObjects )
         end
         
         if HasDetectedObjects then
@@ -726,20 +834,27 @@ do -- DETECTION_BASE
         -- IsDetected = false!
         -- This is used in A2A_TASK_DISPATCHER to initiate fighter sweeping! The TASK_A2A_INTERCEPT tasks will be replaced with TASK_A2A_SWEEP tasks.
         for DetectedObjectName, DetectedObject in pairs( self.DetectedObjects ) do
-          if self.DetectedObjects[DetectedObjectName].IsDetected == true and self.DetectedObjects[DetectedObjectName].DetectionTimeStamp + 60 <= DetectionTimeStamp then
+          if self.DetectedObjects[DetectedObjectName].IsDetected == true and self.DetectedObjects[DetectedObjectName].DetectionTimeStamp + 300 <= DetectionTimeStamp then
             self.DetectedObjects[DetectedObjectName].IsDetected = false
           end
         end
 
         self:CreateDetectionItems() -- Polymorphic call to Create/Update the DetectionItems list for the DETECTION_ class grouping method.
+        
         for DetectedItemID, DetectedItem in pairs( self.DetectedItems ) do
+        
           self:UpdateDetectedItemDetection( DetectedItem )
+          
           self:CleanDetectionItem( DetectedItem, DetectedItemID ) -- Any DetectionItem that has a Set with zero elements in it, must be removed from the DetectionItems list.
+          
+          if DetectedItem then
+            self:__DetectedItem( 0.1, DetectedItem )
+          end
+          
         end
- 
-        self:__Detect( self.RefreshTimeInterval )
       end
 
+
     end
   
   
@@ -747,7 +862,7 @@ do -- DETECTION_BASE
   
   do -- DetectionItems Creation
   
-    -- Clean the DetectedItem table.
+    --- Clean the DetectedItem table.
     -- @param #DETECTION_BASE self
     -- @return #DETECTION_BASE
     function DETECTION_BASE:CleanDetectionItem( DetectedItem, DetectedItemID )
@@ -773,7 +888,7 @@ do -- DETECTION_BASE
       local DetectedItems = self:GetDetectedItems()
       
       for DetectedItemIndex, DetectedItem in pairs( DetectedItems ) do
-        local DetectedSet = self:GetDetectedSet( DetectedItem )
+        local DetectedSet = self:GetDetectedItemSet( DetectedItem )
         if DetectedSet then
           DetectedSet:RemoveUnitsByName( UnitName )
         end
@@ -947,7 +1062,7 @@ do -- DETECTION_BASE
     --- Set the parameters to calculate to optimal intercept point.
     -- @param #DETECTION_BASE self
     -- @param #boolean Intercept Intercept is true if an intercept point is calculated. Intercept is false if it is disabled. The default Intercept is false.
-    -- @param #number IntereptDelay If Intercept is true, then InterceptDelay is the average time it takes to get airplanes airborne.
+    -- @param #number InterceptDelay If Intercept is true, then InterceptDelay is the average time it takes to get airplanes airborne.
     -- @return #DETECTION_BASE self
     function DETECTION_BASE:SetIntercept( Intercept, InterceptDelay )
       self:F2()
@@ -1164,17 +1279,17 @@ do -- DETECTION_BASE
   
     --- Returns if there are friendlies nearby the FAC units ...
     -- @param #DETECTION_BASE self
-    -- @param DetectedItem
+    -- @param #DETECTION_BASE.DetectedItem DetectedItem
     -- @param DCS#Unit.Category Category The category of the unit.
     -- @return #boolean true if there are friendlies nearby 
     function DETECTION_BASE:IsFriendliesNearBy( DetectedItem, Category )
-      --self:F( { "FriendliesNearBy Test", DetectedItem.FriendliesNearBy } )
+--      self:F( { "FriendliesNearBy Test", DetectedItem.FriendliesNearBy } )
       return ( DetectedItem.FriendliesNearBy and DetectedItem.FriendliesNearBy[Category] ~= nil ) or false
     end
   
     --- Returns friendly units nearby the FAC units ...
     -- @param #DETECTION_BASE self
-    -- @param DetectedItem
+    -- @param #DETECTION_BASE.DetectedItem DetectedItem
     -- @param DCS#Unit.Category Category The category of the unit.
     -- @return #map<#string,Wrapper.Unit#UNIT> The map of Friendly UNITs. 
     function DETECTION_BASE:GetFriendliesNearBy( DetectedItem, Category )
@@ -1184,6 +1299,7 @@ do -- DETECTION_BASE
     
     --- Returns if there are friendlies nearby the intercept ...
     -- @param #DETECTION_BASE self
+    -- @param #DETECTION_BASE.DetectedItem DetectedItem
     -- @return #boolean trhe if there are friendlies near the intercept.
     function DETECTION_BASE:IsFriendliesNearIntercept( DetectedItem )
       
@@ -1192,6 +1308,7 @@ do -- DETECTION_BASE
   
     --- Returns friendly units nearby the intercept point ...
     -- @param #DETECTION_BASE self
+    -- @param #DETECTION_BASE.DetectedItem DetectedItem The detected item.
     -- @return #map<#string,Wrapper.Unit#UNIT> The map of Friendly UNITs. 
     function DETECTION_BASE:GetFriendliesNearIntercept( DetectedItem )
       
@@ -1200,7 +1317,8 @@ do -- DETECTION_BASE
   
     --- Returns the distance used to identify friendlies near the deteted item ...
     -- @param #DETECTION_BASE self
-    -- @return #number The distance. 
+    -- @param #DETECTION_BASE.DetectedItem DetectedItem The detected item.
+    -- @return #table A table of distances to friendlies. 
     function DETECTION_BASE:GetFriendliesDistance( DetectedItem )
       
       return DetectedItem.FriendliesDistance
@@ -1208,6 +1326,7 @@ do -- DETECTION_BASE
   
     --- Returns if there are friendlies nearby the FAC units ...
     -- @param #DETECTION_BASE self
+    -- @param #DETECTION_BASE.DetectedItem DetectedItem
     -- @return #boolean trhe if there are friendlies nearby 
     function DETECTION_BASE:IsPlayersNearBy( DetectedItem )
       
@@ -1216,6 +1335,7 @@ do -- DETECTION_BASE
   
     --- Returns friendly units nearby the FAC units ...
     -- @param #DETECTION_BASE self
+    -- @param #DETECTION_BASE.DetectedItem DetectedItem The detected item.
     -- @return #map<#string,Wrapper.Unit#UNIT> The map of Friendly UNITs. 
     function DETECTION_BASE:GetPlayersNearBy( DetectedItem )
       
@@ -1224,10 +1344,11 @@ do -- DETECTION_BASE
   
     --- Background worker function to determine if there are friendlies nearby ...
     -- @param #DETECTION_BASE self
+    -- @param #table TargetData
     function DETECTION_BASE:ReportFriendliesNearBy( TargetData )
       --self:F( { "Search Friendlies", DetectedItem = TargetData.DetectedItem } )
       
-      local DetectedItem = TargetData.DetectedItem  -- Functional.Detection#DETECTION_BASE.DetectedItem    
+      local DetectedItem = TargetData.DetectedItem  --#DETECTION_BASE.DetectedItem    
       local DetectedSet = TargetData.DetectedItem.Set
       local DetectedUnit = DetectedSet:GetFirst() -- Wrapper.Unit#UNIT
     
@@ -1311,14 +1432,14 @@ do -- DETECTION_BASE
         world.searchObjects( Object.Category.UNIT, SphereSearch, FindNearByFriendlies, TargetData )
 
         DetectedItem.PlayersNearBy = nil
-        local DetectionZone = ZONE_UNIT:New( "DetectionPlayers", DetectedUnit, self.FriendliesRange )
         
         _DATABASE:ForEachPlayer(
           --- @param Wrapper.Unit#UNIT PlayerUnit
           function( PlayerUnitName )
             local PlayerUnit = UNIT:FindByName( PlayerUnitName )
 
-            if PlayerUnit and PlayerUnit:IsInZone(DetectionZone) then
+            if PlayerUnit and PlayerUnit:GetCoordinate():IsInRadius( DetectedUnitCoord, self.FriendliesRange ) then
+            --if PlayerUnit and PlayerUnit:IsInZone(DetectionZone) then
 
               local PlayerUnitCategory = PlayerUnit:GetDesc().category
     
@@ -1396,16 +1517,18 @@ do -- DETECTION_BASE
   -- @param #string ObjectName
   -- @return #DETECTION_BASE.DetectedObject
   function DETECTION_BASE:GetDetectedObject( ObjectName )
-  	--self:F2( ObjectName )
+  	self:F2( { ObjectName = ObjectName } )
     
     if ObjectName then
       local DetectedObject = self.DetectedObjects[ObjectName]
       
       if DetectedObject then
+        --self:F( { DetectedObjects = self.DetectedObjects } )
         -- Only return detected objects that are alive!
         local DetectedUnit = UNIT:FindByName( ObjectName )
         if DetectedUnit and DetectedUnit:IsAlive() then
           if self:IsDetectedObjectIdentified( DetectedObject ) == false then
+            --self:F( { DetectedObject = DetectedObject } )
             return DetectedObject
           end
         end
@@ -1447,31 +1570,31 @@ do -- DETECTION_BASE
   --- Adds a new DetectedItem to the DetectedItems list.
   -- The DetectedItem is a table and contains a SET_UNIT in the field Set.
   -- @param #DETECTION_BASE self
-  -- @param ItemPrefix
-  -- @param DetectedItemKey The key of the DetectedItem.
+  -- @param #string ItemPrefix Prefix of detected item.
+  -- @param #number DetectedItemKey The key of the DetectedItem. Default self.DetectedItemMax. Could also be a string in principle.
   -- @param Core.Set#SET_UNIT Set (optional) The Set of Units to be added.
   -- @return #DETECTION_BASE.DetectedItem
   function DETECTION_BASE:AddDetectedItem( ItemPrefix, DetectedItemKey, Set )
   
-    local DetectedItem = {}
+    local DetectedItem = {} --#DETECTION_BASE.DetectedItem
     self.DetectedItemCount = self.DetectedItemCount + 1
     self.DetectedItemMax = self.DetectedItemMax + 1
     
-    if DetectedItemKey then
-      self.DetectedItems[DetectedItemKey] = DetectedItem
-    else
-      self.DetectedItems[self.DetectedItemMax] = DetectedItem
-    end
-    
-    self.DetectedItemsByIndex[self.DetectedItemMax] = DetectedItem
     
+    DetectedItemKey = DetectedItemKey or self.DetectedItemMax
+    self.DetectedItems[DetectedItemKey] = DetectedItem
+    self.DetectedItemsByIndex[DetectedItemKey] = DetectedItem
+    DetectedItem.Index = DetectedItemKey
     
     DetectedItem.Set = Set or SET_UNIT:New():FilterDeads():FilterCrashes()
-    DetectedItem.Index = DetectedItemKey or self.DetectedItemMax
     DetectedItem.ItemID = ItemPrefix .. "." .. self.DetectedItemMax
     DetectedItem.ID = self.DetectedItemMax
     DetectedItem.Removed = false
     
+    if self.Locking then
+      self:LockDetectedItem( DetectedItem )
+    end
+    
     return DetectedItem
   end
   
@@ -1482,9 +1605,11 @@ do -- DETECTION_BASE
   -- @param Core.Set#SET_UNIT Set (optional) The Set of Units to be added.
   -- @param Core.Zone#ZONE_UNIT Zone (optional) The Zone to be added where the Units are located.
   -- @return #DETECTION_BASE.DetectedItem
-  function DETECTION_BASE:AddDetectedItemZone( DetectedItemKey, Set, Zone )
+  function DETECTION_BASE:AddDetectedItemZone( ItemPrefix, DetectedItemKey, Set, Zone )
   
-    local DetectedItem = self:AddDetectedItem( "AREA", DetectedItemKey, Set )
+    self:F( { ItemPrefix, DetectedItemKey, Set, Zone } )
+  
+    local DetectedItem = self:AddDetectedItem( ItemPrefix, DetectedItemKey, Set )
 
     DetectedItem.Zone = Zone
     
@@ -1557,7 +1682,7 @@ do -- DETECTION_BASE
   -- @return #DETECTION_BASE.DetectedItem
   function DETECTION_BASE:GetDetectedItemByIndex( Index )
   
-    self:F( { DetectedItemsByIndex = self.DetectedItemsByIndex } )
+    self:F( { self.DetectedItemsByIndex } )
     
     local DetectedItem = self.DetectedItemsByIndex[Index]
     if DetectedItem then
@@ -1594,7 +1719,7 @@ do -- DETECTION_BASE
   -- @param #DETECTION_BASE self
   -- @param #DETECTION_BASE.DetectedItem DetectedItem
   -- @return Core.Set#SET_UNIT DetectedSet
-  function DETECTION_BASE:GetDetectedSet( DetectedItem )
+  function DETECTION_BASE:GetDetectedItemSet( DetectedItem )
   
     local DetectedSetUnit = DetectedItem and DetectedItem.Set
     if DetectedSetUnit then
@@ -1604,7 +1729,7 @@ do -- DETECTION_BASE
     return nil
   end
   
-  --- Set IsDetected flag for all DetectedItems.
+  --- Set IsDetected flag for the DetectedItem, which can have more units.
   -- @param #DETECTION_BASE self
   -- @return #DETECTION_BASE.DetectedItem DetectedItem
   -- @return #boolean true if at least one UNIT is detected from the DetectedSet, false if no UNIT was detected from the DetectedSet.
@@ -1630,6 +1755,7 @@ do -- DETECTION_BASE
 
   --- Checks if there is at least one UNIT detected in the Set of the the DetectedItem.
   -- @param #DETECTION_BASE self
+  -- @param #DETECTION_BASE.DetectedItem DetectedItem
   -- @return #boolean true if at least one UNIT is detected from the DetectedSet, false if no UNIT was detected from the DetectedSet.
   function DETECTION_BASE:IsDetectedItemDetected( DetectedItem ) 
   
@@ -1657,6 +1783,68 @@ do -- DETECTION_BASE
 
   end  
 
+  --- Lock the detected items when created and lock all existing detected items.
+  -- @param #DETECTION_BASE self
+  -- @return #DETECTION_BASE
+  function DETECTION_BASE:LockDetectedItems()
+
+    for DetectedItemID, DetectedItem in pairs( self.DetectedItems ) do
+      self:LockDetectedItem( DetectedItem )
+    end
+    self.Locking = true
+
+    return self
+  end
+
+
+  --- Unlock the detected items when created and unlock all existing detected items.
+  -- @param #DETECTION_BASE self
+  -- @return #DETECTION_BASE
+  function DETECTION_BASE:UnlockDetectedItems()
+
+    for DetectedItemID, DetectedItem in pairs( self.DetectedItems ) do
+      self:UnlockDetectedItem( DetectedItem )
+    end
+    self.Locking = nil
+
+    return self
+  end
+  
+  --- Validate if the detected item is locked.
+  -- @param #DETECTION_BASE self
+  -- @param #DETECTION_BASE.DetectedItem DetectedItem The DetectedItem.
+  -- @return #boolean
+  function DETECTION_BASE:IsDetectedItemLocked( DetectedItem )
+
+    return self.Locking and DetectedItem.Locked == true
+
+  end
+  
+
+  --- Lock a detected item.
+  -- @param #DETECTION_BASE self
+  -- @param #DETECTION_BASE.DetectedItem DetectedItem The DetectedItem.
+  -- @return #DETECTION_BASE
+  function DETECTION_BASE:LockDetectedItem( DetectedItem )
+
+    DetectedItem.Locked = true
+
+    return self
+  end
+
+  --- Unlock a detected item.
+  -- @param #DETECTION_BASE self
+  -- @param #DETECTION_BASE.DetectedItem DetectedItem The DetectedItem.
+  -- @return #DETECTION_BASE
+  function DETECTION_BASE:UnlockDetectedItem( DetectedItem )
+
+    DetectedItem.Locked = nil
+
+    return self
+  end
+
+
+
 
   --- Set the detected item coordinate.
   -- @param #DETECTION_BASE self
@@ -1692,6 +1880,20 @@ do -- DETECTION_BASE
     return nil
   end
 
+  --- Get a list of the detected item coordinates.
+  -- @param #DETECTION_BASE self
+  -- @return #table A table of Core.Point#COORDINATE
+  function DETECTION_BASE:GetDetectedItemCoordinates()
+  
+    local Coordinates = {}
+  
+    for DetectedItemID, DetectedItem in pairs( self:GetDetectedItems() ) do
+      Coordinates[DetectedItem] = self:GetDetectedItemCoordinate( DetectedItem )
+    end
+  
+    return Coordinates
+  end
+
   --- Set the detected item threatlevel.
   -- @param #DETECTION_BASE self
   -- @param #DETECTION_BASE.DetectedItem The DetectedItem to calculate the threatlevel for.
@@ -1743,13 +1945,13 @@ do -- DETECTION_BASE
     return nil
   end
   
-  --- Get the detection Groups.
+  --- Get the Detection Set.
   -- @param #DETECTION_BASE self
-  -- @return Core.Set#SET_GROUP
-  function DETECTION_BASE:GetDetectionSetGroup()
+  -- @return #DETECTION_BASE self
+  function DETECTION_BASE:GetDetectionSet()
   
-    local DetectionSetGroup = self.DetectionSetGroup
-    return DetectionSetGroup
+    local DetectionSet = self.DetectionSet
+    return DetectionSet
   end
   
     --- Find the nearest Recce of the DetectedItem.
@@ -1761,7 +1963,7 @@ do -- DETECTION_BASE
     local NearestRecce = nil
     local DistanceRecce = 1000000000 -- Units are not further than 1000000 km away from an area :-)
     
-    for RecceGroupName, RecceGroup in pairs( self.DetectionSetGroup:GetSet() ) do
+    for RecceGroupName, RecceGroup in pairs( self.DetectionSet:GetSet() ) do
       if RecceGroup and RecceGroup:IsAlive() then
         for RecceUnit, RecceUnit in pairs( RecceGroup:GetUnits() ) do
           if RecceUnit:IsActive() then
@@ -1802,14 +2004,16 @@ end
 
 do -- DETECTION_UNITS
 
+  --- @type DETECTION_UNITS
+  -- @field DCS#Distance DetectionRange The range till which targets are detected.
+  -- @extends Functional.Detection#DETECTION_BASE
+
   --- Will detect units within the battle zone.
   -- 
   -- It will build a DetectedItems list filled with DetectedItems. Each DetectedItem will contain a field Set, which contains a @{Core.Set#SET_UNIT} containing ONE @{UNIT} object reference.
   -- Beware that when the amount of units detected is large, the DetectedItems list will be large also. 
   -- 
-  -- @type DETECTION_UNITS
-  -- @field DCS#Distance DetectionRange The range till which targets are detected.
-  -- @extends #DETECTION_BASE
+  -- @field #DETECTION_UNITS
   DETECTION_UNITS = {
     ClassName = "DETECTION_UNITS",
     DetectionRange = nil,
@@ -1835,7 +2039,7 @@ do -- DETECTION_UNITS
 
   --- Make text documenting the changes of the detected zone.
   -- @param #DETECTION_UNITS self
-  -- @param #DETECTION_UNITS.DetectedItem DetectedItem
+  -- @param #DETECTION_BASE.DetectedItem DetectedItem
   -- @return #string The Changes text
   function DETECTION_UNITS:GetChangeText( DetectedItem )
     self:F( DetectedItem )
@@ -1876,10 +2080,10 @@ do -- DETECTION_UNITS
   -- @param #DETECTION_UNITS self
   -- @return #DETECTION_UNITS self
   function DETECTION_UNITS:CreateDetectionItems()
-  
     -- Loop the current detected items, and check if each object still exists and is detected.
     
-    for DetectedItemKey, DetectedItem in pairs( self.DetectedItems ) do
+    for DetectedItemKey, _DetectedItem in pairs( self.DetectedItems ) do
+      local DetectedItem=_DetectedItem --#DETECTION_BASE.DetectedItem
     
       local DetectedItemSet = DetectedItem.Set -- Core.Set#SET_UNIT
       
@@ -1897,6 +2101,7 @@ do -- DETECTION_UNITS
           -- Yes, the DetectedUnit is still detected or exists. Flag as identified.
           self:IdentifyDetectedObject( DetectedObject )
           
+          self:F( { "**DETECTED**", IsVisible = DetectedObject.IsVisible } )
           -- Update the detection with the new data provided.
           DetectedItem.TypeName = DetectedUnit:GetTypeName()            
           DetectedItem.CategoryName = DetectedUnit:GetCategoryName()            
@@ -1964,7 +2169,7 @@ do -- DETECTION_UNITS
       local DetectedFirstUnitCoord = DetectedFirstUnit:GetCoordinate()
       self:SetDetectedItemCoordinate( DetectedItem, DetectedFirstUnitCoord, DetectedFirstUnit )
 
-      self:ReportFriendliesNearBy( { DetectedItem = DetectedItem, ReportSetGroup = self.DetectionSetGroup } ) -- Fill the Friendlies table
+      self:ReportFriendliesNearBy( { DetectedItem = DetectedItem, ReportSetGroup = self.DetectionSet } ) -- Fill the Friendlies table
       self:SetDetectedItemThreatLevel( DetectedItem )
       self:NearestRecce( DetectedItem )
       
@@ -2021,6 +2226,9 @@ do -- DETECTION_UNITS
       Report:Add(DetectedItemID .. ", " .. DetectedItemCoordText)
       Report:Add( string.format( "Threat: [%s]", string.rep(  "■", ThreatLevelA2G ), string.rep(  "□", 10-ThreatLevelA2G ) ) )
       Report:Add( string.format("Type: %s%s", UnitCategoryText, UnitDistanceText ) )
+      Report:Add( string.format("Visible: %s", DetectedItem.IsVisible and "yes" or "no" ) )
+      Report:Add( string.format("Detected: %s", DetectedItem.IsDetected and "yes" or "no" ) )
+      Report:Add( string.format("Distance: %s", DetectedItem.KnowDistance and "yes" or "no" ) )
       return Report
     end
     return nil
@@ -2051,13 +2259,15 @@ end
 
 do -- DETECTION_TYPES
 
+  --- @type DETECTION_TYPES
+  -- @extends Functional.Detection#DETECTION_BASE
+
   --- Will detect units within the battle zone.
   -- It will build a DetectedItems[] list filled with DetectedItems, grouped by the type of units detected. 
   -- Each DetectedItem will contain a field Set, which contains a @{Core.Set#SET_UNIT} containing ONE @{UNIT} object reference.
   -- Beware that when the amount of different types detected is large, the DetectedItems[] list will be large also. 
   -- 
-  -- @type DETECTION_TYPES
-  -- @extends #DETECTION_BASE
+  -- @field #DETECTION_TYPES
   DETECTION_TYPES = {
     ClassName = "DETECTION_TYPES",
     DetectionRange = nil,
@@ -2083,7 +2293,7 @@ do -- DETECTION_TYPES
 
   --- Make text documenting the changes of the detected zone.
   -- @param #DETECTION_TYPES self
-  -- @param #DETECTION_TYPES.DetectedItem DetectedItem
+  -- @param Functional.Detection#DETECTION_BASE.DetectedItem DetectedItem
   -- @return #string The Changes text
   function DETECTION_TYPES:GetChangeText( DetectedItem )
     self:F( DetectedItem )
@@ -2194,7 +2404,7 @@ do -- DETECTION_TYPES
       local DetectedUnitCoord = DetectedFirstUnit:GetCoordinate()
       self:SetDetectedItemCoordinate( DetectedItem, DetectedUnitCoord, DetectedFirstUnit )
 
-      self:ReportFriendliesNearBy( { DetectedItem = DetectedItem, ReportSetGroup = self.DetectionSetGroup } ) -- Fill the Friendlies table
+      self:ReportFriendliesNearBy( { DetectedItem = DetectedItem, ReportSetGroup = self.DetectionSet } ) -- Fill the Friendlies table
       self:SetDetectedItemThreatLevel( DetectedItem )
       self:NearestRecce( DetectedItem )
     end
@@ -2212,7 +2422,7 @@ do -- DETECTION_TYPES
   function DETECTION_TYPES:DetectedItemReportSummary( DetectedItem, AttackGroup, Settings )
     self:F( { DetectedItem = DetectedItem } )
   
-    local DetectedSet = self:GetDetectedSet( DetectedItem )
+    local DetectedSet = self:GetDetectedItemSet( DetectedItem )
     local DetectedItemID = self:GetDetectedItemID( DetectedItem )
     
     self:T( DetectedItem )
@@ -2258,6 +2468,11 @@ end
 
 do -- DETECTION_AREAS
 
+  --- @type DETECTION_AREAS
+  -- @field DCS#Distance DetectionZoneRange The range till which targets are grouped upon the first detected target.
+  -- @field #DETECTION_BASE.DetectedItems DetectedItems A list of areas containing the set of @{Wrapper.Unit}s, @{Zone}s, the center @{Wrapper.Unit} within the zone, and ID of each area that was detected within a DetectionZoneRange.
+  -- @extends Functional.Detection#DETECTION_BASE
+
   --- Detect units within the battle zone for a list of @{Wrapper.Group}s detecting targets following (a) detection method(s), 
   -- and will build a list (table) of @{Core.Set#SET_UNIT}s containing the @{Wrapper.Unit#UNIT}s detected.
   -- The class is group the detected units within zones given a DetectedZoneRange parameter.
@@ -2288,10 +2503,7 @@ do -- DETECTION_AREAS
   --   
   -- the detected zones when a new detection has taken place.
   -- 
-  -- @type DETECTION_AREAS
-  -- @field DCS#Distance DetectionZoneRange The range till which targets are grouped upon the first detected target.
-  -- @field #DETECTION_BASE.DetectedItems DetectedItems A list of areas containing the set of @{Wrapper.Unit}s, @{Zone}s, the center @{Wrapper.Unit} within the zone, and ID of each area that was detected within a DetectionZoneRange.
-  -- @extends #DETECTION_BASE
+  -- @field #DETECTION_AREAS
   DETECTION_AREAS = {
     ClassName = "DETECTION_AREAS",
     DetectionZoneRange = nil,
@@ -2326,27 +2538,67 @@ do -- DETECTION_AREAS
   -- @param Wrapper.Group#GROUP AttackGroup The group to get the settings for.
   -- @param Core.Settings#SETTINGS Settings (Optional) Message formatting settings to use.
   -- @return Core.Report#REPORT The report of the detection items.
-  function DETECTION_AREAS:DetectedItemReportSummary( DetectedItem, AttackGroup, Settings )
+  function DETECTION_AREAS:DetectedItemReportMenu( DetectedItem, AttackGroup, Settings )
     self:F( { DetectedItem = DetectedItem } )
   
     local DetectedItemID = self:GetDetectedItemID( DetectedItem )
     
     if DetectedItem then
-      local DetectedSet = self:GetDetectedSet( DetectedItem )
+      local DetectedSet = self:GetDetectedItemSet( DetectedItem )
       local ReportSummaryItem
       
       local DetectedZone = self:GetDetectedItemZone( DetectedItem )
       local DetectedItemCoordinate = DetectedZone:GetCoordinate()
       local DetectedItemCoordText = DetectedItemCoordinate:ToString( AttackGroup, Settings )
 
+      local ThreatLevelA2G = self:GetDetectedItemThreatLevel( DetectedItem )
+      
+      local Report = REPORT:New()
+      Report:Add( DetectedItemID )
+      Report:Add( string.format( "Threat: [%s%s]", string.rep(  "■", ThreatLevelA2G ), string.rep(  "□", 10-ThreatLevelA2G ) ) )
+      
+      return Report
+    end
+    
+    return nil
+  end
+
+  --- Report summary of a detected item using a given numeric index.
+  -- @param #DETECTION_AREAS self
+  -- @param #DETECTION_BASE.DetectedItem DetectedItem The DetectedItem.
+  -- @param Wrapper.Group#GROUP AttackGroup The group to get the settings for.
+  -- @param Core.Settings#SETTINGS Settings (Optional) Message formatting settings to use.
+  -- @return Core.Report#REPORT The report of the detection items.
+  function DETECTION_AREAS:DetectedItemReportSummary( DetectedItem, AttackGroup, Settings )
+    self:F( { DetectedItem = DetectedItem } )
+  
+    local DetectedItemID = self:GetDetectedItemID( DetectedItem )
+    
+    if DetectedItem then
+      local DetectedSet = self:GetDetectedItemSet( DetectedItem )
+      local ReportSummaryItem
+      
+      --local DetectedZone = self:GetDetectedItemZone( DetectedItem )
+      local DetectedItemCoordinate = self:GetDetectedItemCoordinate( DetectedItem )
+      local DetectedAir = DetectedSet:HasAirUnits()
+      local DetectedAltitude = self:GetDetectedItemCoordinate( DetectedItem )
+      local DetectedItemCoordText = ""
+      if DetectedAir > 0 then
+        DetectedItemCoordText = DetectedItemCoordinate:ToStringA2A( AttackGroup, Settings )
+      else
+        DetectedItemCoordText = DetectedItemCoordinate:ToStringA2G( AttackGroup, Settings )
+      end
+      
+
       local ThreatLevelA2G = self:GetDetectedItemThreatLevel( DetectedItem )
       local DetectedItemsCount = DetectedSet:Count()
       local DetectedItemsTypes = DetectedSet:GetTypeNames()
       
       local Report = REPORT:New()
       Report:Add(DetectedItemID .. ", " .. DetectedItemCoordText)
-      Report:Add( string.format( "Threat: [%s]", string.rep(  "■", ThreatLevelA2G ), string.rep(  "□", 10-ThreatLevelA2G ) ) )
+      Report:Add( string.format( "Threat: [%s%s]", string.rep(  "■", ThreatLevelA2G ), string.rep(  "□", 10-ThreatLevelA2G ) ) )
       Report:Add( string.format("Type: %2d of %s", DetectedItemsCount, DetectedItemsTypes ) )
+      --Report:Add( string.format("Detected: %s", DetectedItem.IsDetected and "yes" or "no" ) )
       
       return Report
     end
@@ -2511,7 +2763,9 @@ do -- DETECTION_AREAS
   function DETECTION_AREAS:CreateDetectionItems()
   
   
-    self:T2( "Checking Detected Items for new Detected Units ..." )
+    self:F( "Checking Detected Items for new Detected Units ..." )
+    --self:F( { DetectedObjects = self.DetectedObjects } )
+    
     -- First go through all detected sets, and check if there are new detected units, match all existing detected units and identify undetected units.
     -- Regroup when needed, split groups when needed.
     for DetectedItemID, DetectedItemData in pairs( self.DetectedItems ) do
@@ -2662,7 +2916,7 @@ do -- DETECTION_AREAS
         if AddedToDetectionArea == false then
         
           -- New detection area
-          local DetectedItem = self:AddDetectedItemZone( nil, 
+          local DetectedItem = self:AddDetectedItemZone( "AREA", nil, 
             SET_UNIT:New():FilterDeads():FilterCrashes(),
             ZONE_UNIT:New( DetectedUnitName, DetectedUnit, self.DetectionZoneRange )
           )
@@ -2694,7 +2948,7 @@ do -- DETECTION_AREAS
       -- If there were friendlies nearby, and now there aren't any friendlies nearby, we flag the area as "changed".
       -- This is for the A2G dispatcher to detect if there is a change in the tactical situation.
       local OldFriendliesNearbyGround = self:IsFriendliesNearBy( DetectedItem, Unit.Category.GROUND_UNIT )
-      self:ReportFriendliesNearBy( { DetectedItem = DetectedItem, ReportSetGroup = self.DetectionSetGroup } ) -- Fill the Friendlies table
+      self:ReportFriendliesNearBy( { DetectedItem = DetectedItem, ReportSetGroup = self.DetectionSet } ) -- Fill the Friendlies table
       local NewFriendliesNearbyGround = self:IsFriendliesNearBy( DetectedItem, Unit.Category.GROUND_UNIT  )
       if OldFriendliesNearbyGround ~= NewFriendliesNearbyGround then
         DetectedItem.Changed = true
@@ -2740,3 +2994,5 @@ do -- DETECTION_AREAS
   end
   
 end  
+
+ 

Moose Development/Moose/Functional/DetectionZones.lua

@@ -0,0 +1,416 @@
+do -- DETECTION_ZONES
+
+  --- @type DETECTION_ZONES
+  -- @field DCS#Distance DetectionZoneRange The range till which targets are grouped upon the first detected target.
+  -- @field #DETECTION_BASE.DetectedItems DetectedItems A list of areas containing the set of @{Wrapper.Unit}s, @{Zone}s, the center @{Wrapper.Unit} within the zone, and ID of each area that was detected within a DetectionZoneRange.
+  -- @extends Functional.Detection#DETECTION_BASE
+
+  --- (old, to be revised ) Detect units within the battle zone for a list of @{Core.Zone}s detecting targets following (a) detection method(s), 
+  -- and will build a list (table) of @{Core.Set#SET_UNIT}s containing the @{Wrapper.Unit#UNIT}s detected.
+  -- The class is group the detected units within zones given a DetectedZoneRange parameter.
+  -- A set with multiple detected zones will be created as there are groups of units detected.
+  -- 
+  -- ## 4.1) Retrieve the Detected Unit Sets and Detected Zones
+  -- 
+  -- The methods to manage the DetectedItems[].Set(s) are implemented in @{Functional.Detection#DECTECTION_BASE} and 
+  -- the methods to manage the DetectedItems[].Zone(s) is implemented in @{Functional.Detection#DETECTION_ZONES}.
+  -- 
+  -- Retrieve the DetectedItems[].Set with the method @{Functional.Detection#DETECTION_BASE.GetDetectedSet}(). A @{Core.Set#SET_UNIT} object will be returned.
+  -- 
+  -- Retrieve the formed @{Zone@ZONE_UNIT}s as a result of the grouping the detected units within the DetectionZoneRange, use the method @{Functional.Detection#DETECTION_BASE.GetDetectionZones}().
+  -- To understand the amount of zones created, use the method @{Functional.Detection#DETECTION_BASE.GetDetectionZoneCount}(). 
+  -- If you want to obtain a specific zone from the DetectedZones, use the method @{Functional.Detection#DETECTION_BASE.GetDetectionZone}() with a given index.
+  -- 
+  -- ## 4.4) Flare or Smoke detected units
+  -- 
+  -- Use the methods @{Functional.Detection#DETECTION_ZONES.FlareDetectedUnits}() or @{Functional.Detection#DETECTION_ZONES.SmokeDetectedUnits}() to flare or smoke the detected units when a new detection has taken place.
+  -- 
+  -- ## 4.5) Flare or Smoke or Bound detected zones
+  -- 
+  -- Use the methods:
+  -- 
+  --   * @{Functional.Detection#DETECTION_ZONES.FlareDetectedZones}() to flare in a color 
+  --   * @{Functional.Detection#DETECTION_ZONES.SmokeDetectedZones}() to smoke in a color
+  --   * @{Functional.Detection#DETECTION_ZONES.SmokeDetectedZones}() to bound with a tire with a white flag
+  --   
+  -- the detected zones when a new detection has taken place.
+  -- 
+  -- @field #DETECTION_ZONES
+  DETECTION_ZONES = {
+    ClassName = "DETECTION_ZONES",
+    DetectionZoneRange = nil,
+  }
+  
+  
+  --- DETECTION_ZONES constructor.
+  -- @param #DETECTION_ZONES self
+  -- @param Core.Set#SET_ZONE DetectionSetZone The @{Set} of ZONE_RADIUS.
+  -- @param DCS#Coalition.side DetectionCoalition The coalition of the detection.
+  -- @return #DETECTION_ZONES
+  function DETECTION_ZONES:New( DetectionSetZone, DetectionCoalition )
+  
+    -- Inherits from DETECTION_BASE
+    local self = BASE:Inherit( self, DETECTION_BASE:New( DetectionSetZone ) ) -- #DETECTION_ZONES
+  
+    self.DetectionSetZone = DetectionSetZone  -- Core.Set#SET_ZONE
+    self.DetectionCoalition = DetectionCoalition
+    
+    self._SmokeDetectedUnits = false
+    self._FlareDetectedUnits = false
+    self._SmokeDetectedZones = false
+    self._FlareDetectedZones = false
+    self._BoundDetectedZones = false
+    
+    return self
+  end
+
+  --- @param #DETECTION_ZONES self
+  -- @param #number The amount of alive recce.
+  function DETECTION_ZONES:CountAliveRecce()
+
+    return self.DetectionSetZone:Count()
+
+  end    
+  
+  --- @param #DETECTION_ZONES self
+  function DETECTION_ZONES:ForEachAliveRecce( IteratorFunction, ... )
+    self:F2( arg )
+    
+    self.DetectionSetZone:ForEachZone( IteratorFunction, arg )
+  
+    return self
+  end
+
+  --- Report summary of a detected item using a given numeric index.
+  -- @param #DETECTION_ZONES self
+  -- @param #DETECTION_BASE.DetectedItem DetectedItem The DetectedItem.
+  -- @param Wrapper.Group#GROUP AttackGroup The group to get the settings for.
+  -- @param Core.Settings#SETTINGS Settings (Optional) Message formatting settings to use.
+  -- @return Core.Report#REPORT The report of the detection items.
+  function DETECTION_ZONES:DetectedItemReportSummary( DetectedItem, AttackGroup, Settings )
+    self:F( { DetectedItem = DetectedItem } )
+  
+    local DetectedItemID = self:GetDetectedItemID( DetectedItem )
+    
+    if DetectedItem then
+      local DetectedSet = self:GetDetectedItemSet( DetectedItem )
+      local ReportSummaryItem
+      
+      local DetectedZone = self:GetDetectedItemZone( DetectedItem )
+      local DetectedItemCoordinate = DetectedZone:GetCoordinate()
+      local DetectedItemCoordText = DetectedItemCoordinate:ToString( AttackGroup, Settings )
+
+      local ThreatLevelA2G = self:GetDetectedItemThreatLevel( DetectedItem )
+      local DetectedItemsCount = DetectedSet:Count()
+      local DetectedItemsTypes = DetectedSet:GetTypeNames()
+      
+      local Report = REPORT:New()
+      Report:Add(DetectedItemID .. ", " .. DetectedItemCoordText)
+      Report:Add( string.format( "Threat: [%s]", string.rep(  "■", ThreatLevelA2G ), string.rep(  "□", 10-ThreatLevelA2G ) ) )
+      Report:Add( string.format("Type: %2d of %s", DetectedItemsCount, DetectedItemsTypes ) )
+      Report:Add( string.format("Detected: %s", DetectedItem.IsDetected and "yes" or "no" ) )
+      
+      return Report
+    end
+    
+    return nil
+  end
+
+  --- Report detailed of a detection result.
+  -- @param #DETECTION_ZONES self
+  -- @param Wrapper.Group#GROUP AttackGroup The group to generate the report for.
+  -- @return #string
+  function DETECTION_ZONES:DetectedReportDetailed( AttackGroup ) --R2.1  Fixed missing report
+    self:F()
+    
+    local Report = REPORT:New()
+    for DetectedItemIndex, DetectedItem in pairs( self.DetectedItems ) do
+      local DetectedItem = DetectedItem -- #DETECTION_BASE.DetectedItem
+      local ReportSummary = self:DetectedItemReportSummary( DetectedItem, AttackGroup )
+      Report:SetTitle( "Detected areas:" )
+      Report:Add( ReportSummary:Text() )
+    end
+    
+    local ReportText = Report:Text()
+    
+    return ReportText
+  end
+
+  
+  --- Calculate the optimal intercept point of the DetectedItem.
+  -- @param #DETECTION_ZONES self
+  -- @param #DETECTION_BASE.DetectedItem DetectedItem
+  function DETECTION_ZONES:CalculateIntercept( DetectedItem )
+
+    local DetectedCoord = DetectedItem.Coordinate
+--    local DetectedSpeed = DetectedCoord:GetVelocity()
+--    local DetectedHeading = DetectedCoord:GetHeading()
+--
+--    if self.Intercept then
+--      local DetectedSet = DetectedItem.Set
+--      -- todo: speed
+--  
+--      local TranslateDistance = DetectedSpeed * self.InterceptDelay
+--      
+--      local InterceptCoord = DetectedCoord:Translate( TranslateDistance, DetectedHeading )
+--      
+--      DetectedItem.InterceptCoord = InterceptCoord
+--    else
+--      DetectedItem.InterceptCoord = DetectedCoord
+--    end
+    DetectedItem.InterceptCoord = DetectedCoord    
+  end
+  
+  
+
+  --- Smoke the detected units
+  -- @param #DETECTION_ZONES self
+  -- @return #DETECTION_ZONES self
+  function DETECTION_ZONES:SmokeDetectedUnits()
+    self:F2()
+  
+    self._SmokeDetectedUnits = true
+    return self
+  end
+  
+  --- Flare the detected units
+  -- @param #DETECTION_ZONES self
+  -- @return #DETECTION_ZONES self
+  function DETECTION_ZONES:FlareDetectedUnits()
+    self:F2()
+  
+    self._FlareDetectedUnits = true
+    return self
+  end
+  
+  --- Smoke the detected zones
+  -- @param #DETECTION_ZONES self
+  -- @return #DETECTION_ZONES self
+  function DETECTION_ZONES:SmokeDetectedZones()
+    self:F2()
+  
+    self._SmokeDetectedZones = true
+    return self
+  end
+  
+  --- Flare the detected zones
+  -- @param #DETECTION_ZONES self
+  -- @return #DETECTION_ZONES self
+  function DETECTION_ZONES:FlareDetectedZones()
+    self:F2()
+  
+    self._FlareDetectedZones = true
+    return self
+  end
+
+  --- Bound the detected zones
+  -- @param #DETECTION_ZONES self
+  -- @return #DETECTION_ZONES self
+  function DETECTION_ZONES:BoundDetectedZones()
+    self:F2()
+  
+    self._BoundDetectedZones = true
+    return self
+  end
+  
+  --- Make text documenting the changes of the detected zone.
+  -- @param #DETECTION_ZONES self
+  -- @param #DETECTION_BASE.DetectedItem DetectedItem
+  -- @return #string The Changes text
+  function DETECTION_ZONES:GetChangeText( DetectedItem )
+    self:F( DetectedItem )
+    
+    local MT = {}
+    
+    for ChangeCode, ChangeData in pairs( DetectedItem.Changes ) do
+  
+      if ChangeCode == "AA" then
+        MT[#MT+1] = "Detected new area " .. ChangeData.ID .. ". The center target is a " .. ChangeData.ItemUnitType .. "."
+      end
+  
+      if ChangeCode == "RAU" then
+        MT[#MT+1] = "Changed area " .. ChangeData.ID .. ". Removed the center target."
+      end
+      
+      if ChangeCode == "AAU" then
+        MT[#MT+1] = "Changed area " .. ChangeData.ID .. ". The new center target is a " .. ChangeData.ItemUnitType .. "."
+      end
+      
+      if ChangeCode == "RA" then
+        MT[#MT+1] = "Removed old area " .. ChangeData.ID .. ". No more targets in this area."
+      end
+      
+      if ChangeCode == "AU" then
+        local MTUT = {}
+        for ChangeUnitType, ChangeUnitCount in pairs( ChangeData ) do
+          if ChangeUnitType  ~= "ID" then
+            MTUT[#MTUT+1] = ChangeUnitCount .. " of " .. ChangeUnitType
+          end
+        end
+        MT[#MT+1] = "Detected for area " .. ChangeData.ID .. " new target(s) " .. table.concat( MTUT, ", " ) .. "."
+      end
+  
+      if ChangeCode == "RU" then
+        local MTUT = {}
+        for ChangeUnitType, ChangeUnitCount in pairs( ChangeData ) do
+          if ChangeUnitType  ~= "ID" then
+            MTUT[#MTUT+1] = ChangeUnitCount .. " of " .. ChangeUnitType
+          end
+        end
+        MT[#MT+1] = "Removed for area " .. ChangeData.ID .. " invisible or destroyed target(s) " .. table.concat( MTUT, ", " ) .. "."
+      end
+      
+    end
+    
+    return table.concat( MT, "\n" )
+    
+  end
+  
+  
+  --- Make a DetectionSet table. This function will be overridden in the derived clsses.
+  -- @param #DETECTION_ZONES self
+  -- @return #DETECTION_ZONES self
+  function DETECTION_ZONES:CreateDetectionItems()
+  
+  
+    self:F( "Checking Detected Items for new Detected Units ..." )
+    
+    local DetectedUnits = SET_UNIT:New()
+    
+    -- First go through all zones, and check if there are new Zones.
+    -- New Zones become a new DetectedItem.
+    for ZoneName, DetectionZone in pairs( self.DetectionSetZone:GetSet() ) do
+      
+      local DetectedItem = self:GetDetectedItemByKey( ZoneName )
+
+      if DetectedItem == nil then
+        DetectedItem = self:AddDetectedItemZone( "ZONE", ZoneName, nil, DetectionZone )
+      end
+
+      local DetectedItemSetUnit = self:GetDetectedItemSet( DetectedItem )
+      
+      -- Scan the zone
+      DetectionZone:Scan( { Object.Category.UNIT }, { Unit.Category.GROUND_UNIT } )
+      
+      -- For all the units in the zone,
+      -- check if they are of the same coalition to be included.
+      local ZoneUnits = DetectionZone:GetScannedUnits()
+      for DCSUnitID, DCSUnit in pairs( ZoneUnits ) do
+        local UnitName = DCSUnit:getName()
+        local ZoneUnit = UNIT:FindByName( UnitName )
+        local ZoneUnitCoalition = ZoneUnit:GetCoalition()
+        if ZoneUnitCoalition == self.DetectionCoalition then
+          if DetectedItemSetUnit:FindUnit( UnitName ) == nil and DetectedUnits:FindUnit( UnitName ) == nil then
+            self:F( "Adding " .. UnitName )
+            DetectedItemSetUnit:AddUnit( ZoneUnit )
+            DetectedUnits:AddUnit( ZoneUnit )
+          end
+        end
+      end
+    end
+            
+    
+    -- Now all the tests should have been build, now make some smoke and flares...
+    -- We also report here the friendlies within the detected areas.
+    
+    for DetectedItemID, DetectedItemData in pairs( self.DetectedItems ) do
+  
+      local DetectedItem = DetectedItemData -- #DETECTION_BASE.DetectedItem
+      local DetectedSet = self:GetDetectedItemSet( DetectedItem )
+      local DetectedFirstUnit = DetectedSet:GetFirst()
+      local DetectedZone = self:GetDetectedItemZone( DetectedItem )
+ 
+      -- Set the last known coordinate to the detection item.
+      local DetectedZoneCoord = DetectedZone:GetCoordinate()
+      self:SetDetectedItemCoordinate( DetectedItem, DetectedZoneCoord, DetectedFirstUnit )
+      
+      self:CalculateIntercept( DetectedItem )
+  
+      -- We search for friendlies nearby.
+      -- If there weren't any friendlies nearby, and now there are friendlies nearby, we flag the area as "changed".
+      -- If there were friendlies nearby, and now there aren't any friendlies nearby, we flag the area as "changed".
+      -- This is for the A2G dispatcher to detect if there is a change in the tactical situation.
+      local OldFriendliesNearbyGround = self:IsFriendliesNearBy( DetectedItem, Unit.Category.GROUND_UNIT )
+      self:ReportFriendliesNearBy( { DetectedItem = DetectedItem, ReportSetGroup = self.DetectionSetGroup } ) -- Fill the Friendlies table
+      local NewFriendliesNearbyGround = self:IsFriendliesNearBy( DetectedItem, Unit.Category.GROUND_UNIT  )
+      if OldFriendliesNearbyGround ~= NewFriendliesNearbyGround then
+        DetectedItem.Changed = true
+      end
+
+      self:SetDetectedItemThreatLevel( DetectedItem )  -- Calculate A2G threat level
+      --self:NearestRecce( DetectedItem )
+
+      
+      if DETECTION_ZONES._SmokeDetectedUnits or self._SmokeDetectedUnits then
+        DetectedZone:SmokeZone( SMOKECOLOR.Red, 30 )
+      end
+      
+      --DetectedSet:Flush( self )
+      
+      DetectedSet:ForEachUnit(
+        --- @param Wrapper.Unit#UNIT DetectedUnit
+        function( DetectedUnit )
+          if DetectedUnit:IsAlive() then
+            --self:T( "Detected Set #" .. DetectedItem.ID .. ":" .. DetectedUnit:GetName() )
+            if DETECTION_ZONES._FlareDetectedUnits or self._FlareDetectedUnits then
+              DetectedUnit:FlareGreen()
+            end
+            if DETECTION_ZONES._SmokeDetectedUnits or self._SmokeDetectedUnits then
+              DetectedUnit:SmokeGreen()
+            end
+          end
+        end
+      )
+      if DETECTION_ZONES._FlareDetectedZones or self._FlareDetectedZones then
+        DetectedZone:FlareZone( SMOKECOLOR.White, 30, math.random( 0,90 ) )
+      end
+      if DETECTION_ZONES._SmokeDetectedZones or self._SmokeDetectedZones then
+        DetectedZone:SmokeZone( SMOKECOLOR.White, 30 )
+      end
+
+      if DETECTION_ZONES._BoundDetectedZones or self._BoundDetectedZones then
+        self.CountryID = DetectedSet:GetFirst():GetCountry()
+        DetectedZone:BoundZone( 12, self.CountryID )
+      end
+    end
+  
+  end
+
+  --- @param #DETECTION_ZONES self
+  -- @param #string From The From State string.
+  -- @param #string Event The Event string.
+  -- @param #string To The To State string.
+  -- @param Detection The element on which the detection is based.
+  -- @param #number DetectionTimeStamp Time stamp of detection event.
+  function DETECTION_ZONES:onafterDetection( From, Event, To, Detection, DetectionTimeStamp  )
+
+    self.DetectionRun = self.DetectionRun + 1
+    if self.DetectionCount > 0 and self.DetectionRun == self.DetectionCount then
+      self:CreateDetectionItems() -- Polymorphic call to Create/Update the DetectionItems list for the DETECTION_ class grouping method.
+  
+      for DetectedItemID, DetectedItem in pairs( self.DetectedItems ) do
+        self:UpdateDetectedItemDetection( DetectedItem )
+        self:CleanDetectionItem( DetectedItem, DetectedItemID ) -- Any DetectionItem that has a Set with zero elements in it, must be removed from the DetectionItems list.
+        if DetectedItem then
+          self:__DetectedItem( 0.1, DetectedItem )
+        end
+      end
+      self:__Detect( -self.RefreshTimeInterval )
+    end
+  end
+  
+  
+  --- Set IsDetected flag for the DetectedItem, which can have more units.
+  -- @param #DETECTION_ZONES self
+  -- @return #DETECTION_ZONES.DetectedItem DetectedItem
+  -- @return #boolean true if at least one UNIT is detected from the DetectedSet, false if no UNIT was detected from the DetectedSet.
+  function DETECTION_ZONES:UpdateDetectedItemDetection( DetectedItem )
+    
+    local IsDetected = true
+    
+    DetectedItem.IsDetected = true
+    
+    return IsDetected
+  end
+  
+end 

Moose Development/Moose/Functional/Escort.lua

@@ -2,6 +2,27 @@
 -- 
 -- ===
 -- 
+-- ## Features:
+-- 
+--   * Escort navigation commands.
+--   * Escort hold at position commands.
+--   * Escorts reporting detected targets.
+--   * Escorts scanning targets in advance.
+--   * Escorts attacking specific targets.
+--   * Request assistance from other groups for attack.
+--   * Manage rule of engagement of escorts.
+--   * Manage the allowed evasion techniques of escorts.
+--   * Make escort to execute a defined mission or path.
+--   * Escort tactical situation reporting.
+-- 
+-- ===
+-- 
+-- ## Missions:
+-- 
+-- [ESC - Escorting](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/ESC%20-%20Escorting)
+-- 
+-- ===
+-- 
 -- Allows you to interact with escorting AI on your flight and take the lead.
 -- 
 -- Each escorting group can be commanded with a whole set of radio commands (radio menu in your flight, and then F10).
@@ -77,47 +98,18 @@
 -- Escort groups can have their own mission. This menu item will allow the escort group to resume their Mission from a given waypoint.
 -- Note that this is really fantastic, as you now have the dynamic of taking control of the escort groups, and allowing them to resume their path or mission.
 --
--- # ESCORT construction methods.
+-- ===
 -- 
--- Create a new SPAWN object with the @{#ESCORT.New} method:
---
---  * @{#ESCORT.New}: Creates a new ESCORT object from a @{Wrapper.Group#GROUP} for a @{Wrapper.Client#CLIENT}, with an optional briefing text.
---
--- # ESCORT initialization methods.
+-- ### Authors: **FlightControl** 
 -- 
--- The following menus are created within the RADIO MENU (F10) of an active unit hosted by a player:
---
--- * @{#ESCORT.MenuFollowAt}: Creates a menu to make the escort follow the client.
--- * @{#ESCORT.MenuHoldAtEscortPosition}: Creates a menu to hold the escort at its current position.
--- * @{#ESCORT.MenuHoldAtLeaderPosition}: Creates a menu to hold the escort at the client position.
--- * @{#ESCORT.MenuScanForTargets}: Creates a menu so that the escort scans targets.
--- * @{#ESCORT.MenuFlare}: Creates a menu to disperse flares.
--- * @{#ESCORT.MenuSmoke}: Creates a menu to disparse smoke.
--- * @{#ESCORT.MenuReportTargets}: Creates a menu so that the escort reports targets.
--- * @{#ESCORT.MenuReportPosition}: Creates a menu so that the escort reports its current position from bullseye.
--- * @{#ESCORT.MenuAssistedAttack: Creates a menu so that the escort supportes assisted attack from other escorts with the client.
--- * @{#ESCORT.MenuROE: Creates a menu structure to set the rules of engagement of the escort.
--- * @{#ESCORT.MenuEvasion: Creates a menu structure to set the evasion techniques when the escort is under threat.
--- * @{#ESCORT.MenuResumeMission}: Creates a menu structure so that the escort can resume from a waypoint.
--- 
--- 
--- @usage
--- -- Declare a new EscortPlanes object as follows:
--- 
--- -- First find the GROUP object and the CLIENT object.
--- local EscortClient = CLIENT:FindByName( "Unit Name" ) -- The Unit Name is the name of the unit flagged with the skill Client in the mission editor.
--- local EscortGroup = GROUP:FindByName( "Group Name" ) -- The Group Name is the name of the group that will escort the Escort Client.
--- 
--- -- Now use these 2 objects to construct the new EscortPlanes object.
--- EscortPlanes = ESCORT:New( EscortClient, EscortGroup, "Desert", "Welcome to the mission. You are escorted by a plane with code name 'Desert', which can be instructed through the F10 radio menu." )
--- 
---
+-- ===
 --
 -- @module Functional.Escort
 -- @image Escorting.JPG
 
---- ESCORT class
--- @type ESCORT
+
+
+--- @type ESCORT
 -- @extends Core.Base#BASE
 -- @field Wrapper.Client#CLIENT EscortClient
 -- @field Wrapper.Group#GROUP EscortGroup
@@ -129,6 +121,26 @@
 -- @Field DCS#AI.Option.Air.val.ROE OptionROE Which ROE is set to the EscortGroup.
 -- @field DCS#AI.Option.Air.val.REACTION_ON_THREAT OptionReactionOnThreat Which REACTION_ON_THREAT is set to the EscortGroup.
 -- @field FunctionalMENU_GROUPDETECTION_BASE Detection
+
+--- ESCORT class
+-- 
+-- # ESCORT construction methods.
+-- 
+-- Create a new SPAWN object with the @{#ESCORT.New} method:
+--
+--  * @{#ESCORT.New}: Creates a new ESCORT object from a @{Wrapper.Group#GROUP} for a @{Wrapper.Client#CLIENT}, with an optional briefing text.
+--
+-- @usage
+-- -- Declare a new EscortPlanes object as follows:
+-- 
+-- -- First find the GROUP object and the CLIENT object.
+-- local EscortClient = CLIENT:FindByName( "Unit Name" ) -- The Unit Name is the name of the unit flagged with the skill Client in the mission editor.
+-- local EscortGroup = GROUP:FindByName( "Group Name" ) -- The Group Name is the name of the group that will escort the Escort Client.
+-- 
+-- -- Now use these 2 objects to construct the new EscortPlanes object.
+-- EscortPlanes = ESCORT:New( EscortClient, EscortGroup, "Desert", "Welcome to the mission. You are escorted by a plane with code name 'Desert', which can be instructed through the F10 radio menu." )
+--
+-- @field #ESCORT
 ESCORT = {
   ClassName = "ESCORT",
   EscortName = nil, -- The Escort Name
@@ -860,7 +872,7 @@ function ESCORT:_AttackTarget( DetectedItem )
     EscortGroup:OptionROTPassiveDefense()
     EscortGroup:SetState( EscortGroup, "Escort", self )
 
-    local DetectedSet = self.Detection:GetDetectedSet( DetectedItem )
+    local DetectedSet = self.Detection:GetDetectedItemSet( DetectedItem )
     
     local Tasks = {}
 
@@ -883,7 +895,7 @@ function ESCORT:_AttackTarget( DetectedItem )
     
   else
   
-    local DetectedSet = self.Detection:GetDetectedSet( DetectedItem )
+    local DetectedSet = self.Detection:GetDetectedItemSet( DetectedItem )
     
     local Tasks = {}
 
@@ -922,7 +934,7 @@ function ESCORT:_AssistTarget( EscortGroupAttack, DetectedItem )
     EscortGroupAttack:OptionROEOpenFire()
     EscortGroupAttack:OptionROTVertical()
     
-    local DetectedSet = self.Detection:GetDetectedSet( DetectedItem )
+    local DetectedSet = self.Detection:GetDetectedItemSet( DetectedItem )
     
     local Tasks = {}
 
@@ -944,7 +956,7 @@ function ESCORT:_AssistTarget( EscortGroupAttack, DetectedItem )
     )
 
   else
-    local DetectedSet = self.Detection:GetDetectedSet( DetectedItem )
+    local DetectedSet = self.Detection:GetDetectedItemSet( DetectedItem )
     
     local Tasks = {}
 

Moose Development/Moose/Functional/MissileTrainer.lua

@@ -1,18 +1,27 @@
---- **Functional** -- MISSILETRAINER helps you to train missile avoidance.
+--- **Functional** -- Train missile defence and deflection.
 -- 
 -- ===
 --
--- The @{#MISSILETRAINER} class uses the DCS world messaging system to be alerted of any missiles fired, and when a missile would hit your aircraft,
+-- ## Features:
+-- 
+--   * Track the missiles fired at you and other players, providing bearing and range information of the missiles towards the airplanes.
+--   * Provide alerts of missile launches, including detailed information of the units launching, including bearing, range <20>
+--   * Provide alerts when a missile would have killed your aircraft.
+--   * Provide alerts when the missile self destructs.
+--   * Enable / Disable and Configure the Missile Trainer using the various menu options.
+-- 
+-- ===
+-- 
+-- ## Missions:
+-- 
+-- [MIT - Missile Trainer](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/MIT%20-%20Missile%20Trainer)
+-- 
+-- ===
+-- 
+-- Uses the MOOSE messaging system to be alerted of any missiles fired, and when a missile would hit your aircraft,
 -- the class will destroy the missile within a certain range, to avoid damage to your aircraft.
--- It suports the following functionality:
---
---  * Track the missiles fired at you and other players, providing bearing and range information of the missiles towards the airplanes.
---  * Provide alerts of missile launches, including detailed information of the units launching, including bearing, range <20>
---  * Provide alerts when a missile would have killed your aircraft.
---  * Provide alerts when the missile self destructs.
---  * Enable / Disable and Configure the Missile Trainer using the various menu options.
 --  
---  When running a mission where MISSILETRAINER is used, the following radio menu structure ( 'Radio Menu' -> 'Other (F10)' -> 'MissileTrainer' ) options are available for the players:
+-- When running a mission where the missile trainer is used, the following radio menu structure ( 'Radio Menu' -> 'Other (F10)' -> 'MissileTrainer' ) options are available for the players:
 --  
 --  * **Messages**: Menu to configure all messages.
 --     * **Messages On**: Show all messages.
@@ -42,17 +51,40 @@
 --     * **150 meter**: Destroys the missile when the distance to the aircraft is below or equal to 150 meter.
 --     * **200 meter**: Destroys the missile when the distance to the aircraft is below or equal to 200 meter.
 --   
+-- ===
+-- 
+-- ### Authors: **FlightControl**
+-- 
+-- ### Contributions:
+-- 
+--    * **Stuka (Danny)**: Who you can search on the Eagle Dynamics Forums. Working together with Danny has resulted in the MISSILETRAINER class.  
+--      Danny has shared his ideas and together we made a design. 
+--      Together with the **476 virtual team**, we tested the MISSILETRAINER class, and got much positive feedback!
+--    * **132nd Squadron**: Testing and optimizing the logic.
+-- 
+-- ===
 --
--- 1.1) MISSILETRAINER construction methods:
--- -----------------------------------------
+-- @module Functional.MissileTrainer
+-- @image Missile_Trainer.JPG
+
+
+--- @type MISSILETRAINER
+-- @field Core.Set#SET_CLIENT DBClients
+-- @extends Core.Base#BASE
+
+
+---
+--
+-- # Constructor:
+-- 
 -- Create a new MISSILETRAINER object with the @{#MISSILETRAINER.New} method:
 --
 --   * @{#MISSILETRAINER.New}: Creates a new MISSILETRAINER object taking the maximum distance to your aircraft to evaluate when a missile needs to be destroyed.
 --
 -- MISSILETRAINER will collect each unit declared in the mission with a skill level "Client" and "Player", and will monitor the missiles shot at those.
 --
--- 1.2) MISSILETRAINER initialization methods:
--- -------------------------------------------
+-- # Initialization:
+-- 
 -- A MISSILETRAINER object will behave differently based on the usage of initialization methods:
 --
 --  * @{#MISSILETRAINER.InitMessagesOnOff}: Sets by default the display of any message to be ON or OFF.
@@ -65,24 +97,8 @@
 --  * @{#MISSILETRAINER.InitRangeOnOff}: Sets by default the display of range information of missiles ON of OFF.
 --  * @{#MISSILETRAINER.InitBearingOnOff}: Sets by default the display of bearing information of missiles ON of OFF.
 --  * @{#MISSILETRAINER.InitMenusOnOff}: Allows to configure the options through the radio menu.
---
--- ===
 -- 
--- CREDITS
--- ===
--- **Stuka (Danny)** Who you can search on the Eagle Dynamics Forums.
--- Working together with Danny has resulted in the MISSILETRAINER class. 
--- Danny has shared his ideas and together we made a design. 
--- Together with the **476 virtual team**, we tested the MISSILETRAINER class, and got much positive feedback!
--- 
--- @module Functional.MissileTrainer
--- @image Missile_Trainer.JPG
-
-
---- The MISSILETRAINER class
--- @type MISSILETRAINER
--- @field Core.Set#SET_CLIENT DBClients
--- @extends Core.Base#BASE
+-- @field #MISSILETRAINER 
 MISSILETRAINER = {
   ClassName = "MISSILETRAINER",
   TrackingMissiles = {},

Moose Development/Moose/Functional/Movement.lua

@@ -1,4 +1,4 @@
---- **Functional** -- Limit the MOVEMENT of simulaneous moving ground vehicles.
+--- **Functional** -- Limit the movement of simulaneous moving ground vehicles.
 -- 
 -- ===
 --  
@@ -10,9 +10,11 @@
 -- @module Functional.Movement
 -- @image MOOSE.JPG
 
---- the MOVEMENT class
--- @type MOVEMENT
+--- @type MOVEMENT
 -- @extends Core.Base#BASE
+
+---
+--@field #MOVEMENT
 MOVEMENT = {
 	ClassName = "MOVEMENT",
 }

Moose Development/Moose/Functional/PseudoATC.lua

@@ -1,4 +1,4 @@
---- **Functional** - (R2.4) Rudimentary ATC.
+--- **Functional** - Rudimentary ATC.
 --  
 -- ![Banner Image](..\Presentations\PSEUDOATC\PSEUDOATC_Main.jpg)
 -- 
@@ -8,7 +8,7 @@
 -- 
 -- In particular, a menu entry "Pseudo ATC" is created in the "F10 Other..." radiomenu.
 -- 
--- ## Features
+-- ## Features:
 -- 
 -- * Weather report at nearby airbases and mission waypoints.
 -- * Report absolute bearing and range to nearest airports and mission waypoints.
@@ -20,12 +20,6 @@
 --  
 -- ====
 -- 
--- # Demo Missions
---
--- ### [MOOSE - ALL Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS)
--- 
--- ====
--- 
 -- # YouTube Channel
 -- 
 -- ### [MOOSE YouTube Channel](https://www.youtube.com/channel/UCjrA9j5LQoWsG4SpS8i79Qg)
@@ -87,7 +81,7 @@
 -- @field #PSEUDOATC
 PSEUDOATC={
   ClassName = "PSEUDOATC",
-  player={},
+  group={},
   Debug=false,
   mdur=30,
   mrefresh=120,
@@ -104,7 +98,7 @@ PSEUDOATC.id="PseudoATC | "
 
 --- PSEUDOATC version.
 -- @field #number version
-PSEUDOATC.version="0.9.0"
+PSEUDOATC.version="0.9.2"
 
 -----------------------------------------------------------------------------------------------------------------------------------------
 
@@ -389,16 +383,23 @@ function PSEUDOATC:PlayerEntered(unit)
   local PlayerName=unit:GetPlayerName()
   local UnitName=unit:GetName()
   local CallSign=unit:GetCallsign()
+  local UID=unit:GetDCSObject():getID()
+  
+  if not self.group[GID] then
+    self.group[GID]={}
+    self.group[GID].player={}
+  end
+  
   
   -- Init player table.  
-  self.player[GID]={}
-  self.player[GID].group=group
-  self.player[GID].unit=unit
-  self.player[GID].groupname=GroupName
-  self.player[GID].unitname=UnitName
-  self.player[GID].playername=PlayerName
-  self.player[GID].callsign=CallSign
-  self.player[GID].waypoints=group:GetTaskRoute()
+  self.group[GID].player[UID]={}
+  self.group[GID].player[UID].group=group
+  self.group[GID].player[UID].unit=unit
+  self.group[GID].player[UID].groupname=GroupName
+  self.group[GID].player[UID].unitname=UnitName
+  self.group[GID].player[UID].playername=PlayerName
+  self.group[GID].player[UID].callsign=CallSign
+  self.group[GID].player[UID].waypoints=group:GetTaskRoute()
   
   -- Info message.
   local text=string.format("Player %s entered unit %s of group %s (id=%d).", PlayerName, UnitName, GroupName, GID)
@@ -406,19 +407,26 @@ function PSEUDOATC:PlayerEntered(unit)
   MESSAGE:New(text, 30):ToAllIf(self.Debug)
   
   -- Create main F10 menu, i.e. "F10/Pseudo ATC"
-  self.player[GID].menu_main=missionCommands.addSubMenuForGroup(GID, "Pseudo ATC")
+    local countPlayerInGroup = 0
+    for _ in pairs(self.group[GID].player) do countPlayerInGroup = countPlayerInGroup + 1 end
+  if countPlayerInGroup <= 1 then
+    self.group[GID].menu_main=missionCommands.addSubMenuForGroup(GID, "Pseudo ATC")
+  end
+  
+  -- Create/update custom menu for player
+  self:MenuCreatePlayer(GID,UID)
     
   -- Create/update list of nearby airports.
-  self:LocalAirports(GID)
+  self:LocalAirports(GID,UID)
   
   -- Create submenu of local airports.
-  self:MenuAirports(GID)
+  self:MenuAirports(GID,UID)
   
   -- Create submenu Waypoints.
-  self:MenuWaypoints(GID)
+  self:MenuWaypoints(GID,UID)
   
   -- Start scheduler to refresh the F10 menues.
-  self.player[GID].scheduler, self.player[GID].schedulerid=SCHEDULER:New(nil, self.MenuRefresh, {self, GID}, self.mrefresh, self.mrefresh)
+  self.group[GID].player[UID].scheduler, self.group[GID].player[UID].schedulerid=SCHEDULER:New(nil, self.MenuRefresh, {self, GID, UID}, self.mrefresh, self.mrefresh)
  
 end
 
@@ -431,24 +439,23 @@ function PSEUDOATC:PlayerLanded(unit, place)
   
   -- Gather some information.
   local group=unit:GetGroup()
-  local id=group:GetID()
-  local PlayerName=self.player[id].playername
-  local Callsign=self.player[id].callsign
-  local UnitName=self.player[id].unitname
-  local GroupName=self.player[id].groupname
-  local CallSign=self.player[id].callsign
+  local GID=group:GetID()
+  local UID=unit:GetDCSObject():getID()
+  local PlayerName=self.group[GID].player[UID].playername
+  local UnitName=self.group[GID].player[UID].unitname
+  local GroupName=self.group[GID].player[UID].groupname
   
   -- Debug message.
-  local text=string.format("Player %s in unit %s of group %s (id=%d) landed at %s.", PlayerName, UnitName, GroupName, id, place)
+  local text=string.format("Player %s in unit %s of group %s (id=%d) landed at %s.", PlayerName, UnitName, GroupName, GID, place)
   self:T(PSEUDOATC.id..text)
   MESSAGE:New(text, 30):ToAllIf(self.Debug)
   
   -- Stop altitude reporting timer if its activated.
-  self:AltitudeTimerStop(id)
+  self:AltitudeTimerStop(GID,UID)
   
   -- Welcome message.
   if place and self.chatty then
-    local text=string.format("Touchdown! Welcome to %s. Have a nice day!", place)
+    local text=string.format("Touchdown! Welcome to %s pilot %s. Have a nice day!", place,PlayerName)
     MESSAGE:New(text, self.mdur):ToGroup(group)
   end
 
@@ -463,15 +470,15 @@ function PSEUDOATC:PlayerTakeOff(unit, place)
   
   -- Gather some information.
   local group=unit:GetGroup()
-  local id=group:GetID()
-  local PlayerName=self.player[id].playername
-  local Callsign=self.player[id].callsign
-  local UnitName=self.player[id].unitname
-  local GroupName=self.player[id].groupname
-  local CallSign=self.player[id].callsign
+  local GID=group:GetID()
+  local UID=unit:GetDCSObject():getID()
+  local PlayerName=self.group[GID].player[UID].playername
+  local CallSign=self.group[GID].player[UID].callsign
+  local UnitName=self.group[GID].player[UID].unitname
+  local GroupName=self.group[GID].player[UID].groupname
   
   -- Debug message.
-  local text=string.format("Player %s in unit %s of group %s (id=%d) took off at %s.", PlayerName, UnitName, GroupName, id, place)
+  local text=string.format("Player %s in unit %s of group %s (id=%d) took off at %s.", PlayerName, UnitName, GroupName, GID, place)
   self:T(PSEUDOATC.id..text)
   MESSAGE:New(text, 30):ToAllIf(self.Debug)
     
@@ -491,30 +498,44 @@ function PSEUDOATC:PlayerLeft(unit)
  
   -- Get id.
   local group=unit:GetGroup()
-  local id=group:GetID()
+  local GID=group:GetID()
+  local UID=unit:GetDCSObject():getID()
   
-  if self.player[id] then
+  if self.group[GID].player[UID] then
+    local PlayerName=self.group[GID].player[UID].playername
+    local CallSign=self.group[GID].player[UID].callsign
+    local UnitName=self.group[GID].player[UID].unitname
+    local GroupName=self.group[GID].player[UID].groupname
   
     -- Debug message.
-    local text=string.format("Player %s (callsign %s) of group %s just left unit %s.", self.player[id].playername, self.player[id].callsign, self.player[id].groupname, self.player[id].unitname)
+    local text=string.format("Player %s (callsign %s) of group %s just left unit %s.", PlayerName, CallSign, GroupName, UnitName)
     self:T(PSEUDOATC.id..text)
     MESSAGE:New(text, 30):ToAllIf(self.Debug)
     
     -- Stop scheduler for menu updates
-    if self.player[id].schedulerid then
-      self.player[id].scheduler:Stop(self.player[id].schedulerid)
+    if self.group[GID].player[UID].schedulerid then
+      self.group[GID].player[UID].scheduler:Stop(self.group[GID].player[UID].schedulerid)
     end
     
     -- Stop scheduler for reporting alt if it runs.
-    self:AltitudeTimerStop(id)
+    self:AltitudeTimerStop(GID,UID)
     
+    --  Remove own menu.
+    if self.group[GID].player[UID].menu_own then
+      missionCommands.removeItemForGroup(GID,self.group[GID].player[UID].menu_own)
+    end
     -- Remove main menu.
-    if self.player[id].menu_main then
-      missionCommands.removeItem(self.player[id].menu_main)
+    -- WARNING: Remove only if last human element of group 
+    
+    local countPlayerInGroup = 0
+    for _ in pairs(self.group[GID].player) do countPlayerInGroup = countPlayerInGroup + 1 end
+  
+    if self.group[GID].menu_main and countPlayerInGroup==1 then
+      missionCommands.removeItemForGroup(GID,self.group[GID].menu_main)
     end
   
     -- Remove player array.
-    self.player[id]=nil
+    self.group[GID].player[UID]=nil
     
   end
 end
@@ -524,80 +545,94 @@ end
 
 --- Refreshes all player menues.
 -- @param #PSEUDOATC self.
--- @param #number id Group id of player unit. 
-function PSEUDOATC:MenuRefresh(id)
-  self:F({id=id})
-
+-- @param #number GID Group id of player unit.
+-- @param #number UID Unit id of player. 
+function PSEUDOATC:MenuRefresh(GID,UID)
+  self:F({GID=GID,UID=UID})
   -- Debug message.
-  local text=string.format("Refreshing menues for player %s in group %s.", self.player[id].playername, self.player[id].groupname)
+  local text=string.format("Refreshing menues for player %s in group %s.", self.group[GID].player[UID].playername, self.group[GID].player[UID].groupname)
   self:T(PSEUDOATC.id..text)
   MESSAGE:New(text,30):ToAllIf(self.Debug)
 
   -- Clear menu.
-  self:MenuClear(id)
+  self:MenuClear(GID,UID)
   
   -- Create list of nearby airports.
-  self:LocalAirports(id)
+  self:LocalAirports(GID,UID)
       
   -- Create submenu Local Airports.
-  self:MenuAirports(id)
+  self:MenuAirports(GID,UID)
   
   -- Create submenu Waypoints etc.
-  self:MenuWaypoints(id)
+  self:MenuWaypoints(GID,UID)
   
 end
 
+--- Create player menus.
+-- @param #PSEUDOATC self.
+-- @param #number GID Group id of player unit.
+-- @param #number UID Unit id of player. 
+function PSEUDOATC:MenuCreatePlayer(GID,UID)
+  self:F({GID=GID,UID=UID})
+  -- Table for menu entries.
+    local PlayerName=self.group[GID].player[UID].playername
+    self.group[GID].player[UID].menu_own=missionCommands.addSubMenuForGroup(GID, PlayerName, self.group[GID].menu_main)
+end
+
+
 
 --- Clear player menus.
 -- @param #PSEUDOATC self.
--- @param #number id Group id of player unit. 
-function PSEUDOATC:MenuClear(id)
-  self:F(id)
+-- @param #number GID Group id of player unit.
+-- @param #number UID Unit id of player. 
+function PSEUDOATC:MenuClear(GID,UID)
+  self:F({GID=GID,UID=UID})
 
   -- Debug message.
-  local text=string.format("Clearing menus for player %s in group %s.", self.player[id].playername, self.player[id].groupname)
+  local text=string.format("Clearing menus for player %s in group %s.", self.group[GID].player[UID].playername, self.group[GID].player[UID].groupname)
   self:T(PSEUDOATC.id..text)
   MESSAGE:New(text,30):ToAllIf(self.Debug)
   
   -- Delete Airports menu.
-  if self.player[id].menu_airports then
-    missionCommands.removeItemForGroup(id, self.player[id].menu_airports)
-    self.player[id].menu_airports=nil
+  if self.group[GID].player[UID].menu_airports then
+    missionCommands.removeItemForGroup(GID, self.group[GID].player[UID].menu_airports)
+    self.group[GID].player[UID].menu_airports=nil
   else
     self:T2(PSEUDOATC.id.."No airports to clear menus.")
   end
  
   -- Delete waypoints menu.
-  if self.player[id].menu_waypoints then
-    missionCommands.removeItemForGroup(id, self.player[id].menu_waypoints)
-    self.player[id].menu_waypoints=nil
+  if self.group[GID].player[UID].menu_waypoints then
+    missionCommands.removeItemForGroup(GID, self.group[GID].player[UID].menu_waypoints)
+    self.group[GID].player[UID].menu_waypoints=nil
   end
   
   -- Delete report alt until touchdown menu command.
-  if self.player[id].menu_reportalt then
-    missionCommands.removeItemForGroup(id, self.player[id].menu_reportalt)
-    self.player[id].menu_reportalt=nil
+  if self.group[GID].player[UID].menu_reportalt then
+    missionCommands.removeItemForGroup(GID, self.group[GID].player[UID].menu_reportalt)
+    self.group[GID].player[UID].menu_reportalt=nil
   end
 
   -- Delete request current alt menu command.
-  if self.player[id].menu_requestalt then
-    missionCommands.removeItemForGroup(id, self.player[id].menu_requestalt)
-    self.player[id].menu_requestalt=nil
+  if self.group[GID].player[UID].menu_requestalt then
+    missionCommands.removeItemForGroup(GID, self.group[GID].player[UID].menu_requestalt)
+    self.group[GID].player[UID].menu_requestalt=nil
   end
 
 end
 
 --- Create "F10/Pseudo ATC/Local Airports/Airport Name/" menu items each containing weather report and BR request.
 -- @param #PSEUDOATC self
--- @param #number id Group id of player unit for which menues are created. 
-function PSEUDOATC:MenuAirports(id)
-  self:F(id)
+-- @param #number GID Group id of player unit.
+-- @param #number UID Unit id of player. 
+function PSEUDOATC:MenuAirports(GID,UID)
+  self:F({GID=GID,UID=UID})
 
   -- Table for menu entries.
-  self.player[id].menu_airports=missionCommands.addSubMenuForGroup(id, "Local Airports", self.player[id].menu_main)
+  self.group[GID].player[UID].menu_airports=missionCommands.addSubMenuForGroup(GID, "Local Airports", self.group[GID].player[UID].menu_own)
    
   local i=0
-  for _,airport in pairs(self.player[id].airports) do
+  for _,airport in pairs(self.group[GID].player[UID].airports) do
   
     i=i+1
     if i > 10 then
@@ -609,37 +644,38 @@ function PSEUDOATC:MenuAirports(id)
     local pos=AIRBASE:FindByName(name):GetCoordinate()
     
     --F10menu_ATC_airports[ID][name] = missionCommands.addSubMenuForGroup(ID, name, F10menu_ATC)
-    local submenu=missionCommands.addSubMenuForGroup(id, name, self.player[id].menu_airports)
+    local submenu=missionCommands.addSubMenuForGroup(GID, name, self.group[GID].player[UID].menu_airports)
     
     -- Create menu reporting commands
-    missionCommands.addCommandForGroup(id, "Weather Report", submenu, self.ReportWeather, self, id, pos, name)
-    missionCommands.addCommandForGroup(id, "Request BR", submenu, self.ReportBR, self, id, pos, name)
+    missionCommands.addCommandForGroup(GID, "Weather Report", submenu, self.ReportWeather, self, GID, UID, pos, name)
+    missionCommands.addCommandForGroup(GID, "Request BR", submenu, self.ReportBR, self, GID, UID, pos, name)
     
     -- Debug message.
-    self:T(string.format(PSEUDOATC.id.."Creating airport menu item %s for ID %d", name, id))
+    self:T(string.format(PSEUDOATC.id.."Creating airport menu item %s for ID %d", name, GID))
   end
 end
 
 --- Create "F10/Pseudo ATC/Waypoints/<Waypoint i>  menu items.
 -- @param #PSEUDOATC self
--- @param #number id Group id of player unit for which menues are created. 
-function PSEUDOATC:MenuWaypoints(id)
-  self:F(id)
+-- @param #number GID Group id of player unit.
+-- @param #number UID Unit id of player. 
+function PSEUDOATC:MenuWaypoints(GID, UID)
+  self:F({GID=GID, UID=UID})
 
   -- Player unit and callsign.
-  local unit=self.player[id].unit --Wrapper.Unit#UNIT
-  local callsign=self.player[id].callsign
+--  local unit=self.group[GID].player[UID].unit --Wrapper.Unit#UNIT
+  local callsign=self.group[GID].player[UID].callsign
   
   -- Debug info.
-  self:T(PSEUDOATC.id..string.format("Creating waypoint menu for %s (ID %d).", callsign, id))
+  self:T(PSEUDOATC.id..string.format("Creating waypoint menu for %s (ID %d).", callsign, GID))
      
-  if #self.player[id].waypoints>0 then
+  if #self.group[GID].player[UID].waypoints>0 then
   
     -- F10/PseudoATC/Waypoints
-    self.player[id].menu_waypoints=missionCommands.addSubMenuForGroup(id, "Waypoints", self.player[id].menu_main)
+    self.group[GID].player[UID].menu_waypoints=missionCommands.addSubMenuForGroup(GID, "Waypoints", self.group[GID].player[UID].menu_own)
 
     local j=0    
-    for i, wp in pairs(self.player[id].waypoints) do
+    for i, wp in pairs(self.group[GID].player[UID].waypoints) do
     
       -- Increase counter
       j=j+1
@@ -653,16 +689,16 @@ function PSEUDOATC:MenuWaypoints(id)
       local name=string.format("Waypoint %d", i-1)
       
       -- "F10/PseudoATC/Waypoints/Waypoint X"
-      local submenu=missionCommands.addSubMenuForGroup(id, name, self.player[id].menu_waypoints)
+      local submenu=missionCommands.addSubMenuForGroup(GID, name, self.group[GID].player[UID].menu_waypoints)
       
       -- Menu commands for each waypoint "F10/PseudoATC/My Aircraft (callsign)/Waypoints/Waypoint X/<Commands>"
-      missionCommands.addCommandForGroup(id, "Weather Report", submenu, self.ReportWeather, self, id, pos, name)
-      missionCommands.addCommandForGroup(id, "Request BR", submenu, self.ReportBR, self, id, pos, name)
+      missionCommands.addCommandForGroup(GID, "Weather Report", submenu, self.ReportWeather, self, GID, UID, pos, name)
+      missionCommands.addCommandForGroup(GID, "Request BR", submenu, self.ReportBR, self, GID, UID, pos, name)
     end
   end
   
-  self.player[id].menu_reportalt  = missionCommands.addCommandForGroup(id, "Talk me down",     self.player[id].menu_main, self.AltidudeTimerToggle, self, id)
-  self.player[id].menu_requestalt = missionCommands.addCommandForGroup(id, "Request altitude", self.player[id].menu_main, self.ReportHeight, self, id)
+  self.group[GID].player[UID].menu_reportalt  = missionCommands.addCommandForGroup(GID, "Talk me down",     self.group[GID].player[UID].menu_own, self.AltidudeTimerToggle, self, GID, UID)
+  self.group[GID].player[UID].menu_requestalt = missionCommands.addCommandForGroup(GID, "Request altitude", self.group[GID].player[UID].menu_own, self.ReportHeight, self, GID, UID)
 end
 
 -----------------------------------------------------------------------------------------------------------------------------------------
@@ -670,14 +706,15 @@ end
 
 --- Weather Report. Report pressure QFE/QNH, temperature, wind at certain location.
 -- @param #PSEUDOATC self
--- @param #number id Group id to which the report is delivered.
+-- @param #number GID Group id of player unit.
+-- @param #number UID Unit id of player. 
 -- @param Core.Point#COORDINATE position Coordinates at which the pressure is measured.
 -- @param #string location Name of the location at which the pressure is measured.
-function PSEUDOATC:ReportWeather(id, position, location)
-  self:F({id=id, position=position, location=location})
+function PSEUDOATC:ReportWeather(GID, UID, position, location)
+  self:F({GID=GID, UID=UID, position=position, location=location})
   
   -- Player unit system settings.
-  local settings=_DATABASE:GetPlayerSettings(self.player[id].playername) or _SETTINGS --Core.Settings#SETTINGS
+  local settings=_DATABASE:GetPlayerSettings(self.group[GID].player[UID].playername) or _SETTINGS --Core.Settings#SETTINGS
   
   local text=string.format("Local weather at %s:\n", location)
    
@@ -729,36 +766,37 @@ function PSEUDOATC:ReportWeather(id, position, location)
   end  
   
   -- Message text.
-  local text=text..string.format("Wind from %s at %s (%s).", Ds, Vs, Bd)
+  local text=text..string.format("%s, Wind from %s at %s (%s).", self.group[GID].player[UID].playername, Ds, Vs, Bd)
   
   -- Send message
-  self:_DisplayMessageToGroup(self.player[id].unit, text, self.mdur, true)
+  self:_DisplayMessageToGroup(self.group[GID].player[UID].unit, text, self.mdur, true)
   
 end
 
 --- Report absolute bearing and range form player unit to airport.
 -- @param #PSEUDOATC self
--- @param #number id Group id to the report is delivered.
+-- @param #number GID Group id of player unit.
+-- @param #number UID Unit id of player. 
 -- @param Core.Point#COORDINATE position Coordinates at which the pressure is measured.
 -- @param #string location Name of the location at which the pressure is measured.
-function PSEUDOATC:ReportBR(id, position, location)
-  self:F({id=id, position=position, location=location})
+function PSEUDOATC:ReportBR(GID, UID, position, location)
+  self:F({GID=GID, UID=UID, position=position, location=location})
 
   -- Current coordinates.
-  local unit=self.player[id].unit --Wrapper.Unit#UNIT
+  local unit=self.group[GID].player[UID].unit --Wrapper.Unit#UNIT
   local coord=unit:GetCoordinate()
   
   -- Direction vector from current position (coord) to target (position).
-  local pos=coord:Translate(30,90)
-  local vec3=coord:GetDirectionVec3(pos)
-  local angle=coord:GetAngleDegrees(vec3)
+  local angle=coord:HeadingTo(position)
+  
+  -- Range from current to 
   local range=coord:Get2DDistance(position)
   
   -- Bearing string.
   local Bs=string.format('%03d°', angle)
   
   -- Settings.
-  local settings=_DATABASE:GetPlayerSettings(self.player[id].playername) or _SETTINGS --Core.Settings#SETTINGS
+  local settings=_DATABASE:GetPlayerSettings(self.group[GID].player[UID].playername) or _SETTINGS --Core.Settings#SETTINGS
   
   
   local Rs=string.format("%.1f NM", UTILS.MetersToNM(range))
@@ -769,18 +807,20 @@ function PSEUDOATC:ReportBR(id, position, location)
   -- Message text.
   local text=string.format("%s: Bearing %s, Range %s.", location, Bs, Rs)
 
-  -- Send message to player group.  
-  MESSAGE:New(text, self.mdur):ToGroup(self.player[id].group)      
+  -- Send message
+  self:_DisplayMessageToGroup(self.group[GID].player[UID].unit, text, self.mdur, true)  
+  
 end
 
 --- Report altitude above ground level of player unit.
 -- @param #PSEUDOATC self
--- @param #number id Group id to the report is delivered.
+-- @param #number GID Group id of player unit.
+-- @param #number UID Unit id of player. 
 -- @param #number dt (Optional) Duration the message is displayed.
 -- @param #boolean _clear (Optional) Clear previouse messages. 
 -- @return #number Altitude above ground.
-function PSEUDOATC:ReportHeight(id, dt, _clear)
-  self:F({id=id, dt=dt})
+function PSEUDOATC:ReportHeight(GID, UID, dt, _clear)
+  self:F({GID=GID, UID=UID, dt=dt})
 
   local dt = dt or self.mdur
   if _clear==nil then
@@ -797,7 +837,7 @@ function PSEUDOATC:ReportHeight(id, dt, _clear)
   end
 
   -- Get height AGL.
-  local unit=self.player[id].unit --Wrapper.Unit#UNIT
+  local unit=self.group[GID].player[UID].unit --Wrapper.Unit#UNIT
   
   if unit and unit:IsAlive() then
   
@@ -806,7 +846,7 @@ function PSEUDOATC:ReportHeight(id, dt, _clear)
     local callsign=unit:GetCallsign()
     
     -- Settings.
-    local settings=_DATABASE:GetPlayerSettings(self.player[id].playername) or _SETTINGS --Core.Settings#SETTINGS
+    local settings=_DATABASE:GetPlayerSettings(self.group[GID].player[UID].playername) or _SETTINGS --Core.Settings#SETTINGS
     
     -- Height string.
     local Hs=string.format("%d ft", UTILS.MetersToFeet(height))
@@ -823,7 +863,7 @@ function PSEUDOATC:ReportHeight(id, dt, _clear)
     end
     
     -- Send message to player group.  
-    self:_DisplayMessageToGroup(self.player[id].unit,_text, dt,_clear)
+    self:_DisplayMessageToGroup(self.group[GID].player[UID].unit,_text, dt,_clear)
     
     -- Return height
     return height
@@ -836,47 +876,50 @@ end
 
 --- Toggle report altitude reporting on/off.
 -- @param #PSEUDOATC self.
--- @param #number id Group id of player unit. 
-function PSEUDOATC:AltidudeTimerToggle(id)
-  self:F(id)
+-- @param #number GID Group id of player unit.
+-- @param #number UID Unit id of player. 
+function PSEUDOATC:AltidudeTimerToggle(GID,UID)
+  self:F({GID=GID, UID=UID})
   
-  if self.player[id].altimerid then
+  if self.group[GID].player[UID].altimerid then
     -- If the timer is on, we turn it off.
-    self:AltitudeTimerStop(id)
+    self:AltitudeTimerStop(GID, UID)
   else
     -- If the timer is off, we turn it on.
-    self:AltitudeTimeStart(id)
+    self:AltitudeTimeStart(GID, UID)
   end
 end
 
 --- Start altitude reporting scheduler.
 -- @param #PSEUDOATC self.
--- @param #number id Group id of player unit. 
-function PSEUDOATC:AltitudeTimeStart(id)
-  self:F(id)
+-- @param #number GID Group id of player unit.
+-- @param #number UID Unit id of player. 
+function PSEUDOATC:AltitudeTimeStart(GID, UID)
+  self:F({GID=GID, UID=UID})
   
   -- Debug info.
-  self:T(PSEUDOATC.id..string.format("Starting altitude report timer for player ID %d.", id))
+  self:T(PSEUDOATC.id..string.format("Starting altitude report timer for player ID %d.", UID))
   
   -- Start timer. Altitude is reported every ~3 seconds.
-  self.player[id].altimer, self.player[id].altimerid=SCHEDULER:New(nil, self.ReportHeight, {self, id, 0.1, true}, 1, 3)
+  self.group[GID].player[UID].altimer, self.group[GID].player[UID].altimerid=SCHEDULER:New(nil, self.ReportHeight, {self, GID, UID, 0.1, true}, 1, 3)
 end
 
 --- Stop/destroy DCS scheduler function for reporting altitude.
 -- @param #PSEUDOATC self.
--- @param #number id Group id of player unit. 
-function PSEUDOATC:AltitudeTimerStop(id)
-
+-- @param #number GID Group id of player unit.
+-- @param #number UID Unit id of player. 
+function PSEUDOATC:AltitudeTimerStop(GID, UID)
+  self:F({GID=GID,UID=UID})
   -- Debug info.
-  self:T(PSEUDOATC.id..string.format("Stopping altitude report timer for player ID %d.", id))
+  self:T(PSEUDOATC.id..string.format("Stopping altitude report timer for player ID %d.", UID))
   
   -- Stop timer.
-  if self.player[id].altimerid then
-    self.player[id].altimer:Stop(self.player[id].altimerid)
+  if self.group[GID].player[UID].altimerid then
+    self.group[GID].player[UID].altimer:Stop(self.group[GID].player[UID].altimerid)
   end
   
-  self.player[id].altimer=nil
-  self.player[id].altimerid=nil
+  self.group[GID].player[UID].altimer=nil
+  self.group[GID].player[UID].altimerid=nil
 end
 
 -----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
@@ -884,16 +927,17 @@ end
 
 --- Create list of nearby airports sorted by distance to player unit.
 -- @param #PSEUDOATC self
--- @param #number id Group id of player unit.
-function PSEUDOATC:LocalAirports(id)
-  self:F(id)
+-- @param #number GID Group id of player unit.
+-- @param #number UID Unit id of player. 
+function PSEUDOATC:LocalAirports(GID, UID)
+  self:F({GID=GID, UID=UID})
 
   -- Airports table.  
-  self.player[id].airports=nil
-  self.player[id].airports={}
+  self.group[GID].player[UID].airports=nil
+  self.group[GID].player[UID].airports={}
   
   -- Current player position.
-  local pos=self.player[id].unit:GetCoordinate()
+  local pos=self.group[GID].player[UID].unit:GetCoordinate()
   
   -- Loop over coalitions.
   for i=0,2 do
@@ -909,7 +953,7 @@ function PSEUDOATC:LocalAirports(id)
       local d=q:Get2DDistance(pos)
       
       -- Add to table.
-      table.insert(self.player[id].airports, {distance=d, name=name})
+      table.insert(self.group[GID].player[UID].airports, {distance=d, name=name})
       
     end
   end
@@ -920,7 +964,7 @@ function PSEUDOATC:LocalAirports(id)
   end
   
   -- Sort airports table w.r.t. distance to player.
-  table.sort(self.player[id].airports, compare)
+  table.sort(self.group[GID].player[UID].airports, compare)
   
 end
 
@@ -998,3 +1042,5 @@ function PSEUDOATC:_myname(unitname)
   return string.format("%s (%s)", csign, pname)
 end
 
+
+

Moose Development/Moose/Functional/RAT.lua

@@ -1,33 +1,31 @@
---- **Functional** - (R2.2) - Create random airtraffic in your missions.
+--- **Functional** - Create random airtraffic in your missions.
 -- 
 -- ===
 -- 
--- The aim of the RAT class is to fill the empty DCS world with randomized air traffic and bring more life to your airports.
--- 
--- In particular, it is designed to spawn AI air units at random airports. These units will be assigned a random flight path to another random airport on the map.
--- 
+-- The aim of the RAT class is to fill the empty DCS world with randomized air traffic and bring more life to your airports.  
+-- In particular, it is designed to spawn AI air units at random airports. These units will be assigned a random flight path to another random airport on the map.  
 -- Even the mission designer will not know where aircraft will be spawned and which route they follow.
 -- 
--- ## Features
+-- ## Features:
 -- 
---  * Very simple interface. Just one unit and two lines of Lua code needed to fill your map.
---  * High degree of randomization. Aircraft will spawn at random airports, have random routes and random destinations.
---  * Specific departure and/or destination airports can be chosen.
---  * Departure and destination airports can be restricted by coalition.
---  * Planes and helicopters supported. Helicopters can also be send to FARPs and ships.
---  * Units can also be spawned in air within pre-defined zones of the map.
---  * Aircraft will be removed when they arrive at their destination (or get stuck on the ground).
---  * When a unit is removed a new unit with a different flight plan is respawned.
---  * Aircraft can report their status during the route.
---  * All of the above can be customized by the user if necessary.
---  * All current (Caucasus, Nevada, Normandy, Persian Gulf) and future maps are supported.
+--   * Very simple interface. Just one unit and two lines of Lua code needed to fill your map.
+--   * High degree of randomization. Aircraft will spawn at random airports, have random routes and random destinations.
+--   * Specific departure and/or destination airports can be chosen.
+--   * Departure and destination airports can be restricted by coalition.
+--   * Planes and helicopters supported. Helicopters can also be send to FARPs and ships.
+--   * Units can also be spawned in air within pre-defined zones of the map.
+--   * Aircraft will be removed when they arrive at their destination (or get stuck on the ground).
+--   * When a unit is removed a new unit with a different flight plan is respawned.
+--   * Aircraft can report their status during the route.
+--   * All of the above can be customized by the user if necessary.
+--   * All current (Caucasus, Nevada, Normandy, Persian Gulf) and future maps are supported.
 --  
---  The RAT class creates an entry in the F10 radio menu which allows to
+-- The RAT class creates an entry in the F10 radio menu which allows to:
 --  
---  * Create new groups on-the-fly, i.e. at run time within the mission,
---  * Destroy specific groups (e.g. if they get stuck or damaged and block a runway),
---  * Request the status of all RAT aircraft or individual groups,
---  * Place markers at waypoints on the F10 map for each group.
+--   * Create new groups on-the-fly, i.e. at run time within the mission,
+--   * Destroy specific groups (e.g. if they get stuck or damaged and block a runway),
+--   * Request the status of all RAT aircraft or individual groups,
+--   * Place markers at waypoints on the F10 map for each group.
 -- 
 -- Note that by its very nature, this class is suited best for civil or transport aircraft. However, it also works perfectly fine for military aircraft of any kind.
 -- 
@@ -35,10 +33,9 @@
 -- 
 -- ===
 -- 
--- # Demo Missions
+-- ## Missions:
 --
--- ### [MOOSE - ALL Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS)
--- ### [MOOSE - RAT Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/RAT%20-%20Random%20Air%20Traffic)
+-- ### [RAT - Random Air Traffic](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/RAT%20-%20Random%20Air%20Traffic)
 -- 
 -- ===
 -- 
@@ -153,6 +150,8 @@
 -- @field #number  parkingscanradius Radius in meters until which parking spots are scanned for obstacles like other units, statics or scenery.
 -- @field #boolean parkingscanscenery If true, area around parking spots is scanned for scenery objects. Default is false.
 -- @field #boolean parkingverysafe If true, parking spots are considered as non-free until a possible aircraft has left and taken off. Default false.
+-- @field #boolean despawnair If true, aircraft are despawned when they reach their destination zone. Default.
+-- @field #boolean eplrs If true, turn on EPLSR datalink for the RAT group.
 -- @extends Core.Spawn#SPAWN
 
 --- Implements an easy to use way to randomly fill your map with AI aircraft.
@@ -219,6 +218,44 @@
 -- Hence, the default flight plan for a RAT aircraft will be: Fly from airport A to B, get respawned at C and fly to D, get respawned at E and fly to F, ...
 -- This ensures that you always have a constant number of AI aircraft on your map.
 -- 
+-- ## Parking Problems
+-- 
+-- One big issue in DCS is that not all aircraft can be spawned on every airport or airbase. In particular, bigger aircraft might not have a valid parking spot at smaller airports and 
+-- airstripes. This can lead to multiple problems in DCS.
+-- 
+-- * Landing: When an aircraft tries to land at an airport where it does not have a valid parking spot, it is immidiately despawned the moment its wheels touch the runway, i.e.
+-- when a landing event is triggered. This leads to the loss of the RAT aircraft. On possible way to circumvent the this problem is to let another RAT aircraft spawn at landing
+-- and not when it shuts down its engines. See the @{RAT.RespawnAfterLanding}() function.
+-- * Spawning: When a big aircraft is dynamically spawned on a small airbase a few things can go wrong. For example, it could be spawned at a parking spot with a shelter.
+-- Or it could be damaged by a scenery object when it is taxiing out to the runway, or it could overlap with other aircraft on parking spots near by.
+-- 
+-- You can check yourself if an aircraft has a valid parking spot at an airbase by dragging its group on the airport in the mission editor and set it to start from ramp.
+-- If it stays at the airport, it has a valid parking spot, if it jumps to another airport, it does not have a valid parking spot on that airbase.
+-- 
+-- ### Setting the Terminal Type
+-- Each parking spot has a specific type depending on its size or if a helicopter spot or a shelter etc. The classification is not perfect but it is the best we have.
+-- If you encounter problems described above, you can request a specific terminal type for the RAT aircraft. This can be done by the @{#RAT.SetTerminalType}(*terminaltype*)
+-- function. The parameter *terminaltype* can be set as follows
+-- 
+-- * AIRBASE.TerminalType.HelicopterOnly: Special spots for Helicopers.
+-- * AIRBASE.TerminalType.Shelter: Hardened Air Shelter. Currently only on Caucaus map.
+-- * AIRBASE.TerminalType.OpenMed: Open/Shelter air airplane only.
+-- * AIRBASE.TerminalType.OpenBig: Open air spawn points. Generally larger but does not guarantee large aircraft are capable of spawning there.
+-- * AIRBASE.TerminalType.OpenMedOrBig: Combines OpenMed and OpenBig spots.
+-- * AIRBASE.TerminalType.HelicopterUnsable: Combines HelicopterOnly, OpenMed and OpenBig.
+-- * AIRBASE.TerminalType.FighterAircraft: Combines Shelter, OpenMed and OpenBig spots. So effectively all spots usable by fixed wing aircraft.
+-- 
+-- So for example
+--      c17=RAT:New("C-17")
+--      c17:SetTerminalType(AIRBASE.TerminalType.OpenBig)
+--      c17:Spawn(5)
+--      
+-- This would randomly spawn five C-17s but only on airports which have big open air parking spots. Note that also only destination airports are allowed
+-- which do have this type of parking spot. This should ensure that the aircraft is able to land at the destination without beeing despawned immidiately.
+-- 
+-- Also, the aircraft are spawned only on the requested parking spot types and not on any other type. If no parking spot of this type is availabe at the
+-- moment of spawning, the group is automatically spawned in air above the selected airport.
+-- 
 -- ## Examples
 -- 
 -- Here are a few examples, how you can modify the default settings of RAT class objects.
@@ -393,6 +430,8 @@ RAT={
   parkingscanradius=40,     -- Scan radius.
   parkingscanscenery=false, -- Scan parking spots for scenery obstacles.
   parkingverysafe=false,    -- Very safe option.
+  despawnair=true,
+  eplrs=false,
 }
 
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
@@ -511,7 +550,7 @@ RAT.id="RAT | "
 --- RAT version.
 -- @list version
 RAT.version={
-  version = "2.3.2",
+  version = "2.3.8",
   print = true,
 }
 
@@ -682,6 +721,11 @@ function RAT:Spawn(naircraft)
       self.FLcruise=005*RAT.unit.FL2m
     end
   end
+
+  -- Enable helos to go to destinations 100 meters away.  
+  if self.category==RAT.cat.heli then
+    self.mindist=50
+  end  
   
   -- Run consistency checks.
   self:_CheckConsistency()
@@ -983,11 +1027,11 @@ function RAT:SetCoalitionAircraft(color)
 end
 
 --- Set country of RAT group.
--- See https://wiki.hoggitworld.com/view/DCS_enum_country
+-- See [DCS_enum_country](https://wiki.hoggitworld.com/view/DCS_enum_country).
 -- 
 -- This overrules the coalition settings. So if you want your group to be of a specific coalition, you have to set a country that is part of that coalition.
 -- @param #RAT self
--- @param #DCS.country.id id DCS country enumerator ID. For example country.id.USA or country.id.RUSSIA.
+-- @param DCS#country.id id DCS country enumerator ID. For example country.id.USA or country.id.RUSSIA.
 -- @return #RAT RAT self object.
 function RAT:SetCountry(id)
   self:F2(id)
@@ -995,10 +1039,17 @@ function RAT:SetCountry(id)
   return self
 end
 
---- Set the terminal type the aircraft use when spawning at an airbase. Cf. https://wiki.hoggitworld.com/view/DCS_func_getParking
+--- Set the terminal type the aircraft use when spawning at an airbase. See [DCS_func_getParking](https://wiki.hoggitworld.com/view/DCS_func_getParking).
+-- Note that some additional terminal types have been introduced. Check @{Wrapper.Airbase#AIRBASE} class for details.
+-- Also note that only airports which have this kind of terminal are possible departures and/or destinations.
 -- @param #RAT self
 -- @param Wrapper.Airbase#AIRBASE.TerminalType termtype Type of terminal. Use enumerator AIRBASE.TerminalType.XXX.
 -- @return #RAT RAT self object.
+-- 
+-- @usage
+-- c17=RAT:New("C-17 BIG Plane")
+-- c17:SetTerminalType(AIRBASE.TerminalType.OpenBig) -- Only very big parking spots are used.
+-- c17:Spawn(5)
 function RAT:SetTerminalType(termtype)
   self:F2(termtype)
   self.termtype=termtype
@@ -1051,6 +1102,14 @@ function RAT:SetParkingSpotSafeOFF()
   return self
 end
 
+--- Aircraft that reach their destination zone are not despawned. They will probably go the the nearest airbase and try to land.
+-- @param #RAT self
+-- @return #RAT RAT self object.
+function RAT:SetDespawnAirOFF()
+  self.despawnair=false
+  return self
+end
+
 --- Set takeoff type. Starting cold at airport, starting hot at airport, starting at runway, starting in the air.
 -- Default is "takeoff-coldorhot". So there is a 50% chance that the aircraft starts with cold engines and 50% that it starts with hot engines. 
 -- @param #RAT self
@@ -1585,6 +1644,19 @@ function RAT:Invisible()
   return self
 end
 
+--- Turn EPLRS datalink on/off. 
+-- @param #RAT self
+-- @param #boolean switch If true (or nil), turn EPLRS on.
+-- @return #RAT RAT self object.
+function RAT:SetEPLRS(switch)
+  if switch==nil or switch==true then
+    self.eplrs=true
+  else
+    self.eplrs=false
+  end
+  return self
+end
+
 --- Aircraft are immortal. 
 -- @param #RAT self
 -- @return #RAT RAT self object.
@@ -1770,14 +1842,14 @@ function RAT:ATC_Delay(time)
 end
 
 --- Set minimum distance between departure and destination. Default is 5 km.
--- Minimum distance should not be smaller than maybe ~500 meters to ensure that departure and destination are different.
+-- Minimum distance should not be smaller than maybe ~100 meters to ensure that departure and destination are different.
 -- @param #RAT self
 -- @param #number dist Distance in km.
 -- @return #RAT RAT self object.
 function RAT:SetMinDistance(dist)
   self:F2(dist)
   -- Distance in meters. Absolute minimum is 500 m.
-  self.mindist=math.max(500, dist*1000)
+  self.mindist=math.max(100, dist*1000)
   return self
 end
 
@@ -2019,8 +2091,9 @@ end
 -- @param #table _waypoint First waypoint to be used (for continue journey, commute, etc).
 -- @param Core.Point#COORDINATE _lastpos (Optional) Position where the aircraft will be spawned.
 -- @param #number _nrespawn Number of already performed respawn attempts (e.g. spawning on runway bug).
+-- @param #table parkingdata Explicitly specify the parking spots when spawning at an airport.
 -- @return #number Spawn index.
-function RAT:_SpawnWithRoute(_departure, _destination, _takeoff, _landing, _livery, _waypoint, _lastpos, _nrespawn)
+function RAT:_SpawnWithRoute(_departure, _destination, _takeoff, _landing, _livery, _waypoint, _lastpos, _nrespawn, parkingdata)
   self:F({rat=RAT.id, departure=_departure, destination=_destination, takeoff=_takeoff, landing=_landing, livery=_livery, waypoint=_waypoint, lastpos=_lastpos, nrespawn=_nrespawn})
 
   -- Set takeoff type.
@@ -2070,7 +2143,7 @@ function RAT:_SpawnWithRoute(_departure, _destination, _takeoff, _landing, _live
   end
   
   -- Modify the spawn template to follow the flight plan.
-  local successful=self:_ModifySpawnTemplate(waypoints, livery, _lastpos, departure, takeoff)
+  local successful=self:_ModifySpawnTemplate(waypoints, livery, _lastpos, departure, takeoff, parkingdata)
   if not successful then
     return nil
   end
@@ -2106,6 +2179,11 @@ function RAT:_SpawnWithRoute(_departure, _destination, _takeoff, _landing, _live
     self:_CommandImmortal(group, true)
   end
   
+  -- Set group to be immortal.
+  if self.eplrs then
+    group:CommandEPLRS(true, 1)
+  end  
+  
   -- Set ROE, default is "weapon hold".
   self:_SetROE(group, self.roe)
   
@@ -2403,7 +2481,7 @@ function RAT:_SetRoute(takeoff, landing, _departure, _destination, _waypoint)
   local VxCruiseMax
   if self.Vcruisemax then
     -- User input.
-    VxCruiseMax = min(self.Vcruisemax, self.aircraft.Vmax)
+    VxCruiseMax = math.min(self.Vcruisemax, self.aircraft.Vmax)
   else
     -- Max cruise speed 90% of Vmax or 900 km/h whichever is lower.
     VxCruiseMax = math.min(self.aircraft.Vmax*0.90, 250)
@@ -2413,7 +2491,7 @@ function RAT:_SetRoute(takeoff, landing, _departure, _destination, _waypoint)
   local VxCruiseMin = math.min(VxCruiseMax*0.70, 166)
   
   -- Cruise speed (randomized). Expectation value at midpoint between min and max.
-  local VxCruise = self:_Random_Gaussian((VxCruiseMax-VxCruiseMin)/2+VxCruiseMin, (VxCruiseMax-VxCruiseMax)/4, VxCruiseMin, VxCruiseMax)
+  local VxCruise = UTILS.RandomGaussian((VxCruiseMax-VxCruiseMin)/2+VxCruiseMin, (VxCruiseMax-VxCruiseMax)/4, VxCruiseMin, VxCruiseMax)
   
   -- Climb speed 90% ov Vmax but max 720 km/h.
   local VxClimb = math.min(self.aircraft.Vmax*0.90, 200)
@@ -2771,7 +2849,7 @@ function RAT:_SetRoute(takeoff, landing, _departure, _destination, _waypoint)
   end
     
   -- Set cruise altitude. Selected from Gaussian distribution but limited to FLmin and FLmax.
-  local FLcruise=self:_Random_Gaussian(FLcruise_expect, math.abs(FLmax-FLmin)/4, FLmin, FLmax)
+  local FLcruise=UTILS.RandomGaussian(FLcruise_expect, math.abs(FLmax-FLmin)/4, FLmin, FLmax)
     
   -- Overrule setting if user specified a flight level explicitly.
   if self.FLuser then
@@ -3010,14 +3088,27 @@ function RAT:_PickDeparture(takeoff)
   if self.random_departure then
   
     -- Airports of friendly coalitions.
-    for _,airport in pairs(self.airports) do
+    for _,_airport in pairs(self.airports) do
     
+      local airport=_airport --Wrapper.Airbase#AIRBASE
+      
       local name=airport:GetName()
       if not self:_Excluded(name) then
         if takeoff==RAT.wp.air then
+        
           table.insert(departures, airport:GetZone())  -- insert zone object.
+          
         else
-          table.insert(departures, airport)            -- insert airport object.
+        
+          -- Check if airbase has the right terminals.
+          local nspots=1
+          if self.termtype~=nil then
+            nspots=airport:GetParkingSpotsNumber(self.termtype)
+          end
+          
+          if nspots>0 then
+            table.insert(departures, airport)            -- insert airport object.
+          end
         end
       end
       
@@ -3034,6 +3125,14 @@ function RAT:_PickDeparture(takeoff)
           dep=AIRBASE:FindByName(name):GetZone()
         else
           dep=AIRBASE:FindByName(name)
+          -- Check if the airport has a valid parking spot
+          if self.termtype~=nil and dep~=nil then
+            local _dep=dep --Wrapper.Airbase#AIRBASE
+            local nspots=_dep:GetParkingSpotsNumber(self.termtype)
+            if nspots==0 then
+              dep=nil
+            end
+          end
         end
       elseif self:_ZoneExists(name) then
         if takeoff==RAT.wp.air then
@@ -3098,7 +3197,8 @@ function RAT:_PickDestination(departure, q, minrange, maxrange, random, landing)
   if random then
   
     -- Airports of friendly coalitions.
-    for _,airport in pairs(self.airports) do
+    for _,_airport in pairs(self.airports) do
+      local airport=_airport --Wrapper.Airbase#AIRBASE
       local name=airport:GetName()
       if self:_IsFriendly(name) and not self:_Excluded(name) and name~=departure:GetName() then
       
@@ -3110,7 +3210,14 @@ function RAT:_PickDestination(departure, q, minrange, maxrange, random, landing)
           if landing==RAT.wp.air then
             table.insert(destinations, airport:GetZone())  -- insert zone object.
           else
-            table.insert(destinations, airport)            -- insert airport object.
+            -- Check if the requested terminal type is available.
+            local nspot=1
+            if self.termtype then
+              nspot=airport:GetParkingSpotsNumber(self.termtype)
+            end
+            if nspot>0 then
+              table.insert(destinations, airport)            -- insert airport object.
+            end
           end
         end
       end
@@ -3130,6 +3237,14 @@ function RAT:_PickDestination(departure, q, minrange, maxrange, random, landing)
             dest=AIRBASE:FindByName(name):GetZone()
           else
             dest=AIRBASE:FindByName(name)
+            -- Check if the requested terminal type is available.
+            local nspot=1
+            if self.termtype then
+              nspot=dest:GetParkingSpotsNumber(self.termtype)
+            end
+            if nspot==0 then
+              dest=nil
+            end
           end
         elseif self:_ZoneExists(name) then
           if landing==RAT.wp.air then
@@ -3277,26 +3392,49 @@ function RAT:_GetAirportsOfMap()
       local _name=airbase:getName()
       local _myab=AIRBASE:FindByName(_name)
       
-      -- Add airport to table.
-      table.insert(self.airports_map, _myab)
+      if _myab then
       
-      local text="MOOSE: Airport ID = ".._myab:GetID().." and Name = ".._myab:GetName()..", Category = ".._myab:GetCategory()..", TypeName = ".._myab:GetTypeName()
-      self:T(RAT.id..text)
+        -- Add airport to table.
+        table.insert(self.airports_map, _myab)
+        
+        local text="MOOSE: Airport ID = ".._myab:GetID().." and Name = ".._myab:GetName()..", Category = ".._myab:GetCategory()..", TypeName = ".._myab:GetTypeName()
+        self:T(RAT.id..text)
+        
+      else
+      
+        self:E(RAT.id..string.format("WARNING: Airbase %s does not exsist as MOOSE object!", tostring(_name)))
+      
+      end
     end
     
   end
 end
 
---- Get all "friendly" airports of the current map.
+--- Get all "friendly" airports of the current map. Fills the self.airports{} table.
 -- @param #RAT self
 function RAT:_GetAirportsOfCoalition()
   for _,coalition in pairs(self.ctable) do
-    for _,airport in pairs(self.airports_map) do
+    for _,_airport in pairs(self.airports_map) do
+      local airport=_airport --Wrapper.Airbase#AIRBASE
+      local category=airport:GetDesc().category
       if airport:GetCoalition()==coalition then
         -- Planes cannot land on FARPs.
-        local condition1=self.category==RAT.cat.plane and airport:GetTypeName()=="FARP"
+        --local condition1=self.category==RAT.cat.plane and airport:GetTypeName()=="FARP"
+        local condition1=self.category==RAT.cat.plane and category==Airbase.Category.HELIPAD
         -- Planes cannot land on ships.
-        local condition2=self.category==RAT.cat.plane and airport:GetCategory()==1
+        --local condition2=self.category==RAT.cat.plane and airport:GetCategory()==1
+        local condition2=self.category==RAT.cat.plane and category==Airbase.Category.SHIP
+        
+        -- Check that airport has the requested terminal types.
+        -- NOT good here because we would also not allow any airport zones!
+        --[[
+        local nspots=1
+        if self.termtype then
+          nspots=airport:GetParkingSpotsNumber(self.termtype)
+        end
+        local condition3 = nspots==0
+        ]]
+        
         if not (condition1 or condition2) then
           table.insert(self.airports, airport)
         end
@@ -3305,8 +3443,8 @@ function RAT:_GetAirportsOfCoalition()
   end
     
   if #self.airports==0 then
-    local text="ERROR! No possible departure/destination airports found."
-    MESSAGE:New(text, 30):ToAll()
+    local text=string.format("No possible departure/destination airports found for RAT %s.", tostring(self.alias))
+    MESSAGE:New(text, 10):ToAll()
     self:E(RAT.id..text)
   end
 end
@@ -3504,13 +3642,18 @@ function RAT:Status(message, forID)
       
         local text=string.format("Flight %s will be despawned NOW!", self.alias)
         self:T(RAT.id..text)
-        -- Despawn old group.
+        
+        -- Respawn group
         if (not self.norespawn) and (not self.respawn_after_takeoff) then
           local idx=self:GetSpawnIndexFromGroup(group)
           local coord=group:GetCoordinate()  
           self:_Respawn(idx, coord, 0)
         end
-        self:_Despawn(group, 0)
+        
+        -- Despawn old group.
+        if self.despawnair then
+          self:_Despawn(group, 0)
+        end
         
       end
 
@@ -4916,38 +5059,6 @@ function RAT:_Randomize(value, fac, lower, upper)
   return r
 end
 
---- Generate Gaussian pseudo-random numbers.
--- @param #number x0 Expectation value of distribution.
--- @param #number sigma (Optional) Standard deviation. Default 10.
--- @param #number xmin (Optional) Lower cut-off value.
--- @param #number xmax (Optional) Upper cut-off value.
--- @return #number Gaussian random number.
-function RAT:_Random_Gaussian(x0, sigma, xmin, xmax)
-
-  -- Standard deviation. Default 10 if not given.
-  sigma=sigma or 10
-    
-  local r
-  local gotit=false
-  local i=0
-  while not gotit do
-  
-    -- Uniform numbers in [0,1). We need two.
-    local x1=math.random()
-    local x2=math.random()
-  
-    -- Transform to Gaussian exp(-(x-x0)²/(2*sigma²).
-    r = math.sqrt(-2*sigma*sigma * math.log(x1)) * math.cos(2*math.pi * x2) + x0
-    
-    i=i+1
-    if (r>=xmin and r<=xmax) or i>100 then
-      gotit=true
-    end
-  end
-  
-  return r
-
-end
 
 --- Place markers of the waypoints. Note we assume a very specific number and type of waypoints here.
 -- @param #RAT self
@@ -5006,9 +5117,10 @@ end
 -- @param Core.Point#COORDINATE spawnplace (Optional) Place where spawning should happen. If not present, first waypoint is taken.
 -- @param Wrapper.Airbase#AIRBASE departure Departure airbase or zone.
 -- @param #number takeoff Takeoff type.
+-- @param #table parkingdata Parking data, i.e. parking spot coordinates and terminal ids for all units of the group.
 -- @return #boolean True if modification was successful or nil if not, e.g. when no parking space was found and spawn in air is disabled.
-function RAT:_ModifySpawnTemplate(waypoints, livery, spawnplace, departure, takeoff)
-  self:F2({waypoints=waypoints, livery=livery, spawnplace=spawnplace, departure=departure, takeoff=takeoff})
+function RAT:_ModifySpawnTemplate(waypoints, livery, spawnplace, departure, takeoff, parkingdata)
+  self:F2({waypoints=waypoints, livery=livery, spawnplace=spawnplace, departure=departure, takeoff=takeoff, parking=parkingdata})
 
   -- The 3D vector of the first waypoint, i.e. where we actually spawn the template group.
   local PointVec3 = COORDINATE:New(waypoints[1].x, waypoints[1].alt, waypoints[1].y)
@@ -5096,6 +5208,10 @@ function RAT:_ModifySpawnTemplate(waypoints, livery, spawnplace, departure, take
           self:T(RAT.id..string.format("Group %s is spawned on farp/ship/runway %s.", self.alias, departure:GetName()))
           nfree=departure:GetFreeParkingSpotsNumber(termtype, true)
           spots=departure:GetFreeParkingSpotsTable(termtype, true)
+        elseif parkingdata~=nil then
+          -- Parking data explicitly set by user as input parameter.
+          nfree=#parkingdata
+          spots=parkingdata
         else
           -- Helo is spawned.
           if self.category==RAT.cat.heli then
@@ -5254,7 +5370,7 @@ function RAT:_ModifySpawnTemplate(waypoints, livery, spawnplace, departure, take
                
         if spawnonground then
           
-          -- Shíps and FARPS seem to have a build in queue.
+          -- Sh<EFBFBD>ps and FARPS seem to have a build in queue.
           if spawnonship or spawnonfarp or spawnonrunway or automatic then
             self:T(RAT.id..string.format("RAT group %s spawning at farp, ship or runway %s.", self.alias, departure:GetName()))
 
@@ -5367,7 +5483,7 @@ function RAT:_ATCInit(airports_map)
   if not RAT.ATC.init then
     local text
     text="Starting RAT ATC.\nSimultanious = "..RAT.ATC.Nclearance.."\n".."Delay        = "..RAT.ATC.delay
-	  self:T(RAT.id..text)
+	  BASE:T(RAT.id..text)
     RAT.ATC.init=true
     for _,ap in pairs(airports_map) do
       local name=ap:GetName()
@@ -5390,7 +5506,7 @@ end
 -- @param #string name Group name of the flight.
 -- @param #string dest Name of the destination airport.
 function RAT:_ATCAddFlight(name, dest)
-  self:T(string.format("%sATC %s: Adding flight %s with destination %s.", RAT.id, dest, name, dest))
+  BASE:T(string.format("%sATC %s: Adding flight %s with destination %s.", RAT.id, dest, name, dest))
   RAT.ATC.flight[name]={}
   RAT.ATC.flight[name].destination=dest
   RAT.ATC.flight[name].Tarrive=-1
@@ -5415,7 +5531,7 @@ end
 -- @param #string name Group name of the flight.
 -- @param #number time Time the fight first registered.
 function RAT:_ATCRegisterFlight(name, time)
-  self:T(RAT.id.."Flight ".. name.." registered at ATC for landing clearance.")
+  BASE:T(RAT.id.."Flight ".. name.." registered at ATC for landing clearance.")
   RAT.ATC.flight[name].Tarrive=time
   RAT.ATC.flight[name].holding=0
 end
@@ -5446,7 +5562,7 @@ function RAT:_ATCStatus()
       
       -- Aircraft is holding.
       local text=string.format("ATC %s: Flight %s is holding for %i:%02d. %s.", dest, name, hold/60, hold%60, busy)
-      self:T(RAT.id..text)
+      BASE:T(RAT.id..text)
       
     elseif hold==RAT.ATC.onfinal then
     
@@ -5454,7 +5570,7 @@ function RAT:_ATCStatus()
       local Tfinal=Tnow-RAT.ATC.flight[name].Tonfinal
       
       local text=string.format("ATC %s: Flight %s is on final. Waiting %i:%02d for landing event.", dest, name, Tfinal/60, Tfinal%60)
-      self:T(RAT.id..text)
+      BASE:T(RAT.id..text)
       
     elseif hold==RAT.ATC.unregistered then
     
@@ -5462,7 +5578,7 @@ function RAT:_ATCStatus()
       --self:T(string.format("ATC %s: Flight %s is not registered yet (hold %d).", dest, name, hold))
       
     else
-      self:E(RAT.id.."ERROR: Unknown holding time in RAT:_ATCStatus().")
+      BASE:E(RAT.id.."ERROR: Unknown holding time in RAT:_ATCStatus().")
     end
   end
   
@@ -5504,12 +5620,12 @@ function RAT:_ATCCheck()
         
         -- Debug message.
         local text=string.format("ATC %s: Flight %s runway is busy. You are #%d of %d in landing queue. Your holding time is %i:%02d.", name, flight,qID, nqueue, RAT.ATC.flight[flight].holding/60, RAT.ATC.flight[flight].holding%60)
-        self:T(RAT.id..text)
+        BASE:T(RAT.id..text)
         
       else
       
         local text=string.format("ATC %s: Flight %s was cleared for landing. Your holding time was %i:%02d.", name, flight, RAT.ATC.flight[flight].holding/60, RAT.ATC.flight[flight].holding%60)
-        self:T(RAT.id..text)
+        BASE:T(RAT.id..text)
       
         -- Clear flight for landing.
         RAT:_ATCClearForLanding(name, flight)
@@ -5637,12 +5753,7 @@ function RAT:_ATCQueue()
     for k,v in ipairs(_queue) do
       table.insert(RAT.ATC.airport[airport].queue, v[1])
     end
-    
-    --fvh
-    --for k,v in ipairs(RAT.ATC.airport[airport].queue) do
-      --print(string.format("queue #%02i flight \"%s\" holding %d seconds",k, v, RAT.ATC.flight[v].holding))
-    --end
-    
+
   end
 end
 

Moose Development/Moose/Functional/Scoring.lua

@@ -1,4 +1,25 @@
---- **Functional** -- (R2.0) - Administer the scoring of player achievements, and create a CSV file logging the scoring events for use at team or squadron websites.
+--- **Functional** - Administer the scoring of player achievements, and create a CSV file logging the scoring events for use at team or squadron websites.
+-- 
+-- ===
+-- 
+-- ## Features:
+-- 
+--   * Set the scoring scales based on threat level.
+--   * Positive scores and negative scores.
+--   * A contribution model to score achievements.
+--   * Score goals.
+--   * Score specific achievements.
+--   * Score the hits and destroys of units.
+--   * Score the hits and destroys of statics.
+--   * Score the hits and destroys of scenery.
+--   * Log scores into a CSV file.
+--   * Connect to a remote server using JSON and IP.
+--   
+-- ===
+-- 
+-- ## Missions:
+-- 
+-- [SCO - Scoring](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/SCO%20-%20Scoring)
 -- 
 -- ===
 -- 
@@ -52,9 +73,34 @@
 -- Use the radio menu F10 to consult the scores while running the mission. 
 -- Scores can be reported for your user, or an overall score can be reported of all players currently active in the mission.
 -- 
--- # 1) @{Functional.Scoring#SCORING} class, extends @{Core.Base#BASE}
+-- ===
 -- 
--- ## 1.1) Set the destroy score or penalty scale
+-- ### Authors: **FlightControl**
+-- 
+-- ### Contributions:
+-- 
+--   * **Wingthor (TAW)**: Testing & Advice.
+--   * **Dutch-Baron (TAW)**: Testing & Advice.
+--   * **[Whisper](http://forums.eagle.ru/member.php?u=3829): Testing and Advice.
+-- 
+-- ===       
+-- 
+-- @module Functional.Scoring
+-- @image Scoring.JPG
+
+
+--- @type SCORING
+-- @field Players A collection of the current players that have joined the game.
+-- @extends Core.Base#BASE
+
+--- SCORING class
+-- 
+-- # Constructor:
+-- 
+--      local Scoring = SCORING:New( "Scoring File" )
+--       
+-- 
+-- # Set the destroy score or penalty scale:
 -- 
 -- Score scales can be set for scores granted when enemies or friendlies are destroyed.
 -- Use the method @{#SCORING.SetScaleDestroyScore}() to set the scale of enemy destroys (positive destroys). 
@@ -67,7 +113,7 @@
 -- The above sets the scale for valid scores to 10. So scores will be given in a scale from 0 to 10.
 -- The penalties will be given in a scale from 0 to 40.
 -- 
--- ## 1.2) Define special targets that will give extra scores.
+-- # Define special targets that will give extra scores:
 -- 
 -- Special targets can be set that will give extra scores to the players when these are destroyed.
 -- Use the methods @{#SCORING.AddUnitScore}() and @{#SCORING.RemoveUnitScore}() to specify a special additional score for a specific @{Wrapper.Unit}s.  
@@ -84,7 +130,7 @@
 -- 
 --      Scoring:RemoveUnitScore( UNIT:FindByName( "Unit #001" ) )
 -- 
--- ## 1.3) Define destruction zones that will give extra scores.
+-- # Define destruction zones that will give extra scores:
 -- 
 -- Define zones of destruction. Any object destroyed within the zone of the given category will give extra points.
 -- Use the method @{#SCORING.AddZoneScore}() to add a @{Zone} for additional scoring.  
@@ -94,12 +140,12 @@
 -- The other implementation could be to designate a scenery target (a building) in the mission editor surrounded by a @{Zone}, 
 -- just large enough around that building.
 -- 
--- ## 1.4) Add extra Goal scores upon an event or a condition.
+-- # Add extra Goal scores upon an event or a condition:
 -- 
 -- A mission has goals and achievements. The scoring system provides an API to set additional scores when a goal or achievement event happens.
 -- Use the method @{#SCORING.AddGoalScore}() to add a score for a Player at any time in your mission.
 -- 
--- ## 1.5) (Decommissioned) Configure fratricide level.
+-- # (Decommissioned) Configure fratricide level.
 -- 
 -- **This functionality is decomissioned until the DCS bug concerning Unit:destroy() not being functional in multi player for player units has been fixed by ED**.
 -- 
@@ -107,13 +153,13 @@
 -- Use the method @{#SCORING.SetFratricide}() to define the level when a player gets kicked.  
 -- By default, the fratricide level is the default penalty mutiplier * 2 for the penalty score.
 -- 
--- ## 1.6) Penalty score when a player changes the coalition.
+-- # Penalty score when a player changes the coalition.
 -- 
 -- When a player changes the coalition, he can receive a penalty score.
 -- Use the method @{#SCORING.SetCoalitionChangePenalty}() to define the penalty when a player changes coalition.
 -- By default, the penalty for changing coalition is the default penalty scale.  
 -- 
--- ## 1.8) Define output CSV files.
+-- # Define output CSV files.
 -- 
 -- The CSV file is given the name of the string given in the @{#SCORING.New}{} constructor, followed by the .csv extension.
 -- The file is incrementally saved in the **<User>\\Saved Games\\DCS\\Logs** folder, and has a time stamp indicating each mission run.
@@ -150,7 +196,7 @@
 -- The MOOSE designer cannot take any responsibility of any damage inflicted as a result of the de-sanitization.
 -- That being said, I hope that the SCORING class provides you with a great add-on to score your squad mates achievements.
 -- 
--- ## 1.9) Configure messages.
+-- # Configure messages.
 -- 
 -- When players hit or destroy targets, messages are sent.
 -- Various methods exist to configure:
@@ -158,7 +204,7 @@
 --   * Which messages are sent upon the event.
 --   * Which audience receives the message.
 -- 
--- ### 1.9.1) Configure the messages sent upon the event.
+-- ## Configure the messages sent upon the event.
 -- 
 -- Use the following methods to configure when to send messages. By default, all messages are sent.
 -- 
@@ -167,49 +213,16 @@
 --   * @{#SCORING.SetMessagesAddon}(): Configure to send messages for additional score, after a target has been destroyed.
 --   * @{#SCORING.SetMessagesZone}(): Configure to send messages for additional score, after a target has been destroyed within a given zone.
 --   
--- ### 1.9.2) Configure the audience of the messages.
+-- ## Configure the audience of the messages.
 -- 
 -- Use the following methods to configure the audience of the messages. By default, the messages are sent to all players in the mission.
 -- 
 --   * @{#SCORING.SetMessagesToAll}(): Configure to send messages to all players.
 --   * @{#SCORING.SetMessagesToCoalition}(): Configure to send messages to only those players within the same coalition as the player.
--- 
---   
--- ===
---
--- # **API CHANGE HISTORY**
---
--- The underlying change log documents the API changes. Please read this carefully. The following notation is used:
---
---   * **Added** parts are expressed in bold type face.
---   * _Removed_ parts are expressed in italic type face.
---
--- Hereby the change log:
---
--- 2017-02-26: Initial class and API.
 --
 -- ===
---
--- # **AUTHORS and CONTRIBUTIONS**
---
--- ### Contributions:
---
---   * **Wingthor (TAW)**: Testing & Advice.
---   * **Dutch-Baron (TAW)**: Testing & Advice.
---   * **[Whisper](http://forums.eagle.ru/member.php?u=3829): Testing and Advice.
---        
--- ### Authors:
---
---   * **FlightControl**: Concept, Design & Programming.
 -- 
--- @module Functional.Scoring
--- @image Scoring.JPG
-
-
---- The Scoring class
--- @type SCORING
--- @field Players A collection of the current players that have joined the game.
--- @extends Core.Base#BASE
+-- @field #SCORING
 SCORING = {
   ClassName = "SCORING",
   ClassID = 0,
@@ -236,8 +249,10 @@ local _SCORINGCategory =
 -- @param #string GameName The name of the game. This name is also logged in the CSV score file.
 -- @return #SCORING self
 -- @usage
+-- 
 -- -- Define a new scoring object for the mission Gori Valley.
 -- ScoringObject = SCORING:New( "Gori Valley" )
+-- 
 function SCORING:New( GameName )
 
   -- Inherits from BASE
@@ -1620,7 +1635,7 @@ function SCORING:ReportScoreGroupSummary( PlayerGroup )
       self:F( { ReportMissions, ScoreMissions, PenaltyMissions } )
       
       local PlayerScore = ScoreHits + ScoreDestroys + ScoreCoalitionChanges + ScoreGoals + ScoreMissions
-      local PlayerPenalty = PenaltyHits + PenaltyDestroys + PenaltyCoalitionChanges + ScoreGoals + PenaltyMissions
+      local PlayerPenalty = PenaltyHits + PenaltyDestroys + PenaltyCoalitionChanges + PenaltyGoals + PenaltyMissions
   
       PlayerMessage = 
         string.format( "Player '%s' Score = %d ( %d Score, -%d Penalties )", 

Moose Development/Moose/Functional/Sead.lua

@@ -1,13 +1,41 @@
---- **Functional** -- Provides defensive behaviour to a set of SAM sites within a running Mission.
+--- **Functional** -- Make SAM sites execute evasive and defensive behaviour when being fired upon.
+-- 
+-- ===
+-- 
+-- ## Features:
+-- 
+--   * When SAM sites are being fired upon, the SAMs will take evasive action will reposition themselves when possible.
+--   * When SAM sites are being fired upon, the SAMs will take defensive action by shutting down their radars.
+-- 
+-- ===
+-- 
+-- ## Missions:
+-- 
+-- [SEV - SEAD Evasion](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/SEV%20-%20SEAD%20Evasion)
+-- 
+-- ===
+-- 
+-- ### Authors: **FlightControl**
 -- 
 -- ===
 -- 
 -- @module Functional.Sead
 -- @image SEAD.JPG
 
---- The SEAD class
--- @type SEAD
+--- @type SEAD
 -- @extends Core.Base#BASE
+
+--- Make SAM sites execute evasive and defensive behaviour when being fired upon.
+-- 
+-- This class is very easy to use. Just setup a SEAD object by using @{#SEAD.New}() and SAMs will evade and take defensive action when being fired upon.
+-- 
+-- # Constructor:
+-- 
+-- Use the @{#SEAD.New}() constructor to create a new SEAD object.
+-- 
+--       SEAD_RU_SAM_Defenses = SEAD:New( { 'RU SA-6 Kub', 'RU SA-6 Defenses', 'RU MI-26 Troops', 'RU Attack Gori' } )
+-- 
+-- @field #SEAD
 SEAD = {
 	ClassName = "SEAD", 
 	TargetSkill = {
@@ -29,8 +57,10 @@ SEAD = {
 -- -- Defends the Russian SA installations from SEAD attacks.
 -- SEAD_RU_SAM_Defenses = SEAD:New( { 'RU SA-6 Kub', 'RU SA-6 Defenses', 'RU MI-26 Troops', 'RU Attack Gori' } )
 function SEAD:New( SEADGroupPrefixes )
+
 	local self = BASE:Inherit( self, BASE:New() )
-	self:F( SEADGroupPrefixes )	
+	self:F( SEADGroupPrefixes )
+	
 	if type( SEADGroupPrefixes ) == 'table' then
 		for SEADGroupPrefixID, SEADGroupPrefix in pairs( SEADGroupPrefixes ) do
 			self.SEADGroupPrefixes[SEADGroupPrefix] = SEADGroupPrefix
@@ -57,7 +87,29 @@ function SEAD:OnEventShot( EventData )
 	local SEADWeaponName = EventData.WeaponName	-- return weapon type
 	-- Start of the 2nd loop
 	self:T( "Missile Launched = " .. SEADWeaponName )
-	if SEADWeaponName == "KH-58" or SEADWeaponName == "KH-25MPU" or SEADWeaponName == "AGM-88" or SEADWeaponName == "KH-31A" or SEADWeaponName == "KH-31P" then -- Check if the missile is a SEAD
+	
+	--if SEADWeaponName == "KH-58" or SEADWeaponName == "KH-25MPU" or SEADWeaponName == "AGM-88" or SEADWeaponName == "KH-31A" or SEADWeaponName == "KH-31P" then -- Check if the missile is a SEAD
+  if SEADWeaponName == "weapons.missiles.X_58" --Kh-58U anti-radiation missiles fired
+    or 
+    SEADWeaponName == "weapons.missiles.Kh25MP_PRGS1VP" --Kh-25MP anti-radiation missiles fired
+    or
+    SEADWeaponName == "weapons.missiles.X_25MP" --Kh-25MPU anti-radiation missiles fired
+    or
+    SEADWeaponName == "weapons.missiles.X_28" --Kh-28 anti-radiation missiles fired
+    or
+    SEADWeaponName == "weapons.missiles.X_31P" --Kh-31P anti-radiation missiles fired
+    or
+    SEADWeaponName == "weapons.missiles.AGM_45A" --AGM-45A anti-radiation missiles fired
+    or
+    SEADWeaponName == "weapons.missiles.AGM_45" --AGM-45B anti-radiation missiles fired
+    or
+    SEADWeaponName == "weapons.missiles.AGM_88" --AGM-88C anti-radiation missiles fired
+    or
+    SEADWeaponName == "weapons.missiles.AGM_122" --AGM-122 Sidearm anti-radiation missiles fired
+    or
+    SEADWeaponName == "weapons.missiles.ALARM" --ALARM anti-radiation missiles fired
+    then
+	
 		local _evade = math.random (1,100) -- random number for chance of evading action
 		local _targetMim = EventData.Weapon:getTarget() -- Identify target
 		local _targetMimname = Unit.getName(_targetMim)
@@ -83,47 +135,62 @@ function SEAD:OnEventShot( EventData )
 			self:T( _targetskill )
 			if self.TargetSkill[_targetskill] then
 				if (_evade > self.TargetSkill[_targetskill].Evade) then
+				
 					self:T( string.format("Evading, target skill  " ..string.format(_targetskill)) )
+					
 					local _targetMim = Weapon.getTarget(SEADWeapon)
 					local _targetMimname = Unit.getName(_targetMim)
 					local _targetMimgroup = Unit.getGroup(Weapon.getTarget(SEADWeapon))
 					local _targetMimcont= _targetMimgroup:getController()
+					
 					routines.groupRandomDistSelf(_targetMimgroup,300,'Diamond',250,20) -- move randomly
+					
 					local SuppressedGroups1 = {} -- unit suppressed radar off for a random time
+					
 					local function SuppressionEnd1(id)
 						id.ctrl:setOption(AI.Option.Ground.id.ALARM_STATE,AI.Option.Ground.val.ALARM_STATE.GREEN)
 						SuppressedGroups1[id.groupName] = nil
 					end
+					
 					local id = {
 					groupName = _targetMimgroup,
 					ctrl = _targetMimcont
 					}
+					
 					local delay1 = math.random(self.TargetSkill[_targetskill].DelayOff[1], self.TargetSkill[_targetskill].DelayOff[2])
+					
 					if SuppressedGroups1[id.groupName] == nil then
+					
 						SuppressedGroups1[id.groupName] = {
 							SuppressionEndTime1 = timer.getTime() + delay1,
 							SuppressionEndN1 = SuppressionEndCounter1	--Store instance of SuppressionEnd() scheduled function
-						}	
+						}
+							
 						Controller.setOption(_targetMimcont, AI.Option.Ground.id.ALARM_STATE,AI.Option.Ground.val.ALARM_STATE.GREEN)
 						timer.scheduleFunction(SuppressionEnd1, id, SuppressedGroups1[id.groupName].SuppressionEndTime1)	--Schedule the SuppressionEnd() function
 						--trigger.action.outText( string.format("Radar Off " ..string.format(delay1)), 20)
 					end
 					
 					local SuppressedGroups = {}
+					
 					local function SuppressionEnd(id)
 						id.ctrl:setOption(AI.Option.Ground.id.ALARM_STATE,AI.Option.Ground.val.ALARM_STATE.RED)
 						SuppressedGroups[id.groupName] = nil
 					end
+					
 					local id = {
 						groupName = _targetMimgroup,
 						ctrl = _targetMimcont
 					}
+					
 					local delay = math.random(self.TargetSkill[_targetskill].DelayOn[1], self.TargetSkill[_targetskill].DelayOn[2])
+					
 					if SuppressedGroups[id.groupName] == nil then
 						SuppressedGroups[id.groupName] = {
 							SuppressionEndTime = timer.getTime() + delay,
 							SuppressionEndN = SuppressionEndCounter	--Store instance of SuppressionEnd() scheduled function
 						}
+						
 						timer.scheduleFunction(SuppressionEnd, id, SuppressedGroups[id.groupName].SuppressionEndTime)	--Schedule the SuppressionEnd() function
 						--trigger.action.outText( string.format("Radar On " ..string.format(delay)), 20)
 					end

Moose Development/Moose/Functional/Suppression.lua

@@ -1,7 +1,18 @@
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
---- **Functional** - (R2.4) Suppress fire of ground units when they get hit.
+--- **Functional** - Suppress fire of ground units when they get hit.
 -- 
--- ====
+-- ===
+-- 
+-- ## Features:
+-- 
+--   * Hold fire of attacked units when being fired upon.
+--
+-- ===
+-- 
+-- ## Missions:
+--
+-- ## [MOOSE - ALL Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS)
+-- 
+-- === 
 -- 
 -- When ground units get hit by (suppressive) enemy fire, they will not be able to shoot back for a certain amount of time.
 -- 
@@ -12,12 +23,6 @@
 -- 
 -- ====
 -- 
--- # Demo Missions
---
--- ### [MOOSE - ALL Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS)
--- 
--- ====
--- 
 -- # YouTube Channel
 -- 
 -- ### [MOOSE YouTube Channel](https://www.youtube.com/channel/UCjrA9j5LQoWsG4SpS8i79Qg)
@@ -28,7 +33,8 @@
 -- 
 -- ### Contributions: [FlightControl](https://forums.eagle.ru/member.php?u=89536)
 -- 
--- ====
+-- ===
+-- 
 -- @module Functional.Suppression
 -- @image Suppression.JPG
 

Moose Development/Moose/Functional/ZoneCaptureCoalition.lua

@@ -1,14 +1,40 @@
---- **Functional** -- (R2.3) Models the process to zone guarding and capturing.
+--- **Functional** -- Models the process to zone guarding and capturing.
 --
 -- ===
 -- 
--- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/CAZ - Capture Zones)
+-- ## Features:
 -- 
---   - CAZ-000 - Capture Zone: Demonstrates the basic concept of capturing a zone.
+--   * Models the possible state transitions between the Guarded, Attacked, Empty and Captured states.
+--   * A zone has an owning coalition, that means that at a specific point in time, a zone can be owned by the red or blue coalition.
+--   * Provide event handlers to tailor the actions when a zone changes coalition or state.
 -- 
 -- ===
 -- 
--- ### [YouTube Playlist](https://www.youtube.com/watch?v=0m6K6Yxa-os&list=PL7ZUrU4zZUl0qqJsfa8DPvZWDY-OyDumE)
+-- ## Missions:
+-- 
+-- [CAZ - Capture Zones](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/CAZ%20-%20Capture%20Zones)
+-- 
+-- ===
+-- 
+-- # Player Experience
+-- 
+-- ![States](..\Presentations\ZONE_CAPTURE_COALITION\Dia3.JPG)
+--  
+-- The above models the possible state transitions between the **Guarded**, **Attacked**, **Empty** and **Captured** states.  
+-- A zone has an __owning coalition__, that means that at a specific point in time, a zone can be owned by the red or blue coalition.
+--
+-- The Zone can be in the state **Guarded** by the __owning coalition__, 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 **Attacked**. 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 **Empty**, 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 **Captured**.  
+-- 
+-- The zone needs to be monitored regularly for the presence of units to interprete the correct state transition required.  
+-- This monitoring process MUST be started using the @{#ZONE_CAPTURE_COALITION.Start}() method.  
+-- Otherwise no monitoring will be active and the zone will stay in the current state forever.  
+-- 
+-- ===
+-- 
+-- ## [YouTube Playlist](https://www.youtube.com/watch?v=0m6K6Yxa-os&list=PL7ZUrU4zZUl0qqJsfa8DPvZWDY-OyDumE)
 -- 
 -- ===
 -- 
@@ -29,65 +55,76 @@ do -- ZONE_CAPTURE_COALITION
   --- Models the process to capture a Zone for a Coalition, which is guarded by another Coalition.
   -- This is a powerful concept that allows to create very dynamic missions based on the different state transitions of various zones.
   -- 
-  -- ---
-  --
-  -- ![Banner Image](..\Presentations\ZONE_CAPTURE_COALITION\Dia1.JPG)
-  --
-  -- ---
+  -- ===
   -- 
-  -- # 0. Player Experience
+  -- In order to use ZONE_CAPTURE_COALITION, you need to:
   -- 
-  -- ![States](..\Presentations\ZONE_CAPTURE_COALITION\Dia3.JPG)
-  --  
-  -- The above models the possible state transitions between the **Guarded**, **Attacked**, **Empty** and **Captured** states.
-  -- A zone has an __owning coalition__, that means that at a specific point in time, a zone can be owned by the red or blue coalition.
-  --
-  -- The Zone can be in the state **Guarded** by the __owning coalition__, 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 **Attacked**. 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 **Empty**, 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 **Captured**.
-  -- 
-  -- The zone needs to be monitored regularly for the presence of units to interprete the correct state transition required.
-  -- This monitoring process MUST be started using the @{#ZONE_CAPTURE_COALITION.Start}() method.
-  -- Otherwise no monitoring will be active and the zone will stay in the current state forever.
-  -- See further in chapter 3.3 for more information about this.
-  -- 
-  -- ## 1. ZONE\_CAPTURE\_COALITION constructor
-  --   
-  --   * @{#ZONE_CAPTURE_COALITION.New}(): Creates a new ZONE\_CAPTURE\_COALITION object.
-  --   
-  -- In order to use ZONE\_CAPTURE\_COALITION, you need to:
-  -- 
-  --   - Create a @{Zone} object from one of the ZONE\_ classes. Note that ZONE\_POLYGON\_ classes are not yet functional. The only functional ZONE\_ classses are those derived from a ZONE\_RADIUS.
+  --   * Create a @{Zone} object from one of the ZONE_ classes.  
+  --     Note that ZONE_POLYGON_ classes are not yet functional.  
+  --     The only functional ZONE_ classses are those derived from a ZONE_RADIUS.
+  --   * Set the state of the zone. Most of the time, Guarded would be the initial state.
+  --   * Start the zone capturing **monitoring process**.  
+  --     This will check the presence of friendly and/or enemy units within the zone and will transition the state of the zone when the tactical situation changed.
+  --     The frequency of the monitoring must not be real-time, a 30 second interval to execute the checks is sufficient. 
   -- 
   -- ![New](..\Presentations\ZONE_CAPTURE_COALITION\Dia5.JPG)
   -- 
-  -- Ensure that during the life cycle of the ZONE\_CAPTURE\_COALITION object, the object keeps alive.
-  -- It is best to declare the object globally within your script.
+  -- ### Important:
   -- 
-  -- ## 2. ZONE\_CAPTURE\_COALITION is a finite state machine (FSM).
+  -- You must start the monitoring process within your code, or there won't be any state transition checks executed.  
+  -- See further the start/stop monitoring process.
+  -- 
+  -- ### Important:
+  -- 
+  -- Ensure that the object containing the ZONE_CAPTURE_COALITION object is persistent.
+  -- Otherwise the garbage collector of lua will remove the object and the monitoring process will stop.
+  -- This will result in your object to be destroyed (removed) from internal memory and there won't be any zone state transitions anymore detected!
+  -- So use the `local` keyword in lua with thought! Most of the time, you can declare your object gobally.
+  -- 
+  -- 
+  -- 
+  -- # Example:
+  -- 
+  --       -- Define a new ZONE object, which is based on the trigger zone `CaptureZone`, which is defined within the mission editor.
+  --       CaptureZone = ZONE:New( "CaptureZone" )
+  --       
+  --       -- Here we create a new ZONE_CAPTURE_COALITION object, using the :New constructor.
+  --       ZoneCaptureCoalition = ZONE_CAPTURE_COALITION:New( CaptureZone, coalition.side.RED )
+  --       
+  --       -- Set the zone to Guarding state.
+  --       ZoneCaptureCoalition:__Guard( 1 )
+  --       
+  --       -- Start the zone monitoring process in 30 seconds and check every 30 seconds.
+  --       ZoneCaptureCoalition:Start( 30, 30 ) 
+  --   
+  -- 
+  -- # Constructor:
+  --   
+  -- Use the @{#ZONE_CAPTURE_COALITION.New}() constructor to create a new ZONE_CAPTURE_COALITION object.
+  -- 
+  -- # ZONE_CAPTURE_COALITION is a finite state machine (FSM).
   -- 
   -- ![States](..\Presentations\ZONE_CAPTURE_COALITION\Dia4.JPG)
   -- 
-  -- ### 2.1 ZONE\_CAPTURE\_COALITION States
+  -- ## ZONE_CAPTURE_COALITION States
   -- 
   --   * **Captured**: The Zone has been captured by an other coalition.
   --   * **Attacked**: The Zone is currently intruded by an other coalition. There are units of the owning coalition and an other coalition in the Zone.
   --   * **Guarded**: The Zone is guarded by the owning coalition. There is no other unit of an other coalition in the Zone.
   --   * **Empty**: The Zone is empty. There is not valid unit in the Zone.
   --   
-  -- ### 2.2 ZONE\_CAPTURE\_COALITION Events
+  -- ## 2.2 ZONE_CAPTURE_COALITION Events
   -- 
   --   * **Capture**: The Zone has been captured by an other coalition.
   --   * **Attack**: The Zone is currently intruded by an other coalition. There are units of the owning coalition and an other coalition in the Zone.
   --   * **Guard**: The Zone is guarded by the owning coalition. There is no other unit of an other coalition in the Zone.
   --   * **Empty**: The Zone is empty. There is not valid unit in the Zone.
   -- 
-  -- ## 3. "Script It"
+  -- # "Script It"
   -- 
-  -- ZONE\_CAPTURE\_COALITION allows to take action on the various state transitions and add your custom code and logic.
+  -- ZONE_CAPTURE_COALITION allows to take action on the various state transitions and add your custom code and logic.
   -- 
-  -- ### 3.1. Take action using state- and event handlers.
+  -- ## Take action using state- and event handlers.
   -- 
   -- ![States](..\Presentations\ZONE_CAPTURE_COALITION\Dia6.JPG)
   -- 
@@ -104,8 +141,6 @@ do -- ZONE_CAPTURE_COALITION
   --   - On Before the event is triggered. Return false to cancel the transition.
   --   - On After the event is triggered.
   -- 
-  -- 
-  -- 
   -- ![States](..\Presentations\ZONE_CAPTURE_COALITION\Dia7.JPG)
   -- 
   -- Each handler can receive optionally 3 parameters:
@@ -126,7 +161,7 @@ do -- ZONE_CAPTURE_COALITION
   -- 
   -- This code checks that when the __Guarded__ state has been reached, that if the **From** state was __Empty__, then display a message.
   -- 
-  -- ### 3.2. Example Event Handler.
+  -- ## Example Event Handler.
   -- 
   --     --- @param Functional.ZoneCaptureCoalition#ZONE_CAPTURE_COALITION self
   --     function ZoneCaptureCoalition:OnEnterGuarded( From, Event, To )
@@ -145,7 +180,7 @@ do -- ZONE_CAPTURE_COALITION
   --       end
   --     end
   --     
-  -- ### 3.3. Stop and Start the zone monitoring process.
+  -- ## Stop and Start the zone monitoring process.
   -- 
   -- At regular intervals, the state of the zone needs to be monitored.
   -- The zone needs to be scanned for the presence of units within the zone boundaries.
@@ -157,8 +192,8 @@ do -- ZONE_CAPTURE_COALITION
   -- 
   -- Therefore, the mission designer is given 2 methods that allow to take control of the CPU utilization efficiency:
   -- 
-  --   - @{#ZONE_CAPTURE_COALITION.Start()}(): This starts the monitoring process.
-  --   - @{#ZONE_CAPTURE_COALITION.Stop()}(): This stops the monitoring process.
+  --   * @{#ZONE_CAPTURE_COALITION.Start}(): This starts the monitoring process.
+  --   * @{#ZONE_CAPTURE_COALITION.Stop}(): This stops the monitoring process.
   --   
   -- ### IMPORTANT
   -- 
@@ -166,9 +201,9 @@ do -- ZONE_CAPTURE_COALITION
   -- The monitoring process is NOT started by default!!!**
   --   
   -- 
-  -- ## 4. Full Example
+  -- # Full Example
   -- 
-  -- The following annotated code shows a real example of how ZONE\_CAPTURE\_COALITION can be applied.
+  -- The following annotated code shows a real example of how ZONE_CAPTURE_COALITION can be applied.
   -- 
   -- The concept is simple.
   -- 
@@ -321,15 +356,15 @@ do -- ZONE_CAPTURE_COALITION
   --  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 )
+  function ZONE_CAPTURE_COALITION:New( Zone, Coalition, UnitCategories )
   
-    local self = BASE:Inherit( self, ZONE_GOAL_COALITION:New( Zone, Coalition ) ) -- #ZONE_CAPTURE_COALITION
+    local self = BASE:Inherit( self, ZONE_GOAL_COALITION:New( Zone, Coalition, UnitCategories ) ) -- #ZONE_CAPTURE_COALITION
 
-    self:F( { Zone = Zone, Coalition  = Coalition } )
+    self:F( { Zone = Zone, Coalition  = Coalition, UnitCategories = UnitCategories } )
 
     do 
     
-      --- Captured State Handler OnLeave for ZONE\_CAPTURE\_COALITION
+      --- Captured State Handler OnLeave for ZONE_CAPTURE_COALITION
       -- @function [parent=#ZONE_CAPTURE_COALITION] OnLeaveCaptured
       -- @param #ZONE_CAPTURE_COALITION self
       -- @param #string From
@@ -337,7 +372,7 @@ do -- ZONE_CAPTURE_COALITION
       -- @param #string To
       -- @return #boolean
   
-      --- Captured State Handler OnEnter for ZONE\_CAPTURE\_COALITION
+      --- Captured State Handler OnEnter for ZONE_CAPTURE_COALITION
       -- @function [parent=#ZONE_CAPTURE_COALITION] OnEnterCaptured
       -- @param #ZONE_CAPTURE_COALITION self
       -- @param #string From
@@ -349,7 +384,7 @@ do -- ZONE_CAPTURE_COALITION
   
     do 
     
-      --- Attacked State Handler OnLeave for ZONE\_CAPTURE\_COALITION
+      --- Attacked State Handler OnLeave for ZONE_CAPTURE_COALITION
       -- @function [parent=#ZONE_CAPTURE_COALITION] OnLeaveAttacked
       -- @param #ZONE_CAPTURE_COALITION self
       -- @param #string From
@@ -357,7 +392,7 @@ do -- ZONE_CAPTURE_COALITION
       -- @param #string To
       -- @return #boolean
   
-      --- Attacked State Handler OnEnter for ZONE\_CAPTURE\_COALITION
+      --- Attacked State Handler OnEnter for ZONE_CAPTURE_COALITION
       -- @function [parent=#ZONE_CAPTURE_COALITION] OnEnterAttacked
       -- @param #ZONE_CAPTURE_COALITION self
       -- @param #string From
@@ -368,7 +403,7 @@ do -- ZONE_CAPTURE_COALITION
 
     do 
     
-      --- Guarded State Handler OnLeave for ZONE\_CAPTURE\_COALITION
+      --- Guarded State Handler OnLeave for ZONE_CAPTURE_COALITION
       -- @function [parent=#ZONE_CAPTURE_COALITION] OnLeaveGuarded
       -- @param #ZONE_CAPTURE_COALITION self
       -- @param #string From
@@ -376,7 +411,7 @@ do -- ZONE_CAPTURE_COALITION
       -- @param #string To
       -- @return #boolean
   
-      --- Guarded State Handler OnEnter for ZONE\_CAPTURE\_COALITION
+      --- Guarded State Handler OnEnter for ZONE_CAPTURE_COALITION
       -- @function [parent=#ZONE_CAPTURE_COALITION] OnEnterGuarded
       -- @param #ZONE_CAPTURE_COALITION self
       -- @param #string From
@@ -388,7 +423,7 @@ do -- ZONE_CAPTURE_COALITION
 
     do 
     
-      --- Empty State Handler OnLeave for ZONE\_CAPTURE\_COALITION
+      --- Empty State Handler OnLeave for ZONE_CAPTURE_COALITION
       -- @function [parent=#ZONE_CAPTURE_COALITION] OnLeaveEmpty
       -- @param #ZONE_CAPTURE_COALITION self
       -- @param #string From
@@ -396,7 +431,7 @@ do -- ZONE_CAPTURE_COALITION
       -- @param #string To
       -- @return #boolean
   
-      --- Empty State Handler OnEnter for ZONE\_CAPTURE\_COALITION
+      --- Empty State Handler OnEnter for ZONE_CAPTURE_COALITION
       -- @function [parent=#ZONE_CAPTURE_COALITION] OnEnterEmpty
       -- @param #ZONE_CAPTURE_COALITION self
       -- @param #string From
@@ -407,7 +442,7 @@ do -- ZONE_CAPTURE_COALITION
   
     self:AddTransition( "*", "Guard", "Guarded" )
     
-    --- Guard Handler OnBefore for ZONE\_CAPTURE\_COALITION
+    --- Guard Handler OnBefore for ZONE_CAPTURE_COALITION
     -- @function [parent=#ZONE_CAPTURE_COALITION] OnBeforeGuard
     -- @param #ZONE_CAPTURE_COALITION self
     -- @param #string From
@@ -415,25 +450,25 @@ do -- ZONE_CAPTURE_COALITION
     -- @param #string To
     -- @return #boolean
     
-    --- Guard Handler OnAfter for ZONE\_CAPTURE\_COALITION
+    --- Guard Handler OnAfter for ZONE_CAPTURE_COALITION
     -- @function [parent=#ZONE_CAPTURE_COALITION] OnAfterGuard
     -- @param #ZONE_CAPTURE_COALITION self
     -- @param #string From
     -- @param #string Event
     -- @param #string To
     
-    --- Guard Trigger for ZONE\_CAPTURE\_COALITION
+    --- Guard Trigger for ZONE_CAPTURE_COALITION
     -- @function [parent=#ZONE_CAPTURE_COALITION] Guard
     -- @param #ZONE_CAPTURE_COALITION self
     
-    --- Guard Asynchronous Trigger for ZONE\_CAPTURE\_COALITION
+    --- Guard Asynchronous Trigger for ZONE_CAPTURE_COALITION
     -- @function [parent=#ZONE_CAPTURE_COALITION] __Guard
     -- @param #ZONE_CAPTURE_COALITION self
     -- @param #number Delay
     
     self:AddTransition( "*", "Empty", "Empty" )
     
-    --- Empty Handler OnBefore for ZONE\_CAPTURE\_COALITION
+    --- Empty Handler OnBefore for ZONE_CAPTURE_COALITION
     -- @function [parent=#ZONE_CAPTURE_COALITION] OnBeforeEmpty
     -- @param #ZONE_CAPTURE_COALITION self
     -- @param #string From
@@ -441,18 +476,18 @@ do -- ZONE_CAPTURE_COALITION
     -- @param #string To
     -- @return #boolean
     
-    --- Empty Handler OnAfter for ZONE\_CAPTURE\_COALITION
+    --- Empty Handler OnAfter for ZONE_CAPTURE_COALITION
     -- @function [parent=#ZONE_CAPTURE_COALITION] OnAfterEmpty
     -- @param #ZONE_CAPTURE_COALITION self
     -- @param #string From
     -- @param #string Event
     -- @param #string To
     
-    --- Empty Trigger for ZONE\_CAPTURE\_COALITION
+    --- Empty Trigger for ZONE_CAPTURE_COALITION
     -- @function [parent=#ZONE_CAPTURE_COALITION] Empty
     -- @param #ZONE_CAPTURE_COALITION self
     
-    --- Empty Asynchronous Trigger for ZONE\_CAPTURE\_COALITION
+    --- Empty Asynchronous Trigger for ZONE_CAPTURE_COALITION
     -- @function [parent=#ZONE_CAPTURE_COALITION] __Empty
     -- @param #ZONE_CAPTURE_COALITION self
     -- @param #number Delay
@@ -460,7 +495,7 @@ do -- ZONE_CAPTURE_COALITION
     
     self:AddTransition( {  "Guarded", "Empty" }, "Attack", "Attacked" )
   
-    --- Attack Handler OnBefore for ZONE\_CAPTURE\_COALITION
+    --- Attack Handler OnBefore for ZONE_CAPTURE_COALITION
     -- @function [parent=#ZONE_CAPTURE_COALITION] OnBeforeAttack
     -- @param #ZONE_CAPTURE_COALITION self
     -- @param #string From
@@ -468,25 +503,25 @@ do -- ZONE_CAPTURE_COALITION
     -- @param #string To
     -- @return #boolean
     
-    --- Attack Handler OnAfter for ZONE\_CAPTURE\_COALITION
+    --- Attack Handler OnAfter for ZONE_CAPTURE_COALITION
     -- @function [parent=#ZONE_CAPTURE_COALITION] OnAfterAttack
     -- @param #ZONE_CAPTURE_COALITION self
     -- @param #string From
     -- @param #string Event
     -- @param #string To
     
-    --- Attack Trigger for ZONE\_CAPTURE\_COALITION
+    --- Attack Trigger for ZONE_CAPTURE_COALITION
     -- @function [parent=#ZONE_CAPTURE_COALITION] Attack
     -- @param #ZONE_CAPTURE_COALITION self
     
-    --- Attack Asynchronous Trigger for ZONE\_CAPTURE\_COALITION
+    --- Attack Asynchronous Trigger for ZONE_CAPTURE_COALITION
     -- @function [parent=#ZONE_CAPTURE_COALITION] __Attack
     -- @param #ZONE_CAPTURE_COALITION self
     -- @param #number Delay
     
     self:AddTransition( { "Guarded", "Attacked", "Empty" }, "Capture", "Captured" )
    
-    --- Capture Handler OnBefore for ZONE\_CAPTURE\_COALITION
+    --- Capture Handler OnBefore for ZONE_CAPTURE_COALITION
     -- @function [parent=#ZONE_CAPTURE_COALITION] OnBeforeCapture
     -- @param #ZONE_CAPTURE_COALITION self
     -- @param #string From
@@ -494,22 +529,29 @@ do -- ZONE_CAPTURE_COALITION
     -- @param #string To
     -- @return #boolean
     
-    --- Capture Handler OnAfter for ZONE\_CAPTURE\_COALITION
+    --- Capture Handler OnAfter for ZONE_CAPTURE_COALITION
     -- @function [parent=#ZONE_CAPTURE_COALITION] OnAfterCapture
     -- @param #ZONE_CAPTURE_COALITION self
     -- @param #string From
     -- @param #string Event
     -- @param #string To
     
-    --- Capture Trigger for ZONE\_CAPTURE\_COALITION
+    --- Capture Trigger for ZONE_CAPTURE_COALITION
     -- @function [parent=#ZONE_CAPTURE_COALITION] Capture
     -- @param #ZONE_CAPTURE_COALITION self
     
-    --- Capture Asynchronous Trigger for ZONE\_CAPTURE\_COALITION
+    --- Capture Asynchronous Trigger for ZONE_CAPTURE_COALITION
     -- @function [parent=#ZONE_CAPTURE_COALITION] __Capture
     -- @param #ZONE_CAPTURE_COALITION self
     -- @param #number Delay
 
+    -- We check if a unit within the zone is hit.
+    -- If it is, then we must move the zone to attack state.
+    self:HandleEvent( EVENTS.Hit, self.OnEventHit )
+
+    -- ZoneGoal objects are added to the _DATABASE.ZONES_GOAL and SET_ZONE_GOAL sets.
+    _EVENTDISPATCHER:CreateEventNewZoneGoal( self )
+
     return self
   end
   
@@ -517,6 +559,8 @@ do -- ZONE_CAPTURE_COALITION
   --- @param #ZONE_CAPTURE_COALITION self
   function ZONE_CAPTURE_COALITION:onenterCaptured()
   
+    self:F({"hello"})
+  
     self:GetParent( self, ZONE_CAPTURE_COALITION ).onenterCaptured( self )
     
     self.Goal:Achieved()
@@ -525,7 +569,7 @@ do -- ZONE_CAPTURE_COALITION
 
   function ZONE_CAPTURE_COALITION:IsGuarded()
   
-    local IsGuarded = self.Zone:IsAllInZoneOfCoalition( self.Coalition )
+    local IsGuarded = self:IsAllInZoneOfCoalition( self.Coalition )
     self:F( { IsGuarded = IsGuarded } )
     return IsGuarded
   end
@@ -533,7 +577,7 @@ do -- ZONE_CAPTURE_COALITION
 
   function ZONE_CAPTURE_COALITION:IsEmpty()
   
-    local IsEmpty = self.Zone:IsNoneInZone()
+    local IsEmpty = self:IsNoneInZone()
     self:F( { IsEmpty = IsEmpty } )
     return IsEmpty
   end
@@ -541,7 +585,7 @@ do -- ZONE_CAPTURE_COALITION
 
   function ZONE_CAPTURE_COALITION:IsCaptured()
   
-    local IsCaptured = self.Zone:IsAllInZoneOfOtherCoalition( self.Coalition )
+    local IsCaptured = self:IsAllInZoneOfOtherCoalition( self.Coalition )
     self:F( { IsCaptured = IsCaptured } )
     return IsCaptured
   end
@@ -549,7 +593,7 @@ do -- ZONE_CAPTURE_COALITION
   
   function ZONE_CAPTURE_COALITION:IsAttacked()
   
-    local IsAttacked = self.Zone:IsSomeInZoneOfCoalition( self.Coalition )
+    local IsAttacked = self:IsSomeInZoneOfCoalition( self.Coalition )
     self:F( { IsAttacked = IsAttacked } )
     return IsAttacked
   end
@@ -560,7 +604,7 @@ do -- ZONE_CAPTURE_COALITION
   -- @param #ZONE_CAPTURE_COALITION self
   function ZONE_CAPTURE_COALITION:Mark()
   
-    local Coord = self.Zone:GetCoordinate()
+    local Coord = self:GetCoordinate()
     local ZoneName = self:GetZoneName()
     local State = self:GetState()
     
@@ -599,11 +643,12 @@ do -- ZONE_CAPTURE_COALITION
   
     --self:GetParent( self ):onenterCaptured()
 
-    local NewCoalition = self.Zone:GetScannedCoalition()
+    local NewCoalition = self:GetScannedCoalition()
     self:F( { NewCoalition = NewCoalition } )
     self:SetCoalition( NewCoalition )
   
     self:Mark()
+    self.Goal:Achieved()
   end
   
   
@@ -631,14 +676,14 @@ do -- ZONE_CAPTURE_COALITION
     --BASE:GetParent( self ).onafterGuard( self )
   
     if not self.SmokeScheduler then
-      self.SmokeScheduler = self:ScheduleRepeat( 1, 1, 0.1, nil, self.StatusSmoke, self )
+      self.SmokeScheduler = self:ScheduleRepeat( self.StartInterval, self.RepeatInterval, 0.1, nil, self.StatusSmoke, self )
     end
   end
 
 
   function ZONE_CAPTURE_COALITION:IsCaptured()
   
-    local IsCaptured = self.Zone:IsAllInZoneOfOtherCoalition( self.Coalition )
+    local IsCaptured = self:IsAllInZoneOfOtherCoalition( self.Coalition )
     self:F( { IsCaptured = IsCaptured } )
     return IsCaptured
   end
@@ -646,7 +691,7 @@ do -- ZONE_CAPTURE_COALITION
   
   function ZONE_CAPTURE_COALITION:IsAttacked()
   
-    local IsAttacked = self.Zone:IsSomeInZoneOfCoalition( self.Coalition )
+    local IsAttacked = self:IsSomeInZoneOfCoalition( self.Coalition )
     self:F( { IsAttacked = IsAttacked } )
     return IsAttacked
   end
@@ -702,13 +747,13 @@ do -- ZONE_CAPTURE_COALITION
   -- 
   function ZONE_CAPTURE_COALITION:Start( StartInterval, RepeatInterval )
   
-    StartInterval = StartInterval or 15
-    RepeatInterval = RepeatInterval or 15
+    self.StartInterval = StartInterval or 15
+    self.RepeatInterval = RepeatInterval or 15
   
     if self.ScheduleStatusZone then
       self:ScheduleStop( self.ScheduleStatusZone )
     end
-    self.ScheduleStatusZone = self:ScheduleRepeat( StartInterval, RepeatInterval, 0.1, nil, self.StatusZone, self )
+    self.ScheduleStatusZone = self:ScheduleRepeat( self.StartInterval, self.RepeatInterval, 1.5, nil, self.StatusZone, self )
   end
   
 
@@ -754,5 +799,20 @@ do -- ZONE_CAPTURE_COALITION
     end
   end
   
+  --- @param #ZONE_CAPTURE_COALITION self
+  -- @param Core.Event#EVENTDATA EventData The event data.
+  function ZONE_CAPTURE_COALITION:OnEventHit( EventData )
+  
+    local UnitHit = EventData.TgtUnit
+    
+    if UnitHit then
+      if UnitHit:IsInZone( self ) then
+        self:Attack()
+      end
+    end
+  
+  end
+  
+  
 end
 

Moose Development/Moose/Functional/ZoneGoal.lua

@@ -44,14 +44,13 @@ do -- Zone
   
   --- ZONE_GOAL Constructor.
   -- @param #ZONE_GOAL self
-  -- @param Core.Zone#ZONE_BASE Zone A @{Zone} object with the goal to be achieved.
+  -- @param Core.Zone#ZONE_RADIUS Zone A @{Zone} object with the goal to be achieved.
   -- @return #ZONE_GOAL
   function ZONE_GOAL:New( Zone )
   
-    local self = BASE:Inherit( self, FSM:New() ) -- #ZONE_GOAL
+    local self = BASE:Inherit( self, ZONE_RADIUS:New( Zone:GetName(), Zone:GetVec2(), Zone:GetRadius() ) ) -- #ZONE_GOAL
     self:F( { Zone = Zone } )
 
-    self.Zone = Zone -- Core.Zone#ZONE_BASE
     self.Goal = GOAL:New()
 
     self.SmokeTime = nil
@@ -67,6 +66,7 @@ do -- Zone
     -- @param Wrapper.Unit#UNIT DestroyedUnit The destroyed unit.
     -- @param #string PlayerName The name of the player.
 
+
     return self
   end
   
@@ -74,7 +74,7 @@ do -- Zone
   -- @param #ZONE_GOAL self
   -- @return Core.Zone#ZONE_BASE
   function ZONE_GOAL:GetZone()
-    return self.Zone
+    return self
   end
   
   
@@ -82,7 +82,7 @@ do -- Zone
   -- @param #ZONE_GOAL self
   -- @return #string
   function ZONE_GOAL:GetZoneName()
-    return self.Zone:GetName()
+    return self:GetName()
   end
 
 
@@ -101,7 +101,7 @@ do -- Zone
   -- @param #ZONE_GOAL self
   -- @param #SMOKECOLOR.Color FlareColor
   function ZONE_GOAL:Flare( FlareColor )
-    self.Zone:FlareZone( FlareColor, math.random( 1, 360 ) )
+    self:FlareZone( FlareColor, math.random( 1, 360 ) )
   end
 
 
@@ -130,7 +130,7 @@ do -- Zone
   
     if self.SmokeTime == nil or self.SmokeTime + 300 <= CurrentTime then
       if self.SmokeColor then
-        self.Zone:GetCoordinate():Smoke( self.SmokeColor )
+        self:GetCoordinate():Smoke( self.SmokeColor )
         --self.SmokeColor = nil
         self.SmokeTime = CurrentTime
       end
@@ -147,11 +147,9 @@ do -- Zone
     
     local Vec3 = EventData.IniDCSUnit:getPosition().p
     self:F( { Vec3 = Vec3 } )
-    local ZoneGoal = self:GetZone()
-    self:F({ZoneGoal})
 
     if EventData.IniDCSUnit then
-      if ZoneGoal:IsVec3InZone(Vec3)  then
+      if self:IsVec3InZone(Vec3)  then
         local PlayerHits = _DATABASE.HITS[EventData.IniUnitName]
         if PlayerHits then
           for PlayerName, PlayerHit in pairs( PlayerHits.Players or {} ) do

Moose Development/Moose/Functional/ZoneGoalCoalition.lua

@@ -104,7 +104,7 @@ do -- ZoneGoal
     local State = self:GetState()
     self:F( { State = self:GetState() } )
   
-    self.Zone:Scan( { Object.Category.UNIT, Object.Category.STATIC } )
+    self:Scan( { Object.Category.UNIT, Object.Category.STATIC } )
   
   end
   

Moose Development/Moose/Modules.lua

@@ -0,0 +1,125 @@
+__Moose.Include( 'Scripts/Moose/Utilities/Enums.lua' )
+__Moose.Include( 'Scripts/Moose/Utilities/Routines.lua' )
+__Moose.Include( 'Scripts/Moose/Utilities/Utils.lua' )
+
+__Moose.Include( 'Scripts/Moose/Core/Base.lua' )
+__Moose.Include( 'Scripts/Moose/Core/UserFlag.lua' )
+__Moose.Include( 'Scripts/Moose/Core/UserSound.lua' )
+__Moose.Include( 'Scripts/Moose/Core/Report.lua' )
+__Moose.Include( 'Scripts/Moose/Core/Scheduler.lua' )
+__Moose.Include( 'Scripts/Moose/Core/ScheduleDispatcher.lua' )
+__Moose.Include( 'Scripts/Moose/Core/Event.lua' )
+__Moose.Include( 'Scripts/Moose/Core/Settings.lua' )
+__Moose.Include( 'Scripts/Moose/Core/Menu.lua' )
+__Moose.Include( 'Scripts/Moose/Core/Zone.lua' )
+__Moose.Include( 'Scripts/Moose/Core/Zone_Detection.lua' )
+__Moose.Include( 'Scripts/Moose/Core/Database.lua' )
+__Moose.Include( 'Scripts/Moose/Core/Set.lua' )
+__Moose.Include( 'Scripts/Moose/Core/Point.lua' )
+__Moose.Include( 'Scripts/Moose/Core/Velocity.lua' )
+__Moose.Include( 'Scripts/Moose/Core/Message.lua' )
+__Moose.Include( 'Scripts/Moose/Core/Fsm.lua' )
+__Moose.Include( 'Scripts/Moose/Core/Radio.lua' )
+__Moose.Include( 'Scripts/Moose/Core/RadioQueue.lua' )
+__Moose.Include( 'Scripts/Moose/Core/RadioSpeech.lua' )
+__Moose.Include( 'Scripts/Moose/Core/Spawn.lua' )
+__Moose.Include( 'Scripts/Moose/Core/SpawnStatic.lua' )
+__Moose.Include( 'Scripts/Moose/Core/Goal.lua' )
+__Moose.Include( 'Scripts/Moose/Core/Spot.lua' )
+
+__Moose.Include( 'Scripts/Moose/Wrapper/Object.lua' )
+__Moose.Include( 'Scripts/Moose/Wrapper/Identifiable.lua' )
+__Moose.Include( 'Scripts/Moose/Wrapper/Positionable.lua' )
+__Moose.Include( 'Scripts/Moose/Wrapper/Controllable.lua' )
+__Moose.Include( 'Scripts/Moose/Wrapper/Group.lua' )
+__Moose.Include( 'Scripts/Moose/Wrapper/Unit.lua' )
+__Moose.Include( 'Scripts/Moose/Wrapper/Client.lua' )
+__Moose.Include( 'Scripts/Moose/Wrapper/Static.lua' )
+__Moose.Include( 'Scripts/Moose/Wrapper/Airbase.lua' )
+__Moose.Include( 'Scripts/Moose/Wrapper/Scenery.lua' )
+
+__Moose.Include( 'Scripts/Moose/Cargo/Cargo.lua' )
+__Moose.Include( 'Scripts/Moose/Cargo/CargoUnit.lua' )
+__Moose.Include( 'Scripts/Moose/Cargo/CargoSlingload.lua' )
+__Moose.Include( 'Scripts/Moose/Cargo/CargoCrate.lua' )
+__Moose.Include( 'Scripts/Moose/Cargo/CargoGroup.lua' )
+
+__Moose.Include( 'Scripts/Moose/Functional/Scoring.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/CleanUp.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/Movement.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/Sead.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/Escort.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/MissileTrainer.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/ATC_Ground.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/Detection.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/DetectionZones.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/Designate.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/RAT.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/Range.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/ZoneGoal.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/ZoneGoalCoalition.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/ZoneCaptureCoalition.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/Artillery.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/Suppression.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/PseudoATC.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/Warehouse.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/Fox.lua' )
+
+__Moose.Include( 'Scripts/Moose/Ops/Airboss.lua' )
+__Moose.Include( 'Scripts/Moose/Ops/RecoveryTanker.lua' )
+__Moose.Include( 'Scripts/Moose/Ops/RescueHelo.lua' )
+__Moose.Include( 'Scripts/Moose/Ops/ATIS.lua' )
+
+__Moose.Include( 'Scripts/Moose/AI/AI_Balancer.lua' )
+__Moose.Include( 'Scripts/Moose/AI/AI_Air.lua' )
+__Moose.Include( 'Scripts/Moose/AI/AI_Air_Patrol.lua' )
+__Moose.Include( 'Scripts/Moose/AI/AI_Air_Engage.lua' )
+__Moose.Include( 'Scripts/Moose/AI/AI_A2A_Patrol.lua' )
+__Moose.Include( 'Scripts/Moose/AI/AI_A2A_Cap.lua' )
+__Moose.Include( 'Scripts/Moose/AI/AI_A2A_Gci.lua' )
+__Moose.Include( 'Scripts/Moose/AI/AI_A2A_Dispatcher.lua' )
+__Moose.Include( 'Scripts/Moose/AI/AI_A2G_BAI.lua' )
+__Moose.Include( 'Scripts/Moose/AI/AI_A2G_CAS.lua' )
+__Moose.Include( 'Scripts/Moose/AI/AI_A2G_SEAD.lua' )
+__Moose.Include( 'Scripts/Moose/AI/AI_A2G_Dispatcher.lua' )
+__Moose.Include( 'Scripts/Moose/AI/AI_Patrol.lua' )
+__Moose.Include( 'Scripts/Moose/AI/AI_Cap.lua' )
+__Moose.Include( 'Scripts/Moose/AI/AI_Cas.lua' )
+__Moose.Include( 'Scripts/Moose/AI/AI_Bai.lua' )
+__Moose.Include( 'Scripts/Moose/AI/AI_Formation.lua' )
+__Moose.Include( 'Scripts/Moose/AI/AI_Escort.lua' )
+__Moose.Include( 'Scripts/Moose/AI/AI_Escort_Request.lua' )
+__Moose.Include( 'Scripts/Moose/AI/AI_Escort_Dispatcher.lua' )
+__Moose.Include( 'Scripts/Moose/AI/AI_Escort_Dispatcher_Request.lua' )
+__Moose.Include( 'Scripts/Moose/AI/AI_Cargo.lua' )
+__Moose.Include( 'Scripts/Moose/AI/AI_Cargo_APC.lua' )
+__Moose.Include( 'Scripts/Moose/AI/AI_Cargo_Helicopter.lua' )
+__Moose.Include( 'Scripts/Moose/AI/AI_Cargo_Airplane.lua' )
+__Moose.Include( 'Scripts/Moose/AI/AI_Cargo_Dispatcher.lua' )
+__Moose.Include( 'Scripts/Moose/AI/AI_Cargo_Dispatcher_APC.lua' )
+__Moose.Include( 'Scripts/Moose/AI/AI_Cargo_Dispatcher_Helicopter.lua' )
+__Moose.Include( 'Scripts/Moose/AI/AI_Cargo_Dispatcher_Airplane.lua' )
+
+__Moose.Include( 'Scripts/Moose/Actions/Act_Assign.lua' )
+__Moose.Include( 'Scripts/Moose/Actions/Act_Route.lua' )
+__Moose.Include( 'Scripts/Moose/Actions/Act_Account.lua' )
+__Moose.Include( 'Scripts/Moose/Actions/Act_Assist.lua' )
+
+__Moose.Include( 'Scripts/Moose/Tasking/CommandCenter.lua' )
+__Moose.Include( 'Scripts/Moose/Tasking/Mission.lua' )
+__Moose.Include( 'Scripts/Moose/Tasking/Task.lua' )
+__Moose.Include( 'Scripts/Moose/Tasking/TaskInfo.lua' )
+__Moose.Include( 'Scripts/Moose/Tasking/Task_Manager.lua' )
+__Moose.Include( 'Scripts/Moose/Tasking/DetectionManager.lua' )
+__Moose.Include( 'Scripts/Moose/Tasking/Task_A2G_Dispatcher.lua' )
+__Moose.Include( 'Scripts/Moose/Tasking/Task_A2G.lua' )
+__Moose.Include( 'Scripts/Moose/Tasking/Task_A2A_Dispatcher.lua' )
+__Moose.Include( 'Scripts/Moose/Tasking/Task_A2A.lua' )
+__Moose.Include( 'Scripts/Moose/Tasking/Task_Cargo.lua' )
+__Moose.Include( 'Scripts/Moose/Tasking/Task_Cargo_Transport.lua' )
+__Moose.Include( 'Scripts/Moose/Tasking/Task_Cargo_CSAR.lua' )
+__Moose.Include( 'Scripts/Moose/Tasking/Task_Cargo_Dispatcher.lua' )
+__Moose.Include( 'Scripts/Moose/Tasking/Task_Capture_Zone.lua' )
+__Moose.Include( 'Scripts/Moose/Tasking/Task_Capture_Dispatcher.lua' )
+
+__Moose.Include( 'Scripts/Moose/Globals.lua' )

Moose Development/Moose/Tasking/CommandCenter.lua

@@ -144,6 +144,25 @@
 -- This is done by using the method @{#COMMANDCENTER.SetReferenceZones}().
 -- For the moment, only one Reference Zone class can be specified, but in the future, more classes will become possible.
 -- 
+-- ## 7. Tasks.
+-- 
+-- ### 7.1. Automatically assign tasks.
+-- 
+-- One of the most important roles of the command center is the management of tasks.
+-- The command center can assign automatically tasks to the players using the @{Tasking.CommandCenter#COMMANDCENTER.SetAutoAssignTasks}() method.
+-- When this method is used with a parameter true; the command center will scan at regular intervals which players in a slot are not having a task assigned.
+-- For those players; the tasking is enabled to assign automatically a task.
+-- An Assign Menu will be accessible for the player under the command center menu, to configure the automatic tasking to switched on or off.
+-- 
+-- ### 7.2. Automatically accept assigned tasks.
+-- 
+-- When a task is assigned; the mission designer can decide if players are immediately assigned to the task; or they can accept/reject the assigned task.
+-- Use the method @{Tasking.CommandCenter#COMMANDCENTER.SetAutoAcceptTasks}() to configure this behaviour.
+-- If the tasks are not automatically accepted; the player will receive a message that he needs to access the command center menu and
+-- choose from 2 added menu options either to accept or reject the assigned task within 30 seconds.
+-- If the task is not accepted within 30 seconds; the task will be cancelled and a new task will be assigned.
+-- 
+-- 
 -- @field #COMMANDCENTER
 COMMANDCENTER = {
   ClassName = "COMMANDCENTER",
@@ -156,6 +175,14 @@ COMMANDCENTER = {
   CommunicationMode = "80",
 }
 
+
+--- @type COMMANDCENTER.AutoAssignMethods
+COMMANDCENTER.AutoAssignMethods = {
+  ["Random"] = 1,
+  ["Distance"] = 2,
+  ["Priority"] = 3,
+  }
+
 --- The constructor takes an IDENTIFIABLE as the HQ command center.
 -- @param #COMMANDCENTER self
 -- @param Wrapper.Positionable#POSITIONABLE CommandCenterPositionable
@@ -169,21 +196,24 @@ function COMMANDCENTER:New( CommandCenterPositionable, CommandCenterName )
   self.CommandCenterName = CommandCenterName or CommandCenterPositionable:GetName()
   self.CommandCenterCoalition = CommandCenterPositionable:GetCoalition()
   
-  self.AutoAssignTasks = false
-	
 	self.Missions = {}
 
+  self:SetAutoAssignTasks( false )
+  self:SetAutoAcceptTasks( true )
+  self:SetAutoAssignMethod( COMMANDCENTER.AutoAssignMethods.Distance )
+  self:SetFlashStatus( false )
+  
   self:HandleEvent( EVENTS.Birth,
     --- @param #COMMANDCENTER self
     -- @param Core.Event#EVENTDATA EventData
     function( self, EventData )
       if EventData.IniObjectCategory == 1 then
         local EventGroup = GROUP:Find( EventData.IniDCSGroup )
-        self:E( { CommandCenter = self:GetName(), EventGroup = EventGroup:GetName(), HasGroup = self:HasGroup( EventGroup ), EventData = EventData } )
-        if EventGroup and self:HasGroup( EventGroup ) then
+        --self:E( { CommandCenter = self:GetName(), EventGroup = EventGroup:GetName(), HasGroup = self:HasGroup( EventGroup ), EventData = EventData } )
+        if EventGroup and EventGroup:IsAlive() and self:HasGroup( EventGroup ) then
           local CommandCenterMenu = MENU_GROUP:New( EventGroup, self:GetText() )
           local MenuReporting = MENU_GROUP:New( EventGroup, "Missions Reports", CommandCenterMenu )
-          local MenuMissionsSummary = MENU_GROUP_COMMAND:New( EventGroup, "Missions Status Report", MenuReporting, self.ReportMissionsStatus, self, EventGroup )
+          local MenuMissionsSummary = MENU_GROUP_COMMAND:New( EventGroup, "Missions Status Report", MenuReporting, self.ReportSummary, self, EventGroup )
           local MenuMissionsDetails = MENU_GROUP_COMMAND:New( EventGroup, "Missions Players Report", MenuReporting, self.ReportMissionsPlayers, self, EventGroup )
           self:ReportSummary( EventGroup )
           local PlayerUnit = EventData.IniUnit
@@ -270,6 +300,8 @@ function COMMANDCENTER:New( CommandCenterPositionable, CommandCenterName )
   self:SetMenu()
   
   _SETTINGS:SetSystemMenu( CommandCenterPositionable )
+  
+  self:SetCommandMenu()
 	
 	return self
 end
@@ -426,6 +458,7 @@ end
 
 --- Gets the commandcenter menu structure governed by the HQ command center.
 -- @param #COMMANDCENTER self
+-- @param Wrapper.Group#Group TaskGroup Task Group.
 -- @return Core.Menu#MENU_COALITION
 function COMMANDCENTER:GetMenu( TaskGroup )
 
@@ -439,10 +472,7 @@ function COMMANDCENTER:GetMenu( TaskGroup )
   self.CommandCenterMenus[TaskGroup] = CommandCenterMenu
 
   if self.AutoAssignTasks == false then
-    local AutoAssignTaskMenu = MENU_GROUP_COMMAND:New( TaskGroup, "Assign Task On", CommandCenterMenu, self.SetAutoAssignTasks, self, true ):SetTime(MenuTime):SetTag("AutoTask")
-    local AssignTaskMenu = MENU_GROUP_COMMAND:New( TaskGroup, "Assign Task", CommandCenterMenu, self.AssignRandomTask, self, TaskGroup ):SetTime(MenuTime):SetTag("AutoTask")
-  else
-    local AutoAssignTaskMenu = MENU_GROUP_COMMAND:New( TaskGroup, "Assign Task Off", CommandCenterMenu, self.SetAutoAssignTasks, self, false ):SetTime(MenuTime):SetTag("AutoTask")
+    local AssignTaskMenu = MENU_GROUP_COMMAND:New( TaskGroup, "Assign Task", CommandCenterMenu, self.AssignTask, self, TaskGroup ):SetTime(MenuTime):SetTag("AutoTask")
   end
   CommandCenterMenu:Remove( MenuTime, "AutoTask" )
     
@@ -453,50 +483,119 @@ end
 --- Assigns a random task to a TaskGroup.
 -- @param #COMMANDCENTER self
 -- @return #COMMANDCENTER
-function COMMANDCENTER:AssignRandomTask( TaskGroup )
+function COMMANDCENTER:AssignTask( TaskGroup )
 
   local Tasks = {}
+  local AssignPriority = 99999999
+  local AutoAssignMethod = self.AutoAssignMethod
 
   for MissionID, Mission in pairs( self:GetMissions() ) do
     local Mission = Mission -- Tasking.Mission#MISSION
     local MissionTasks = Mission:GetGroupTasks( TaskGroup )
     for MissionTaskName, MissionTask in pairs( MissionTasks or {} ) do
-      Tasks[#Tasks+1] = MissionTask
+      local MissionTask = MissionTask -- Tasking.Task#TASK
+      if MissionTask:IsStatePlanned() or MissionTask:IsStateReplanned() or MissionTask:IsStateAssigned() then
+        local TaskPriority = MissionTask:GetAutoAssignPriority( self.AutoAssignMethod, self, TaskGroup )
+        if TaskPriority < AssignPriority then
+          AssignPriority = TaskPriority
+          Tasks = {}
+        end
+        if TaskPriority == AssignPriority then
+          Tasks[#Tasks+1] = MissionTask
+        end
+      end
     end
   end
   
   local Task = Tasks[ math.random( 1, #Tasks ) ] -- Tasking.Task#TASK
   
-  Task:SetAssignMethod( ACT_ASSIGN_MENU_ACCEPT:New( Task.TaskBriefing ) )
-  
-  Task:AssignToGroup( TaskGroup )
+  if Task then
+
+    self:I( "Assigning task " .. Task:GetName() .. " using auto assign method " .. self.AutoAssignMethod .. " to " .. TaskGroup:GetName() .. " with task priority " .. AssignPriority )
+    
+    if not self.AutoAcceptTasks == true then
+      Task:SetAutoAssignMethod( ACT_ASSIGN_MENU_ACCEPT:New( Task.TaskBriefing ) )
+    end
+    
+    Task:AssignToGroup( TaskGroup )
+    
+  end
 
 end
 
 
+--- Sets the menu of the command center.
+-- This command is called within the :New() method.
+-- @param #COMMANDCENTER self
+function COMMANDCENTER:SetCommandMenu()
+
+  local MenuTime = timer.getTime()
+  
+  if self.CommandCenterPositionable and self.CommandCenterPositionable:IsInstanceOf(GROUP) then
+    local CommandCenterText = self:GetText()
+    local CommandCenterMenu = MENU_GROUP:New( self.CommandCenterPositionable, CommandCenterText ):SetTime(MenuTime)
+  
+    if self.AutoAssignTasks == false then
+      local AutoAssignTaskMenu = MENU_GROUP_COMMAND:New( self.CommandCenterPositionable, "Assign Task On", CommandCenterMenu, self.SetAutoAssignTasks, self, true ):SetTime(MenuTime):SetTag("AutoTask")
+    else
+      local AutoAssignTaskMenu = MENU_GROUP_COMMAND:New( self.CommandCenterPositionable, "Assign Task Off", CommandCenterMenu, self.SetAutoAssignTasks, self, false ):SetTime(MenuTime):SetTag("AutoTask")
+    end
+    CommandCenterMenu:Remove( MenuTime, "AutoTask" )
+  end
+
+end
+
+
+
 --- Automatically assigns tasks to all TaskGroups.
+-- One of the most important roles of the command center is the management of tasks.
+-- When this method is used with a parameter true; the command center will scan at regular intervals which players in a slot are not having a task assigned.
+-- For those players; the tasking is enabled to assign automatically a task.
+-- An Assign Menu will be accessible for the player under the command center menu, to configure the automatic tasking to switched on or off.
 -- @param #COMMANDCENTER self
 -- @param #boolean AutoAssign true for ON and false or nil for OFF.
--- @return #COMMANDCENTER
 function COMMANDCENTER:SetAutoAssignTasks( AutoAssign )
 
   self.AutoAssignTasks = AutoAssign or false
   
-  local GroupSet = self:AddGroups()
-
-  for GroupID, TaskGroup in pairs( GroupSet:GetSet() ) do
-    local TaskGroup = TaskGroup -- Wrapper.Group#GROUP
-    self:GetMenu( TaskGroup )
-  end
-
   if self.AutoAssignTasks == true then
     self:ScheduleRepeat( 10, 30, 0, nil, self.AssignTasks, self )
   else
     self:ScheduleStop( self.AssignTasks )
   end
-
+  
 end
 
+--- Automatically accept tasks for all TaskGroups.
+-- When a task is assigned; the mission designer can decide if players are immediately assigned to the task; or they can accept/reject the assigned task.
+-- If the tasks are not automatically accepted; the player will receive a message that he needs to access the command center menu and
+-- choose from 2 added menu options either to accept or reject the assigned task within 30 seconds.
+-- If the task is not accepted within 30 seconds; the task will be cancelled and a new task will be assigned.
+-- @param #COMMANDCENTER self
+-- @param #boolean AutoAccept true for ON and false or nil for OFF.
+function COMMANDCENTER:SetAutoAcceptTasks( AutoAccept )
+
+  self.AutoAcceptTasks = AutoAccept or false
+  
+end
+
+
+--- Define the method to be used to assign automatically a task from the available tasks in the mission.
+-- There are 3 types of methods that can be applied for the moment:
+-- 
+--   1. Random - assigns a random task in the mission to the player.
+--   2. Distance - assigns a task based on a distance evaluation from the player. The closest are to be assigned first.
+--   3. Priority - assigns a task based on the priority as defined by the mission designer, using the SetTaskPriority parameter.
+--   
+-- The different task classes implement the logic to determine the priority of automatic task assignment to a player, depending on one of the above methods.
+-- The method @{Tasking.Task#TASK.GetAutoAssignPriority} calculate the priority of the tasks to be assigned. 
+-- @param #COMMANDCENTER self
+-- @param #COMMANDCENTER.AutoAssignMethods AutoAssignMethod A selection of an assign method from the COMMANDCENTER.AutoAssignMethods enumeration.
+function COMMANDCENTER:SetAutoAssignMethod( AutoAssignMethod )
+
+  self.AutoAssignMethod = AutoAssignMethod or COMMANDCENTER.AutoAssignMethods.Random
+  
+end
 
 --- Automatically assigns tasks to all TaskGroups.
 -- @param #COMMANDCENTER self
@@ -507,21 +606,26 @@ function COMMANDCENTER:AssignTasks()
   for GroupID, TaskGroup in pairs( GroupSet:GetSet() ) do
     local TaskGroup = TaskGroup -- Wrapper.Group#GROUP
     
-    if self:IsGroupAssigned( TaskGroup ) then
-    else
-      -- Only groups with planes or helicopters will receive automatic tasks.
-      -- TODO Workaround DCS-BUG-3 - https://github.com/FlightControl-Master/MOOSE/issues/696
-      if TaskGroup:IsAir() then
-        self:AssignRandomTask( TaskGroup )
+    if TaskGroup:IsAlive() then
+      self:GetMenu( TaskGroup )
+      
+      if self:IsGroupAssigned( TaskGroup ) then
+      else
+        -- Only groups with planes or helicopters will receive automatic tasks.
+        -- TODO Workaround DCS-BUG-3 - https://github.com/FlightControl-Master/MOOSE/issues/696
+        if TaskGroup:IsAir() then
+          self:AssignTask( TaskGroup )
+        end
       end
     end
   end
+
 end
 
 
 --- Get all the Groups active within the command center.
 -- @param #COMMANDCENTER self
--- @return Core.Set#SET_GROUP
+-- @return Core.Set#SET_GROUP The set of groups active within the command center.
 function COMMANDCENTER:AddGroups()
 
   local GroupSet = SET_GROUP:New()
@@ -537,7 +641,7 @@ end
 
 --- Checks of the TaskGroup has a Task.
 -- @param #COMMANDCENTER self
--- @return #boolean
+-- @return #boolean When true, the TaskGroup has a Task, otherwise the returned value will be false.
 function COMMANDCENTER:IsGroupAssigned( TaskGroup )
 
   local Assigned = false
@@ -554,9 +658,9 @@ function COMMANDCENTER:IsGroupAssigned( TaskGroup )
 end
 
 
---- Checks of the COMMANDCENTER has a GROUP.
+--- Checks of the command center has the given MissionGroup.
 -- @param #COMMANDCENTER self
--- @param Wrapper.Group#GROUP
+-- @param Wrapper.Group#GROUP MissionGroup The group active within one of the missions governed by the command center.
 -- @return #boolean
 function COMMANDCENTER:HasGroup( MissionGroup )
 
@@ -573,37 +677,39 @@ function COMMANDCENTER:HasGroup( MissionGroup )
   return Has
 end
 
---- Send a CC message to the coalition of the CC.
+--- Let the command center send a Message to all players.
 -- @param #COMMANDCENTER self
+-- @param #string Message The message text.
 function COMMANDCENTER:MessageToAll( Message )
 
     self:GetPositionable():MessageToAll( Message, 20, self:GetName() )
 
 end
 
---- Send a CC message to a GROUP.
+--- Let the command center send a message to the MessageGroup.
 -- @param #COMMANDCENTER self
--- @param #string Message
--- @param Wrapper.Group#GROUP TaskGroup
-function COMMANDCENTER:MessageToGroup( Message, TaskGroup )
+-- @param #string Message The message text.
+-- @param Wrapper.Group#GROUP MessageGroup The group to receive the message.
+function COMMANDCENTER:MessageToGroup( Message, MessageGroup )
 
-  self:GetPositionable():MessageToGroup( Message, 15, TaskGroup, self:GetShortText() )
+  self:GetPositionable():MessageToGroup( Message, 15, MessageGroup, self:GetShortText() )
 
 end
 
---- Send a CC message of a specified type to a GROUP.
+--- Let the command center send a message to the MessageGroup.
 -- @param #COMMANDCENTER self
--- @param #string Message
--- @param Wrapper.Group#GROUP TaskGroup
+-- @param #string Message The message text.
+-- @param Wrapper.Group#GROUP MessageGroup The group to receive the message.
 -- @param Core.Message#MESSAGE.MessageType MessageType The type of the message, resulting in automatic time duration and prefix of the message.
-function COMMANDCENTER:MessageTypeToGroup( Message, TaskGroup, MessageType )
+function COMMANDCENTER:MessageTypeToGroup( Message, MessageGroup, MessageType )
 
-  self:GetPositionable():MessageTypeToGroup( Message, MessageType, TaskGroup, self:GetShortText() )
+  self:GetPositionable():MessageTypeToGroup( Message, MessageType, MessageGroup, self:GetShortText() )
 
 end
 
---- Send a CC message to the coalition of the CC.
+--- Let the command center send a message to the coalition of the command center.
 -- @param #COMMANDCENTER self
+-- @param #string Message The message text.
 function COMMANDCENTER:MessageToCoalition( Message )
 
   local CCCoalition = self:GetPositionable():GetCoalition()
@@ -614,9 +720,9 @@ function COMMANDCENTER:MessageToCoalition( Message )
 end
 
 
---- Send a CC message of a specified type to the coalition of the CC.
+--- Let the command center send a message of a specified type to the coalition of the command center.
 -- @param #COMMANDCENTER self
--- @param #string Message The message.
+-- @param #string Message The message text.
 -- @param Core.Message#MESSAGE.MessageType MessageType The type of the message, resulting in automatic time duration and prefix of the message.
 function COMMANDCENTER:MessageTypeToCoalition( Message, MessageType )
 
@@ -628,9 +734,10 @@ function COMMANDCENTER:MessageTypeToCoalition( Message, MessageType )
 end
 
 
---- Report the status of all MISSIONs to a GROUP.
+--- Let the command center send a report of the status of all missions to a group.
 -- Each Mission is listed, with an indication how many Tasks are still to be completed.
 -- @param #COMMANDCENTER self
+-- @param Wrapper.Group#GROUP ReportGroup The group to receive the report.
 function COMMANDCENTER:ReportSummary( ReportGroup )
   self:F( ReportGroup )
 
@@ -642,15 +749,16 @@ function COMMANDCENTER:ReportSummary( ReportGroup )
   
   for MissionID, Mission in pairs( self.Missions ) do
     local Mission = Mission -- Tasking.Mission#MISSION
-    Report:Add( " - " .. Mission:ReportSummary() )
+    Report:Add( " - " .. Mission:ReportSummary( ReportGroup ) )
   end
   
   self:MessageToGroup( Report:Text(), ReportGroup )
 end
 
---- Report the players of all MISSIONs to a GROUP.
+--- Let the command center send a report of the players of all missions to a group.
 -- Each Mission is listed, with an indication how many Tasks are still to be completed.
 -- @param #COMMANDCENTER self
+-- @param Wrapper.Group#GROUP ReportGroup The group to receive the report.
 function COMMANDCENTER:ReportMissionsPlayers( ReportGroup )
   self:F( ReportGroup )
 
@@ -658,17 +766,19 @@ function COMMANDCENTER:ReportMissionsPlayers( ReportGroup )
   
   Report:Add( "Players active in all missions." )
 
-  for MissionID, Mission in pairs( self.Missions ) do
-    local Mission = Mission -- Tasking.Mission#MISSION
-    Report:Add( " - " .. Mission:ReportPlayers() )
+  for MissionID, MissionData in pairs( self.Missions ) do
+    local Mission = MissionData -- Tasking.Mission#MISSION
+    Report:Add( " - " .. Mission:ReportPlayersPerTask(ReportGroup) )
   end
   
   self:MessageToGroup( Report:Text(), ReportGroup )
 end
 
---- Report the status of a Task to a Group.
+--- Let the command center send a report of the status of a task to a group.
 -- Report the details of a Mission, listing the Mission, and all the Task details.
 -- @param #COMMANDCENTER self
+-- @param Wrapper.Group#GROUP ReportGroup The group to receive the report.
+-- @param Tasking.Task#TASK Task The task to be reported.
 function COMMANDCENTER:ReportDetails( ReportGroup, Task )
   self:F( ReportGroup )
 
@@ -682,3 +792,12 @@ function COMMANDCENTER:ReportDetails( ReportGroup, Task )
   self:MessageToGroup( Report:Text(), ReportGroup )
 end
 
+
+--- Let the command center flash a report of the status of the subscribed task to a group.
+-- @param #COMMANDCENTER self
+function COMMANDCENTER:SetFlashStatus( Flash )
+  self:F()
+
+  self.FlashStatus = Flash or true
+
+end

Moose Development/Moose/Tasking/DetectionManager.lua

@@ -43,17 +43,23 @@
 
 do -- DETECTION MANAGER
   
-  --- DETECTION_MANAGER class.
-  -- @type DETECTION_MANAGER
+  --- @type DETECTION_MANAGER
   -- @field Core.Set#SET_GROUP SetGroup The groups to which the FAC will report to.
   -- @field Functional.Detection#DETECTION_BASE Detection The DETECTION_BASE object that is used to report the detected objects.
+  -- @field Tasking.CommandCenter#COMMANDCENTER CC The command center that is used to communicate with the players.
   -- @extends Core.Fsm#FSM
+
+  --- DETECTION_MANAGER class.
+  -- @field #DETECTION_MANAGER
   DETECTION_MANAGER = {
     ClassName = "DETECTION_MANAGER",
     SetGroup = nil,
     Detection = nil,
   }
   
+  --- @field Tasking.CommandCenter#COMMANDCENTER
+  DETECTION_MANAGER.CC = nil
+  
   --- FAC constructor.
   -- @param #DETECTION_MANAGER self
   -- @param Core.Set#SET_GROUP SetGroup
@@ -215,13 +221,95 @@ do -- DETECTION MANAGER
   
     return self._ReportDisplayTime
   end
+
+
+  --- Set a command center to communicate actions to the players reporting to the command center.
+  -- @param #DETECTION_MANAGER self
+  -- @return #DETECTION_MANGER self
+  function DETECTION_MANAGER:SetTacticalMenu( DispatcherMainMenuText, DispatcherMenuText )
+
+    local DispatcherMainMenu = MENU_MISSION:New( DispatcherMainMenuText, nil )
+    local DispatcherMenu = MENU_MISSION_COMMAND:New( DispatcherMenuText, DispatcherMainMenu,
+      function()
+        self:ShowTacticalDisplay( self.Detection )
+      end
+      )
+    
+    return self
+  end
+  
+  
+
+  
+  --- Set a command center to communicate actions to the players reporting to the command center.
+  -- @param #DETECTION_MANAGER self
+  -- @param Tasking.CommandCenter#COMMANDCENTER CommandCenter The command center.
+  -- @return #DETECTION_MANGER self
+  function DETECTION_MANAGER:SetCommandCenter( CommandCenter )
+    
+    self.CC = CommandCenter
+    
+    return self
+  end
+  
+  
+  --- Get the command center to communicate actions to the players.
+  -- @param #DETECTION_MANAGER self
+  -- @return Tasking.CommandCenter#COMMANDCENTER The command center.
+  function DETECTION_MANAGER:GetCommandCenter()
+    
+    return self.CC
+  end
+ 
+  
+  --- Send an information message to the players reporting to the command center.
+  -- @param #DETECTION_MANAGER self
+  -- @param #table Squadron The squadron table.
+  -- @param #string Message The message to be sent.
+  -- @param #string SoundFile The name of the sound file .wav or .ogg.
+  -- @param #number SoundDuration The duration of the sound.
+  -- @param #string SoundPath The path pointing to the folder in the mission file.
+  -- @param Wrapper.Group#GROUP DefenderGroup The defender group sending the message.
+  -- @return #DETECTION_MANGER self
+  function DETECTION_MANAGER:MessageToPlayers( Squadron,  Message, DefenderGroup )
+  
+    self:F( { Message = Message } )
+    
+--    if not self.PreviousMessage or self.PreviousMessage ~= Message then
+--      self.PreviousMessage = Message
+--      if self.CC then
+--        self.CC:MessageToCoalition( Message )
+--      end
+--    end
+
+    if self.CC then
+      self.CC:MessageToCoalition( Message )
+    end
+    
+    Message = Message:gsub( "°", " degrees " )
+    Message = Message:gsub( "(%d)%.(%d)", "%1 dot %2" )
+    
+  -- Here we handle the transmission of the voice over.
+  -- If for a certain reason the Defender does not exist, we use the coordinate of the airbase to send the message from.
+    local RadioQueue = Squadron.RadioQueue -- Core.RadioSpeech#RADIOSPEECH
+    if RadioQueue then
+      local DefenderUnit = DefenderGroup:GetUnit(1)
+      if DefenderUnit and DefenderUnit:IsAlive() then
+        RadioQueue:SetSenderUnitName( DefenderUnit:GetName() )
+      end
+      RadioQueue:Speak( Message, Squadron.Language )
+    end
+    
+    return self
+  end
+  
+  
   
   --- Reports the detected items to the @{Core.Set#SET_GROUP}.
   -- @param #DETECTION_MANAGER self
   -- @param Functional.Detection#DETECTION_BASE Detection
   -- @return #DETECTION_MANAGER self
   function DETECTION_MANAGER:ProcessDetected( Detection )
-  	self:E()
   
   end
 

Moose Development/Moose/Tasking/Mission.lua

@@ -129,10 +129,10 @@ MISSION = {
 --- This is the main MISSION declaration method. Each Mission is like the master or a Mission orchestration between, Clients, Tasks, Stages etc.
 -- @param #MISSION self
 -- @param Tasking.CommandCenter#COMMANDCENTER CommandCenter
--- @param #string MissionName is the name of the mission. This name will be used to reference the status of each mission by the players.
--- @param #string MissionPriority is a string indicating the "priority" of the Mission. f.e. "Primary", "Secondary" or "First", "Second". It is free format and up to the Mission designer to choose. There are no rules behind this field.
--- @param #string MissionBriefing is a string indicating the mission briefing to be shown when a player joins a @{CLIENT}.
--- @param #string MissionCoalition is a string indicating the coalition or party to which this mission belongs to. It is free format and can be chosen freely by the mission designer. Note that this field is not to be confused with the coalition concept of the ME. Examples of a Mission Coalition could be "NATO", "CCCP", "Intruders", "Terrorists"...
+-- @param #string MissionName Name of the mission. This name will be used to reference the status of each mission by the players.
+-- @param #string MissionPriority String indicating the "priority" of the Mission. e.g. "Primary", "Secondary". It is free format and up to the Mission designer to choose. There are no rules behind this field.
+-- @param #string MissionBriefing String indicating the mission briefing to be shown when a player joins a @{CLIENT}.
+-- @param DCS#coaliton.side MissionCoalition Side of the coalition, i.e. and enumerator @{#DCS.coalition.side} corresponding to RED, BLUE or NEUTRAL.
 -- @return #MISSION self
 function MISSION:New( CommandCenter, MissionName, MissionPriority, MissionBriefing, MissionCoalition )
 
@@ -611,13 +611,14 @@ function MISSION:RemoveTaskMenu( Task )
 end
 
 
---- Gets the root mission menu for the TaskGroup.
+--- Gets the root mission menu for the TaskGroup. Obsolete?! Originally no reference to TaskGroup parameter!
 -- @param #MISSION self
+-- @param Wrapper.Group#GROUP TaskGroup Task group.
 -- @return Core.Menu#MENU_COALITION self
 function MISSION:GetRootMenu( TaskGroup ) -- R2.2
 
   local CommandCenter = self:GetCommandCenter()
-  local CommandCenterMenu = CommandCenter:GetMenu()
+  local CommandCenterMenu = CommandCenter:GetMenu( TaskGroup )
 
   local MissionName = self:GetText()
   --local MissionMenu = CommandCenterMenu:GetMenu( MissionName )
@@ -629,6 +630,7 @@ end
 
 --- Gets the mission menu for the TaskGroup.
 -- @param #MISSION self
+-- @param Wrapper.Group#GROUP TaskGroup Task group.
 -- @return Core.Menu#MENU_COALITION self
 function MISSION:GetMenu( TaskGroup ) -- R2.1 -- Changed Menu Structure
 
@@ -966,18 +968,19 @@ function MISSION:ReportPlayersProgress( ReportGroup )
   -- Determine how many tasks are remaining.
   for TaskID, Task in pairs( self:GetTasks() ) do
     local Task = Task -- Tasking.Task#TASK
-    local TaskGoalTotal = Task:GetGoalTotal() or 0
     local TaskName = Task:GetName()
+    local Goal = Task:GetGoal()
     PlayerList[TaskName] = PlayerList[TaskName] or {}
-    if TaskGoalTotal ~= 0 then
-      local PlayerNames = self:GetPlayerNames()
-      for PlayerName, PlayerData in pairs( PlayerNames ) do
-        PlayerList[TaskName][PlayerName] = string.format( 'Player (%s): Task "%s": %d%%', PlayerName, TaskName, Task:GetPlayerProgress( PlayerName ) * 100 / TaskGoalTotal )
+    if Goal then
+      local TotalContributions = Goal:GetTotalContributions()
+      local PlayerContributions = Goal:GetPlayerContributions()
+      self:F( { TotalContributions = TotalContributions, PlayerContributions = PlayerContributions } )
+      for PlayerName, PlayerContribution in pairs( PlayerContributions ) do
+         PlayerList[TaskName][PlayerName] = string.format( 'Player (%s): Task "%s": %d%%', PlayerName, TaskName, PlayerContributions[PlayerName] * 100 / TotalContributions )       
       end
     else
       PlayerList[TaskName]["_"] = string.format( 'Player (---): Task "%s": %d%%', TaskName, 0 )
-    end
-    
+    end    
   end
 
   for TaskName, TaskData in pairs( PlayerList ) do

Moose Development/Moose/Tasking/Task.lua

@@ -856,6 +856,8 @@ do -- Group Assignment
 
     CommandCenter:SetMenu()
     
+    self:MenuFlashTaskStatus( TaskGroup, self:GetMission():GetCommandCenter().FlashStatus )
+    
     return self
   end
   
@@ -1111,6 +1113,11 @@ function TASK:SetAssignedMenuForGroup( TaskGroup, MenuTime )
       end
       local MarkMenu = MENU_GROUP_COMMAND:New( TaskGroup, string.format( "Mark Task Location on Map" ), TaskControl, self.MenuMarkToGroup, self, TaskGroup ):SetTime( MenuTime ):SetTag( "Tasking" )
       local TaskTypeMenu = MENU_GROUP_COMMAND:New( TaskGroup, string.format( "Report Task Details" ), TaskControl, self.MenuTaskStatus, self, TaskGroup ):SetTime( MenuTime ):SetTag( "Tasking" )
+      if not self.FlashTaskStatus then
+        local TaskFlashStatusMenu = MENU_GROUP_COMMAND:New( TaskGroup, string.format( "Flash Task Details" ), TaskControl, self.MenuFlashTaskStatus, self, TaskGroup, true ):SetTime( MenuTime ):SetTag( "Tasking" )
+      else
+        local TaskFlashStatusMenu = MENU_GROUP_COMMAND:New( TaskGroup, string.format( "Stop Flash Task Details" ), TaskControl, self.MenuFlashTaskStatus, self, TaskGroup, nil ):SetTime( MenuTime ):SetTag( "Tasking" )
+      end      
     end
   end
 
@@ -1200,25 +1207,59 @@ function TASK:MenuMarkToGroup( TaskGroup )
 
   self:UpdateTaskInfo( self.DetectedItem )
   
-  local Report = REPORT:New():SetIndent( 0 )
-
-  self.TaskInfo:Report( Report, "M", TaskGroup )
-
-  local TargetCoordinate = self.TaskInfo:GetData( "Coordinate" ) -- Core.Point#COORDINATE
-  local MarkText = Report:Text( ", " ) 
-  self:F( { Coordinate = TargetCoordinate, MarkText = MarkText } )
-  TargetCoordinate:MarkToGroup( MarkText, TaskGroup )
-  --Coordinate:MarkToAll( Briefing )
+  local TargetCoordinates = self.TaskInfo:GetData( "Coordinates" ) -- Core.Point#COORDINATE
+  if TargetCoordinates then
+    for TargetCoordinateID, TargetCoordinate in pairs( TargetCoordinates ) do
+      local Report = REPORT:New():SetIndent( 0 )
+      self.TaskInfo:Report( Report, "M", TaskGroup, self )
+      local MarkText = Report:Text( ", " ) 
+      self:F( { Coordinate = TargetCoordinate, MarkText = MarkText } )
+      TargetCoordinate:MarkToGroup( MarkText, TaskGroup )
+      --Coordinate:MarkToAll( Briefing )
+    end
+  else
+    local TargetCoordinate = self.TaskInfo:GetData( "Coordinate" ) -- Core.Point#COORDINATE
+    if TargetCoordinate then
+      local Report = REPORT:New():SetIndent( 0 )
+      self.TaskInfo:Report( Report, "M", TaskGroup, self )
+      local MarkText = Report:Text( ", " ) 
+      self:F( { Coordinate = TargetCoordinate, MarkText = MarkText } )
+      TargetCoordinate:MarkToGroup( MarkText, TaskGroup )
+    end
+  end
+  
 end
 
 --- Report the task status.
 -- @param #TASK self
+-- @param Wrapper.Group#GROUP TaskGroup
 function TASK:MenuTaskStatus( TaskGroup )
 
-  local ReportText = self:ReportDetails( TaskGroup )
-  
-  self:T( ReportText )
-  self:GetMission():GetCommandCenter():MessageTypeToGroup( ReportText, TaskGroup, MESSAGE.Type.Detailed )
+  if TaskGroup:IsAlive() then
+
+    local ReportText = self:ReportDetails( TaskGroup )
+    
+    self:T( ReportText )
+    self:GetMission():GetCommandCenter():MessageTypeToGroup( ReportText, TaskGroup, MESSAGE.Type.Detailed )
+  end
+
+end
+
+--- Report the task status.
+-- @param #TASK self
+function TASK:MenuFlashTaskStatus( TaskGroup, Flash )
+
+  self.FlashTaskStatus = Flash
+
+  if self.FlashTaskStatus then
+    self.FlashTaskScheduler, self.FlashTaskScheduleID = SCHEDULER:New( self, self.MenuTaskStatus, { TaskGroup }, 0, 60 )
+  else
+    if self.FlashTaskScheduler then
+      self.FlashTaskScheduler:Stop( self.FlashTaskScheduleID )
+      self.FlashTaskScheduler = nil
+      self.FlashTaskScheduleID = nil
+    end
+  end
 
 end
 
@@ -1697,6 +1738,23 @@ end
 
 do -- Links
 
+  --- Set goal of a task
+  -- @param #TASK self
+  -- @param Core.Goal#GOAL Goal
+  -- @return #TASK
+  function TASK:SetGoal( Goal )
+    self.Goal = Goal
+  end
+
+
+  --- Get goal of a task
+  -- @param #TASK self
+  -- @return Core.Goal#GOAL The Goal
+  function TASK:GetGoal()
+    return self.Goal
+  end
+
+
   --- Set dispatcher of a task
   -- @param #TASK self
   -- @param Tasking.DetectionManager#DETECTION_MANAGER Dispatcher
@@ -1739,7 +1797,7 @@ function TASK:ReportSummary( ReportGroup )
   -- Determine the status of the Task.
   Report:Add( "State: <" .. self:GetState() .. ">" )
   
-  self.TaskInfo:Report( Report, "S", ReportGroup )
+  self.TaskInfo:Report( Report, "S", ReportGroup, self )
   
   return Report:Text( ', ' )
 end
@@ -1756,7 +1814,7 @@ function TASK:ReportOverview( ReportGroup )
   local TaskName = self:GetName()
   local Report = REPORT:New()
   
-  self.TaskInfo:Report( Report, "O", ReportGroup )
+  self.TaskInfo:Report( Report, "O", ReportGroup, self )
   
   return Report:Text()
 end
@@ -1774,7 +1832,7 @@ function TASK:GetPlayerCount() --R2.1 Get a count of the players.
     if PlayerGroup:IsAlive() == true then
       if self:IsGroupAssigned( PlayerGroup ) then
         local PlayerNames = PlayerGroup:GetPlayerNames()
-          PlayerCount = PlayerCount + #PlayerNames
+        PlayerCount = PlayerCount + ((PlayerNames) and #PlayerNames or 0) -- PlayerNames can be nil when there are no players.
       end
     end
   end
@@ -1796,7 +1854,7 @@ function TASK:GetPlayerNames() --R2.1 Get a map of the players.
     if PlayerGroup:IsAlive() == true then
       if self:IsGroupAssigned( PlayerGroup ) then
         local PlayerNames = PlayerGroup:GetPlayerNames()
-        for PlayerNameID, PlayerName in pairs( PlayerNames ) do
+        for PlayerNameID, PlayerName in pairs( PlayerNames or {} ) do
           PlayerNameMap[PlayerName] = PlayerGroup
         end
       end
@@ -1840,7 +1898,7 @@ function TASK:ReportDetails( ReportGroup )
     Report:AddIndent( Players )
   end
   
-  self.TaskInfo:Report( Report, "D", ReportGroup )
+  self.TaskInfo:Report( Report, "D", ReportGroup, self )
   
   return Report:Text()
 end

Moose Development/Moose/Tasking/TaskInfo.lua

@@ -24,7 +24,7 @@ TASKINFO = {
   ClassName = "TASKINFO",
 }
 
---- @type #TASKINFO.Detail #string A string that flags to document which level of detail needs to be shown in the report.
+--- @type TASKINFO.Detail #string A string that flags to document which level of detail needs to be shown in the report.
 -- 
 --   - "M" for Markings on the Map (F10).
 --   - "S" for Summary Reports.
@@ -52,16 +52,16 @@ end
 
 --- Add taskinfo. 
 -- @param #TASKINFO self
--- @param #string The info key.
+-- @param #string Key The info key.
 -- @param Data The data of the info.
 -- @param #number Order The display order, which is a number from 0 to 100.
 -- @param #TASKINFO.Detail Detail The detail Level.
 -- @param #boolean Keep (optional) If true, this would indicate that the planned taskinfo would be persistent when the task is completed, so that the original planned task info is used at the completed reports.
 -- @return #TASKINFO self
-function TASKINFO:AddInfo( Key, Data, Order, Detail, Keep )
-  self.VolatileInfo:Add( Key, { Data = Data, Order = Order, Detail = Detail } )
+function TASKINFO:AddInfo( Key, Data, Order, Detail, Keep, ShowKey, Type )
+  self.VolatileInfo:Add( Key, { Data = Data, Order = Order, Detail = Detail, ShowKey = ShowKey, Type = Type } )
   if Keep == true then
-    self.PersistentInfo:Add( Key, { Data = Data, Order = Order, Detail = Detail } )
+    self.PersistentInfo:Add( Key, { Data = Data, Order = Order, Detail = Detail, ShowKey = ShowKey, Type = Type } )
   end
   return self
 end
@@ -85,7 +85,7 @@ end
 -- @return Data The data of the info.
 function TASKINFO:GetData( Key )
   local Object = self.Info:Get( Key )
-  return Object.Data
+  return Object and Object.Data
 end
 
 
@@ -124,8 +124,30 @@ end
 -- @param #TASKINFO.Detail Detail The detail Level.
 -- @param #boolean Keep (optional) If true, this would indicate that the planned taskinfo would be persistent when the task is completed, so that the original planned task info is used at the completed reports.
 -- @return #TASKINFO self
-function TASKINFO:AddCoordinate( Coordinate, Order, Detail, Keep )
-  self:AddInfo( "Coordinate", Coordinate, Order, Detail, Keep )
+function TASKINFO:AddCoordinate( Coordinate, Order, Detail, Keep, ShowKey, Name )
+  self:AddInfo( Name or "Coordinate", Coordinate, Order, Detail, Keep, ShowKey, "Coordinate" )
+  return self
+end
+
+
+--- Get the Coordinate. 
+-- @param #TASKINFO self
+-- @return Core.Point#COORDINATE Coordinate
+function TASKINFO:GetCoordinate( Name )
+  return self:GetData( Name or "Coordinate" )
+end
+
+
+
+--- Add Coordinates. 
+-- @param #TASKINFO self
+-- @param #list<Core.Point#COORDINATE> Coordinates
+-- @param #number Order The display order, which is a number from 0 to 100.
+-- @param #TASKINFO.Detail Detail The detail Level.
+-- @param #boolean Keep (optional) If true, this would indicate that the planned taskinfo would be persistent when the task is completed, so that the original planned task info is used at the completed reports.
+-- @return #TASKINFO self
+function TASKINFO:AddCoordinates( Coordinates, Order, Detail, Keep )
+  self:AddInfo( "Coordinates", Coordinates, Order, Detail, Keep )
   return self
 end
 
@@ -140,7 +162,7 @@ end
 -- @param #boolean Keep (optional) If true, this would indicate that the planned taskinfo would be persistent when the task is completed, so that the original planned task info is used at the completed reports.
 -- @return #TASKINFO self
 function TASKINFO:AddThreat( ThreatText, ThreatLevel, Order, Detail, Keep )
-  self:AddInfo( "Threat", ThreatText .. " [" .. string.rep(  "■", ThreatLevel ) .. string.rep(  "□", 10 - ThreatLevel ) .. "]", Order, Detail, Keep )
+  self:AddInfo( "Threat", " [" .. string.rep(  "■", ThreatLevel ) .. string.rep(  "□", 10 - ThreatLevel ) .. "]:" .. ThreatText, Order, Detail, Keep )
   return self
 end
 
@@ -259,6 +281,7 @@ function TASKINFO:AddCargoSet( SetCargo, Order, Detail, Keep )
   )
 
   self:AddInfo( "Cargo", CargoReport:Text(), Order, Detail, Keep )
+  
 
   return self
 end
@@ -270,8 +293,9 @@ end
 -- @param Core.Report#REPORT Report
 -- @param #TASKINFO.Detail Detail The detail Level.
 -- @param Wrapper.Group#GROUP ReportGroup
+-- @param Tasking.Task#TASK Task
 -- @return #TASKINFO self
-function TASKINFO:Report( Report, Detail, ReportGroup )
+function TASKINFO:Report( Report, Detail, ReportGroup, Task )
 
   local Line = 0
   local LineReport = REPORT:New()
@@ -282,75 +306,63 @@ function TASKINFO:Report( Report, Detail, ReportGroup )
 
   for Key, Data in UTILS.spairs( self.Info.Set, function( t, a, b ) return t[a].Order < t[b].Order end ) do
 
-    self:F( { Key = Key, Detail = Detail, Data = Data } )
-    
     if Data.Detail:find( Detail ) then
       local Text = ""
-      if Key == "TaskName" then
+      local ShowKey = ( Data.ShowKey == nil or Data.ShowKey == true )
+      if     Key == "TaskName" then
         Key = nil
         Text = Data.Data
-      end
-      if Key == "Coordinate" then
+      elseif Data.Type and Data.Type == "Coordinate" then
         local Coordinate = Data.Data -- Core.Point#COORDINATE
-        Text = Coordinate:ToString( ReportGroup:GetUnit(1), nil, self )
-      end
-      if Key == "Threat" then
+        Text = Coordinate:ToString( ReportGroup:GetUnit(1), nil, Task )
+      elseif Key == "Threat" then
         local DataText = Data.Data -- #string
         Text = DataText
-      end
-      if Key == "Counting" then
+      elseif Key == "Counting" then
         local DataText = Data.Data -- #string
         Text = DataText
-      end
-      if Key == "Targets" then
+      elseif Key == "Targets" then
         local DataText = Data.Data -- #string
         Text = DataText
-      end
-      if Key == "QFE" then
+      elseif Key == "QFE" then
         local Coordinate = Data.Data -- Core.Point#COORDINATE
-        Text = Coordinate:ToStringPressure( ReportGroup:GetUnit(1), nil, self )
-      end
-      if Key == "Temperature" then
+        Text = Coordinate:ToStringPressure( ReportGroup:GetUnit(1), nil, Task )
+      elseif Key == "Temperature" then
         local Coordinate = Data.Data -- Core.Point#COORDINATE
-        Text = Coordinate:ToStringTemperature( ReportGroup:GetUnit(1), nil, self )
-      end
-      if Key == "Wind" then
+        Text = Coordinate:ToStringTemperature( ReportGroup:GetUnit(1), nil, Task )
+      elseif Key == "Wind" then
         local Coordinate = Data.Data -- Core.Point#COORDINATE
-        Text = Coordinate:ToStringWind( ReportGroup:GetUnit(1), nil, self )
-      end
-      if Key == "Cargo" then
+        Text = Coordinate:ToStringWind( ReportGroup:GetUnit(1), nil, Task )
+      elseif Key == "Cargo" then
+        local DataText = Data.Data -- #string
+        Text = DataText
+      elseif Key == "Friendlies" then
+        local DataText = Data.Data -- #string
+        Text = DataText
+      elseif Key == "Players" then
+        local DataText = Data.Data -- #string
+        Text = DataText
+      else
         local DataText = Data.Data -- #string
         Text = DataText
       end
-      if Key == "Friendlies" then
-        local DataText = Data.Data -- #string
-        Text = DataText
-      end
-      if Key == "Players" then
-        local DataText = Data.Data -- #string
-        Text = DataText
-      end
-
 
       if Line < math.floor( Data.Order / 10 ) then
         if Line == 0 then
-          if Text ~= "" then
-            Report:AddIndent( LineReport:Text( ", " ), "-" )
-          end
+          Report:AddIndent( LineReport:Text( ", " ), "-" )
         else
-          if Text ~= "" then
-            Report:AddIndent( LineReport:Text( ", " ) )
-          end
+          Report:AddIndent( LineReport:Text( ", " ) )
         end
         LineReport = REPORT:New()
         Line = math.floor( Data.Order / 10 )
       end
 
       if Text ~= "" then
-        LineReport:Add( ( Key and ( Key .. ":" ) or "" ) .. Text )
+        LineReport:Add( ( ( Key and ShowKey == true ) and ( Key .. ": " ) or "" ) .. Text )
       end
+
     end
   end
+  
   Report:AddIndent( LineReport:Text( ", " ) )
-
 end

Moose Development/Moose/Tasking/Task_A2A.lua

@@ -351,6 +351,26 @@ do -- TASK_A2A
     end
   end
 
+  --- This function is called from the @{Tasking.CommandCenter#COMMANDCENTER} to determine the method of automatic task selection.
+  -- @param #TASK_A2A self
+  -- @param #number AutoAssignMethod The method to be applied to the task.
+  -- @param Tasking.CommandCenter#COMMANDCENTER CommandCenter The command center.
+  -- @param Wrapper.Group#GROUP TaskGroup The player group.
+  function TASK_A2A:GetAutoAssignPriority( AutoAssignMethod, CommandCenter, TaskGroup )
+  
+    if     AutoAssignMethod == COMMANDCENTER.AutoAssignMethods.Random then
+      return math.random( 1, 9 )
+    elseif AutoAssignMethod == COMMANDCENTER.AutoAssignMethods.Distance then
+      local Coordinate = self.TaskInfo:GetData( "Coordinate" )
+      local Distance = Coordinate:Get2DDistance( CommandCenter:GetPositionable():GetCoordinate() )
+      return math.floor( Distance )
+    elseif AutoAssignMethod == COMMANDCENTER.AutoAssignMethods.Priority then
+      return 1
+    end
+
+    return 0
+  end
+
 end 
 
 

Moose Development/Moose/Tasking/Task_A2A_Dispatcher.lua

@@ -574,15 +574,15 @@ do -- TASK_A2A_DISPATCHER
               self:Success( Task )
             end
 
-            function Task.onenterCancelled( Task, From, Event, To )
+            function Task.OnEnterCancelled( Task, From, Event, To )
               self:Cancelled( Task )
             end
             
-            function Task.onenterFailed( Task, From, Event, To )
+            function Task.OnEnterFailed( Task, From, Event, To )
               self:Failed( Task )
             end
 
-            function Task.onenterAborted( Task, From, Event, To )
+            function Task.OnEnterAborted( Task, From, Event, To )
               self:Aborted( Task )
             end
             

Moose Development/Moose/Tasking/Task_A2G.lua

@@ -355,6 +355,27 @@ do -- TASK_A2G
     end
     
   end
+  
+  --- This function is called from the @{Tasking.CommandCenter#COMMANDCENTER} to determine the method of automatic task selection.
+  -- @param #TASK_A2G self
+  -- @param #number AutoAssignMethod The method to be applied to the task.
+  -- @param Tasking.CommandCenter#COMMANDCENTER CommandCenter The command center.
+  -- @param Wrapper.Group#GROUP TaskGroup The player group.
+  function TASK_A2G:GetAutoAssignPriority( AutoAssignMethod, CommandCenter, TaskGroup )
+  
+    if     AutoAssignMethod == COMMANDCENTER.AutoAssignMethods.Random then
+      return math.random( 1, 9 )
+    elseif AutoAssignMethod == COMMANDCENTER.AutoAssignMethods.Distance then
+      local Coordinate = self.TaskInfo:GetData( "Coordinate" )
+      local Distance = Coordinate:Get2DDistance( CommandCenter:GetPositionable():GetCoordinate() )
+      self:F({Distance=Distance})
+      return math.floor( Distance )
+    elseif AutoAssignMethod == COMMANDCENTER.AutoAssignMethods.Priority then
+      return 1
+    end
+
+    return 0
+  end
 
 end 
 

Moose Development/Moose/Tasking/Task_A2G_Dispatcher.lua

@@ -633,7 +633,7 @@ do -- TASK_A2G_DISPATCHER
         --DetectedSet:Flush( self )
         
         local DetectedItemID = DetectedItem.ID
-        local TaskIndex = DetectedItem.ID
+        local TaskIndex = DetectedItem.Index
         local DetectedItemChanged = DetectedItem.Changed
         
         self:F( { DetectedItemChanged = DetectedItemChanged, DetectedItemID = DetectedItemID, TaskIndex = TaskIndex } )
@@ -649,6 +649,7 @@ do -- TASK_A2G_DISPATCHER
               if TargetSetUnit then
                 if Task:IsInstanceOf( TASK_A2G_SEAD ) then
                   Task:SetTargetSetUnit( TargetSetUnit )
+                  Task:SetDetection( Detection, DetectedItem )
                   Task:UpdateTaskInfo( DetectedItem )
                   TargetsReport:Add( Detection:GetChangeText( DetectedItem )  )
                 else
@@ -659,7 +660,7 @@ do -- TASK_A2G_DISPATCHER
                 if TargetSetUnit then
                   if Task:IsInstanceOf( TASK_A2G_CAS ) then
                     Task:SetTargetSetUnit( TargetSetUnit )
-                    Task:SetDetection( Detection, TaskIndex )
+                    Task:SetDetection( Detection, DetectedItem )
                     Task:UpdateTaskInfo( DetectedItem )
                     TargetsReport:Add( Detection:GetChangeText( DetectedItem ) )
                   else
@@ -671,7 +672,7 @@ do -- TASK_A2G_DISPATCHER
                   if TargetSetUnit then
                     if Task:IsInstanceOf( TASK_A2G_BAI ) then
                       Task:SetTargetSetUnit( TargetSetUnit )
-                      Task:SetDetection( Detection, TaskIndex )
+                      Task:SetDetection( Detection, DetectedItem )
                       Task:UpdateTaskInfo( DetectedItem )
                       TargetsReport:Add( Detection:GetChangeText( DetectedItem ) )
                     else
@@ -775,15 +776,15 @@ do -- TASK_A2G_DISPATCHER
               self:Success( Task )
             end
 
-            function Task.onenterCancelled( Task, From, Event, To )
+            function Task.OnEnterCancelled( Task, From, Event, To )
               self:Cancelled( Task )
             end
             
-            function Task.onenterFailed( Task, From, Event, To )
+            function Task.OnEnterFailed( Task, From, Event, To )
               self:Failed( Task )
             end
 
-            function Task.onenterAborted( Task, From, Event, To )
+            function Task.OnEnterAborted( Task, From, Event, To )
               self:Aborted( Task )
             end
             

Moose Development/Moose/Tasking/Task_CARGO.lua

@@ -1,19 +1,35 @@
 --- **Tasking** -- Base class to model tasks for players to transport cargo.
 -- 
+-- ## Features:
+-- 
+--   * TASK_CARGO is the **base class** for:
+--   
+--     * @{Tasking.Task_Cargo_Transport#TASK_CARGO_TRANSPORT}
+--     * @{Tasking.Task_Cargo_CSAR#TASK_CARGO_CSAR}
+-- 
+-- 
+-- ===
+-- 
+-- ## Test Missions:
+-- 
+-- Test missions can be located on the main GITHUB site.
+-- 
+-- [FlightControl-Master/MOOSE_MISSIONS/TAD - Task Dispatching/CGO - Cargo Dispatching/](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/TAD%20-%20Task%20Dispatching/CGO%20-%20Cargo%20Dispatching)
+-- 
 -- ===
 --
--- # 1) Tasking system.
+-- ## Tasking system.
 -- 
--- #### If you are not yet aware what the MOOSE tasking system is about, read FIRST the explanation on tasking **@{Tasking.Task}**.
+-- #### If you are not yet aware what the MOOSE tasking system is about, read FIRST the explanation on the @{Tasking.Task} module.
 -- 
 -- ===
 -- 
--- # 2) Context of cargo tasking.
+-- ## Context of cargo tasking.
 -- 
 -- The Moose framework provides various CARGO classes that allow DCS physical or logical objects to be transported or sling loaded by Carriers.
 -- The CARGO_ classes, as part of the MOOSE core, are able to Board, Load, UnBoard and UnLoad cargo between Carrier units.
 -- 
--- The TASK\_CARGO class is not meant to use within your missions as a mission designer. It is a base class, and other classes are derived from it.
+-- The TASK_CARGO class is not meant to use within your missions as a mission designer. It is a base class, and other classes are derived from it.
 -- 
 -- The following TASK_CARGO_ classes are important, as they implement the CONCRETE tasks:
 -- 
@@ -25,7 +41,7 @@
 -- 
 -- ===
 -- 
--- # 3) Cargo tasking from a player perspective.
+-- ## Cargo tasking from a player perspective.
 -- 
 -- A human player can join the battle field in a client airborne slot or a ground vehicle within the CA module (ALT-J).
 -- The player needs to accept the task from the task overview list within the mission, using the menus.
@@ -46,19 +62,19 @@
 -- In the menu, you'll find for each CARGO, that is part of the scope of the task, various actions that can be completed.
 -- Depending on the location of your Carrier unit, the menu options will vary.
 -- 
--- ## 3.1) Joining a Cargo Transport Task
+-- ### Joining a Cargo Transport Task
 -- 
 -- Once you've joined a task, using the **Join Planned Task Menu**, 
 -- you can Pickup cargo from a pickup location and Deploy cargo in deployment zones, using the **Task Action Menu**.
 --  
--- ## 3.2) Task Action Menu.
+-- ### Task Action Menu.
 -- 
 -- When a player has joined a **`CARGO`** task (type), for that player only, 
 -- it's **Task Action Menu** will show an additional menu options.
 -- 
 -- From within this menu, you will be able to route to a cargo location, deploy zone, and load/unload cargo.
 -- 
--- ## 3.3) Pickup cargo by Boarding, Loading and Sling Loading.
+-- ### Pickup cargo by Boarding, Loading and Sling Loading.
 -- 
 -- There are three different ways how cargo can be picked up:
 -- 
@@ -99,7 +115,7 @@
 -- This is done to ensure that **different teams** have a **defined scope** for defined cargo, and that **multiple teams** can join
 -- **multiple tasks**, transporting cargo **simultaneously** in a **cooperation**.
 -- 
--- In this example, there is a menu option to **Route to pickup cargo...".
+-- In this example, there is a menu option to **Route to pickup cargo...**.
 -- Use this menu to route towards cargo locations for pickup into your carrier.
 -- 
 -- ![Task_Types](../Tasking/Task_Cargo_Types_Menu.JPG)
@@ -140,7 +156,7 @@
 -- These routing options will only be shown, when your carrier bays have cargo loaded.
 -- So, only when there is something to be deployed from your carrier, the deploy options will be shown.
 --     
--- ### 3.3.1) Pickup Cargo.
+-- #### Pickup Cargo.
 -- 
 -- In order to pickup cargo, use the **task action menu** to **route to a specific cargo**.
 -- When a cargo route is selected, the HQ will send you routing messages indicating the location of the cargo.
@@ -155,51 +171,78 @@
 -- It takes a bit of skill to land a helicopter near a cargo to be loaded, but that is part of the game, isn't it?
 -- Expecially when you are landing in a "hot" zone, so when cargo is under immediate threat of fire.
 -- 
--- ### 3.3.2) Board Cargo (infantry).
+-- #### Board Cargo (infantry).
 -- 
--- ![Task_Types](../Tasking/Boarding_Ready.JPG)  
+-- ![](../Tasking/Boarding_Ready.png)  
 -- 
 -- If your Carrier is within the **Reporting Range of the cargo**, and the cargo is **moveable**, the **cargo can be boarded**!
 -- This type of cargo will be most of the time be infantry.
 -- 
--- ![Boarding](../Tasking/Boarding_Menu.JPG)  
+-- ![](../Tasking/Boarding_Menu.png)  
 -- 
--- A board menu has appeared, because your carrier is in boarding range of the cargo (infantry).
+-- A **Board cargo...** sub menu has appeared, because your carrier is in boarding range of the cargo (infantry).
+-- Select the **Board cargo...** menu.
 -- 
--- ![Boarding](../Tasking/Boarding_Started.JPG)  
+-- ![](../Tasking/Boarding_Menu_Engineers.png)  
 -- 
+-- Any cargo that can be boarded (thus movable cargo), within boarding range of the carrier, will be listed here!
+-- In this example, the cargo **Engineers** can be boarded, by selecting the menu option.
 -- 
--- Select the option from the action menu, then select the cargo to be boarded, and the cargo will start moving towards your carrier.
--- Note that a message is displayed by the infantry cargo that boarding has started.
+-- ![](../Tasking/Boarding_Started.png)  
 -- 
--- ![Boarding](../Tasking/Boarding_Ongoing.JPG)  
+-- After the menu option to board the cargo has been selected, the boarding process is started.
+-- A message from the cargo is communicated to the pilot, that boarding is started.
+-- 
+-- ![](../Tasking/Boarding_Ongoing.png)  
+-- 
+-- **The pilot must wait at the exact position until all cargo has been boarded!**  
 -- 
 -- The moveable cargo will run in formation to your carrier, and will board one by one, depending on the near range set by the mission designer.
 -- The near range as added because carriers can be large or small, depending on the object size of the carrier.
 -- 
--- ![Boarding](../Tasking/Boarding_Almost_Done.JPG)  
+-- ![](../Tasking/Boarding_In_Progress.png)  
+-- 
+-- ![](../Tasking/Boarding_Almost_Done.png)  
 -- 
 -- Note that multiple units may need to board your Carrier, so it is required to await the full boarding process.
 -- 
--- ![Boarding](../Tasking/Boarding_Done.JPG)  
+-- ![](../Tasking/Boarding_Done.png)  
 -- 
 -- Once the cargo is fully boarded within your Carrier, you will be notified of this.
 -- 
--- Note that for airborne Carriers, it is required to land first before the Boarding process can be initiated.
--- If during boarding the Carrier gets airborne, the boarding process will be cancelled.
+-- **Remarks:**
 -- 
--- ### 3.3.3) Load Cargo.
+--   * For airborne Carriers, it is required to land first before the Boarding process can be initiated.
+--     If during boarding the Carrier gets airborne, the boarding process will be cancelled.
+--   * The carrier must remain stationary when the boarding sequence has started until further notified.
 -- 
--- If your Carrier is within the **Loading Range of the cargo**, and the cargo is **stationary**, the **cargo can be loaded**, but not boarded!
+-- #### Load Cargo.
+-- 
+-- Cargo can be loaded into vehicles or helicopters or airplanes, as long as the carrier is sufficiently near to the cargo object.
+-- 
+-- ![](../Tasking/Loading_Ready.png)  
+-- 
+-- If your Carrier is within the **Loading Range of the cargo**, thus, sufficiently near to the cargo, and the cargo is **stationary**, the **cargo can be loaded**, but not boarded!
+-- 
+-- ![](../Tasking/Loading_Menu.png)  
+-- 
+-- Select the task action menu and now a **Load cargo...** sub menu will be listed.
+-- Select the **Load cargo...** sub menu, and a further detailed menu will be shown.
+-- 
+-- ![](../Tasking/Loading_Menu_Crate.png)  
+-- 
+-- For each non-moveable cargo object (crates etc), **within loading range of the carrier**, the cargo will be listed and can be loaded into the carrier!
+-- 
+-- ![](../Tasking/Loading_Cargo_Loaded.png)  
 -- 
--- Select the task action menu and now a **Load option** will be listed with the cargo name next to it!
--- Select the option from the action menu, and the cargo will loaded into your carrier.
 -- Once the cargo is loaded within your Carrier, you will be notified of this.
 -- 
--- Note that for airborne Carriers, it is required to land first right near the cargo, before the loading process can be initiated.
+-- **Remarks:**
+--  
+--   * For airborne Carriers, it is required to **land first right near the cargo**, before the loading process can be initiated.
 -- As stated, this requires some pilot skills :-)
 -- 
--- ### 3.3.4) Sling Load Cargo (helicopters only).
+-- #### Sling Load Cargo (helicopters only).
 -- 
 -- If your Carrier is within the **Loading Range of the cargo**, and the cargo is **stationary**, the **cargo can also be sling loaded**!
 -- Note that this is only possible for helicopters.
@@ -211,7 +254,9 @@
 -- As stated, this requires some pilot skills :-)
 -- 
 -- 
--- ## 3.4) Deploy cargo by Unboarding, Unloading and Sling Deploying.
+-- ### Deploy cargo by Unboarding, Unloading and Sling Deploying.
+-- 
+-- #### **Deploying the relevant cargo within deploy zones, will make you achieve cargo transportation tasks!!!**
 -- 
 -- There are two different ways how cargo can be deployed:
 -- 
@@ -231,61 +276,122 @@
 -- Fortunately, the HQ can help to route you to the locations of deploy zone.
 -- Use the task action menu to receive HQ help for this.
 -- 
--- ![Task_Types](../Tasking/Task_Cargo_Actions.JPG)
+-- ![](../Tasking/Routing_Deploy_Zone_Menu.png)
 --  
 -- Depending on the location within the battlefield, the task action menu will contain **Route options** that can be selected
 -- to start the HQ sending you routing messages. Also, if the carrier cargo bays contain cargo, 
 -- then beside **Route options** there will also be **Deploy options** listed.
 -- These **Deploy options** are meant to route you to the deploy zone locations.
 -- 
+-- ![](../Tasking/Routing_Deploy_Zone_Menu_Workplace.png)
+-- 
+-- Depending on the task that you have selected, the deploy zones will be listed.
+-- **There may be multiple deploy zones within the mission, but only the deploy zones relevant for your task will be available in the menu!**
+--  
+-- ![](../Tasking/Routing_Deploy_Zone_Message.png)
+-- 
+-- When a routing option is selected, you are sent routing messages in a selected coordinate format.
 -- Possible routing coordinate formats are: Bearing Range (BR), Lattitude Longitude (LL) or Military Grid System (MGRS).
--- Note that for LL, there are two sub formats.
+-- Note that for LL, there are two sub formats. (See pickup).
+-- 
+-- ![](../Tasking/Routing_Deploy_Zone_Arrived.png)
+-- 
+-- When you are within the range of the deploy zone (can be also a polygon!), a message is communicated by HQ that you have arrived within the zone!
 -- 
 -- The routing messages are formulated in the coordinate format that is currently active as configured in your settings profile.  
 -- ![Task_Types](../Tasking/Task_Cargo_Settings.JPG)  
 -- Use the **Settings Menu** to select the coordinate format that you would like to use for location determination.
 -- 
--- ## 3.4) Deploy Cargo.
+-- #### Unboard Cargo.
 -- 
--- Various Deployment Zones can be foreseen in the scope of the Cargo transportation. Each deployment zone can be of varying @{Zone} type.
--- The Cargo menu provides with menu options to execute an action to steer your Carrier to a specific Zone.
+-- If your carrier contains cargo, and the cargo is **moveable**, the **cargo can be unboarded**!
+-- You can only unload cargo if there is cargo within your cargo bays within the carrier.
 -- 
--- In order to deploy cargo, use the task action menu to select a cargo to route to.
--- When selected, the HQ will send you routing messages indicating the location of the deploy zone.
---  
--- Upon arrival at the deploy zone, the HQ will contact you and further instructions will be given.
+-- ![](../Tasking/Unboarding_Menu.png)
 -- 
--- ### 3.4.1) Unboard Cargo.
+-- Select the task action menu and now an **Unboard cargo...** sub menu will be listed!
+-- Again, this option will only be listed if there is a non moveable cargo within your cargo bays.
 -- 
--- If your Carrier is within the **deploy zone**, and the cargo is **moveable**, the **cargo can be unboarded**!
+-- ![](../Tasking/Unboarding_Menu_Engineers.png)
 -- 
--- Select the task action menu and now an **Unboard option** will be listed with the cargo name next to it!
--- Select the option from the action menu, and the cargo will step out of your carrier and will move towards a grouping point.
+-- Now you will see a menu option to unload the non-moveable cargo.
+-- In this example, you can unload the **Engineers** that was loaded within your carrier cargo bays.
+-- Depending on the cargo loaded within your cargo bays, you will see other options here!
+-- Select the relevant menu option from the cargo unload menu, and the cargo will unloaded from your carrier.
+-- 
+-- ![](../Tasking/Unboarding_Started.png)
+-- 
+-- **The cargo will step out of your carrier and will move towards a grouping point.**
+-- When the unboarding process has started, you will be notified by a message to your carrier.
+-- 
+-- ![](../Tasking/Unboarding_In_Progress.png)
 -- 
 -- The moveable cargo will unboard one by one, so note that multiple units may need to unboard your Carrier, 
 -- so it is required to await the full completion of the unboarding process.
--- Once the cargo is fully unboarded from your Carrier, you will be notified of this.
 -- 
--- Note that for airborne Carriers, it is required to land first before the unboarding process can be initiated.
--- If during unboarding the Carrier gets airborne, the unboarding process will be cancelled.
+-- ![](../Tasking/Unboarding_Done.png)
 -- 
--- ### 3.4.2) Unload Cargo.
+-- Once the cargo is fully unboarded from your carrier, you will be notified of this.
+--
+-- **Remarks:**
 -- 
--- If your Carrier is within the **deploy zone**, and the cargo is **stationary**, the **cargo can be unloaded**, but not unboarded!
+--   * For airborne carriers, it is required to land first before the unboarding process can be initiated.
+--     If during unboarding the Carrier gets airborne, the unboarding process will be cancelled.
+--   * Once the moveable cargo is unboarded, they will start moving towards a specified gathering point.
+--   * The moveable cargo will send a message to your carrier with unboarding status updates.
 -- 
--- Select the task action menu and now an **Unload option** will be listed with the cargo name next to it!
--- Select the option from the action menu, and the cargo will unloaded from your carrier.
--- Once the cargo is unloaded fom your Carrier, you will be notified of this.
+-- **Deploying a cargo within a deployment zone, may complete a deployment task! So ensure that you deploy the right cargo at the right deployment zone!**
 -- 
--- Note that for airborne Carriers, it is required to land first at the deploy zone, before the unloading process can be initiated.
+-- #### Unload Cargo.
 -- 
--- ### 3.4.3) Sling Deploy Cargo (helicopters only).
+-- If your carrier contains cargo, and the cargo is **stationary**, the **cargo can be unloaded**, but not unboarded!
+-- You can only unload cargo if there is cargo within your cargo bays within the carrier.
+-- 
+-- ![](../Tasking/Unloading_Menu.png)
+-- 
+-- Select the task action menu and now an **Unload cargo...** sub menu will be listed! 
+-- Again, this option will only be listed if there is a non moveable cargo within your cargo bays.
+-- 
+-- ![](../Tasking/Unloading_Menu_Crate.png)
+-- 
+-- Now you will see a menu option to unload the non-moveable cargo.
+-- In this example, you can unload the **Crate** that was loaded within your carrier cargo bays.
+-- Depending on the cargo loaded within your cargo bays, you will see other options here!
+-- Select the relevant menu option from the cargo unload menu, and the cargo will unloaded from your carrier.
+-- 
+-- ![](../Tasking/Unloading_Done.png)
+-- 
+-- Once the cargo is unloaded fom your Carrier, you may be notified of this, when there is a truck near to the cargo.
+-- If there is no truck near to the unload area, no message will be sent to your carrier!
+-- 
+-- **Remarks:**
+-- 
+--   * For airborne Carriers, it is required to land first, before the unloading process can be initiated.
+--   * A truck must be near the unload area to get messages to your carrier of the unload event!
+--   * Unloading is only for non-moveable cargo.
+--   * The non-moveable cargo must be within your cargo bays, or no unload option will be available.
+--   
+-- **Deploying a cargo within a deployment zone, may complete a deployment task! So ensure that you deploy the right cargo at the right deployment zone!**
+-- 
+-- 
+-- #### Sling Deploy Cargo (helicopters only).
 -- 
 -- If your Carrier is within the **deploy zone**, and the cargo is **stationary**, the **cargo can also be sling deploying**!
 -- Note that this is only possible for helicopters.
 -- 
 -- To sling deploy cargo, there is no task action menu required. Just follow the normal sling deploying procedure.
 -- 
+-- **Deploying a cargo within a deployment zone, may complete a deployment task! So ensure that you deploy the right cargo at the right deployment zone!**
+-- 
+-- ## Cargo tasking from a mission designer perspective.
+-- 
+-- Please consult the documentation how to implement the derived classes of SET_CARGO in:
+-- 
+--   - @{Tasking.Task_Cargo#TASK_CARGO}: Documents the main methods how to handle the cargo tasking from a mission designer perspective.
+--   - @{Tasking.Task_Cargo#TASK_CARGO_TRANSPORT}: Documents the specific methods how to handle the cargo transportation tasking from a mission designer perspective.
+--   - @{Tasking.Task_Cargo#TASK_CARGO_CSAR}: Documents the specific methods how to handle the cargo CSAR tasking from a mission designer perspective.
+--   
+-- 
 -- ===
 -- 
 -- ### Author: **FlightControl**
@@ -364,6 +470,8 @@ do -- TASK_CARGO
   --   * **Success**: The cargo task is successfully completed.
   --   * **Failed**: The cargo task has failed. This will happen if the player exists the task early, without communicating a possible cancellation to HQ.
   -- 
+  -- 
+  -- 
   -- ===
   -- 
   -- @field #TASK_CARGO
@@ -508,7 +616,6 @@ do -- TASK_CARGO
     Fsm:AddTransition( "Rejected", "Reject", "Aborted" )
     Fsm:AddTransition( "Failed", "Fail", "Failed" )
 
-
     ---- @param #FSM_PROCESS self
     -- @param Wrapper.Unit#UNIT TaskUnit
     -- @param #TASK_CARGO Task
@@ -529,7 +636,6 @@ do -- TASK_CARGO
       local TaskUnitName = TaskUnit:GetName()
       local MenuTime = Task:InitTaskControlMenu( TaskUnit )
       local MenuControl = Task:GetTaskControlMenu( TaskUnit )
-      local CargoItemCount = TaskUnit:CargoItemCount()
       
       Task.SetCargo:ForEachCargo(
         
@@ -554,7 +660,13 @@ do -- TASK_CARGO
             local TaskGroup = TaskUnit:GetGroup()
             
             if Cargo:IsUnLoaded() then
-              if CargoItemCount < 1 then 
+              local CargoBayFreeWeight = TaskUnit:GetCargoBayFreeWeight()
+              local CargoWeight = Cargo:GetWeight()
+              
+              self:F({CargoBayFreeWeight=CargoBayFreeWeight})
+  
+              -- Only when there is space within the bay to load the next cargo item!
+              if CargoBayFreeWeight > CargoWeight then 
                 if Cargo:IsInReportRadius( TaskUnit:GetPointVec2() ) then
                   local NotInDeployZones = true
                   for DeployZoneName, DeployZone in pairs( Task.DeployZones ) do
@@ -582,9 +694,12 @@ do -- TASK_CARGO
                             Cargo:Report( "Load at " .. Cargo:GetCoordinate():ToString( TaskUnit:GetGroup() ) .. " within " .. Cargo.NearRadius .. ".", "reporting", TaskUnit:GetGroup() )
                           end
                         else
+                          --local Cargo = Cargo -- Cargo.CargoSlingload#CARGO_SLINGLOAD
                           if Cargo:CanSlingload() == true then
                             if Cargo:IsInLoadRadius( TaskUnit:GetPointVec2() ) then
-                              Cargo:Report( "Ready for slingloading.", "slingload", TaskUnit:GetGroup() )
+                              Cargo:Report( "Ready for sling loading.", "slingload", TaskUnit:GetGroup() )
+                              local SlingloadMenu = MENU_GROUP:New( TaskGroup, "Slingload cargo", MenuControl ):SetTime( MenuTime ):SetTag( "Cargo" )
+                              MENU_GROUP_COMMAND:New( TaskUnit:GetGroup(), Cargo.Name, SlingloadMenu, self.MenuLoadCargo, self, Cargo ):SetTime(MenuTime):SetTag("Cargo"):SetRemoveParent()
                             else
                               Cargo:Report( "Slingload at " .. Cargo:GetCoordinate():ToString( TaskUnit:GetGroup() ) .. ".", "reporting", TaskUnit:GetGroup() )
                             end
@@ -598,8 +713,29 @@ do -- TASK_CARGO
                 else
                   if not Cargo:IsDeployed() == true then
                     local RouteToPickupMenu = MENU_GROUP:New( TaskGroup, "Route to pickup cargo", MenuControl ):SetTime( MenuTime ):SetTag( "Cargo" )
-                    MENU_GROUP_COMMAND:New( TaskUnit:GetGroup(), Cargo.Name, RouteToPickupMenu, self.MenuRouteToPickup, self, Cargo ):SetTime(MenuTime):SetTag("Cargo"):SetRemoveParent()
+                    --MENU_GROUP_COMMAND:New( TaskUnit:GetGroup(), Cargo.Name, RouteToPickupMenu, self.MenuRouteToPickup, self, Cargo ):SetTime(MenuTime):SetTag("Cargo"):SetRemoveParent()
                     Cargo:ReportResetAll( TaskUnit:GetGroup() )
+                    if Cargo:CanBoard() == true then
+                      if not Cargo:IsInLoadRadius( TaskUnit:GetPointVec2() ) then
+                        local BoardMenu = MENU_GROUP:New( TaskGroup, "Board cargo", RouteToPickupMenu ):SetTime( MenuTime ):SetTag( "Cargo" )
+                        MENU_GROUP_COMMAND:New( TaskUnit:GetGroup(), Cargo.Name, BoardMenu, self.MenuRouteToPickup, self, Cargo ):SetTime(MenuTime):SetTag("Cargo"):SetRemoveParent()
+                      end
+                    else
+                      if Cargo:CanLoad() == true then
+                        if not Cargo:IsInLoadRadius( TaskUnit:GetPointVec2() ) then
+                          local LoadMenu = MENU_GROUP:New( TaskGroup, "Load cargo", RouteToPickupMenu ):SetTime( MenuTime ):SetTag( "Cargo" )
+                          MENU_GROUP_COMMAND:New( TaskUnit:GetGroup(), Cargo.Name, LoadMenu, self.MenuRouteToPickup, self, Cargo ):SetTime(MenuTime):SetTag("Cargo"):SetRemoveParent()
+                        end
+                      else
+                        --local Cargo = Cargo -- Cargo.CargoSlingload#CARGO_SLINGLOAD
+                        if Cargo:CanSlingload() == true then
+                          if not Cargo:IsInLoadRadius( TaskUnit:GetPointVec2() ) then
+                            local SlingloadMenu = MENU_GROUP:New( TaskGroup, "Slingload cargo", RouteToPickupMenu ):SetTime( MenuTime ):SetTag( "Cargo" )
+                            MENU_GROUP_COMMAND:New( TaskUnit:GetGroup(), Cargo.Name, SlingloadMenu, self.MenuRouteToPickup, self, Cargo ):SetTime(MenuTime):SetTag("Cargo"):SetRemoveParent()
+                          end
+                        end
+                      end
+                    end
                   end
                 end
               end
@@ -607,11 +743,11 @@ do -- TASK_CARGO
               -- Cargo in deployzones are flagged as deployed.
               for DeployZoneName, DeployZone in pairs( Task.DeployZones ) do
                 if Cargo:IsInZone( DeployZone ) then
-                  Task:E( { CargoIsDeployed = Task.CargoDeployed and "true" or "false" } )
+                  Task:I( { CargoIsDeployed = Task.CargoDeployed and "true" or "false" } )
                   if Cargo:IsDeployed() == false then
                     Cargo:SetDeployed( true )
                     -- Now we call a callback method to handle the CargoDeployed event.
-                    Task:E( { CargoIsAlive = Cargo:IsAlive() and "true" or "false" } )
+                    Task:I( { CargoIsAlive = Cargo:IsAlive() and "true" or "false" } )
                     if Cargo:IsAlive() then
                       Task:CargoDeployed( TaskUnit, Cargo, DeployZone )
                     end
@@ -881,7 +1017,7 @@ do -- TASK_CARGO
           else
             Cargo:MessageToGroup( "Boarding ...", TaskUnit:GetGroup() )
             if not Cargo:IsBoarding() then
-              Cargo:Board( TaskUnit, 20, self )
+              Cargo:Board( TaskUnit, nil, self )
             end
           end
         else
@@ -1225,10 +1361,19 @@ do -- TASK_CARGO
   end
   
   --- @param #TASK_CARGO self
-  function TASK_CARGO:UpdateTaskInfo( DetectedItem )
+  function TASK_CARGO:UpdateTaskInfo()
   
     if self:IsStatePlanned() or self:IsStateAssigned() then
+      self.TaskInfo:AddTaskName( 0, "MSOD" )
       self.TaskInfo:AddCargoSet( self.SetCargo, 10, "SOD", true )
+      local Coordinates = {}
+      for CargoName, Cargo in pairs( self.SetCargo:GetSet() ) do
+        local Cargo = Cargo -- Cargo.Cargo#CARGO
+        if not Cargo:IsLoaded() then
+          Coordinates[#Coordinates+1] = Cargo:GetCoordinate()
+        end
+      end
+      self.TaskInfo:AddCoordinates( Coordinates, 1, "M" )
     end
   end
 
@@ -1236,6 +1381,23 @@ do -- TASK_CARGO
     
     return 0
   end
+
+  --- This function is called from the @{Tasking.CommandCenter#COMMANDCENTER} to determine the method of automatic task selection.
+  -- @param #TASK_CARGO self
+  -- @param #number AutoAssignMethod The method to be applied to the task.
+  -- @param Wrapper.Group#GROUP TaskGroup The player group.
+  function TASK_CARGO:GetAutoAssignPriority( AutoAssignMethod, TaskGroup )
+  
+    if     AutoAssignMethod == COMMANDCENTER.AutoAssignMethods.Random then
+      return math.random( 1, 9 )
+    elseif AutoAssignMethod == COMMANDCENTER.AutoAssignMethods.Distance then
+      return 0
+    elseif AutoAssignMethod == COMMANDCENTER.AutoAssignMethods.Priority then
+      return 1
+    end
+
+    return 0
+  end
   
   
   

Moose Development/Moose/Tasking/Task_Capture_Dispatcher.lua

@@ -0,0 +1,396 @@
+--- **Tasking** - Creates and manages player TASK_ZONE_CAPTURE tasks.
+-- 
+-- The **TASK_CAPTURE_DISPATCHER** allows you to setup various tasks for let human
+-- players capture zones in a co-operation effort. 
+--  
+-- The dispatcher will implement for you mechanisms to create capture zone tasks:
+--  
+--   * As setup by the mission designer.
+--   * Dynamically capture zone tasks.
+--   
+-- 
+--   
+-- **Specific features:**
+-- 
+--   * Creates a task to capture zones and achieve mission goals.
+--   * Orchestrate the task flow, so go from Planned to Assigned to Success, Failed or Cancelled.
+--   * Co-operation tasking, so a player joins a group of players executing the same task.
+-- 
+-- 
+-- **A complete task menu system to allow players to:**
+--   
+--   * Join the task, abort the task.
+--   * Mark the location of the zones to capture on the map.
+--   * Provide details of the zones.
+--   * Route to the zones.
+--   * Display the task briefing.
+--   
+--   
+-- **A complete mission menu system to allow players to:**
+--   
+--   * Join a task, abort the task.
+--   * Display task reports.
+--   * Display mission statistics.
+--   * Mark the task locations on the map.
+--   * Provide details of the zones.
+--   * Display the mission briefing.
+--   * Provide status updates as retrieved from the command center.
+--   * Automatically assign a random task as part of a mission.
+--   * Manually assign a specific task as part of a mission.
+--   
+--   
+--  **A settings system, using the settings menu:**
+--  
+--   * Tweak the duration of the display of messages.
+--   * Switch between metric and imperial measurement system.
+--   * Switch between coordinate formats used in messages: BR, BRA, LL DMS, LL DDM, MGRS.
+--   * Various other options.
+--   
+-- ===
+-- 
+-- ### Author: **FlightControl**
+-- 
+-- ### Contributions: 
+-- 
+-- ===
+-- 
+-- @module Tasking.Task_Zone_Capture_Dispatcher
+-- @image Task_Zone_Capture_Dispatcher.JPG
+
+do -- TASK_CAPTURE_DISPATCHER
+
+  --- TASK_CAPTURE_DISPATCHER class.
+  -- @type TASK_CAPTURE_DISPATCHER
+  -- @extends Tasking.Task_Manager#TASK_MANAGER
+  -- @field TASK_CAPTURE_DISPATCHER.ZONE ZONE
+
+  --- @type TASK_CAPTURE_DISPATCHER.CSAR
+  -- @field Wrapper.Unit#UNIT PilotUnit
+  -- @field Tasking.Task#TASK Task
+  
+
+  --- Implements the dynamic dispatching of capture zone tasks.
+  -- 
+  -- The **TASK_CAPTURE_DISPATCHER** allows you to setup various tasks for let human
+  -- players capture zones in a co-operation effort. 
+  --  
+  -- Let's explore **step by step** how to setup the task capture zone dispatcher.
+  -- 
+  -- # 1. Setup a mission environment.
+  -- 
+  -- It is easy, as it works just like any other task setup, so setup a command center and a mission.
+  -- 
+  -- ## 1.1. Create a command center.
+  -- 
+  -- First you need to create a command center using the @{Tasking.CommandCenter#COMMANDCENTER.New}() constructor.
+  -- The command assumes that you´ve setup a group in the mission editor with the name HQ.
+  -- This group will act as the command center object.
+  -- It is a good practice to mark this group as invisible and invulnerable.
+  -- 
+  --     local CommandCenter = COMMANDCENTER
+  --        :New( GROUP:FindByName( "HQ" ), "HQ" ) -- Create the CommandCenter.
+  --     
+  -- ## 1.2. Create a mission.
+  -- 
+  -- Tasks work in a **mission**, which groups these tasks to achieve a joint **mission goal**. A command center can **govern multiple missions**.
+  -- 
+  -- Create a new mission, using the @{Tasking.Mission#MISSION.New}() constructor.
+  -- 
+  --     -- Declare the Mission for the Command Center.
+  --     local Mission = MISSION
+  --       :New( CommandCenter, 
+  --             "Overlord", 
+  --             "High", 
+  --             "Capture the blue zones.", 
+  --             coalition.side.RED 
+  --           ) 
+  -- 
+  -- 
+  -- # 2. Dispatch a **capture zone** task.
+  -- 
+  -- So, now that we have a command center and a mission, we now create the capture zone task.
+  -- We create the capture zone task using the @{#TASK_CAPTURE_DISPATCHER.AddCaptureZoneTask}() constructor.
+  -- 
+  -- ## 2.1. Create the capture zones.
+  -- 
+  -- Because a capture zone task will not generate the capture zones, you'll need to create them first.
+  -- 
+  --     
+  --     -- We define here a capture zone; of the type ZONE_CAPTURE_COALITION.
+  --     -- The zone to be captured has the name Alpha, and was defined in the mission editor as a trigger zone.
+  --     CaptureZone = ZONE:New( "Alpha" )
+  --     CaptureZoneCoalitionApha = ZONE_CAPTURE_COALITION:New( CaptureZone, coalition.side.RED )
+  -- 
+  -- ## 2.2. Create a set of player groups.
+  --    
+  -- What is also needed, is to have a set of @{Core.Group}s defined that contains the clients of the players.
+  -- 
+  --     -- Allocate the player slots, which must be aircraft (airplanes or helicopters), that can be manned by players.
+  --     -- We use the method FilterPrefixes to filter those player groups that have client slots, as defined in the mission editor.
+  --     -- In this example, we filter the groups where the name starts with "Blue Player", which captures the blue player slots.
+  --     local PlayerGroupSet = SET_GROUP:New():FilterPrefixes( "Blue Player" ):FilterStart()
+  -- 
+  -- ## 2.3. Setup the capture zone task.
+  -- 
+  -- First, we need to create a TASK_CAPTURE_DISPATCHER object.
+  -- 
+  --     TaskCaptureZoneDispatcher = TASK_CAPTURE_DISPATCHER:New( Mission, PilotGroupSet )
+  -- 
+  -- So, the variable `TaskCaptureZoneDispatcher` will contain the object of class TASK_CAPTURE_DISPATCHER, 
+  -- which will allow you to dispatch capture zone tasks:
+  --  
+  --   * for mission `Mission`, as was defined in section 1.2.
+  --   * for the group set `PilotGroupSet`, as was defined in section 2.2.
+  -- 
+  -- Now that we have `TaskDispatcher` object, we can now **create the TaskCaptureZone**, using the @{#TASK_CAPTURE_DISPATCHER.AddCaptureZoneTask}() method!
+  -- 
+  --     local TaskCaptureZone = TaskCaptureZoneDispatcher:AddCaptureZoneTask( 
+  --       "Capture zone Alpha", 
+  --       CaptureZoneCoalitionAlpha, 
+  --       "Fly to zone Alpha and eliminate all enemy forces to capture it." )
+  -- 
+  -- As a result of this code, the `TaskCaptureZone` (returned) variable will contain an object of @{#TASK_CAPTURE_ZONE}!
+  -- We pass to the method the title of the task, and the `CaptureZoneCoalitionAlpha`, which is the zone to be captured, as defined in section 2.1!
+  -- This returned `TaskCaptureZone` object can now be used to setup additional task configurations, or to control this specific task with special events.
+  -- 
+  -- And you're done! As you can see, it is a small bit of work, but the reward is great.
+  -- And, because all this is done using program interfaces, you can easily build a mission to capture zones yourself!
+  -- Based on various events happening within your mission, you can use the above methods to create new capture zones, 
+  -- and setup a new capture zone task and assign it to a group of players, while your mission is running!
+  -- 
+  --     
+  -- 
+  -- @field #TASK_CAPTURE_DISPATCHER
+  TASK_CAPTURE_DISPATCHER = {
+    ClassName = "TASK_CAPTURE_DISPATCHER",
+    Mission = nil,
+    Tasks = {},
+    Zones = {},
+    ZoneCount = 0,
+  }
+
+
+  
+  TASK_CAPTURE_DISPATCHER.AI_A2G_Dispatcher = nil -- AI.AI_A2G_Dispatcher#AI_A2G_DISPATCHER
+  
+  --- TASK_CAPTURE_DISPATCHER constructor.
+  -- @param #TASK_CAPTURE_DISPATCHER self
+  -- @param Tasking.Mission#MISSION Mission The mission for which the task dispatching is done.
+  -- @param Core.Set#SET_GROUP SetGroup The set of groups that can join the tasks within the mission.
+  -- @return #TASK_CAPTURE_DISPATCHER self
+  function TASK_CAPTURE_DISPATCHER:New( Mission, SetGroup )
+  
+    -- Inherits from DETECTION_MANAGER
+    local self = BASE:Inherit( self, TASK_MANAGER:New( SetGroup ) ) -- #TASK_CAPTURE_DISPATCHER
+    
+    self.Mission = Mission
+    
+    self:AddTransition( "Started", "Assign", "Started" )
+    self:AddTransition( "Started", "ZoneCaptured", "Started" )
+    
+    self:__StartTasks( 5 )
+    
+    return self
+  end
+
+
+  --- Link a task capture dispatcher from the other coalition to understand its plan for defenses.
+  -- This is used for the tactical overview, so the players also know the zones attacked by the other coalition!
+  -- @param #TASK_CAPTURE_DISPATCHER self
+  -- @param #TASK_CAPTURE_DISPATCHER DefenseTaskCaptureDispatcher
+  function TASK_CAPTURE_DISPATCHER:SetDefenseTaskCaptureDispatcher( DefenseTaskCaptureDispatcher )
+  
+    self.DefenseTaskCaptureDispatcher = DefenseTaskCaptureDispatcher
+  end
+
+
+  --- Get the linked task capture dispatcher from the other coalition to understand its plan for defenses.
+  -- This is used for the tactical overview, so the players also know the zones attacked by the other coalition!
+  -- @param #TASK_CAPTURE_DISPATCHER self
+  -- @return #TASK_CAPTURE_DISPATCHER
+  function TASK_CAPTURE_DISPATCHER:GetDefenseTaskCaptureDispatcher()
+  
+    return self.DefenseTaskCaptureDispatcher
+  end
+
+
+  --- Link an AI A2G dispatcher from the other coalition to understand its plan for defenses.
+  -- This is used for the tactical overview, so the players also know the zones attacked by the other AI A2G dispatcher!
+  -- @param #TASK_CAPTURE_DISPATCHER self
+  -- @param AI.AI_A2G_Dispatcher#AI_A2G_DISPATCHER DefenseAIA2GDispatcher
+  function TASK_CAPTURE_DISPATCHER:SetDefenseAIA2GDispatcher( DefenseAIA2GDispatcher )
+  
+    self.DefenseAIA2GDispatcher = DefenseAIA2GDispatcher
+  end
+
+
+  --- Get the linked AI A2G dispatcher from the other coalition to understand its plan for defenses.
+  -- This is used for the tactical overview, so the players also know the zones attacked by the AI A2G dispatcher!
+  -- @param #TASK_CAPTURE_DISPATCHER self
+  -- @return AI.AI_A2G_Dispatcher#AI_A2G_DISPATCHER
+  function TASK_CAPTURE_DISPATCHER:GetDefenseAIA2GDispatcher()
+  
+    return self.DefenseAIA2GDispatcher
+  end
+
+
+  --- Add a capture zone task.
+  -- @param #TASK_CAPTURE_DISPATCHER self
+  -- @param #string TaskPrefix (optional) The prefix of the capture zone task. 
+  -- If no TaskPrefix is given, then "Capture" will be used as the TaskPrefix. 
+  -- The TaskPrefix will be appended with a . + a number of 3 digits, if the TaskPrefix already exists in the task collection.
+  -- @param Functional.CaptureZoneCoalition#ZONE_CAPTURE_COALITION CaptureZone The zone of the coalition to be captured as the task goal.
+  -- @param #string Briefing The briefing of the task to be shown to the player.
+  -- @return Tasking.Task_Capture_Zone#TASK_CAPTURE_ZONE
+  -- @usage
+  -- 
+  --  
+  function TASK_CAPTURE_DISPATCHER:AddCaptureZoneTask( TaskPrefix, CaptureZone, Briefing )
+
+    local TaskName = TaskPrefix or "Capture"
+    if self.Zones[TaskName] then
+      self.ZoneCount = self.ZoneCount + 1
+      TaskName = string.format( "%s.%03d", TaskName, self.ZoneCount )
+    end
+    
+    self.Zones[TaskName] = {} 
+    self.Zones[TaskName].CaptureZone = CaptureZone
+    self.Zones[TaskName].Briefing = Briefing
+    self.Zones[TaskName].Task = nil
+    self.Zones[TaskName].TaskPrefix = TaskPrefix
+    
+    self:ManageTasks()
+    
+    return self.Zones[TaskName] and self.Zones[TaskName].Task
+  end
+
+
+  --- Link an AI_A2G_DISPATCHER to the TASK_CAPTURE_DISPATCHER.
+  -- @param #TASK_CAPTURE_DISPATCHER self
+  -- @param AI.AI_A2G_Dispatcher#AI_A2G_DISPATCHER AI_A2G_Dispatcher The AI Dispatcher to be linked to the tasking. 
+  -- @return Tasking.Task_Capture_Zone#TASK_CAPTURE_ZONE
+  function TASK_CAPTURE_DISPATCHER:Link_AI_A2G_Dispatcher( AI_A2G_Dispatcher )
+
+    self.AI_A2G_Dispatcher = AI_A2G_Dispatcher -- AI.AI_A2G_Dispatcher#AI_A2G_DISPATCHER
+    AI_A2G_Dispatcher.Detection:LockDetectedItems()
+
+    return self
+  end
+
+
+  --- Assigns tasks to the @{Core.Set#SET_GROUP}.
+  -- @param #TASK_CAPTURE_DISPATCHER self
+  -- @return #boolean Return true if you want the task assigning to continue... false will cancel the loop.
+  function TASK_CAPTURE_DISPATCHER:ManageTasks()
+    self:F()
+  
+    local AreaMsg = {}
+    local TaskMsg = {}
+    local ChangeMsg = {}
+    
+    local Mission = self.Mission
+    
+    if Mission:IsIDLE() or Mission:IsENGAGED() then
+    
+      local TaskReport = REPORT:New()
+      
+      -- Checking the task queue for the dispatcher, and removing any obsolete task!
+      for TaskIndex, TaskData in pairs( self.Tasks ) do
+        local Task = TaskData -- Tasking.Task#TASK
+        if Task:IsStatePlanned() then
+        -- Here we need to check if the pilot is still existing.
+--            Task = self:RemoveTask( TaskIndex )
+        end
+        
+      end
+
+      -- Now that all obsolete tasks are removed, loop through the Zone tasks.
+      for TaskName, CaptureZone in pairs( self.Zones ) do
+        
+        if not CaptureZone.Task then
+          -- New Transport Task
+          CaptureZone.Task = TASK_CAPTURE_ZONE:New( Mission, self.SetGroup, TaskName, CaptureZone.CaptureZone, CaptureZone.Briefing )
+          CaptureZone.Task.TaskPrefix = CaptureZone.TaskPrefix -- We keep the TaskPrefix for further reference!
+          Mission:AddTask( CaptureZone.Task )
+          TaskReport:Add( TaskName )
+          
+          -- Link the Task Dispatcher to the capture zone task, because it is used on the UpdateTaskInfo.
+          CaptureZone.Task:SetDispatcher( self )
+          CaptureZone.Task:UpdateTaskInfo()
+
+          function CaptureZone.Task.OnEnterAssigned( Task, From, Event, To )
+            if self.AI_A2G_Dispatcher then
+              self.AI_A2G_Dispatcher:Unlock( Task.TaskZoneName ) -- This will unlock the zone to be defended by AI.
+            end        
+            CaptureZone.Task:UpdateTaskInfo()
+            CaptureZone.Task.ZoneGoal.Attacked = true
+          end
+          
+          function CaptureZone.Task.OnEnterSuccess( Task, From, Event, To )
+            --self:Success( Task )
+            if self.AI_A2G_Dispatcher then
+              self.AI_A2G_Dispatcher:Lock( Task.TaskZoneName ) -- This will lock the zone from being defended by AI.
+            end
+            CaptureZone.Task:UpdateTaskInfo()
+            CaptureZone.Task.ZoneGoal.Attacked = false
+          end
+
+          function CaptureZone.Task.OnEnterCancelled( Task, From, Event, To )
+            self:Cancelled( Task )
+            if self.AI_A2G_Dispatcher then
+              self.AI_A2G_Dispatcher:Lock( Task.TaskZoneName ) -- This will lock the zone from being defended by AI.
+            end
+            CaptureZone.Task:UpdateTaskInfo()
+            CaptureZone.Task.ZoneGoal.Attacked = false
+          end
+            
+          function CaptureZone.Task.OnEnterFailed( Task, From, Event, To )
+            self:Failed( Task )
+            if self.AI_A2G_Dispatcher then
+              self.AI_A2G_Dispatcher:Lock( Task.TaskZoneName ) -- This will lock the zone from being defended by AI.
+            end
+            CaptureZone.Task:UpdateTaskInfo()
+            CaptureZone.Task.ZoneGoal.Attacked = false
+          end
+
+          function CaptureZone.Task.OnEnterAborted( Task, From, Event, To )
+            self:Aborted( Task )
+            if self.AI_A2G_Dispatcher then
+              self.AI_A2G_Dispatcher:Lock( Task.TaskZoneName ) -- This will lock the zone from being defended by AI.
+            end
+            CaptureZone.Task:UpdateTaskInfo()
+            CaptureZone.Task.ZoneGoal.Attacked = false
+          end
+
+          -- Now broadcast the onafterCargoPickedUp event to the Task Cargo Dispatcher.
+          function CaptureZone.Task.OnAfterCaptured( Task, From, Event, To, TaskUnit )
+            self:Captured( Task, Task.TaskPrefix, TaskUnit )
+            if self.AI_A2G_Dispatcher then
+              self.AI_A2G_Dispatcher:Lock( Task.TaskZoneName ) -- This will lock the zone from being defended by AI.
+            end
+            CaptureZone.Task:UpdateTaskInfo()
+            CaptureZone.Task.ZoneGoal.Attacked = false
+          end
+
+        end
+        
+      end
+      
+      
+      -- TODO set menus using the HQ coordinator
+      Mission:GetCommandCenter():SetMenu()
+
+      local TaskText = TaskReport:Text(", ")
+      
+      for TaskGroupID, TaskGroup in pairs( self.SetGroup:GetSet() ) do
+        if ( not Mission:IsGroupAssigned(TaskGroup) ) and TaskText ~= "" then
+          Mission:GetCommandCenter():MessageToGroup( string.format( "%s has tasks %s. Subscribe to a task using the radio menu.", Mission:GetShortText(), TaskText ), TaskGroup )
+        end
+      end
+      
+    end
+    
+    return true
+  end
+
+end

Moose Development/Moose/Tasking/Task_Capture_Zone.lua

@@ -47,7 +47,7 @@ do -- TASK_ZONE_GOAL
   -- @param Tasking.Mission#MISSION Mission
   -- @param Core.Set#SET_GROUP SetGroup The set of groups for which the Task can be assigned.
   -- @param #string TaskName The name of the Task.
-  -- @param Core.ZoneGoal#ZONE_GOAL ZoneGoal
+  -- @param Core.ZoneGoalCoalition#ZONE_GOAL_COALITION ZoneGoal
   -- @return #TASK_ZONE_GOAL self
   function TASK_ZONE_GOAL:New( Mission, SetGroup, TaskName, ZoneGoal, TaskType, TaskBriefing )
     local self = BASE:Inherit( self, TASK:New( Mission, SetGroup, TaskName, TaskType, TaskBriefing ) ) -- #TASK_ZONE_GOAL
@@ -59,19 +59,25 @@ do -- TASK_ZONE_GOAL
     local Fsm = self:GetUnitProcess()
     
 
-    Fsm:AddProcess   ( "Planned", "Accept", ACT_ASSIGN_ACCEPT:New( self.TaskBriefing ), { Assigned = "StartMonitoring", Rejected = "Reject" }  )
-    
     Fsm:AddTransition( "Assigned", "StartMonitoring", "Monitoring" )
     Fsm:AddTransition( "Monitoring", "Monitor", "Monitoring", {} )
-    Fsm:AddTransition( "Monitoring", "RouteTo", "Monitoring" )
     Fsm:AddProcess( "Monitoring", "RouteToZone", ACT_ROUTE_ZONE:New(), {} )
     
-    --Fsm:AddTransition( "Accounted", "DestroyedAll", "Accounted" )
-    --Fsm:AddTransition( "Accounted", "Success", "Success" )
     Fsm:AddTransition( "Rejected", "Reject", "Aborted" )
     Fsm:AddTransition( "Failed", "Fail", "Failed" )
     
     self:SetTargetZone( self.ZoneGoal:GetZone() )
+
+    --- Test 
+    -- @param #FSM_PROCESS self
+    -- @param Wrapper.Unit#UNIT TaskUnit
+    -- @param Tasking.Task#TASK Task
+    function Fsm:OnAfterAssigned( TaskUnit, Task )
+      self:F( { TaskUnit = TaskUnit, Task = Task and Task:GetClassNameAndID() } )
+      
+      self:__StartMonitoring( 0.1 )
+      self:__RouteToZone( 0.1 )
+    end
     
     --- Test 
     -- @param #FSM_PROCESS self
@@ -80,7 +86,6 @@ do -- TASK_ZONE_GOAL
     function Fsm:onafterStartMonitoring( TaskUnit, Task )
       self:F( { self } )
       self:__Monitor( 0.1 )
-      self:__RouteTo( 0.1 )
     end
     
     --- Monitor Loop
@@ -101,7 +106,7 @@ do -- TASK_ZONE_GOAL
       -- Determine the first Unit from the self.TargetSetUnit
       
       if Task:GetTargetZone( TaskUnit ) then
-        self:__RouteTo( 0.1 )
+        self:__RouteToZone( 0.1 )
       end
     end
 
@@ -160,37 +165,37 @@ do -- TASK_ZONE_GOAL
 end 
 
 
-do -- TASK_ZONE_CAPTURE
+do -- TASK_CAPTURE_ZONE
 
-  --- The TASK_ZONE_CAPTURE class
-  -- @type TASK_ZONE_CAPTURE
+  --- The TASK_CAPTURE_ZONE class
+  -- @type TASK_CAPTURE_ZONE
   -- @field Core.ZoneGoalCoalition#ZONE_GOAL_COALITION ZoneGoal
   -- @extends #TASK_ZONE_GOAL
 
-  --- # TASK_ZONE_CAPTURE class, extends @{Tasking.TaskZoneGoal#TASK_ZONE_GOAL}
+  --- # TASK_CAPTURE_ZONE class, extends @{Tasking.TaskZoneGoal#TASK_ZONE_GOAL}
   -- 
-  -- The TASK_ZONE_CAPTURE class defines an Suppression or Extermination of Air Defenses task for a human player to be executed.
+  -- The TASK_CAPTURE_ZONE class defines an Suppression or Extermination of Air Defenses task for a human player to be executed.
   -- These tasks are important to be executed as they will help to achieve air superiority at the vicinity.
   -- 
-  -- The TASK_ZONE_CAPTURE is used by the @{Tasking.Task_A2G_Dispatcher#TASK_A2G_DISPATCHER} to automatically create SEAD tasks 
+  -- The TASK_CAPTURE_ZONE is used by the @{Tasking.Task_A2G_Dispatcher#TASK_A2G_DISPATCHER} to automatically create SEAD tasks 
   -- based on detected enemy ground targets.
   -- 
-  -- @field #TASK_ZONE_CAPTURE
-  TASK_ZONE_CAPTURE = {
-    ClassName = "TASK_ZONE_CAPTURE",
+  -- @field #TASK_CAPTURE_ZONE
+  TASK_CAPTURE_ZONE = {
+    ClassName = "TASK_CAPTURE_ZONE",
   }
   
 
-  --- Instantiates a new TASK_ZONE_CAPTURE.
-  -- @param #TASK_ZONE_CAPTURE self
+  --- Instantiates a new TASK_CAPTURE_ZONE.
+  -- @param #TASK_CAPTURE_ZONE self
   -- @param Tasking.Mission#MISSION Mission
   -- @param Core.Set#SET_GROUP SetGroup The set of groups for which the Task can be assigned.
   -- @param #string TaskName The name of the Task.
   -- @param Core.ZoneGoalCoalition#ZONE_GOAL_COALITION ZoneGoalCoalition
   -- @param #string TaskBriefing The briefing of the task.
-  -- @return #TASK_ZONE_CAPTURE self
-  function TASK_ZONE_CAPTURE:New( Mission, SetGroup, TaskName, ZoneGoalCoalition, TaskBriefing)
-    local self = BASE:Inherit( self, TASK_ZONE_GOAL:New( Mission, SetGroup, TaskName, ZoneGoalCoalition, "CAPTURE", TaskBriefing ) ) -- #TASK_ZONE_CAPTURE
+  -- @return #TASK_CAPTURE_ZONE self
+  function TASK_CAPTURE_ZONE:New( Mission, SetGroup, TaskName, ZoneGoalCoalition, TaskBriefing)
+    local self = BASE:Inherit( self, TASK_ZONE_GOAL:New( Mission, SetGroup, TaskName, ZoneGoalCoalition, "CAPTURE", TaskBriefing ) ) -- #TASK_CAPTURE_ZONE
     self:F()
     
     Mission:AddTask( self )
@@ -206,42 +211,84 @@ do -- TASK_ZONE_CAPTURE
       "Capture Zone " .. self.TaskZoneName
     )
     
-    self:UpdateTaskInfo()
+    self:UpdateTaskInfo( true )
+    
+    self:SetGoal( self.ZoneGoal.Goal )
 
     return self
   end 
 
 
-  --- Instantiates a new TASK_ZONE_CAPTURE.
-  -- @param #TASK_ZONE_CAPTURE self
-  function TASK_ZONE_CAPTURE:UpdateTaskInfo() 
-
-
+  --- Instantiates a new TASK_CAPTURE_ZONE.
+  -- @param #TASK_CAPTURE_ZONE self
+  function TASK_CAPTURE_ZONE:UpdateTaskInfo( Persist ) 
+  
+    Persist = Persist or false
+  
     local ZoneCoordinate = self.ZoneGoal:GetZone():GetCoordinate() 
-    self.TaskInfo:AddCoordinate( ZoneCoordinate, 0, "SOD" )
-    self.TaskInfo:AddText( "Zone Name", self.ZoneGoal:GetZoneName(), 10, "MOD" )
-    self.TaskInfo:AddText( "Zone Coalition", self.ZoneGoal:GetCoalitionName(), 11, "MOD" )
+    self.TaskInfo:AddTaskName( 0, "MSOD", Persist )
+    self.TaskInfo:AddCoordinate( ZoneCoordinate, 1, "SOD", Persist )
+--    self.TaskInfo:AddText( "Zone Name", self.ZoneGoal:GetZoneName(), 10, "MOD", Persist )
+--    self.TaskInfo:AddText( "Zone Coalition", self.ZoneGoal:GetCoalitionName(), 11, "MOD", Persist )
+    local SetUnit = self.ZoneGoal:GetScannedSetUnit()
+    local ThreatLevel, ThreatText = SetUnit:CalculateThreatLevelA2G()
+    local ThreatCount = SetUnit:Count()
+    self.TaskInfo:AddThreat( ThreatText, ThreatLevel, 20, "MOD", Persist )
+    self.TaskInfo:AddInfo( "Remaining Units", ThreatCount, 21, "MOD", Persist, true)
+    
+    if self.Dispatcher then
+      local DefenseTaskCaptureDispatcher = self.Dispatcher:GetDefenseTaskCaptureDispatcher() -- Tasking.Task_Capture_Dispatcher#TASK_CAPTURE_DISPATCHER
+      
+      if DefenseTaskCaptureDispatcher then
+        -- Loop through all zones of the player Defenses, and check which zone has an assigned task!
+        -- The Zones collection contains a Task. This Task is checked if it is assigned.
+        -- If Assigned, then this task will be the task that is the closest to the defense zone.
+        for TaskName, CaptureZone in pairs( DefenseTaskCaptureDispatcher.Zones or {} ) do
+          local Task = CaptureZone.Task -- Tasking.Task_Capture_Zone#TASK_CAPTURE_ZONE
+          if Task  and Task:IsStateAssigned() then -- We also check assigned.
+            -- Now we register the defense player zone information to the task report.
+            self.TaskInfo:AddInfo( "Defense Player Zone", Task.ZoneGoal:GetName(), 30, "MOD", Persist ) 
+            self.TaskInfo:AddCoordinate( Task.ZoneGoal:GetZone():GetCoordinate(), 31, "MOD", Persist, false, "Defense Player Coordinate" )
+          end
+        end
+      end
+      local DefenseAIA2GDispatcher = self.Dispatcher:GetDefenseAIA2GDispatcher() -- AI.AI_A2G_Dispatcher#AI_A2G_DISPATCHER
+      
+      if DefenseAIA2GDispatcher then
+        -- Loop through all the tasks of the AI Defenses, and check which zone is involved in the defenses and is active!
+        for Defender, Task in pairs( DefenseAIA2GDispatcher:GetDefenderTasks() or {} ) do
+          local DetectedItem = DefenseAIA2GDispatcher:GetDefenderTaskTarget( Defender )
+          if DetectedItem then
+            local DetectedZone = DefenseAIA2GDispatcher.Detection:GetDetectedItemZone( DetectedItem )
+            if DetectedZone then
+              self.TaskInfo:AddInfo( "Defense AI Zone", DetectedZone:GetName(), 40, "MOD", Persist  )
+              self.TaskInfo:AddCoordinate( DetectedZone:GetCoordinate(), 41, "MOD", Persist, false, "Defense AI Coordinate" )
+            end
+          end
+        end
+      end
+    end
+    
   end
     
 
-  function TASK_ZONE_CAPTURE:ReportOrder( ReportGroup ) 
-    local Coordinate = self:GetData( "Coordinate" )
-    --local Coordinate = self.TaskInfo.Coordinates.TaskInfoText
+  function TASK_CAPTURE_ZONE:ReportOrder( ReportGroup ) 
+
+    local Coordinate = self.TaskInfo:GetCoordinate()
     local Distance = ReportGroup:GetCoordinate():Get2DDistance( Coordinate )
     
     return Distance
   end
   
   
-  --- @param #TASK_ZONE_CAPTURE self
+  --- @param #TASK_CAPTURE_ZONE self
   -- @param Wrapper.Unit#UNIT TaskUnit
-  function TASK_ZONE_CAPTURE:OnAfterGoal( From, Event, To, PlayerUnit, PlayerName )
+  function TASK_CAPTURE_ZONE:OnAfterGoal( From, Event, To, PlayerUnit, PlayerName )
   
-    self:F( { PlayerUnit = PlayerUnit } )
+    self:F( { PlayerUnit = PlayerUnit, Achieved = self.ZoneGoal.Goal:IsAchieved() } )
     
     if self.ZoneGoal then
       if self.ZoneGoal.Goal:IsAchieved() then
-        self:Success()
         local TotalContributions = self.ZoneGoal.Goal:GetTotalContributions()
         local PlayerContributions = self.ZoneGoal.Goal:GetPlayerContributions()
         self:F( { TotalContributions = TotalContributions, PlayerContributions = PlayerContributions } )
@@ -251,11 +298,32 @@ do -- TASK_ZONE_CAPTURE
              Scoring:_AddMissionGoalScore( self.Mission, PlayerName, "Zone " .. self.ZoneGoal:GetZoneName() .." captured", PlayerContribution * 200 / TotalContributions )
            end
         end
+        self:Success()
       end
     end
     
     self:__Goal( -10, PlayerUnit, PlayerName )
   end
 
+  --- This function is called from the @{Tasking.CommandCenter#COMMANDCENTER} to determine the method of automatic task selection.
+  -- @param #TASK_CAPTURE_ZONE self
+  -- @param #number AutoAssignMethod The method to be applied to the task.
+  -- @param Tasking.CommandCenter#COMMANDCENTER CommandCenter The command center.
+  -- @param Wrapper.Group#GROUP TaskGroup The player group.
+  function TASK_CAPTURE_ZONE:GetAutoAssignPriority( AutoAssignMethod, CommandCenter, TaskGroup, AutoAssignReference )
+  
+    if     AutoAssignMethod == COMMANDCENTER.AutoAssignMethods.Random then
+      return math.random( 1, 9 )
+    elseif AutoAssignMethod == COMMANDCENTER.AutoAssignMethods.Distance then
+      local Coordinate = self.TaskInfo:GetCoordinate()
+      local Distance = Coordinate:Get2DDistance( CommandCenter:GetPositionable():GetCoordinate() )
+      return math.floor( Distance )
+    elseif AutoAssignMethod == COMMANDCENTER.AutoAssignMethods.Priority then
+      return 1
+    end
+
+    return 0
+  end
+
 end
 

Moose Development/Moose/Tasking/Task_Cargo_CSAR.lua

@@ -152,6 +152,114 @@ do -- TASK_CARGO_CSAR
   -- It is better you use the cargo dispatcher to generate CSAR tasks and it will work as it is intended.
   -- By doing this, CSAR tasking will become a dynamic experience.
   -- 
+  -- # 2) Create a task using the @{Tasking.Task_Cargo_Dispatcher} module.
+  -- 
+  -- Actually, it is better to **GENERATE** these tasks using the @{Tasking.Task_Cargo_Dispatcher} module.
+  -- Using the dispatcher module, transport tasks can be created much more easy.
+  -- 
+  -- Find below an example how to use the TASK_CARGO_DISPATCHER class:
+  -- 
+  -- 
+  --      -- Find the HQ group.
+  --      HQ = GROUP:FindByName( "HQ", "Bravo" )
+  --    
+  --      -- Create the command center with the name "Lima".
+  --      CommandCenter = COMMANDCENTER
+  --        :New( HQ, "Lima" )
+  --    
+  --      -- Create the mission, for the command center, with the name "CSAR Mission", a "Tactical" mission, with the mission briefing "Rescue downed pilots.", for the RED coalition.
+  --      Mission = MISSION
+  --        :New( CommandCenter, "CSAR Mission", "Tactical", "Rescue downed pilots.", coalition.side.RED )
+  --    
+  --      -- Create the SET of GROUPs containing clients (players) that will transport the cargo.
+  --      -- These are have a name that start with "Rescue" and are of the "red" coalition.
+  --      AttackGroups = SET_GROUP:New():FilterCoalitions( "red" ):FilterPrefixes( "Rescue" ):FilterStart()
+  --    
+  --    
+  --      -- Here we create the TASK_CARGO_DISPATCHER object! This is where we assign the dispatcher to generate tasks in the Mission for the AttackGroups.
+  --      TaskDispatcher = TASK_CARGO_DISPATCHER:New( Mission, AttackGroups )
+  --    
+  --      
+  --      -- Here the task dispatcher will generate automatically CSAR tasks once a pilot ejects.
+  --      TaskDispatcher:StartCSARTasks( 
+  --        "CSAR", 
+  --        { ZONE_UNIT:New( "Hospital", STATIC:FindByName( "Hospital" ), 100 ) }, 
+  --        "One of our pilots has ejected. Go out to Search and Rescue our pilot!\n" .. 
+  --        "Use the radio menu to let the command center assist you with the CSAR tasking."
+  --      )
+  -- 
+  -- # 3) Handle cargo task events.
+  -- 
+  -- When a player is picking up and deploying cargo using his carrier, events are generated by the tasks. These events can be captured and tailored with your own code.
+  -- 
+  -- In order to properly capture the events and avoid mistakes using the documentation, it is advised that you execute the following actions:
+  -- 
+  --   * **Copy / Paste** the code section into your script.
+  --   * **Change** the CLASS literal to the task object name you have in your script.
+  --   * Within the function, you can now **write your own code**!
+  --   * **IntelliSense** will recognize the type of the variables provided by the function. Note: the From, Event and To variables can be safely ignored, 
+  --     but you need to declare them as they are automatically provided by the event handling system of MOOSE.
+  -- 
+  -- You can send messages or fire off any other events within the code section. The sky is the limit!
+  -- 
+  -- NOTE: CSAR tasks are actually automatically created by the TASK_CARGO_DISPATCHER. So the underlying is not really applicable for mission designers as they will use the dispatcher instead
+  -- of capturing these events from manually created CSAR tasks!
+  -- 
+  -- ## 3.1) Handle the **CargoPickedUp** event.
+  -- 
+  -- Find below an example how to tailor the **CargoPickedUp** event, generated by the CSARTask:
+  -- 
+  --      function CSARTask:OnAfterCargoPickedUp( From, Event, To, TaskUnit, Cargo )
+  --        
+  --        MESSAGE:NewType( "Unit " .. TaskUnit:GetName().. " has picked up cargo.", MESSAGE.Type.Information ):ToAll()
+  --        
+  --      end
+  -- 
+  -- If you want to code your own event handler, use this code fragment to tailor the event when a player carrier has picked up a cargo object in the CarrierGroup.
+  -- You can use this event handler to post messages to players, or provide status updates etc.
+  -- 
+  --      --- CargoPickedUp event handler OnAfter for CLASS.
+  --      -- @param #CLASS self
+  --      -- @param #string From A string that contains the "*from state name*" when the event was triggered.
+  --      -- @param #string Event A string that contains the "*event name*" when the event was triggered.
+  --      -- @param #string To A string that contains the "*to state name*" when the event was triggered.
+  --      -- @param Wrapper.Unit#UNIT TaskUnit The unit (client) of the player that has picked up the cargo.
+  --      -- @param Cargo.Cargo#CARGO Cargo The cargo object that has been picked up. Note that this can be a CARGO_GROUP, CARGO_CRATE or CARGO_SLINGLOAD object!
+  --      function CLASS:OnAfterCargoPickedUp( From, Event, To, TaskUnit, Cargo )
+  --      
+  --        -- Write here your own code.
+  --      
+  --      end
+  -- 
+  -- 
+  -- ## 3.2) Handle the **CargoDeployed** event.
+  -- 
+  -- Find below an example how to tailor the **CargoDeployed** event, generated by the CSARTask:
+  -- 
+  --      function CSARTask:OnAfterCargoDeployed( From, Event, To, TaskUnit, Cargo, DeployZone )
+  --        
+  --        MESSAGE:NewType( "Unit " .. TaskUnit:GetName().. " has deployed cargo at zone " .. DeployZone:GetName(), MESSAGE.Type.Information ):ToAll()
+  --        
+  --      end
+  -- 
+  -- If you want to code your own event handler, use this code fragment to tailor the event when a player carrier has deployed a cargo object from the CarrierGroup.
+  -- You can use this event handler to post messages to players, or provide status updates etc.
+  -- 
+  -- 
+  --      --- CargoDeployed event handler OnAfter for CLASS.
+  --      -- @param #CLASS self
+  --      -- @param #string From A string that contains the "*from state name*" when the event was triggered.
+  --      -- @param #string Event A string that contains the "*event name*" when the event was triggered.
+  --      -- @param #string To A string that contains the "*to state name*" when the event was triggered.
+  --      -- @param Wrapper.Unit#UNIT TaskUnit The unit (client) of the player that has deployed the cargo.
+  --      -- @param Cargo.Cargo#CARGO Cargo The cargo object that has been deployed. Note that this can be a CARGO_GROUP, CARGO_CRATE or CARGO_SLINGLOAD object!
+  --      -- @param Core.Zone#ZONE DeployZone The zone wherein the cargo is deployed. This can be any zone type, like a ZONE, ZONE_GROUP, ZONE_AIRBASE.
+  --      function CLASS:OnAfterCargoDeployed( From, Event, To, TaskUnit, Cargo, DeployZone )
+  --      
+  --        -- Write here your own code.
+  --      
+  --      end
+  --      
   -- ===
   -- 
   -- @field #TASK_CARGO_CSAR
@@ -181,16 +289,6 @@ do -- TASK_CARGO_CSAR
     
     self:F( { CargoDeployed = self.CargoDeployed ~= nil and "true" or "false" } )
     
-      --- OnBefore Transition Handler for Event CargoPickedUp.
-      -- @function [parent=#TASK_CARGO_CSAR] OnBeforeCargoPickedUp
-      -- @param #TASK_CARGO_CSAR self
-      -- @param #string From The From State string.
-      -- @param #string Event The Event string.
-      -- @param #string To The To State string.
-      -- @param Wrapper.Unit#UNIT TaskUnit The Unit (Client) that PickedUp the cargo. You can use this to retrieve the PlayerName etc.
-      -- @param Core.Cargo#CARGO Cargo The Cargo that got PickedUp by the TaskUnit. You can use this to check Cargo Status.
-      -- @return #boolean Return false to cancel Transition.
-      
       --- OnAfter Transition Handler for Event CargoPickedUp.
       -- @function [parent=#TASK_CARGO_CSAR] OnAfterCargoPickedUp
       -- @param #TASK_CARGO_CSAR self
@@ -200,30 +298,6 @@ do -- TASK_CARGO_CSAR
       -- @param Wrapper.Unit#UNIT TaskUnit The Unit (Client) that PickedUp the cargo. You can use this to retrieve the PlayerName etc.
       -- @param Core.Cargo#CARGO Cargo The Cargo that got PickedUp by the TaskUnit. You can use this to check Cargo Status.
         
-      --- Synchronous Event Trigger for Event CargoPickedUp.
-      -- @function [parent=#TASK_CARGO_CSAR] CargoPickedUp
-      -- @param #TASK_CARGO_CSAR self
-      -- @param Wrapper.Unit#UNIT TaskUnit The Unit (Client) that PickedUp the cargo. You can use this to retrieve the PlayerName etc.
-      -- @param Core.Cargo#CARGO Cargo The Cargo that got PickedUp by the TaskUnit. You can use this to check Cargo Status.
-      
-      --- Asynchronous Event Trigger for Event CargoPickedUp.
-      -- @function [parent=#TASK_CARGO_CSAR] __CargoPickedUp
-      -- @param #TASK_CARGO_CSAR self
-      -- @param #number Delay The delay in seconds.
-      -- @param Wrapper.Unit#UNIT TaskUnit The Unit (Client) that PickedUp the cargo. You can use this to retrieve the PlayerName etc.
-      -- @param Core.Cargo#CARGO Cargo The Cargo that got PickedUp by the TaskUnit. You can use this to check Cargo Status.
-    
-      --- OnBefore Transition Handler for Event CargoDeployed.
-      -- @function [parent=#TASK_CARGO_CSAR] OnBeforeCargoDeployed
-      -- @param #TASK_CARGO_CSAR self
-      -- @param #string From The From State string.
-      -- @param #string Event The Event string.
-      -- @param #string To The To State string.
-      -- @param Wrapper.Unit#UNIT TaskUnit The Unit (Client) that Deployed the cargo. You can use this to retrieve the PlayerName etc.
-      -- @param Core.Cargo#CARGO Cargo The Cargo that got PickedUp by the TaskUnit. You can use this to check Cargo Status.
-      -- @param Core.Zone#ZONE DeployZone The zone where the Cargo got Deployed or UnBoarded.
-      -- @return #boolean Return false to cancel Transition.
-      
       --- OnAfter Transition Handler for Event CargoDeployed.
       -- @function [parent=#TASK_CARGO_CSAR] OnAfterCargoDeployed
       -- @param #TASK_CARGO_CSAR self
@@ -234,21 +308,6 @@ do -- TASK_CARGO_CSAR
       -- @param Core.Cargo#CARGO Cargo The Cargo that got PickedUp by the TaskUnit. You can use this to check Cargo Status.
       -- @param Core.Zone#ZONE DeployZone The zone where the Cargo got Deployed or UnBoarded.
         
-      --- Synchronous Event Trigger for Event CargoDeployed.
-      -- @function [parent=#TASK_CARGO_CSAR] CargoDeployed
-      -- @param #TASK_CARGO_CSAR self
-      -- @param Wrapper.Unit#UNIT TaskUnit The Unit (Client) that Deployed the cargo. You can use this to retrieve the PlayerName etc.
-      -- @param Core.Cargo#CARGO Cargo The Cargo that got PickedUp by the TaskUnit. You can use this to check Cargo Status.
-      -- @param Core.Zone#ZONE DeployZone The zone where the Cargo got Deployed or UnBoarded.
-      
-      --- Asynchronous Event Trigger for Event CargoDeployed.
-      -- @function [parent=#TASK_CARGO_CSAR] __CargoDeployed
-      -- @param #TASK_CARGO_CSAR self
-      -- @param #number Delay The delay in seconds.
-      -- @param Wrapper.Unit#UNIT TaskUnit The Unit (Client) that Deployed the cargo. You can use this to retrieve the PlayerName etc.
-      -- @param Core.Cargo#CARGO Cargo The Cargo that got PickedUp by the TaskUnit. You can use this to check Cargo Status.
-      -- @param Core.Zone#ZONE DeployZone The zone where the Cargo got Deployed or UnBoarded.
-
     local Fsm = self:GetUnitProcess()
 
     local CargoReport = REPORT:New( "Rescue a downed pilot from the following position:")
@@ -271,6 +330,8 @@ do -- TASK_CARGO_CSAR
     
     return self
   end 
+  
+
 
   function TASK_CARGO_CSAR:ReportOrder( ReportGroup ) 
     

Moose Development/Moose/Tasking/Task_Cargo_Dispatcher.lua

@@ -1,5 +1,58 @@
 --- **Tasking** - Creates and manages player TASK_CARGO tasks.
 -- 
+-- The **TASK_CARGO_DISPATCHER** allows you to setup various tasks for let human
+-- players transport cargo as part of a task. 
+--  
+-- The cargo dispatcher will implement for you mechanisms to create cargo transportation tasks:
+--  
+--   * As setup by the mission designer.
+--   * Dynamically create CSAR missions (when a pilot is downed as part of a downed plane).
+--   * Dynamically spawn new cargo and create cargo taskings!
+--   
+-- 
+--   
+-- **Specific features:**
+-- 
+--   * Creates a task to transport @{Cargo.Cargo} to and between deployment zones.
+--   * Derived from the TASK_CARGO class, which is derived from the TASK class.
+--   * Orchestrate the task flow, so go from Planned to Assigned to Success, Failed or Cancelled.
+--   * Co-operation tasking, so a player joins a group of players executing the same task.
+-- 
+-- 
+-- **A complete task menu system to allow players to:**
+--   
+--   * Join the task, abort the task.
+--   * Mark the task location on the map.
+--   * Provide details of the target.
+--   * Route to the cargo.
+--   * Route to the deploy zones.
+--   * Load/Unload cargo.
+--   * Board/Unboard cargo.
+--   * Slingload cargo.
+--   * Display the task briefing.
+--   
+--   
+-- **A complete mission menu system to allow players to:**
+--   
+--   * Join a task, abort the task.
+--   * Display task reports.
+--   * Display mission statistics.
+--   * Mark the task locations on the map.
+--   * Provide details of the targets.
+--   * Display the mission briefing.
+--   * Provide status updates as retrieved from the command center.
+--   * Automatically assign a random task as part of a mission.
+--   * Manually assign a specific task as part of a mission.
+--   
+--   
+--  **A settings system, using the settings menu:**
+--  
+--   * Tweak the duration of the display of messages.
+--   * Switch between metric and imperial measurement system.
+--   * Switch between coordinate formats used in messages: BR, BRA, LL DMS, LL DDM, MGRS.
+--   * Different settings modes for A2G and A2A operations.
+--   * Various other options.
+--   
 -- ===
 -- 
 -- ### Author: **FlightControl**
@@ -9,7 +62,7 @@
 -- ===
 -- 
 -- @module Tasking.Task_Cargo_Dispatcher
--- @image MOOSE.JPG
+-- @image Task_Cargo_Dispatcher.JPG
 
 do -- TASK_CARGO_DISPATCHER
 
@@ -17,6 +70,7 @@ do -- TASK_CARGO_DISPATCHER
   -- @type TASK_CARGO_DISPATCHER
   -- @extends Tasking.Task_Manager#TASK_MANAGER
   -- @field TASK_CARGO_DISPATCHER.CSAR CSAR
+  -- @field Core.Set#SET_ZONE SetZonesCSAR
 
   --- @type TASK_CARGO_DISPATCHER.CSAR
   -- @field Wrapper.Unit#UNIT PilotUnit
@@ -25,148 +79,292 @@ do -- TASK_CARGO_DISPATCHER
 
   --- Implements the dynamic dispatching of cargo tasks.
   -- 
-  -- ![Banner Image](..\Presentations\TASK_CARGO_DISPATCHER\Dia3.JPG)
+  -- The **TASK_CARGO_DISPATCHER** allows you to setup various tasks for let human
+  -- players transport cargo as part of a task. 
   -- 
-  -- The EWR will detect units, will group them, and will dispatch @{Task}s to groups. Depending on the type of target detected, different tasks will be dispatched.
-  -- Find a summary below describing for which situation a task type is created:
+  -- There are currently **two types of tasks** that can be constructed:
   -- 
-  -- ![Banner Image](..\Presentations\TASK_CARGO_DISPATCHER\Dia9.JPG)
+  --   * A **normal cargo transport** task, which tasks humans to transport cargo from a location towards a deploy zone.
+  --   * A **CSAR** cargo transport task. CSAR tasks are **automatically generated** when a friendly (AI) plane is downed and the friendly pilot ejects... 
+  --   You as a player (the helo pilot) can go out in the battlefield, fly behind enemy lines, and rescue the pilot (back to a deploy zone).
   -- 
-  --   * **CSAR Task**: Is created when a fiendly pilot has ejected from a plane, and needs to be rescued (sometimes behind enemy lines).
+  -- Let's explore **step by step** how to setup the task cargo dispatcher.
   -- 
-  -- ## 1. TASK\_A2A\_DISPATCHER constructor:
+  -- # 1. Setup a mission environment.
   -- 
-  -- The @{#TASK_CARGO_DISPATCHER.New}() method creates a new TASK\_A2A\_DISPATCHER instance.
+  -- It is easy, as it works just like any other task setup, so setup a command center and a mission.
   -- 
-  -- ### 1.1. Define or set the **Mission**:
+  -- ## 1.1. Create a command center.
   -- 
-  -- Tasking is executed to accomplish missions. Therefore, a MISSION object needs to be given as the first parameter.
+  -- First you need to create a command center using the @{Tasking.CommandCenter#COMMANDCENTER.New}() constructor.
   -- 
-  --     local HQ = GROUP:FindByName( "HQ", "Bravo" )
-  --     local CommandCenter = COMMANDCENTER:New( HQ, "Lima" )
-  --     local Mission = MISSION:New( CommandCenter, "A2A Mission", "High", "Watch the air enemy units being detected.", coalition.side.RED )
-  -- 
-  -- Missions are governed by COMMANDCENTERS, so, ensure you have a COMMANDCENTER object installed and setup within your mission.
-  -- Create the MISSION object, and hook it under the command center.
-  -- 
-  -- ### 1.2. Build a set of the groups seated by human players:
-  -- 
-  -- ![Banner Image](..\Presentations\TASK_CARGO_DISPATCHER\Dia6.JPG)
-  -- 
-  -- A set or collection of the groups wherein human players can be seated, these can be clients or units that can be joined as a slot or jumping into.
+  --     local CommandCenter = COMMANDCENTER
+  --        :New( HQ, "Lima" ) -- Create the CommandCenter.
   --     
-  --     local AttackGroups = SET_GROUP:New():FilterCoalitions( "red" ):FilterPrefixes( "Defender" ):FilterStart()
-  --     
-  -- The set is built using the SET_GROUP class. Apply any filter criteria to identify the correct groups for your mission.
-  -- Only these slots or units will be able to execute the mission and will receive tasks for this mission, once available.
+  -- ## 1.2. Create a mission.
   -- 
-  -- ### 1.3. Define the **EWR network**:
+  -- Tasks work in a mission, which groups these tasks to achieve a joint mission goal.
+  -- A command center can govern multiple missions.
+  -- Create a new mission, using the @{Tasking.Mission#MISSION.New}() constructor.
   -- 
-  -- As part of the TASK\_A2A\_DISPATCHER constructor, an EWR network must be given as the third parameter.
-  -- An EWR network, or, Early Warning Radar network, is used to early detect potential airborne targets and to understand the position of patrolling targets of the enemy.
+  --     -- Declare the Mission for the Command Center.
+  --     local Mission = MISSION
+  --       :New( CommandCenter, 
+  --             "Overlord", 
+  --             "High", 
+  --             "Transport the cargo.", 
+  --             coalition.side.RED 
+  --           ) 
   -- 
-  -- ![Banner Image](..\Presentations\TASK_CARGO_DISPATCHER\Dia5.JPG)
   -- 
-  -- Typically EWR networks are setup using 55G6 EWR, 1L13 EWR, Hawk sr and Patriot str ground based radar units. 
-  -- These radars have different ranges and 55G6 EWR and 1L13 EWR radars are Eastern Bloc units (eg Russia, Ukraine, Georgia) while the Hawk and Patriot radars are Western (eg US).
-  -- Additionally, ANY other radar capable unit can be part of the EWR network! Also AWACS airborne units, planes, helicopters can help to detect targets, as long as they have radar.
-  -- The position of these units is very important as they need to provide enough coverage 
-  -- to pick up enemy aircraft as they approach so that CAP and GCI flights can be tasked to intercept them.
+  -- # 2. Dispatch a **transport cargo** task.
   -- 
-  -- ![Banner Image](..\Presentations\TASK_CARGO_DISPATCHER\Dia7.JPG)
+  -- So, now that we have a command center and a mission, we now create the transport task.
+  -- We create the transport task using the @{#TASK_CARGO_DISPATCHER.AddTransportTask}() constructor.
+  -- 
+  -- ## 2.1. Create the cargo in the mission.
+  -- 
+  -- Because a transport task will not generate the cargo itself, you'll need to create it first.
+  -- 
+  --     -- Here we define the "cargo set", which is a collection of cargo objects.
+  --     -- The cargo set will be the input for the cargo transportation task.
+  --     -- So a transportation object is handling a cargo set, which is automatically updated when new cargo is added/deleted.
+  --     local WorkmaterialsCargoSet = SET_CARGO:New():FilterTypes( "Workmaterials" ):FilterStart()
+  --    
+  --     -- Now we add cargo into the battle scene.
+  --     local PilotGroup = GROUP:FindByName( "Engineers" )
+  --      
+  --     -- CARGO_GROUP can be used to setup cargo with a GROUP object underneath.
+  --     -- We name the type of this group "Workmaterials", so that this cargo group will be included within the WorkmaterialsCargoSet.
+  --     -- Note that the name of the cargo is "Engineer Team 1".
+  --     local CargoGroup = CARGO_GROUP:New( PilotGroup, "Workmaterials", "Engineer Team 1", 500 )
+  -- 
+  -- What is also needed, is to have a set of @{Core.Group}s defined that contains the clients of the players.
+  -- 
+  --     -- Allocate the Transport, which are the helicopters to retrieve the pilot, that can be manned by players.
+  --     -- The name of these helicopter groups containing one client begins with "Transport", as modelled within the mission editor.
+  --     local PilotGroupSet = SET_GROUP:New():FilterPrefixes( "Transport" ):FilterStart()
+  -- 
+  -- ## 2.2. Setup the cargo transport task.
+  -- 
+  -- First, we need to create a TASK_CARGO_DISPATCHER object.
+  -- 
+  --     TaskDispatcher = TASK_CARGO_DISPATCHER:New( Mission, PilotGroupSet )
+  -- 
+  -- So, the variable `TaskDispatcher` will contain the object of class TASK_CARGO_DISPATCHER, which will allow you to dispatch cargo transport tasks:
   --  
-  -- Additionally in a hot war situation where the border is no longer respected the placement of radars has a big effect on how fast the war escalates. 
-  -- For example if they are a long way forward and can detect enemy planes on the ground and taking off 
-  -- they will start to vector CAP and GCI flights to attack them straight away which will immediately draw a response from the other coalition. 
-  -- Having the radars further back will mean a slower escalation because fewer targets will be detected and 
-  -- therefore less CAP and GCI flights will spawn and this will tend to make just the border area active rather than a melee over the whole map. 
-  -- It all depends on what the desired effect is. 
+  --   * for mission `Mission`.
+  --   * for the group set `PilotGroupSet`.
   -- 
-  -- EWR networks are **dynamically constructed**, that is, they form part of the @{Functional.Detection#DETECTION_BASE} object that is given as the input parameter of the TASK\_A2A\_DISPATCHER class.
-  -- By defining in a **smart way the names or name prefixes of the groups** with EWR capable units, these groups will be **automatically added or deleted** from the EWR network, 
-  -- increasing or decreasing the radar coverage of the Early Warning System.
+  -- Now that we have `TaskDispatcher` object, we can now **create the TransportTask**, using the @{#TASK_CARGO_DISPATCHER.AddTransportTask}() method!
   -- 
-  -- See the following example to setup an EWR network containing EWR stations and AWACS.
+  --     local TransportTask = TaskDispatcher:AddTransportTask( 
+  --       "Transport workmaterials", 
+  --       WorkmaterialsCargoSet, 
+  --       "Transport the workers, engineers and the equipment near the Workplace." )
   -- 
-  --     local EWRSet = SET_GROUP:New():FilterPrefixes( "EWR" ):FilterCoalitions("red"):FilterStart()
-  --
-  --     local EWRDetection = DETECTION_AREAS:New( EWRSet, 6000 )
-  --     EWRDetection:SetFriendliesRange( 10000 )
-  --     EWRDetection:SetRefreshTimeInterval(30)
-  --
-  --     -- Setup the A2A dispatcher, and initialize it.
-  --     A2ADispatcher = TASK_CARGO_DISPATCHER:New( Mission, AttackGroups, EWRDetection )
+  -- As a result of this code, the `TransportTask` (returned) variable will contain an object of @{#TASK_CARGO_TRANSPORT}!
+  -- We pass to the method the title of the task, and the `WorkmaterialsCargoSet`, which is the set of cargo groups to be transported!
+  -- This object can also be used to setup additional things, or to control this specific task with special actions.
   -- 
-  -- The above example creates a SET_GROUP instance, and stores this in the variable (object) **EWRSet**.
-  -- **EWRSet** is then being configured to filter all active groups with a group name starting with **EWR** to be included in the Set.
-  -- **EWRSet** is then being ordered to start the dynamic filtering. Note that any destroy or new spawn of a group with the above names will be removed or added to the Set.
-  -- Then a new **EWRDetection** object is created from the class DETECTION_AREAS. A grouping radius of 6000 is choosen, which is 6km.
-  -- The **EWRDetection** object is then passed to the @{#TASK_CARGO_DISPATCHER.New}() method to indicate the EWR network configuration and setup the A2A tasking and detection mechanism.
+  -- And you're done! As you can see, it is a bit of work, but the reward is great.
+  -- And, because all this is done using program interfaces, you can build a mission with a **dynamic cargo transport task mechanism** yourself!
+  -- Based on events happening within your mission, you can use the above methods to create new cargo, and setup a new task for cargo transportation to a group of players!
   -- 
-  -- ### 2. Define the detected **target grouping radius**:
+  --     
+  -- # 3. Dispatch CSAR tasks.
   -- 
-  -- ![Banner Image](..\Presentations\TASK_CARGO_DISPATCHER\Dia8.JPG)
+  -- CSAR tasks can be dynamically created when a friendly pilot ejects, or can be created manually.
+  -- We'll explore both options.
   -- 
-  -- The target grouping radius is a property of the Detection object, that was passed to the AI\_A2A\_DISPATCHER object, but can be changed.
-  -- The grouping radius should not be too small, but also depends on the types of planes and the era of the simulation.
-  -- Fast planes like in the 80s, need a larger radius than WWII planes.  
-  -- Typically I suggest to use 30000 for new generation planes and 10000 for older era aircraft.
+  -- ## 3.1. CSAR task dynamic creation.
   -- 
-  -- Note that detected targets are constantly re-grouped, that is, when certain detected aircraft are moving further than the group radius, then these aircraft will become a separate
-  -- group being detected. This may result in additional GCI being started by the dispatcher! So don't make this value too small!
+  -- Because there is an "event" in a running simulation that creates CSAR tasks, the method @{#TASK_CARGO_DISPATCHER.StartCSARTasks}() will create automatically:
   -- 
-  -- ## 3. Set the **Engage radius**:
+  --   1. a new downed pilot at the location where the plane was shot
+  --   2. declare that pilot as cargo
+  --   3. creates a CSAR task automatically to retrieve that pilot
+  --   4. requires deploy zones to be specified where to transport the downed pilot to, in order to complete that task.
   -- 
-  -- Define the radius to engage any target by airborne friendlies, which are executing cap or returning from an intercept mission.
+  -- You create a CSAR task dynamically in a very easy way:
   -- 
-  -- ![Banner Image](..\Presentations\TASK_CARGO_DISPATCHER\Dia11.JPG)
+  --     TaskDispatcher:StartCSARTasks( 
+  --       "CSAR", 
+  --       { ZONE_UNIT:New( "Hospital", STATIC:FindByName( "Hospital" ), 100 ) }, 
+  --       "One of our pilots has ejected. Go out to Search and Rescue our pilot!\n" .. 
+  --       "Use the radio menu to let the command center assist you with the CSAR tasking."
+  --     )
   -- 
-  -- So, if there is a target area detected and reported, 
-  -- then any friendlies that are airborne near this target area, 
-  -- will be commanded to (re-)engage that target when available (if no other tasks were commanded).
-  -- For example, if 100000 is given as a value, then any friendly that is airborne within 100km from the detected target, 
-  -- will be considered to receive the command to engage that target area.
-  -- You need to evaluate the value of this parameter carefully.
-  -- If too small, more intercept missions may be triggered upon detected target areas.
-  -- If too large, any airborne cap may not be able to reach the detected target area in time, because it is too far.
+  -- The method @{#TASK_CARGO_DISPATCHER.StopCSARTasks}() will automatically stop with the creation of CSAR tasks when friendly pilots eject.
   -- 
-  -- ## 4. Set **Scoring** and **Messages**:
+  -- **Remarks:** 
+  --   
+  --   * the ZONE_UNIT can also be a ZONE, or a ZONE_POLYGON object, or any other ZONE_ object!
+  --   * you can declare the array of zones in another variable, or course!
   -- 
-  -- The TASK\_A2A\_DISPATCHER is a state machine. It triggers the event Assign when a new player joins a @{Task} dispatched by the TASK\_A2A\_DISPATCHER.
-  -- An _event handler_ can be defined to catch the **Assign** event, and add **additional processing** to set _scoring_ and to _define messages_,
-  -- when the player reaches certain achievements in the task.
   -- 
-  -- The prototype to handle the **Assign** event needs to be developed as follows:
+  -- ## 3.2. CSAR task manual creation.
   -- 
-  --      TaskDispatcher = TASK_CARGO_DISPATCHER:New( ... )
+  -- We create the CSAR task using the @{#TASK_CARGO_DISPATCHER.AddCSARTask}() constructor.
   -- 
-  --      --- @param #TaskDispatcher self
-  --      -- @param #string From Contains the name of the state from where the Event was triggered.
-  --      -- @param #string Event Contains the name of the event that was triggered. In this case Assign.
-  --      -- @param #string To Contains the name of the state that will be transitioned to.
-  --      -- @param Tasking.Task_A2A#TASK_A2A Task The Task object, which is any derived object from TASK_A2A.
-  --      -- @param Wrapper.Unit#UNIT TaskUnit The Unit or Client that contains the Player.
-  --      -- @param #string PlayerName The name of the Player that joined the TaskUnit.
-  --      function TaskDispatcher:OnAfterAssign( From, Event, To, Task, TaskUnit, PlayerName )
-  --        Task:SetScoreOnProgress( PlayerName, 20, TaskUnit )
-  --        Task:SetScoreOnSuccess( PlayerName, 200, TaskUnit )
-  --        Task:SetScoreOnFail( PlayerName, -100, TaskUnit )
+  -- The method will create a new CSAR task, and will generate the pilots cargo itself, at the specified coordinate.
+  -- 
+  -- What is first needed, is to have a set of @{Core.Group}s defined that contains the clients of the players.
+  -- 
+  --     -- Allocate the Transport, which are the helicopter to retrieve the pilot, that can be manned by players.
+  --     local GroupSet = SET_GROUP:New():FilterPrefixes( "Transport" ):FilterStart()
+  -- 
+  -- We need to create a TASK_CARGO_DISPATCHER object.
+  -- 
+  --     TaskDispatcher = TASK_CARGO_DISPATCHER:New( Mission, GroupSet )
+  -- 
+  -- So, the variable `TaskDispatcher` will contain the object of class TASK_CARGO_DISPATCHER, which will allow you to dispatch cargo CSAR tasks:
+  --  
+  --   * for mission `Mission`.
+  --   * for the group of players (pilots) captured within the `GroupSet` (those groups with a name starting with `"Transport"`).
+  -- 
+  -- Now that we have a PilotsCargoSet and a GroupSet, we can now create the CSAR task manually.
+  -- 
+  --     -- Declare the CSAR task.
+  --     local CSARTask = TaskDispatcher:AddCSARTask( 
+  --       "CSAR Task",
+  --       Coordinate,
+  --       270,
+  --       "Bring the pilot back!"
+  --     )
+  -- 
+  -- As a result of this code, the `CSARTask` (returned) variable will contain an object of @{#TASK_CARGO_CSAR}!
+  -- We pass to the method the title of the task, and the `WorkmaterialsCargoSet`, which is the set of cargo groups to be transported!
+  -- This object can also be used to setup additional things, or to control this specific task with special actions.
+  -- Note that when you declare a CSAR task manually, you'll still need to specify a deployment zone!
+  -- 
+  -- # 4. Setup the deploy zone(s).
+  -- 
+  -- The task cargo dispatcher also foresees methods to setup the deployment zones to where the cargo needs to be transported!
+  -- 
+  -- There are two levels on which deployment zones can be configured:
+  -- 
+  --   * Default deploy zones: The TASK_CARGO_DISPATCHER object can have default deployment zones, which will apply over all tasks active in the task dispatcher.
+  --   * Task specific deploy zones: The TASK_CARGO_DISPATCHER object can have specific deployment zones which apply to a specific task only!
+  -- 
+  -- Note that for Task specific deployment zones, there are separate deployment zone creation methods per task type!
+  -- 
+  -- ## 4.1. Setup default deploy zones.
+  -- 
+  -- Use the @{#TASK_CARGO_DISPATCHER.SetDefaultDeployZone}() to setup one deployment zone, and @{#TASK_CARGO_DISPATCHER.SetDefaultDeployZones}() to setup multiple default deployment zones in one call.
+  -- 
+  -- ## 4.2. Setup task specific deploy zones for a **transport task**.
+  -- 
+  -- Use the @{#TASK_CARGO_DISPATCHER.SetTransportDeployZone}() to setup one deployment zone, and @{#TASK_CARGO_DISPATCHER.SetTransportDeployZones}() to setup multiple default deployment zones in one call.
+  -- 
+  -- ## 4.3. Setup task specific deploy zones for a **CSAR task**. 
+  -- 
+  -- Use the @{#TASK_CARGO_DISPATCHER.SetCSARDeployZone}() to setup one deployment zone, and @{#TASK_CARGO_DISPATCHER.SetCSARDeployZones}() to setup multiple default deployment zones in one call.
+  -- 
+  -- ## 4.4. **CSAR ejection zones**. 
+  -- 
+  -- Setup a set of zones where the pilots will only eject and a task is created for CSAR. When such a set of zones is given, any ejection outside those zones will not result in a pilot created for CSAR!
+  -- 
+  -- Use the @{#TASK_CARGO_DISPATCHER.SetCSARZones}() to setup the set of zones.
+  -- 
+  -- ## 4.5. **CSAR ejection maximum**.
+  -- 
+  -- Setup how many pilots will eject the maximum. This to avoid an overload of CSAR tasks being created :-) The default is endless CSAR tasks.
+  -- 
+  -- Use the @{#TASK_CARGO_DISPATCHER.SetMaxCSAR}() to setup the maximum of pilots that will eject for CSAR.
+  -- 
+  -- 
+  -- # 5) Handle cargo task events.
+  -- 
+  -- When a player is picking up and deploying cargo using his carrier, events are generated by the dispatcher. These events can be captured and tailored with your own code.
+  -- 
+  -- In order to properly capture the events and avoid mistakes using the documentation, it is advised that you execute the following actions:
+  -- 
+  --   * **Copy / Paste** the code section into your script.
+  --   * **Change** the CLASS literal to the task object name you have in your script.
+  --   * Within the function, you can now **write your own code**!
+  --   * **IntelliSense** will recognize the type of the variables provided by the function. Note: the From, Event and To variables can be safely ignored, 
+  --     but you need to declare them as they are automatically provided by the event handling system of MOOSE.
+  -- 
+  -- You can send messages or fire off any other events within the code section. The sky is the limit!
+  -- 
+  -- First, we need to create a TASK_CARGO_DISPATCHER object.
+  -- 
+  --      TaskDispatcher = TASK_CARGO_DISPATCHER:New( Mission, PilotGroupSet )
+  -- 
+  -- Second, we create a new cargo transport task for the transportation of workmaterials.
+  -- 
+  --      TaskDispatcher:AddTransportTask( 
+  --        "Transport workmaterials", 
+  --        WorkmaterialsCargoSet, 
+  --        "Transport the workers, engineers and the equipment near the Workplace." )
+  -- 
+  -- Note that we don't really need to keep the resulting task, it is kept internally also in the dispatcher.
+  -- 
+  -- Using the `TaskDispatcher` object, we can now cpature the CargoPickedUp and CargoDeployed events.
+  -- 
+  -- ## 5.1) Handle the **CargoPickedUp** event.
+  -- 
+  -- Find below an example how to tailor the **CargoPickedUp** event, generated by the `TaskDispatcher`:
+  -- 
+  --      function TaskDispatcher:OnAfterCargoPickedUp( From, Event, To, Task, TaskPrefix, TaskUnit, Cargo )
+  --        
+  --        MESSAGE:NewType( "Unit " .. TaskUnit:GetName().. " has picked up cargo for task " .. Task:GetName() .. ".", MESSAGE.Type.Information ):ToAll()
+  --        
   --      end
   -- 
-  -- The **OnAfterAssign** method (function) is added to the TaskDispatcher object.
-  -- This method will be called when a new player joins a unit in the set of groups in scope of the dispatcher.
-  -- So, this method will be called only **ONCE** when a player joins a unit in scope of the task.
+  -- If you want to code your own event handler, use this code fragment to tailor the event when a player carrier has picked up a cargo object in the CarrierGroup.
+  -- You can use this event handler to post messages to players, or provide status updates etc.
+  -- 
+  --      --- CargoPickedUp event handler OnAfter for CLASS.
+  --      -- @param #CLASS self
+  --      -- @param #string From A string that contains the "*from state name*" when the event was triggered.
+  --      -- @param #string Event A string that contains the "*event name*" when the event was triggered.
+  --      -- @param #string To A string that contains the "*to state name*" when the event was triggered.
+  --      -- @param Tasking.Task_Cargo#TASK_CARGO Task The cargo task for which the cargo has been picked up. Note that this will be a derived TAKS_CARGO object!
+  --      -- @param #string TaskPrefix The prefix of the task that was provided when the task was created.
+  --      -- @param Wrapper.Unit#UNIT TaskUnit The unit (client) of the player that has picked up the cargo.
+  --      -- @param Cargo.Cargo#CARGO Cargo The cargo object that has been picked up. Note that this can be a CARGO_GROUP, CARGO_CRATE or CARGO_SLINGLOAD object!
+  --      function CLASS:OnAfterCargoPickedUp( From, Event, To, Task, TaskPrefix, TaskUnit, Cargo )
+  --      
+  --        -- Write here your own code.
+  --      
+  --      end
+  -- 
+  -- 
+  -- ## 5.2) Handle the **CargoDeployed** event.
+  -- 
+  -- Find below an example how to tailor the **CargoDeployed** event, generated by the `TaskDispatcher`:
+  -- 
+  --       function WorkplaceTask:OnAfterCargoDeployed( From, Event, To, Task, TaskPrefix, TaskUnit, Cargo, DeployZone )
+  --        
+  --         MESSAGE:NewType( "Unit " .. TaskUnit:GetName().. " has deployed cargo at zone " .. DeployZone:GetName() .. " for task " .. Task:GetName() .. ".", MESSAGE.Type.Information ):ToAll()
+  --        
+  --         Helos[ math.random(1,#Helos) ]:Spawn()
+  --         EnemyHelos[ math.random(1,#EnemyHelos) ]:Spawn()
+  --       end
+  -- 
+  -- If you want to code your own event handler, use this code fragment to tailor the event when a player carrier has deployed a cargo object from the CarrierGroup.
+  -- You can use this event handler to post messages to players, or provide status updates etc.
+  -- 
+  -- 
+  --      --- CargoDeployed event handler OnAfter for CLASS.
+  --      -- @param #CLASS self
+  --      -- @param #string From A string that contains the "*from state name*" when the event was triggered.
+  --      -- @param #string Event A string that contains the "*event name*" when the event was triggered.
+  --      -- @param #string To A string that contains the "*to state name*" when the event was triggered.
+  --      -- @param Tasking.Task_Cargo#TASK_CARGO Task The cargo task for which the cargo has been deployed. Note that this will be a derived TAKS_CARGO object!
+  --      -- @param #string TaskPrefix The prefix of the task that was provided when the task was created.
+  --      -- @param Wrapper.Unit#UNIT TaskUnit The unit (client) of the player that has deployed the cargo.
+  --      -- @param Cargo.Cargo#CARGO Cargo The cargo object that has been deployed. Note that this can be a CARGO_GROUP, CARGO_CRATE or CARGO_SLINGLOAD object!
+  --      -- @param Core.Zone#ZONE DeployZone The zone wherein the cargo is deployed. This can be any zone type, like a ZONE, ZONE_GROUP, ZONE_AIRBASE.
+  --      function CLASS:OnAfterCargoDeployed( From, Event, To, Task, TaskPrefix, TaskUnit, Cargo, DeployZone )
+  --      
+  --        -- Write here your own code.
+  --      
+  --      end
   -- 
-  -- The TASK class implements various methods to additional **set scoring** for player achievements:
   -- 
-  --   * @{Tasking.Task#TASK.SetScoreOnProgress}() will add additional scores when a player achieves **Progress** while executing the task.
-  --     Examples of **task progress** can be destroying units, arriving at zones etc.
-  --   
-  --   * @{Tasking.Task#TASK.SetScoreOnSuccess}() will add additional scores when the task goes into **Success** state. 
-  --     This means the **task has been successfully completed**.
-  --     
-  --   * @{Tasking.Task#TASK.SetScoreOnSuccess}() will add additional (negative) scores when the task goes into **Failed** state. 
-  --     This means the **task has not been successfully completed**, and the scores must be given with a negative value!
   -- 
   -- @field #TASK_CARGO_DISPATCHER
   TASK_CARGO_DISPATCHER = {
@@ -194,6 +392,8 @@ do -- TASK_CARGO_DISPATCHER
     self.Mission = Mission
     
     self:AddTransition( "Started", "Assign", "Started" )
+    self:AddTransition( "Started", "CargoPickedUp", "Started" )
+    self:AddTransition( "Started", "CargoDeployed", "Started" )
     
     --- OnAfter Transition Handler for Event Assign.
     -- @function [parent=#TASK_CARGO_DISPATCHER] OnAfterAssign
@@ -208,6 +408,9 @@ do -- TASK_CARGO_DISPATCHER
     self:SetCSARRadius()
     self:__StartTasks( 5 )
     
+    self.MaxCSAR = nil
+    self.CountCSAR = 0
+    
     -- For CSAR missions, we process the event when a pilot ejects.
     
     self:HandleEvent( EVENTS.Ejection )
@@ -216,6 +419,47 @@ do -- TASK_CARGO_DISPATCHER
   end
 
 
+  --- Sets the set of zones were pilots will only be spawned (eject) when the planes crash.  
+  -- Note that because this is a set of zones, the MD can create the zones dynamically within his mission!
+  -- Just provide a set of zones, see usage, but find the tactical situation here:
+  -- 
+  -- ![CSAR Zones](../Tasking/CSAR_Zones.JPG)
+  -- 
+  -- @param #TASK_CARGO_DISPATCHER self
+  -- @param Core.Set#SET_ZONE SetZonesCSAR The set of zones where pilots will only be spawned for CSAR when they eject.
+  -- @usage
+  -- 
+  --      TaskDispatcher = TASK_CARGO_DISPATCHER:New( Mission, AttackGroups )
+  -- 
+  --      -- Use this call to pass the set of zones.
+  --      -- Note that you can create the set of zones inline, because the FilterOnce method (and other SET_ZONE methods return self).
+  --      -- So here the zones can be created as normal trigger zones (MOOSE creates a collection of ZONE objects when teh mission starts of all trigger zones).
+  --      -- Just name them as CSAR zones here.
+  --      TaskDispatcher:SetCSARZones( SET_ZONE:New():FilterPrefixes("CSAR"):FilterOnce() )
+  -- 
+  function TASK_CARGO_DISPATCHER:SetCSARZones( SetZonesCSAR )
+
+    self.SetZonesCSAR = SetZonesCSAR
+  
+  end
+
+
+  --- Sets the maximum of pilots that will be spawned (eject) when the planes crash.  
+  -- @param #TASK_CARGO_DISPATCHER self
+  -- @param #number MaxCSAR The maximum of pilots that will eject for CSAR.
+  -- @usage
+  -- 
+  --      TaskDispatcher = TASK_CARGO_DISPATCHER:New( Mission, AttackGroups )
+  -- 
+  --      -- Use this call to the maximum of CSAR to 10.
+  --      TaskDispatcher:SetMaxCSAR( 10 )
+  -- 
+  function TASK_CARGO_DISPATCHER:SetMaxCSAR( MaxCSAR )
+
+    self.MaxCSAR = MaxCSAR
+  
+  end
+
 
 
   --- Handle the event when a pilot ejects.
@@ -233,8 +477,15 @@ do -- TASK_CARGO_DISPATCHER
       
       -- Only add a CSAR task if the coalition of the mission is equal to the coalition of the ejected unit.
       if CSARCoalition == self.Mission:GetCommandCenter():GetCoalition() then
-        local CSARTaskName = self:AddCSARTask( self.CSARTaskName, CSARCoordinate, CSARHeading, CSARCountry, self.CSARBriefing )     
-        self:SetCSARDeployZones( CSARTaskName, self.CSARDeployZones )
+        -- And only add if the eject is in one of the zones, if defined.
+        if not self.SetZonesCSAR or ( self.SetZonesCSAR and self.SetZonesCSAR:IsCoordinateInZone( CSARCoordinate ) ) then
+          -- And only if the maximum of pilots is not reached that ejected!
+          if not self.MaxCSAR or ( self.MaxCSAR and self.CountCSAR < self.MaxCSAR ) then
+            local CSARTaskName = self:AddCSARTask( self.CSARTaskName, CSARCoordinate, CSARHeading, CSARCountry, self.CSARBriefing )     
+            self:SetCSARDeployZones( CSARTaskName, self.CSARDeployZones )
+            self.CountCSAR = self.CountCSAR + 1
+          end
+        end
       end
     end
     
@@ -321,11 +572,11 @@ do -- TASK_CARGO_DISPATCHER
   -- 
   --   -- Add a CSAR task to rescue a downed pilot from within a coordinate.
   --   local Coordinate = PlaneUnit:GetPointVec2()
-  --   TaskA2ADispatcher:AddCSARTask( Coordinate )
+  --   TaskA2ADispatcher:AddCSARTask( "CSAR Task", Coordinate )
   --   
   --   -- Add a CSAR task to rescue a downed pilot from within a coordinate of country RUSSIA, which is pointing to the west (270°).
   --   local Coordinate = PlaneUnit:GetPointVec2()
-  --   TaskA2ADispatcher:AddCSARTask( Coordinate, 270, Country.RUSSIA )
+  --   TaskA2ADispatcher:AddCSARTask( "CSAR Task", Coordinate, 270, Country.RUSSIA )
   --   
   function TASK_CARGO_DISPATCHER:AddCSARTask( CSARTaskPrefix, CSARCoordinate, CSARHeading, CSARCountry, CSARBriefing )
 
@@ -368,6 +619,7 @@ do -- TASK_CARGO_DISPATCHER
     self.CSAR[CSARTaskName].PilotGroup = CSARGroup
     self.CSAR[CSARTaskName].Briefing = CSARBriefing
     self.CSAR[CSARTaskName].Task = nil
+    self.CSAR[CSARTaskName].TaskPrefix = CSARTaskPrefix
     
     return CSARTaskName
   end
@@ -453,16 +705,17 @@ do -- TASK_CARGO_DISPATCHER
   --  -- Here we set a TransportDeployZone. We use the WorkplaceTask as the reference, and provide a ZONE object.
   --  TaskDispatcher:SetTransportDeployZone( WorkplaceTask, ZONE:New( "Workplace" ) )
   --  
-  function TASK_CARGO_DISPATCHER:AddTransportTask( TaskName, SetCargo, Briefing )
+  function TASK_CARGO_DISPATCHER:AddTransportTask( TaskPrefix, SetCargo, Briefing )
 
     self.TransportCount = self.TransportCount + 1
     
-    local TaskName = string.format( ( TaskName or "Transport" ) .. ".%03d", self.TransportCount )
+    local TaskName = string.format( ( TaskPrefix or "Transport" ) .. ".%03d", self.TransportCount )
     
     self.Transport[TaskName] = {} 
     self.Transport[TaskName].SetCargo = SetCargo
     self.Transport[TaskName].Briefing = Briefing
     self.Transport[TaskName].Task = nil
+    self.Transport[TaskName].TaskPrefix = TaskPrefix
     
     self:ManageTasks()
     
@@ -485,6 +738,8 @@ do -- TASK_CARGO_DISPATCHER
     else
       error( "Task does not exist" )
     end
+
+    self:ManageTasks()
   
     return self
   end
@@ -503,6 +758,8 @@ do -- TASK_CARGO_DISPATCHER
     else
       error( "Task does not exist" )
     end
+
+    self:ManageTasks()
   
     return self
   end
@@ -565,6 +822,7 @@ do -- TASK_CARGO_DISPATCHER
           -- New CSAR Task
           local SetCargo = self:EvaluateCSAR( CSAR.PilotGroup )
           CSAR.Task = TASK_CARGO_CSAR:New( Mission, self.SetGroup, CSARName, SetCargo, CSAR.Briefing )
+          CSAR.Task.TaskPrefix = CSAR.TaskPrefix -- We keep the TaskPrefix for further reference!
           Mission:AddTask( CSAR.Task )
           TaskReport:Add( CSARName )
           if CSAR.DeployZones then
@@ -572,6 +830,17 @@ do -- TASK_CARGO_DISPATCHER
           else
             CSAR.Task:SetDeployZones( self.DefaultDeployZones or {} )
           end
+          
+          -- Now broadcast the onafterCargoPickedUp event to the Task Cargo Dispatcher.
+          function CSAR.Task.OnAfterCargoPickedUp( Task, From, Event, To, TaskUnit, Cargo )
+            self:CargoPickedUp( Task, Task.TaskPrefix, TaskUnit, Cargo )
+          end
+
+          -- Now broadcast the onafterCargoDeployed event to the Task Cargo Dispatcher.
+          function CSAR.Task.OnAfterCargoDeployed( Task, From, Event, To, TaskUnit, Cargo, DeployZone )
+            self:CargoDeployed( Task, Task.TaskPrefix, TaskUnit, Cargo, DeployZone )
+          end
+          
         end
       end
       
@@ -582,32 +851,43 @@ do -- TASK_CARGO_DISPATCHER
         if not Transport.Task then
           -- New Transport Task
           Transport.Task = TASK_CARGO_TRANSPORT:New( Mission, self.SetGroup, TransportName, Transport.SetCargo, Transport.Briefing )
+          Transport.Task.TaskPrefix = Transport.TaskPrefix -- We keep the TaskPrefix for further reference!
           Mission:AddTask( Transport.Task )
           TaskReport:Add( TransportName )
-          if Transport.DeployZones then
-            Transport.Task:SetDeployZones( Transport.DeployZones or {} )
-          else
-            Transport.Task:SetDeployZones( self.DefaultDeployZones or {} )
-          end
-
           function Transport.Task.OnEnterSuccess( Task, From, Event, To )
             self:Success( Task )
           end
 
-          function Transport.Task.onenterCancelled( Task, From, Event, To )
+          function Transport.Task.OnEnterCancelled( Task, From, Event, To )
             self:Cancelled( Task )
           end
           
-          function Transport.Task.onenterFailed( Task, From, Event, To )
+          function Transport.Task.OnEnterFailed( Task, From, Event, To )
             self:Failed( Task )
           end
 
-          function Transport.Task.onenterAborted( Task, From, Event, To )
+          function Transport.Task.OnEnterAborted( Task, From, Event, To )
             self:Aborted( Task )
           end
-            
 
+          -- Now broadcast the onafterCargoPickedUp event to the Task Cargo Dispatcher.
+          function Transport.Task.OnAfterCargoPickedUp( Task, From, Event, To, TaskUnit, Cargo )
+            self:CargoPickedUp( Task, Task.TaskPrefix, TaskUnit, Cargo )
+          end
+
+          -- Now broadcast the onafterCargoDeployed event to the Task Cargo Dispatcher.
+          function Transport.Task.OnAfterCargoDeployed( Task, From, Event, To, TaskUnit, Cargo, DeployZone )
+            self:CargoDeployed( Task, Task.TaskPrefix, TaskUnit, Cargo, DeployZone )
+          end
+          
         end
+        
+        if Transport.DeployZones then
+          Transport.Task:SetDeployZones( Transport.DeployZones or {} )
+        else
+          Transport.Task:SetDeployZones( self.DefaultDeployZones or {} )
+        end
+        
       end
       
       

Moose Development/Moose/Tasking/Task_Cargo_Transport.lua

@@ -67,11 +67,8 @@ do -- TASK_CARGO_TRANSPORT
   -- 
   -- ===
   -- 
-  -- A transport task can be created manually, but actually, it is better to **GENERATE** these tasks using the 
-  -- @{Tasking.Task_Cargo_Dispatcher} module.
-  -- 
-  -- Using the dispatcher, transport tasks can be created much more easy.
-  -- 
+  -- A transport task can be created manually.
+  --  
   -- # 1) Create a transport task manually (code it).
   -- 
   -- Although it is recommended to use the dispatcher, you can create a transport task yourself as a mission designer.
@@ -141,6 +138,124 @@ do -- TASK_CARGO_TRANSPORT
   -- It is better you use the cargo dispatcher to create transport tasks and it will work as it is intended.
   -- By doing this, cargo transport tasking will become a dynamic experience.
   -- 
+  -- 
+  -- # 2) Create a task using the @{Tasking.Task_Cargo_Dispatcher} module.
+  -- 
+  -- Actually, it is better to **GENERATE** these tasks using the @{Tasking.Task_Cargo_Dispatcher} module.
+  -- Using the dispatcher module, transport tasks can be created much more easy.
+  -- 
+  -- Find below an example how to use the TASK_CARGO_DISPATCHER class:
+  -- 
+  -- 
+  --    -- Find the HQ group.
+  --    HQ = GROUP:FindByName( "HQ", "Bravo" )
+  --    
+  --    -- Create the command center with the name "Lima".
+  --    CommandCenter = COMMANDCENTER
+  --      :New( HQ, "Lima" )
+  --    
+  --    -- Create the mission, for the command center, with the name "Operation Cargo Fun", a "Tactical" mission, with the mission briefing "Transport Cargo", for the BLUE coalition.
+  --    Mission = MISSION
+  --      :New( CommandCenter, "Operation Cargo Fun", "Tactical", "Transport Cargo", coalition.side.BLUE )
+  --    
+  --    -- Create the SET of GROUPs containing clients (players) that will transport the cargo.
+  --    -- These are have a name that start with "Transport" and are of the "blue" coalition.
+  --    TransportGroups = SET_GROUP:New():FilterCoalitions( "blue" ):FilterPrefixes( "Transport" ):FilterStart()
+  --    
+  --    
+  --    -- Here we create the TASK_CARGO_DISPATCHER object! This is where we assign the dispatcher to generate tasks in the Mission for the TransportGroups.
+  --    TaskDispatcher = TASK_CARGO_DISPATCHER:New( Mission, TransportGroups )
+  --    
+  --    
+  --    -- Here we declare the SET of CARGOs called "Workmaterials".
+  --    local CargoSetWorkmaterials = SET_CARGO:New():FilterTypes( "Workmaterials" ):FilterStart()
+  --    
+  --    -- Here we declare (add) CARGO_GROUP objects of various types, that are filtered and added in the CargoSetworkmaterials cargo set.
+  --    -- These cargo objects have the type "Workmaterials" which is exactly the type of cargo the CargoSetworkmaterials is filtering on.
+  --    local EngineerCargoGroup = CARGO_GROUP:New( GROUP:FindByName( "Engineers" ), "Workmaterials", "Engineers", 250 )
+  --    local ConcreteCargo = CARGO_SLINGLOAD:New( STATIC:FindByName( "Concrete" ), "Workmaterials", "Concrete", 150, 50 )
+  --    local CrateCargo = CARGO_CRATE:New( STATIC:FindByName( "Crate" ), "Workmaterials", "Crate", 150, 50 )
+  --    local EnginesCargo = CARGO_CRATE:New( STATIC:FindByName( "Engines" ), "Workmaterials", "Engines", 150, 50 )
+  --    local MetalCargo = CARGO_CRATE:New( STATIC:FindByName( "Metal" ), "Workmaterials", "Metal", 150, 50 )
+  --    
+  --    -- And here we create a new WorkplaceTask, using the :AddTransportTask method of the TaskDispatcher.
+  --    local WorkplaceTask = TaskDispatcher:AddTransportTask( "Build a Workplace", CargoSetWorkmaterials, "Transport the workers, engineers and the equipment near the Workplace." )
+  --    TaskDispatcher:SetTransportDeployZone( WorkplaceTask, ZONE:New( "Workplace" ) )
+  -- 
+  -- # 3) Handle cargo task events.
+  -- 
+  -- When a player is picking up and deploying cargo using his carrier, events are generated by the tasks. These events can be captured and tailored with your own code.
+  -- 
+  -- In order to properly capture the events and avoid mistakes using the documentation, it is advised that you execute the following actions:
+  -- 
+  --   * **Copy / Paste** the code section into your script.
+  --   * **Change** the CLASS literal to the task object name you have in your script.
+  --   * Within the function, you can now **write your own code**!
+  --   * **IntelliSense** will recognize the type of the variables provided by the function. Note: the From, Event and To variables can be safely ignored, 
+  --     but you need to declare them as they are automatically provided by the event handling system of MOOSE.
+  -- 
+  -- You can send messages or fire off any other events within the code section. The sky is the limit!
+  -- 
+  -- 
+  -- ## 3.1) Handle the CargoPickedUp event.
+  -- 
+  -- Find below an example how to tailor the **CargoPickedUp** event, generated by the WorkplaceTask:
+  -- 
+  --      function WorkplaceTask:OnAfterCargoPickedUp( From, Event, To, TaskUnit, Cargo )
+  --        
+  --        MESSAGE:NewType( "Unit " .. TaskUnit:GetName().. " has picked up cargo.", MESSAGE.Type.Information ):ToAll()
+  --        
+  --      end
+  -- 
+  -- If you want to code your own event handler, use this code fragment to tailor the event when a player carrier has picked up a cargo object in the CarrierGroup.
+  -- You can use this event handler to post messages to players, or provide status updates etc.
+  -- 
+  --      --- CargoPickedUp event handler OnAfter for CLASS.
+  --      -- @param #CLASS self
+  --      -- @param #string From A string that contains the "*from state name*" when the event was triggered.
+  --      -- @param #string Event A string that contains the "*event name*" when the event was triggered.
+  --      -- @param #string To A string that contains the "*to state name*" when the event was triggered.
+  --      -- @param Wrapper.Unit#UNIT TaskUnit The unit (client) of the player that has picked up the cargo.
+  --      -- @param Cargo.Cargo#CARGO Cargo The cargo object that has been picked up. Note that this can be a CARGO_GROUP, CARGO_CRATE or CARGO_SLINGLOAD object!
+  --      function CLASS:OnAfterCargoPickedUp( From, Event, To, TaskUnit, Cargo )
+  --      
+  --        -- Write here your own code.
+  --      
+  --      end
+  -- 
+  -- 
+  -- ## 3.2) Handle the CargoDeployed event.
+  -- 
+  -- Find below an example how to tailor the **CargoDeployed** event, generated by the WorkplaceTask:
+  -- 
+  --      function WorkplaceTask:OnAfterCargoDeployed( From, Event, To, TaskUnit, Cargo, DeployZone )
+  --        
+  --        MESSAGE:NewType( "Unit " .. TaskUnit:GetName().. " has deployed cargo at zone " .. DeployZone:GetName(), MESSAGE.Type.Information ):ToAll()
+  --        
+  --        Helos[ math.random(1,#Helos) ]:Spawn()
+  --        EnemyHelos[ math.random(1,#EnemyHelos) ]:Spawn()
+  --      end
+  -- 
+  -- If you want to code your own event handler, use this code fragment to tailor the event when a player carrier has deployed a cargo object from the CarrierGroup.
+  -- You can use this event handler to post messages to players, or provide status updates etc.
+  -- 
+  -- 
+  --      --- CargoDeployed event handler OnAfter for CLASS.
+  --      -- @param #CLASS self
+  --      -- @param #string From A string that contains the "*from state name*" when the event was triggered.
+  --      -- @param #string Event A string that contains the "*event name*" when the event was triggered.
+  --      -- @param #string To A string that contains the "*to state name*" when the event was triggered.
+  --      -- @param Wrapper.Unit#UNIT TaskUnit The unit (client) of the player that has deployed the cargo.
+  --      -- @param Cargo.Cargo#CARGO Cargo The cargo object that has been deployed. Note that this can be a CARGO_GROUP, CARGO_CRATE or CARGO_SLINGLOAD object!
+  --      -- @param Core.Zone#ZONE DeployZone The zone wherein the cargo is deployed. This can be any zone type, like a ZONE, ZONE_GROUP, ZONE_AIRBASE.
+  --      function CLASS:OnAfterCargoDeployed( From, Event, To, TaskUnit, Cargo, DeployZone )
+  --      
+  --        -- Write here your own code.
+  --      
+  --      end
+  -- 
+  -- 
+  -- 
   -- ===
   -- 
   -- @field #TASK_CARGO_TRANSPORT