Merge remote-tracking branch 'origin/develop' into branch

# Conflicts:
#	Moose Development/Moose/Ops/EasyGCICAP.lua

Moose Development/Debugger/debugger.lua

@@ -1953,7 +1953,7 @@ local function refct_from_id(id) -- refct = refct_from_id(CTypeID)
       unsigned = refct.unsigned,
       size = bit.band(bit.rshift(ctype.info, 16), 127),
     }
-    refct.bool, refct.const, refct.volatile, refct.unsigned = nil
+    refct.bool, refct.const, refct.volatile, refct.unsigned = nil, nil, nil, nil
   end
 
   if CT[4] then -- Merge sibling attributes onto this type.

Moose Development/Moose/AI/.gitignore

@@ -0,0 +1,2 @@
+/AI_Patrol.lua
+/AI_BAI.lua

Moose Development/Moose/AI/AI_A2A_Cap.lua

@@ -1,218 +0,0 @@
---- **AI** - Models the process of Combat Air Patrol (CAP) for airplanes.
---
--- This is a class used in the @{AI.AI_A2A_Dispatcher}.
---
--- ===
---
--- ### Author: **FlightControl**
---
--- ===
---
--- @module AI.AI_A2A_Cap
--- @image AI_Combat_Air_Patrol.JPG
-
--- @type AI_A2A_CAP
--- @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 @{Core.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_A2A_CAP is assigned a @{Wrapper.Group} and this must be done before the AI_A2A_CAP 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 threshold has been reached by the AI, or when the AI is commanded to RTB.
--- When the fuel threshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
---
--- ![Process](..\Presentations\AI_CAP\Dia13.JPG)
---
--- ## 1. AI_A2A_CAP constructor
---
---   * @{#AI_A2A_CAP.New}(): Creates a new AI_A2A_CAP object.
---
--- ## 2. AI_A2A_CAP is a FSM
---
--- ![Process](..\Presentations\AI_CAP\Dia2.JPG)
---
--- ### 2.1 AI_A2A_CAP 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_A2A_CAP Events
---
---   * **@{AI.AI_Patrol#AI_PATROL_ZONE.Start}**: Start the process.
---   * **@{AI.AI_Patrol#AI_PATROL_ZONE.Route}**: Route the AI to a new random 3D point within the Patrol Zone.
---   * **@{#AI_A2A_CAP.Engage}**: Let the AI engage the bogeys.
---   * **@{#AI_A2A_CAP.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_A2A_CAP.Destroy}**: The AI has destroyed a bogey @{Wrapper.Unit}.
---   * **@{#AI_A2A_CAP.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 thresholds 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_A2A_CAP.SetEngageRange}() to define that range.
---
--- ## 4. Set the Zone of Engagement
---
--- ![Zone](..\Presentations\AI_CAP\Dia12.JPG)
---
--- An optional @{Core.Zone} can be set,
--- that will define when the AI will engage with the detected airborne enemy targets.
--- Use the method @{#AI_A2A_CAP.SetEngageZone}() to define that Zone.
---
--- # Developer Note
--- 
--- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
--- Therefore, this class is considered to be deprecated
---
--- ===
---
--- @field #AI_A2A_CAP
-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 @{Core.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 )
-  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 ) --#AI_A2A_CAP
-
-  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
--- @param Core.Zone#ZONE_BASE PatrolZone The @{Core.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#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#AltitudeType PatrolAltType The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to RADIO
--- @return #AI_A2A_CAP
-function AI_A2A_CAP:New( AICap, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, EngageMinSpeed, EngageMaxSpeed, PatrolAltType )
-
-  return self:New2( AICap, EngageMinSpeed, EngageMaxSpeed, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolAltType, PatrolZone, PatrolMinSpeed, PatrolMaxSpeed, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolAltType )
-
-end
-
---- onafter State Transition for Event Patrol.
--- @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
-
---- Set the Engage Zone which defines where the AI will engage bogies.
--- @param #AI_A2A_CAP self
--- @param Core.Zone#ZONE EngageZone The zone where the AI is performing CAP.
--- @return #AI_A2A_CAP self
-function AI_A2A_CAP:SetEngageZone( EngageZone )
-  self:F2()
-
-  if EngageZone then
-    self.EngageZone = EngageZone
-  else
-    self.EngageZone = nil
-  end
-end
-
---- Set the Engage Range when the AI will engage with airborne enemies.
--- @param #AI_A2A_CAP self
--- @param #number EngageRange The Engage Range.
--- @return #AI_A2A_CAP self
-function AI_A2A_CAP:SetEngageRange( EngageRange )
-  self:F2()
-
-  if EngageRange then
-    self.EngageRange = EngageRange
-  else
-    self.EngageRange = nil
-  end
-end
-
---- Evaluate the attack and create an AttackUnitTask list.
--- @param #AI_A2A_CAP self
--- @param Core.Set#SET_UNIT AttackSetUnit The set of units to attack.
--- @param Wrapper.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 )
-
-  local AttackUnitTasks = {}
-
-  for AttackUnitID, AttackUnit in pairs( self.AttackSetUnit:GetSet() ) do
-    local AttackUnit = AttackUnit -- Wrapper.Unit#UNIT
-    if AttackUnit and 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
-  end
-
-  return AttackUnitTasks
-end

Moose Development/Moose/AI/AI_A2A_Gci.lua

@@ -1,147 +0,0 @@
---- **AI** - Models the process of Ground Controlled Interception (GCI) for airplanes.
---
--- This is a class used in the @{AI.AI_A2A_Dispatcher}.
---
--- ===
---
--- ### Author: **FlightControl**
---
--- ===
---
--- @module AI.AI_A2A_Gci
--- @image AI_Ground_Control_Intercept.JPG
-
-
-
--- @type AI_A2A_GCI
--- @extends AI.AI_A2A#AI_A2A
-
-
---- Implements the core functions to intercept intruders. Use the Engage trigger to intercept intruders.
---
--- The AI_A2A_GCI is assigned a @{Wrapper.Group} and this must be done before the AI_A2A_GCI process can be started using the **Start** event.
---
--- 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.
---
--- This cycle will continue.
---
--- During the patrol, the AI will detect enemy targets, which are reported through the **Detected** event.
---
--- When enemies are detected, the AI will automatically engage the enemy.
---
--- Until a fuel or damage threshold has been reached by the AI, or when the AI is commanded to RTB.
--- When the fuel threshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
---
--- ## 1. AI_A2A_GCI constructor
---
---   * @{#AI_A2A_GCI.New}(): Creates a new AI_A2A_GCI object.
---
--- ## 2. AI_A2A_GCI is a FSM
---
--- ![Process](..\Presentations\AI_GCI\Dia2.JPG)
---
--- ### 2.1 AI_A2A_GCI 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_A2A_GCI Events
---
---   * **@{AI.AI_Patrol#AI_PATROL_ZONE.Start}**: Start the process.
---   * **@{AI.AI_Patrol#AI_PATROL_ZONE.Route}**: Route the AI to a new random 3D point within the Patrol Zone.
---   * **@{#AI_A2A_GCI.Engage}**: Let the AI engage the bogeys.
---   * **@{#AI_A2A_GCI.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_A2A_GCI.Destroy}**: The AI has destroyed a bogey @{Wrapper.Unit}.
---   * **@{#AI_A2A_GCI.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 thresholds have been reached, the AI will RTB.
---
--- # Developer Note
---
--- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
--- Therefore, this class is considered to be deprecated
---
--- ===
---
--- @field #AI_A2A_GCI
-AI_A2A_GCI = {
-  ClassName = "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:New2( AIIntercept, EngageMinSpeed, EngageMaxSpeed, EngageFloorAltitude, EngageCeilingAltitude, EngageAltType )
-
-  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: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.
--- @param #string From The From State string.
--- @param #string Event The Event string.
--- @param #string To The To State string.
-function AI_A2A_GCI:onafterStart( AIIntercept, From, Event, To )
-
-  self:GetParent( self, AI_A2A_GCI ).onafterStart( self, AIIntercept, From, Event, To )
-end
-
-
---- Evaluate the attack and create an AttackUnitTask list.
--- @param #AI_A2A_GCI self
--- @param Core.Set#SET_UNIT AttackSetUnit The set of units to attack.
--- @param Wrapper.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 )
-
-  local AttackUnitTasks = {}
-
-  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
-  end
-
-  return AttackUnitTasks
-end

Moose Development/Moose/AI/AI_A2A_Patrol.lua

@@ -1,409 +0,0 @@
---- **AI** - Models the process of air patrol of airplanes.
--- 
--- ===
--- 
--- ### Author: **FlightControl**
--- 
--- ===
--- 
--- @module AI.AI_A2A_Patrol
--- @image AI_Air_Patrolling.JPG
-
-
--- @type AI_A2A_PATROL
--- @extends AI.AI_A2A#AI_A2A
-
---- Implements the core functions to patrol a @{Core.Zone} by an AI @{Wrapper.Group} or @{Wrapper.Group}.
--- 
--- ![Process](..\Presentations\AI_PATROL\Dia3.JPG)
--- 
--- The AI_A2A_PATROL is assigned a @{Wrapper.Group} and this must be done before the AI_A2A_PATROL process can be started using the **Start** event.
--- 
--- ![Process](..\Presentations\AI_PATROL\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_PATROL\Dia5.JPG)
--- 
--- This cycle will continue.
--- 
--- ![Process](..\Presentations\AI_PATROL\Dia6.JPG)
--- 
--- During the patrol, the AI will detect enemy targets, which are reported through the **Detected** event.
---
--- ![Process](..\Presentations\AI_PATROL\Dia9.JPG)
--- 
----- Note that the enemy is not engaged! To model enemy engagement, either tailor the **Detected** event, or
--- use derived AI_ classes to model AI offensive or defensive behaviour.
--- 
--- ![Process](..\Presentations\AI_PATROL\Dia10.JPG)
--- 
--- Until a fuel or damage threshold has been reached by the AI, or when the AI is commanded to RTB.
--- When the fuel threshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
--- 
--- ![Process](..\Presentations\AI_PATROL\Dia11.JPG)
--- 
--- ## 1. AI_A2A_PATROL constructor
---   
---   * @{#AI_A2A_PATROL.New}(): Creates a new AI_A2A_PATROL object.
--- 
--- ## 2. AI_A2A_PATROL is a FSM
--- 
--- ![Process](..\Presentations\AI_PATROL\Dia2.JPG)
--- 
--- ### 2.1. AI_A2A_PATROL States
--- 
---   * **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.
--- 
--- ### 2.2. AI_A2A_PATROL Events
--- 
---   * **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 thresholds have been reached, the AI will RTB.
---    
--- ## 3. Set or Get the AI controllable
--- 
---   * @{#AI_A2A_PATROL.SetControllable}(): Set the AIControllable.
---   * @{#AI_A2A_PATROL.GetControllable}(): Get the AIControllable.
---
--- ## 4. Set the Speed and Altitude boundaries of the AI controllable
---
---   * @{#AI_A2A_PATROL.SetSpeed}(): Set the patrol speed boundaries of the AI, for the next patrol.
---   * @{#AI_A2A_PATROL.SetAltitude}(): Set altitude boundaries of the AI, for the next patrol.
--- 
--- ## 5. Manage the detection process of the AI controllable
--- 
--- The detection process of the AI controllable can be manipulated.
--- Detection requires an amount of CPU power, which has an impact on your mission performance.
--- Only put detection on when absolutely necessary, and the frequency of the detection can also be set.
--- 
---   * @{#AI_A2A_PATROL.SetDetectionOn}(): Set the detection on. The AI will detect for targets.
---   * @{#AI_A2A_PATROL.SetDetectionOff}(): Set the detection off, the AI will not detect for targets. The existing target list will NOT be erased.
--- 
--- The detection frequency can be set with @{#AI_A2A_PATROL.SetRefreshTimeInterval}( seconds ), where the amount of seconds specify how much seconds will be waited before the next detection.
--- Use the method @{#AI_A2A_PATROL.GetDetectedUnits}() to obtain a list of the @{Wrapper.Unit}s detected by the AI.
--- 
--- The detection can be filtered to potential targets in a specific zone.
--- Use the method @{#AI_A2A_PATROL.SetDetectionZone}() to set the zone where targets need to be detected.
--- Note that when the zone is too far away, or the AI is not heading towards the zone, or the AI is too high, no targets may be detected
--- according the weather conditions.
--- 
--- ## 6. Manage the "out of fuel" in the AI_A2A_PATROL
--- 
--- 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 threshold is calculated.
--- When the fuel threshold is reached, the AI will continue for a given time its patrol task in orbit, 
--- while a new AI is targeted to the AI_A2A_PATROL.
--- Once the time is finished, the old AI will return to the base.
--- Use the method @{#AI_A2A_PATROL.ManageFuel}() to have this proces in place.
--- 
--- ## 7. Manage "damage" behaviour of the AI in the AI_A2A_PATROL
--- 
--- When the AI is damaged, it is required that a new Patrol is started. However, damage cannon be foreseen early on. 
--- Therefore, when the damage threshold is reached, the AI will return immediately to the home base (RTB).
--- Use the method @{#AI_A2A_PATROL.ManageDamage}() to have this proces in place.
---
--- # Developer Note
--- 
--- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
--- Therefore, this class is considered to be deprecated
---
--- ===
--- 
--- @field #AI_A2A_PATROL
-AI_A2A_PATROL = {
-  ClassName = "AI_A2A_PATROL",
-}
-
---- Creates a new AI_A2A_PATROL object
--- @param #AI_A2A_PATROL self
--- @param Wrapper.Group#GROUP AIPatrol The patrol group object.
--- @param Core.Zone#ZONE_BASE PatrolZone The @{Core.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 BARO
--- @return #AI_A2A_PATROL self
--- @usage
--- -- Define a new AI_A2A_PATROL Object. This PatrolArea will patrol a Group within PatrolZone between 3000 and 6000 meters, with a variying speed between 600 and 900 km/h.
--- PatrolZone = ZONE:New( 'PatrolZone' )
--- PatrolSpawn = SPAWN:New( 'Patrol Group' )
--- PatrolArea = AI_A2A_PATROL:New( PatrolZone, 3000, 6000, 600, 900 )
-function AI_A2A_PATROL:New( AIPatrol, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType )
-
-  local AI_Air = AI_AIR:New( AIPatrol )
-  local AI_Air_Patrol = AI_AIR_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
-  self.PatrolCeilingAltitude = PatrolCeilingAltitude
-  self.PatrolMinSpeed = PatrolMinSpeed
-  self.PatrolMaxSpeed = PatrolMaxSpeed
-  
-  -- defafult PatrolAltType to "BARO" if not specified
-  self.PatrolAltType = PatrolAltType or "BARO"
-  
-  self:AddTransition( { "Started", "Airborne", "Refuelling" }, "Patrol", "Patrolling" )
-
---- OnBefore Transition Handler for Event Patrol.
--- @function [parent=#AI_A2A_PATROL] OnBeforePatrol
--- @param #AI_A2A_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_A2A_PATROL] OnAfterPatrol
--- @param #AI_A2A_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_A2A_PATROL] Patrol
--- @param #AI_A2A_PATROL self
-
---- Asynchronous Event Trigger for Event Patrol.
--- @function [parent=#AI_A2A_PATROL] __Patrol
--- @param #AI_A2A_PATROL self
--- @param #number Delay The delay in seconds.
-
---- OnLeave Transition Handler for State Patrolling.
--- @function [parent=#AI_A2A_PATROL] OnLeavePatrolling
--- @param #AI_A2A_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_A2A_PATROL] OnEnterPatrolling
--- @param #AI_A2A_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", "Route", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_A2A_PATROL.
-
---- OnBefore Transition Handler for Event Route.
--- @function [parent=#AI_A2A_PATROL] OnBeforeRoute
--- @param #AI_A2A_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 Route.
--- @function [parent=#AI_A2A_PATROL] OnAfterRoute
--- @param #AI_A2A_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 Route.
--- @function [parent=#AI_A2A_PATROL] Route
--- @param #AI_A2A_PATROL self
-
---- Asynchronous Event Trigger for Event Route.
--- @function [parent=#AI_A2A_PATROL] __Route
--- @param #AI_A2A_PATROL self
--- @param #number Delay The delay in seconds.
-
-
-
-  self:AddTransition( "*", "Reset", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_A2A_PATROL.
-  
-  return self
-end
-
-
-
-
---- Sets (modifies) the minimum and maximum speed of the patrol.
--- @param #AI_A2A_PATROL self
--- @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.
--- @return #AI_A2A_PATROL self
-function AI_A2A_PATROL:SetSpeed( PatrolMinSpeed, PatrolMaxSpeed )
-  self:F2( { PatrolMinSpeed, PatrolMaxSpeed } )
-  
-  self.PatrolMinSpeed = PatrolMinSpeed
-  self.PatrolMaxSpeed = PatrolMaxSpeed
-end
-
-
-
---- Sets the floor and ceiling altitude of the patrol.
--- @param #AI_A2A_PATROL 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_PATROL self
-function AI_A2A_PATROL:SetAltitude( PatrolFloorAltitude, PatrolCeilingAltitude )
-  self:F2( { PatrolFloorAltitude, PatrolCeilingAltitude } )
-  
-  self.PatrolFloorAltitude = PatrolFloorAltitude
-  self.PatrolCeilingAltitude = PatrolCeilingAltitude
-end
-
-
---- Defines a new patrol route using the @{AI.AI_Patrol#AI_PATROL_ZONE} parameters and settings.
--- @param #AI_A2A_PATROL self
--- @return #AI_A2A_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_A2A_PATROL:onafterPatrol( AIPatrol, From, Event, To )
-  self:F2()
-
-  self:ClearTargetDistance()
-
-  self:__Route( 1 )
-  
-  AIPatrol:OnReSpawn(
-    function( PatrolGroup )
-      self:__Reset( 1 )
-      self:__Route( 5 )
-    end
-  )
-end
-
-
---- This static method is called from the route path within the last task at the last waypoint of the AIPatrol.
--- Note that this method is required, as triggers the next route when patrolling for the AIPatrol.
--- @param Wrapper.Group#GROUP AIPatrol The AI group.
--- @param #AI_A2A_PATROL Fsm The FSM.
-function AI_A2A_PATROL.PatrolRoute( AIPatrol, Fsm )
-
-  AIPatrol:F( { "AI_A2A_PATROL.PatrolRoute:", AIPatrol:GetName() } )
-
-  if AIPatrol and AIPatrol:IsAlive() then
-    Fsm:Route()
-  end
-  
-end
-
-
---- Defines a new patrol route using the @{AI.AI_Patrol#AI_PATROL_ZONE} parameters and settings.
--- @param #AI_A2A_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_A2A_PATROL:onafterRoute( AIPatrol, From, Event, To )
-  self:F2()
-
-  -- When RTB, don't allow anymore the routing.
-  if From == "RTB" then
-    return
-  end
-
-  
-  if AIPatrol and AIPatrol:IsAlive() then
-    
-    local PatrolRoute = {}
-
-    --- Calculate the target route point.
-    
-    local CurrentCoord = AIPatrol:GetCoordinate()
-    
-    -- Random altitude.
-    local altitude=math.random(self.PatrolFloorAltitude, self.PatrolCeilingAltitude)
-      
-    -- Random speed in km/h.
-    local speedkmh = math.random(self.PatrolMinSpeed, self.PatrolMaxSpeed)
-    
-    -- First waypoint is current position.
-    PatrolRoute[1]=CurrentCoord:WaypointAirTurningPoint(nil, speedkmh, {}, "Current")    
-    
-    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
-
-      -- 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()
-  
-    -- Patrol.
-    AIPatrol:Route( PatrolRoute, 0.5)
-  end
-
-end
-

Moose Development/Moose/AI/AI_A2G_BAI.lua

@@ -1,96 +0,0 @@
---- **AI** - Models the process of air to ground BAI engagement for airplanes and helicopters.
---
--- This is a class used in the @{AI.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 -- TODO: Documentation. This class does not exist, unable to determine what it extends.
-
---- Implements the core functions to intercept intruders. Use the Engage trigger to intercept intruders.
---
--- # Developer Note
--- 
--- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
--- Therefore, this class is considered to be deprecated
---
--- ===
--- 
--- @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 @{Core.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 @{Core.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 Wrapper.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

@@ -1,96 +0,0 @@
---- **AI** - Models the process of air to ground engagement for airplanes and helicopters.
---
--- This is a class used in the @{AI.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 TODO: Documentation. This class does not exist, unable to determine what it extends.
-
---- Implements the core functions to intercept intruders. Use the Engage trigger to intercept intruders.
---
--- # Developer Note
--- 
--- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
--- Therefore, this class is considered to be deprecated
---
--- ===
--- 
--- @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 @{Core.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 @{Core.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 Wrapper.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

@@ -1,131 +0,0 @@
---- **AI** - Models the process of air to ground SEAD engagement for airplanes and helicopters.
---
--- This is a class used in the @{AI.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.
--- 
--- 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.
--- 
--- 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.
--- 
--- This cycle will continue.
--- 
--- During the patrol, the AI will detect enemy targets, which are reported through the **Detected** event.
--- 
--- When enemies are detected, the AI will automatically engage the enemy.
--- 
--- Until a fuel or damage threshold has been reached by the AI, or when the AI is commanded to RTB.
--- When the fuel threshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
--- 
--- ## 1. AI_A2G_SEAD constructor
---   
---   * @{#AI_A2G_SEAD.New}(): Creates a new AI_A2G_SEAD object.
---
--- ## 3. Set the Range of Engagement
--- 
--- 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_AIR_PATROL.SetEngageRange}() to define that range.
---
--- # Developer Note
--- 
--- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
--- Therefore, this class is considered to be deprecated
---
--- ===
--- 
--- @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 @{Core.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 )
-  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 @{Core.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 Wrapper.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,840 +0,0 @@
---- **AI** - Models the process of AI air operations.
--- 
--- ===
--- 
--- ### Author: **FlightControl**
--- 
--- ===
--- 
--- @module AI.AI_Air
--- @image MOOSE.JPG
-
----
--- @type AI_AIR
--- @extends Core.Fsm#FSM_CONTROLLABLE
-
---- The AI_AIR class implements the core functions to operate an AI @{Wrapper.Group}.
--- 
--- 
--- # 1) AI_AIR constructor
---   
---   * @{#AI_AIR.New}(): Creates a new AI_AIR object.
--- 
--- # 2) AI_AIR 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
---
--- ## 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.
---
--- # Developer Note
--- 
--- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
--- Therefore, this class is considered to be deprecated
---
--- @field #AI_AIR
-AI_AIR = {
-  ClassName = "AI_AIR",
-}
-
-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_AIR
-  
-  self:SetControllable( AIGroup )
-  
-  self:SetStartState( "Stopped" ) 
-
-  self:AddTransition( "*", "Queue", "Queued" )
-
-  self:AddTransition( "*", "Start", "Started" )
-  
-  --- 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_AIR
-  -- @function [parent=#AI_AIR] OnAfterStart
-  -- @param #AI_AIR self
-  -- @param #string From
-  -- @param #string Event
-  -- @param #string To
-  
-  --- Start Trigger for AI_AIR
-  -- @function [parent=#AI_AIR] Start
-  -- @param #AI_AIR 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_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.
--- @param #string To The To State string.
--- @return #boolean Return false to cancel Transition.
-
---- OnEnter Transition Handler for State Stopped.
--- @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_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.
--- @param #string To The To State string.
--- @return #boolean Return false to cancel Transition.
-
---- OnAfter Transition Handler for Event Stop.
--- @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_AIR] Stop
--- @param #AI_AIR self
-
---- Asynchronous Event Trigger for Event Stop.
--- @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_AIR.
-
---- OnBefore Transition Handler for Event Status.
--- @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.
--- @param #string To The To State string.
--- @return #boolean Return false to cancel Transition.
-
---- OnAfter Transition Handler for Event Status.
--- @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_AIR] Status
--- @param #AI_AIR self
-
---- Asynchronous Event Trigger for Event Status.
--- @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_AIR.
-
---- OnBefore Transition Handler for Event RTB.
--- @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.
--- @param #string To The To State string.
--- @return #boolean Return false to cancel Transition.
-
---- OnAfter Transition Handler for Event RTB.
--- @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_AIR] RTB
--- @param #AI_AIR self
-
---- Asynchronous Event Trigger for Event RTB.
--- @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_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.
--- @param #string To The To State string.
--- @return #boolean Return false to cancel Transition.
-
---- OnEnter Transition Handler for State Returning.
--- @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.
--- @param #string To The To State string.
-
-  self:AddTransition( "Patrolling", "Refuel", "Refuelling" ) 
-
-  --- 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_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_AIR
-  -- @function [parent=#AI_AIR] Refuel
-  -- @param #AI_AIR self
-  
-  --- Refuel Asynchronous Trigger for AI_AIR
-  -- @function [parent=#AI_AIR] __Refuel
-  -- @param #AI_AIR self
-  -- @param #number Delay
-
-  self:AddTransition( "*", "Takeoff", "Airborne" )
-  self:AddTransition( "*", "Return", "Returning" )
-  self:AddTransition( "*", "Hold", "Holding" )
-  self:AddTransition( "*", "Home", "Home" )
-  self:AddTransition( "*", "LostControl", "LostControl" )
-  self:AddTransition( "*", "Fuel", "Fuel" )
-  self:AddTransition( "*", "Damaged", "Damaged" )
-  self:AddTransition( "*", "Eject", "*" )
-  self:AddTransition( "*", "Crash", "Crashed" )
-  self:AddTransition( "*", "PilotDead", "*" )
-  
-  self.IdleCount = 0
-  
-  self.RTBSpeedMaxFactor = 0.6
-  self.RTBSpeedMinFactor = 0.5
-  
-  return self
-end
-
--- @param Wrapper.Group#GROUP self
--- @param Core.Event#EVENTDATA EventData
-function GROUP:OnEventTakeoff( EventData, Fsm )
-  Fsm:Takeoff()
-  self:UnHandleEvent( EVENTS.Takeoff )
-end
-
-
-
-function AI_AIR:SetDispatcher( Dispatcher )
-  self.Dispatcher = Dispatcher
-end
-
-function AI_AIR:GetDispatcher()
-  return self.Dispatcher
-end
-
-function AI_AIR:SetTargetDistance( Coordinate )
-
-  local CurrentCoord = self.Controllable:GetCoordinate()
-  self.TargetDistance = CurrentCoord:Get2DDistance( Coordinate )
-
-  self.ClosestTargetDistance = ( not self.ClosestTargetDistance or self.ClosestTargetDistance > self.TargetDistance ) and self.TargetDistance or self.ClosestTargetDistance
-end
-
-
-function AI_AIR:ClearTargetDistance()
-
-  self.TargetDistance = nil
-  self.ClosestTargetDistance = nil
-end
-
-
---- Sets (modifies) the minimum and maximum speed of the patrol.
--- @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_AIR self
-function AI_AIR:SetSpeed( PatrolMinSpeed, PatrolMaxSpeed )
-  self:F2( { PatrolMinSpeed, PatrolMaxSpeed } )
-  
-  self.PatrolMinSpeed = PatrolMinSpeed
-  self.PatrolMaxSpeed = 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_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_AIR self
-function AI_AIR:SetAltitude( PatrolFloorAltitude, PatrolCeilingAltitude )
-  self:F2( { PatrolFloorAltitude, PatrolCeilingAltitude } )
-  
-  self.PatrolFloorAltitude = PatrolFloorAltitude
-  self.PatrolCeilingAltitude = PatrolCeilingAltitude
-end
-
-
---- Sets the home airbase.
--- @param #AI_AIR self
--- @param Wrapper.Airbase#AIRBASE 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_AIR self
--- @param Wrapper.Group#GROUP TankerName The group name of the tanker as defined within the Mission Editor or spawned.
--- @return #AI_AIR self
-function AI_AIR:SetTanker( TankerName )
-  self:F2( { TankerName } )
-  
-  self.TankerName = TankerName
-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_AIR self
--- @param #number DisengageRadius The disengage range.
--- @return #AI_AIR self
-function AI_AIR:SetDisengageRadius( DisengageRadius )
-  self:F2( { DisengageRadius } )
-  
-  self.DisengageRadius = DisengageRadius
-end
-
---- Set the status checking off.
--- @param #AI_AIR self
--- @return #AI_AIR self
-function AI_AIR:SetStatusOff()
-  self:F2()
-  
-  self.CheckStatus = false
-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 threshold is calculated.
--- When the fuel threshold is reached, the AI will continue for a given time its patrol task in orbit, while a new AIControllable is targeted to the AI_AIR.
--- Once the time is finished, the old AI will return to the base.
--- @param #AI_AIR self
--- @param #number FuelThresholdPercentage The threshold 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.FuelThresholdPercentage = FuelThresholdPercentage
-  self.OutOfFuelOrbitTime = OutOfFuelOrbitTime
-  
-  self.Controllable:OptionRTBBingoFuel( false )
-  
-  return self
-end
-
---- When the AI is damaged beyond a certain threshold, it is required that the AI returns to the home base.
--- However, damage cannot be foreseen early on. 
--- Therefore, when the damage threshold is reached, 
--- 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 threshold will be 0.25.
--- @param #AI_AIR self
--- @param #number PatrolDamageThreshold The threshold in percentage (between 0 and 1) when the AI is considered to be damaged.
--- @return #AI_AIR self
-function AI_AIR:SetDamageThreshold( PatrolDamageThreshold )
-
-  self.PatrolManageDamage = true
-  self.PatrolDamageThreshold = PatrolDamageThreshold
-  
-  return self
-end
-
-
-
---- Defines a new patrol route using the @{AI.AI_Patrol#AI_PATROL_ZONE} parameters and settings.
--- @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:onafterStart( Controllable, From, Event, To )
-
-  self:__Status( 10 ) -- Check status status every 30 seconds.
-  
-  self:HandleEvent( EVENTS.PilotDead, self.OnPilotDead )
-  self:HandleEvent( EVENTS.Crash, self.OnCrash )
-  self:HandleEvent( EVENTS.Ejection, self.OnEjection )
-  
-  Controllable:OptionROEHoldFire()
-  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_AIR self
-function AI_AIR:onbeforeStatus()
-
-  return self.CheckStatus
-end
-
--- @param #AI_AIR self
-function AI_AIR:onafterStatus()
-
-  if self.Controllable and self.Controllable:IsAlive() then
-  
-    local RTB = false
-    
-    local DistanceFromHomeBase = self.HomeAirbase:GetCoordinate():Get2DDistance( self.Controllable:GetCoordinate() )
-    
-    if not self:Is( "Holding" ) and not self:Is( "Returning" ) then
-      local DistanceFromHomeBase = self.HomeAirbase:GetCoordinate():Get2DDistance( self.Controllable:GetCoordinate() )
-      
-      if DistanceFromHomeBase > self.DisengageRadius then
-        self:T( self.Controllable:GetName() .. " is too far from home base, RTB!" )
-        self:Hold( 300 )
-        RTB = false
-      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" ) and not self:is( "Refuelling" )then
-
-      local Fuel = self.Controllable:GetFuelMin()
-
-      -- If the fuel in the controllable is below the threshold percentage,
-      -- then send for refuel in case of a tanker, otherwise RTB.
-      if Fuel < self.FuelThresholdPercentage then
-
-        if self.TankerName then
-          self:T( self.Controllable:GetName() .. " is out of fuel: " .. Fuel .. " ... Refuelling at Tanker!" )
-          self:Refuel()
-        else
-          self:T( 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.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()
-
-    -- 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:T( 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 >= 10 then
-          if Damage ~= InitialLife then
-            self:Damaged()
-          else  
-            self:T( self.Controllable:GetName() .. " control lost! " )
-
-            self:LostControl()
-          end
-        else
-          self.IdleCount = self.IdleCount + 1
-        end
-      end
-    else
-      self.IdleCount = 0
-    end
-
-    if RTB == true then
-      self:__RTB( self.TaskDelay )
-    end
-
-    if not self:Is("Home") then
-      self:__Status( 10 )
-    end
-
-  end
-end
-
-
--- @param Wrapper.Group#GROUP AIGroup
-function AI_AIR.RTBRoute( AIGroup, Fsm )
-
-  AIGroup:F( { "AI_AIR.RTBRoute:", AIGroup:GetName() } )
-
-  if AIGroup:IsAlive() then
-    Fsm:RTB()
-  end
-
-end
-
--- @param Wrapper.Group#GROUP AIGroup
-function AI_AIR.RTBHold( AIGroup, Fsm )
-
-  AIGroup:F( { "AI_AIR.RTBHold:", AIGroup:GetName() } )
-  if AIGroup:IsAlive() then
-    Fsm:__RTB( Fsm.TaskDelay )
-    Fsm:Return()
-    local Task = AIGroup:TaskOrbitCircle( 4000, 400 )
-    AIGroup:SetTask( Task )
-  end
-
-end
-
---- Set the min and max factors on RTB speed. Use this, if your planes are heading back to base too fast. Default values are 0.5 and 0.6. 
--- The RTB speed is calculated as the max speed of the unit multiplied by MinFactor (lower bracket) and multiplied by MaxFactor (upper bracket). 
--- A random value in this bracket is then applied in the waypoint routing generation.
--- @param #AI_AIR self
--- @param #number MinFactor Lower bracket factor. Defaults to 0.5.
--- @param #number MaxFactor Upper bracket factor. Defaults to 0.6.
--- @return #AI_AIR self
-function AI_AIR:SetRTBSpeedFactors(MinFactor,MaxFactor)
-  self.RTBSpeedMaxFactor = MaxFactor or 0.6
-  self.RTBSpeedMinFactor = MinFactor or 0.5
-  return self
-end
-
-
--- @param #AI_AIR self
--- @param Wrapper.Group#GROUP AIGroup
-function AI_AIR:onafterRTB( AIGroup, From, Event, To )
-  self:F( { AIGroup, From, Event, To } )
-
-    if AIGroup and AIGroup:IsAlive() then
-
-    self:T( "Group " .. AIGroup:GetName() .. " ... RTB! ( " .. self:GetState() .. " )" )
-
-    self:ClearTargetDistance()
-    --AIGroup:ClearTasks()
-
-    AIGroup:OptionProhibitAfterburner(true)
-
-    local EngageRoute = {}
-
-    --- Calculate the target route point.
-
-    local FromCoord = AIGroup:GetCoordinate()
-    if not FromCoord then return end
-        
-    local ToTargetCoord = self.HomeAirbase:GetCoordinate() -- coordinate is on land height(!)
-
-    local ToTargetVec3 = ToTargetCoord:GetVec3()
-    ToTargetVec3.y = ToTargetCoord:GetLandHeight()+3000 -- let's set this 1000m/3000 feet above ground
-    local ToTargetCoord2 = COORDINATE:NewFromVec3( ToTargetVec3 )
-
-    if not self.RTBMinSpeed or not self.RTBMaxSpeed then    
-      local RTBSpeedMax = AIGroup:GetSpeedMax()
-      local RTBSpeedMaxFactor = self.RTBSpeedMaxFactor or 0.6
-      local RTBSpeedMinFactor = self.RTBSpeedMinFactor or 0.5
-      self:SetRTBSpeed( RTBSpeedMax * RTBSpeedMinFactor, RTBSpeedMax * RTBSpeedMaxFactor)  
-    end
-
-    local RTBSpeed = math.random( self.RTBMinSpeed, self.RTBMaxSpeed )
-    --local ToAirbaseAngle = FromCoord:GetAngleDegrees( FromCoord:GetDirectionVec3( ToTargetCoord2 ) )
-
-    local Distance = FromCoord:Get2DDistance( ToTargetCoord2 )
-
-    --local ToAirbaseCoord = FromCoord:Translate( 5000, ToAirbaseAngle )
-    local ToAirbaseCoord = ToTargetCoord2
-
-    if Distance < 5000 then
-      self:T( "RTB and near the airbase!" )
-      self:Home()
-      return
-    end
-
-    if not AIGroup:InAir() == true then
-      self:T( "Not anymore in the air, considered Home." )
-      self:Home()
-      return
-    end
-
-
-    --- Create a route point of type air.
-    local FromRTBRoutePoint = FromCoord:WaypointAir( 
-      self.PatrolAltType, 
-      COORDINATE.WaypointType.TurningPoint, 
-      COORDINATE.WaypointAction.TurningPoint, 
-      RTBSpeed, 
-      true 
-    )
-
-    --- Create a route point of type air.
-    local ToRTBRoutePoint = ToAirbaseCoord:WaypointAir( 
-      self.PatrolAltType, 
-      COORDINATE.WaypointType.TurningPoint, 
-      COORDINATE.WaypointAction.TurningPoint, 
-      RTBSpeed, 
-      true 
-    )
-
-    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 ROUTE THE GROUP!
-    AIGroup:Route( EngageRoute, self.TaskDelay )
-
-  end
-
-end
-
--- @param #AI_AIR self
--- @param Wrapper.Group#GROUP AIGroup
-function AI_AIR:onafterHome( AIGroup, From, Event, To )
-  self:F( { AIGroup, From, Event, To } )
-
-  self:T( "Group " .. self.Controllable:GetName() .. " ... Home! ( " .. self:GetState() .. " )" )
-  
-  if AIGroup and AIGroup:IsAlive() then
-  end
-
-end
-
-
-
--- @param #AI_AIR self
--- @param Wrapper.Group#GROUP AIGroup
-function AI_AIR:onafterHold( AIGroup, From, Event, To, HoldTime )
-  self:F( { AIGroup, From, Event, To } )
-
-  self:T( "Group " .. self.Controllable:GetName() .. " ... Holding! ( " .. self:GetState() .. " )" )
-  
-  if AIGroup and AIGroup:IsAlive() then
-    local Coordinate = AIGroup:GetCoordinate()
-    if Coordinate == nil then return end
-    local OrbitTask = AIGroup:TaskOrbitCircle( math.random( self.PatrolFloorAltitude, self.PatrolCeilingAltitude ), self.PatrolMinSpeed, Coordinate )
-    local TimedOrbitTask = AIGroup:TaskControlled( OrbitTask, AIGroup:TaskCondition( nil, nil, nil, nil, HoldTime , nil ) )
-    
-    local RTBTask = AIGroup:TaskFunction( "AI_AIR.RTBHold", self )
-    
-    local OrbitHoldTask = AIGroup:TaskOrbitCircle( 4000, self.PatrolMinSpeed )
-    
-    --AIGroup:SetState( AIGroup, "AI_AIR", self )
-    
-    AIGroup:SetTask( AIGroup:TaskCombo( { TimedOrbitTask, RTBTask, OrbitHoldTask } ), 1 )
-  end
-
-end
-
--- @param Wrapper.Group#GROUP AIGroup
-function AI_AIR.Resume( AIGroup, Fsm )
-
-  AIGroup:T( { "AI_AIR.Resume:", AIGroup:GetName() } )
-  if AIGroup:IsAlive() then
-    Fsm:__RTB( Fsm.TaskDelay )
-  end
-  
-end
-
--- @param #AI_AIR self
--- @param Wrapper.Group#GROUP AIGroup
-function AI_AIR:onafterRefuel( AIGroup, From, Event, To )
-  self:F( { AIGroup, From, Event, To } )
-
-  if AIGroup and AIGroup:IsAlive() then
-  
-    -- Get tanker group.
-    local Tanker = GROUP:FindByName( self.TankerName )
-
-    if Tanker and Tanker:IsAlive() and Tanker:IsAirPlane() then
-
-      self:T( "Group " .. self.Controllable:GetName() .. " ... Refuelling! State=" .. self:GetState() .. ", Refuelling tanker " .. self.TankerName )
-
-      local RefuelRoute = {}
-  
-      --- Calculate the target route point.
-      
-      local FromRefuelCoord = AIGroup:GetCoordinate()
-      local ToRefuelCoord = Tanker:GetCoordinate()
-      local ToRefuelSpeed = math.random( self.PatrolMinSpeed, self.PatrolMaxSpeed )
-      
-      --- Create a route point of type air.
-      local FromRefuelRoutePoint = FromRefuelCoord:WaypointAir(self.PatrolAltType, COORDINATE.WaypointType.TurningPoint, COORDINATE.WaypointAction.TurningPoint, ToRefuelSpeed, true)
-
-      --- Create a route point of type air. NOT used!
-      local ToRefuelRoutePoint = Tanker:GetCoordinate():WaypointAir(self.PatrolAltType, COORDINATE.WaypointType.TurningPoint, COORDINATE.WaypointAction.TurningPoint, ToRefuelSpeed, true)
-  
-      self:F( { ToRefuelSpeed = ToRefuelSpeed } )
-      
-      RefuelRoute[#RefuelRoute+1] = FromRefuelRoutePoint
-      RefuelRoute[#RefuelRoute+1] = ToRefuelRoutePoint
-      
-      AIGroup:OptionROEHoldFire()
-      AIGroup:OptionROTEvadeFire()
-      
-      -- Get Class name for .Resume function
-      local classname=self:GetClassName()
-      
-      -- AI_A2A_CAP can call this function but does not have a .Resume function. Try to fix.
-      if classname=="AI_A2A_CAP" then
-        classname="AI_AIR_PATROL"
-      end
-      
-      env.info("FF refueling classname="..classname)
-  
-      local Tasks = {}
-      Tasks[#Tasks+1] = AIGroup:TaskRefueling()
-      Tasks[#Tasks+1] = AIGroup:TaskFunction(  classname .. ".Resume", self )
-      RefuelRoute[#RefuelRoute].task = AIGroup:TaskCombo( Tasks )
-  
-      AIGroup:Route( RefuelRoute, self.TaskDelay )
-      
-    else
-    
-      -- No tanker defined ==> RTB!
-      self:RTB()
-      
-    end
-    
-  end
-
-end
-    
-
-
--- @param #AI_AIR self
-function AI_AIR:onafterDead()
-  self:SetStatusOff()
-end
-
-
--- @param #AI_AIR self
--- @param Core.Event#EVENTDATA EventData
-function AI_AIR:OnCrash( EventData )
-
-  if self.Controllable:IsAlive() and EventData.IniDCSGroupName == self.Controllable:GetName() then
-    if #self.Controllable:GetUnits() == 1 then
-      self:__Crash( self.TaskDelay, EventData )
-    end
-  end
-end
-
--- @param #AI_AIR self
--- @param Core.Event#EVENTDATA EventData
-function AI_AIR:OnEjection( EventData )
-
-  if self.Controllable:IsAlive() and EventData.IniDCSGroupName == self.Controllable:GetName() then
-    self:__Eject( self.TaskDelay, EventData )
-  end
-end
-
--- @param #AI_AIR self
--- @param Core.Event#EVENTDATA EventData
-function AI_AIR:OnPilotDead( EventData )
-
-  if self.Controllable:IsAlive() and EventData.IniDCSGroupName == self.Controllable:GetName() then
-    self:__PilotDead( self.TaskDelay, EventData )
-  end
-end

Moose Development/Moose/AI/AI_Air_Engage.lua

@@ -1,593 +0,0 @@
---- **AI** - Models the process of air to ground engagement for airplanes and helicopters.
---
--- This is a class used in the @{AI.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.
--- 
--- 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.
--- 
--- 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.
--- 
--- This cycle will continue.
--- 
--- During the patrol, the AI will detect enemy targets, which are reported through the **Detected** event.
--- 
--- When enemies are detected, the AI will automatically engage the enemy.
--- 
--- Until a fuel or damage threshold has been reached by the AI, or when the AI is commanded to RTB.
--- When the fuel threshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
--- 
--- ## 1. AI_AIR_ENGAGE constructor
---   
---   * @{#AI_AIR_ENGAGE.New}(): Creates a new AI_AIR_ENGAGE object.
---
--- ## 2. Set the Zone of Engagement
---
--- An optional @{Core.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.
-  --
-  -- # Developer Note
-  -- 
-  -- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
-  -- Therefore, this class is considered to be deprecated
-  --
--- # Developer Note
--- 
--- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
--- Therefore, this class is considered to be deprecated
---
--- ===
--- 
--- @field #AI_AIR_ENGAGE
-AI_AIR_ENGAGE = {
-  ClassName = "AI_AIR_ENGAGE",
-}
-
-
-
---- Creates a new AI_AIR_ENGAGE object
--- @param #AI_AIR_ENGAGE self
--- @param AI.AI_Air#AI_AIR AI_Air The AI_AIR FSM.
--- @param Wrapper.Group#GROUP AIGroup The AI group.
--- @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 )
-  -- TODO: This function is overwritten below!
-  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  
-  return true
-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:T(string.format("AI_AIR_ENGAGE.___EngageRoute: %s", tostring(AIGroup:GetName())))
-  
-  if AIGroup and AIGroup:IsAlive() then
-    Fsm:__EngageRoute( Fsm.TaskDelay or 0.1, 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.
--- @param Core.Set#SET_UNIT AttackSetUnit Unit set to be attacked.
-function AI_AIR_ENGAGE:onafterEngageRoute( DefenderGroup, From, Event, To, AttackSetUnit )
-  self:T( { 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:CountAlive()
-  
-  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:GetRandomSurely():GetPointVec3()
-      
-      if TargetCoord == nil then
-        self:Return()
-        return
-      end
-      
-      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 )
-      
-      -- TODO: A factor of * 3 is way too close. This causes the AI not to engange until merged sometimes!
-      if TargetDistance <= EngageDistance * 9 then
-
-        --self:T(string.format("AI_AIR_ENGAGE onafterEngageRoute ==> __Engage - target distance = %.1f km", TargetDistance/1000))
-        self:__Engage( 0.1, AttackSetUnit )
-
-      else
-      
-        --self:T(string.format("FF AI_AIR_ENGAGE onafterEngageRoute ==> Routing - target distance = %.1f km", TargetDistance/1000))
-
-        local EngageRoute = {}
-        local AttackTasks = {}
-        
-        --- Calculate the target route point.
-        
-        local FromWP = DefenderCoord:WaypointAir(self.PatrolAltType or "RADIO", COORDINATE.WaypointType.TurningPoint, COORDINATE.WaypointAction.TurningPoint, EngageSpeed, true)
-        
-        EngageRoute[#EngageRoute+1] = FromWP
-  
-        self:SetTargetDistance( TargetCoord ) -- For RTB status check
-        
-        local FromEngageAngle = DefenderCoord:GetAngleDegrees( DefenderCoord:GetDirectionVec3( TargetCoord ) )
-        local ToCoord=DefenderCoord:Translate( EngageDistance, FromEngageAngle, true )
-        
-        local ToWP = ToCoord:WaypointAir(self.PatrolAltType or "RADIO", COORDINATE.WaypointType.TurningPoint, COORDINATE.WaypointAction.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 or 0.1 )
-      end
-
-    end
-  else
-    -- TODO: This will make an A2A Dispatcher CAP flight to return rather than going back to patrolling!
-    self:T( DefenderGroupName .. ": No targets found -> Going RTB")
-    self:Return()
-  end
-end
-
-
--- @param Wrapper.Group#GROUP AIControllable
-function AI_AIR_ENGAGE.___Engage( AIGroup, Fsm, AttackSetUnit )
-
-  Fsm:T(string.format("AI_AIR_ENGAGE.___Engage: %s", tostring(AIGroup:GetName())))
-  
-  if AIGroup and AIGroup:IsAlive() then
-    local delay=Fsm.TaskDelay or 0.1
-    Fsm:__Engage(delay, 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.
--- @param Core.Set#SET_UNIT AttackSetUnit Set of units to be attacked.
-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:CountAlive()
-  self:T({AttackCount = AttackCount})
-  
-  if AttackCount > 0 then
-
-    if DefenderGroup and 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:GetRandomSurely():GetPointVec3()
-      if not TargetCoord then
-          self:Return()
-          return
-      end
-      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", COORDINATE.WaypointType.TurningPoint, COORDINATE.WaypointAction.TurningPoint, EngageSpeed, true)
-      EngageRoute[#EngageRoute+1] = FromWP
-
-      self:SetTargetDistance( TargetCoord ) -- For RTB status check
-
-      local FromEngageAngle = DefenderCoord:GetAngleDegrees( DefenderCoord:GetDirectionVec3( TargetCoord ) )
-      local ToCoord=DefenderCoord:Translate( EngageDistance, FromEngageAngle, true )
-      
-      local ToWP = ToCoord:WaypointAir(self.EngageAltType or "RADIO", COORDINATE.WaypointType.TurningPoint, COORDINATE.WaypointAction.TurningPoint, EngageSpeed, true)
-      EngageRoute[#EngageRoute+1] = ToWP
-      
-      -- TODO: A factor of * 3 this way too low. This causes the AI NOT to engage until very close or even merged sometimes. Some A2A missiles have a much longer range! Needs more frequent updates of the task!
-      if TargetDistance <= EngageDistance * 9 then
-      
-        local AttackUnitTasks = self:CreateAttackUnitTasks( AttackSetUnit, DefenderGroup, EngageAltitude ) -- Polymorphic
-        
-        if #AttackUnitTasks == 0 then
-          self:T( DefenderGroupName .. ": No valid targets found -> Going RTB")
-          self:Return()
-          return
-        else
-          local text=string.format("%s: Engaging targets at distance %.2f NM", DefenderGroupName, UTILS.MetersToNM(TargetDistance))
-          self:T(text)
-          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 or 0.1 )
-      
-    end
-  else
-    -- TODO: This will make an A2A Dispatcher CAP flight to return rather than going back to patrolling!
-    self:T( 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 and AIEngage:IsAlive() then
-    Fsm:__Reset( Fsm.TaskDelay or 0.1 )
-    Fsm:__EngageRoute( Fsm.TaskDelay or 0.2, Fsm.AttackSetUnit )
-  end
-  
-end

Moose Development/Moose/AI/AI_Air_Patrol.lua

@@ -1,391 +0,0 @@
---- **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 @{Core.Zone} by an AI @{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 threshold has been reached by the AI, or when the AI is commanded to RTB.
--- When the fuel threshold 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 thresholds 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_AIR_PATROL.SetEngageRange}() to define that range.
---
--- # Developer Note
--- 
--- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
--- Therefore, this class is considered to be deprecated
---
--- ===
--- 
--- @field #AI_AIR_PATROL
-AI_AIR_PATROL = {
-  ClassName = "AI_AIR_PATROL",
-}
-
---- Creates a new AI_AIR_PATROL object
--- @param #AI_AIR_PATROL self
--- @param AI.AI_Air#AI_AIR AI_Air The AI_AIR FSM.
--- @param Wrapper.Group#GROUP AIGroup The AI group.
--- @param Core.Zone#ZONE_BASE PatrolZone The @{Core.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 @{AI.AI_Patrol#AI_PATROL_ZONE} 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
-
---- This static method is called from the route path within the last task at the last waypoint of the AIPatrol.
--- Note that this method is required, as triggers the next route when patrolling for the AIPatrol.
--- @param Wrapper.Group#GROUP AIPatrol The AI group.
--- @param #AI_AIR_PATROL Fsm The FSM.
-function AI_AIR_PATROL.___PatrolRoute( AIPatrol, Fsm )
-
-  AIPatrol:F( { "AI_AIR_PATROL.___PatrolRoute:", AIPatrol:GetName() } )
-
-  if AIPatrol and AIPatrol:IsAlive() then
-    Fsm:PatrolRoute()
-  end
-
-end
-
---- Defines a new patrol route using the @{AI.AI_Patrol#AI_PATROL_ZONE} 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 and  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", COORDINATE.WaypointType.TurningPoint, COORDINATE.WaypointAction.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_AIR_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, COORDINATE.WaypointType.TurningPoint, COORDINATE.WaypointAction.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
-
---- Resumes the AIPatrol
--- @param Wrapper.Group#GROUP AIPatrol
--- @param Core.Fsm#FSM Fsm
-function AI_AIR_PATROL.Resume( AIPatrol, Fsm )
-
-  AIPatrol:F( { "AI_AIR_PATROL.Resume:", AIPatrol:GetName() } )
-  if AIPatrol and AIPatrol:IsAlive() then
-    Fsm:__Reset( Fsm.TaskDelay )
-    Fsm:__PatrolRoute( Fsm.TaskDelay )
-  end
-
-end

Moose Development/Moose/AI/AI_Air_Squadron.lua

@@ -1,294 +0,0 @@
---- **AI** - Models squadrons for airplanes and helicopters.
---
--- This is a class used in the @{AI.AI_Air_Dispatcher} and derived dispatcher classes.
--- 
--- ===
--- 
--- ### Author: **FlightControl**
--- 
--- ===       
---
--- @module AI.AI_Air_Squadron
--- @image MOOSE.JPG
-
-
-
--- @type AI_AIR_SQUADRON
--- @extends Core.Base#BASE
-
-
---- Implements the core functions modeling squadrons for airplanes and helicopters.
---
--- # Developer Note
--- 
--- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
--- Therefore, this class is considered to be deprecated
---
--- ===
--- 
--- @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:T( { 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_BAI.lua

@@ -1,651 +0,0 @@
---- **AI** - Peform Battlefield Area Interdiction (BAI) within an engagement zone.
---
--- **Features:**
--- 
---   * Hold and standby within a patrol zone.
---   * Engage upon command the assigned targets within an engagement zone.
---   * Loop the zone until all targets are eliminated.
---   * Trigger different events upon the results achieved.
---   * After combat, return to the patrol zone and hold.
---   * RTB when commanded or after out of fuel.
---
--- ===
--- 
--- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AI/AI_BAI)
--- 
--- ===
--- 
--- ### [YouTube Playlist]()
--- 
--- ===
--- 
--- ### Author: **FlightControl**
--- ### Contributions: 
--- 
---   * **Gunterlund**: Test case revision.
--- 
--- ===
---
--- @module AI.AI_BAI
--- @image AI_Battlefield_Air_Interdiction.JPG
-
-
---- AI_BAI_ZONE class
--- @type AI_BAI_ZONE
--- @field Wrapper.Controllable#CONTROLLABLE AIControllable The @{Wrapper.Controllable} patrolling.
--- @field Core.Zone#ZONE_BASE TargetZone The @{Core.Zone} where the patrol needs to be executed.
--- @extends AI.AI_Patrol#AI_PATROL_ZONE
-
---- Implements the core functions to provide BattleGround Air Interdiction in an Engage @{Core.Zone} by an AIR @{Wrapper.Controllable} or @{Wrapper.Group}.
--- 
--- The AI_BAI_ZONE runs a process. It holds an AI in a Patrol Zone and when the AI is commanded to engage, it will fly to an Engage Zone.
--- 
--- ![HoldAndEngage](..\Presentations\AI_BAI\Dia3.JPG)
--- 
--- The AI_BAI_ZONE is assigned a @{Wrapper.Group} and this must be done before the AI_BAI_ZONE process can be started through the **Start** event.
---  
--- ![Start Event](..\Presentations\AI_BAI\Dia4.JPG)
--- 
--- Upon started, The AI will **Route** itself towards the random 3D point within a 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.
--- This cycle will continue until a fuel or damage threshold has been reached by the AI, or when the AI is commanded to RTB.
--- 
--- ![Route Event](..\Presentations\AI_BAI\Dia5.JPG)
--- 
--- When the AI is commanded to provide BattleGround Air Interdiction (through the event **Engage**), the AI will fly towards the Engage Zone.
--- Any target that is detected in the Engage Zone will be reported and will be destroyed by the AI.
--- 
--- ![Engage Event](..\Presentations\AI_BAI\Dia6.JPG)
--- 
--- The AI will detect the targets and will only destroy the targets within the Engage Zone.
--- 
--- ![Engage Event](..\Presentations\AI_BAI\Dia7.JPG)
--- 
--- Every target that is destroyed, is reported< by the AI.
--- 
--- ![Engage Event](..\Presentations\AI_BAI\Dia8.JPG)
--- 
--- Note that the AI does not know when the Engage Zone is cleared, and therefore will keep circling in the zone. 
---
--- ![Engage Event](..\Presentations\AI_BAI\Dia9.JPG)
--- 
--- Until it is notified through the event **Accomplish**, which is to be triggered by an observing party:
--- 
---   * a FAC
---   * a timed event
---   * a menu option selected by a human
---   * a condition
---   * others ...
--- 
--- ![Engage Event](..\Presentations\AI_BAI\Dia10.JPG)
--- 
--- When the AI has accomplished the Bombing, it will fly back to the Patrol Zone.
--- 
--- ![Engage Event](..\Presentations\AI_BAI\Dia11.JPG)
--- 
--- It will keep patrolling there, until it is notified to RTB or move to another BOMB Zone.
--- It can be notified to go RTB through the **RTB** event.
--- 
--- When the fuel threshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
--- 
--- ![Engage Event](..\Presentations\AI_BAI\Dia12.JPG)
---
--- # 1. AI_BAI_ZONE constructor
---
---   * @{#AI_BAI_ZONE.New}(): Creates a new AI_BAI_ZONE object.
---
--- ## 2. AI_BAI_ZONE is a FSM
--- 
--- ![Process](..\Presentations\AI_BAI\Dia2.JPG)
--- 
--- ### 2.1. AI_BAI_ZONE 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 targets in the Engage Zone, executing BOMB.
---   * **Returning** ( Group ): The AI is returning to Base..
--- 
--- ### 2.2. AI_BAI_ZONE Events
--- 
---   * **@{AI.AI_Patrol#AI_PATROL_ZONE.Start}**: Start the process.
---   * **@{AI.AI_Patrol#AI_PATROL_ZONE.Route}**: Route the AI to a new random 3D point within the Patrol Zone.
---   * **@{#AI_BAI_ZONE.Engage}**: Engage the AI to provide BOMB in the Engage Zone, destroying any target it finds.
---   * **@{#AI_BAI_ZONE.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_BAI_ZONE.Destroy}**: The AI has destroyed a target @{Wrapper.Unit}.
---   * **@{#AI_BAI_ZONE.Destroyed}**: The AI has destroyed all target @{Wrapper.Unit}s assigned in the BOMB task.
---   * **Status**: The AI is checking status (fuel and damage). When the thresholds have been reached, the AI will RTB.
--- 
--- ## 3. Modify the Engage Zone behaviour to pinpoint a **map object** or **scenery object**
--- 
--- Use the method @{#AI_BAI_ZONE.SearchOff}() to specify that the EngageZone is not to be searched for potential targets (UNITs), but that the center of the zone
--- is the point where a map object is to be destroyed (like a bridge).
--- 
--- Example:
--- 
---      -- Tell the BAI not to search for potential targets in the BAIEngagementZone, but rather use the center of the BAIEngagementZone as the bombing location.
---      AIBAIZone:SearchOff()
--- 
--- Searching can be switched back on with the method @{#AI_BAI_ZONE.SearchOn}(). Use the method @{#AI_BAI_ZONE.SearchOnOff}() to flexibily switch searching on or off.
---
--- # Developer Note
--- 
--- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
--- Therefore, this class is considered to be deprecated
---
--- ===
--- 
--- @field #AI_BAI_ZONE
-AI_BAI_ZONE = {
-  ClassName = "AI_BAI_ZONE",
-}
-
-
-
---- Creates a new AI_BAI_ZONE object
--- @param #AI_BAI_ZONE self
--- @param Core.Zone#ZONE_BASE PatrolZone The @{Core.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.Controllable} in km/h.
--- @param DCS#Speed  PatrolMaxSpeed The maximum speed of the @{Wrapper.Controllable} in km/h.
--- @param Core.Zone#ZONE_BASE EngageZone The zone where the engage will happen.
--- @param DCS#AltitudeType PatrolAltType The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to RADIO
--- @return #AI_BAI_ZONE self
-function AI_BAI_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, EngageZone, PatrolAltType )
-
-  -- Inherits from BASE
-  local self = BASE:Inherit( self, AI_PATROL_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType ) ) -- #AI_BAI_ZONE
-
-  self.EngageZone = EngageZone
-  self.Accomplished = false
-  
-  self:SetDetectionZone( self.EngageZone )
-  self:SearchOn()
-
-  self:AddTransition( { "Patrolling", "Engaging" }, "Engage", "Engaging" ) -- FSM_CONTROLLABLE Transition for type #AI_BAI_ZONE.
-
-  --- OnBefore Transition Handler for Event Engage.
-  -- @function [parent=#AI_BAI_ZONE] OnBeforeEngage
-  -- @param #AI_BAI_ZONE 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. 
-  -- @return #boolean Return false to cancel Transition.
-  
-  --- OnAfter Transition Handler for Event Engage.
-  -- @function [parent=#AI_BAI_ZONE] OnAfterEngage
-  -- @param #AI_BAI_ZONE 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 Engage.
-  -- @function [parent=#AI_BAI_ZONE] Engage
-  -- @param #AI_BAI_ZONE self
-  -- @param #number EngageSpeed (optional) The speed the Group will hold when engaging to the target zone.
-  -- @param DCS#Distance EngageAltitude (optional) Desired altitude to perform the unit engagement.
-  -- @param DCS#AI.Task.WeaponExpend EngageWeaponExpend (optional) Determines how much weapon will be released at each attack. 
-  -- If parameter is not defined the unit / controllable will choose expend on its own discretion.
-  -- Use the structure @{DCS#AI.Task.WeaponExpend} to define the amount of weapons to be release at each attack.
-  -- @param #number EngageAttackQty (optional) This parameter limits maximal quantity of attack. The aicraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aicraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.
-  -- @param DCS#Azimuth EngageDirection (optional) Desired ingress direction from the target to the attacking aircraft. Controllable/aircraft will make its attacks from the direction. Of course if there is no way to attack from the direction due the terrain controllable/aircraft will choose another direction.
-  
-  --- Asynchronous Event Trigger for Event Engage.
-  -- @function [parent=#AI_BAI_ZONE] __Engage
-  -- @param #AI_BAI_ZONE self
-  -- @param #number Delay The delay in seconds.
-  -- @param #number EngageSpeed (optional) The speed the Group will hold when engaging to the target zone.
-  -- @param DCS#Distance EngageAltitude (optional) Desired altitude to perform the unit engagement.
-  -- @param DCS#AI.Task.WeaponExpend EngageWeaponExpend (optional) Determines how much weapon will be released at each attack. 
-  -- If parameter is not defined the unit / controllable will choose expend on its own discretion.
-  -- Use the structure @{DCS#AI.Task.WeaponExpend} to define the amount of weapons to be release at each attack.
-  -- @param #number EngageAttackQty (optional) This parameter limits maximal quantity of attack. The aicraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aicraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.
-  -- @param DCS#Azimuth EngageDirection (optional) Desired ingress direction from the target to the attacking aircraft. Controllable/aircraft will make its attacks from the direction. Of course if there is no way to attack from the direction due the terrain controllable/aircraft will choose another direction.
-
---- OnLeave Transition Handler for State Engaging.
--- @function [parent=#AI_BAI_ZONE] OnLeaveEngaging
--- @param #AI_BAI_ZONE 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.
--- @return #boolean Return false to cancel Transition.
-
---- OnEnter Transition Handler for State Engaging.
--- @function [parent=#AI_BAI_ZONE] OnEnterEngaging
--- @param #AI_BAI_ZONE 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.
-
-  self:AddTransition( "Engaging", "Target", "Engaging" ) -- FSM_CONTROLLABLE Transition for type #AI_BAI_ZONE.
-
-  self:AddTransition( "Engaging", "Fired", "Engaging" ) -- FSM_CONTROLLABLE Transition for type #AI_BAI_ZONE.
-  
-  --- OnBefore Transition Handler for Event Fired.
-  -- @function [parent=#AI_BAI_ZONE] OnBeforeFired
-  -- @param #AI_BAI_ZONE 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.
-  -- @return #boolean Return false to cancel Transition.
-  
-  --- OnAfter Transition Handler for Event Fired.
-  -- @function [parent=#AI_BAI_ZONE] OnAfterFired
-  -- @param #AI_BAI_ZONE 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 Fired.
-  -- @function [parent=#AI_BAI_ZONE] Fired
-  -- @param #AI_BAI_ZONE self
-  
-  --- Asynchronous Event Trigger for Event Fired.
-  -- @function [parent=#AI_BAI_ZONE] __Fired
-  -- @param #AI_BAI_ZONE self
-  -- @param #number Delay The delay in seconds.
-
-  self:AddTransition( "*", "Destroy", "*" ) -- FSM_CONTROLLABLE Transition for type #AI_BAI_ZONE.
-
-  --- OnBefore Transition Handler for Event Destroy.
-  -- @function [parent=#AI_BAI_ZONE] OnBeforeDestroy
-  -- @param #AI_BAI_ZONE 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.
-  -- @return #boolean Return false to cancel Transition.
-  
-  --- OnAfter Transition Handler for Event Destroy.
-  -- @function [parent=#AI_BAI_ZONE] OnAfterDestroy
-  -- @param #AI_BAI_ZONE 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 Destroy.
-  -- @function [parent=#AI_BAI_ZONE] Destroy
-  -- @param #AI_BAI_ZONE self
-  
-  --- Asynchronous Event Trigger for Event Destroy.
-  -- @function [parent=#AI_BAI_ZONE] __Destroy
-  -- @param #AI_BAI_ZONE self
-  -- @param #number Delay The delay in seconds.
-
-
-  self:AddTransition( "Engaging", "Abort", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_BAI_ZONE.
-
-  --- OnBefore Transition Handler for Event Abort.
-  -- @function [parent=#AI_BAI_ZONE] OnBeforeAbort
-  -- @param #AI_BAI_ZONE 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.
-  -- @return #boolean Return false to cancel Transition.
-  
-  --- OnAfter Transition Handler for Event Abort.
-  -- @function [parent=#AI_BAI_ZONE] OnAfterAbort
-  -- @param #AI_BAI_ZONE 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 Abort.
-  -- @function [parent=#AI_BAI_ZONE] Abort
-  -- @param #AI_BAI_ZONE self
-  
-  --- Asynchronous Event Trigger for Event Abort.
-  -- @function [parent=#AI_BAI_ZONE] __Abort
-  -- @param #AI_BAI_ZONE self
-  -- @param #number Delay The delay in seconds.
-
-  self:AddTransition( "Engaging", "Accomplish", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_BAI_ZONE.
-
-  --- OnBefore Transition Handler for Event Accomplish.
-  -- @function [parent=#AI_BAI_ZONE] OnBeforeAccomplish
-  -- @param #AI_BAI_ZONE 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.
-  -- @return #boolean Return false to cancel Transition.
-  
-  --- OnAfter Transition Handler for Event Accomplish.
-  -- @function [parent=#AI_BAI_ZONE] OnAfterAccomplish
-  -- @param #AI_BAI_ZONE 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 Accomplish.
-  -- @function [parent=#AI_BAI_ZONE] Accomplish
-  -- @param #AI_BAI_ZONE self
-  
-  --- Asynchronous Event Trigger for Event Accomplish.
-  -- @function [parent=#AI_BAI_ZONE] __Accomplish
-  -- @param #AI_BAI_ZONE self
-  -- @param #number Delay The delay in seconds.  
-
-  return self
-end
-
-
---- Set the Engage Zone where the AI is performing BOMB. Note that if the EngageZone is changed, the AI needs to re-detect targets.
--- @param #AI_BAI_ZONE self
--- @param Core.Zone#ZONE EngageZone The zone where the AI is performing BOMB.
--- @return #AI_BAI_ZONE self
-function AI_BAI_ZONE:SetEngageZone( EngageZone )
-  self:F2()
-
-  if EngageZone then  
-    self.EngageZone = EngageZone
-  else
-    self.EngageZone = nil
-  end
-end
-
-
---- Specifies whether to search for potential targets in the zone, or let the center of the zone be the bombing coordinate.
--- AI_BAI_ZONE will search for potential targets by default.
--- @param #AI_BAI_ZONE self
--- @return #AI_BAI_ZONE
-function AI_BAI_ZONE:SearchOnOff( Search )
-
-  self.Search = Search
-  
-  return self
-end
-
---- If Search is Off, the current zone coordinate will be the center of the bombing.
--- @param #AI_BAI_ZONE self
--- @return #AI_BAI_ZONE
-function AI_BAI_ZONE:SearchOff()
-
-  self:SearchOnOff( false )
-
-  return self
-end
-
-
---- If Search is On, BAI will search for potential targets in the zone.
--- @param #AI_BAI_ZONE self
--- @return #AI_BAI_ZONE
-function AI_BAI_ZONE:SearchOn()
-
-  self:SearchOnOff( true )
-
-  return self
-end
-
-
---- onafter State Transition for Event Start.
--- @param #AI_BAI_ZONE 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_BAI_ZONE:onafterStart( Controllable, From, Event, To )
-
-  -- Call the parent Start event handler
-  self:GetParent(self).onafterStart( self, Controllable, From, Event, To )
-  self:HandleEvent( EVENTS.Dead )
-  
-  self:SetDetectionDeactivated() -- When not engaging, set the detection off.
-end
-
--- @param Wrapper.Controllable#CONTROLLABLE AIControllable
-function _NewEngageRoute( AIControllable )
-
-  AIControllable:T( "NewEngageRoute" )
-  local EngageZone = AIControllable:GetState( AIControllable, "EngageZone" ) -- AI.AI_BAI#AI_BAI_ZONE
-  EngageZone:__Engage( 1, EngageZone.EngageSpeed, EngageZone.EngageAltitude, EngageZone.EngageWeaponExpend, EngageZone.EngageAttackQty, EngageZone.EngageDirection )
-end
-
-
--- @param #AI_BAI_ZONE 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_BAI_ZONE:onbeforeEngage( Controllable, From, Event, To )
-  
-  if self.Accomplished == true then
-    return false
-  end
-end
-
--- @param #AI_BAI_ZONE 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_BAI_ZONE:onafterTarget( Controllable, From, Event, To )
-  self:F({"onafterTarget",self.Search,Controllable:IsAlive()})
-  
-  
-
-  if Controllable:IsAlive() then
-
-    local AttackTasks = {}
-
-    if self.Search == true then
-      for DetectedUnit, Detected in pairs( self.DetectedUnits ) do
-        local DetectedUnit = DetectedUnit -- Wrapper.Unit#UNIT
-        if DetectedUnit:IsAlive() then
-          if DetectedUnit:IsInZone( self.EngageZone ) then
-            if Detected == true then
-              self:F( {"Target: ", DetectedUnit } )
-              self.DetectedUnits[DetectedUnit] = false
-              local AttackTask = Controllable:TaskAttackUnit( DetectedUnit, false, self.EngageWeaponExpend, self.EngageAttackQty, self.EngageDirection, self.EngageAltitude, nil )
-              self.Controllable:PushTask( AttackTask, 1 )
-            end
-          end
-        else
-          self.DetectedUnits[DetectedUnit] = nil
-        end
-      end
-    else
-      self:F("Attack zone")
-      local AttackTask = Controllable:TaskAttackMapObject( 
-        self.EngageZone:GetPointVec2():GetVec2(),
-        true, 
-        self.EngageWeaponExpend, 
-        self.EngageAttackQty, 
-        self.EngageDirection,
-        self.EngageAltitude
-      )
-      self.Controllable:PushTask( AttackTask, 1 )
-    end
-
-    self:__Target( -10 )
-
-  end
-end
-
-
--- @param #AI_BAI_ZONE 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_BAI_ZONE:onafterAbort( Controllable, From, Event, To )
-  Controllable:ClearTasks()
-  self:__Route( 1 )
-end
-
--- @param #AI_BAI_ZONE 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.
--- @param #number EngageSpeed (optional) The speed the Group will hold when engaging to the target zone.
--- @param DCS#Distance EngageAltitude (optional) Desired altitude to perform the unit engagement.
--- @param DCS#AI.Task.WeaponExpend EngageWeaponExpend (optional) Determines how much weapon will be released at each attack. If parameter is not defined the unit / controllable will choose expend on its own discretion.
--- @param #number EngageAttackQty (optional) This parameter limits maximal quantity of attack. The aicraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aicraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.
--- @param DCS#Azimuth EngageDirection (optional) Desired ingress direction from the target to the attacking aircraft. Controllable/aircraft will make its attacks from the direction. Of course if there is no way to attack from the direction due the terrain controllable/aircraft will choose another direction.
-function AI_BAI_ZONE:onafterEngage( Controllable, From, Event, To, 
-                                    EngageSpeed, 
-                                    EngageAltitude, 
-                                    EngageWeaponExpend, 
-                                    EngageAttackQty, 
-                                    EngageDirection )
-
-  self:F("onafterEngage")
-
-  self.EngageSpeed = EngageSpeed or 400
-  self.EngageAltitude = EngageAltitude or 2000
-  self.EngageWeaponExpend = EngageWeaponExpend
-  self.EngageAttackQty = EngageAttackQty
-  self.EngageDirection = EngageDirection
-
-  if Controllable:IsAlive() then
-
-    local EngageRoute = {}
-
-    --- Calculate the current route point.
-    local CurrentVec2 = self.Controllable:GetVec2()
-    
-    --DONE: Create GetAltitude function for GROUP, and delete GetUnit(1).
-    local CurrentAltitude = self.Controllable:GetAltitude()
-    local CurrentPointVec3 = COORDINATE:New( CurrentVec2.x, CurrentAltitude, CurrentVec2.y )
-    local ToEngageZoneSpeed = self.PatrolMaxSpeed
-    local CurrentRoutePoint = CurrentPointVec3:WaypointAir( 
-        self.PatrolAltType, 
-        COORDINATE.WaypointType.TurningPoint, 
-        COORDINATE.WaypointAction.TurningPoint, 
-        self.EngageSpeed, 
-        true 
-      )
-    
-    EngageRoute[#EngageRoute+1] = CurrentRoutePoint
-
-    local AttackTasks = {}
-    
-    if self.Search == true then
-  
-      for DetectedUnitID, DetectedUnitData in pairs( self.DetectedUnits ) do
-        local DetectedUnit = DetectedUnitData -- Wrapper.Unit#UNIT
-        self:T( DetectedUnit )
-        if DetectedUnit:IsAlive() then
-          if DetectedUnit:IsInZone( self.EngageZone ) then
-            self:F( {"Engaging ", DetectedUnit } )
-            AttackTasks[#AttackTasks+1] = Controllable:TaskBombing( 
-              DetectedUnit:GetPointVec2():GetVec2(),
-              true, 
-              EngageWeaponExpend, 
-              EngageAttackQty, 
-              EngageDirection,
-              EngageAltitude 
-            )
-          end
-        else
-          self.DetectedUnits[DetectedUnit] = nil
-        end
-      end
-    else
-      self:F("Attack zone")
-      AttackTasks[#AttackTasks+1] = Controllable:TaskAttackMapObject( 
-        self.EngageZone:GetPointVec2():GetVec2(),
-        true, 
-        EngageWeaponExpend, 
-        EngageAttackQty, 
-        EngageDirection,
-        EngageAltitude 
-      )
-    end
-
-    EngageRoute[#EngageRoute].task = Controllable:TaskCombo( AttackTasks )
-
-    --- Define a random point in the @{Core.Zone}. The AI will fly to that point within the zone.
-    
-      --- Find a random 2D point in EngageZone.
-    local ToTargetVec2 = self.EngageZone:GetRandomVec2()
-    self:T2( ToTargetVec2 )
-
-    --- Obtain a 3D @{Point} from the 2D point + altitude.
-    local ToTargetPointVec3 = COORDINATE:New( ToTargetVec2.x, self.EngageAltitude, ToTargetVec2.y )
-    
-    --- Create a route point of type air.
-    local ToTargetRoutePoint = ToTargetPointVec3:WaypointAir( 
-      self.PatrolAltType, 
-      COORDINATE.WaypointType.TurningPoint, 
-      COORDINATE.WaypointAction.TurningPoint, 
-      self.EngageSpeed, 
-      true 
-    )
-    
-    EngageRoute[#EngageRoute+1] = ToTargetRoutePoint
-
-    Controllable:OptionROEOpenFire()
-    Controllable:OptionROTVertical()
-
-    --- Now we're going to do something special, we're going to call a function from a waypoint action at the AIControllable...
-    Controllable:WayPointInitialize( EngageRoute )
-    
-    --- Do a trick, link the NewEngageRoute function of the object to the AIControllable in a temporary variable ...
-    Controllable:SetState( Controllable, "EngageZone", self )
-
-    Controllable:WayPointFunction( #EngageRoute, 1, "_NewEngageRoute" )
-
-    --- NOW ROUTE THE GROUP!
-    Controllable:WayPointExecute( 1 )
-
-    self:SetRefreshTimeInterval( 2 )
-    self:SetDetectionActivated()
-    self:__Target( -2 ) -- Start targeting
-  end
-end
-
-
--- @param #AI_BAI_ZONE 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_BAI_ZONE:onafterAccomplish( Controllable, From, Event, To )
-  self.Accomplished = true
-  self:SetDetectionDeactivated()
-end
-
-
--- @param #AI_BAI_ZONE 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.
--- @param Core.Event#EVENTDATA EventData
-function AI_BAI_ZONE:onafterDestroy( Controllable, From, Event, To, EventData )
-
-  if EventData.IniUnit then
-    self.DetectedUnits[EventData.IniUnit] = nil
-  end
-end
-
-
--- @param #AI_BAI_ZONE self
--- @param Core.Event#EVENTDATA EventData
-function AI_BAI_ZONE:OnEventDead( EventData )
-  self:F( { "EventDead", EventData } )
-
-  if EventData.IniDCSUnit then
-    if self.DetectedUnits and self.DetectedUnits[EventData.IniUnit] then
-      self:__Destroy( 1, EventData )
-    end
-  end
-end
-
-

Moose Development/Moose/AI/AI_Balancer.lua

@@ -1,307 +0,0 @@
---- **AI** - Balance player slots with AI to create an engaging simulation environment, independent of the amount of players. 
--- 
--- **Features:**
--- 
---   * Automatically spawn AI as a replacement of free player slots for a coalition.
---   * Make the AI to perform tasks.
---   * Define a maximum amount of AI to be active at the same time.
---   * Configure the behaviour of AI when a human joins a slot for which an AI is active.
--- 
--- ===
--- 
--- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AI/AI_Balancer)
--- 
--- ===
--- 
--- ### [YouTube Playlist](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl2CJVIrL1TdAumuVS8n64B7)
--- 
--- ===
--- 
--- ### Author: **FlightControl**
--- ### Contributions: 
--- 
---   * **Dutch_Baron**: Working together with James has resulted in the creation of the AI_BALANCER class. James has shared his ideas on balancing AI with air units, and together we made a first design which you can use now :-)
--- 
--- ===
--- 
--- @module AI.AI_Balancer
--- @image AI_Balancing.JPG
-
--- @type AI_BALANCER
--- @field Core.Set#SET_CLIENT SetClient
--- @field Core.Spawn#SPAWN SpawnAI
--- @field Wrapper.Group#GROUP Test
--- @extends Core.Fsm#FSM_SET
-
-
---- Monitors and manages as many replacement AI groups as there are
--- CLIENTS in a SET\_CLIENT collection, which are not occupied by human players. 
--- In other words, use AI_BALANCER to simulate human behaviour by spawning in replacement AI in multi player missions.
--- 
--- The parent class @{Core.Fsm#FSM_SET} manages the functionality to control the Finite State Machine (FSM). 
--- The mission designer can tailor the behaviour of the AI_BALANCER, by defining event and state transition methods.
--- An explanation about state and event transition methods can be found in the @{Core.Fsm} module documentation.
--- 
--- The mission designer can tailor the AI_BALANCER behaviour, by implementing a state or event handling method for the following:
--- 
---   * @{#AI_BALANCER.OnAfterSpawned}( AISet, From, Event, To, AIGroup ): Define to add extra logic when an AI is spawned.
--- 
--- ## 1. AI_BALANCER construction
--- 
--- Create a new AI_BALANCER object with the @{#AI_BALANCER.New}() method:
--- 
--- ## 2. AI_BALANCER is a FSM
--- 
--- ![Process](..\Presentations\AI_BALANCER\Dia13.JPG)
--- 
--- ### 2.1. AI_BALANCER States
--- 
---   * **Monitoring** ( Set ): Monitoring the Set if all AI is spawned for the Clients.
---   * **Spawning** ( Set, ClientName ): There is a new AI group spawned with ClientName as the name of reference.
---   * **Spawned** ( Set, AIGroup ): A new AI has been spawned. You can handle this event to customize the AI behaviour with other AI FSMs or own processes.
---   * **Destroying** ( Set, AIGroup ): The AI is being destroyed.
---   * **Returning** ( Set, AIGroup ): The AI is returning to the airbase specified by the ReturnToAirbase methods. Handle this state to customize the return behaviour of the AI, if any.
--- 
--- ### 2.2. AI_BALANCER Events
--- 
---   * **Monitor** ( Set ): Every 10 seconds, the Monitor event is triggered to monitor the Set.
---   * **Spawn** ( Set, ClientName ): Triggers when there is a new AI group to be spawned with ClientName as the name of reference.
---   * **Spawned** ( Set, AIGroup ): Triggers when a new AI has been spawned. You can handle this event to customize the AI behaviour with other AI FSMs or own processes.
---   * **Destroy** ( Set, AIGroup ): The AI is being destroyed.
---   * **Return** ( Set, AIGroup ): The AI is returning to the airbase specified by the ReturnToAirbase methods.
---    
--- ## 3. AI_BALANCER spawn interval for replacement AI
--- 
--- Use the method @{#AI_BALANCER.InitSpawnInterval}() to set the earliest and latest interval in seconds that is waited until a new replacement AI is spawned.
--- 
--- ## 4. AI_BALANCER returns AI to Airbases
--- 
--- By default, When a human player joins a slot that is AI_BALANCED, the AI group will be destroyed by default. 
--- However, there are 2 additional options that you can use to customize the destroy behaviour.
--- When a human player joins a slot, you can configure to let the AI return to:
--- 
---    * @{#AI_BALANCER.ReturnToHomeAirbase}: Returns the AI to the **home** @{Wrapper.Airbase#AIRBASE}.
---    * @{#AI_BALANCER.ReturnToNearestAirbases}: Returns the AI to the **nearest friendly** @{Wrapper.Airbase#AIRBASE}.
--- 
--- Note that when AI returns to an airbase, the AI_BALANCER will trigger the **Return** event and the AI will return, 
--- otherwise the AI_BALANCER will trigger a **Destroy** event, and the AI will be destroyed.
---
--- # Developer Note
--- 
--- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
--- Therefore, this class is considered to be deprecated
---
--- @field #AI_BALANCER
-AI_BALANCER = {
-  ClassName = "AI_BALANCER",
-  PatrolZones = {},
-  AIGroups = {},
-  Earliest = 5, -- Earliest a new AI can be spawned is in 5 seconds.
-  Latest = 60, -- Latest a new AI can be spawned is in 60 seconds.
-}
-
-
-
---- Creates a new AI_BALANCER object
--- @param #AI_BALANCER self
--- @param Core.Set#SET_CLIENT SetClient A SET\_CLIENT object that will contain the CLIENT objects to be monitored if they are alive or not (joined by a player).
--- @param Core.Spawn#SPAWN SpawnAI The default Spawn object to spawn new AI Groups when needed.
--- @return #AI_BALANCER
-function AI_BALANCER:New( SetClient, SpawnAI )
-  
-  -- Inherits from BASE
-  local self = BASE:Inherit( self, FSM_SET:New( SET_GROUP:New() ) ) -- AI.AI_Balancer#AI_BALANCER
-  
-  -- TODO: Define the OnAfterSpawned event
-  self:SetStartState( "None" )
-  self:AddTransition( "*", "Monitor", "Monitoring" )
-  self:AddTransition( "*", "Spawn", "Spawning" )
-  self:AddTransition( "Spawning", "Spawned", "Spawned" )
-  self:AddTransition( "*", "Destroy", "Destroying" )
-  self:AddTransition( "*", "Return", "Returning" )
-  
-  self.SetClient = SetClient
-  self.SetClient:FilterOnce()
-  self.SpawnAI = SpawnAI
-  
-  self.SpawnQueue = {}
-
-  self.ToNearestAirbase = false
-  self.ToHomeAirbase = false
-  
-  self:__Monitor( 1 )
-
-  return self
-end
-
---- Sets the earliest to the latest interval in seconds how long AI_BALANCER will wait to spawn a new AI.
--- Provide 2 identical seconds if the interval should be a fixed amount of seconds.
--- @param #AI_BALANCER self
--- @param #number Earliest The earliest a new AI can be spawned in seconds.
--- @param #number Latest The latest a new AI can be spawned in seconds.
--- @return self
-function AI_BALANCER:InitSpawnInterval( Earliest, Latest )
-
-  self.Earliest = Earliest
-  self.Latest = Latest
-  
-  return self
-end
-
---- Returns the AI to the nearest friendly @{Wrapper.Airbase#AIRBASE}.
--- @param #AI_BALANCER self
--- @param DCS#Distance ReturnThresholdRange If there is an enemy @{Wrapper.Client#CLIENT} within the ReturnThresholdRange given in meters, the AI will not return to the nearest @{Wrapper.Airbase#AIRBASE}.
--- @param Core.Set#SET_AIRBASE ReturnAirbaseSet The SET of @{Core.Set#SET_AIRBASE}s to evaluate where to return to.
-function AI_BALANCER:ReturnToNearestAirbases( ReturnThresholdRange, ReturnAirbaseSet )
-
-  self.ToNearestAirbase = true
-  self.ReturnThresholdRange = ReturnThresholdRange
-  self.ReturnAirbaseSet = ReturnAirbaseSet
-end
-
---- Returns the AI to the home @{Wrapper.Airbase#AIRBASE}.
--- @param #AI_BALANCER self
--- @param DCS#Distance ReturnThresholdRange If there is an enemy @{Wrapper.Client#CLIENT} within the ReturnThresholdRange given in meters, the AI will not return to the nearest @{Wrapper.Airbase#AIRBASE}.
-function AI_BALANCER:ReturnToHomeAirbase( ReturnThresholdRange )
-
-  self.ToHomeAirbase = true
-  self.ReturnThresholdRange = ReturnThresholdRange
-end
-
---- AI_BALANCER:onenterSpawning
--- @param #AI_BALANCER self
--- @param Core.Set#SET_GROUP SetGroup
--- @param #string ClientName
--- @param Wrapper.Group#GROUP AIGroup
-function AI_BALANCER:onenterSpawning( SetGroup, From, Event, To, ClientName )
-
-  -- OK, Spawn a new group from the default SpawnAI object provided.
-  local AIGroup = self.SpawnAI:Spawn() -- Wrapper.Group#GROUP
-  if AIGroup then
-    AIGroup:T( { "Spawning new AIGroup", ClientName = ClientName } )
-    --TODO: need to rework UnitName thing ...
-    
-    SetGroup:Remove( ClientName ) -- Ensure that the previously allocated AIGroup to ClientName is removed in the Set.
-    SetGroup:Add( ClientName, AIGroup )
-    self.SpawnQueue[ClientName] = nil
-    
-    -- Fire the Spawned event. The first parameter is the AIGroup just Spawned.
-    -- Mission designers can catch this event to bind further actions to the AIGroup.
-    self:Spawned( AIGroup )
-  end
-end
-
---- AI_BALANCER:onenterDestroying
--- @param #AI_BALANCER self
--- @param Core.Set#SET_GROUP SetGroup
--- @param Wrapper.Group#GROUP AIGroup
-function AI_BALANCER:onenterDestroying( SetGroup, From, Event, To, ClientName, AIGroup )
-
-  AIGroup:Destroy()
-  SetGroup:Flush( self )
-  SetGroup:Remove( ClientName )
-  SetGroup:Flush( self )
-end
-
---- RTB
--- @param #AI_BALANCER self
--- @param Core.Set#SET_GROUP SetGroup
--- @param #string From
--- @param #string Event
--- @param #string To
--- @param Wrapper.Group#GROUP AIGroup
-function AI_BALANCER:onenterReturning( SetGroup, From, Event, To, AIGroup )
-
-    local AIGroupTemplate = AIGroup:GetTemplate()
-    if self.ToHomeAirbase == true then
-      local WayPointCount = #AIGroupTemplate.route.points
-      local SwitchWayPointCommand = AIGroup:CommandSwitchWayPoint( 1, WayPointCount, 1 )
-      AIGroup:SetCommand( SwitchWayPointCommand )
-      AIGroup:MessageToRed( "Returning to home base ...", 30 )
-    else
-      -- Okay, we need to send this Group back to the nearest base of the Coalition of the AI.
-      local PointVec2 = COORDINATE:New(AIGroup:GetVec2().x, 0, AIGroup:GetVec2().y)
-      local ClosestAirbase = self.ReturnAirbaseSet:FindNearestAirbaseFromPointVec2( PointVec2 )
-      self:T( ClosestAirbase.AirbaseName )
-      AIGroup:RouteRTB(ClosestAirbase)
-    end
-
-end
-
---- AI_BALANCER:onenterMonitoring
--- @param #AI_BALANCER self
-function AI_BALANCER:onenterMonitoring( SetGroup )
-
-  self:T2( { self.SetClient:Count() } )
-  --self.SetClient:Flush()
-
-  self.SetClient:ForEachClient(
-    --- SetClient:ForEachClient
-    -- @param Wrapper.Client#CLIENT Client
-    function( Client )
-      self:T3(Client.ClientName)
-
-      local AIGroup = self.Set:Get( Client.UnitName ) -- Wrapper.Group#GROUP
-      if AIGroup then self:T( { AIGroup = AIGroup:GetName(), IsAlive = AIGroup:IsAlive() } ) end
-      if Client:IsAlive() == true then
-
-        if AIGroup and AIGroup:IsAlive() == true then
-
-          if self.ToNearestAirbase == false and self.ToHomeAirbase == false then
-            self:Destroy( Client.UnitName, AIGroup )
-          else
-            -- We test if there is no other CLIENT within the self.ReturnThresholdRange of the first unit of the AI group.
-            -- If there is a CLIENT, the AI stays engaged and will not return.
-            -- If there is no CLIENT within the self.ReturnThresholdRange, then the unit will return to the Airbase return method selected.
-
-            local PlayerInRange = { Value = false }          
-            local RangeZone = ZONE_RADIUS:New( 'RangeZone', AIGroup:GetVec2(), self.ReturnThresholdRange )
-            
-            self:T2( RangeZone )
-            
-            _DATABASE:ForEachPlayerUnit(
-              --- Nameless function
-              -- @param Wrapper.Unit#UNIT RangeTestUnit
-              function( RangeTestUnit, RangeZone, AIGroup, PlayerInRange )
-                self:T2( { PlayerInRange, RangeTestUnit.UnitName, RangeZone.ZoneName } )
-                if RangeTestUnit:IsInZone( RangeZone ) == true then
-                  self:T2( "in zone" )
-                  if RangeTestUnit:GetCoalition() ~= AIGroup:GetCoalition() then
-                    self:T2( "in range" )
-                    PlayerInRange.Value = true
-                  end
-                end
-              end,
-              
-              --- Nameless function
-              -- @param Core.Zone#ZONE_RADIUS RangeZone
-              -- @param Wrapper.Group#GROUP AIGroup
-              function( RangeZone, AIGroup, PlayerInRange )
-                if PlayerInRange.Value == false then
-                  self:Return( AIGroup )
-                end
-              end
-              , RangeZone, AIGroup, PlayerInRange
-            )
-            
-          end
-          self.Set:Remove( Client.UnitName )
-        end
-      else
-        if not AIGroup or not AIGroup:IsAlive() == true then
-          self:T( "Client " .. Client.UnitName .. " not alive." )
-          self:T( { Queue = self.SpawnQueue[Client.UnitName] } )
-          if not self.SpawnQueue[Client.UnitName] then
-            -- Spawn a new AI taking into account the spawn interval Earliest, Latest
-            self:__Spawn( math.random( self.Earliest, self.Latest ), Client.UnitName )
-            self.SpawnQueue[Client.UnitName] = true
-            self:T( "New AI Spawned for Client " .. Client.UnitName )
-          end
-        end
-      end
-      return true
-    end
-  )
-  
-  self:__Monitor( 10 )
-end

Moose Development/Moose/AI/AI_CAP.lua

@@ -1,541 +0,0 @@
---- **AI** - Perform Combat Air Patrolling (CAP) for airplanes.
---
--- **Features:**
--- 
---   * Patrol AI airplanes within a given zone.
---   * Trigger detected events when enemy airplanes are detected.
---   * Manage a fuel threshold to RTB on time.
---   * Engage the enemy when detected.
---
--- ===
--- 
--- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AI/AI_CAP)
--- 
--- ===
--- 
--- ### [YouTube Playlist](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl1YCyPxJgoZn-CfhwyeW65L)
--- 
--- ===
--- 
--- ### Author: **FlightControl**
--- ### Contributions:
---
---   * **Quax**: Concept, Advice & Testing.
---   * **Pikey**: Concept, Advice & Testing.
---   * **Gunterlund**: Test case revision.
---   * **Whisper**: Testing.
---   * **Delta99**: Testing.
--- 
--- ===       
---
--- @module AI.AI_CAP
--- @image AI_Combat_Air_Patrol.JPG
-
--- @type AI_CAP_ZONE
--- @field Wrapper.Controllable#CONTROLLABLE AIControllable The @{Wrapper.Controllable} patrolling.
--- @field Core.Zone#ZONE_BASE TargetZone The @{Core.Zone} where the patrol needs to be executed.
--- @extends AI.AI_Patrol#AI_PATROL_ZONE
-
---- Implements the core functions to patrol a @{Core.Zone} by an AI @{Wrapper.Controllable} 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_CAP_ZONE is assigned a @{Wrapper.Group} and this must be done before the AI_CAP_ZONE 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 threshold has been reached by the AI, or when the AI is commanded to RTB.
--- When the fuel threshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
--- 
--- ![Process](..\Presentations\AI_CAP\Dia13.JPG)
--- 
--- ## 1. AI_CAP_ZONE constructor
---   
---   * @{#AI_CAP_ZONE.New}(): Creates a new AI_CAP_ZONE object.
--- 
--- ## 2. AI_CAP_ZONE is a FSM
--- 
--- ![Process](..\Presentations\AI_CAP\Dia2.JPG)
--- 
--- ### 2.1 AI_CAP_ZONE 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_CAP_ZONE Events
--- 
---   * **@{AI.AI_Patrol#AI_PATROL_ZONE.Start}**: Start the process.
---   * **@{AI.AI_Patrol#AI_PATROL_ZONE.Route}**: Route the AI to a new random 3D point within the Patrol Zone.
---   * **@{#AI_CAP_ZONE.Engage}**: Let the AI engage the bogeys.
---   * **@{#AI_CAP_ZONE.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_CAP_ZONE.Destroy}**: The AI has destroyed a bogey @{Wrapper.Unit}.
---   * **@{#AI_CAP_ZONE.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 thresholds 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_CAP_ZONE.SetEngageRange}() to define that range.
---
--- ## 4. Set the Zone of Engagement
--- 
--- ![Zone](..\Presentations\AI_CAP\Dia12.JPG)
--- 
--- An optional @{Core.Zone} can be set, 
--- that will define when the AI will engage with the detected airborne enemy targets.
--- Use the method @{#AI_CAP_ZONE.SetEngageZone}() to define that Zone.
---
--- # Developer Note
--- 
--- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
--- Therefore, this class is considered to be deprecated
---
--- ===
--- 
--- @field #AI_CAP_ZONE
-AI_CAP_ZONE = {
-  ClassName = "AI_CAP_ZONE",
-}
-
---- Creates a new AI_CAP_ZONE object
--- @param #AI_CAP_ZONE self
--- @param Core.Zone#ZONE_BASE PatrolZone The @{Core.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.Controllable} in km/h.
--- @param DCS#Speed  PatrolMaxSpeed The maximum speed of the @{Wrapper.Controllable} in km/h.
--- @param DCS#AltitudeType PatrolAltType The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to RADIO
--- @return #AI_CAP_ZONE self
-function AI_CAP_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType )
-
-  -- Inherits from BASE
-  local self = BASE:Inherit( self, AI_PATROL_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType ) ) -- #AI_CAP_ZONE
-
-  self.Accomplished = false
-  self.Engaging = false
-
-  self:AddTransition( { "Patrolling", "Engaging" }, "Engage", "Engaging" ) -- FSM_CONTROLLABLE Transition for type #AI_CAP_ZONE.
-
-  --- OnBefore Transition Handler for Event Engage.
-  -- @function [parent=#AI_CAP_ZONE] OnBeforeEngage
-  -- @param #AI_CAP_ZONE 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.
-  -- @return #boolean Return false to cancel Transition.
-
-  --- OnAfter Transition Handler for Event Engage.
-  -- @function [parent=#AI_CAP_ZONE] OnAfterEngage
-  -- @param #AI_CAP_ZONE 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 Engage.
-  -- @function [parent=#AI_CAP_ZONE] Engage
-  -- @param #AI_CAP_ZONE self
-
-  --- Asynchronous Event Trigger for Event Engage.
-  -- @function [parent=#AI_CAP_ZONE] __Engage
-  -- @param #AI_CAP_ZONE self
-  -- @param #number Delay The delay in seconds.
-
---- OnLeave Transition Handler for State Engaging.
--- @function [parent=#AI_CAP_ZONE] OnLeaveEngaging
--- @param #AI_CAP_ZONE 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.
--- @return #boolean Return false to cancel Transition.
-
---- OnEnter Transition Handler for State Engaging.
--- @function [parent=#AI_CAP_ZONE] OnEnterEngaging
--- @param #AI_CAP_ZONE 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.
-
-  self:AddTransition( "Engaging", "Fired", "Engaging" ) -- FSM_CONTROLLABLE Transition for type #AI_CAP_ZONE.
-
-  --- OnBefore Transition Handler for Event Fired.
-  -- @function [parent=#AI_CAP_ZONE] OnBeforeFired
-  -- @param #AI_CAP_ZONE 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.
-  -- @return #boolean Return false to cancel Transition.
-
-  --- OnAfter Transition Handler for Event Fired.
-  -- @function [parent=#AI_CAP_ZONE] OnAfterFired
-  -- @param #AI_CAP_ZONE 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 Fired.
-  -- @function [parent=#AI_CAP_ZONE] Fired
-  -- @param #AI_CAP_ZONE self
-
-  --- Asynchronous Event Trigger for Event Fired.
-  -- @function [parent=#AI_CAP_ZONE] __Fired
-  -- @param #AI_CAP_ZONE self
-  -- @param #number Delay The delay in seconds.
-
-  self:AddTransition( "*", "Destroy", "*" ) -- FSM_CONTROLLABLE Transition for type #AI_CAP_ZONE.
-
-  --- OnBefore Transition Handler for Event Destroy.
-  -- @function [parent=#AI_CAP_ZONE] OnBeforeDestroy
-  -- @param #AI_CAP_ZONE 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.
-  -- @return #boolean Return false to cancel Transition.
-
-  --- OnAfter Transition Handler for Event Destroy.
-  -- @function [parent=#AI_CAP_ZONE] OnAfterDestroy
-  -- @param #AI_CAP_ZONE 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 Destroy.
-  -- @function [parent=#AI_CAP_ZONE] Destroy
-  -- @param #AI_CAP_ZONE self
-
-  --- Asynchronous Event Trigger for Event Destroy.
-  -- @function [parent=#AI_CAP_ZONE] __Destroy
-  -- @param #AI_CAP_ZONE self
-  -- @param #number Delay The delay in seconds.
-
-  self:AddTransition( "Engaging", "Abort", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_CAP_ZONE.
-
-  --- OnBefore Transition Handler for Event Abort.
-  -- @function [parent=#AI_CAP_ZONE] OnBeforeAbort
-  -- @param #AI_CAP_ZONE 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.
-  -- @return #boolean Return false to cancel Transition.
-
-  --- OnAfter Transition Handler for Event Abort.
-  -- @function [parent=#AI_CAP_ZONE] OnAfterAbort
-  -- @param #AI_CAP_ZONE 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 Abort.
-  -- @function [parent=#AI_CAP_ZONE] Abort
-  -- @param #AI_CAP_ZONE self
-
-  --- Asynchronous Event Trigger for Event Abort.
-  -- @function [parent=#AI_CAP_ZONE] __Abort
-  -- @param #AI_CAP_ZONE self
-  -- @param #number Delay The delay in seconds.
-
-  self:AddTransition( "Engaging", "Accomplish", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_CAP_ZONE.
-
-  --- OnBefore Transition Handler for Event Accomplish.
-  -- @function [parent=#AI_CAP_ZONE] OnBeforeAccomplish
-  -- @param #AI_CAP_ZONE 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.
-  -- @return #boolean Return false to cancel Transition.
-
-  --- OnAfter Transition Handler for Event Accomplish.
-  -- @function [parent=#AI_CAP_ZONE] OnAfterAccomplish
-  -- @param #AI_CAP_ZONE 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 Accomplish.
-  -- @function [parent=#AI_CAP_ZONE] Accomplish
-  -- @param #AI_CAP_ZONE self
-
-  --- Asynchronous Event Trigger for Event Accomplish.
-  -- @function [parent=#AI_CAP_ZONE] __Accomplish
-  -- @param #AI_CAP_ZONE self
-  -- @param #number Delay The delay in seconds.  
-
-  return self
-end
-
---- Set the Engage Zone which defines where the AI will engage bogies. 
--- @param #AI_CAP_ZONE self
--- @param Core.Zone#ZONE EngageZone The zone where the AI is performing CAP.
--- @return #AI_CAP_ZONE self
-function AI_CAP_ZONE:SetEngageZone( EngageZone )
-  self:F2()
-
-  if EngageZone then
-    self.EngageZone = EngageZone
-  else
-    self.EngageZone = nil
-  end
-end
-
---- Set the Engage Range when the AI will engage with airborne enemies. 
--- @param #AI_CAP_ZONE self
--- @param #number EngageRange The Engage Range.
--- @return #AI_CAP_ZONE self
-function AI_CAP_ZONE:SetEngageRange( EngageRange )
-  self:F2()
-
-  if EngageRange then  
-    self.EngageRange = EngageRange
-  else
-    self.EngageRange = nil
-  end
-end
-
---- onafter State Transition for Event Start.
--- @param #AI_CAP_ZONE 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_CAP_ZONE:onafterStart( Controllable, From, Event, To )
-
-  -- Call the parent Start event handler
-  self:GetParent(self).onafterStart( self, Controllable, From, Event, To )
-  self:HandleEvent( EVENTS.Dead )
-
-end
-
--- @param AI.AI_CAP#AI_CAP_ZONE 
--- @param Wrapper.Group#GROUP EngageGroup
-function AI_CAP_ZONE.EngageRoute( EngageGroup, Fsm )
-
-  EngageGroup:F( { "AI_CAP_ZONE.EngageRoute:", EngageGroup:GetName() } )
-
-  if EngageGroup:IsAlive() then
-    Fsm:__Engage( 1 )
-  end
-end
-
--- @param #AI_CAP_ZONE 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_CAP_ZONE:onbeforeEngage( Controllable, From, Event, To )
-  
-  if self.Accomplished == true then
-    return false
-  end
-end
-
--- @param #AI_CAP_ZONE 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_CAP_ZONE:onafterDetected( Controllable, From, Event, To )
-
-  if From ~= "Engaging" then
-
-    local Engage = false
-
-    for DetectedUnit, Detected in pairs( self.DetectedUnits ) do
-
-      local DetectedUnit = DetectedUnit -- Wrapper.Unit#UNIT
-      self:T( DetectedUnit )
-      if DetectedUnit:IsAlive() and DetectedUnit:IsAir() then
-        Engage = true
-        break
-      end
-    end
-
-    if Engage == true then
-      self:F( 'Detected -> Engaging' )
-      self:__Engage( 1 )
-    end
-  end
-end
-
--- @param #AI_CAP_ZONE 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_CAP_ZONE:onafterAbort( Controllable, From, Event, To )
-  Controllable:ClearTasks()
-  self:__Route( 1 )
-end
-
--- @param #AI_CAP_ZONE 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_CAP_ZONE:onafterEngage( Controllable, From, Event, To )
-
-  if Controllable and Controllable:IsAlive() then
-
-    local EngageRoute = {}
-
-    --- Calculate the current route point.
-    local CurrentVec2 = self.Controllable:GetVec2()
-
-    if not CurrentVec2 then return self end
-
-    --DONE: Create GetAltitude function for GROUP, and delete GetUnit(1).
-    local CurrentAltitude = self.Controllable:GetAltitude()
-    local CurrentPointVec3 = COORDINATE:New( CurrentVec2.x, CurrentAltitude, CurrentVec2.y )
-    local ToEngageZoneSpeed = self.PatrolMaxSpeed
-    local CurrentRoutePoint = CurrentPointVec3:WaypointAir(
-        self.PatrolAltType,
-        COORDINATE.WaypointType.TurningPoint,
-        COORDINATE.WaypointAction.TurningPoint,
-        ToEngageZoneSpeed,
-        true
-      )
-
-    EngageRoute[#EngageRoute+1] = CurrentRoutePoint
-
-     --- Find a random 2D point in PatrolZone.
-    local ToTargetVec2 = self.PatrolZone:GetRandomVec2()
-    self:T2( ToTargetVec2 )
-
-    --- Define Speed and Altitude.
-    local ToTargetAltitude = math.random( self.EngageFloorAltitude, self.EngageCeilingAltitude )
-    local ToTargetSpeed = math.random( self.PatrolMinSpeed, self.PatrolMaxSpeed )
-    self:T2( { self.PatrolMinSpeed, self.PatrolMaxSpeed, ToTargetSpeed } )
-
-    --- Obtain a 3D @{Point} from the 2D point + altitude.
-    local ToTargetPointVec3 = COORDINATE:New( ToTargetVec2.x, ToTargetAltitude, ToTargetVec2.y )
-
-    --- Create a route point of type air.
-    local ToPatrolRoutePoint = ToTargetPointVec3:WaypointAir(
-      self.PatrolAltType,
-      COORDINATE.WaypointType.TurningPoint,
-      COORDINATE.WaypointAction.TurningPoint,
-      ToTargetSpeed,
-      true
-    )
-
-    EngageRoute[#EngageRoute+1] = ToPatrolRoutePoint
-
-    Controllable:OptionROEOpenFire()
-    Controllable:OptionROTEvadeFire()
-
-    local AttackTasks = {}
-
-    for DetectedUnit, Detected in pairs( self.DetectedUnits ) do
-      local DetectedUnit = DetectedUnit -- Wrapper.Unit#UNIT
-      self:T( { DetectedUnit, DetectedUnit:IsAlive(), DetectedUnit:IsAir() } )
-      if DetectedUnit:IsAlive() and DetectedUnit:IsAir() then
-        if self.EngageZone then
-          if DetectedUnit:IsInZone( self.EngageZone ) then
-            self:F( {"Within Zone and Engaging ", DetectedUnit } )
-            AttackTasks[#AttackTasks+1] = Controllable:TaskAttackUnit( DetectedUnit )
-          end
-        else 
-          if self.EngageRange then
-            if DetectedUnit:GetPointVec3():Get2DDistance(Controllable:GetPointVec3() ) <= self.EngageRange then
-              self:F( {"Within Range and Engaging", DetectedUnit } )
-              AttackTasks[#AttackTasks+1] = Controllable:TaskAttackUnit( DetectedUnit )
-            end
-          else
-            AttackTasks[#AttackTasks+1] = Controllable:TaskAttackUnit( DetectedUnit )
-          end
-        end
-      else
-        self.DetectedUnits[DetectedUnit] = nil
-      end
-    end
-
-    if #AttackTasks == 0 then
-      self:F("No targets found -> Going back to Patrolling")
-      self:__Abort( 1 )
-      self:__Route( 1 )
-      self:SetDetectionActivated()
-    else
-
-      AttackTasks[#AttackTasks+1] = Controllable:TaskFunction( "AI_CAP_ZONE.EngageRoute", self )
-      EngageRoute[1].task = Controllable:TaskCombo( AttackTasks )
-
-      self:SetDetectionDeactivated()
-    end
-
-    Controllable:Route( EngageRoute, 0.5 )
-
-  end
-end
-
--- @param #AI_CAP_ZONE 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_CAP_ZONE:onafterAccomplish( Controllable, From, Event, To )
-  self.Accomplished = true
-  self:SetDetectionOff()
-end
-
--- @param #AI_CAP_ZONE 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.
--- @param Core.Event#EVENTDATA EventData
-function AI_CAP_ZONE:onafterDestroy( Controllable, From, Event, To, EventData )
-
-  if EventData.IniUnit then
-    self.DetectedUnits[EventData.IniUnit] = nil
-  end
-end
-
--- @param #AI_CAP_ZONE self
--- @param Core.Event#EVENTDATA EventData
-function AI_CAP_ZONE:OnEventDead( EventData )
-  self:F( { "EventDead", EventData } )
-
-  if EventData.IniDCSUnit then
-    if self.DetectedUnits and self.DetectedUnits[EventData.IniUnit] then
-      self:__Destroy( 1, EventData )
-    end
-  end
-end

Moose Development/Moose/AI/AI_CAS.lua

@@ -1,569 +0,0 @@
---- **AI** - Perform Close Air Support (CAS) near friendlies.
---
--- **Features:**
--- 
---   * Hold and standby within a patrol zone.
---   * Engage upon command the enemies within an engagement zone.
---   * Loop the zone until all enemies are eliminated.
---   * Trigger different events upon the results achieved.
---   * After combat, return to the patrol zone and hold.
---   * RTB when commanded or after fuel.
---
--- ===
--- 
--- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AI/AI_CAS)
--- 
--- ===
--- 
--- ### [YouTube Playlist](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl3JBO1WDqqpyYRRmIkR2ir2)
--- 
--- ===
--- 
--- ### Author: **FlightControl**
--- ### Contributions: 
---
---   * **Quax**: Concept, Advice & Testing.
---   * **Pikey**: Concept, Advice & Testing.
---   * **Gunterlund**: Test case revision.
---
--- ===
---
--- @module AI.AI_CAS
--- @image AI_Close_Air_Support.JPG
-
---- AI_CAS_ZONE class
--- @type AI_CAS_ZONE
--- @field Wrapper.Controllable#CONTROLLABLE AIControllable The @{Wrapper.Controllable} patrolling.
--- @field Core.Zone#ZONE_BASE TargetZone The @{Core.Zone} where the patrol needs to be executed.
--- @extends AI.AI_Patrol#AI_PATROL_ZONE
-
---- Implements the core functions to provide Close Air Support in an Engage @{Core.Zone} by an AIR @{Wrapper.Controllable} or @{Wrapper.Group}.
--- The AI_CAS_ZONE runs a process. It holds an AI in a Patrol Zone and when the AI is commanded to engage, it will fly to an Engage Zone.
--- 
--- ![HoldAndEngage](..\Presentations\AI_CAS\Dia3.JPG)
--- 
--- The AI_CAS_ZONE is assigned a @{Wrapper.Group} and this must be done before the AI_CAS_ZONE process can be started through the **Start** event.
---  
--- ![Start Event](..\Presentations\AI_CAS\Dia4.JPG)
--- 
--- Upon started, The AI will **Route** itself towards the random 3D point within a 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.
--- This cycle will continue until a fuel or damage threshold has been reached by the AI, or when the AI is commanded to RTB.
--- 
--- ![Route Event](..\Presentations\AI_CAS\Dia5.JPG)
--- 
--- When the AI is commanded to provide Close Air Support (through the event **Engage**), the AI will fly towards the Engage Zone.
--- Any target that is detected in the Engage Zone will be reported and will be destroyed by the AI.
--- 
--- ![Engage Event](..\Presentations\AI_CAS\Dia6.JPG)
--- 
--- The AI will detect the targets and will only destroy the targets within the Engage Zone.
--- 
--- ![Engage Event](..\Presentations\AI_CAS\Dia7.JPG)
--- 
--- Every target that is destroyed, is reported< by the AI.
--- 
--- ![Engage Event](..\Presentations\AI_CAS\Dia8.JPG)
--- 
--- Note that the AI does not know when the Engage Zone is cleared, and therefore will keep circling in the zone. 
---
--- ![Engage Event](..\Presentations\AI_CAS\Dia9.JPG)
--- 
--- Until it is notified through the event **Accomplish**, which is to be triggered by an observing party:
--- 
---   * a FAC
---   * a timed event
---   * a menu option selected by a human
---   * a condition
---   * others ...
--- 
--- ![Engage Event](..\Presentations\AI_CAS\Dia10.JPG)
--- 
--- When the AI has accomplished the CAS, it will fly back to the Patrol Zone.
--- 
--- ![Engage Event](..\Presentations\AI_CAS\Dia11.JPG)
--- 
--- It will keep patrolling there, until it is notified to RTB or move to another CAS Zone.
--- It can be notified to go RTB through the **RTB** event.
--- 
--- When the fuel threshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
--- 
--- ![Engage Event](..\Presentations\AI_CAS\Dia12.JPG)
---
--- ## AI_CAS_ZONE constructor
---
---   * @{#AI_CAS_ZONE.New}(): Creates a new AI_CAS_ZONE object.
---
--- ## AI_CAS_ZONE is a FSM
--- 
--- ![Process](..\Presentations\AI_CAS\Dia2.JPG)
--- 
--- ### 2.1. AI_CAS_ZONE 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 targets in the Engage Zone, executing CAS.
---   * **Returning** ( Group ): The AI is returning to Base..
--- 
--- ### 2.2. AI_CAS_ZONE Events
--- 
---   * **@{AI.AI_Patrol#AI_PATROL_ZONE.Start}**: Start the process.
---   * **@{AI.AI_Patrol#AI_PATROL_ZONE.Route}**: Route the AI to a new random 3D point within the Patrol Zone.
---   * **@{#AI_CAS_ZONE.Engage}**: Engage the AI to provide CAS in the Engage Zone, destroying any target it finds.
---   * **@{#AI_CAS_ZONE.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_CAS_ZONE.Destroy}**: The AI has destroyed a target @{Wrapper.Unit}.
---   * **@{#AI_CAS_ZONE.Destroyed}**: The AI has destroyed all target @{Wrapper.Unit}s assigned in the CAS task.
---   * **Status**: The AI is checking status (fuel and damage). When the thresholds have been reached, the AI will RTB.
---
--- # Developer Note
--- 
--- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
--- Therefore, this class is considered to be deprecated
---
--- ===
--- 
--- @field #AI_CAS_ZONE
-AI_CAS_ZONE = {
-  ClassName = "AI_CAS_ZONE",
-}
-
-
-
---- Creates a new AI_CAS_ZONE object
--- @param #AI_CAS_ZONE self
--- @param Core.Zone#ZONE_BASE PatrolZone The @{Core.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.Controllable} in km/h.
--- @param DCS#Speed  PatrolMaxSpeed The maximum speed of the @{Wrapper.Controllable} in km/h.
--- @param Core.Zone#ZONE_BASE EngageZone The zone where the engage will happen.
--- @param DCS#AltitudeType PatrolAltType The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to RADIO
--- @return #AI_CAS_ZONE self
-function AI_CAS_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, EngageZone, PatrolAltType )
-
-  -- Inherits from BASE
-  local self = BASE:Inherit( self, AI_PATROL_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType ) ) -- #AI_CAS_ZONE
-
-  self.EngageZone = EngageZone
-  self.Accomplished = false
-  
-  self:SetDetectionZone( self.EngageZone )
-
-  self:AddTransition( { "Patrolling", "Engaging" }, "Engage", "Engaging" ) -- FSM_CONTROLLABLE Transition for type #AI_CAS_ZONE.
-
-  --- OnBefore Transition Handler for Event Engage.
-  -- @function [parent=#AI_CAS_ZONE] OnBeforeEngage
-  -- @param #AI_CAS_ZONE 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.
-  -- @return #boolean Return false to cancel Transition.
-  
-  --- OnAfter Transition Handler for Event Engage.
-  -- @function [parent=#AI_CAS_ZONE] OnAfterEngage
-  -- @param #AI_CAS_ZONE 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 Engage.
-  -- @function [parent=#AI_CAS_ZONE] Engage
-  -- @param #AI_CAS_ZONE self
-  -- @param #number EngageSpeed (optional) The speed the Group will hold when engaging to the target zone.
-  -- @param DCS#Distance EngageAltitude (optional) Desired altitude to perform the unit engagement.
-  -- @param DCS#AI.Task.WeaponExpend EngageWeaponExpend (optional) Determines how much weapon will be released at each attack. 
-  -- If parameter is not defined the unit / controllable will choose expend on its own discretion.
-  -- Use the structure @{DCS#AI.Task.WeaponExpend} to define the amount of weapons to be release at each attack.
-  -- @param #number EngageAttackQty (optional) This parameter limits maximal quantity of attack. The aicraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aicraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.
-  -- @param DCS#Azimuth EngageDirection (optional) Desired ingress direction from the target to the attacking aircraft. Controllable/aircraft will make its attacks from the direction. Of course if there is no way to attack from the direction due the terrain controllable/aircraft will choose another direction.
-  
-  --- Asynchronous Event Trigger for Event Engage.
-  -- @function [parent=#AI_CAS_ZONE] __Engage
-  -- @param #AI_CAS_ZONE self
-  -- @param #number Delay The delay in seconds.
-  -- @param #number EngageSpeed (optional) The speed the Group will hold when engaging to the target zone.
-  -- @param DCS#Distance EngageAltitude (optional) Desired altitude to perform the unit engagement.
-  -- @param DCS#AI.Task.WeaponExpend EngageWeaponExpend (optional) Determines how much weapon will be released at each attack. 
-  -- If parameter is not defined the unit / controllable will choose expend on its own discretion.
-  -- Use the structure @{DCS#AI.Task.WeaponExpend} to define the amount of weapons to be release at each attack.
-  -- @param #number EngageAttackQty (optional) This parameter limits maximal quantity of attack. The aicraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aicraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.
-  -- @param DCS#Azimuth EngageDirection (optional) Desired ingress direction from the target to the attacking aircraft. Controllable/aircraft will make its attacks from the direction. Of course if there is no way to attack from the direction due the terrain controllable/aircraft will choose another direction.
-
---- OnLeave Transition Handler for State Engaging.
--- @function [parent=#AI_CAS_ZONE] OnLeaveEngaging
--- @param #AI_CAS_ZONE 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.
--- @return #boolean Return false to cancel Transition.
-
---- OnEnter Transition Handler for State Engaging.
--- @function [parent=#AI_CAS_ZONE] OnEnterEngaging
--- @param #AI_CAS_ZONE 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.
-
-  self:AddTransition( "Engaging", "Target", "Engaging" ) -- FSM_CONTROLLABLE Transition for type #AI_CAS_ZONE.
-
-  self:AddTransition( "Engaging", "Fired", "Engaging" ) -- FSM_CONTROLLABLE Transition for type #AI_CAS_ZONE.
-  
-  --- OnBefore Transition Handler for Event Fired.
-  -- @function [parent=#AI_CAS_ZONE] OnBeforeFired
-  -- @param #AI_CAS_ZONE 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.
-  -- @return #boolean Return false to cancel Transition.
-  
-  --- OnAfter Transition Handler for Event Fired.
-  -- @function [parent=#AI_CAS_ZONE] OnAfterFired
-  -- @param #AI_CAS_ZONE 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 Fired.
-  -- @function [parent=#AI_CAS_ZONE] Fired
-  -- @param #AI_CAS_ZONE self
-  
-  --- Asynchronous Event Trigger for Event Fired.
-  -- @function [parent=#AI_CAS_ZONE] __Fired
-  -- @param #AI_CAS_ZONE self
-  -- @param #number Delay The delay in seconds.
-
-  self:AddTransition( "*", "Destroy", "*" ) -- FSM_CONTROLLABLE Transition for type #AI_CAS_ZONE.
-
-  --- OnBefore Transition Handler for Event Destroy.
-  -- @function [parent=#AI_CAS_ZONE] OnBeforeDestroy
-  -- @param #AI_CAS_ZONE 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.
-  -- @return #boolean Return false to cancel Transition.
-  
-  --- OnAfter Transition Handler for Event Destroy.
-  -- @function [parent=#AI_CAS_ZONE] OnAfterDestroy
-  -- @param #AI_CAS_ZONE 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 Destroy.
-  -- @function [parent=#AI_CAS_ZONE] Destroy
-  -- @param #AI_CAS_ZONE self
-  
-  --- Asynchronous Event Trigger for Event Destroy.
-  -- @function [parent=#AI_CAS_ZONE] __Destroy
-  -- @param #AI_CAS_ZONE self
-  -- @param #number Delay The delay in seconds.
-
-
-  self:AddTransition( "Engaging", "Abort", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_CAS_ZONE.
-
-  --- OnBefore Transition Handler for Event Abort.
-  -- @function [parent=#AI_CAS_ZONE] OnBeforeAbort
-  -- @param #AI_CAS_ZONE 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.
-  -- @return #boolean Return false to cancel Transition.
-  
-  --- OnAfter Transition Handler for Event Abort.
-  -- @function [parent=#AI_CAS_ZONE] OnAfterAbort
-  -- @param #AI_CAS_ZONE 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 Abort.
-  -- @function [parent=#AI_CAS_ZONE] Abort
-  -- @param #AI_CAS_ZONE self
-  
-  --- Asynchronous Event Trigger for Event Abort.
-  -- @function [parent=#AI_CAS_ZONE] __Abort
-  -- @param #AI_CAS_ZONE self
-  -- @param #number Delay The delay in seconds.
-
-  self:AddTransition( "Engaging", "Accomplish", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_CAS_ZONE.
-
-  --- OnBefore Transition Handler for Event Accomplish.
-  -- @function [parent=#AI_CAS_ZONE] OnBeforeAccomplish
-  -- @param #AI_CAS_ZONE 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.
-  -- @return #boolean Return false to cancel Transition.
-  
-  --- OnAfter Transition Handler for Event Accomplish.
-  -- @function [parent=#AI_CAS_ZONE] OnAfterAccomplish
-  -- @param #AI_CAS_ZONE 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 Accomplish.
-  -- @function [parent=#AI_CAS_ZONE] Accomplish
-  -- @param #AI_CAS_ZONE self
-  
-  --- Asynchronous Event Trigger for Event Accomplish.
-  -- @function [parent=#AI_CAS_ZONE] __Accomplish
-  -- @param #AI_CAS_ZONE self
-  -- @param #number Delay The delay in seconds.  
-
-  return self
-end
-
-
---- Set the Engage Zone where the AI is performing CAS. Note that if the EngageZone is changed, the AI needs to re-detect targets.
--- @param #AI_CAS_ZONE self
--- @param Core.Zone#ZONE EngageZone The zone where the AI is performing CAS.
--- @return #AI_CAS_ZONE self
-function AI_CAS_ZONE:SetEngageZone( EngageZone )
-  self:F2()
-
-  if EngageZone then  
-    self.EngageZone = EngageZone
-  else
-    self.EngageZone = nil
-  end
-end
-
-
-
---- onafter State Transition for Event Start.
--- @param #AI_CAS_ZONE 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_CAS_ZONE:onafterStart( Controllable, From, Event, To )
-
-  -- Call the parent Start event handler
-  self:GetParent(self).onafterStart( self, Controllable, From, Event, To )
-  self:HandleEvent( EVENTS.Dead )
-  
-  self:SetDetectionDeactivated() -- When not engaging, set the detection off.
-end
-
--- @param AI.AI_CAS#AI_CAS_ZONE 
--- @param Wrapper.Group#GROUP EngageGroup
-function AI_CAS_ZONE.EngageRoute( EngageGroup, Fsm )
-
-  EngageGroup:F( { "AI_CAS_ZONE.EngageRoute:", EngageGroup:GetName() } )
-
-  if EngageGroup:IsAlive() then
-    Fsm:__Engage( 1, Fsm.EngageSpeed, Fsm.EngageAltitude, Fsm.EngageWeaponExpend, Fsm.EngageAttackQty, Fsm.EngageDirection )
-  end
-end
-
-
--- @param #AI_CAS_ZONE 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_CAS_ZONE:onbeforeEngage( Controllable, From, Event, To )
-  
-  if self.Accomplished == true then
-    return false
-  end
-end
-
--- @param #AI_CAS_ZONE 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_CAS_ZONE:onafterTarget( Controllable, From, Event, To )
-
-  if Controllable:IsAlive() then
-
-    local AttackTasks = {}
-
-    for DetectedUnit, Detected in pairs( self.DetectedUnits ) do
-      local DetectedUnit = DetectedUnit -- Wrapper.Unit#UNIT
-      if DetectedUnit:IsAlive() then
-        if DetectedUnit:IsInZone( self.EngageZone ) then
-          if Detected == true then
-            self:F( {"Target: ", DetectedUnit } )
-            self.DetectedUnits[DetectedUnit] = false
-            local AttackTask = Controllable:TaskAttackUnit( DetectedUnit, false, self.EngageWeaponExpend, self.EngageAttackQty, self.EngageDirection, self.EngageAltitude, nil )
-            self.Controllable:PushTask( AttackTask, 1 )
-          end
-        end
-      else
-        self.DetectedUnits[DetectedUnit] = nil
-      end
-    end
-
-    self:__Target( -10 )
-
-  end
-end
-
-
--- @param #AI_CAS_ZONE 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_CAS_ZONE:onafterAbort( Controllable, From, Event, To )
-  Controllable:ClearTasks()
-  self:__Route( 1 )
-end
-
--- @param #AI_CAS_ZONE 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.
--- @param #number EngageSpeed (optional) The speed the Group will hold when engaging to the target zone.
--- @param DCS#Distance EngageAltitude (optional) Desired altitude to perform the unit engagement.
--- @param DCS#AI.Task.WeaponExpend EngageWeaponExpend (optional) Determines how much weapon will be released at each attack. If parameter is not defined the unit / controllable will choose expend on its own discretion.
--- @param #number EngageAttackQty (optional) This parameter limits maximal quantity of attack. The aicraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aicraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.
--- @param DCS#Azimuth EngageDirection (optional) Desired ingress direction from the target to the attacking aircraft. Controllable/aircraft will make its attacks from the direction. Of course if there is no way to attack from the direction due the terrain controllable/aircraft will choose another direction.
-function AI_CAS_ZONE:onafterEngage( Controllable, From, Event, To, 
-                                    EngageSpeed, 
-                                    EngageAltitude, 
-                                    EngageWeaponExpend, 
-                                    EngageAttackQty, 
-                                    EngageDirection )
-  self:F("onafterEngage")
-
-  self.EngageSpeed = EngageSpeed or 400
-  self.EngageAltitude = EngageAltitude or 2000
-  self.EngageWeaponExpend = EngageWeaponExpend
-  self.EngageAttackQty = EngageAttackQty
-  self.EngageDirection = EngageDirection
-
-  if Controllable:IsAlive() then
-
-    Controllable:OptionROEOpenFire()
-    Controllable:OptionROTVertical()
-
-    local EngageRoute = {}
-
-    --- Calculate the current route point.
-    local CurrentVec2 = self.Controllable:GetVec2()
-    
-    --DONE: Create GetAltitude function for GROUP, and delete GetUnit(1).
-    local CurrentAltitude = self.Controllable:GetAltitude()
-    local CurrentPointVec3 = COORDINATE:New( CurrentVec2.x, CurrentAltitude, CurrentVec2.y )
-    local ToEngageZoneSpeed = self.PatrolMaxSpeed
-    local CurrentRoutePoint = CurrentPointVec3:WaypointAir( 
-        self.PatrolAltType, 
-        COORDINATE.WaypointType.TurningPoint, 
-        COORDINATE.WaypointAction.TurningPoint, 
-        self.EngageSpeed, 
-        true 
-      )
-    
-    EngageRoute[#EngageRoute+1] = CurrentRoutePoint
-
-    local AttackTasks = {}
-
-    for DetectedUnit, Detected in pairs( self.DetectedUnits ) do
-      local DetectedUnit = DetectedUnit -- Wrapper.Unit#UNIT
-      self:T( DetectedUnit )
-      if DetectedUnit:IsAlive() then
-        if DetectedUnit:IsInZone( self.EngageZone ) then
-          self:F( {"Engaging ", DetectedUnit } )
-          AttackTasks[#AttackTasks+1] = Controllable:TaskAttackUnit( DetectedUnit, 
-                                                                     true, 
-                                                                     EngageWeaponExpend, 
-                                                                     EngageAttackQty, 
-                                                                     EngageDirection 
-                                                                   )
-        end
-      else
-        self.DetectedUnits[DetectedUnit] = nil
-      end
-    end
-
-    AttackTasks[#AttackTasks+1] = Controllable:TaskFunction( "AI_CAS_ZONE.EngageRoute", self )
-    EngageRoute[#EngageRoute].task = Controllable:TaskCombo( AttackTasks )
-
-    --- Define a random point in the @{Core.Zone}. The AI will fly to that point within the zone.
-    
-      --- Find a random 2D point in EngageZone.
-    local ToTargetVec2 = self.EngageZone:GetRandomVec2()
-    self:T2( ToTargetVec2 )
-
-    --- Obtain a 3D @{Point} from the 2D point + altitude.
-    local ToTargetPointVec3 = COORDINATE:New( ToTargetVec2.x, self.EngageAltitude, ToTargetVec2.y )
-    
-    --- Create a route point of type air.
-    local ToTargetRoutePoint = ToTargetPointVec3:WaypointAir( 
-      self.PatrolAltType, 
-      COORDINATE.WaypointType.TurningPoint, 
-      COORDINATE.WaypointAction.TurningPoint, 
-      self.EngageSpeed, 
-      true 
-    )
-    
-    EngageRoute[#EngageRoute+1] = ToTargetRoutePoint
-  
-    Controllable:Route( EngageRoute, 0.5 )
-    
-    self:SetRefreshTimeInterval( 2 )
-    self:SetDetectionActivated()
-    self:__Target( -2 ) -- Start targeting
-  end
-end
-
-
--- @param #AI_CAS_ZONE 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_CAS_ZONE:onafterAccomplish( Controllable, From, Event, To )
-  self.Accomplished = true
-  self:SetDetectionDeactivated()
-end
-
-
--- @param #AI_CAS_ZONE 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.
--- @param Core.Event#EVENTDATA EventData
-function AI_CAS_ZONE:onafterDestroy( Controllable, From, Event, To, EventData )
-
-  if EventData.IniUnit then
-    self.DetectedUnits[EventData.IniUnit] = nil
-  end
-end
-
-
--- @param #AI_CAS_ZONE self
--- @param Core.Event#EVENTDATA EventData
-function AI_CAS_ZONE:OnEventDead( EventData )
-  self:F( { "EventDead", EventData } )
-
-  if EventData.IniDCSUnit then
-    if self.DetectedUnits and self.DetectedUnits[EventData.IniUnit] then
-      self:__Destroy( 1, EventData )
-    end
-  end
-end
-
-

Moose Development/Moose/AI/AI_Cargo.lua

@@ -1,589 +0,0 @@
---- **AI** - 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.
---
--- # Developer Note
--- 
--- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
--- Therefore, this class is considered to be deprecated
--- 
--- @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 Cargo carrier group.
--- @param Core.Set#SET_CARGO CargoSet Set of cargo(s) to transport.
--- @return #AI_CARGO self
-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" )
-  
-  -- Board
-  self:AddTransition( "Unloaded",     "Pickup",     "Unloaded" )
-  self:AddTransition( "*",            "Load",       "*" )
-  self:AddTransition( "*",            "Reload",       "*" )
-  self:AddTransition( "*",            "Board",      "*" )
-  self:AddTransition( "*",            "Loaded",     "Loaded" )
-  self:AddTransition( "Loaded",       "PickedUp",   "Loaded" )
-  
-  -- Unload
-  self:AddTransition( "Loaded",       "Deploy",     "*" )
-  self:AddTransition( "*",            "Unload",     "*" )
-  self:AddTransition( "*",            "Unboard",    "*" )
-  self:AddTransition( "*",            "Unloaded",   "Unloaded" )
-  self:AddTransition( "Unloaded",     "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
-
-  --- On after Deployed event.
-  -- @function [parent=#AI_CARGO] OnAfterDeployed
-  -- @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.
-  -- @param #boolean Defend Defend for APCs.
-  
-  
-  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()
-            local CarrierSpace=Carrier_Weight[CarrierUnit] 
-  
-            -- Only when there is space within the bay to load the next cargo item!
-            if CarrierSpace > CargoWeight 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
-            else
-              self:T(string.format("WARNING: Cargo too heavy for carrier %s. Cargo=%.1f > %.1f free space", tostring(CarrierUnit:GetName()), CargoWeight, CarrierSpace))
-            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:T({ 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.
--- @param #boolean Defend Defend for APCs.
-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,607 +0,0 @@
---- **AI** - Models the intelligent transportation of cargo using ground vehicles.
---
--- ===
--- 
--- ### Author: **FlightControl**
--- 
--- ===       
---
--- @module AI.AI_Cargo_APC
--- @image AI_Cargo_Dispatching_For_APC.JPG
-
--- @type AI_CARGO_APC
--- @extends AI.AI_Cargo#AI_CARGO
-
-
---- 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 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 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.
--- 
--- ## **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.
--- The carrier will hold the route once the unboarded infantry is further than 50 meters from the APCs, 
--- 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 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 radius of 350 meters to 500 meters has been proven to be the most effective and efficient.
--- 
--- 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.
--- 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 and following the APCs, 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 ... 
--- 
--- ## Control the APCs on the map.
--- 
--- It is possible also as a human ground commander to influence the path of the APCs, by pointing a new path using the DCS user interface on the map.
--- In this case, the APCs will change the direction towards its new indicated route. However, there is a catch!
--- Once the APCs are near the enemy, and infantry is unboarded, the APCs won't be able to hold the route until the infantry could catch up.
--- The APCs will simply drive on and won't stop! This is a limitation in ED that prevents user actions being controlled by the scripting engine.
--- No workaround is possible on this.
--- 
--- ## Cargo deployment.
---  
--- Using the @{#AI_CARGO_APC.Deploy}() method, you are able to direct the APCs towards a point on the battlefield to unboard/unload the cargo at the specific coordinate. 
--- The APCs will follow nearby roads as much as possible, to ensure fast and clean cargo transportation between the objects and villages in the simulation environment.
--- 
--- ## Cargo pickup.
---  
--- Using the @{#AI_CARGO_APC.Pickup}() method, you are able to direct the APCs towards a point on the battlefield to board/load the cargo at the specific coordinate. 
--- The APCs will follow nearby roads as much as possible, to ensure fast and clean cargo transportation between the objects and villages in the simulation environment.
--- 
---
--- # Developer Note
--- 
--- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
--- Therefore, this class is considered to be deprecated
---
--- 
--- @field #AI_CARGO_APC
-AI_CARGO_APC = {
-  ClassName = "AI_CARGO_APC",
-  Coordinate = nil, -- Core.Point#COORDINATE,
-}
-
---- Creates a new AI_CARGO_APC object.
--- @param #AI_CARGO_APC self
--- @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, AI_CARGO:New( APC, CargoSet ) ) -- #AI_CARGO_APC
-
-  self:AddTransition( "*", "Monitor", "*" )
-  self:AddTransition( "*", "Follow", "Following" )
-  self:AddTransition( "*", "Guard", "Unloaded" )
-  self:AddTransition( "*", "Home", "*" )
-  self:AddTransition( "*", "Reload", "Boarding" )
-  self:AddTransition( "*", "Deployed", "*" )
-  self:AddTransition( "*", "PickedUp", "*" )
-  self:AddTransition( "*", "Destroyed", "Destroyed" )
-
-  self:SetCombatRadius( CombatRadius )
-
-  self:SetCarrier( APC )
-  
-  return self
-end
-
-
---- Set the Carrier.
--- @param #AI_CARGO_APC self
--- @param Wrapper.Group#GROUP CargoCarrier
--- @return #AI_CARGO_APC
-function AI_CARGO_APC:SetCarrier( CargoCarrier )
-
-  self.CargoCarrier = CargoCarrier -- Wrapper.Group#GROUP
-  self.CargoCarrier:SetState( self.CargoCarrier, "AI_CARGO_APC", self )
-
-  CargoCarrier:HandleEvent( EVENTS.Dead )
-  
-  function CargoCarrier:OnEventDead( EventData )
-    self:F({"dead"})
-    local AICargoTroops = self:GetState( self, "AI_CARGO_APC" )
-    self:F({AICargoTroops=AICargoTroops})
-    if AICargoTroops then
-      self:F({})
-      if not AICargoTroops:Is( "Loaded" ) then
-        -- There are enemies within combat radius. Unload the CargoCarrier.
-        AICargoTroops:Destroyed()
-      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()
-  
-  self:SetControllable( CargoCarrier )
-
-  self:Guard()
-
-  return self
-end
-
---- Set whether or not the carrier will use roads to *pickup* and *deploy* the cargo.
--- @param #AI_CARGO_APC self
--- @param #boolean Offroad If true, carrier will not use roads. If `nil` or `false` the carrier will use roads when available.
--- @param #number Formation Offroad formation used. Default is `ENUMS.Formation.Vehicle.Offroad`.
--- @return #AI_CARGO_APC self
-function AI_CARGO_APC:SetOffRoad(Offroad, Formation)
-
-  self:SetPickupOffRoad(Offroad, Formation)
-  self:SetDeployOffRoad(Offroad, Formation)
-  
-  return self
-end
-
---- Set whether the carrier will *not* use roads to *pickup* the cargo.
--- @param #AI_CARGO_APC self
--- @param #boolean Offroad If true, carrier will not use roads.
--- @param #number Formation Offroad formation used. Default is `ENUMS.Formation.Vehicle.Offroad`.
--- @return #AI_CARGO_APC self
-function AI_CARGO_APC:SetPickupOffRoad(Offroad, Formation)
-
-  self.pickupOffroad=Offroad
-  self.pickupFormation=Formation or ENUMS.Formation.Vehicle.OffRoad
-  
-  return self
-end
-
---- Set whether the carrier will *not* use roads to *deploy* the cargo.
--- @param #AI_CARGO_APC self
--- @param #boolean Offroad If true, carrier will not use roads.
--- @param #number Formation Offroad formation used. Default is `ENUMS.Formation.Vehicle.Offroad`.
--- @return #AI_CARGO_APC self
-function AI_CARGO_APC:SetDeployOffRoad(Offroad, Formation)
-
-  self.deployOffroad=Offroad
-  self.deployFormation=Formation or ENUMS.Formation.Vehicle.OffRoad
-  
-  return self
-end
-
-
---- Find a free Carrier within a radius.
--- @param #AI_CARGO_APC self
--- @param Core.Point#COORDINATE Coordinate
--- @param #number Radius
--- @return Wrapper.Group#GROUP NewCarrier
-function AI_CARGO_APC:FindCarrier( Coordinate, Radius )
-
-  local CoordinateZone = ZONE_RADIUS:New( "Zone" , Coordinate:GetVec2(), Radius )
-  CoordinateZone:Scan( { Object.Category.UNIT } )
-  for _, DCSUnit in pairs( CoordinateZone:GetScannedUnits() ) do
-    local NearUnit = UNIT:Find( DCSUnit )
-    self:F({NearUnit=NearUnit})
-    if not NearUnit:GetState( NearUnit, "AI_CARGO_APC" ) then
-      local Attributes = NearUnit:GetDesc()
-      self:F({Desc=Attributes})
-      if NearUnit:HasAttribute( "Trucks" ) then
-        return NearUnit:GetGroup()
-      end
-    end
-  end
-  
-  return nil
-
-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.
--- @param #AI_CARGO_APC self
--- @param #AI_CARGO_APC Me
--- @param Wrapper.Unit#UNIT APCUnit
--- @param Cargo.CargoGroup#CARGO_GROUP Cargo
--- @return #AI_CARGO_APC
-function AI_CARGO_APC:FollowToCarrier( Me, APCUnit, CargoGroup )
-
-  local InfantryGroup = CargoGroup:GetGroup()
-
-  self:F( { self = self:GetClassNameAndID(), InfantryGroup = InfantryGroup:GetName() } )
-  
-  --if self:Is( "Following" ) then
-
-  if APCUnit:IsAlive() then
-    -- We check if the Cargo is near to the CargoCarrier.
-    if InfantryGroup:IsPartlyInZone( ZONE_UNIT:New( "Radius", APCUnit, 25 ) ) then
-  
-      -- The Cargo does not need to follow the Carrier.
-      Me:Guard()
-    
-    else
-      
-      self:F( { InfantryGroup = InfantryGroup:GetName() } )
-    
-      if InfantryGroup:IsAlive() then
-            
-        self:F( { InfantryGroup = InfantryGroup:GetName() } )
-  
-        local Waypoints = {}
-        
-        -- Calculate the new Route.
-        local FromCoord = InfantryGroup:GetCoordinate()
-        local FromGround = FromCoord:WaypointGround( 10, "Diamond" )
-        self:F({FromGround=FromGround})
-        table.insert( Waypoints, FromGround )
-  
-        local ToCoord = APCUnit:GetCoordinate():GetRandomCoordinateInRadius( 10, 5 )
-        local ToGround = ToCoord:WaypointGround( 10, "Diamond" )
-        self:F({ToGround=ToGround})
-        table.insert( Waypoints, ToGround )
-        
-        local TaskRoute = InfantryGroup:TaskFunction( "AI_CARGO_APC.FollowToCarrier", Me, APCUnit, CargoGroup )
-        
-        self:F({Waypoints = Waypoints})
-        local Waypoint = Waypoints[#Waypoints]
-        InfantryGroup:SetTaskWaypoint( Waypoint, TaskRoute ) -- Set for the given Route at Waypoint 2 the TaskRouteToZone.
-      
-        InfantryGroup:Route( Waypoints, 1 ) -- Move after a random seconds to the Route. See the Route method for details.
-      end
-    end
-  end
-end
-
-
---- 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, IsTransporting = self:IsTransporting() } )
-
-  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
-                end
-              end
-            end
-          end
-        end
-        
-      end
-      self.CarrierCoordinate = APC:GetCoordinate()
-    end
-  
-    self:__Monitor( -5 )
-  end
-  
-end
-
-
---- 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 Cargo, APCUnit in pairs( self.Carrier_Cargo ) do
-      local Cargo = Cargo -- Cargo.Cargo#CARGO
-      if Cargo:IsUnLoaded() then
-        self:FollowToCarrier( self, APCUnit, Cargo )
-        APCUnit:RouteResume()
-      end
-    end
-  end
-  
-end
-
---- Pickup task function. Triggers Load event.
--- @param Wrapper.Group#GROUP APC The cargo carrier group.
--- @param #AI_CARGO_APC sel `AI_CARGO_APC` class.
--- @param Core.Point#COORDINATE Coordinate. The coordinate (not used).
--- @param #number Speed Speed (not used).
--- @param Core.Zone#ZONE PickupZone Pickup zone.
-function AI_CARGO_APC._Pickup(APC, self, Coordinate, Speed, PickupZone)
-
-  APC:F( { "AI_CARGO_APC._Pickup:", APC:GetName() } )
-
-  if APC:IsAlive() then
-    self:Load( PickupZone )
-  end
-end
-
---- Deploy task function. Triggers Unload event.
--- @param Wrapper.Group#GROUP APC The cargo carrier group.
--- @param #AI_CARGO_APC self `AI_CARGO_APC` class.
--- @param Core.Point#COORDINATE Coordinate. The coordinate (not used).
--- @param Core.Zone#ZONE DeployZone Deploy zone.
-function AI_CARGO_APC._Deploy(APC, self, Coordinate, DeployZone)
-
-  APC:F( { "AI_CARGO_APC._Deploy:", APC } )
-
-  if APC:IsAlive() then
-    self:Unload( DeployZone )
-  end
-end
-
-
-
---- 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.
--- @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
-
-    if Coordinate then
-      self.RoutePickup = true
-      
-      local _speed=Speed or APC:GetSpeedMax()*0.5
-
-      -- Route on road.
-      local Waypoints = {}
-      
-      if self.pickupOffroad then
-        Waypoints[1]=APC:GetCoordinate():WaypointGround(Speed, self.pickupFormation)
-        Waypoints[2]=Coordinate:WaypointGround(_speed, self.pickupFormation, DCSTasks)
-      else
-        Waypoints=APC:TaskGroundOnRoad(Coordinate, _speed, ENUMS.Formation.Vehicle.OffRoad, true)
-      end
-      
-  
-      local TaskFunction = APC:TaskFunction( "AI_CARGO_APC._Pickup", self, Coordinate, Speed, PickupZone )
-
-      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.
-    else
-      AI_CARGO_APC._Pickup( APC, self, Coordinate, Speed, PickupZone )
-    end
-
-    self:GetParent( self, AI_CARGO_APC ).onafterPickup( self, APC, From, Event, To, Coordinate, Speed, Height, PickupZone )
-  end
-  
-end
-
-
---- 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 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
-
-    self.RouteDeploy = true
-    
-    -- Set speed in km/h.
-    local speedmax=APC:GetSpeedMax()    
-    local _speed=Speed or speedmax*0.5    
-    _speed=math.min(_speed, speedmax)
-
-    -- Route on road.
-    local Waypoints = {}
-    
-    if self.deployOffroad then
-      Waypoints[1]=APC:GetCoordinate():WaypointGround(Speed, self.deployFormation)
-      Waypoints[2]=Coordinate:WaypointGround(_speed, self.deployFormation, DCSTasks)
-    else
-      Waypoints=APC:TaskGroundOnRoad(Coordinate, _speed, ENUMS.Formation.Vehicle.OffRoad, true)
-    end
-
-    -- Task function
-    local TaskFunction = APC:TaskFunction( "AI_CARGO_APC._Deploy", self, Coordinate, DeployZone )
-    
-    -- Last waypoint
-    local Waypoint = Waypoints[#Waypoints]
-    
-    -- Set task function
-    APC:SetTaskWaypoint(Waypoint, TaskFunction) -- Set for the given Route at Waypoint 2 the TaskRouteToZone.
-  
-    -- Route group
-    APC:Route( Waypoints, 1 ) -- Move after a random seconds to the Route. See the Route method for details.
-
-    -- Call parent function.
-    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 } )
-
-
-  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 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.
--- @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
-    
-    Speed = Speed or APC:GetSpeedMax()*0.5
-    
-    local Waypoints = APC:TaskGroundOnRoad( Coordinate, Speed, "Line abreast", true )
-
-    self:F({Waypoints = Waypoints})
-    local Waypoint = Waypoints[#Waypoints]
-  
-    APC:Route( Waypoints, 1 ) -- Move after a random seconds to the Route. See the Route method for details.
-    
-  end
-  
-end

Moose Development/Moose/AI/AI_Cargo_Airplane.lua

@@ -1,510 +0,0 @@
---- **AI** - Models the intelligent transportation of cargo using airplanes.
---
--- ===
--- 
--- ### Author: **FlightControl**
--- 
--- ===       
---
--- @module AI.AI_Cargo_Airplane
--- @image AI_Cargo_Dispatching_For_Airplanes.JPG
-
--- @type AI_CARGO_AIRPLANE
--- @extends Core.Fsm#FSM_CONTROLLABLE
-
-
---- 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 ... 
--- 
---
--- # Developer Note
--- 
--- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
--- Therefore, this class is considered to be deprecated
---
--- @field #AI_CARGO_AIRPLANE
-AI_CARGO_AIRPLANE = {
-  ClassName = "AI_CARGO_AIRPLANE",
-  Coordinate = nil, -- Core.Point#COORDINATE
-}
-
---- Creates a new AI_CARGO_AIRPLANE object.
--- @param #AI_CARGO_AIRPLANE self
--- @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, 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 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 transport plane.
-  -- @param #string From From state.
-  -- @param #string Event Event.
-  -- @param #string To To state.
-  -- @param Core.Point#COORDINATE Coordinate The coordinate where to pickup stuff.
-  -- @param #number Speed 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 PickupZone The airbase zone where the cargo will be picked up.
-  
-  --- Pickup Trigger for AI_CARGO_AIRPLANE
-  -- @function [parent=#AI_CARGO_AIRPLANE] Pickup
-  -- @param #AI_CARGO_AIRPLANE self
-  -- @param Core.Point#COORDINATE Coordinate The coordinate where to pickup stuff.
-  -- @param #number Speed 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 PickupZone The airbase zone where the cargo will be picked up.
-  
-  --- Pickup Asynchronous Trigger for AI_CARGO_AIRPLANE
-  -- @function [parent=#AI_CARGO_AIRPLANE] __Pickup
-  -- @param #AI_CARGO_AIRPLANE self
-  -- @param #number Delay Delay in seconds.
-  -- @param Core.Point#COORDINATE Coordinate The coordinate where to pickup stuff.
-  -- @param #number Speed 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 PickupZone The airbase zone where the cargo will be picked up.
-  
-  --- 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 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 From state.
-  -- @param #string Event Event.
-  -- @param #string To To state.
-  -- @param Core.Point#COORDINATE Coordinate Coordinate where to deploy stuff.
-  -- @param #number Speed Speed in km/h for travelling to the deploy base.
-  -- @param #number Height Height in meters to move to the home coordinate.
-  -- @param Core.Zone#ZONE_AIRBASE DeployZone The airbase zone where the cargo will be deployed.
-  
-  --- Deploy Trigger for AI_CARGO_AIRPLANE
-  -- @function [parent=#AI_CARGO_AIRPLANE] Deploy
-  -- @param #AI_CARGO_AIRPLANE self
-  -- @param Core.Point#COORDINATE Coordinate Coordinate where to deploy stuff.
-  -- @param #number Speed Speed in km/h for travelling to the deploy base.
-  -- @param #number Height Height in meters to move to the home coordinate.
-  -- @param Core.Zone#ZONE_AIRBASE DeployZone The airbase zone where the cargo will be deployed. 
-  
-  --- Deploy Asynchronous Trigger for AI_CARGO_AIRPLANE
-  -- @function [parent=#AI_CARGO_AIRPLANE] __Deploy
-  -- @param #AI_CARGO_AIRPLANE self
-  -- @param #number Delay Delay in seconds.
-  -- @param Core.Point#COORDINATE Coordinate Coordinate where to deploy stuff.
-  -- @param #number Speed Speed in km/h for travelling to the deploy base.
-  -- @param #number Height Height in meters to move to the home coordinate.
-  -- @param Core.Zone#ZONE_AIRBASE DeployZone The airbase zone where the cargo will be deployed.
-
-  --- 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
-
-
-  --- On after Deployed event.
-  -- @function [parent=#AI_CARGO_AIRPLANE] OnAfterDeployed
-  -- @param #AI_CARGO_AIRPLANE self
-  -- @param Wrapper.Group#GROUP Airplane Cargo plane.
-  -- @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.
-  
-  -- Set carrier. 
-  self:SetCarrier( Airplane )
-  
-  return self
-end
-
-
---- Set the Carrier (controllable). Also initializes events for carrier and defines the coalition.
--- @param #AI_CARGO_AIRPLANE self
--- @param Wrapper.Group#GROUP Airplane Transport plane.
--- @return #AI_CARGO_AIRPLANE self
-function AI_CARGO_AIRPLANE:SetCarrier( Airplane )
-
-  local AICargo = self
-
-  self.Airplane = Airplane -- Wrapper.Group#GROUP
-  self.Airplane:SetState( self.Airplane, "AI_CARGO_AIRPLANE", self )
-
-  self.RoutePickup = false
-  self.RouteDeploy = false
-
-  Airplane:HandleEvent( EVENTS.Dead )
-  Airplane:HandleEvent( EVENTS.Hit )
-  Airplane:HandleEvent( EVENTS.EngineShutdown )
-  
-  function Airplane:OnEventDead( EventData )
-    local AICargoTroops = self:GetState( self, "AI_CARGO_AIRPLANE" )
-    self:F({AICargoTroops=AICargoTroops})
-    if AICargoTroops then
-      self:F({})
-      if not AICargoTroops:Is( "Loaded" ) then
-        -- There are enemies within combat range. Unload the Airplane.
-        AICargoTroops:Destroyed()
-      end
-    end
-  end
-  
-  
-  function Airplane:OnEventHit( EventData )
-    local AICargoTroops = self:GetState( self, "AI_CARGO_AIRPLANE" )
-    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 Airplane.
-        AICargoTroops:Unload()
-      end
-    end
-  end
-  
-  
-  function Airplane:OnEventEngineShutdown( EventData )
-    AICargo.Relocating = false
-    AICargo:Landed( self.Airplane )
-  end
-  
-  self.Coalition = self.Airplane:GetCoalition()
-  
-  self:SetControllable( Airplane )
-
-  return self
-end
-
-
---- Find a free Carrier within a range.
--- @param #AI_CARGO_AIRPLANE self
--- @param Wrapper.Airbase#AIRBASE Airbase
--- @param #number Radius
--- @return Wrapper.Group#GROUP NewCarrier
-function AI_CARGO_AIRPLANE:FindCarrier( Coordinate, Radius )
-
-  local CoordinateZone = ZONE_RADIUS:New( "Zone" , Coordinate:GetVec2(), Radius )
-  CoordinateZone:Scan( { Object.Category.UNIT } )
-  for _, DCSUnit in pairs( CoordinateZone:GetScannedUnits() ) do
-    local NearUnit = UNIT:Find( DCSUnit )
-    self:F({NearUnit=NearUnit})
-    if not NearUnit:GetState( NearUnit, "AI_CARGO_AIRPLANE" ) then
-      local Attributes = NearUnit:GetDesc()
-      self:F({Desc=Attributes})
-      if NearUnit:HasAttribute( "Trucks" ) then
-        self:SetCarrier( NearUnit )
-        break
-      end
-    end
-  end
-
-end
-
---- 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
-function AI_CARGO_AIRPLANE:onafterLanded( Airplane, From, Event, To )
-
-  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( self.PickupZone )
-    end
-    
-    -- Aircraft was send to this airbase to deploy troops. Initiate unloading.
-    if self.RouteDeploy == true then
-      self:Unload()
-      self.RouteDeploy = false
-    end
-     
-  end
-  
-end
-
-
---- 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 The coordinate where to pickup stuff.
--- @param #number Speed 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 PickupZone The airbase 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
-    
-    local airbasepickup=Coordinate:GetClosestAirbase()
-    
-    self.PickupZone = PickupZone or ZONE_AIRBASE:New(airbasepickup:GetName())
-  
-    -- 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 = self.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())
-    
-    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, self.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 Coordinate where to deploy stuff.
--- @param #number Speed Speed in km/h for travelling to the deploy base.
--- @param #number Height Height in meters to move to the home coordinate.
--- @param Core.Zone#ZONE_AIRBASE DeployZone The airbase zone where the cargo will be deployed.
-function AI_CARGO_AIRPLANE:onafterDeploy( Airplane, From, Event, To, Coordinate, Speed, Height, DeployZone )
-
-  if Airplane and Airplane:IsAlive()~=nil then
-    
-    local Airbase = Coordinate:GetClosestAirbase()
-    
-    if DeployZone then
-      Airbase=DeployZone:GetAirbase()
-    end
-    
-    -- 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
-
-
---- 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.
--- @param Core.Zone#ZONE_AIRBASE DeployZone The airbase zone where the cargo will be deployed.
-function AI_CARGO_AIRPLANE:onafterUnload( Airplane, From, Event, To, DeployZone )
-
-  local UnboardInterval = 10
-  local UnboardDelay = 10
-
-  if Airplane and Airplane:IsAlive() then
-    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
-
---- 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
-
-    -- Set takeoff type.
-    local Takeoff = SPAWN.Takeoff.Cold
-    
-    -- Get template of group.
-    local Template = Airplane:GetTemplate()
-    
-    -- Nil check
-    if Template==nil then
-      return
-    end
-
-    -- Waypoints of the route.
-    local Points={}
-    
-    -- To point.
-    local AirbasePointVec2 = Airbase:GetPointVec2()
-    local ToWaypoint = AirbasePointVec2:WaypointAir(COORDINATE.WaypointAltType.BARO, "Land", "Landing", Speed or Airplane:GetSpeedMax()*0.8, true, Airbase)
-        
-    --ToWaypoint["airdromeId"]   = Airbase:GetID()
-    --ToWaypoint["speed_locked"] = true
-    
-
-    -- If self.Airbase~=nil then group is currently at an airbase, where it should be respawned.        
-    if self.Airbase then
-    
-      -- 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
-
-      local PointVec3 = Airplane:GetPointVec3()
-      Template.x = PointVec3.x
-      Template.y = PointVec3.z
- 
-      Template.route.points = Points
-            
-      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,263 +0,0 @@
---- **AI** - Models the intelligent transportation of infantry and other cargo using APCs.
---
--- ## 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.
---   * Define a list of deploy zones of various types to transport the cargo to.
---   * The vehicles follow the roads to ensure the fastest possible cargo transportation over the ground.
---   * Multiple vehicles can transport multiple cargo as one vehicle group.
---   * Multiple vehicle groups can be enabled as one collaborating transportation process.
---   * Infantry loaded as cargo, will unboard in case enemies are nearby and will help defending the vehicles.
---   * Different ranges can be setup for enemy defenses.
---   * Different options can be setup to tweak the cargo transporation behaviour.
---  
--- ===
--- 
--- ## 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**
--- 
--- ===       
---
--- @module AI.AI_Cargo_Dispatcher_APC
--- @image AI_Cargo_Dispatching_For_APC.JPG
-
--- @type AI_CARGO_DISPATCHER_APC
--- @extends AI.AI_Cargo_Dispatcher#AI_CARGO_DISPATCHER
-
-
---- 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 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.
--- 
--- ---
--- 
--- # 2) AI_CARGO_DISPATCHER_APC 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!**
--- 
--- ---
--- 
--- # 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.
---    
--- # 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.
--- 
--- # 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.
--- 
--- If no home zone is specified, the APCs will wait near the deploy zone for a new pickup command.   
---
--- # Developer Note
--- 
--- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
--- Therefore, this class is considered to be deprecated
---
--- ===
--- 
--- @field #AI_CARGO_DISPATCHER_APC
-AI_CARGO_DISPATCHER_APC = {
-  ClassName = "AI_CARGO_DISPATCHER_APC",
-}
-
---- Creates a new AI_CARGO_DISPATCHER_APC object.
--- @param #AI_CARGO_DISPATCHER_APC self
--- @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
--- 
---      -- An AI dispatcher object for a vehicle squadron, moving infantry from pickup zones to deploy zones.
--- 
---      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( APCSet, CargoSet, PickupZoneSet, DeployZoneSet ) ) -- #AI_CARGO_DISPATCHER_APC
-
-  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
-
-
---- AI cargo
--- @param #AI_CARGO_DISPATCHER_APC self
--- @param Wrapper.Group#GROUP APC The APC carrier.
--- @param Core.Set#SET_CARGO CargoSet Cargo set.
--- @return AI.AI_Cargo_APC#AI_CARGO_DISPATCHER_APC AI cargo APC object.
-function AI_CARGO_DISPATCHER_APC:AICargo( APC, CargoSet )
-
-  local aicargoapc=AI_CARGO_APC:New(APC, CargoSet, self.CombatRadius)
-  
-  aicargoapc:SetDeployOffRoad(self.deployOffroad, self.deployFormation)
-  aicargoapc:SetPickupOffRoad(self.pickupOffroad, self.pickupFormation)
-  
-  return aicargoapc
-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 (default), 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( 500 )
--- 
--- -- Keep the cargo in the carrier when the carrier is under attack.
--- AICargoDispatcher:SetCombatRadius( 0 )
-function AI_CARGO_DISPATCHER_APC:SetCombatRadius( CombatRadius )
-
-  self.CombatRadius = CombatRadius or 0
-
-  return self
-end
-
---- Set whether the carrier will *not* use roads to *pickup* and *deploy* the cargo.
--- @param #AI_CARGO_DISPATCHER_APC self
--- @param #boolean Offroad If true, carrier will not use roads.
--- @param #number Formation Offroad formation used. Default is `ENUMS.Formation.Vehicle.Offroad`.
--- @return #AI_CARGO_DISPATCHER_APC self
-function AI_CARGO_DISPATCHER_APC:SetOffRoad(Offroad, Formation)
-
-  self:SetPickupOffRoad(Offroad, Formation)
-  self:SetDeployOffRoad(Offroad, Formation)
-  
-  return self
-end
-
---- Set whether the carrier will *not* use roads to *pickup* the cargo.
--- @param #AI_CARGO_DISPATCHER_APC self
--- @param #boolean Offroad If true, carrier will not use roads.
--- @param #number Formation Offroad formation used. Default is `ENUMS.Formation.Vehicle.Offroad`.
--- @return #AI_CARGO_DISPATCHER_APC self
-function AI_CARGO_DISPATCHER_APC:SetPickupOffRoad(Offroad, Formation)
-
-  self.pickupOffroad=Offroad
-  self.pickupFormation=Formation or ENUMS.Formation.Vehicle.OffRoad
-  
-  return self
-end
-
---- Set whether the carrier will *not* use roads to *deploy* the cargo.
--- @param #AI_CARGO_DISPATCHER_APC self
--- @param #boolean Offroad If true, carrier will not use roads.
--- @param #number Formation Offroad formation used. Default is `ENUMS.Formation.Vehicle.Offroad`.
--- @return #AI_CARGO_DISPATCHER_APC self
-function AI_CARGO_DISPATCHER_APC:SetDeployOffRoad(Offroad, Formation)
-
-  self.deployOffroad=Offroad
-  self.deployFormation=Formation or ENUMS.Formation.Vehicle.OffRoad
-  
-  return self
-end

Moose Development/Moose/AI/AI_Cargo_Dispatcher_Airplane.lua

@@ -1,169 +0,0 @@
---- **AI** - 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**
--- 
--- ===       
---
--- @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
-
-
---- 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 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!**
--- 
---
--- # Developer Note
--- 
--- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
--- Therefore, this class is considered to be deprecated
---
--- 
--- @field #AI_CARGO_DISPATCHER_AIRPLANE
-AI_CARGO_DISPATCHER_AIRPLANE = {
-  ClassName = "AI_CARGO_DISPATCHER_AIRPLANE",
-}
-
---- Creates a new AI_CARGO_DISPATCHER_AIRPLANE object.
--- @param #AI_CARGO_DISPATCHER_AIRPLANE self
--- @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
--- 
---      -- 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( AirplaneSet, CargoSet, PickupZoneSet, DeployZoneSet )
-
-  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,199 +0,0 @@
---- **AI** - 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**
--- 
--- ===       
---
--- @module AI.AI_Cargo_Dispatcher_Helicopter
--- @image AI_Cargo_Dispatching_For_Helicopters.JPG
-
--- @type AI_CARGO_DISPATCHER_HELICOPTER
--- @extends AI.AI_Cargo_Dispatcher#AI_CARGO_DISPATCHER
-
-
---- 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 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.
---   
---   * @{#AI_CARGO_DISPATCHER\_HELICOPTER.New}(): Creates a new AI\_CARGO\_DISPATCHER\_HELICOPTER object.
--- 
--- ---
--- 
--- # 2. AI\_CARGO\_DISPATCHER\_HELICOPTER 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!**
--- 
--- ---
--- 
--- ## 3. Set the pickup parameters.
--- 
--- 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.SetPickupHeight}(): Set the height or randomizes the height in meters to pickup the cargo.
--- 
--- ---   
---    
--- ## 4. Set the deploy parameters.
--- 
--- 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.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.
--- 
--- If no home zone is specified, the helicopters will wait near the deploy zone for a new pickup command.   
---
--- # Developer Note
--- 
--- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
--- Therefore, this class is considered to be deprecated
---
--- ===
--- 
--- @field #AI_CARGO_DISPATCHER_HELICOPTER
-AI_CARGO_DISPATCHER_HELICOPTER = {
-  ClassName = "AI_CARGO_DISPATCHER_HELICOPTER",
-}
-
---- Creates a new AI_CARGO_DISPATCHER_HELICOPTER object.
--- @param #AI_CARGO_DISPATCHER_HELICOPTER self
--- @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
--- 
---      -- An AI dispatcher object for a helicopter squadron, moving infantry from pickup zones to deploy zones.
--- 
---      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( HelicopterSet, CargoSet, PickupZoneSet, DeployZoneSet ) ) -- #AI_CARGO_DISPATCHER_HELICOPTER
-
-  self:SetPickupSpeed( 350, 150 )
-  self:SetDeploySpeed( 350, 150 )
-
-  self:SetPickupRadius( 40, 12 )
-  self:SetDeployRadius( 40, 12 )
-  
-  self:SetPickupHeight( 500, 200 )
-  self:SetDeployHeight( 500, 200 )
-  
-  return self
-end
-
-
-function AI_CARGO_DISPATCHER_HELICOPTER:AICargo( Helicopter, CargoSet )
-
-  local dispatcher = AI_CARGO_HELICOPTER:New( Helicopter, CargoSet )
-  dispatcher:SetLandingSpeedAndHeight(27, 6)
-  return dispatcher
-  
-end
-

Moose Development/Moose/AI/AI_Cargo_Dispatcher_Ship.lua

@@ -1,198 +0,0 @@
---- **AI** - Models the intelligent transportation of infantry and other cargo using Ships.
---
--- ## Features:
--- 
---   * Transport cargo to various deploy zones using naval vehicles.
---   * Various @{Cargo.Cargo#CARGO} types can be transported, including infantry, vehicles, and crates.
---   * Define a deploy zone of various types to determine the destination of the cargo.
---   * Ships will follow shipping lanes as defined in the Mission Editor.
---   * Multiple ships can transport multiple cargo as a single group.
---
--- ===
---
--- ## Test Missions: 
---
--- NEED TO DO
---
--- ===
---
--- ### Author: **acrojason** (derived from AI_Cargo_Dispatcher_APC by FlightControl)
---
--- ===
---
--- @module AI.AI_Cargo_Dispatcher_Ship
--- @image AI_Cargo_Dispatcher.JPG
-
--- @type AI_CARGO_DISPATCHER_SHIP
--- @extends AI.AI_Cargo_Dispatcher#AI_CARGO_DISPATCHER
-
-
---- A dynamic cargo transportation capability for AI groups.
--- 
--- Naval vessels can be mobilized to semi-intelligently transport cargo within the simulation.
---
--- The AI_CARGO_DISPATCHER_SHIP module is derived from the AI_CARGO_DISPATCHER module.
---
--- ## Note! In order to fully understand the mechanisms of the AI_CARGO_DISPATCHER_SHIP class, it is recommended that you first consult and READ the documentation of the @{AI.AI_Cargo_Dispatcher} module!!!
---
--- This will be particularly helpful in order to determine how to **Tailor the different cargo handling events**.
---
--- The AI_CARGO_DISPATCHER_SHIP 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 generally be declared within the mission to make the AI_CARGO_DISPATCHER_SHIP object recognize the cargo.
---
---
--- # 1) AI_CARGO_DISPATCHER_SHIP constructor.
--- 
---   * @{#AI_CARGO_DISPATCHER_SHIP.New}(): Creates a new AI_CARGO_DISPATCHER_SHIP object.
---
--- ---
---
--- # 2) AI_CARGO_DISPATCHER_SHIP 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!**
--- 
--- ---
--- 
--- # 3) Set the pickup parameters.
--- 
--- Several parameters can be set to pickup cargo:
--- 
---    * @{#AI_CARGO_DISPATCHER_SHIP.SetPickupRadius}(): Sets or randomizes the pickup location for the Ship around the cargo coordinate in a radius defined an outer and optional inner radius. 
---    * @{#AI_CARGO_DISPATCHER_SHIP.SetPickupSpeed}(): Set the speed or randomizes the speed in km/h to pickup the cargo.
---    
--- # 4) Set the deploy parameters.
--- 
--- Several parameters can be set to deploy cargo:
--- 
---    * @{#AI_CARGO_DISPATCHER_SHIP.SetDeployRadius}(): Sets or randomizes the deploy location for the Ship around the cargo coordinate in a radius defined an outer and an optional inner radius. 
---    * @{#AI_CARGO_DISPATCHER_SHIP.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.
--- 
--- A home zone can be specified to where the Ship will move when there isn't any cargo left for pickup.
--- Use @{#AI_CARGO_DISPATCHER_SHIP.SetHomeZone}() to specify the home zone.
--- 
--- If no home zone is specified, the Ship will wait near the deploy zone for a new pickup command.   
---
--- # Developer Note
--- 
--- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
--- Therefore, this class is considered to be deprecated
---
--- ===
--- 
--- @field #AI_CARGO_DISPATCHER_SHIP
-AI_CARGO_DISPATCHER_SHIP = {
-    ClassName = "AI_CARGO_DISPATCHER_SHIP"
-  }
-  
---- Creates a new AI_CARGO_DISPATCHER_SHIP object.
--- @param #AI_CARGO_DISPATCHER_SHIP self
--- @param Core.Set#SET_GROUP ShipSet  The set of @{Wrapper.Group#GROUP} objects of Ships 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, or CARGO_SLINGLOAD objects.
--- @param Core.Set#SET_ZONE PickupZoneSet  The set of pickup zones which are used to determine from where the cargo can be picked up by the Ship. 
--- @param Core.Set#SET_ZONE DeployZoneSet  The set of deploy zones which determine where the cargo will be deployed by the Ship.
--- @param #table ShippingLane  Table containing list of Shipping Lanes to be used
--- @return #AI_CARGO_DISPATCHER_SHIP
--- @usage
---
---      -- An AI dispatcher object for a naval group, moving cargo from pickup zones to deploy zones via a predetermined Shipping Lane
---
---      local SetCargoInfantry = SET_CARGO:New():FilterTypes( "Infantry" ):FilterStart()
---      local SetShip = SET_GROUP:New():FilterPrefixes( "Ship" ):FilterStart()
---      local SetPickupZones = SET_ZONE:New():FilterPrefixes( "Pickup" ):FilterStart()
---      local SetDeployZones = SET_ZONE:New():FilterPrefixes( "Deploy" ):FilterStart()
---      NEED MORE THOUGHT - ShippingLane is part of Warehouse.......
---      local ShippingLane = SET_GROUP:New():FilterPrefixes( "ShippingLane" ):FilterOnce():GetSetObjects()
--- 
---      AICargoDispatcherShip = AI_CARGO_DISPATCHER_SHIP:New( SetShip, SetCargoInfantry, SetPickupZones, SetDeployZones, ShippingLane )
---      AICargoDispatcherShip:Start()
---
-function AI_CARGO_DISPATCHER_SHIP:New( ShipSet, CargoSet, PickupZoneSet, DeployZoneSet, ShippingLane )
-
-  local self = BASE:Inherit( self, AI_CARGO_DISPATCHER:New( ShipSet, CargoSet, PickupZoneSet, DeployZoneSet ) )
-
-  self:SetPickupSpeed( 60, 10 )
-  self:SetDeploySpeed( 60, 10 )
-
-  self:SetPickupRadius( 500, 6000 )
-  self:SetDeployRadius( 500, 6000 )
-
-  self:SetPickupHeight( 0, 0 )
-  self:SetDeployHeight( 0, 0 )
-
-  self:SetShippingLane( ShippingLane )
-
-  self:SetMonitorTimeInterval( 600 )
-
-  return self
-end
-
-function AI_CARGO_DISPATCHER_SHIP:SetShippingLane( ShippingLane )
-  self.ShippingLane = ShippingLane
-
-  return self
-
-end
-
-function AI_CARGO_DISPATCHER_SHIP:AICargo( Ship, CargoSet )
-
-  return AI_CARGO_SHIP:New( Ship, CargoSet, 0, self.ShippingLane )
-end

Moose Development/Moose/AI/AI_Cargo_Helicopter.lua

@@ -1,661 +0,0 @@
---- **AI** - Models the intelligent transportation of cargo using helicopters.
---
--- ===
--- 
--- ### Author: **FlightControl**
--- 
--- ===       
---
--- @module AI.AI_Cargo_Helicopter
--- @image AI_Cargo_Dispatching_For_Helicopters.JPG
-
--- @type AI_CARGO_HELICOPTER
--- @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 helicopters, 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 ... 
--- 
---
--- # Developer Note
--- 
--- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
--- Therefore, this class is considered to be deprecated
---
--- ===
--- 
--- @field #AI_CARGO_HELICOPTER
-AI_CARGO_HELICOPTER = {
-  ClassName = "AI_CARGO_HELICOPTER",
-  Coordinate = nil, -- Core.Point#COORDINATE,
-}
-
-AI_CARGO_QUEUE = {}
-
---- Creates a new AI_CARGO_HELICOPTER object.
--- @param #AI_CARGO_HELICOPTER self
--- @param Wrapper.Group#GROUP Helicopter
--- @param Core.Set#SET_CARGO CargoSet
--- @return #AI_CARGO_HELICOPTER
-function AI_CARGO_HELICOPTER:New( Helicopter, CargoSet )
-
-  local self = BASE:Inherit( self, AI_CARGO:New( Helicopter, CargoSet ) ) -- #AI_CARGO_HELICOPTER
-
-  self.Zone = ZONE_GROUP:New( Helicopter:GetName(), Helicopter, 300 )
-
-  self:SetStartState( "Unloaded" ) 
-  -- Boarding
-  self:AddTransition( "Unloaded",     "Pickup",     "Unloaded" )
-  self:AddTransition( "*",            "Landed",     "*" )
-  self:AddTransition( "*",            "Load",       "*" )
-  self:AddTransition( "*",            "Loaded",     "Loaded" )
-  self:AddTransition( "Loaded",       "PickedUp",   "Loaded" )
-  
-  -- Unboarding
-  self:AddTransition( "Loaded",       "Deploy",     "*" )
-  self:AddTransition( "*",            "Queue",      "*" )
-  self:AddTransition( "*",            "Orbit" ,     "*" )
-  self:AddTransition( "*",            "Destroyed",  "*" )
-  self:AddTransition( "*",            "Unload",     "*" )    
-  self:AddTransition( "*",            "Unloaded",   "Unloaded" )
-  self:AddTransition( "Unloaded",     "Deployed",   "Unloaded" )
-  
-  -- RTB
-  self:AddTransition( "*", "Home" , "*" ) 
-
-  --- Pickup Handler OnBefore for AI_CARGO_HELICOPTER
-  -- @function [parent=#AI_CARGO_HELICOPTER] OnBeforePickup
-  -- @param #AI_CARGO_HELICOPTER self
-  -- @param #string From
-  -- @param #string Event
-  -- @param #string To
-  -- @param Core.Point#COORDINATE Coordinate
-  -- @return #boolean
-  
-  --- Pickup Handler OnAfter for AI_CARGO_HELICOPTER
-  -- @function [parent=#AI_CARGO_HELICOPTER] OnAfterPickup
-  -- @param #AI_CARGO_HELICOPTER self
-  -- @param #string From
-  -- @param #string Event
-  -- @param #string To
-  -- @param Core.Point#COORDINATE Coordinate
-  -- @param #number Speed Speed in km/h to fly to the pickup coordinate. Default is 50% of max possible speed the unit can go.
-  
-    --- PickedUp Handler OnAfter for AI_CARGO_HELICOPTER - Cargo set has been picked up, ready to deploy
-  -- @function [parent=#AI_CARGO_HELICOPTER] OnAfterPickedUp
-  -- @param #AI_CARGO_HELICOPTER self
-  -- @param Wrapper.Group#GROUP Helicopter The helicopter #GROUP object
-  -- @param #string From
-  -- @param #string Event
-  -- @param #string To
-  -- @param Wrapper.Unit#UNIT Unit The helicopter #UNIT object
-
-    --- Unloaded Handler OnAfter for AI_CARGO_HELICOPTER - Cargo unloaded, carrier is empty
-  -- @function [parent=#AI_CARGO_HELICOPTER] OnAfterUnloaded
-  -- @param #AI_CARGO_HELICOPTER self
-  -- @param #string From
-  -- @param #string Event
-  -- @param #string To
-  -- @param Cargo.CargoGroup#CARGO_GROUP Cargo The #CARGO_GROUP object.
-  -- @param Wrapper.Unit#UNIT Unit The helicopter #UNIT object
-  
-  --- 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 fly 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 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
-  -- @param #AI_CARGO_HELICOPTER self
-  -- @param #string From
-  -- @param #string Event
-  -- @param #string To
-  -- @param Core.Point#COORDINATE Coordinate Place at which cargo is deployed.
-  -- @param #number Speed Speed in km/h to fly to the pickup coordinate. Default is 50% of max possible speed the unit can go.
-  -- @return #boolean
-  
-  --- Deploy Handler OnAfter for AI_CARGO_HELICOPTER
-  -- @function [parent=#AI_CARGO_HELICOPTER] OnAfterDeploy
-  -- @param #AI_CARGO_HELICOPTER self
-  -- @param #string From
-  -- @param #string Event
-  -- @param #string To
-  -- @param Core.Point#COORDINATE Coordinate
-  -- @param #number Speed Speed in km/h to fly to the pickup coordinate. Default is 50% of max possible speed the unit can go.
-  
-    --- Deployed Handler OnAfter for AI_CARGO_HELICOPTER
-  -- @function [parent=#AI_CARGO_HELICOPTER] OnAfterDeployed
-  -- @param #AI_CARGO_HELICOPTER self
-  -- @param #string From
-  -- @param #string Event
-  -- @param #string To
-  
-  --- Deploy Trigger for AI_CARGO_HELICOPTER
-  -- @function [parent=#AI_CARGO_HELICOPTER] Deploy
-  -- @param #AI_CARGO_HELICOPTER self
-  -- @param Core.Point#COORDINATE Coordinate Place at which the cargo is deployed.
-  -- @param #number Speed Speed in km/h to fly 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 Place at which the cargo is deployed.
-  -- @param #number Speed Speed in km/h to fly to the pickup coordinate. Default is 50% of max possible speed the unit can go.
-  
-  --- Home Trigger for AI_CARGO_HELICOPTER
-  -- @function [parent=#AI_CARGO_HELICOPTER] Home
-  -- @param #AI_CARGO_HELICOPTER self
-  -- @param Core.Point#COORDINATE Coordinate Place to which the helicopter will go.
-  -- @param #number Speed (optional) Speed in km/h to fly to the pickup coordinate. Default is 50% of max possible speed the unit can go.
-  -- @param #number Height (optional) Height the Helicopter should be flying at.
-  
-  --- Home Asynchronous Trigger for AI_CARGO_HELICOPTER
-  -- @function [parent=#AI_CARGO_HELICOPTER] __Home
-  -- @param #number Delay Delay in seconds.
-  -- @param #AI_CARGO_HELICOPTER self
-  -- @param Core.Point#COORDINATE Coordinate Place to which the helicopter will go.
-  -- @param #number Speed (optional) Speed in km/h to fly to the pickup coordinate. Default is 50% of max possible speed the unit can go.
-  -- @param #number Height (optional) Height the Helicopter should be flying at. 
-
-  -- We need to capture the Crash events for the helicopters.
-  -- The helicopter reference is used in the semaphore AI_CARGO_QUEUE.
-  -- So, we need to unlock this when the helo is not anymore ...
-  Helicopter:HandleEvent( EVENTS.Crash,
-    function( Helicopter, EventData )
-      AI_CARGO_QUEUE[Helicopter] = nil
-    end
-  )
-
-  -- We need to capture the Land events for the helicopters.
-  -- The helicopter reference is used in the semaphore AI_CARGO_QUEUE.
-  -- So, we need to unlock this when the helo has landed, which can be anywhere ...
-  -- But only free the landing coordinate after 1 minute, to ensure that all helos have left.
-  Helicopter:HandleEvent( EVENTS.Land,
-    function( Helicopter, EventData )
-      self:ScheduleOnce( 60, 
-        function( Helicopter )
-          AI_CARGO_QUEUE[Helicopter] = nil
-        end, Helicopter
-      )
-    end
-  )
-
-  self:SetCarrier( Helicopter )
-  
-  self.landingspeed = 15 -- kph
-  self.landingheight = 5.5 -- meter
-  
-  return self
-end
-
-
-
-
-
---- Set the Carrier.
--- @param #AI_CARGO_HELICOPTER self
--- @param Wrapper.Group#GROUP Helicopter
--- @return #AI_CARGO_HELICOPTER
-function AI_CARGO_HELICOPTER:SetCarrier( Helicopter )
-
-  local AICargo = self
-
-  self.Helicopter = Helicopter -- Wrapper.Group#GROUP
-  self.Helicopter:SetState( self.Helicopter, "AI_CARGO_HELICOPTER", self )
-
-  self.RoutePickup = false
-  self.RouteDeploy = false
-
-  Helicopter:HandleEvent( EVENTS.Dead )
-  Helicopter:HandleEvent( EVENTS.Hit )
-  Helicopter:HandleEvent( EVENTS.Land )
-  
-  function Helicopter:OnEventDead( EventData )
-    local AICargoTroops = self:GetState( self, "AI_CARGO_HELICOPTER" )
-    self:F({AICargoTroops=AICargoTroops})
-    if AICargoTroops then
-      self:F({})
-      if not AICargoTroops:Is( "Loaded" ) then
-        -- There are enemies within combat range. Unload the Helicopter.
-        AICargoTroops:Destroyed()
-      end
-    end
-  end
-  
-  function Helicopter:OnEventLand( EventData )
-    AICargo:Landed()
-  end
-  
-  self.Coalition = self.Helicopter:GetCoalition()
-  
-  self:SetControllable( Helicopter )
-
-  return self
-end
-
---- Set landingspeed and -height for helicopter landings. Adjust after tracing if your helis get stuck after landing.
--- @param #AI_CARGO_HELICOPTER self
--- @param #number speed Landing speed in kph(!), e.g. 15
--- @param #number height Landing height in meters(!), e.g. 5.5
--- @return #AI_CARGO_HELICOPTER self
--- @usage If your choppers get stuck, add tracing to your script to determine if they hit the right parameters like so:
---    
---        BASE:TraceOn()
---        BASE:TraceClass("AI_CARGO_HELICOPTER")
---        
--- Watch the DCS.log for entries stating `Helicopter:<name>, Height = Helicopter:<number>, Velocity = Helicopter:<number>`
--- Adjust if necessary.
-function AI_CARGO_HELICOPTER:SetLandingSpeedAndHeight(speed, height)
-  local _speed = speed or 15
-  local _height = height or 5.5
-  self.landingheight = _height
-  self.landingspeed = _speed
-  return self
-end
-
--- @param #AI_CARGO_HELICOPTER self
--- @param Wrapper.Group#GROUP Helicopter
--- @param From
--- @param Event
--- @param To
-function AI_CARGO_HELICOPTER:onafterLanded( Helicopter, From, Event, To )
-  self:F({From, Event, To})
-  Helicopter:F( { Name = Helicopter:GetName() } )
-
-  if Helicopter and Helicopter:IsAlive() then
-
-    -- S_EVENT_LAND is directly called in two situations:
-    -- 1 - When the helo lands normally on the ground.
-    -- 2 - when the helo is hit and goes RTB or even when it is destroyed.
-    -- For point 2, this is an issue, the infantry may not unload in this case!
-    -- So we check if the helo is on the ground, and velocity< 15.
-    -- Only then the infantry can unload (and load too, for consistency)!
-
-    self:T( { Helicopter:GetName(), Height = Helicopter:GetHeight( true ), Velocity = Helicopter:GetVelocityKMH() } )
-
-    if self.RoutePickup == true then
-      if Helicopter:GetHeight( true ) <= self.landingheight then --and Helicopter:GetVelocityKMH() < self.landingspeed then
-        --self:Load( Helicopter:GetPointVec2() )
-        self:Load( self.PickupZone )
-        self.RoutePickup = false
-      end
-    end
-    
-    if self.RouteDeploy == true then
-      if Helicopter:GetHeight( true ) <= self.landingheight then --and Helicopter:GetVelocityKMH() < self.landingspeed then
-        self:Unload( self.DeployZone )
-        self.RouteDeploy = false
-      end
-    end
-     
-  end
-  
-end
-
--- @param #AI_CARGO_HELICOPTER self
--- @param Wrapper.Group#GROUP Helicopter
--- @param From
--- @param Event
--- @param To
--- @param Core.Point#COORDINATE Coordinate
--- @param #number Speed
-function AI_CARGO_HELICOPTER:onafterQueue( Helicopter, From, Event, To, Coordinate, Speed, DeployZone )
-  self:F({From, Event, To, Coordinate, Speed, DeployZone})
-  local HelicopterInZone = false
-
-  if Helicopter and Helicopter:IsAlive() == true then
-    
-    local Distance = Coordinate:DistanceFromPointVec2( Helicopter:GetCoordinate() )
-    
-    if Distance > 2000 then
-      self:__Queue( -10, Coordinate, Speed, DeployZone )
-    else
-    
-      local ZoneFree = true
-
-      for Helicopter, ZoneQueue in pairs( AI_CARGO_QUEUE ) do
-        local ZoneQueue = ZoneQueue -- Core.Zone#ZONE_RADIUS
-        if ZoneQueue:IsCoordinateInZone( Coordinate ) then
-          ZoneFree = false
-        end
-      end
-      
-      self:F({ZoneFree=ZoneFree})
-      
-      if ZoneFree == true then
-     
-        local ZoneQueue = ZONE_RADIUS:New( Helicopter:GetName(), Coordinate:GetVec2(), 100 )
-     
-        AI_CARGO_QUEUE[Helicopter] = ZoneQueue 
-      
-        local Route = {}
-        
---          local CoordinateFrom = Helicopter:GetCoordinate()
---          local WaypointFrom = CoordinateFrom:WaypointAir( 
---            "RADIO", 
---            COORDINATE.WaypointType.TurningPoint, 
---            COORDINATE.WaypointAction.TurningPoint, 
---            Speed, 
---            true 
---          )
---          Route[#Route+1] = WaypointFrom
-        local CoordinateTo = Coordinate
-        
-        local landheight = CoordinateTo:GetLandHeight() -- get target height
-        CoordinateTo.y = landheight + 50 -- flight height should be 50m above ground
-    
-        local WaypointTo = CoordinateTo:WaypointAir( 
-          "RADIO", 
-          COORDINATE.WaypointType.TurningPoint, 
-          COORDINATE.WaypointAction.TurningPoint, 
-          50, 
-          true 
-        )
-        Route[#Route+1] = WaypointTo
-        
-        local Tasks = {}
-        Tasks[#Tasks+1] = Helicopter:TaskLandAtVec2( CoordinateTo:GetVec2() )
-        Route[#Route].task = Helicopter:TaskCombo( Tasks )
-    
-        Route[#Route+1] = WaypointTo
-    
-        -- 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, Speed, DeployZone )
-      end
-    end
-  else
-    AI_CARGO_QUEUE[Helicopter] = nil
-  end
-end
-
-
--- @param #AI_CARGO_HELICOPTER self
--- @param Wrapper.Group#GROUP Helicopter
--- @param From
--- @param Event
--- @param To
--- @param Core.Point#COORDINATE Coordinate
--- @param #number Speed
-function AI_CARGO_HELICOPTER:onafterOrbit( Helicopter, From, Event, To, Coordinate )
-  self:F({From, Event, To, Coordinate})
-  
-  if Helicopter and Helicopter:IsAlive() then
-    
-    local Route = {}
-    
-    local CoordinateTo = Coordinate
-    local landheight = CoordinateTo:GetLandHeight() -- get target height
-    CoordinateTo.y = landheight + 50 -- flight height should be 50m above ground
-    
-    local WaypointTo = CoordinateTo:WaypointAir("RADIO", COORDINATE.WaypointType.TurningPoint, COORDINATE.WaypointAction.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
-
-
-
---- On after Deployed event.
--- @param #AI_CARGO_HELICOPTER self
--- @param Wrapper.Group#GROUP Helicopter
--- @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( { From, Event, To, DeployZone = DeployZone } )
-
-  self:Orbit( Helicopter:GetCoordinate(), 50 )
-
- -- Free the coordinate zone after 30 seconds, so that the original helicopter can fly away first.
-  self:ScheduleOnce( 30, 
-    function( Helicopter )
-      AI_CARGO_QUEUE[Helicopter] = nil
-    end, Helicopter
-  )
-  
-  self:GetParent( self, AI_CARGO_HELICOPTER ).onafterDeployed( self, Helicopter, From, Event, To, DeployZone )
-  
-end
-
---- 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 Pickup place.
--- @param #number Speed Speed in km/h to fly 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 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 )
-  self:F({Coordinate, Speed, Height, PickupZone })
-  
-  if Helicopter and Helicopter:IsAlive() ~= nil then
-
-    Helicopter:Activate()
-
-    self.RoutePickup = true
-    Coordinate.y = Height
-    
-    local _speed=Speed or Helicopter:GetSpeedMax()*0.5        
-     
-    local Route = {}
-    
-    --- Calculate the target route point.
-    local CoordinateFrom = Helicopter:GetCoordinate()
-
-    --- Create a route point of type air.
-    local WaypointFrom = CoordinateFrom:WaypointAir("RADIO", COORDINATE.WaypointType.TurningPoint, COORDINATE.WaypointAction.TurningPoint, _speed, true)
-
-    --- Create a route point of type air.
-    local CoordinateTo = Coordinate
-    local landheight = CoordinateTo:GetLandHeight() -- get target height
-    CoordinateTo.y = landheight + 50 -- flight height should be 50m above ground
-    
-    local WaypointTo = CoordinateTo:WaypointAir("RADIO", COORDINATE.WaypointType.TurningPoint, COORDINATE.WaypointAction.TurningPoint,_speed, true)
-
-    Route[#Route+1] = WaypointFrom
-    Route[#Route+1] = WaypointTo
-    
-    --- Now we're going to do something special, we're going to call a function from a waypoint action at the AIControllable...
-    Helicopter:WayPointInitialize( Route )
-  
-    local Tasks = {}
-    
-    Tasks[#Tasks+1] = Helicopter:TaskLandAtVec2( CoordinateTo:GetVec2() )
-    Route[#Route].task = Helicopter:TaskCombo( Tasks )
-
-    Route[#Route+1] = WaypointTo
-
-    -- 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 )
-
-  end
-  
-end
-
---- 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
-
---- 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 Place at which the cargo is deployed.
--- @param #number Speed Speed in km/h to fly 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 deploy coordinate.
-function AI_CARGO_HELICOPTER:onafterDeploy( Helicopter, From, Event, To, Coordinate, Speed, Height, DeployZone )
-  self:F({From, Event, To, Coordinate, Speed, Height, DeployZone})
-  if Helicopter and Helicopter:IsAlive() ~= nil then
-
-    self.RouteDeploy = true
-
-     
-    local Route = {}
-    
-    --- Calculate the target route point.
-
-    Coordinate.y = Height
-    
-    local _speed=Speed or Helicopter:GetSpeedMax()*0.5      
-
-    --- Create a route point of type air.
-    local CoordinateFrom = Helicopter:GetCoordinate()
-    local WaypointFrom = CoordinateFrom:WaypointAir("RADIO", COORDINATE.WaypointType.TurningPoint, COORDINATE.WaypointAction.TurningPoint, _speed, true)
-    Route[#Route+1] = WaypointFrom
-    Route[#Route+1] = WaypointFrom
-
-    --- Create a route point of type air.
-    
-    local CoordinateTo = Coordinate
-    local landheight = CoordinateTo:GetLandHeight() -- get target height
-    CoordinateTo.y = landheight + 50 -- flight height should be 50m above ground
-    
-    local WaypointTo = CoordinateTo:WaypointAir("RADIO", COORDINATE.WaypointType.TurningPoint, COORDINATE.WaypointAction.TurningPoint, _speed, true)
-
-    Route[#Route+1] = WaypointTo
-    Route[#Route+1] = WaypointTo
-    
-    --- Now we're going to do something special, we're going to call a function from a waypoint action at the AIControllable...
-    Helicopter:WayPointInitialize( Route )
-  
-    local Tasks = {}
-    
-    -- The _Deploy function does not exist.
-    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() )
-    Route[#Route].task = Helicopter:TaskCombo( Tasks )
-
-    Route[#Route+1] = WaypointTo
-
-    -- 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
-
-
---- 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 Home place.
--- @param #number Speed Speed in km/h to fly 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 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 )
-  self:F({From, Event, To, Coordinate, Speed, Height})
-  
-  if Helicopter and Helicopter:IsAlive() ~= nil then
-
-    self.RouteHome = true
-     
-    local Route = {}
-    
-    --- Calculate the target route point.
-
-    --Coordinate.y = Height
-    Height = Height or 50
-    
-    Speed = Speed or Helicopter:GetSpeedMax()*0.5          
-
-    --- Create a route point of type air.
-    local CoordinateFrom = Helicopter:GetCoordinate()
-    
-    local WaypointFrom = CoordinateFrom:WaypointAir("RADIO", COORDINATE.WaypointType.TurningPoint, COORDINATE.WaypointAction.TurningPoint, Speed, true)
-    Route[#Route+1] = WaypointFrom
-
-    --- Create a route point of type air.
-    local CoordinateTo = Coordinate
-    local landheight = CoordinateTo:GetLandHeight() -- get target height
-    CoordinateTo.y = landheight + Height -- flight height should be 50m above ground
-    
-    local WaypointTo = CoordinateTo:WaypointAir("RADIO", COORDINATE.WaypointType.TurningPoint, COORDINATE.WaypointAction.TurningPoint, Speed, true)
-
-    Route[#Route+1] = WaypointTo
-    
-    --- Now we're going to do something special, we're going to call a function from a waypoint action at the AIControllable...
-    Helicopter:WayPointInitialize( Route )
-  
-    local Tasks = {}
-    
-    Tasks[#Tasks+1] = Helicopter:TaskLandAtVec2( CoordinateTo:GetVec2() )
-    Route[#Route].task = Helicopter:TaskCombo( Tasks )
- 
-    Route[#Route+1] = WaypointTo
-
-    -- Now route the helicopter
-    Helicopter:Route(Route, 0)
-  end
-  
-end
-

Moose Development/Moose/AI/AI_Cargo_Ship.lua

@@ -1,402 +0,0 @@
---- **AI** - Models the intelligent transportation of infantry and other cargo.
---
--- ===
---
--- ### Author: **acrojason** (derived from AI_Cargo_APC by FlightControl)
---
--- ===
---
--- @module AI.AI_Cargo_Ship
--- @image AI_Cargo_Dispatcher.JPG
-
--- @type AI_CARGO_SHIP
--- @extends AI.AI_Cargo#AI_CARGO
-
---- Brings a dynamic cargo handling capability for an AI naval group.
---
--- Naval ships can be utilized to transport cargo around the map following naval shipping lanes.
--- The AI_CARGO_SHIP class uses the @{Cargo.Cargo} capabilities within the MOOSE framework. 
--- @{Cargo.Cargo} must be declared within the mission or warehouse to make the AI_CARGO_SHIP recognize the cargo.
--- Please consult the @{Cargo.Cargo} module for more information.
---
--- ## Cargo loading.
--- 
--- The module will automatically load cargo when the Ship is within boarding or loading radius. 
--- The boarding or loading radius is specified when the cargo is created in the simulation and depends on the type of 
--- cargo and the specified boarding radius.
---
--- ## Defending the Ship when enemies are nearby
--- This is not supported for naval cargo because most tanks don't float. Protect your transports...
---
--- ## Infantry or cargo **health**.
--- When cargo is unboarded from the Ship, the cargo is actually respawned into the battlefield.
--- As a result, the unboarding cargo 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 newly spawned units as a parameter.
--- However, cargo that was destroyed when unboarded and following the Ship won't be respawned again (this is likely not a thing for
--- naval cargo due to the lack of support for defending the Ship mentioned above). 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. Given the relatively short duration of DCS missions and the somewhat
--- lengthy naval transport times, most units entering the Ship as cargo will be freshly en route to an amphibious landing or transporting 
--- between warehouses.
---
--- ## Control the Ships on the map.
--- 
--- Currently, naval transports can only be controlled via scripts due to their reliance upon predefined Shipping Lanes created in the Mission
--- Editor. An interesting future enhancement could leverage new pathfinding functionality for ships in the Ops module.
---
--- ## Cargo deployment.
---
--- Using the @{#AI_CARGO_SHIP.Deploy}() method, you are able to direct the Ship towards a Deploy zone to unboard/unload the cargo at the
--- specified coordinate. The Ship will follow the Shipping Lane to ensure consistent cargo transportation within the simulation environment.
---
--- ## Cargo pickup.
---
--- Using the @{#AI_CARGO_SHIP.Pickup}() method, you are able to direct the Ship towards a Pickup zone to board/load the cargo at the specified
--- coordinate. The Ship will follow the Shipping Lane to ensure consistent cargo transportation within the simulation environment.
---
---
--- # Developer Note
--- 
--- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
--- Therefore, this class is considered to be deprecated
---
--- @field #AI_CARGO_SHIP
-AI_CARGO_SHIP = {
-    ClassName = "AI_CARGO_SHIP",
-    Coordinate = nil -- Core.Point#COORDINATE
-}
-
---- Creates a new AI_CARGO_SHIP object.
--- @param #AI_CARGO_SHIP self
--- @param Wrapper.Group#GROUP Ship  The carrier Ship 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 CombatRadius is 0, no defense will occur.
--- @param #table ShippingLane  Table containing list of Shipping Lanes to be used
--- @return #AI_CARGO_SHIP
-function AI_CARGO_SHIP:New( Ship, CargoSet, CombatRadius, ShippingLane )
-
-    local self = BASE:Inherit( self, AI_CARGO:New( Ship, CargoSet ) ) -- #AI_CARGO_SHIP
-
-    self:AddTransition( "*", "Monitor", "*" )
-    self:AddTransition( "*", "Destroyed", "Destroyed" )
-    self:AddTransition( "*", "Home", "*" )
-
-    self:SetCombatRadius( 0 )  -- Don't want to deploy cargo in middle of water to defend Ship, so set CombatRadius to 0
-    self:SetShippingLane ( ShippingLane )
-
-    self:SetCarrier( Ship )
-
-    return self
-end
-
---- Set the Carrier
--- @param #AI_CARGO_SHIP self
--- @param Wrapper.Group#GROUP CargoCarrier
--- @return #AI_CARGO_SHIP
-function AI_CARGO_SHIP:SetCarrier( CargoCarrier )
-    self.CargoCarrier = CargoCarrier -- Wrapper.Group#GROUIP
-    self.CargoCarrier:SetState( self.CargoCarrier, "AI_CARGO_SHIP", self )
-
-    CargoCarrier:HandleEvent( EVENTS.Dead )
-
-    function CargoCarrier:OnEventDead( EventData )
-        self:F({"dead"})
-        local AICargoTroops = self:GetState( self, "AI_CARGO_SHIP" )
-        self:F({AICargoTroops=AICargoTroops})
-        if AICargoTroops then
-            self:F({})
-            if not AICargoTroops:Is( "Loaded" ) then
-                -- Better hope they can swim!
-                AICargoTroops:Destroyed()
-            end
-        end
-    end
-
-    self.Zone = ZONE_UNIT:New( self.CargoCarrier:GetName() .. "-Zone", self.CargoCarrier, self.CombatRadius )
-    self.Coalition = self.CargoCarrier:GetCoalition()
-
-    self:SetControllable( CargoCarrier )
-
-    return self
-end
-
-
---- FInd a free Carrier within a radius
--- @param #AI_CARGO_SHIP self
--- @param Core.Point#COORDINATE Coordinate
--- @param #number Radius
--- @return Wrapper.Group#GROUP NewCarrier
-function AI_CARGO_SHIP:FindCarrier( Coordinate, Radius )
-
-    local CoordinateZone = ZONE_RADIUS:New( "Zone", Coordinate:GetVec2(), Radius )
-    CoordinateZone:Scan( { Object.Category.UNIT } )
-    for _, DCSUnit in pairs( CoordinateZone:GetScannedUnits() ) do
-        local NearUnit = UNIT:Find( DCSUnit )
-        self:F({NearUnit=NearUnit})
-        if not NearUnit:GetState( NearUnit, "AI_CARGO_SHIP" ) then
-            local Attributes = NearUnit:GetDesc()
-            self:F({Desc=Attributes})
-            if NearUnit:HasAttributes( "Trucks" ) then
-                return NearUnit:GetGroup()
-            end
-        end
-    end
-
-    return nil
-end
-
-function AI_CARGO_SHIP:SetShippingLane( ShippingLane )
-    self.ShippingLane = ShippingLane
-
-    return self
-end
-
-function AI_CARGO_SHIP:SetCombatRadius( CombatRadius )
-    self.CombatRadius = CombatRadius or 0
-
-    return self
-end
-
-
---- Follow Infantry to the Carrier
--- @param #AI_CARGO_SHIP self
--- @param #AI_CARGO_SHIP Me
--- @param Wrapper.Unit#UNIT ShipUnit
--- @param Cargo.CargoGroup#CARGO_GROUP Cargo
--- @return #AI_CARGO_SHIP
-function AI_CARGO_SHIP:FollowToCarrier( Me, ShipUnit, CargoGroup )
-
-    local InfantryGroup = CargoGroup:GetGroup()
-
-    self:F( { self=self:GetClassNameAndID(), InfantryGroup = InfantryGroup:GetName() } )
-
-    if ShipUnit:IsAlive() then
-        -- Check if the Cargo is near the CargoCarrier
-        if InfantryGroup:IsPartlyInZone( ZONE_UNIT:New( "Radius", ShipUnit, 1000 ) ) then
-
-            -- Cargo does not need to navigate to Carrier
-            Me:Guard()
-        else
-
-            self:F( { InfantryGroup = InfantryGroup:GetName() } )
-            if InfantryGroup:IsAlive() then
-
-                self:F( { InfantryGroup = InfantryGroup:GetName() } )
-                local Waypoints = {}
-
-                -- Calculate new route
-                local FromCoord = InfantryGroup:GetCoordinate()
-                local FromGround = FromCoord:WaypointGround( 10, "Diamond" )
-                self:F({FromGround=FromGround})
-                table.insert( Waypoints, FromGround )
-
-                local ToCoord = ShipUnit:GetCoordinate():GetRandomCoordinateInRadius( 10, 5 )
-                local ToGround = ToCoord:WaypointGround( 10, "Diamond" )
-                self:F({ToGround=ToGround})
-                table.insert( Waypoints, ToGround )
-
-                local TaskRoute = InfantryGroup:TaskFunction( "AI_CARGO_SHIP.FollowToCarrier", Me, ShipUnit, CargoGroup )
-
-                self:F({Waypoints=Waypoints})
-                local Waypoint = Waypoints[#Waypoints]
-                InfantryGroup:SetTaskWaypoint( Waypoint, TaskRoute ) -- Set for the given Route at Waypoint 2 the TaskRouteToZone
-
-                InfantryGroup:Route( Waypoints, 1 ) -- Move after a random number of seconds to the Route.  See Route method for details
-            end
-        end
-    end
-end
-
-
-function AI_CARGO_SHIP:onafterMonitor( Ship, From, Event, To )
-    self:F( { Ship, From, Event, To, IsTransporting = self:IsTransporting() } )
-
-    if self.CombatRadius > 0 then
-        -- We really shouldn't find ourselves in here for Ships since the CombatRadius should always be 0.
-        -- This is to avoid Unloading the Ship in the middle of the sea.
-        if Ship and Ship:IsAlive() then
-            if self.CarrierCoordinate then
-                if self:IsTransporting() == true then
-                    local Coordinate = Ship: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, ShipUnit in pairs( self.Carrier_Cargo ) do
-                                            local Cargo = Cargo -- Cargo.Cargo#CARGO
-                                            local ShipUnit = ShipUnit -- Wrapper.Unit#UNIT
-                                            if Cargo:IsAlive() then
-                                                if not Cargo:IsNear( ShipUnit, 40 ) then
-                                                    ShipUnit:RouteStop()
-                                                    self.CarrierStopped = true
-                                                else
-                                                    if self.CarrierStopped then
-                                                        if Cargo:IsNear( ShipUnit, 25 ) then
-                                                            ShipUnit:RouteResume()
-                                                            self.CarrierStopped = nil
-                                                        end
-                                                    end
-                                                end
-                                            end
-                                        end
-                                    end
-                                end
-                            end
-                        end
-                    end
-                end
-            self.CarrierCoordinate = Ship:GetCoordinate()
-        end
-        self:__Monitor( -5 )
-    end
-end
-
---- Check if cargo ship is alive and trigger Load event
--- @param Wrapper.Group#Group Ship
--- @param #AI_CARGO_SHIP self
-function AI_CARGO_SHIP._Pickup( Ship, self, Coordinate, Speed, PickupZone )
-    
-    Ship:F( { "AI_CARGO_Ship._Pickup:", Ship:GetName() } )
-
-    if Ship:IsAlive() then
-        self:Load( PickupZone )
-    end
-end
-
---- Check if cargo ship is alive and trigger Unload event. Good time to remind people that Lua is case sensitive and Unload != UnLoad
--- @param Wrapper.Group#GROUP Ship
--- @param #AI_CARGO_SHIP self
-function AI_CARGO_SHIP._Deploy( Ship, self, Coordinate, DeployZone )
-    Ship:F( { "AI_CARGO_Ship._Deploy:", Ship } )
-
-    if Ship:IsAlive() then
-        self:Unload( DeployZone )
-    end
-end
-
---- on after Pickup event.
--- @param AI_CARGO_SHIP Ship
--- @param From
--- @param Event
--- @param To
--- @param Core.Point#COORDINATE  Coordinate of the pickup point
--- @param #number Speed  Speed in km/h to sail to the pickup coordinate. Default is 50% of max speed for the unit
--- @param #number Height  Altitude in meters to move to the pickup coordinate. This parameter is ignored for Ships
--- @param Core.Zone#ZONE PickupZone (optional)  The zone where the cargo will be picked up. The PickupZone can be nil if there was no PickupZoneSet provided
-function AI_CARGO_SHIP:onafterPickup( Ship, From, Event, To, Coordinate, Speed, Height, PickupZone )
-    
-    if Ship and Ship:IsAlive() then
-        AI_CARGO_SHIP._Pickup( Ship, self, Coordinate, Speed, PickupZone )
-        self:GetParent( self, AI_CARGO_SHIP ).onafterPickup( self, Ship, From, Event, To, Coordinate, Speed, Height, PickupZone )
-    end
-end
-
---- On after Deploy event.
--- @param #AI_CARGO_SHIP self
--- @param Wrapper.Group#GROUP SHIP
--- @param From
--- @param Event
--- @param To
--- @param Core.Point#COORDINATE Coordinate  Coordinate of the deploy point
--- @param #number Speed  Speed in km/h to sail to the deploy coordinate. Default is 50% of max speed for the unit
--- @param #number Height  Altitude in meters to move to the deploy coordinate. This parameter is ignored for Ships
--- @param Core.Zone#ZONE  DeployZone The zone where the cargo will be deployed.
-function AI_CARGO_SHIP:onafterDeploy( Ship, From, Event, To, Coordinate, Speed, Height, DeployZone )
-
-  if Ship and Ship:IsAlive() then
-    
-    Speed = Speed or Ship:GetSpeedMax()*0.8
-    local lane = self.ShippingLane
-
-    if lane then
-      local Waypoints = {}
-
-      for i=1, #lane do
-        local coord = lane[i]
-        local Waypoint = coord:WaypointGround(_speed)
-        table.insert(Waypoints, Waypoint)
-      end
-
-      local TaskFunction = Ship:TaskFunction( "AI_CARGO_SHIP._Deploy", self, Coordinate, DeployZone )
-      local Waypoint = Waypoints[#Waypoints]
-      Ship:SetTaskWaypoint( Waypoint, TaskFunction )
-      Ship:Route(Waypoints, 1)  
-      self:GetParent( self, AI_CARGO_SHIP ).onafterDeploy( self, Ship, From, Event, To, Coordinate, Speed, Height, DeployZone )
-    else
-      self:E(self.lid.."ERROR: No shipping lane defined for Naval Transport!")
-    end
-  end
-end
-
---- On after Unload event.
--- @param #AI_CARGO_SHIP self
--- @param Wrapper.Group#GROUP Ship
--- @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_SHIP:onafterUnload( Ship, From, Event, To, DeployZone, Defend )
-    self:F( { Ship, From, Event, To, DeployZone, Defend = Defend } )
-  
-    local UnboardInterval = 5
-    local UnboardDelay = 5
-  
-    if Ship and Ship:IsAlive() then
-      for _, ShipUnit in pairs( Ship:GetUnits() ) do
-        local ShipUnit = ShipUnit -- Wrapper.Unit#UNIT
-        Ship:RouteStop()
-        for _, Cargo in pairs( ShipUnit:GetCargo() ) do
-          self:F( { Cargo = Cargo:GetName(), Isloaded = Cargo:IsLoaded() } )
-          if Cargo:IsLoaded() then
-            local unboardCoord = DeployZone:GetRandomPointVec2()
-            Cargo:__UnBoard( UnboardDelay, unboardCoord, 1000)
-            UnboardDelay = UnboardDelay + Cargo:GetCount() * UnboardInterval
-            self:__Unboard( UnboardDelay, Cargo, ShipUnit, DeployZone, Defend )
-            if not Defend == true then
-              Cargo:SetDeployed( true )
-            end
-          end 
-        end
-      end
-    end
-end
-
-function AI_CARGO_SHIP:onafterHome( Ship, From, Event, To, Coordinate, Speed, Height, HomeZone )
-    if Ship and Ship:IsAlive() then
-        
-        self.RouteHome = true
-        Speed = Speed or Ship:GetSpeedMax()*0.8
-        local lane = self.ShippingLane
- 
-        if lane then
-            local Waypoints = {}
-
-            -- Need to find a more generalized way to do this instead of reversing the shipping lane.
-            -- This only works if the Source/Dest route waypoints are numbered 1..n and not n..1
-            for i=#lane, 1, -1 do
-                local coord = lane[i]
-                local Waypoint = coord:WaypointGround(_speed)
-                table.insert(Waypoints, Waypoint)
-            end
-
-            local Waypoint = Waypoints[#Waypoints]
-            Ship:Route(Waypoints, 1)
-        
-        else
-            self:E(self.lid.."ERROR: No shipping lane defined for Naval Transport!")
-        end
-    end
-end

Moose Development/Moose/AI/AI_Escort_Dispatcher.lua

@@ -1,190 +0,0 @@
---- **AI** - 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 MOOSE.JPG
-
-
--- @type AI_ESCORT_DISPATCHER
--- @extends Core.Fsm#FSM
-
-
---- Models the automatic assignment of AI escorts to player flights.
---
--- # Developer Note
--- 
--- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
--- Therefore, this class is considered to be deprecated
---
--- ===
---   
--- @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:T({EscortAirbase= self.EscortAirbase } )
-  self:T({PlayerGroupName = PlayerGroupName } )
-  self:T({PlayerGroup = PlayerGroup})
-  self:T({FirstGroup = self.CarrierSet:GetFirst()})
-  self:T({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:T({EscortAirbase= self.EscortAirbase } )
-  self:T({PlayerGroupName = PlayerGroupName } )
-  self:T({PlayerGroup = PlayerGroup})
-  self:T({FirstGroup = self.CarrierSet:GetFirst()})
-  self:T({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:T({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

@@ -1,151 +0,0 @@
---- **AI** - 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 MOOSE.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.
---
--- # Developer Note
--- 
--- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
--- Therefore, this class is considered to be deprecated
---
--- ===
---   
--- @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

@@ -1,321 +0,0 @@
---- **AI** - 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/AI/AI_Escort)
--- 
--- ===
--- 
--- 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.
-  --
-  -- # Developer Note
-  -- 
-  -- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
-  -- Therefore, this class is considered to be deprecated
-  --
--- ===
--- 
--- ### Authors: **FlightControl** 
--- 
--- ===
---
--- @module AI.AI_Escort_Request
--- @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_Patrol.lua

@@ -1,948 +0,0 @@
---- **AI** - Perform Air Patrolling for airplanes.
--- 
--- **Features:**
--- 
---   * Patrol AI airplanes within a given zone.
---   * Trigger detected events when enemy airplanes are detected.
---   * Manage a fuel threshold to RTB on time.
--- 
--- ===
--- 
--- AI PATROL classes makes AI Controllables execute an Patrol.
--- 
--- There are the following types of PATROL classes defined:
--- 
---   * @{#AI_PATROL_ZONE}: Perform a PATROL in a zone.
---   
--- ===
--- 
--- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AI/AI_Patrol)
--- 
--- ===
--- 
--- ### [YouTube Playlist](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl35HvYZKA6G22WMt7iI3zky)
--- 
--- ===
--- 
--- ### Author: **FlightControl**
--- ### Contributions: 
--- 
---   * **Dutch_Baron**: Working together with James has resulted in the creation of the AI_BALANCER class. James has shared his ideas on balancing AI with air units, and together we made a first design which you can use now :-)
---   * **Pikey**: Testing and API concept review.
--- 
--- ===
--- 
--- @module AI.AI_Patrol
--- @image AI_Air_Patrolling.JPG
-
---- AI_PATROL_ZONE class
--- @type AI_PATROL_ZONE
--- @field Wrapper.Controllable#CONTROLLABLE AIControllable The @{Wrapper.Controllable} patrolling.
--- @field Core.Zone#ZONE_BASE PatrolZone The @{Core.Zone} where the patrol needs to be executed.
--- @field DCS#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
--- @field DCS#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
--- @field DCS#Speed  PatrolMinSpeed The minimum speed of the @{Wrapper.Controllable} in km/h.
--- @field DCS#Speed  PatrolMaxSpeed The maximum speed of the @{Wrapper.Controllable} in km/h.
--- @field Core.Spawn#SPAWN CoordTest
--- @extends Core.Fsm#FSM_CONTROLLABLE
-
---- Implements the core functions to patrol a @{Core.Zone} by an AI @{Wrapper.Controllable} or @{Wrapper.Group}.
--- 
--- ![Process](..\Presentations\AI_PATROL\Dia3.JPG)
--- 
--- The AI_PATROL_ZONE is assigned a @{Wrapper.Group} and this must be done before the AI_PATROL_ZONE process can be started using the **Start** event.
--- 
--- ![Process](..\Presentations\AI_PATROL\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_PATROL\Dia5.JPG)
--- 
--- This cycle will continue.
--- 
--- ![Process](..\Presentations\AI_PATROL\Dia6.JPG)
--- 
--- During the patrol, the AI will detect enemy targets, which are reported through the **Detected** event.
---
--- ![Process](..\Presentations\AI_PATROL\Dia9.JPG)
--- 
----- Note that the enemy is not engaged! To model enemy engagement, either tailor the **Detected** event, or
--- use derived AI_ classes to model AI offensive or defensive behaviour.
--- 
--- ![Process](..\Presentations\AI_PATROL\Dia10.JPG)
--- 
--- Until a fuel or damage threshold has been reached by the AI, or when the AI is commanded to RTB.
--- When the fuel threshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
--- 
--- ![Process](..\Presentations\AI_PATROL\Dia11.JPG)
--- 
--- ## 1. AI_PATROL_ZONE constructor
---   
---   * @{#AI_PATROL_ZONE.New}(): Creates a new AI_PATROL_ZONE object.
--- 
--- ## 2. AI_PATROL_ZONE is a FSM
--- 
--- ![Process](..\Presentations\AI_PATROL\Dia2.JPG)
--- 
--- ### 2.1. AI_PATROL_ZONE States
--- 
---   * **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.
--- 
--- ### 2.2. AI_PATROL_ZONE Events
--- 
---   * **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 thresholds have been reached, the AI will RTB.
---    
--- ## 3. Set or Get the AI controllable
--- 
---   * @{#AI_PATROL_ZONE.SetControllable}(): Set the AIControllable.
---   * @{#AI_PATROL_ZONE.GetControllable}(): Get the AIControllable.
---
--- ## 4. Set the Speed and Altitude boundaries of the AI controllable
---
---   * @{#AI_PATROL_ZONE.SetSpeed}(): Set the patrol speed boundaries of the AI, for the next patrol.
---   * @{#AI_PATROL_ZONE.SetAltitude}(): Set altitude boundaries of the AI, for the next patrol.
--- 
--- ## 5. Manage the detection process of the AI controllable
--- 
--- The detection process of the AI controllable can be manipulated.
--- Detection requires an amount of CPU power, which has an impact on your mission performance.
--- Only put detection on when absolutely necessary, and the frequency of the detection can also be set.
--- 
---   * @{#AI_PATROL_ZONE.SetDetectionOn}(): Set the detection on. The AI will detect for targets.
---   * @{#AI_PATROL_ZONE.SetDetectionOff}(): Set the detection off, the AI will not detect for targets. The existing target list will NOT be erased.
--- 
--- The detection frequency can be set with @{#AI_PATROL_ZONE.SetRefreshTimeInterval}( seconds ), where the amount of seconds specify how much seconds will be waited before the next detection.
--- Use the method @{#AI_PATROL_ZONE.GetDetectedUnits}() to obtain a list of the @{Wrapper.Unit}s detected by the AI.
--- 
--- The detection can be filtered to potential targets in a specific zone.
--- Use the method @{#AI_PATROL_ZONE.SetDetectionZone}() to set the zone where targets need to be detected.
--- Note that when the zone is too far away, or the AI is not heading towards the zone, or the AI is too high, no targets may be detected
--- according the weather conditions.
--- 
--- ## 6. Manage the "out of fuel" in the AI_PATROL_ZONE
--- 
--- 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 threshold is calculated.
--- When the fuel threshold is reached, the AI will continue for a given time its patrol task in orbit, 
--- while a new AI is targeted to the AI_PATROL_ZONE.
--- Once the time is finished, the old AI will return to the base.
--- Use the method @{#AI_PATROL_ZONE.ManageFuel}() to have this process in place.
--- 
--- ## 7. Manage "damage" behaviour of the AI in the AI_PATROL_ZONE
--- 
--- When the AI is damaged, it is required that a new AIControllable is started. However, damage cannon be foreseen early on. 
--- Therefore, when the damage threshold is reached, the AI will return immediately to the home base (RTB).
--- Use the method @{#AI_PATROL_ZONE.ManageDamage}() to have this process in place.
---
--- # Developer Note
--- 
--- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
--- Therefore, this class is considered to be deprecated
---
--- ===
--- 
--- @field #AI_PATROL_ZONE
-AI_PATROL_ZONE = {
-  ClassName = "AI_PATROL_ZONE",
-}
-
---- Creates a new AI_PATROL_ZONE object
--- @param #AI_PATROL_ZONE self
--- @param Core.Zone#ZONE_BASE PatrolZone The @{Core.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.Controllable} in km/h.
--- @param DCS#Speed  PatrolMaxSpeed The maximum speed of the @{Wrapper.Controllable} in km/h.
--- @param DCS#AltitudeType PatrolAltType The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to RADIO
--- @return #AI_PATROL_ZONE self
--- @usage
--- -- Define a new AI_PATROL_ZONE Object. This PatrolArea will patrol an AIControllable within PatrolZone between 3000 and 6000 meters, with a variying speed between 600 and 900 km/h.
--- PatrolZone = ZONE:New( 'PatrolZone' )
--- PatrolSpawn = SPAWN:New( 'Patrol Group' )
--- PatrolArea = AI_PATROL_ZONE:New( PatrolZone, 3000, 6000, 600, 900 )
-function AI_PATROL_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, PatrolAltType )
-
-  -- Inherits from BASE
-  local self = BASE:Inherit( self, FSM_CONTROLLABLE:New() ) -- #AI_PATROL_ZONE
-
-
-  self.PatrolZone = PatrolZone
-  self.PatrolFloorAltitude = PatrolFloorAltitude
-  self.PatrolCeilingAltitude = PatrolCeilingAltitude
-  self.PatrolMinSpeed = PatrolMinSpeed
-  self.PatrolMaxSpeed = PatrolMaxSpeed
-
-  -- defafult PatrolAltType to "BARO" if not specified
-  self.PatrolAltType = PatrolAltType or "BARO"
-
-  self:SetRefreshTimeInterval( 30 )
-
-  self.CheckStatus = true
-
-  self:ManageFuel( .2, 60 )
-  self:ManageDamage( 1 )
-
-
-  self.DetectedUnits = {} -- This table contains the targets detected during patrol.
-
-  self:SetStartState( "None" ) 
-
-  self:AddTransition( "*", "Stop", "Stopped" )
-
---- OnLeave Transition Handler for State Stopped.
--- @function [parent=#AI_PATROL_ZONE] OnLeaveStopped
--- @param #AI_PATROL_ZONE 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.
--- @return #boolean Return false to cancel Transition.
-
---- OnEnter Transition Handler for State Stopped.
--- @function [parent=#AI_PATROL_ZONE] OnEnterStopped
--- @param #AI_PATROL_ZONE 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_PATROL_ZONE] OnBeforeStop
--- @param #AI_PATROL_ZONE 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.
--- @return #boolean Return false to cancel Transition.
-
---- OnAfter Transition Handler for Event Stop.
--- @function [parent=#AI_PATROL_ZONE] OnAfterStop
--- @param #AI_PATROL_ZONE 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_PATROL_ZONE] Stop
--- @param #AI_PATROL_ZONE self
-
---- Asynchronous Event Trigger for Event Stop.
--- @function [parent=#AI_PATROL_ZONE] __Stop
--- @param #AI_PATROL_ZONE self
--- @param #number Delay The delay in seconds.
-
-  self:AddTransition( "None", "Start", "Patrolling" )
-
---- OnBefore Transition Handler for Event Start.
--- @function [parent=#AI_PATROL_ZONE] OnBeforeStart
--- @param #AI_PATROL_ZONE 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.
--- @return #boolean Return false to cancel Transition.
-
---- OnAfter Transition Handler for Event Start.
--- @function [parent=#AI_PATROL_ZONE] OnAfterStart
--- @param #AI_PATROL_ZONE 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 Start.
--- @function [parent=#AI_PATROL_ZONE] Start
--- @param #AI_PATROL_ZONE self
-
---- Asynchronous Event Trigger for Event Start.
--- @function [parent=#AI_PATROL_ZONE] __Start
--- @param #AI_PATROL_ZONE self
--- @param #number Delay The delay in seconds.
-
---- OnLeave Transition Handler for State Patrolling.
--- @function [parent=#AI_PATROL_ZONE] OnLeavePatrolling
--- @param #AI_PATROL_ZONE 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.
--- @return #boolean Return false to cancel Transition.
-
---- OnEnter Transition Handler for State Patrolling.
--- @function [parent=#AI_PATROL_ZONE] OnEnterPatrolling
--- @param #AI_PATROL_ZONE 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.
-
-  self:AddTransition( "Patrolling", "Route", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_PATROL_ZONE.
-
---- OnBefore Transition Handler for Event Route.
--- @function [parent=#AI_PATROL_ZONE] OnBeforeRoute
--- @param #AI_PATROL_ZONE 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.
--- @return #boolean Return false to cancel Transition.
-
---- OnAfter Transition Handler for Event Route.
--- @function [parent=#AI_PATROL_ZONE] OnAfterRoute
--- @param #AI_PATROL_ZONE 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 Route.
--- @function [parent=#AI_PATROL_ZONE] Route
--- @param #AI_PATROL_ZONE self
-
---- Asynchronous Event Trigger for Event Route.
--- @function [parent=#AI_PATROL_ZONE] __Route
--- @param #AI_PATROL_ZONE self
--- @param #number Delay The delay in seconds.
-
-  self:AddTransition( "*", "Status", "*" ) -- FSM_CONTROLLABLE Transition for type #AI_PATROL_ZONE.
-
---- OnBefore Transition Handler for Event Status.
--- @function [parent=#AI_PATROL_ZONE] OnBeforeStatus
--- @param #AI_PATROL_ZONE 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.
--- @return #boolean Return false to cancel Transition.
-
---- OnAfter Transition Handler for Event Status.
--- @function [parent=#AI_PATROL_ZONE] OnAfterStatus
--- @param #AI_PATROL_ZONE 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_PATROL_ZONE] Status
--- @param #AI_PATROL_ZONE self
-
---- Asynchronous Event Trigger for Event Status.
--- @function [parent=#AI_PATROL_ZONE] __Status
--- @param #AI_PATROL_ZONE self
--- @param #number Delay The delay in seconds.
-
-  self:AddTransition( "*", "Detect", "*" ) -- FSM_CONTROLLABLE Transition for type #AI_PATROL_ZONE.
-
---- OnBefore Transition Handler for Event Detect.
--- @function [parent=#AI_PATROL_ZONE] OnBeforeDetect
--- @param #AI_PATROL_ZONE 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.
--- @return #boolean Return false to cancel Transition.
-
---- OnAfter Transition Handler for Event Detect.
--- @function [parent=#AI_PATROL_ZONE] OnAfterDetect
--- @param #AI_PATROL_ZONE 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 Detect.
--- @function [parent=#AI_PATROL_ZONE] Detect
--- @param #AI_PATROL_ZONE self
-
---- Asynchronous Event Trigger for Event Detect.
--- @function [parent=#AI_PATROL_ZONE] __Detect
--- @param #AI_PATROL_ZONE self
--- @param #number Delay The delay in seconds.
-
-  self:AddTransition( "*", "Detected", "*" ) -- FSM_CONTROLLABLE Transition for type #AI_PATROL_ZONE.
-
---- OnBefore Transition Handler for Event Detected.
--- @function [parent=#AI_PATROL_ZONE] OnBeforeDetected
--- @param #AI_PATROL_ZONE 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.
--- @return #boolean Return false to cancel Transition.
-
---- OnAfter Transition Handler for Event Detected.
--- @function [parent=#AI_PATROL_ZONE] OnAfterDetected
--- @param #AI_PATROL_ZONE 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 Detected.
--- @function [parent=#AI_PATROL_ZONE] Detected
--- @param #AI_PATROL_ZONE self
-
---- Asynchronous Event Trigger for Event Detected.
--- @function [parent=#AI_PATROL_ZONE] __Detected
--- @param #AI_PATROL_ZONE self
--- @param #number Delay The delay in seconds.
-
-  self:AddTransition( "*", "RTB", "Returning" ) -- FSM_CONTROLLABLE Transition for type #AI_PATROL_ZONE.
-
---- OnBefore Transition Handler for Event RTB.
--- @function [parent=#AI_PATROL_ZONE] OnBeforeRTB
--- @param #AI_PATROL_ZONE 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.
--- @return #boolean Return false to cancel Transition.
-
---- OnAfter Transition Handler for Event RTB.
--- @function [parent=#AI_PATROL_ZONE] OnAfterRTB
--- @param #AI_PATROL_ZONE 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_PATROL_ZONE] RTB
--- @param #AI_PATROL_ZONE self
-
---- Asynchronous Event Trigger for Event RTB.
--- @function [parent=#AI_PATROL_ZONE] __RTB
--- @param #AI_PATROL_ZONE self
--- @param #number Delay The delay in seconds.
-
---- OnLeave Transition Handler for State Returning.
--- @function [parent=#AI_PATROL_ZONE] OnLeaveReturning
--- @param #AI_PATROL_ZONE 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.
--- @return #boolean Return false to cancel Transition.
-
---- OnEnter Transition Handler for State Returning.
--- @function [parent=#AI_PATROL_ZONE] OnEnterReturning
--- @param #AI_PATROL_ZONE 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.
-
-  self:AddTransition( "*", "Reset", "Patrolling" ) -- FSM_CONTROLLABLE Transition for type #AI_PATROL_ZONE.
-
-  self:AddTransition( "*", "Eject", "*" )
-  self:AddTransition( "*", "Crash", "Crashed" )
-  self:AddTransition( "*", "PilotDead", "*" )
-
-  return self
-end
-
-
-
-
---- Sets (modifies) the minimum and maximum speed of the patrol.
--- @param #AI_PATROL_ZONE 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_PATROL_ZONE self
-function AI_PATROL_ZONE:SetSpeed( PatrolMinSpeed, PatrolMaxSpeed )
-  self:F2( { PatrolMinSpeed, PatrolMaxSpeed } )
-
-  self.PatrolMinSpeed = PatrolMinSpeed
-  self.PatrolMaxSpeed = PatrolMaxSpeed
-end
-
-
-
---- Sets the floor and ceiling altitude of the patrol.
--- @param #AI_PATROL_ZONE 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_PATROL_ZONE self
-function AI_PATROL_ZONE:SetAltitude( PatrolFloorAltitude, PatrolCeilingAltitude )
-  self:F2( { PatrolFloorAltitude, PatrolCeilingAltitude } )
-
-  self.PatrolFloorAltitude = PatrolFloorAltitude
-  self.PatrolCeilingAltitude = PatrolCeilingAltitude
-end
-
---   * @{#AI_PATROL_ZONE.SetDetectionOn}(): Set the detection on. The AI will detect for targets.
---   * @{#AI_PATROL_ZONE.SetDetectionOff}(): Set the detection off, the AI will not detect for targets. The existing target list will NOT be erased.
-
---- Set the detection on. The AI will detect for targets.
--- @param #AI_PATROL_ZONE self
--- @return #AI_PATROL_ZONE self
-function AI_PATROL_ZONE:SetDetectionOn()
-  self:F2()
-
-  self.DetectOn = true
-end
-
---- Set the detection off. The AI will NOT detect for targets.
--- However, the list of already detected targets will be kept and can be enquired!
--- @param #AI_PATROL_ZONE self
--- @return #AI_PATROL_ZONE self
-function AI_PATROL_ZONE:SetDetectionOff()
-  self:F2()
-
-  self.DetectOn = false
-end
-
---- Set the status checking off.
--- @param #AI_PATROL_ZONE self
--- @return #AI_PATROL_ZONE self
-function AI_PATROL_ZONE:SetStatusOff()
-  self:F2()
-  
-  self.CheckStatus = false
-end
-
---- Activate the detection. The AI will detect for targets if the Detection is switched On.
--- @param #AI_PATROL_ZONE self
--- @return #AI_PATROL_ZONE self
-function AI_PATROL_ZONE:SetDetectionActivated()
-  self:F2()
-  
-  self:ClearDetectedUnits()
-  self.DetectActivated = true
-  self:__Detect( -self.DetectInterval )
-end
-
---- Deactivate the detection. The AI will NOT detect for targets.
--- @param #AI_PATROL_ZONE self
--- @return #AI_PATROL_ZONE self
-function AI_PATROL_ZONE:SetDetectionDeactivated()
-  self:F2()
-  
-  self:ClearDetectedUnits()
-  self.DetectActivated = false
-end
-
---- Set the interval in seconds between each detection executed by the AI.
--- The list of already detected targets will be kept and updated.
--- Newly detected targets will be added, but already detected targets that were 
--- not detected in this cycle, will NOT be removed!
--- The default interval is 30 seconds.
--- @param #AI_PATROL_ZONE self
--- @param #number Seconds The interval in seconds.
--- @return #AI_PATROL_ZONE self
-function AI_PATROL_ZONE:SetRefreshTimeInterval( Seconds )
-  self:F2()
-
-  if Seconds then  
-    self.DetectInterval = Seconds
-  else
-    self.DetectInterval = 30
-  end
-end
-
---- Set the detection zone where the AI is detecting targets.
--- @param #AI_PATROL_ZONE self
--- @param Core.Zone#ZONE DetectionZone The zone where to detect targets.
--- @return #AI_PATROL_ZONE self
-function AI_PATROL_ZONE:SetDetectionZone( DetectionZone )
-  self:F2()
-
-  if DetectionZone then  
-    self.DetectZone = DetectionZone
-  else
-    self.DetectZone = nil
-  end
-end
-
---- Gets a list of @{Wrapper.Unit#UNIT}s that were detected by the AI.
--- No filtering is applied, so, ANY detected UNIT can be in this list.
--- It is up to the mission designer to use the @{Wrapper.Unit} class and methods to filter the targets.
--- @param #AI_PATROL_ZONE self
--- @return #table The list of @{Wrapper.Unit#UNIT}s
-function AI_PATROL_ZONE:GetDetectedUnits()
-  self:F2()
-
-  return self.DetectedUnits 
-end
-
---- Clears the list of @{Wrapper.Unit#UNIT}s that were detected by the AI.
--- @param #AI_PATROL_ZONE self
-function AI_PATROL_ZONE:ClearDetectedUnits()
-  self:F2()
-  self.DetectedUnits = {}
-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 threshold is calculated.
--- When the fuel threshold is reached, the AI will continue for a given time its patrol task in orbit, while a new AIControllable is targeted to the AI_PATROL_ZONE.
--- Once the time is finished, the old AI will return to the base.
--- @param #AI_PATROL_ZONE self
--- @param #number PatrolFuelThresholdPercentage The threshold 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_PATROL_ZONE self
-function AI_PATROL_ZONE:ManageFuel( PatrolFuelThresholdPercentage, PatrolOutOfFuelOrbitTime )
-
-  self.PatrolFuelThresholdPercentage = PatrolFuelThresholdPercentage
-  self.PatrolOutOfFuelOrbitTime = PatrolOutOfFuelOrbitTime
-
-  return self
-end
-
---- When the AI is damaged beyond a certain threshold, it is required that the AI returns to the home base.
--- However, damage cannot be foreseen early on. 
--- Therefore, when the damage threshold is reached, 
--- 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 threshold will be 0.25.
--- @param #AI_PATROL_ZONE self
--- @param #number PatrolDamageThreshold The threshold in percentage (between 0 and 1) when the AI is considered to be damaged.
--- @return #AI_PATROL_ZONE self
-function AI_PATROL_ZONE:ManageDamage( PatrolDamageThreshold )
-
-  self.PatrolManageDamage = true
-  self.PatrolDamageThreshold = PatrolDamageThreshold
-
-  return self
-end
-
---- Defines a new patrol route using the @{#AI_PATROL_ZONE} parameters and settings.
--- @param #AI_PATROL_ZONE 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.
--- @return #AI_PATROL_ZONE self
-function AI_PATROL_ZONE:onafterStart( Controllable, From, Event, To )
-  self:F2()
-
-  self:__Route( 1 ) -- Route to the patrol point. The asynchronous trigger is important, because a spawned group and units takes at least one second to come live.
-  self:__Status( 60 ) -- Check status status every 30 seconds.
-  self:SetDetectionActivated()
-
-  self:HandleEvent( EVENTS.PilotDead, self.OnPilotDead )
-  self:HandleEvent( EVENTS.Crash, self.OnCrash )
-  self:HandleEvent( EVENTS.Ejection, self.OnEjection )
-
-  Controllable:OptionROEHoldFire()
-  Controllable:OptionROTVertical()
-
-  self.Controllable:OnReSpawn(
-    function( PatrolGroup )
-      self:T( "ReSpawn" )
-      self:__Reset( 1 )
-      self:__Route( 5 )
-    end
-  )
-
-  self:SetDetectionOn()
-  
-end
-
-
--- @param #AI_PATROL_ZONE self
--- @param Wrapper.Controllable#CONTROLLABLE Controllable+
-function AI_PATROL_ZONE:onbeforeDetect( Controllable, From, Event, To )
-
-  return self.DetectOn and self.DetectActivated
-end
-
--- @param #AI_PATROL_ZONE self
--- @param Wrapper.Controllable#CONTROLLABLE Controllable
-function AI_PATROL_ZONE:onafterDetect( Controllable, From, Event, To )
-
-  local Detected = false
-
-  local DetectedTargets = Controllable:GetDetectedTargets()
-  for TargetID, Target in pairs( DetectedTargets or {} ) do
-    local TargetObject = Target.object
-
-    if TargetObject and TargetObject:isExist() and TargetObject.id_ < 50000000 then
-
-      local TargetUnit = UNIT:Find( TargetObject )
-
-      -- Check that target is alive due to issue https://github.com/FlightControl-Master/MOOSE/issues/1234
-      if TargetUnit and TargetUnit:IsAlive() then
-
-        local TargetUnitName = TargetUnit:GetName()
-
-        if self.DetectionZone then
-          if TargetUnit:IsInZone( self.DetectionZone ) then
-            self:T( {"Detected ", TargetUnit } )
-            if self.DetectedUnits[TargetUnit] == nil then
-              self.DetectedUnits[TargetUnit] = true
-            end
-            Detected = true 
-          end
-        else       
-          if self.DetectedUnits[TargetUnit] == nil then
-            self.DetectedUnits[TargetUnit] = true
-          end
-          Detected = true
-        end
-  
-      end
-    end
-  end
-
-  self:__Detect( -self.DetectInterval )
-
-  if Detected == true then
-    self:__Detected( 1.5 )
-  end
-  
-end
-
--- @param Wrapper.Controllable#CONTROLLABLE AIControllable
--- This static method is called from the route path within the last task at the last waypoint of the Controllable.
--- Note that this method is required, as triggers the next route when patrolling for the Controllable.
-function AI_PATROL_ZONE:_NewPatrolRoute( AIControllable )
-
-  local PatrolZone = AIControllable:GetState( AIControllable, "PatrolZone" ) -- PatrolCore.Zone#AI_PATROL_ZONE
-  PatrolZone:__Route( 1 )
-end
-
-
---- Defines a new patrol route using the @{#AI_PATROL_ZONE} parameters and settings.
--- @param #AI_PATROL_ZONE 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_PATROL_ZONE:onafterRoute( Controllable, From, Event, To )
-
-  self:F2()
-
-  -- When RTB, don't allow anymore the routing.
-  if From == "RTB" then
-    return
-  end
-
-  local life = self.Controllable:GetLife() or 0
-  if self.Controllable:IsAlive() and life > 1 then
-    -- Determine if the AIControllable is within the PatrolZone. 
-    -- If not, make a waypoint within the to that the AIControllable will fly at maximum speed to that point.
-
-    local PatrolRoute = {}
-
-    -- Calculate the current route point of the controllable as the start point of the route.
-    -- However, when the controllable is not in the air,
-    -- the controllable current waypoint is probably the airbase...
-    -- Thus, if we would take the current waypoint as the startpoint, upon take-off, the controllable flies
-    -- immediately back to the airbase, and this is not correct.
-    -- Therefore, when on a runway, get as the current route point a random point within the PatrolZone.
-    -- This will make the plane fly immediately to the patrol zone.
-    
-    if self.Controllable:InAir() == false then
-      self:T( "Not in the air, finding route path within PatrolZone" )
-      local CurrentVec2 = self.Controllable:GetVec2()
-      if not CurrentVec2 then return end
-      --Done: Create GetAltitude function for GROUP, and delete GetUnit(1).
-      local CurrentAltitude = self.Controllable:GetAltitude()
-      local CurrentPointVec3 = COORDINATE:New( CurrentVec2.x, CurrentAltitude, CurrentVec2.y )
-      local ToPatrolZoneSpeed = self.PatrolMaxSpeed
-      local CurrentRoutePoint = CurrentPointVec3:WaypointAir( 
-          self.PatrolAltType, 
-          COORDINATE.WaypointType.TakeOffParking, 
-          COORDINATE.WaypointAction.FromParkingArea, 
-          ToPatrolZoneSpeed, 
-          true 
-        )
-      PatrolRoute[#PatrolRoute+1] = CurrentRoutePoint
-    else
-      self:T( "In the air, finding route path within PatrolZone" )
-      local CurrentVec2 = self.Controllable:GetVec2()
-      if not CurrentVec2 then return end
-      --DONE: Create GetAltitude function for GROUP, and delete GetUnit(1).
-      local CurrentAltitude = self.Controllable:GetAltitude()
-      local CurrentPointVec3 = COORDINATE:New( CurrentVec2.x, CurrentAltitude, CurrentVec2.y )
-      local ToPatrolZoneSpeed = self.PatrolMaxSpeed
-      local CurrentRoutePoint = CurrentPointVec3:WaypointAir( 
-          self.PatrolAltType, 
-          COORDINATE.WaypointType.TurningPoint, 
-          COORDINATE.WaypointAction.TurningPoint, 
-          ToPatrolZoneSpeed, 
-          true 
-        )
-      PatrolRoute[#PatrolRoute+1] = CurrentRoutePoint
-    end    
-    
-    
-    --- Define a random point in the @{Core.Zone}. The AI will fly to that point within the zone.
-    
-      --- Find a random 2D point in PatrolZone.
-    local ToTargetVec2 = self.PatrolZone:GetRandomVec2()
-    self:T2( ToTargetVec2 )
-
-    --- Define Speed and Altitude.
-    local ToTargetAltitude = math.random( self.PatrolFloorAltitude, self.PatrolCeilingAltitude )
-    local ToTargetSpeed = math.random( self.PatrolMinSpeed, self.PatrolMaxSpeed )
-    self:T2( { self.PatrolMinSpeed, self.PatrolMaxSpeed, ToTargetSpeed } )
-    
-    --- Obtain a 3D @{Point} from the 2D point + altitude.
-    local ToTargetPointVec3 = COORDINATE:New( ToTargetVec2.x, ToTargetAltitude, ToTargetVec2.y )
-    
-    --- Create a route point of type air.
-    local ToTargetRoutePoint = ToTargetPointVec3:WaypointAir( 
-      self.PatrolAltType, 
-      COORDINATE.WaypointType.TurningPoint, 
-      COORDINATE.WaypointAction.TurningPoint, 
-      ToTargetSpeed, 
-      true 
-    )
-    
-    --self.CoordTest:SpawnFromVec3( ToTargetPointVec3:GetVec3() )
-    
-    --ToTargetPointVec3:SmokeRed()
-
-    PatrolRoute[#PatrolRoute+1] = ToTargetRoutePoint
-    
-    --- Now we're going to do something special, we're going to call a function from a waypoint action at the AIControllable...
-    self.Controllable:WayPointInitialize( PatrolRoute )
-    
-    --- Do a trick, link the NewPatrolRoute function of the PATROLGROUP object to the AIControllable in a temporary variable ...
-    self.Controllable:SetState( self.Controllable, "PatrolZone", self )
-    self.Controllable:WayPointFunction( #PatrolRoute, 1, "AI_PATROL_ZONE:_NewPatrolRoute" )
-
-    --- NOW ROUTE THE GROUP!
-    self.Controllable:WayPointExecute( 1, 2 )
-  end
-
-end
-
--- @param #AI_PATROL_ZONE self
-function AI_PATROL_ZONE:onbeforeStatus()
-
-  return self.CheckStatus
-end
-
--- @param #AI_PATROL_ZONE self
-function AI_PATROL_ZONE:onafterStatus()
-  self:F2()
-
-  if self.Controllable and self.Controllable:IsAlive() then
-  
-    local RTB = false
-    
-    local Fuel = self.Controllable:GetFuelMin()
-    if Fuel < self.PatrolFuelThresholdPercentage then
-      self:T( 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 ) )
-      OldAIControllable:SetTask( TimedOrbitTask, 10 )
-
-      RTB = true
-    end
-    
-    -- TODO: Check GROUP damage function.
-    local Damage = self.Controllable:GetLife()
-    if Damage <= self.PatrolDamageThreshold then
-      self:T( self.Controllable:GetName() .. " is damaged:" .. Damage .. ", RTB!" )
-      RTB = true
-    end
-    
-    if self:IsInstanceOf("AI_CAS") or self:IsInstanceOf("AI_BAI") then
-      local atotal,shells,rockets,bombs,missiles = self.Controllable:GetAmmunition()
-      local arelevant = rockets+bombs   
-      if arelevant == 0 or missiles == 0 then 
-        RTB = true
-        self:T({total=atotal,shells=shells,rockets=rockets,bombs=bombs,missiles=missiles})
-        self:T( self.Controllable:GetName() .. " is out of ammo, RTB!" ) 
-      end
-    end
-    
-    if RTB == true then
-      self:RTB()
-    else
-      self:__Status( 60 ) -- Execute the Patrol event after 30 seconds.
-    end
-  end
-end
-
--- @param #AI_PATROL_ZONE self
-function AI_PATROL_ZONE:onafterRTB()
-  self:F2()
-
-  if self.Controllable and self.Controllable:IsAlive() then
-
-    self:SetDetectionOff()
-    self.CheckStatus = false
-    
-    local PatrolRoute = {}
-  
-    --- Calculate the current route point.
-    local CurrentVec2 = self.Controllable:GetVec2()
-    if not CurrentVec2 then return end
-    --DONE: Create GetAltitude function for GROUP, and delete GetUnit(1).
-    --local CurrentAltitude = self.Controllable:GetUnit(1):GetAltitude()
-    local CurrentAltitude = self.Controllable:GetAltitude()
-    local CurrentPointVec3 = COORDINATE:New( CurrentVec2.x, CurrentAltitude, CurrentVec2.y )
-    local ToPatrolZoneSpeed = self.PatrolMaxSpeed
-    local CurrentRoutePoint = CurrentPointVec3:WaypointAir( 
-        self.PatrolAltType, 
-        COORDINATE.WaypointType.TurningPoint, 
-        COORDINATE.WaypointAction.TurningPoint, 
-        ToPatrolZoneSpeed, 
-        true 
-      )
-    
-    PatrolRoute[#PatrolRoute+1] = CurrentRoutePoint
-    
-    --- Now we're going to do something special, we're going to call a function from a waypoint action at the AIControllable...
-    self.Controllable:WayPointInitialize( PatrolRoute )
-  
-    --- NOW ROUTE THE GROUP!
-    self.Controllable:WayPointExecute( 1, 1 )
-    
-  end
-    
-end
-
--- @param #AI_PATROL_ZONE self
-function AI_PATROL_ZONE:onafterDead()
-  self:SetDetectionOff()
-  self:SetStatusOff()
-end
-
--- @param #AI_PATROL_ZONE self
--- @param Core.Event#EVENTDATA EventData
-function AI_PATROL_ZONE:OnCrash( EventData )
-
-  if self.Controllable:IsAlive() and EventData.IniDCSGroupName == self.Controllable:GetName() then
-    if #self.Controllable:GetUnits() == 1 then
-      self:__Crash( 1, EventData )
-    end
-  end
-end
-
--- @param #AI_PATROL_ZONE self
--- @param Core.Event#EVENTDATA EventData
-function AI_PATROL_ZONE:OnEjection( EventData )
-
-  if self.Controllable:IsAlive() and EventData.IniDCSGroupName == self.Controllable:GetName() then
-    self:__Eject( 1, EventData )
-  end
-end
-
--- @param #AI_PATROL_ZONE self
--- @param Core.Event#EVENTDATA EventData
-function AI_PATROL_ZONE:OnPilotDead( EventData )
-
-  if self.Controllable:IsAlive() and EventData.IniDCSGroupName == self.Controllable:GetName() then
-    self:__PilotDead( 1, EventData )
-  end
-end

Moose Development/Moose/Actions/Act_Account.lua

@@ -1,310 +0,0 @@
---- **Actions** - ACT_ACCOUNT_ classes **account for** (detect, count & report) various DCS events occurring on UNITs.
---
--- ![Banner Image](..\Presentations\ACT_ACCOUNT\Dia1.JPG)
---
--- ===
---
--- @module Actions.Act_Account
--- @image MOOSE.JPG
-
-do -- ACT_ACCOUNT
-
-  --- # @{#ACT_ACCOUNT} FSM class, extends @{Core.Fsm#FSM_PROCESS}
-  --
-  -- ## ACT_ACCOUNT state machine:
-  --
-  -- This class is a state machine: it manages a process that is triggered by events causing state transitions to occur.
-  -- All derived classes from this class will start with the class name, followed by a \_. See the relevant derived class descriptions below.
-  -- Each derived class follows exactly the same process, using the same events and following the same state transitions,
-  -- but will have **different implementation behaviour** upon each event or state transition.
-  --
-  -- ### ACT_ACCOUNT States
-  --
-  --   * **Assigned**: The player is assigned.
-  --   * **Waiting**: Waiting for an event.
-  --   * **Report**: Reporting.
-  --   * **Account**: Account for an event.
-  --   * **Accounted**: All events have been accounted for, end of the process.
-  --   * **Failed**: Failed the process.
-  --
-  -- ### ACT_ACCOUNT Events
-  --
-  --   * **Start**: Start the process.
-  --   * **Wait**: Wait for an event.
-  --   * **Report**: Report the status of the accounting.
-  --   * **Event**: An event happened, process the event.
-  --   * **More**: More targets.
-  --   * **NoMore (*)**: No more targets.
-  --   * **Fail (*)**: The action process has failed.
-  --
-  -- (*) End states of the process.
-  --
-  -- ### ACT_ACCOUNT state transition methods:
-  --
-  -- State transition functions can be set **by the mission designer** customizing or improving the behaviour of the state.
-  -- There are 2 moments when state transition methods will be called by the state machine:
-  --
-  --   * **Before** the state transition.
-  --     The state transition method needs to start with the name **OnBefore + the name of the state**.
-  --     If the state transition method returns false, then the processing of the state transition will not be done!
-  --     If you want to change the behaviour of the AIControllable at this event, return false,
-  --     but then you'll need to specify your own logic using the AIControllable!
-  --
-  --   * **After** the state transition.
-  --     The state transition method needs to start with the name **OnAfter + the name of the state**.
-  --     These state transition methods need to provide a return value, which is specified at the function description.
-  --
-  -- # Developer Note
-  -- 
-  -- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
-  -- Therefore, this class is considered to be deprecated
-  --
-  -- @type ACT_ACCOUNT
-  -- @field Core.Set#SET_UNIT TargetSetUnit
-  -- @extends Core.Fsm#FSM_PROCESS
-  ACT_ACCOUNT = {
-    ClassName = "ACT_ACCOUNT",
-    TargetSetUnit = nil,
-  }
-
-  --- Creates a new DESTROY process.
-  -- @param #ACT_ACCOUNT self
-  -- @return #ACT_ACCOUNT
-  function ACT_ACCOUNT:New()
-
-    -- Inherits from BASE
-    local self = BASE:Inherit( self, FSM_PROCESS:New() ) -- Core.Fsm#FSM_PROCESS
-
-    self:AddTransition( "Assigned", "Start", "Waiting" )
-    self:AddTransition( "*", "Wait", "Waiting" )
-    self:AddTransition( "*", "Report", "Report" )
-    self:AddTransition( "*", "Event", "Account" )
-    self:AddTransition( "Account", "Player", "AccountForPlayer" )
-    self:AddTransition( "Account", "Other", "AccountForOther" )
-    self:AddTransition( { "Account", "AccountForPlayer", "AccountForOther" }, "More", "Wait" )
-    self:AddTransition( { "Account", "AccountForPlayer", "AccountForOther" }, "NoMore", "Accounted" )
-    self:AddTransition( "*", "Fail", "Failed" )
-
-    self:AddEndState( "Failed" )
-
-    self:SetStartState( "Assigned" )
-
-    return self
-  end
-
-  --- Process Events
-
-  --- StateMachine callback function
-  -- @param #ACT_ACCOUNT self
-  -- @param Wrapper.Unit#UNIT ProcessUnit
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  function ACT_ACCOUNT:onafterStart( ProcessUnit, From, Event, To )
-
-    self:HandleEvent( EVENTS.Dead, self.onfuncEventDead )
-    self:HandleEvent( EVENTS.Crash, self.onfuncEventCrash )
-    self:HandleEvent( EVENTS.Hit )
-
-    self:__Wait( 1 )
-  end
-
-    --- StateMachine callback function
-    -- @param #ACT_ACCOUNT self
-    -- @param Wrapper.Unit#UNIT ProcessUnit
-    -- @param #string Event
-    -- @param #string From
-    -- @param #string To
-  function ACT_ACCOUNT:onenterWaiting( ProcessUnit, From, Event, To )
-
-    if self.DisplayCount >= self.DisplayInterval then
-      self:Report()
-      self.DisplayCount = 1
-    else
-      self.DisplayCount = self.DisplayCount + 1
-    end
-
-    return true -- Process always the event.
-  end
-
-  --- StateMachine callback function
-  -- @param #ACT_ACCOUNT self
-  -- @param Wrapper.Unit#UNIT ProcessUnit
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  function ACT_ACCOUNT:onafterEvent( ProcessUnit, From, Event, To, Event )
-
-    self:__NoMore( 1 )
-  end
-
-end -- ACT_ACCOUNT
-
-do -- ACT_ACCOUNT_DEADS
-
-  --- # @{#ACT_ACCOUNT_DEADS} FSM class, extends @{#ACT_ACCOUNT}
-  --
-  -- The ACT_ACCOUNT_DEADS class accounts (detects, counts and reports) successful kills of DCS units.
-  -- The process is given a @{Core.Set} of units that will be tracked upon successful destruction.
-  -- The process will end after each target has been successfully destroyed.
-  -- Each successful dead will trigger an Account state transition that can be scored, modified or administered.
-  --
-  --
-  -- ## ACT_ACCOUNT_DEADS constructor:
-  --
-  --   * @{#ACT_ACCOUNT_DEADS.New}(): Creates a new ACT_ACCOUNT_DEADS object.
-  --
-  -- @type ACT_ACCOUNT_DEADS
-  -- @field Core.Set#SET_UNIT TargetSetUnit
-  -- @extends #ACT_ACCOUNT
-  ACT_ACCOUNT_DEADS = {
-    ClassName = "ACT_ACCOUNT_DEADS",
-  }
-
-  --- Creates a new DESTROY process.
-  -- @param #ACT_ACCOUNT_DEADS self
-  -- @param Core.Set#SET_UNIT TargetSetUnit
-  -- @param #string TaskName
-  function ACT_ACCOUNT_DEADS:New()
-    -- Inherits from BASE
-    local self = BASE:Inherit( self, ACT_ACCOUNT:New() ) -- #ACT_ACCOUNT_DEADS
-
-    self.DisplayInterval = 30
-    self.DisplayCount = 30
-    self.DisplayMessage = true
-    self.DisplayTime = 10 -- 10 seconds is the default
-    self.DisplayCategory = "HQ" -- Targets is the default display category
-
-    return self
-  end
-
-  function ACT_ACCOUNT_DEADS:Init( FsmAccount )
-
-    self.Task = self:GetTask()
-    self.TaskName = self.Task:GetName()
-  end
-
-  --- Process Events
-
-  --- StateMachine callback function
-  -- @param #ACT_ACCOUNT_DEADS self
-  -- @param Wrapper.Unit#UNIT ProcessUnit
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  function ACT_ACCOUNT_DEADS:onenterReport( ProcessUnit, Task, From, Event, To )
-
-    local MessageText = "Your group with assigned " .. self.TaskName .. " task has " .. Task.TargetSetUnit:GetUnitTypesText() .. " targets left to be destroyed."
-    self:GetCommandCenter():MessageTypeToGroup( MessageText, ProcessUnit:GetGroup(), MESSAGE.Type.Information )
-  end
-
-  --- StateMachine callback function
-  -- @param #ACT_ACCOUNT_DEADS self
-  -- @param Wrapper.Unit#UNIT ProcessUnit
-  -- @param Tasking.Task#TASK Task
-  -- @param #string From
-  -- @param #string Event
-  -- @param #string To
-  -- @param Core.Event#EVENTDATA EventData
-  function ACT_ACCOUNT_DEADS:onafterEvent( ProcessUnit, Task, From, Event, To, EventData  )
-    self:T( { ProcessUnit:GetName(), Task:GetName(), From, Event, To, EventData } )
-
-    if Task.TargetSetUnit:FindUnit( EventData.IniUnitName ) then
-      local PlayerName = ProcessUnit:GetPlayerName()
-      local PlayerHit = self.PlayerHits and self.PlayerHits[EventData.IniUnitName]
-      if PlayerHit == PlayerName then
-        self:Player( EventData )
-      else
-        self:Other( EventData )
-      end
-    end
-  end
-
-  --- StateMachine callback function
-  -- @param #ACT_ACCOUNT_DEADS self
-  -- @param Wrapper.Unit#UNIT ProcessUnit
-  -- @param Tasking.Task#TASK Task
-  -- @param #string From
-  -- @param #string Event
-  -- @param #string To
-  -- @param Core.Event#EVENTDATA EventData
-  function ACT_ACCOUNT_DEADS:onenterAccountForPlayer( ProcessUnit, Task, From, Event, To, EventData  )
-    self:T( { ProcessUnit:GetName(), Task:GetName(), From, Event, To, EventData } )
-
-    local TaskGroup = ProcessUnit:GetGroup()
-
-    Task.TargetSetUnit:Remove( EventData.IniUnitName )
-
-    local MessageText = "You have destroyed a target.\nYour group assigned with task " .. self.TaskName .. " has\n" .. Task.TargetSetUnit:Count() .. " targets ( " .. Task.TargetSetUnit:GetUnitTypesText() .. " ) left to be destroyed."
-    self:GetCommandCenter():MessageTypeToGroup( MessageText, ProcessUnit:GetGroup(), MESSAGE.Type.Information )
-
-    local PlayerName = ProcessUnit:GetPlayerName()
-    Task:AddProgress( PlayerName, "Destroyed " .. EventData.IniTypeName, timer.getTime(), 1 )
-
-    if Task.TargetSetUnit:Count() > 0 then
-      self:__More( 1 )
-    else
-      self:__NoMore( 1 )
-    end
-  end
-
-  --- StateMachine callback function
-  -- @param #ACT_ACCOUNT_DEADS self
-  -- @param Wrapper.Unit#UNIT ProcessUnit
-  -- @param Tasking.Task#TASK Task
-  -- @param #string From
-  -- @param #string Event
-  -- @param #string To
-  -- @param Core.Event#EVENTDATA EventData
-  function ACT_ACCOUNT_DEADS:onenterAccountForOther( ProcessUnit, Task, From, Event, To, EventData  )
-    self:T( { ProcessUnit:GetName(), Task:GetName(), From, Event, To, EventData } )
-
-    local TaskGroup = ProcessUnit:GetGroup()
-    Task.TargetSetUnit:Remove( EventData.IniUnitName )
-
-    local MessageText = "One of the task targets has been destroyed.\nYour group assigned with task " .. self.TaskName .. " has\n" .. Task.TargetSetUnit:Count() .. " targets ( " .. Task.TargetSetUnit:GetUnitTypesText() .. " ) left to be destroyed."
-    self:GetCommandCenter():MessageTypeToGroup( MessageText, ProcessUnit:GetGroup(), MESSAGE.Type.Information )
-
-    if Task.TargetSetUnit:Count() > 0 then
-      self:__More( 1 )
-    else
-      self:__NoMore( 1 )
-    end
-  end
-
-  --- DCS Events
-
-  -- @param #ACT_ACCOUNT_DEADS self
-  -- @param Core.Event#EVENTDATA EventData
-  function ACT_ACCOUNT_DEADS:OnEventHit( EventData )
-    self:T( { "EventDead", EventData } )
-
-    if EventData.IniPlayerName and EventData.TgtDCSUnitName then
-      self.PlayerHits = self.PlayerHits or {}
-      self.PlayerHits[EventData.TgtDCSUnitName] = EventData.IniPlayerName
-    end
-  end
-
-  -- @param #ACT_ACCOUNT_DEADS self
-  -- @param Core.Event#EVENTDATA EventData
-  function ACT_ACCOUNT_DEADS:onfuncEventDead( EventData )
-    self:T( { "EventDead", EventData } )
-
-    if EventData.IniDCSUnit then
-      self:Event( EventData )
-    end
-  end
-
-  --- DCS Events
-
-  -- @param #ACT_ACCOUNT_DEADS self
-  -- @param Core.Event#EVENTDATA EventData
-  function ACT_ACCOUNT_DEADS:onfuncEventCrash( EventData )
-    self:T( { "EventDead", EventData } )
-
-    if EventData.IniDCSUnit then
-      self:Event( EventData )
-    end
-  end
-
-end -- ACT_ACCOUNT DEADS

Moose Development/Moose/Actions/Act_Assign.lua

@@ -1,292 +0,0 @@
---- (SP) (MP) (FSM) Accept or reject process for player (task) assignments.
---
--- ===
---
--- # @{#ACT_ASSIGN} FSM template class, extends @{Core.Fsm#FSM_PROCESS}
---
--- ## ACT_ASSIGN state machine:
---
--- This class is a state machine: it manages a process that is triggered by events causing state transitions to occur.
--- All derived classes from this class will start with the class name, followed by a \_. See the relevant derived class descriptions below.
--- Each derived class follows exactly the same process, using the same events and following the same state transitions,
--- but will have **different implementation behaviour** upon each event or state transition.
---
--- ### ACT_ASSIGN **Events**:
---
--- These are the events defined in this class:
---
---   * **Start**:  Start the tasking acceptance process.
---   * **Assign**:  Assign the task.
---   * **Reject**:  Reject the task..
---
--- ### ACT_ASSIGN **Event methods**:
---
--- Event methods are available (dynamically allocated by the state machine), that accomodate for state transitions occurring in the process.
--- There are two types of event methods, which you can use to influence the normal mechanisms in the state machine:
---
---   * **Immediate**: The event method has exactly the name of the event.
---   * **Delayed**: The event method starts with a __ + the name of the event. The first parameter of the event method is a number value, expressing the delay in seconds when the event will be executed.
---
--- ### ACT_ASSIGN **States**:
---
---   * **UnAssigned**: The player has not accepted the task.
---   * **Assigned (*)**: The player has accepted the task.
---   * **Rejected (*)**: The player has not accepted the task.
---   * **Waiting**: The process is awaiting player feedback.
---   * **Failed (*)**: The process has failed.
---
--- (*) End states of the process.
---
--- ### ACT_ASSIGN state transition methods:
---
--- State transition functions can be set **by the mission designer** customizing or improving the behaviour of the state.
--- There are 2 moments when state transition methods will be called by the state machine:
---
---   * **Before** the state transition.
---     The state transition method needs to start with the name **OnBefore + the name of the state**.
---     If the state transition method returns false, then the processing of the state transition will not be done!
---     If you want to change the behaviour of the AIControllable at this event, return false,
---     but then you'll need to specify your own logic using the AIControllable!
---
---   * **After** the state transition.
---     The state transition method needs to start with the name **OnAfter + the name of the state**.
---     These state transition methods need to provide a return value, which is specified at the function description.
---
--- # Developer Note
--- 
--- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
--- Therefore, this class is considered to be deprecated
---
--- ===
---
--- # 1) @{#ACT_ASSIGN_ACCEPT} class, extends @{Core.Fsm#ACT_ASSIGN}
---
--- The ACT_ASSIGN_ACCEPT class accepts by default a task for a player. No player intervention is allowed to reject the task.
---
--- ## 1.1) ACT_ASSIGN_ACCEPT constructor:
---
---   * @{#ACT_ASSIGN_ACCEPT.New}(): Creates a new ACT_ASSIGN_ACCEPT object.
---
--- ===
---
--- # 2) @{#ACT_ASSIGN_MENU_ACCEPT} class, extends @{Core.Fsm#ACT_ASSIGN}
---
--- The ACT_ASSIGN_MENU_ACCEPT class accepts a task when the player accepts the task through an added menu option.
--- This assignment type is useful to conditionally allow the player to choose whether or not he would accept the task.
--- The assignment type also allows to reject the task.
---
--- ## 2.1) ACT_ASSIGN_MENU_ACCEPT constructor:
--- -----------------------------------------
---
---   * @{#ACT_ASSIGN_MENU_ACCEPT.New}(): Creates a new ACT_ASSIGN_MENU_ACCEPT object.
---
--- ===
---
--- @module Actions.Act_Assign
--- @image MOOSE.JPG
-
-
-do -- ACT_ASSIGN
-
-  --- ACT_ASSIGN class
-  -- @type ACT_ASSIGN
-  -- @field Tasking.Task#TASK Task
-  -- @field Wrapper.Unit#UNIT ProcessUnit
-  -- @field Core.Zone#ZONE_BASE TargetZone
-  -- @extends Core.Fsm#FSM_PROCESS
-  ACT_ASSIGN = {
-    ClassName = "ACT_ASSIGN",
-  }
-
-
-  --- Creates a new task assignment state machine. The process will accept the task by default, no player intervention accepted.
-  -- @param #ACT_ASSIGN self
-  -- @return #ACT_ASSIGN The task acceptance process.
-  function ACT_ASSIGN:New()
-
-    -- Inherits from BASE
-    local self = BASE:Inherit( self, FSM_PROCESS:New( "ACT_ASSIGN" ) ) -- Core.Fsm#FSM_PROCESS
-
-    self:AddTransition( "UnAssigned", "Start", "Waiting" )
-    self:AddTransition( "Waiting",  "Assign", "Assigned" )
-    self:AddTransition( "Waiting", "Reject", "Rejected" )
-    self:AddTransition( "*", "Fail", "Failed" )
-
-    self:AddEndState( "Assigned" )
-    self:AddEndState( "Rejected" )
-    self:AddEndState( "Failed" )
-
-    self:SetStartState( "UnAssigned" )
-
-    return self
-  end
-
-end -- ACT_ASSIGN
-
-
-
-do -- ACT_ASSIGN_ACCEPT
-
-  --- ACT_ASSIGN_ACCEPT class
-  -- @type ACT_ASSIGN_ACCEPT
-  -- @field Tasking.Task#TASK Task
-  -- @field Wrapper.Unit#UNIT ProcessUnit
-  -- @field Core.Zone#ZONE_BASE TargetZone
-  -- @extends #ACT_ASSIGN
-  ACT_ASSIGN_ACCEPT = {
-    ClassName = "ACT_ASSIGN_ACCEPT",
-  }
-
-
-  --- Creates a new task assignment state machine. The process will accept the task by default, no player intervention accepted.
-  -- @param #ACT_ASSIGN_ACCEPT self
-  -- @param #string TaskBriefing
-  function ACT_ASSIGN_ACCEPT:New( TaskBriefing )
-
-    local self = BASE:Inherit( self, ACT_ASSIGN:New() ) -- #ACT_ASSIGN_ACCEPT
-
-    self.TaskBriefing = TaskBriefing
-
-    return self
-  end
-
-  function ACT_ASSIGN_ACCEPT:Init( FsmAssign )
-
-    self.TaskBriefing = FsmAssign.TaskBriefing
-  end
-
-  --- StateMachine callback function
-  -- @param #ACT_ASSIGN_ACCEPT self
-  -- @param Wrapper.Unit#UNIT ProcessUnit
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  function ACT_ASSIGN_ACCEPT:onafterStart( ProcessUnit, Task, From, Event, To )
-
-    self:__Assign( 1 )
-  end
-
-  --- StateMachine callback function
-  -- @param #ACT_ASSIGN_ACCEPT self
-  -- @param Wrapper.Unit#UNIT ProcessUnit
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  function ACT_ASSIGN_ACCEPT:onenterAssigned( ProcessUnit, Task, From, Event, To, TaskGroup )
-
-    self.Task:Assign( ProcessUnit, ProcessUnit:GetPlayerName() )
-  end
-
-end -- ACT_ASSIGN_ACCEPT
-
-
-do -- ACT_ASSIGN_MENU_ACCEPT
-
-  --- ACT_ASSIGN_MENU_ACCEPT class
-  -- @type ACT_ASSIGN_MENU_ACCEPT
-  -- @field Tasking.Task#TASK Task
-  -- @field Wrapper.Unit#UNIT ProcessUnit
-  -- @field Core.Zone#ZONE_BASE TargetZone
-  -- @extends #ACT_ASSIGN
-  ACT_ASSIGN_MENU_ACCEPT = {
-    ClassName = "ACT_ASSIGN_MENU_ACCEPT",
-  }
-
-  --- Init.
-  -- @param #ACT_ASSIGN_MENU_ACCEPT self
-  -- @param #string TaskBriefing
-  -- @return #ACT_ASSIGN_MENU_ACCEPT self
-  function ACT_ASSIGN_MENU_ACCEPT:New( TaskBriefing )
-
-    -- Inherits from BASE
-    local self = BASE:Inherit( self, ACT_ASSIGN:New() ) -- #ACT_ASSIGN_MENU_ACCEPT
-
-    self.TaskBriefing = TaskBriefing
-
-    return self
-  end
-
-
-  --- Creates a new task assignment state machine. The process will request from the menu if it accepts the task, if not, the unit is removed from the simulator.
-  -- @param #ACT_ASSIGN_MENU_ACCEPT self
-  -- @param #string TaskBriefing
-  -- @return #ACT_ASSIGN_MENU_ACCEPT self
-  function ACT_ASSIGN_MENU_ACCEPT:Init( TaskBriefing )
-
-    self.TaskBriefing = TaskBriefing
-
-    return self
-  end
-
-  --- StateMachine callback function
-  -- @param #ACT_ASSIGN_MENU_ACCEPT self
-  -- @param Wrapper.Unit#UNIT ProcessUnit
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  function ACT_ASSIGN_MENU_ACCEPT:onafterStart( ProcessUnit, Task, From, Event, To )
-
-    self:GetCommandCenter():MessageToGroup( "Task " .. self.Task:GetName() .. " has been assigned to you and your group!\nRead the briefing and use the Radio Menu (F10) / Task ... CONFIRMATION menu to accept or reject the task.\nYou have 2 minutes to accept, or the task assignment will be cancelled!", ProcessUnit:GetGroup(), 120 )
-
-    local TaskGroup = ProcessUnit:GetGroup()
-
-    self.Menu = MENU_GROUP:New( TaskGroup, "Task " .. self.Task:GetName() .. " CONFIRMATION" )
-    self.MenuAcceptTask = MENU_GROUP_COMMAND:New( TaskGroup, "Accept task " .. self.Task:GetName(), self.Menu, self.MenuAssign, self, TaskGroup )
-    self.MenuRejectTask = MENU_GROUP_COMMAND:New( TaskGroup, "Reject task " .. self.Task:GetName(), self.Menu, self.MenuReject, self, TaskGroup )
-
-    self:__Reject( 120, TaskGroup )
-  end
-
-  --- Menu function.
-  -- @param #ACT_ASSIGN_MENU_ACCEPT self
-  function ACT_ASSIGN_MENU_ACCEPT:MenuAssign( TaskGroup )
-
-    self:__Assign( -1, TaskGroup )
-  end
-
-  --- Menu function.
-  -- @param #ACT_ASSIGN_MENU_ACCEPT self
-  function ACT_ASSIGN_MENU_ACCEPT:MenuReject( TaskGroup )
-
-    self:__Reject( -1, TaskGroup )
-  end
-
-  --- StateMachine callback function
-  -- @param #ACT_ASSIGN_MENU_ACCEPT self
-  -- @param Wrapper.Unit#UNIT ProcessUnit
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  function ACT_ASSIGN_MENU_ACCEPT:onafterAssign( ProcessUnit, Task, From, Event, To, TaskGroup  )
-
-    self.Menu:Remove()
-  end
-
-  --- StateMachine callback function
-  -- @param #ACT_ASSIGN_MENU_ACCEPT self
-  -- @param Wrapper.Unit#UNIT ProcessUnit
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  function ACT_ASSIGN_MENU_ACCEPT:onafterReject( ProcessUnit, Task, From, Event, To, TaskGroup )
-    self:F( { TaskGroup = TaskGroup } )
-
-    self.Menu:Remove()
-    --TODO: need to resolve this problem ... it has to do with the events ...
-    --self.Task:UnAssignFromUnit( ProcessUnit )needs to become a callback funtion call upon the event
-    self.Task:RejectGroup( TaskGroup )
-  end
-
-  --- StateMachine callback function
-  -- @param #ACT_ASSIGN_ACCEPT self
-  -- @param Wrapper.Unit#UNIT ProcessUnit
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  function ACT_ASSIGN_MENU_ACCEPT:onenterAssigned( ProcessUnit, Task, From, Event, To, TaskGroup )
-
-    --self.Task:AssignToGroup( TaskGroup )
-    self.Task:Assign( ProcessUnit, ProcessUnit:GetPlayerName() )
-  end
-
-end -- ACT_ASSIGN_MENU_ACCEPT

Moose Development/Moose/Actions/Act_Assist.lua

@@ -1,219 +0,0 @@
---- (SP) (MP) (FSM) Route AI or players through waypoints or to zones.
---
--- ## ACT_ASSIST state machine:
---
--- This class is a state machine: it manages a process that is triggered by events causing state transitions to occur.
--- All derived classes from this class will start with the class name, followed by a \_. See the relevant derived class descriptions below.
--- Each derived class follows exactly the same process, using the same events and following the same state transitions,
--- but will have **different implementation behaviour** upon each event or state transition.
---
--- ### ACT_ASSIST **Events**:
---
--- These are the events defined in this class:
---
---   * **Start**:  The process is started.
---   * **Next**: The process is smoking the targets in the given zone.
---
--- ### ACT_ASSIST **Event methods**:
---
--- Event methods are available (dynamically allocated by the state machine), that accomodate for state transitions occurring in the process.
--- There are two types of event methods, which you can use to influence the normal mechanisms in the state machine:
---
---   * **Immediate**: The event method has exactly the name of the event.
---   * **Delayed**: The event method starts with a __ + the name of the event. The first parameter of the event method is a number value, expressing the delay in seconds when the event will be executed.
---
--- ### ACT_ASSIST **States**:
---
---   * **None**: The controllable did not receive route commands.
---   * **AwaitSmoke (*)**: The process is awaiting to smoke the targets in the zone.
---   * **Smoking (*)**: The process is smoking the targets in the zone.
---   * **Failed (*)**: The process has failed.
---
--- (*) End states of the process.
---
--- ### ACT_ASSIST state transition methods:
---
--- State transition functions can be set **by the mission designer** customizing or improving the behaviour of the state.
--- There are 2 moments when state transition methods will be called by the state machine:
---
---   * **Before** the state transition.
---     The state transition method needs to start with the name **OnBefore + the name of the state**.
---     If the state transition method returns false, then the processing of the state transition will not be done!
---     If you want to change the behaviour of the AIControllable at this event, return false,
---     but then you'll need to specify your own logic using the AIControllable!
---
---   * **After** the state transition.
---     The state transition method needs to start with the name **OnAfter + the name of the state**.
---     These state transition methods need to provide a return value, which is specified at the function description.
---
--- ===
---
--- # 1) @{#ACT_ASSIST_SMOKE_TARGETS_ZONE} class, extends @{#ACT_ASSIST}
---
--- The ACT_ASSIST_SMOKE_TARGETS_ZONE class implements the core functions to smoke targets in a @{Core.Zone}.
--- The targets are smoked within a certain range around each target, simulating a realistic smoking behaviour.
--- At random intervals, a new target is smoked.
---
--- # 1.1) ACT_ASSIST_SMOKE_TARGETS_ZONE constructor:
---
---   * @{#ACT_ASSIST_SMOKE_TARGETS_ZONE.New}(): Creates a new ACT_ASSIST_SMOKE_TARGETS_ZONE object.
---
--- # Developer Note
--- 
--- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
--- Therefore, this class is considered to be deprecated
---
--- ===
---
--- @module Actions.Act_Assist
--- @image MOOSE.JPG
-
-
-do -- ACT_ASSIST
-
-  --- ACT_ASSIST class
-  -- @type ACT_ASSIST
-  -- @extends Core.Fsm#FSM_PROCESS
-  ACT_ASSIST = {
-    ClassName = "ACT_ASSIST",
-  }
-
-  --- Creates a new target smoking state machine. The process will request from the menu if it accepts the task, if not, the unit is removed from the simulator.
-  -- @param #ACT_ASSIST self
-  -- @return #ACT_ASSIST
-  function ACT_ASSIST:New()
-
-    -- Inherits from BASE
-    local self = BASE:Inherit( self, FSM_PROCESS:New( "ACT_ASSIST" ) ) -- Core.Fsm#FSM_PROCESS
-
-    self:AddTransition( "None", "Start", "AwaitSmoke" )
-    self:AddTransition( "AwaitSmoke", "Next", "Smoking" )
-    self:AddTransition( "Smoking", "Next", "AwaitSmoke" )
-    self:AddTransition( "*", "Stop", "Success" )
-    self:AddTransition( "*", "Fail", "Failed" )
-
-    self:AddEndState( "Failed" )
-    self:AddEndState( "Success" )
-
-    self:SetStartState( "None" )
-
-    return self
-  end
-
-  --- Task Events
-
-  --- StateMachine callback function
-  -- @param #ACT_ASSIST self
-  -- @param Wrapper.Controllable#CONTROLLABLE ProcessUnit
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  function ACT_ASSIST:onafterStart( ProcessUnit, From, Event, To )
-
-    local ProcessGroup = ProcessUnit:GetGroup()
-    local MissionMenu = self:GetMission():GetMenu( ProcessGroup )
-
-    local function MenuSmoke( MenuParam )
-      local self = MenuParam.self
-      local SmokeColor = MenuParam.SmokeColor
-      self.SmokeColor = SmokeColor
-      self:__Next( 1 )
-    end
-
-    self.Menu = MENU_GROUP:New( ProcessGroup, "Target acquisition", MissionMenu )
-    self.MenuSmokeBlue   = MENU_GROUP_COMMAND:New( ProcessGroup, "Drop blue smoke on targets", self.Menu, MenuSmoke, { self = self, SmokeColor = SMOKECOLOR.Blue } )
-    self.MenuSmokeGreen  = MENU_GROUP_COMMAND:New( ProcessGroup, "Drop green smoke on targets", self.Menu, MenuSmoke, { self = self, SmokeColor = SMOKECOLOR.Green } )
-    self.MenuSmokeOrange = MENU_GROUP_COMMAND:New( ProcessGroup, "Drop Orange smoke on targets", self.Menu, MenuSmoke, { self = self, SmokeColor = SMOKECOLOR.Orange } )
-    self.MenuSmokeRed    = MENU_GROUP_COMMAND:New( ProcessGroup, "Drop Red smoke on targets", self.Menu, MenuSmoke, { self = self, SmokeColor = SMOKECOLOR.Red } )
-    self.MenuSmokeWhite  = MENU_GROUP_COMMAND:New( ProcessGroup, "Drop White smoke on targets", self.Menu, MenuSmoke, { self = self, SmokeColor = SMOKECOLOR.White } )
-  end
-
-  --- StateMachine callback function
-  -- @param #ACT_ASSIST self
-  -- @param Wrapper.Controllable#CONTROLLABLE ProcessUnit
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  function ACT_ASSIST:onafterStop( ProcessUnit, From, Event, To )
-
-    self.Menu:Remove() -- When stopped, remove the menus
-  end
-
-end
-
-do -- ACT_ASSIST_SMOKE_TARGETS_ZONE
-
-  --- ACT_ASSIST_SMOKE_TARGETS_ZONE class
-  -- @type ACT_ASSIST_SMOKE_TARGETS_ZONE
-  -- @field Core.Set#SET_UNIT TargetSetUnit
-  -- @field Core.Zone#ZONE_BASE TargetZone
-  -- @extends #ACT_ASSIST
-  ACT_ASSIST_SMOKE_TARGETS_ZONE = {
-    ClassName = "ACT_ASSIST_SMOKE_TARGETS_ZONE",
-  }
-
---  function ACT_ASSIST_SMOKE_TARGETS_ZONE:_Destructor()
---    self:E("_Destructor")
---
---    self.Menu:Remove()
---    self:EventRemoveAll()
---  end
-
-  --- Creates a new target smoking state machine. The process will request from the menu if it accepts the task, if not, the unit is removed from the simulator.
-  -- @param #ACT_ASSIST_SMOKE_TARGETS_ZONE self
-  -- @param Core.Set#SET_UNIT TargetSetUnit
-  -- @param Core.Zone#ZONE_BASE TargetZone
-  function ACT_ASSIST_SMOKE_TARGETS_ZONE:New( TargetSetUnit, TargetZone )
-    local self = BASE:Inherit( self, ACT_ASSIST:New() ) -- #ACT_ASSIST
-
-    self.TargetSetUnit = TargetSetUnit
-    self.TargetZone = TargetZone
-
-    return self
-  end
-
-  function ACT_ASSIST_SMOKE_TARGETS_ZONE:Init( FsmSmoke )
-
-    self.TargetSetUnit = FsmSmoke.TargetSetUnit
-    self.TargetZone = FsmSmoke.TargetZone
-  end
-
-  --- Creates a new target smoking state machine. The process will request from the menu if it accepts the task, if not, the unit is removed from the simulator.
-  -- @param #ACT_ASSIST_SMOKE_TARGETS_ZONE self
-  -- @param Core.Set#SET_UNIT TargetSetUnit
-  -- @param Core.Zone#ZONE_BASE TargetZone
-  -- @return #ACT_ASSIST_SMOKE_TARGETS_ZONE self
-  function ACT_ASSIST_SMOKE_TARGETS_ZONE:Init( TargetSetUnit, TargetZone )
-
-    self.TargetSetUnit = TargetSetUnit
-    self.TargetZone = TargetZone
-
-    return self
-  end
-
-  --- StateMachine callback function
-  -- @param #ACT_ASSIST_SMOKE_TARGETS_ZONE self
-  -- @param Wrapper.Controllable#CONTROLLABLE ProcessUnit
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  function ACT_ASSIST_SMOKE_TARGETS_ZONE:onenterSmoking( ProcessUnit, From, Event, To )
-
-    self.TargetSetUnit:ForEachUnit(
-      -- @param Wrapper.Unit#UNIT SmokeUnit
-      function( SmokeUnit )
-        if math.random( 1, ( 100 * self.TargetSetUnit:Count() ) / 4 ) <= 100 then
-          SCHEDULER:New( self,
-            function()
-              if SmokeUnit:IsAlive() then
-                SmokeUnit:Smoke( self.SmokeColor, 150 )
-              end
-            end, {}, math.random( 10, 60 )
-          )
-        end
-      end
-    )
-
-  end
-
-end

Moose Development/Moose/Actions/Act_Route.lua

@@ -1,483 +0,0 @@
---- (SP) (MP) (FSM) Route AI or players through waypoints or to zones.
---
--- ===
---
--- # @{#ACT_ROUTE} FSM class, extends @{Core.Fsm#FSM_PROCESS}
---
--- ## ACT_ROUTE state machine:
---
--- This class is a state machine: it manages a process that is triggered by events causing state transitions to occur.
--- All derived classes from this class will start with the class name, followed by a \_. See the relevant derived class descriptions below.
--- Each derived class follows exactly the same process, using the same events and following the same state transitions,
--- but will have **different implementation behaviour** upon each event or state transition.
---
--- ### ACT_ROUTE **Events**:
---
--- These are the events defined in this class:
---
---   * **Start**:  The process is started. The process will go into the Report state.
---   * **Report**: The process is reporting to the player the route to be followed.
---   * **Route**: The process is routing the controllable.
---   * **Pause**: The process is pausing the route of the controllable.
---   * **Arrive**: The controllable has arrived at a route point.
---   * **More**:  There are more route points that need to be followed. The process will go back into the Report state.
---   * **NoMore**:  There are no more route points that need to be followed. The process will go into the Success state.
---
--- ### ACT_ROUTE **Event methods**:
---
--- Event methods are available (dynamically allocated by the state machine), that accomodate for state transitions occurring in the process.
--- There are two types of event methods, which you can use to influence the normal mechanisms in the state machine:
---
---   * **Immediate**: The event method has exactly the name of the event.
---   * **Delayed**: The event method starts with a __ + the name of the event. The first parameter of the event method is a number value, expressing the delay in seconds when the event will be executed.
---
--- ### ACT_ROUTE **States**:
---
---   * **None**: The controllable did not receive route commands.
---   * **Arrived (*)**: The controllable has arrived at a route point.
---   * **Aborted (*)**: The controllable has aborted the route path.
---   * **Routing**: The controllable is understay to the route point.
---   * **Pausing**: The process is pausing the routing. AI air will go into hover, AI ground will stop moving. Players can fly around.
---   * **Success (*)**: All route points were reached.
---   * **Failed (*)**: The process has failed.
---
--- (*) End states of the process.
---
--- ### ACT_ROUTE state transition methods:
---
--- State transition functions can be set **by the mission designer** customizing or improving the behaviour of the state.
--- There are 2 moments when state transition methods will be called by the state machine:
---
---   * **Before** the state transition.
---     The state transition method needs to start with the name **OnBefore + the name of the state**.
---     If the state transition method returns false, then the processing of the state transition will not be done!
---     If you want to change the behaviour of the AIControllable at this event, return false,
---     but then you'll need to specify your own logic using the AIControllable!
---
---   * **After** the state transition.
---     The state transition method needs to start with the name **OnAfter + the name of the state**.
---     These state transition methods need to provide a return value, which is specified at the function description.
---
--- ===
---
--- # 1) @{#ACT_ROUTE_ZONE} class, extends @{#ACT_ROUTE}
---
--- The ACT_ROUTE_ZONE class implements the core functions to route an AIR @{Wrapper.Controllable} player @{Wrapper.Unit} to a @{Core.Zone}.
--- The player receives on perioding times messages with the coordinates of the route to follow.
--- Upon arrival at the zone, a confirmation of arrival is sent, and the process will be ended.
---
--- # 1.1) ACT_ROUTE_ZONE constructor:
---
---   * @{#ACT_ROUTE_ZONE.New}(): Creates a new ACT_ROUTE_ZONE object.
---
--- # Developer Note
--- 
--- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
--- Therefore, this class is considered to be deprecated
---
--- ===
---
--- @module Actions.Act_Route
--- @image MOOSE.JPG
-
-
-do -- ACT_ROUTE
-
-  --- ACT_ROUTE class
-  -- @type ACT_ROUTE
-  -- @field Tasking.Task#TASK TASK
-  -- @field Wrapper.Unit#UNIT ProcessUnit
-  -- @field Core.Zone#ZONE_BASE Zone
-  -- @field Core.Point#COORDINATE Coordinate
-  -- @extends Core.Fsm#FSM_PROCESS
-  ACT_ROUTE = {
-    ClassName = "ACT_ROUTE",
-  }
-
-
-  --- Creates a new routing state machine. The process will route a CLIENT to a ZONE until the CLIENT is within that ZONE.
-  -- @param #ACT_ROUTE self
-  -- @return #ACT_ROUTE self
-  function ACT_ROUTE:New()
-
-    -- Inherits from BASE
-    local self = BASE:Inherit( self, FSM_PROCESS:New( "ACT_ROUTE" ) ) -- Core.Fsm#FSM_PROCESS
-
-    self:AddTransition( "*", "Reset", "None" )
-    self:AddTransition( "None", "Start", "Routing" )
-    self:AddTransition( "*", "Report", "*" )
-    self:AddTransition( "Routing", "Route", "Routing" )
-    self:AddTransition( "Routing", "Pause", "Pausing" )
-    self:AddTransition( "Routing", "Arrive", "Arrived" )
-    self:AddTransition( "*", "Cancel", "Cancelled" )
-    self:AddTransition( "Arrived", "Success", "Success" )
-    self:AddTransition( "*", "Fail", "Failed" )
-    self:AddTransition( "", "", "" )
-    self:AddTransition( "", "", "" )
-
-    self:AddEndState( "Arrived" )
-    self:AddEndState( "Failed" )
-    self:AddEndState( "Cancelled" )
-
-    self:SetStartState( "None" )
-
-    self:SetRouteMode( "C" )
-
-    return self
-  end
-
-  --- Set a Cancel Menu item.
-  -- @param #ACT_ROUTE self
-  -- @return #ACT_ROUTE
-  function ACT_ROUTE:SetMenuCancel( MenuGroup, MenuText, ParentMenu, MenuTime, MenuTag )
-
-    self.CancelMenuGroupCommand = MENU_GROUP_COMMAND:New(
-      MenuGroup,
-      MenuText,
-      ParentMenu,
-      self.MenuCancel,
-      self
-    ):SetTime( MenuTime ):SetTag( MenuTag )
-
-    ParentMenu:SetTime( MenuTime )
-
-    ParentMenu:Remove( MenuTime, MenuTag )
-
-    return self
-  end
-
-  --- Set the route mode.
-  -- There are 2 route modes supported:
-  --
-  --   * SetRouteMode( "B" ): Route mode is Bearing and Range.
-  --   * SetRouteMode( "C" ): Route mode is LL or MGRS according coordinate system setup.
-  --
-  -- @param #ACT_ROUTE self
-  -- @return #ACT_ROUTE
-  function ACT_ROUTE:SetRouteMode( RouteMode )
-
-    self.RouteMode = RouteMode
-
-    return self
-  end
-
-  --- Get the routing text to be displayed.
-  -- The route mode determines the text displayed.
-  -- @param #ACT_ROUTE self
-  -- @param Wrapper.Unit#UNIT Controllable
-  -- @return #string
-  function ACT_ROUTE:GetRouteText( Controllable )
-
-    local RouteText = ""
-
-    local Coordinate = nil -- Core.Point#COORDINATE
-
-    if self.Coordinate then
-      Coordinate = self.Coordinate
-    end
-
-    if self.Zone then
-      Coordinate = self.Zone:GetPointVec3( self.Altitude )
-      Coordinate:SetHeading( self.Heading )
-    end
-
-
-    local Task = self:GetTask() -- This is to dermine that the coordinates are for a specific task mode (A2A or A2G).
-    local CC = self:GetTask():GetMission():GetCommandCenter()
-    if CC then
-      if CC:IsModeWWII() then
-        -- Find closest reference point to the target.
-        local ShortestDistance = 0
-        local ShortestReferencePoint = nil
-        local ShortestReferenceName = ""
-        self:F( { CC.ReferencePoints } )
-        for ZoneName, Zone in pairs( CC.ReferencePoints ) do
-          self:F( { ZoneName = ZoneName } )
-          local Zone = Zone -- Core.Zone#ZONE
-          local ZoneCoord = Zone:GetCoordinate()
-          local ZoneDistance = ZoneCoord:Get2DDistance( Coordinate )
-          self:F( { ShortestDistance, ShortestReferenceName } )
-          if ShortestDistance == 0 or ZoneDistance < ShortestDistance then
-            ShortestDistance = ZoneDistance
-            ShortestReferencePoint = ZoneCoord
-            ShortestReferenceName = CC.ReferenceNames[ZoneName]
-          end
-        end
-        if ShortestReferencePoint then
-          RouteText = Coordinate:ToStringFromRP( ShortestReferencePoint, ShortestReferenceName, Controllable )
-        end
-      else
-        RouteText = Coordinate:ToString( Controllable, nil, Task )
-      end
-    end
-
-    return RouteText
-  end
-
-
-  function ACT_ROUTE:MenuCancel()
-    self:F("Cancelled")
-    self.CancelMenuGroupCommand:Remove()
-    self:__Cancel( 1 )
-  end
-
-  --- Task Events
-
-  --- StateMachine callback function
-  -- @param #ACT_ROUTE self
-  -- @param Wrapper.Unit#UNIT ProcessUnit
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  function ACT_ROUTE:onafterStart( ProcessUnit, From, Event, To )
-
-
-    self:__Route( 1 )
-  end
-
-  --- Check if the controllable has arrived.
-  -- @param #ACT_ROUTE self
-  -- @param Wrapper.Unit#UNIT ProcessUnit
-  -- @return #boolean
-  function ACT_ROUTE:onfuncHasArrived( ProcessUnit )
-    return false
-  end
-
-  --- StateMachine callback function
-  -- @param #ACT_ROUTE self
-  -- @param Wrapper.Unit#UNIT ProcessUnit
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  function ACT_ROUTE:onbeforeRoute( ProcessUnit, From, Event, To )
-
-    if ProcessUnit:IsAlive() then
-      local HasArrived = self:onfuncHasArrived( ProcessUnit ) -- Polymorphic
-      if self.DisplayCount >= self.DisplayInterval then
-        self:T( { HasArrived = HasArrived } )
-        if not HasArrived then
-          self:Report()
-        end
-        self.DisplayCount = 1
-      else
-        self.DisplayCount = self.DisplayCount + 1
-      end
-
-      if HasArrived then
-        self:__Arrive( 1 )
-      else
-        self:__Route( 1 )
-      end
-
-      return HasArrived -- if false, then the event will not be executed...
-    end
-
-    return false
-
-  end
-
-end -- ACT_ROUTE
-
-
-do -- ACT_ROUTE_POINT
-
-  --- ACT_ROUTE_POINT class
-  -- @type ACT_ROUTE_POINT
-  -- @field Tasking.Task#TASK TASK
-  -- @extends #ACT_ROUTE
-  ACT_ROUTE_POINT = {
-    ClassName = "ACT_ROUTE_POINT",
-  }
-
-
-  --- Creates a new routing state machine.
-  -- The task will route a controllable to a Coordinate until the controllable is within the Range.
-  -- @param #ACT_ROUTE_POINT self
-  -- @param Core.Point#COORDINATE The Coordinate to Target.
-  -- @param #number Range The Distance to Target.
-  -- @param Core.Zone#ZONE_BASE Zone
-  function ACT_ROUTE_POINT:New( Coordinate, Range )
-    local self = BASE:Inherit( self, ACT_ROUTE:New() ) -- #ACT_ROUTE_POINT
-
-    self.Coordinate = Coordinate
-    self.Range = Range or 0
-
-    self.DisplayInterval = 30
-    self.DisplayCount = 30
-    self.DisplayMessage = true
-    self.DisplayTime = 10 -- 10 seconds is the default
-
-    return self
-  end
-
-  --- Creates a new routing state machine.
-  -- The task will route a controllable to a Coordinate until the controllable is within the Range.
-  -- @param #ACT_ROUTE_POINT self
-  function ACT_ROUTE_POINT:Init( FsmRoute )
-
-    self.Coordinate = FsmRoute.Coordinate
-    self.Range = FsmRoute.Range or 0
-
-    self.DisplayInterval = 30
-    self.DisplayCount = 30
-    self.DisplayMessage = true
-    self.DisplayTime = 10 -- 10 seconds is the default
-    self:SetStartState("None")
-  end
-
-  --- Set Coordinate
-  -- @param #ACT_ROUTE_POINT self
-  -- @param Core.Point#COORDINATE Coordinate The Coordinate to route to.
-  function ACT_ROUTE_POINT:SetCoordinate( Coordinate )
-    self:F2( { Coordinate } )
-    self.Coordinate = Coordinate
-  end
-
-  --- Get Coordinate
-  -- @param #ACT_ROUTE_POINT self
-  -- @return Core.Point#COORDINATE Coordinate The Coordinate to route to.
-  function ACT_ROUTE_POINT:GetCoordinate()
-    self:F2( { self.Coordinate } )
-    return self.Coordinate
-  end
-
-  --- Set Range around Coordinate
-  -- @param #ACT_ROUTE_POINT self
-  -- @param #number Range The Range to consider the arrival. Default is 10000 meters.
-  function ACT_ROUTE_POINT:SetRange( Range )
-    self:F2( { Range } )
-    self.Range = Range or 10000
-  end
-
-  --- Get Range around Coordinate
-  -- @param #ACT_ROUTE_POINT self
-  -- @return #number The Range to consider the arrival. Default is 10000 meters.
-  function ACT_ROUTE_POINT:GetRange()
-    self:F2( { self.Range } )
-    return self.Range
-  end
-
-  --- Method override to check if the controllable has arrived.
-  -- @param #ACT_ROUTE_POINT self
-  -- @param Wrapper.Unit#UNIT ProcessUnit
-  -- @return #boolean
-  function ACT_ROUTE_POINT:onfuncHasArrived( ProcessUnit )
-
-    if ProcessUnit:IsAlive() then
-      local Distance = self.Coordinate:Get2DDistance( ProcessUnit:GetCoordinate() )
-
-      if Distance <= self.Range then
-        local RouteText = "Task \"" .. self:GetTask():GetName() .. "\", you have arrived."
-        self:GetCommandCenter():MessageTypeToGroup( RouteText, ProcessUnit:GetGroup(), MESSAGE.Type.Information )
-        return true
-      end
-    end
-
-    return false
-  end
-
-  --- Task Events
-
-  --- StateMachine callback function
-  -- @param #ACT_ROUTE_POINT self
-  -- @param Wrapper.Unit#UNIT ProcessUnit
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  function ACT_ROUTE_POINT:onafterReport( ProcessUnit, From, Event, To )
-
-    local RouteText = "Task \"" .. self:GetTask():GetName() .. "\", " .. self:GetRouteText( ProcessUnit )
-
-    self:GetCommandCenter():MessageTypeToGroup( RouteText, ProcessUnit:GetGroup(), MESSAGE.Type.Update )
-  end
-
-end -- ACT_ROUTE_POINT
-
-
-do -- ACT_ROUTE_ZONE
-
-  --- ACT_ROUTE_ZONE class
-  -- @type ACT_ROUTE_ZONE
-  -- @field Tasking.Task#TASK TASK
-  -- @field Wrapper.Unit#UNIT ProcessUnit
-  -- @field Core.Zone#ZONE_BASE Zone
-  -- @extends #ACT_ROUTE
-  ACT_ROUTE_ZONE = {
-    ClassName = "ACT_ROUTE_ZONE",
-  }
-
-
-  --- Creates a new routing state machine. The task will route a controllable to a ZONE until the controllable is within that ZONE.
-  -- @param #ACT_ROUTE_ZONE self
-  -- @param Core.Zone#ZONE_BASE Zone
-  function ACT_ROUTE_ZONE:New( Zone )
-    local self = BASE:Inherit( self, ACT_ROUTE:New() ) -- #ACT_ROUTE_ZONE
-
-    self.Zone = Zone
-
-    self.DisplayInterval = 30
-    self.DisplayCount = 30
-    self.DisplayMessage = true
-    self.DisplayTime = 10 -- 10 seconds is the default
-
-    return self
-  end
-
-  function ACT_ROUTE_ZONE:Init( FsmRoute )
-
-    self.Zone = FsmRoute.Zone
-
-    self.DisplayInterval = 30
-    self.DisplayCount = 30
-    self.DisplayMessage = true
-    self.DisplayTime = 10 -- 10 seconds is the default
-  end
-
-  --- Set Zone
-  -- @param #ACT_ROUTE_ZONE self
-  -- @param Core.Zone#ZONE_BASE Zone The Zone object where to route to.
-  -- @param #number Altitude
-  -- @param #number Heading
-  function ACT_ROUTE_ZONE:SetZone( Zone, Altitude, Heading ) -- R2.2 Added altitude and heading
-    self.Zone = Zone
-    self.Altitude = Altitude
-    self.Heading = Heading
-  end
-
-  --- Get Zone
-  -- @param #ACT_ROUTE_ZONE self
-  -- @return Core.Zone#ZONE_BASE Zone The Zone object where to route to.
-  function ACT_ROUTE_ZONE:GetZone()
-    return self.Zone
-  end
-
-  --- Method override to check if the controllable has arrived.
-  -- @param #ACT_ROUTE self
-  -- @param Wrapper.Unit#UNIT ProcessUnit
-  -- @return #boolean
-  function ACT_ROUTE_ZONE:onfuncHasArrived( ProcessUnit )
-
-    if ProcessUnit:IsInZone( self.Zone ) then
-      local RouteText = "Task \"" .. self:GetTask():GetName() .. "\", you have arrived within the zone."
-      self:GetCommandCenter():MessageTypeToGroup( RouteText, ProcessUnit:GetGroup(), MESSAGE.Type.Information )
-    end
-
-    return ProcessUnit:IsInZone( self.Zone )
-  end
-
-  --- Task Events
-
-  --- StateMachine callback function
-  -- @param #ACT_ROUTE_ZONE self
-  -- @param Wrapper.Unit#UNIT ProcessUnit
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  function ACT_ROUTE_ZONE:onafterReport( ProcessUnit, From, Event, To )
-    self:F( { ProcessUnit = ProcessUnit } )
-
-    local RouteText = "Task \"" .. self:GetTask():GetName() .. "\", " .. self:GetRouteText( ProcessUnit )
-    self:GetCommandCenter():MessageTypeToGroup( RouteText, ProcessUnit:GetGroup(), MESSAGE.Type.Update )
-  end
-
-end -- ACT_ROUTE_ZONE

Moose Development/Moose/Cargo/CargoCrate.lua

@@ -1,337 +0,0 @@
---- **Cargo** - Management of single cargo crates, which are based on a STATIC object.
---
--- ===
--- 
--- ### [Demo Missions]()
--- 
--- ### [YouTube Playlist]()
--- 
--- ===
--- 
--- ### Author: **FlightControl**
--- ### Contributions: 
--- 
--- ===
--- 
--- @module Cargo.CargoCrate
--- @image Cargo_Crates.JPG
-
-do -- CARGO_CRATE
-
-  --- Models the behaviour of cargo crates, which can be slingloaded and boarded on helicopters. 
-  -- @type CARGO_CRATE
-  -- @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\_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.
-  --
-  -- # Developer Note
-  -- 
-  -- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
-  -- Therefore, this class is considered to be deprecated
-  --
-  -- ===
-  -- 
-  -- @field #CARGO_CRATE
-  CARGO_CRATE = {
-    ClassName = "CARGO_CRATE"
-  }
-  
-  --- CARGO_CRATE Constructor.
-  -- @param #CARGO_CRATE self
-  -- @param Wrapper.Static#STATIC CargoStatic
-  -- @param #string Type
-  -- @param #string Name
-  -- @param #number LoadRadius (optional)
-  -- @param #number NearRadius (optional)
-  -- @return #CARGO_CRATE
-  function CARGO_CRATE:New( CargoStatic, Type, Name, LoadRadius, NearRadius )
-    local self = BASE:Inherit( self, CARGO_REPRESENTABLE:New( CargoStatic, Type, Name, nil, LoadRadius, NearRadius ) ) -- #CARGO_CRATE
-    self:T( { Type, Name, NearRadius } )
-  
-    self.CargoObject = CargoStatic -- Wrapper.Static#STATIC
- 
-    -- Cargo objects are added to the _DATABASE and SET_CARGO objects.
-    _EVENTDISPATCHER:CreateEventNewCargo( self )
-    
-    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
-  
-  -- @param #CARGO_CRATE self
-  -- @param Core.Event#EVENTDATA EventData 
-  function CARGO_CRATE:OnEventCargoDead( EventData )
-
-    local Destroyed = false
-  
-    if self:IsDestroyed() or self:IsUnLoaded() or self:IsBoarding() then
-      if self.CargoObject:GetName() == EventData.IniUnitName then
-        if not self.NoDestroy then 
-          Destroyed = true
-        end
-      end
-    else
-      if self:IsLoaded() then
-        local CarrierName = self.CargoCarrier:GetName()
-        if CarrierName == EventData.IniDCSUnitName then
-          MESSAGE:New( "Cargo is lost from carrier " .. CarrierName, 15 ):ToAll()
-          Destroyed = true
-          self.CargoCarrier:ClearCargo()
-        end
-      end
-    end
-    
-    if Destroyed then
-      self:I( { "Cargo crate destroyed: " .. self.CargoObject:GetName() } )
-      self:Destroyed()
-    end
-    
-  end
-  
-  
-  --- Enter UnLoaded State.
-  -- @param #CARGO_CRATE self
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  -- @param Core.Point#COORDINATE
-  function CARGO_CRATE:onenterUnLoaded( From, Event, To, ToPointVec2 )
-    --self:T( { ToPointVec2, From, Event, To } )
-  
-    local Angle = 180
-    local Speed = 10
-    local Distance = 10
-  
-    if From == "Loaded" then
-      local StartCoordinate = self.CargoCarrier:GetCoordinate()
-      local CargoCarrierHeading = self.CargoCarrier:GetHeading() -- Get Heading of object in degrees.
-      local CargoDeployHeading = ( ( CargoCarrierHeading + Angle ) >= 360 ) and ( CargoCarrierHeading + Angle - 360 ) or ( CargoCarrierHeading + Angle )
-      local CargoDeployCoord = StartCoordinate:Translate( Distance, CargoDeployHeading )
-  
-      ToPointVec2 = ToPointVec2 or COORDINATE:NewFromVec2( { x= CargoDeployCoord.x, y = CargoDeployCoord.z } )
-  
-      -- Respawn the group...
-      if self.CargoObject then
-        self.CargoObject:ReSpawnAt( ToPointVec2, 0 )
-        self.CargoCarrier = nil
-      end
-      
-    end
-  
-    if self.OnUnLoadedCallBack then
-      self.OnUnLoadedCallBack( self, unpack( self.OnUnLoadedParameters ) )
-      self.OnUnLoadedCallBack = nil
-    end
-  
-  end
-
-  
-  --- Loaded State.
-  -- @param #CARGO_CRATE self
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  -- @param Wrapper.Unit#UNIT CargoCarrier
-  function CARGO_CRATE:onenterLoaded( From, Event, To, CargoCarrier )
-    --self:T( { From, Event, To, CargoCarrier } )
-  
-    self.CargoCarrier = CargoCarrier
-    
-    -- Only destroy the CargoObject is if there is a CargoObject (packages don't have CargoObjects).
-    if self.CargoObject then
-      self:T("Destroying")
-      self.NoDestroy = true
-      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
-  end
-
-  --- Check if the cargo can be Boarded.
-  -- @param #CARGO_CRATE self
-  function CARGO_CRATE:CanBoard()
-    return false
-  end
-
-  --- Check if the cargo can be Unboarded.
-  -- @param #CARGO_CRATE self
-  function CARGO_CRATE:CanUnboard()
-    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
-  -- @return #boolean true if the Cargo Crate is within the report radius.
-  function CARGO_CRATE:IsInReportRadius( Coordinate )
-    --self:T( { Coordinate, LoadRadius = self.LoadRadius } )
-  
-    local Distance = 0
-    if self:IsUnLoaded() then
-      Distance = Coordinate:Get2DDistance( self.CargoObject:GetCoordinate() )
-      --self:T( Distance )
-      if Distance <= self.LoadRadius then
-        return true
-      end
-    end
-    
-    return false
-  end
-
-
-  --- Check if Cargo Crate is in the radius for the Cargo to be Boarded or Loaded.
-  -- @param #CARGO_CRATE self
-  -- @param Core.Point#Coordinate Coordinate
-  -- @return #boolean true if the Cargo Crate is within the loading radius.
-  function CARGO_CRATE:IsInLoadRadius( Coordinate )
-    --self:T( { Coordinate, LoadRadius = self.NearRadius } )
-  
-    local Distance = 0
-    if self:IsUnLoaded() then
-      Distance = Coordinate:Get2DDistance( self.CargoObject:GetCoordinate() )
-      --self:T( Distance )
-      if Distance <= self.NearRadius then
-        return true
-      end
-    end
-    
-    return false
-  end
-
-
-
-  --- Get the current Coordinate of the CargoGroup.
-  -- @param #CARGO_CRATE self
-  -- @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_CRATE:GetCoordinate()
-    --self:T()
-    
-    return self.CargoObject:GetCoordinate()
-  end
-
-  --- Check if the CargoGroup is alive.
-  -- @param #CARGO_CRATE self
-  -- @return #boolean true if the CargoGroup is alive.
-  -- @return #boolean false if the CargoGroup is dead.
-  function CARGO_CRATE:IsAlive()
-
-    local Alive = true
-  
-    -- When the Cargo is Loaded, the Cargo is in the CargoCarrier, so we check if the CargoCarrier is alive.
-    -- When the Cargo is not Loaded, the Cargo is the CargoObject, so we check if the CargoObject is alive.
-    if self:IsLoaded() then
-      Alive = Alive == true and self.CargoCarrier:IsAlive()
-    else
-      Alive = Alive == true and self.CargoObject:IsAlive()
-    end 
-    
-    return Alive
-  
-  end
-
-  
-  --- Route Cargo to Coordinate and randomize locations.
-  -- @param #CARGO_CRATE self
-  -- @param Core.Point#COORDINATE Coordinate
-  function CARGO_CRATE:RouteTo( Coordinate )
-    self:T( {Coordinate = Coordinate } )
-    
-  end
-
-  
-  --- Check if Cargo is near to the Carrier.
-  -- The Cargo is near to the Carrier within NearRadius.
-  -- @param #CARGO_CRATE 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.
-  function CARGO_CRATE:IsNear( CargoCarrier, NearRadius )
-    self:T( {NearRadius = NearRadius } )
-    
-    return self:IsNear( CargoCarrier:GetCoordinate(), NearRadius )
-  end
-
-  --- Respawn the CargoGroup.
-  -- @param #CARGO_CRATE self
-  function CARGO_CRATE:Respawn()
-
-    self:T( { "Respawning crate " .. self:GetName() } )
-
-
-    -- Respawn the group...
-    if self.CargoObject then
-      self.CargoObject:ReSpawn() -- A cargo destroy crates a DEAD event.
-      self:__Reset( -0.1 )
-    end
-
-    
-  end
-
-
-  --- Respawn the CargoGroup.
-  -- @param #CARGO_CRATE self
-  function CARGO_CRATE:onafterReset()
-
-    self:T( { "Reset crate " .. self:GetName() } )
-
-
-    -- Respawn the group...
-    if self.CargoObject then
-      self:SetDeployed( false )
-      self:SetStartState( "UnLoaded" )
-      self.CargoCarrier = nil
-      -- Cargo objects are added to the _DATABASE and SET_CARGO objects.
-      _EVENTDISPATCHER:CreateEventNewCargo( self )
-    end
-
-    
-  end
-
-  --- Get the transportation method of the Cargo.
-  -- @param #CARGO_CRATE self
-  -- @return #string The transportation method of the Cargo.
-  function CARGO_CRATE:GetTransportationMethod()
-    if self:IsLoaded() then
-      return "for unloading"
-    else
-      if self:IsUnLoaded() then
-        return "for loading"
-      else
-        if self:IsDeployed() then
-          return "delivered"
-        end
-      end
-    end
-    return ""
-  end
-  
-end
-

Moose Development/Moose/Cargo/CargoGroup.lua

@@ -1,775 +0,0 @@
---- **Cargo** - Management of grouped cargo logistics, which are based on a GROUP object.
---
--- ===
--- 
--- ### [Demo Missions]()
--- 
--- ### [YouTube Playlist]()
--- 
--- ===
--- 
--- ### Author: **FlightControl**
--- ### Contributions: 
--- 
--- ===
--- 
--- @module Cargo.CargoGroup
--- @image Cargo_Groups.JPG
-
-
-do -- CARGO_GROUP
-
-  --- @type CARGO_GROUP
-  -- @field Core.Set#SET_CARGO CargoSet The collection of derived CARGO objects.
-  -- @field #string GroupName The name of the CargoGroup.
-  -- @field Wrapper.Group#GROUÜ CargoCarrier The carrier group.
-  -- @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 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.
-  --
-  -- # Developer Note
-  -- 
-  -- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
-  -- Therefore, this class is considered to be deprecated
-  --
-  -- @field #CARGO_GROUP CARGO_GROUP
-  -- 
-  CARGO_GROUP = {
-    ClassName = "CARGO_GROUP",
-  }
-
-  --- CARGO_GROUP constructor.
-  -- This make a new CARGO_GROUP from a @{Wrapper.Group} object.
-  -- It will "ungroup" the group object within the sim, and will create a @{Core.Set} of individual Unit objects.
-  -- @param #CARGO_GROUP self
-  -- @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 )
-  
-    -- Inherit CAROG_REPORTABLE
-    local self = BASE:Inherit( self, CARGO_REPORTABLE:New( Type, Name, 0, LoadRadius, NearRadius ) ) -- #CARGO_GROUP
-    self:T( { Type, Name, LoadRadius } )
-  
-    self.CargoSet = SET_CARGO:New()
-    self.CargoGroup = CargoGroup
-    self.Grouped = true
-    self.CargoUnitTemplate = {}
-    
-    self.NearRadius = NearRadius
-    
-    self:SetDeployed( false )
-    
-    local WeightGroup = 0
-    local VolumeGroup = 0
-    
-    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 ) )
-    
-    -- Deactivate late activation.
-    self.CargoTemplate.lateActivation=false
-
-    self.GroupTemplate = UTILS.DeepCopy( self.CargoTemplate )
-    self.GroupTemplate.name = self.CargoName .. "#CARGO"
-    self.GroupTemplate.groupId = nil
-    
-    self.GroupTemplate.units = {}
-    
-    for UnitID, UnitTemplate in pairs( self.CargoTemplate.units ) do
-      UnitTemplate.name = UnitTemplate.name .. "#CARGO"
-      local CargoUnitName = UnitTemplate.name
-      self.CargoUnitTemplate[CargoUnitName] = UnitTemplate      
-
-       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 )
-      
-    end
-
-    -- Then we register the new group in the database
-    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( 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:T( { "Weight Cargo", WeightGroup } )
-  
-    -- Cargo objects are added to the _DATABASE and SET_CARGO objects.
-    _EVENTDISPATCHER:CreateEventNewCargo( self )
-    
-    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 )
-    
-    return self
-  end
-
-
-  --- Respawn the CargoGroup.
-  -- @param #CARGO_GROUP self
-  function CARGO_GROUP:Respawn()
-
-    self:T( { "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.
-  -- Therefore this method is made to be able to ungroup a group.
-  -- This works for ground only groups.
-  -- @param #CARGO_GROUP self
-  function CARGO_GROUP:Ungroup()
-
-    if self.Grouped == true then
-    
-      self.Grouped = false
-      
-      self.CargoGroup:Destroy()
-      
-      for CargoUnitName, CargoUnit in pairs( self.CargoSet:GetSet() ) do
-        local CargoUnit = CargoUnit -- Cargo.CargoUnit#CARGO_UNIT
-
-        if CargoUnit:IsUnLoaded() then
-          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 = self.CargoName .. "#CARGO#" .. CargoUnitName 
-          GroupTemplate.groupId = nil
-          
-          if CargoUnit:IsUnLoaded() then
-            GroupTemplate.units = {}
-            GroupTemplate.units[1] = self.CargoUnitTemplate[CargoUnitName]
-            GroupTemplate.units[#GroupTemplate.units].unitId = nil
-            GroupTemplate.units[#GroupTemplate.units].x = CargoUnit:GetX()
-            GroupTemplate.units[#GroupTemplate.units].y = CargoUnit:GetY()
-            GroupTemplate.units[#GroupTemplate.units].heading = CargoUnit:GetHeading()
-          end
-      
-      
-          -- 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 )
-        end
-      end
-      
-      self.CargoObject = nil
-    end
-    
-  
-  end
-
-  --- Regroup the cargo group into one group with multiple unit.
-  -- This is required because by default a group will move in formation and this is really an issue for group control.
-  -- Therefore this method is made to be able to regroup a group.
-  -- This works for ground only groups.
-  -- @param #CARGO_GROUP self
-  function CARGO_GROUP:Regroup()
-  
-    self:T("Regroup")
-
-    if self.Grouped == false then
-    
-      self.Grouped = true
-      
-      local GroupTemplate = UTILS.DeepCopy( self.CargoTemplate )
-      GroupTemplate.name = self.CargoName .. "#CARGO"
-      GroupTemplate.groupId = nil
-      GroupTemplate.units = {}
-
-      for CargoUnitName, CargoUnit in pairs( self.CargoSet:GetSet() ) do
-        local CargoUnit = CargoUnit -- Cargo.CargoUnit#CARGO_UNIT
-
-        self:T( { CargoUnit:GetName(), UnLoaded = CargoUnit:IsUnLoaded() } )
-
-        if CargoUnit:IsUnLoaded() then
-    
-          CargoUnit.CargoObject:Destroy()
-
-          GroupTemplate.units[#GroupTemplate.units+1] = self.CargoUnitTemplate[CargoUnitName]
-          GroupTemplate.units[#GroupTemplate.units].unitId = nil
-          GroupTemplate.units[#GroupTemplate.units].x = CargoUnit:GetX()
-          GroupTemplate.units[#GroupTemplate.units].y = CargoUnit:GetY()
-          GroupTemplate.units[#GroupTemplate.units].heading = CargoUnit:GetHeading()
-        end
-      end
-
-      -- Then we register the new group in the database
-      self.CargoGroup = GROUP:NewTemplate( GroupTemplate, GroupTemplate.CoalitionID, GroupTemplate.CategoryID, GroupTemplate.CountryID )
-
-      self:T( { "Regroup", GroupTemplate } )
-        
-      -- Now we spawn the new group based on the template created.
-      self.CargoObject = _DATABASE:Spawn( GroupTemplate )
-    end
-  
-  end
-
-
-  --- @param #CARGO_GROUP self
-  -- @param Core.Event#EVENTDATA EventData 
-  function CARGO_GROUP:OnEventCargoDead( EventData )
-  
-    self:T(EventData)
-
-    local Destroyed = false
-  
-    if self:IsDestroyed() or self:IsUnLoaded() or self:IsBoarding() or self:IsUnboarding() then
-      Destroyed = true
-      for CargoID, CargoData in pairs( self.CargoSet:GetSet() ) do
-        local Cargo = CargoData -- Cargo.Cargo#CARGO
-        if Cargo:IsAlive() then
-          Destroyed = false
-        else
-          Cargo:Destroyed()
-        end
-      end
-    else
-      local CarrierName = self.CargoCarrier:GetName()
-      if CarrierName == EventData.IniDCSUnitName then
-        MESSAGE:New( "Cargo is lost from carrier " .. CarrierName, 15 ):ToAll()
-        Destroyed = true
-        self.CargoCarrier:ClearCargo()
-      end
-    end
-    
-    if Destroyed then
-      self:Destroyed()
-      self:T( { "Cargo group destroyed" } )
-    end
-  
-  end
-
-  --- After Board Event.
-  -- @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:onafterBoard( From, Event, To, CargoCarrier, NearRadius, ... )
-    self:T( { CargoCarrier.UnitName, From, Event, To, NearRadius = NearRadius } )
-    
-    NearRadius = NearRadius or self.NearRadius
-    
-    -- For each Cargo object within the CARGO_GROUPED, route each object to the CargoLoadPointVec2
-    self.CargoSet:ForEach(
-      function( Cargo, ... )
-        self:T( { "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
-
-  --- Enter Loaded State.
-  -- @param #CARGO_GROUP self
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  -- @param Wrapper.Unit#UNIT CargoCarrier
-  function CARGO_GROUP:onafterLoad( From, Event, To, CargoCarrier, ... )
-    --self:T( { 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
-        if not Cargo:IsDestroyed() then
-          Cargo:Load( CargoCarrier )
-        end
-      end
-    end
-    
-    --self.CargoObject:Destroy()
-    self.CargoCarrier = CargoCarrier
-    self.CargoCarrier:AddCargo( self )
-    
-  end
-
-  --- Leave Boarding State.
-  -- @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:T( { CargoCarrier.UnitName, From, Event, To } )
-  
-    local Boarded = true
-    local Cancelled = false
-    local Dead = true
-  
-    self.CargoSet:Flush()
-  
-    -- 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 } )
-      
-      
-      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
-      
-      if Cargo:is( "UnLoaded" ) then
-        Cancelled = true
-      end
-  
-      if not Cargo:is( "Destroyed" ) then
-        Dead = false
-      end
-      
-    end
-  
-    if not Dead then
-  
-      if not Cancelled then
-        if not Boarded then
-          self:__Boarding( -5, CargoCarrier, NearRadius, ... )
-        else
-          self:T("Group Cargo is loaded")
-          self:__Load( 1, CargoCarrier, ... )
-        end
-      else
-          self:__CancelBoarding( 1, CargoCarrier, NearRadius, ... )
-      end
-    else
-      self:__Destroyed( 1, CargoCarrier, NearRadius, ... )
-    end
-    
-  end
-
-  --- Enter UnBoarding State.
-  -- @param #CARGO_GROUP self
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  -- @param Core.Point#COORDINATE 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:T( {From, Event, To, ToPointVec2, NearRadius } )
-  
-    NearRadius = NearRadius or 25
-  
-    local Timer = 1
-  
-    if From == "Loaded" then
-    
-      if self.CargoObject then
-        self.CargoObject:Destroy()
-      end
-  
-      -- For each Cargo object within the CARGO_GROUP, route each object to the CargoLoadPointVec2
-      self.CargoSet:ForEach(
-        --- @param Cargo.Cargo#CARGO Cargo
-        function( Cargo, NearRadius )
-          if not Cargo:IsDestroyed() then
-            local ToVec=nil
-            if ToPointVec2==nil then
-              ToVec=self.CargoCarrier:GetPointVec2():GetRandomPointVec2InRadius(2*NearRadius, NearRadius)
-            else
-              ToVec=ToPointVec2
-            end
-            Cargo:__UnBoard( Timer, ToVec, NearRadius )
-            Timer = Timer + 1
-          end
-        end, { NearRadius }
-      )
-      
-      
-      self:__UnBoarding( 1, ToPointVec2, NearRadius, ... )
-    end
-  
-  end
-
-  --- Leave UnBoarding State.
-  -- @param #CARGO_GROUP self
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  -- @param Core.Point#COORDINATE 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:T( { From, Event, To, ToPointVec2, NearRadius } )
-  
-    --local NearRadius = NearRadius or 25
-  
-    local Angle = 180
-    local Speed = 10
-    local Distance = 5
-  
-    if From == "UnBoarding" then
-      local UnBoarded = true
-  
-      -- 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 } )
-        if not Cargo:is( "UnLoaded" ) and not Cargo:IsDestroyed() then
-          UnBoarded = false
-        end
-      end
-    
-      if UnBoarded then
-        self:__UnLoad( 1, ToPointVec2, ... )
-      else
-        self:__UnBoarding( 1, ToPointVec2, NearRadius, ... )
-      end
-      
-      return false
-    end
-    
-  end
-
-  --- Enter UnLoaded State.
-  -- @param #CARGO_GROUP self
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  -- @param Core.Point#COORDINATE ToPointVec2
-  function CARGO_GROUP:onafterUnLoad( From, Event, To, ToPointVec2, ... )
-    --self:T( { From, Event, To, ToPointVec2 } )
-  
-    if From == "Loaded" then
-      
-      -- For each Cargo object within the CARGO_GROUP, route each object to the CargoLoadPointVec2
-      self.CargoSet:ForEach(
-        function( Cargo )
-          --Cargo:UnLoad( ToPointVec2 )
-          local RandomVec2=nil
-          if ToPointVec2 then 
-            RandomVec2=ToPointVec2:GetRandomPointVec2InRadius(20, 10)
-          end
-          Cargo:UnBoard( RandomVec2 )
-        end
-      )
-  
-    end
-    
-    self.CargoCarrier:RemoveCargo( self )
-    self.CargoCarrier = nil
-    
-  end
-
-
-  --- Get the current Coordinate of the CargoGroup.
-  -- @param #CARGO_GROUP self
-  -- @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()
-    local Cargo = self:GetFirstAlive() -- Cargo.Cargo#CARGO
-    
-    if Cargo then
-      return Cargo.CargoObject:GetCoordinate()
-    end
-    
-    return nil
-  end
-
-  --- Get the x position of the cargo.
-  -- @param #CARGO_GROUP self
-  -- @return #number
-  function CARGO:GetX()
-
-    local Cargo = self:GetFirstAlive() -- Cargo.Cargo#CARGO
-
-    if Cargo then
-      return Cargo:GetCoordinate().x
-    end 
-    
-    return nil
-  end
-  
-  --- Get the y position of the cargo.
-  -- @param #CARGO_GROUP self
-  -- @return #number
-  function CARGO:GetY()
-
-    local Cargo = self:GetFirstAlive() -- Cargo.Cargo#CARGO
-
-    if Cargo then
-      return Cargo:GetCoordinate().z
-    end
-    
-    return nil 
-  end
-  
-
-
-  --- Check if the CargoGroup is alive.
-  -- @param #CARGO_GROUP self
-  -- @return #boolean true if the CargoGroup is alive.
-  -- @return #boolean false if the CargoGroup is dead.
-  function CARGO_GROUP:IsAlive()
-
-    local Cargo = self:GetFirstAlive() -- Cargo.Cargo#CARGO
-    return Cargo ~= nil
-  
-  end
-
-  
-  --- Get the first alive Cargo Unit of the Cargo Group.
-  -- @param #CARGO_GROUP self
-  -- @return #CARGO_GROUP
-  function CARGO_GROUP:GetFirstAlive()
-    
-    local CargoFirstAlive = nil
-    
-    for _, Cargo in pairs( self.CargoSet:GetSet() ) do
-      if not Cargo:IsDestroyed() then
-        CargoFirstAlive = Cargo
-        break
-      end
-    end
-    return CargoFirstAlive
-  end
-
-  
-  --- Get the amount of cargo units in the group.
-  -- @param #CARGO_GROUP self
-  -- @return #CARGO_GROUP
-  function CARGO_GROUP:GetCount()
-    return self.CargoSet:Count()
-  end
-
-
-  --- Get the underlying GROUP object from the CARGO_GROUP.
-  -- @param #CARGO_GROUP self
-  -- @return #CARGO_GROUP
-  function CARGO_GROUP:GetGroup( Cargo )
-    local Cargo = Cargo or self:GetFirstAlive() -- Cargo.Cargo#CARGO
-    return Cargo.CargoObject:GetGroup()
-  end
-
-
-  --- Route Cargo to Coordinate and randomize locations.
-  -- @param #CARGO_GROUP self
-  -- @param Core.Point#COORDINATE Coordinate
-  function CARGO_GROUP:RouteTo( Coordinate )
-    --self:T( {Coordinate = Coordinate } )
-    
-    -- For each Cargo within the CargoSet, route each object to the Coordinate
-    self.CargoSet:ForEach(
-      function( Cargo )
-        Cargo.CargoObject:RouteGroundTo( Coordinate, 10, "vee", 0 )
-      end
-    )
-
-  end
-  
-  --- Check if Cargo is near to the Carrier.
-  -- The Cargo is near to the Carrier if the first unit of the Cargo Group is within NearRadius.
-  -- @param #CARGO_GROUP self
-  -- @param Wrapper.Group#GROUP CargoCarrier
-  -- @param #number NearRadius
-  -- @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:T( {NearRadius = NearRadius } )
-    
-    for _, Cargo in pairs( self.CargoSet:GetSet() ) do
-      local Cargo = Cargo -- Cargo.Cargo#CARGO
-      if Cargo:IsAlive() then
-        if Cargo:IsNear( CargoCarrier:GetCoordinate(), NearRadius ) then
-          self:T( "Near" )
-          return true
-        end
-      end
-    end
-    
-    return nil
-  end
-
-  --- Check if Cargo Group is in the radius for the Cargo to be Boarded.
-  -- @param #CARGO_GROUP self
-  -- @param Core.Point#COORDINATE Coordinate
-  -- @return #boolean true if the Cargo Group is within the load radius.
-  function CARGO_GROUP:IsInLoadRadius( Coordinate )
-    --self:T( { Coordinate } )
-  
-    local Cargo = self:GetFirstAlive() -- Cargo.Cargo#CARGO
-
-    if Cargo then
-      local Distance = 0
-      local CargoCoordinate
-      if Cargo:IsLoaded() then
-        CargoCoordinate = Cargo.CargoCarrier:GetCoordinate()
-      else
-        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:T( { Distance = Distance, LoadRadius = self.LoadRadius } )
-      if Distance <= self.LoadRadius then
-        return true
-      else
-        return false
-      end
-    end
-    
-    return nil
-  
-  end
-
-
-  --- Check if Cargo Group is in the report radius.
-  -- @param #CARGO_GROUP self
-  -- @param Core.Point#Coordinate Coordinate
-  -- @return #boolean true if the Cargo Group is within the report radius.
-  function CARGO_GROUP:IsInReportRadius( Coordinate )
-    --self:T( { Coordinate } )
-  
-    local Cargo = self:GetFirstAlive() -- Cargo.Cargo#CARGO
-
-    if Cargo then
-      self:T( { Cargo } )
-      local Distance = 0
-      if Cargo:IsUnLoaded() then
-        Distance = Coordinate:Get2DDistance( Cargo.CargoObject:GetCoordinate() )
-        --self:T( Distance )
-        if Distance <= self.LoadRadius then
-          return true
-        end
-      end
-    end
-    
-    return nil
-  
-  end
-
-
-  --- Signal a flare at the position of the CargoGroup.
-  -- @param #CARGO_GROUP self
-  -- @param Utilities.Utils#FLARECOLOR FlareColor
-  function CARGO_GROUP:Flare( FlareColor )
-
-    local Cargo = self.CargoSet:GetFirst() -- Cargo.Cargo#CARGO
-    if Cargo then
-      Cargo:Flare( FlareColor )
-    end
-  end
-  
-  --- Smoke the CargoGroup.
-  -- @param #CARGO_GROUP self
-  -- @param Utilities.Utils#SMOKECOLOR SmokeColor The color of the smoke.
-  -- @param #number Radius The radius of randomization around the center of the first element of the CargoGroup.
-  function CARGO_GROUP:Smoke( SmokeColor, Radius )
-
-    local Cargo = self.CargoSet:GetFirst() -- Cargo.Cargo#CARGO
-
-    if Cargo then
-      Cargo:Smoke( SmokeColor, Radius )
-    end
-  end
-  
-  --- Check if the first element of the CargoGroup is the given @{Core.Zone}.
-  -- @param #CARGO_GROUP self
-  -- @param Core.Zone#ZONE_BASE Zone
-  -- @return #boolean **true** if the first element of the CargoGroup is in the Zone
-  -- @return #boolean **false** if there is no element of the CargoGroup in the Zone.
-  function CARGO_GROUP:IsInZone( Zone )
-    --self:T( { Zone } )
-  
-    local Cargo = self.CargoSet:GetFirst() -- Cargo.Cargo#CARGO
-
-    if Cargo then
-      return Cargo:IsInZone( Zone )
-    end
-    
-    return nil
-  
-  end
-
-  --- Get the transportation method of the Cargo.
-  -- @param #CARGO_GROUP self
-  -- @return #string The transportation method of the Cargo.
-  function CARGO_GROUP:GetTransportationMethod()
-    if self:IsLoaded() then
-      return "for unboarding"
-    else
-      if self:IsUnLoaded() then
-        return "for boarding"
-      else
-        if self:IsDeployed() then
-          return "delivered"
-        end
-      end
-    end
-    return ""
-  end
-
-    
-
-end -- CARGO_GROUP
-

Moose Development/Moose/Cargo/CargoSlingload.lua

@@ -1,275 +0,0 @@
---- **Cargo** - Management of single cargo crates, which are based on a STATIC object. The cargo can only be slingloaded.
---
--- ===
--- 
--- ### [Demo Missions]()
--- 
--- ### [YouTube Playlist]()
--- 
--- ===
--- 
--- ### Author: **FlightControl**
--- ### Contributions: 
--- 
--- ===
--- 
--- @module Cargo.CargoSlingload
--- @image Cargo_Slingload.JPG
-
-
-do -- CARGO_SLINGLOAD
-
-  --- Models the behaviour of cargo crates, which can only be slingloaded. 
-  -- @type CARGO_SLINGLOAD
-  -- @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.
-  -- 
-  -- 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.
-  --
-  -- # Developer Note
-  -- 
-  -- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
-  -- Therefore, this class is considered to be deprecated
-  --
-  -- ===
-  -- 
-  -- @field #CARGO_SLINGLOAD
-  CARGO_SLINGLOAD = {
-    ClassName = "CARGO_SLINGLOAD"
-  }
-  
-  --- CARGO_SLINGLOAD Constructor.
-  -- @param #CARGO_SLINGLOAD self
-  -- @param Wrapper.Static#STATIC CargoStatic
-  -- @param #string Type
-  -- @param #string Name
-  -- @param #number LoadRadius (optional)
-  -- @param #number NearRadius (optional)
-  -- @return #CARGO_SLINGLOAD
-  function CARGO_SLINGLOAD:New( CargoStatic, Type, Name, LoadRadius, NearRadius )
-    local self = BASE:Inherit( self, CARGO_REPRESENTABLE:New( CargoStatic, Type, Name, nil, LoadRadius, NearRadius ) ) -- #CARGO_SLINGLOAD
-    self:T( { Type, Name, NearRadius } )
-  
-    self.CargoObject = CargoStatic
-  
-    -- Cargo objects are added to the _DATABASE and SET_CARGO objects.
-    _EVENTDISPATCHER:CreateEventNewCargo( self )
-    
-    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
-
-
-  -- @param #CARGO_SLINGLOAD self
-  -- @param Core.Event#EVENTDATA EventData 
-  function CARGO_SLINGLOAD:OnEventCargoDead( EventData )
-
-    local Destroyed = false
-  
-    if self:IsDestroyed() or self:IsUnLoaded() then
-      if self.CargoObject:GetName() == EventData.IniUnitName then
-        if not self.NoDestroy then 
-          Destroyed = true
-        end
-      end
-    end
-    
-    if Destroyed then
-      self:I( { "Cargo crate destroyed: " .. self.CargoObject:GetName() } )
-      self:Destroyed()
-    end
-  
-  end
-  
-  
-  --- Check if the cargo can be Slingloaded.
-  -- @param #CARGO_SLINGLOAD self
-  function CARGO_SLINGLOAD:CanSlingload()
-    return true
-  end
-  
-  --- Check if the cargo can be Boarded.
-  -- @param #CARGO_SLINGLOAD self
-  function CARGO_SLINGLOAD:CanBoard()
-    return false
-  end
-
-  --- Check if the cargo can be Unboarded.
-  -- @param #CARGO_SLINGLOAD self
-  function CARGO_SLINGLOAD:CanUnboard()
-    return false
-  end
-
-  --- Check if the cargo can be Loaded.
-  -- @param #CARGO_SLINGLOAD self
-  function CARGO_SLINGLOAD:CanLoad()
-    return false
-  end
-
-  --- Check if the cargo can be Unloaded.
-  -- @param #CARGO_SLINGLOAD self
-  function CARGO_SLINGLOAD:CanUnload()
-    return false
-  end
-
-
-  --- Check if Cargo Crate is in the radius for the Cargo to be reported.
-  -- @param #CARGO_SLINGLOAD self
-  -- @param Core.Point#COORDINATE Coordinate
-  -- @return #boolean true if the Cargo Crate is within the report radius.
-  function CARGO_SLINGLOAD:IsInReportRadius( Coordinate )
-    --self:T( { Coordinate, LoadRadius = self.LoadRadius } )
-  
-    local Distance = 0
-    if self:IsUnLoaded() then
-      Distance = Coordinate:Get2DDistance( self.CargoObject:GetCoordinate() )
-      if Distance <= self.LoadRadius then
-        return true
-      end
-    end
-    
-    return false
-  end
-
-
-  --- Check if Cargo Slingload is in the radius for the Cargo to be Boarded or Loaded.
-  -- @param #CARGO_SLINGLOAD self
-  -- @param Core.Point#COORDINATE Coordinate
-  -- @return #boolean true if the Cargo Slingload is within the loading radius.
-  function CARGO_SLINGLOAD:IsInLoadRadius( Coordinate )
-    --self:T( { Coordinate } )
-  
-    local Distance = 0
-    if self:IsUnLoaded() then
-      Distance = Coordinate:Get2DDistance( self.CargoObject:GetCoordinate() )
-      if Distance <= self.NearRadius then
-        return true
-      end
-    end
-    
-    return false
-  end
-
-
-
-  --- Get the current Coordinate of the CargoGroup.
-  -- @param #CARGO_SLINGLOAD self
-  -- @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_SLINGLOAD:GetCoordinate()
-    --self:T()
-    
-    return self.CargoObject:GetCoordinate()
-  end
-
-  --- Check if the CargoGroup is alive.
-  -- @param #CARGO_SLINGLOAD self
-  -- @return #boolean true if the CargoGroup is alive.
-  -- @return #boolean false if the CargoGroup is dead.
-  function CARGO_SLINGLOAD:IsAlive()
-
-    local Alive = true
-  
-    -- When the Cargo is Loaded, the Cargo is in the CargoCarrier, so we check if the CargoCarrier is alive.
-    -- When the Cargo is not Loaded, the Cargo is the CargoObject, so we check if the CargoObject is alive.
-    if self:IsLoaded() then
-      Alive = Alive == true and self.CargoCarrier:IsAlive()
-    else
-      Alive = Alive == true and self.CargoObject:IsAlive()
-    end 
-    
-    return Alive
-  
-  end
-
-  
-  --- Route Cargo to Coordinate and randomize locations.
-  -- @param #CARGO_SLINGLOAD self
-  -- @param Core.Point#COORDINATE Coordinate
-  function CARGO_SLINGLOAD:RouteTo( Coordinate )
-    --self:T( {Coordinate = Coordinate } )
-    
-  end
-
-  
-  --- Check if Cargo is near to the Carrier.
-  -- The Cargo is near to the Carrier within NearRadius.
-  -- @param #CARGO_SLINGLOAD 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.
-  function CARGO_SLINGLOAD:IsNear( CargoCarrier, NearRadius )
-    --self:T( {NearRadius = NearRadius } )
-    
-    return self:IsNear( CargoCarrier:GetCoordinate(), NearRadius )
-  end
-
-
-  --- Respawn the CargoGroup.
-  -- @param #CARGO_SLINGLOAD self
-  function CARGO_SLINGLOAD:Respawn()
-
-    --self:T( { "Respawning slingload " .. self:GetName() } )
-
-
-    -- Respawn the group...
-    if self.CargoObject then
-      self.CargoObject:ReSpawn() -- A cargo destroy crates a DEAD event.
-      self:__Reset( -0.1 )
-    end
-
-    
-  end
-
-
-  --- Respawn the CargoGroup.
-  -- @param #CARGO_SLINGLOAD self
-  function CARGO_SLINGLOAD:onafterReset()
-
-    --self:T( { "Reset slingload " .. self:GetName() } )
-
-
-    -- Respawn the group...
-    if self.CargoObject then
-      self:SetDeployed( false )
-      self:SetStartState( "UnLoaded" )
-      self.CargoCarrier = nil
-      -- Cargo objects are added to the _DATABASE and SET_CARGO objects.
-      _EVENTDISPATCHER:CreateEventNewCargo( self )
-    end
-
-    
-  end
-
-  --- Get the transportation method of the Cargo.
-  -- @param #CARGO_SLINGLOAD self
-  -- @return #string The transportation method of the Cargo.
-  function CARGO_SLINGLOAD:GetTransportationMethod()
-    if self:IsLoaded() then
-      return "for sling loading"
-    else
-      if self:IsUnLoaded() then
-        return "for sling loading"
-      else
-        if self:IsDeployed() then
-          return "delivered"
-        end
-      end
-    end
-    return ""
-  end
-   
-end

Moose Development/Moose/Cargo/CargoUnit.lua

@@ -1,395 +0,0 @@
---- **Cargo** - Management of single cargo logistics, which are based on a UNIT object.
---
--- ===
--- 
--- ### [Demo Missions]()
--- 
--- ### [YouTube Playlist]()
--- 
--- ===
--- 
--- ### Author: **FlightControl**
--- ### Contributions: 
--- 
--- ===
--- 
--- @module Cargo.CargoUnit
--- @image Cargo_Units.JPG
-
-do -- CARGO_UNIT
-
-  --- Models CARGO in the form of units, which can be boarded, unboarded, loaded, unloaded. 
-  -- @type 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.
-  -- 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.
-  --
-  -- # Developer Note
-  -- 
-  -- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
-  -- Therefore, this class is considered to be deprecated
-  --
-  -- ===
-  -- 
-  -- @field #CARGO_UNIT CARGO_UNIT
-  --
-  CARGO_UNIT = {
-    ClassName = "CARGO_UNIT"
-  }
-
-  --- CARGO_UNIT Constructor.
-  -- @param #CARGO_UNIT self
-  -- @param Wrapper.Unit#UNIT CargoUnit
-  -- @param #string Type
-  -- @param #string Name
-  -- @param #number Weight
-  -- @param #number LoadRadius (optional)
-  -- @param #number NearRadius (optional)
-  -- @return #CARGO_UNIT
-  function CARGO_UNIT:New( CargoUnit, Type, Name, LoadRadius, NearRadius )
-  
-    -- Inherit CARGO_REPRESENTABLE.
-    local self = BASE:Inherit( self, CARGO_REPRESENTABLE:New( CargoUnit, Type, Name, LoadRadius, NearRadius ) ) -- #CARGO_UNIT
-    
-    -- Debug info.
-    self:T({Type=Type, Name=Name, LoadRadius=LoadRadius, NearRadius=NearRadius})
-  
-    -- Set cargo object.
-    self.CargoObject = CargoUnit
-  
-    -- Set event prio.
-    self:SetEventPriority( 5 )
-  
-    return self
-  end
-  
-  --- Enter UnBoarding State.
-  -- @param #CARGO_UNIT self
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  -- @param Core.Point#COORDINATE ToPointVec2
-  -- @param #number NearRadius (optional) Defaut 25 m.
-  function CARGO_UNIT:onenterUnBoarding( From, Event, To, ToPointVec2, NearRadius )
-    self:T( { From, Event, To, ToPointVec2, NearRadius } )
-  
-    local Angle = 180
-    local Speed = 60
-    local DeployDistance = 9
-    local RouteDistance = 60
-  
-    if From == "Loaded" then
-  
-      if not self:IsDestroyed() then
-  
-        local CargoCarrier = self.CargoCarrier -- Wrapper.Controllable#CONTROLLABLE
-        
-        if CargoCarrier:IsAlive() then
-    
-          local CargoCarrierPointVec2 = CargoCarrier:GetPointVec2()
-          local CargoCarrierHeading = self.CargoCarrier:GetHeading() -- Get Heading of object in degrees.
-          local CargoDeployHeading = ( ( CargoCarrierHeading + Angle ) >= 360 ) and ( CargoCarrierHeading + Angle - 360 ) or ( CargoCarrierHeading + Angle )
-      
-      
-          local CargoRoutePointVec2 = CargoCarrierPointVec2:Translate( RouteDistance, CargoDeployHeading )
-          
-          
-          -- if there is no ToPointVec2 given, then use the CargoRoutePointVec2
-          local FromDirectionVec3 = CargoCarrierPointVec2:GetDirectionVec3( ToPointVec2 or CargoRoutePointVec2 )
-          local FromAngle = CargoCarrierPointVec2:GetAngleDegrees(FromDirectionVec3)
-          local FromPointVec2 = CargoCarrierPointVec2:Translate( DeployDistance, FromAngle )
-        --local CargoDeployPointVec2 = CargoCarrierPointVec2:GetRandomCoordinateInRadius( 10, 5 )
-  
-          ToPointVec2 = ToPointVec2 or CargoCarrierPointVec2:GetRandomCoordinateInRadius( NearRadius, DeployDistance )
-          
-          -- Respawn the group...
-          if self.CargoObject then
-            if CargoCarrier:IsShip() then
-              -- If CargoCarrier is a ship, we don't want to spawn the units in the water next to the boat. Use destination coord instead.
-              self.CargoObject:ReSpawnAt( ToPointVec2, CargoDeployHeading )
-            else
-              self.CargoObject:ReSpawnAt( FromPointVec2, CargoDeployHeading )
-            end
-            self:T( { "CargoUnits:", self.CargoObject:GetGroup():GetName() } )
-            self.CargoCarrier = nil
-      
-            local Points = {}
-            
-            -- From
-            Points[#Points+1] = FromPointVec2:WaypointGround( Speed, "Vee" )
-            
-            -- To
-            Points[#Points+1] = ToPointVec2:WaypointGround( Speed, "Vee" )
-        
-            local TaskRoute = self.CargoObject:TaskRoute( Points )
-            self.CargoObject:SetTask( TaskRoute, 1 )
-      
-            
-            self:__UnBoarding( 1, ToPointVec2, NearRadius )
-          end
-        else
-          -- the Carrier is dead. This cargo is dead too!
-          self:Destroyed()
-        end
-      end
-    end
-  
-  end
-  
-  --- Leave UnBoarding State.
-  -- @param #CARGO_UNIT self
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  -- @param Core.Point#COORDINATE ToPointVec2
-  -- @param #number NearRadius (optional) Defaut 100 m.
-  function CARGO_UNIT:onleaveUnBoarding( From, Event, To, ToPointVec2, NearRadius )
-    self:T( { From, Event, To, ToPointVec2, NearRadius } )
-  
-    local Angle = 180
-    local Speed = 10
-    local Distance = 5
-  
-    if From == "UnBoarding" then
-      --if self:IsNear( ToPointVec2, NearRadius ) then
-        return true
-      --else
-        
-        --self:__UnBoarding( 1, ToPointVec2, NearRadius )
-      --end
-      --return false
-    end
-  
-  end
-  
-  --- UnBoard Event.
-  -- @param #CARGO_UNIT self
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  -- @param Core.Point#COORDINATE ToPointVec2
-  -- @param #number NearRadius (optional) Defaut 100 m.
-  function CARGO_UNIT:onafterUnBoarding( From, Event, To, ToPointVec2, NearRadius )
-    self:T( { From, Event, To, ToPointVec2, NearRadius } )
-  
-    self.CargoInAir = self.CargoObject:InAir()
-  
-    self:T( self.CargoInAir )
-  
-    -- Only unboard the cargo when the carrier 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
-  
-    end
-  
-    self:__UnLoad( 1, ToPointVec2, NearRadius )
-  
-  end
-  
-  
-  
-  --- Enter UnLoaded State.
-  -- @param #CARGO_UNIT self
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  -- @param Core.Point#COORDINATE
-  function CARGO_UNIT:onenterUnLoaded( From, Event, To, ToPointVec2 )
-    self:T( { ToPointVec2, From, Event, To } )
-  
-    local Angle = 180
-    local Speed = 10
-    local Distance = 5
-  
-    if From == "Loaded" then
-      local StartPointVec2 = self.CargoCarrier:GetPointVec2()
-      local CargoCarrierHeading = self.CargoCarrier:GetHeading() -- Get Heading of object in degrees.
-      local CargoDeployHeading = ( ( CargoCarrierHeading + Angle ) >= 360 ) and ( CargoCarrierHeading + Angle - 360 ) or ( CargoCarrierHeading + Angle )
-      local CargoDeployCoord = StartPointVec2:Translate( Distance, CargoDeployHeading )
-  
-      ToPointVec2 = ToPointVec2 or COORDINATE:New( CargoDeployCoord.x, CargoDeployCoord.z )
-  
-      -- Respawn the group...
-      if self.CargoObject then
-        self.CargoObject:ReSpawnAt( ToPointVec2, 0 )
-        self.CargoCarrier = nil
-      end
-      
-    end
-  
-    if self.OnUnLoadedCallBack then
-      self.OnUnLoadedCallBack( self, unpack( self.OnUnLoadedParameters ) )
-      self.OnUnLoadedCallBack = nil
-    end
-  
-  end
-  
-  --- Board Event.
-  -- @param #CARGO_UNIT self
-  -- @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:T( { From, Event, To, CargoCarrier, NearRadius = NearRadius } )
-  
-    self.CargoInAir = self.CargoObject:InAir()
-    
-    local Desc = self.CargoObject:GetDesc()
-    local MaxSpeed = Desc.speedMaxOffRoad
-    local TypeName = Desc.typeName
-    
-    --self:T({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 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( -5, CargoCarrier, NearRadius, ... )
-            self.RunCount = 0
-          end
-        end
-      end
-  end
-  
-  
-  --- Boarding Event.
-  -- @param #CARGO_UNIT self
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  -- @param Wrapper.Client#CLIENT CargoCarrier
-  -- @param #number NearRadius Default 25 m.
-  function CARGO_UNIT:onafterBoarding( From, Event, To, CargoCarrier, NearRadius, ... )
-    self:T( { From, Event, To, CargoCarrier:GetName(), NearRadius = NearRadius } )
-    
-    self:T( { IsAlive=self.CargoObject:IsAlive() }  )
-    
-      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:T({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 )
-            
-              -- 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:T("Something is wrong")
-    end
-    
-  end
-  
-  
-  --- Loaded State.
-  -- @param #CARGO_UNIT self
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  -- @param Wrapper.Unit#UNIT CargoCarrier
-  function CARGO_UNIT:onenterLoaded( From, Event, To, CargoCarrier )
-    self:T( { From, Event, To, CargoCarrier } )
-  
-    self.CargoCarrier = CargoCarrier
-    
-    --self:T({Unit=self.CargoObject:GetName()})
-    
-    -- Only destroy the CargoObject if there is a CargoObject (packages don't have CargoObjects).
-    if self.CargoObject then
-      self.CargoObject:Destroy( false )
-      --self.CargoObject:ReSpawnAt( COORDINATE:NewFromVec2( {x=0,y=0} ), 0 )
-    end
-  end
-
-  --- Get the transportation method of the Cargo.
-  -- @param #CARGO_UNIT self
-  -- @return #string The transportation method of the Cargo.
-  function CARGO_UNIT:GetTransportationMethod()
-    if self:IsLoaded() then
-      return "for unboarding"
-    else
-      if self:IsUnLoaded() then
-        return "for boarding"
-      else
-        if self:IsDeployed() then
-          return "delivered"
-        end
-      end
-    end
-    return ""
-  end
-
-end -- CARGO_UNIT

Moose Development/Moose/Core/Astar.lua

@@ -157,8 +157,6 @@ ASTAR = {
 -- @field #number surfacetype Surface type.
 -- @field #table valid Cached valid/invalid nodes.
 -- @field #table cost Cached cost.
--- @field Core.Pathline#PATHLINE pathline Pathline that node is part of.
--- @field Core.Pathline#PATHLINE.Point pathpoint Pathline point.
 
 --- ASTAR infinity.
 -- @field #number INF
@@ -166,7 +164,7 @@ ASTAR.INF=1/0
 
 --- ASTAR class version.
 -- @field #string version
-ASTAR.version="0.5.0"
+ASTAR.version="0.4.0"
 
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 -- TODO list
@@ -174,7 +172,6 @@ ASTAR.version="0.5.0"
 
 -- TODO: Add more valid neighbour functions.
 -- TODO: Write docs.
--- DONE: Add pathlines for seach/valid neighbours.
 
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 -- Constructor
@@ -247,10 +244,7 @@ end
 function ASTAR:AddNode(Node)
 
   self.nodes[Node.id]=Node
-  self.Nnodes=self.Nnodes+1
-  
-  self:T3(self.lid..string.format("Adding node UID=%d", Node.id))
-  --Node.coordinate:MarkToAll(string.format("Node ID=%d", Node.id))
+  self.Nnodes=self.Nnodes+1 
     
   return self
 end
@@ -268,47 +262,6 @@ function ASTAR:AddNodeFromCoordinate(Coordinate)
   return node
 end
 
---- Adds nodes to the table of grid nodes from a PATHLINE.
--- @param #ASTAR self
--- @param Core.Pathline#PATHLINE Pathline Pathline or name of pathline. Has to exist.
--- @return #ASTAR self
-function ASTAR:AddNodeFromPathlineName(Pathline)
-
-  if type(Pathline)=="string" then
-    Pathline=PATHLINE:FindByName(Pathline)
-  end
-  
-  if Pathline then
-  
-    for i,_point in pairs(Pathline.points) do
-      local point=_point --Core.Pathline#PATHLINE.Point
-
-      -- Create node from point coordinate.
-      local node=self:AddNodeFromCoordinate(COORDINATE:NewFromVec3(point.vec3))
-      
-      -- Add pathline parameters.
-      node.pathline=Pathline
-      node.pathpoint=point
-      
-      -- Debug.
-      local name=node.pathline and node.pathline.name or "N/A"
-      local idx=node.pathline and node.pathline:_GetPointIndex(node.pathpoint) or "N/A"
-      
-      -- Debug message.
-      self:T(self.lid..string.format("Adding node UID=%d pathline=%s [%s]", node.id, name, tostring(idx)))
-            
-      -- Debug mark
-      --node.coordinate:MarkToAll(string.format("Node ID=%d\npathline=%s [%s]", node.id, name, tostring(idx)))
-      
-    end    
-    
-  else
-    env.error("FF error pathline")
-  end
-
-  return self
-end
-
 --- Check if the coordinate of a node has is at a valid surface type.
 -- @param #ASTAR self
 -- @param #ASTAR.Node Node The node to be added.
@@ -387,18 +340,6 @@ function ASTAR:SetValidNeighbourRoad(MaxDistance)
   return self
 end
 
---- Set valid neighbours to be on the same pathline or not further apart than 10 meters to jump from one pathline to another.
--- @param #ASTAR self
--- @param #number MaxDistance Max allowed distance between nodes of different pathlines in meters. Default is 10 m.
--- @return #ASTAR self
-function ASTAR:SetValidNeighbourPathline(MaxDistance)
-
-  self:SetValidNeighbourFunction(ASTAR.Pathline, MaxDistance)
-
-  return self
-end
-
-
 --- Set the function which calculates the "cost" to go from one to another node.
 -- The first to arguments of this function are always the two nodes under consideration. But you can add optional arguments.
 -- Very often the distance between nodes is a good measure for the cost.
@@ -443,7 +384,7 @@ end
 -- @return #ASTAR self
 function ASTAR:SetCostRoad()
 
-  self:SetCostFunction(ASTAR.Road)
+  self:SetCostFunction(ASTAR)
 
   return self
 end
@@ -603,55 +544,6 @@ function ASTAR.Road(nodeA, nodeB)
 
 end
 
---- Function to check if two nodes are on the same pathline or if nodes are less than 10 meters apart.
--- @param #ASTAR.Node nodeA First node.
--- @param #ASTAR.Node nodeB Other node.
--- @param #number distmax Max distance in meters. Default is 10 m.
--- @return #boolean If true, two nodes are connected.
-function ASTAR.Pathline(nodeA, nodeB, distmax)
-
-  distmax=distmax or 10
-
-  if nodeA.pathline.name==nodeB.pathline.name then
-  
-    -- Nodes are on the same pathline. We use the index to check if they are neighbours.
-  
-    local pathline=nodeA.pathline
-    
-    local idxA=pathline:_GetPointIndex(nodeA.pathpoint)
-    local idxB=pathline:_GetPointIndex(nodeB.pathpoint)
-    
-    if math.abs(idxA-idxB)<=1 then
-      return true
-    end
-    
-  else
-    
-    -- Check if nodeB is close to pathline of nodeA.
-    local c, dist, segA=nodeA.pathline:GetClosestPoint3D(nodeB.coordinate)
-    local seg=segA --Core.Pathline#PATHLINE.Segment
-    
-    if dist<distmax and (nodeA.pathpoint.uid==seg.p1.uid or nodeA.pathpoint.uid==seg.p2.uid) then
-      --env.info(string.format("FF NodeB=%d [pathline=%s] is close to NodeA=%d [pathline=%s] ==> valid neighbour", nodeB.id, nodeB.pathline.name, nodeA.id, nodeA.pathline.name))
-      return true
-    end
-
-
-    -- Check if nodeA is close to pathline of nodeB.
-    local c, dist, segB=nodeB.pathline:GetClosestPoint3D(nodeA.coordinate)
-    local seg=segB --Core.Pathline#PATHLINE.Segment
-
-    if dist<distmax and (nodeB.pathpoint.uid==seg.p1.uid or nodeB.pathpoint.uid==seg.p2.uid) then
-      --env.info(string.format("FF NodeA=%d [pathline=%s] is close to NodeB=%d [pathline=%s] ==> valid neighbour", nodeA.id, nodeA.pathline.name, nodeB.id, nodeB.pathline.name))
-      return true
-    end    
-    
-  end
-
-  return false
-end
-
-
 --- Function to check if distance between two nodes is less than a threshold distance.
 -- @param #ASTAR.Node nodeA First node.
 -- @param #ASTAR.Node nodeB Other node.
@@ -675,9 +567,7 @@ end
 -- @param #ASTAR.Node nodeB Other node.
 -- @return #number Distance between the two nodes.
 function ASTAR.Dist2D(nodeA, nodeB)
-  local dist=nodeA.coordinate:Get2DDistance(nodeB.coordinate)
-  --local text=string.format("FF Cost Dist2D NodeA=%d-->NodeB=%d = %.1f", nodeA.id, nodeB.id, dist)
-  --env.info(text)
+  local dist=nodeA.coordinate:Get2DDistance(nodeB)
   return dist
 end
 
@@ -704,7 +594,7 @@ function ASTAR.DistRoad(nodeA, nodeB)
     local dist=0
     
     for i=2,#path do
-      local b=path[i]   --DCS#Vec2
+      local b=path[i] --DCS#Vec2
       local a=path[i-1] --DCS#Vec2
       
       dist=dist+UTILS.VecDist2D(a,b)
@@ -714,6 +604,7 @@ function ASTAR.DistRoad(nodeA, nodeB)
     return dist
   end
   
+
   return math.huge
 end
 
@@ -723,11 +614,10 @@ end
 
 --- Find the closest node from a given coordinate.
 -- @param #ASTAR self
--- @param Core.Point#COORDINATE Coordinate Reference coordinate.
--- @param #table ExcludeNodes Table of nodes that are excluded.
--- @return #ASTAR.Node Closest node to the coordinate.
+-- @param Core.Point#COORDINATE Coordinate.
+-- @return #ASTAR.Node Cloest node to the coordinate.
 -- @return #number Distance to closest node in meters.
-function ASTAR:FindClosestNode(Coordinate, ExcludeNodes)
+function ASTAR:FindClosestNode(Coordinate)
 
   local distMin=math.huge
   local closeNode=nil
@@ -735,15 +625,11 @@ function ASTAR:FindClosestNode(Coordinate, ExcludeNodes)
   for _,_node in pairs(self.nodes) do
     local node=_node --#ASTAR.Node
     
-    if ExcludeNodes==nil or self:_IsNodeNotInTable(ExcludeNodes, node) then
+    local dist=node.coordinate:Get2DDistance(Coordinate)
     
-      local dist=node.coordinate:Get2DDistance(Coordinate)
-      
-      if dist<distMin then
-        distMin=dist
-        closeNode=node
-      end
-      
+    if dist<distMin then
+      distMin=dist
+      closeNode=node
     end
     
   end
@@ -751,162 +637,38 @@ function ASTAR:FindClosestNode(Coordinate, ExcludeNodes)
   return closeNode, distMin
 end
 
---- Find the closest pathline to a given reference coordinate.
--- @param #ASTAR self
--- @param Core.Point#COORDINATE Coordinate Reference coordinate.
--- @return Core.Pathline#PATHLINE Closest pathline
--- @return #number Distance in meters.
--- @return DCS#Vec3 Closest point on pathline to the ref coordinate.
--- @return Core.Pathline#PATHLINE.Segment Segment.
-function ASTAR:FindClosestPathline(Coordinate)
-
-  local pathline=nil --Core.Pathline#PATHLINE
-  local dist=math.huge
-  local vec3=nil
-  local S=nil
-  
-  for _,_node in pairs(self.nodes) do
-    local node=_node --#ASTAR.Node
-    
-    if node.pathline then
-    
-      local vec, d, s=node.pathline:GetClosestPoint3D(Coordinate)
-      
-      if d<dist then
-        pathline=node.pathline
-        dist=d
-        vec3=vec
-        S=s        
-      end
-    
-    end    
-  end
-  
-  if pathline then
-    -- Debug info.
-    self:T(self.lid..string.format("Closest pathline %s: dist=%.1f", pathline.name, dist))
-  end
-
-  return pathline, dist, vec3, S
-end
-
---- Find the closest node to the given coordinate.
--- @param #ASTAR self
--- @param Core.Point#COORDINATE Coord Reference coordinate.
--- @param #table ExcludeNodes Nodes that are excluded.
--- @return #ASTAR.Node The node that was fround
-function ASTAR:_FindClosestTerminalNode(Coord, ExcludeNodes)
-  
-  -- Find the closest pathline to the ref coordinate.
-  local pathline, dist, vec3, s=self:FindClosestPathline(Coord)
-
-  -- Find the closest node to the given start coordinate.
-  local node, dist2=self:FindClosestNode(Coord)
-  
-  if pathline and vec3 and dist and dist2>dist then
-
-    -- Create a node on the closest pathline so we first go straight there and then along the pathline.
-    local node=self:AddNodeFromCoordinate(COORDINATE:NewFromVec3(vec3))
-    
-    -- We also need the pathline point.    
-    local point=pathline:AddPointFromVec3(vec3, nil, s.p1)
-
-    node.pathline=pathline    
-    node.pathpoint=point
-    
-    self:T2(self.lid..string.format("Added new node=%d, which is closest to start coord. dist=%.1f m", node.id, dist))
-  end
-
-  -- Find the closest node to the given start coordinate.
-  local Node, dist3=self:FindClosestNode(Coord, ExcludeNodes)
-
-  -- Debug info.
-  self:T(self.lid..string.format("CLOSEST node ID=%d, distance=%.1f", Node.id, dist3))
-
-  return Node, dist3
-end
-
-
 --- Find the start node.
 -- @param #ASTAR self
+-- @param #ASTAR.Node Node The node to be added to the nodes table.
 -- @return #ASTAR self
 function ASTAR:FindStartNode()
+
+  local node, dist=self:FindClosestNode(self.startCoord)
   
-  -- Find the closest pathline to the 
-  local pathline, dist, vec3, s=self:FindClosestPathline(self.startCoord)
-
-  -- Find the closest node to the given start coordinate.
-  local node, dist2=self:FindClosestNode(self.startCoord)
+  self.startNode=node
   
-  if pathline and vec3 and dist and dist2>dist then
-
-    -- Create a node on the closest pathline so we first go straight there and then along the pathline.
-    local node=self:AddNodeFromCoordinate(COORDINATE:NewFromVec3(vec3))
-    
-    -- We also need the pathline point.    
-    local point=pathline:AddPointFromVec3(vec3, nil, s.p1)
-
-    node.pathline=pathline    
-    node.pathpoint=point
-    
-    self:T2(self.lid..string.format("Added new node=%d, which is closest to start coord. dist=%.1f m", node.id, dist))
+  if dist>1000 then
+    self:T(self.lid.."Adding start node to node grid!")
+    self:AddNode(node)
   end
-
-  -- Find the closest node to the given start coordinate.
-  self.startNode, dist2=self:FindClosestNode(self.startCoord)
-  
-  --self.startNode.coordinate:MarkToAll("Start Node")
-  
-  -- Debug info.
-  self:T(self.lid..string.format("START node ID=%d", self.startNode.id))
-  
-  -- Not sure why I did this. The node does not need to be added again as it is already contained in self.nodes!
-  --  if dist>1000 then
-  --    self:T(self.lid.."Adding start node to node grid!")
-  --    self:AddNode(node)
-  --  end
     
   return self
 end
 
---- Find the end node.
+--- Add a node.
 -- @param #ASTAR self
+-- @param #ASTAR.Node Node The node to be added to the nodes table.
 -- @return #ASTAR self
 function ASTAR:FindEndNode()
-  
-  local pathline, dist, vec3, s=self:FindClosestPathline(self.endCoord)
-  
-  -- Find the closest node to the given start coordinate.
-  local node, dist2=self:FindClosestNode(self.endCoord)  
-  
-  if pathline and vec3 and dist and dist2>dist then
 
-    -- Create a node on the closest pathline so we first go straight there and then along the pathline.
-    local node=self:AddNodeFromCoordinate(COORDINATE:NewFromVec3(vec3))
-        
-    -- We also need the point.
-    local point=pathline:AddPointFromVec3(vec3, nil, s.p1)
-    
-    -- Add pathline parameters to node.
-    node.pathline=pathline
-    node.pathpoint=point
-    
-    self:T2(self.lid..string.format("Added new node=%d, which is closest to END coord: dist=%.1f m", node.id, dist))
+  local node, dist=self:FindClosestNode(self.endCoord)
+
+  self.endNode=node
+  
+  if dist>1000 then
+    self:T(self.lid.."Adding end node to node grid!")
+    self:AddNode(node)
   end
-  
-  -- Find closest node to the end coordinate (exclude the start coordinate.
-  self.endNode, dist=self:FindClosestNode(self.endCoord, {self.startNode})
-  
-  --self.endNode.coordinate:MarkToAll("End Node")
-  
-  -- Debug info.
-  self:T(self.lid..string.format("END node ID=%d", self.endNode.id))
-  
-  -- Not sure why I did this. The node does not need to be added again as it is already contained in self.nodes!
-  --  if dist>1000 then
-  --    self:T(self.lid.."Adding end node to node grid!")
-  --    self:AddNode(node)
-  --  end
     
   return self
 end
@@ -922,21 +684,12 @@ end
 -- @return #table Table of nodes from start to finish.
 function ASTAR:GetPath(ExcludeStartNode, ExcludeEndNode)
 
---  self:FindStartNode()
---  self:FindEndNode()
-  
-  -- Find start Node (closest node to start coordinate).
-  self.startNode=self:_FindClosestTerminalNode(self.startCoord)
-  
-  -- Find end node, which is not the start node (excluded).
-  self.endNode=self:_FindClosestTerminalNode(self.endCoord, {self.startNode})
+  self:FindStartNode()
+  self:FindEndNode()
 
   local nodes=self.nodes
   local start=self.startNode
   local goal=self.endNode
-  
-  -- Debug info.
-  self:T(self.lid..string.format("GetPath Start Node=%d, End Node=%d", start.id, goal.id))
 
   -- Sets.
   local openset   = {}
@@ -993,12 +746,7 @@ function ASTAR:GetPath(ExcludeStartNode, ExcludeEndNode)
         text=text..string.format(", OS Time %.6f sec", dT)
       end
       text=text..string.format(", Nvalid=%d [%d cached]", self.nvalid, self.nvalidcache)
-      text=text..string.format(", Ncost=%d [%d cached]", self.ncost, self.ncostcache)      
-      text=text..string.format("\nNodes:")
-      for i,_node in ipairs(path) do
-        local node=_node --#ASTAR.Node
-        text=text..string.format("\n[%d] Node ID=%d", i, node.id)
-      end
+      text=text..string.format(", Ncost=%d [%d cached]", self.ncost, self.ncostcache)
       self:T(self.lid..text)
       
       return path
@@ -1011,16 +759,13 @@ function ASTAR:GetPath(ExcludeStartNode, ExcludeEndNode)
     
     -- Get neighbour nodes.
     local neighbors=self:_NeighbourNodes(current, nodes)
-
+    
     -- Loop over neighbours.
     for _,neighbor in pairs(neighbors) do
     
-      -- Node is not in closed set.
       if self:_NotIn(closedset, neighbor.id) then
       
-        -- Calculate tentative_g_score.
-        --local tentative_g_score=g_score[current.id] + self:_DistNodes(current, neighbor)
-        local tentative_g_score=g_score[current.id] + self:_HeuristicCost(current, neighbor)
+        local tentative_g_score=g_score[current.id]+self:_DistNodes(current, neighbor)
          
         if self:_NotIn(openset, neighbor.id) or tentative_g_score < g_score[neighbor.id] then
         
@@ -1048,73 +793,6 @@ function ASTAR:GetPath(ExcludeStartNode, ExcludeEndNode)
   return nil -- no valid path
 end
 
---- A* pathfinding function. This seaches the path along nodes between start and end nodes/coordinates. 
--- It automatically creates a PATHLINE object that is returned in combination with the nodes of the optimal path. 
--- @param #ASTAR self
--- @param #boolean ExcludeStartNode If *true*, do not include start node in found path. Default is to include it.
--- @param #boolean ExcludeEndNode If *true*, do not include end node in found path. Default is to include it.
--- @return Core.Pathline#PATHLINE Pathline.
--- @return #table Nodes of path.
-function ASTAR:GetPathline(ExcludeStartNode, ExcludeEndNode)
-
-  local nodes=self:GetPath(ExcludeStartNode, ExcludeEndNode)
-  
-  local pathline=nil --Core.Pathline#PATHLINE
-  if nodes then
-  
-    pathline=PATHLINE:New("Astar")
-  
-    for _,_node in pairs(nodes) do
-      local node=_node --#ASTAR.Node 
-      
-      local point=pathline:AddPointFromVec3(node.coordinate)
-      point.name=node.pathline.name
-          
-    end
-      
-  end
-
-  return pathline, nodes
-end
-
---- Get pathlines from nodes.
--- @param #ASTAR self
--- @param #table Nodes Given nodes.
--- @return #table Table of PATHLINES used in the path.
-function ASTAR:GetPathlinesFromNodes(Nodes)
-
-  local pathlines={}
-  
-  --for _,_node in pairs(Nodes or {}) do
-  for i=1,#Nodes do
-    local node=Nodes[i] --#ASTAR.Node
-    
-    -- Pathline.
-    local pathline=node.pathline
-    
-    if pathline and i>1 and i<#Nodes then
-      
-      -- Previous and next nodes.
-      local n=Nodes[i-1] --#ASTAR.Node
-      local N=Nodes[i+1] --#ASTAR.Node
-      
-      -- Check if previous and next nodes are on the same pathline.
-      -- If only one point in beteen is of another pathline, this is a junction and we dont actually switch to the other pathline.
-      if n.pathline and N.pathline and n.pathline.name==N.pathline.name and n.pathline.name~=pathline.name then
-        pathline=n.pathline
-      end
-      
-    end
-
-    -- We do not want to add the same pathline two times in a row.
-    if #pathlines==0 or (#pathlines>0 and pathlines[#pathlines].name~=pathline.name) then      
-      table.insert(pathlines, pathline)
-    end
-  end
-
-  return pathlines
-end
-
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 -- A* pathfinding helper functions
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
@@ -1133,18 +811,16 @@ function ASTAR:_HeuristicCost(nodeA, nodeB)
   local cost=nodeA.cost[nodeB.id]
   if cost~=nil then
     self.ncostcache=self.ncostcache+1
-    self:T(self.lid..string.format("Cost nodeA=%d --> nodeB=%d = %.1f (Cashed!)", nodeA.id, nodeB.id, cost))
     return cost
   end
 
+  local cost=nil
   if self.CostFunc then
     cost=self.CostFunc(nodeA, nodeB, unpack(self.CostArg))
   else
     cost=self:_DistNodes(nodeA, nodeB)
   end
   
-  self:T(self.lid..string.format("Cost nodeA=%d --> nodeB=%d = %.1f", nodeA.id, nodeB.id, cost))
-  
   nodeA.cost[nodeB.id]=cost
   nodeB.cost[nodeA.id]=cost  -- Symmetric problem. 
   
@@ -1158,10 +834,9 @@ end
 -- @return #boolean If true, transition between nodes is possible.
 function ASTAR:_IsValidNeighbour(node, neighbor)
 
-  -- Counter of function calls.
+  -- Counter.
   self.nvalid=self.nvalid+1
   
-  -- Check if neighbour is in cached set.
   local valid=node.valid[neighbor.id]
   if valid~=nil then
     --env.info(string.format("Node %d has valid=%s neighbour %d", node.id, tostring(valid), neighbor.id))
@@ -1169,16 +844,13 @@ function ASTAR:_IsValidNeighbour(node, neighbor)
     return valid
   end
 
-  -- Check if this is a valid neighbour.
   local valid=nil
   if self.ValidNeighbourFunc then
     valid=self.ValidNeighbourFunc(node, neighbor, unpack(self.ValidNeighbourArg))  
   else
-    -- If no valid neighbour function is defined, we assume all nodes are valid neighbours.
     valid=true
   end
 
-  -- Cache valid neighbour.
   node.valid[neighbor.id]=valid
   neighbor.valid[node.id]=valid  -- Symmetric problem. 
 
@@ -1212,9 +884,6 @@ function ASTAR:_LowestFscore(set, f_score)
     end
   end
   
-  -- Debug info.
-  self:T(self.lid..string.format("Lowest Fscore=%.1f, Node=%s", lowest, tostring(bestNode)))
-  
   return self.nodes[bestNode]
 end
 
@@ -1259,46 +928,16 @@ end
 -- @param #table map Map.
 -- @param #ASTAR.Node current_node The current node.
 -- @return #table Unwinded path.
-function ASTAR:_UnwindPath(flat_path, map, current_node)
+function ASTAR:_UnwindPath( flat_path, map, current_node )
 
-  local previous_node=map[current_node]
-
-  if previous_node then
-    table.insert(flat_path, 1, previous_node) 
-    return self:_UnwindPath(flat_path, map, previous_node)
+  if map [current_node] then
+    table.insert (flat_path, 1, map[current_node]) 
+    return self:_UnwindPath(flat_path, map, map[current_node])
   else
-    -- No previous node ==> return path.
     return flat_path
   end
 end
 
---- Function to check if a certain node is in a given table.
--- @param #ASTAR self
--- @param #table Nodes Nodes table.
--- @param #ASTAR.Node Node The node to check.
--- @return #boolean If true, the node is not in the set.
-function ASTAR:_IsNodeInTable(Nodes, Node)
-
-  for _,_node in pairs(Nodes) do
-    local node=_node --#ASTAR.Node
-    if node.id==Node.id then
-      return true
-    end
-  end
-
-  return false
-end
-
---- Function to check if a certain node is **not** in a given table.
--- @param #ASTAR self
--- @param #table Nodes Nodes table.
--- @param #ASTAR.Node Node The node to check.
--- @return #boolean If true, the node is not in the set.
-function ASTAR:_IsNodeNotInTable(Nodes, Node)
-  local is=self:_IsNodeInTable(Nodes, Node)
-  return not is
-end
-
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Moose Development/Moose/Core/Base.lua

@@ -974,7 +974,7 @@ do -- Scheduling
   -- @param #BASE self
   -- @param #number Start Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.
   -- @param #function SchedulerFunction The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
-  -- @param #table ... Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.
+  -- @param ... Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.
   -- @return #string The Schedule ID of the planned schedule.
   function BASE:ScheduleOnce( Start, SchedulerFunction, ... )
   

Moose Development/Moose/Core/Database.lua

@@ -872,6 +872,8 @@ end
 -- @return Wrapper.Group#GROUP The found GROUP.
 function DATABASE:FindGroup( GroupName )
 
+  if type(GroupName) ~= "string" or GroupName == "" then return end
+
   local GroupFound = self.GROUPS[GroupName]
   
   if GroupFound == nil and GroupName ~= nil and self.Templates.Groups[GroupName] == nil then
@@ -1110,7 +1112,7 @@ function DATABASE:_RegisterGroupTemplate( GroupTemplate, CoalitionSide, Category
           self:E("WARNING: Invalid STN "..tostring(UnitTemplate.AddPropAircraft.STN_L16).." for ".. UnitTemplate.name)
         else
           self.STNS[stn] = UnitTemplate.name
-          self:I("Register STN "..tostring(UnitTemplate.AddPropAircraft.STN_L16).." for ".. UnitTemplate.name)
+          self:T("Register STN "..tostring(UnitTemplate.AddPropAircraft.STN_L16).." for ".. UnitTemplate.name)
         end
       end
       if UnitTemplate.AddPropAircraft.SADL_TN then
@@ -1119,7 +1121,7 @@ function DATABASE:_RegisterGroupTemplate( GroupTemplate, CoalitionSide, Category
           self:E("WARNING: Invalid SADL "..tostring(UnitTemplate.AddPropAircraft.SADL_TN).." for ".. UnitTemplate.name)
         else
           self.SADL[sadl] = UnitTemplate.name
-          self:I("Register SADL "..tostring(UnitTemplate.AddPropAircraft.SADL_TN).." for ".. UnitTemplate.name)
+          self:T("Register SADL "..tostring(UnitTemplate.AddPropAircraft.SADL_TN).." for ".. UnitTemplate.name)
         end
       end  
     end
@@ -1380,7 +1382,7 @@ function DATABASE:GetCoalitionFromClientTemplate( ClientName )
   if self.Templates.ClientsByName[ClientName] then  
     return self.Templates.ClientsByName[ClientName].CoalitionID
   end
-  self:E("WARNING: Template does not exist for client "..tostring(ClientName))
+  self:T("WARNING: Template does not exist for client "..tostring(ClientName))
   return nil
 end
 
@@ -1392,7 +1394,7 @@ function DATABASE:GetCategoryFromClientTemplate( ClientName )
   if self.Templates.ClientsByName[ClientName] then  
     return self.Templates.ClientsByName[ClientName].CategoryID
   end
-  self:E("WARNING: Template does not exist for client "..tostring(ClientName))
+  self:T("WARNING: Template does not exist for client "..tostring(ClientName))
   return nil
 end
 
@@ -1404,7 +1406,7 @@ function DATABASE:GetCountryFromClientTemplate( ClientName )
   if self.Templates.ClientsByName[ClientName] then  
     return self.Templates.ClientsByName[ClientName].CountryID
   end
-  self:E("WARNING: Template does not exist for client "..tostring(ClientName))
+  self:T("WARNING: Template does not exist for client "..tostring(ClientName))
   return nil  
 end
 
@@ -1697,7 +1699,7 @@ function DATABASE:_EventOnBirth( Event )
       if PlayerName then
 
         -- Debug info.
-        self:I(string.format("Player '%s' joined unit '%s' of group '%s'", tostring(PlayerName), tostring(Event.IniDCSUnitName), tostring(Event.IniDCSGroupName)))
+        self:I(string.format("Player '%s' joined unit '%s' (%s) of group '%s'", tostring(PlayerName), tostring(Event.IniDCSUnitName), tostring(Event.IniTypeName), tostring(Event.IniDCSGroupName)))
               
         -- Add client in case it does not exist already.
         if client == nil or (client and client:CountPlayers() == 0) then

Moose Development/Moose/Core/Event.lua

@@ -1361,7 +1361,8 @@ function EVENT:onEvent( Event )
             Event.IniDynamicCargoName = Event.IniUnitName
             Event.IniPlayerName = string.match(Event.IniUnitName,"^(.+)|%d%d:%d%d|PKG%d+")
           else
-            Event.IniUnit = CARGO:FindByName( Event.IniDCSUnitName )
+            --Event.IniUnit = CARGO:FindByName( Event.IniDCSUnitName )
+            Event.IniUnit = STATIC:FindByName( Event.IniDCSUnitName, false )
           end
           Event.IniCoalition = Event.IniDCSUnit:getCoalition()
           Event.IniCategory = Event.IniDCSUnit:getDesc().category

Moose Development/Moose/Core/Fsm.lua

@@ -45,12 +45,6 @@
 -- By efficiently utilizing the FSM class and derived classes, MOOSE allows mission designers to quickly build processes.
 -- **Ready made FSM-based implementations classes** exist within the MOOSE framework that **can easily be re-used,
 -- and tailored** by mission designers through **the implementation of Transition Handlers**.
--- Each of these FSM implementation classes start either with:
---
---   * an acronym **AI\_**, which indicates a FSM implementation directing **AI controlled** @{Wrapper.Group#GROUP} and/or @{Wrapper.Unit#UNIT}. These AI\_ classes derive the @{#FSM_CONTROLLABLE} class.
---   * an acronym **TASK\_**, which indicates a FSM implementation executing a @{Tasking.Task#TASK} executed by Groups of players. These TASK\_ classes derive the @{#FSM_TASK} class.
---   * an acronym **ACT\_**, which indicates an Sub-FSM implementation, directing **Humans actions** that need to be done in a @{Tasking.Task#TASK}, seated in a @{Wrapper.Client#CLIENT} (slot) or a @{Wrapper.Unit#UNIT} (CA join). These ACT\_ classes derive the @{#FSM_PROCESS} class.
---
 -- Detailed explanations and API specifics are further below clarified and FSM derived class specifics are described in those class documentation sections.
 --
 -- ##__Disclaimer:__
@@ -61,7 +55,6 @@
 --
 -- The following derived classes are available in the MOOSE framework, that implement a specialized form of a FSM:
 --
---   * @{#FSM_TASK}: Models Finite State Machines for @{Tasking.Task}s.
 --   * @{#FSM_PROCESS}: Models Finite State Machines for @{Tasking.Task} actions, which control @{Wrapper.Client}s.
 --   * @{#FSM_CONTROLLABLE}: Models Finite State Machines for @{Wrapper.Controllable}s, which are @{Wrapper.Group}s, @{Wrapper.Unit}s, @{Wrapper.Client}s.
 --   * @{#FSM_SET}: Models Finite State Machines for @{Core.Set}s. Note that these FSMs control multiple objects!!! So State concerns here
@@ -78,7 +71,8 @@
 -- @image Core_Finite_State_Machine.JPG
 
 do -- FSM
-
+  
+  ---
   -- @type FSM
   -- @field #string ClassName Name of the class.
   -- @field Core.Scheduler#SCHEDULER CallScheduler Call scheduler.
@@ -117,11 +111,6 @@ do -- FSM
   -- By efficiently utilizing the FSM class and derived classes, MOOSE allows mission designers to quickly build processes.
   -- **Ready made FSM-based implementations classes** exist within the MOOSE framework that **can easily be re-used,
   -- and tailored** by mission designers through **the implementation of Transition Handlers**.
-  -- Each of these FSM implementation classes start either with:
-  --
-  --   * an acronym **AI\_**, which indicates an FSM implementation directing **AI controlled** @{Wrapper.Group#GROUP} and/or @{Wrapper.Unit#UNIT}. These AI\_ classes derive the @{#FSM_CONTROLLABLE} class.
-  --   * an acronym **TASK\_**, which indicates an FSM implementation executing a @{Tasking.Task#TASK} executed by Groups of players. These TASK\_ classes derive the @{#FSM_TASK} class.
-  --   * an acronym **ACT\_**, which indicates an Sub-FSM implementation, directing **Humans actions** that need to be done in a @{Tasking.Task#TASK}, seated in a @{Wrapper.Client#CLIENT} (slot) or a @{Wrapper.Unit#UNIT} (CA join). These ACT\_ classes derive the @{#FSM_PROCESS} class.
   --
   -- ![Transition Rules and Transition Handlers and Event Triggers](..\Presentations\FSM\Dia3.JPG)
   --

Moose Development/Moose/Core/MarkerOps_Base.lua

@@ -50,7 +50,7 @@ MARKEROPS_BASE = {
   ClassName = "MARKEROPS",
   Tag = "mytag",
   Keywords = {},
-  version = "0.1.3",
+  version = "0.1.4",
   debug = false,
   Casesensitive = true,
 }
@@ -154,14 +154,7 @@ function MARKEROPS_BASE:OnEventMark(Event)
       self:E("Skipping onEvent. Event or Event.idx unknown.")
       return true
     end
-    --position
-    local vec3={y=Event.pos.y, x=Event.pos.x, z=Event.pos.z}
-    local coord=COORDINATE:NewFromVec3(vec3)
-    if self.debug then
-      local coordtext = coord:ToStringLLDDM()
-      local text = tostring(Event.text)
-      local m = MESSAGE:New(string.format("Mark added at %s with text: %s",coordtext,text),10,"Info",false):ToAll()
-    end
+
     local coalition = Event.MarkCoalition
     -- decision
     if Event.id==world.event.S_EVENT_MARK_ADDED then
@@ -170,8 +163,14 @@ function MARKEROPS_BASE:OnEventMark(Event)
       local Eventtext = tostring(Event.text)
       if Eventtext~=nil then
         if self:_MatchTag(Eventtext) then
-         local matchtable = self:_MatchKeywords(Eventtext)
-         self:MarkAdded(Eventtext,matchtable,coord,Event.idx,coalition,Event.PlayerName,Event)
+          local coord=COORDINATE:NewFromVec3({y=Event.pos.y, x=Event.pos.x, z=Event.pos.z})
+          if self.debug then
+            local coordtext = coord:ToStringLLDDM()
+            local text = tostring(Event.text)
+            local m = MESSAGE:New(string.format("Mark added at %s with text: %s",coordtext,text),10,"Info",false):ToAll()
+          end
+          local matchtable = self:_MatchKeywords(Eventtext)
+          self:MarkAdded(Eventtext,matchtable,coord,Event.idx,coalition,Event.PlayerName,Event)
         end
       end
     elseif Event.id==world.event.S_EVENT_MARK_CHANGE then
@@ -180,8 +179,14 @@ function MARKEROPS_BASE:OnEventMark(Event)
       local Eventtext = tostring(Event.text)
       if Eventtext~=nil then
         if self:_MatchTag(Eventtext) then
-         local matchtable = self:_MatchKeywords(Eventtext)
-         self:MarkChanged(Eventtext,matchtable,coord,Event.idx,coalition,Event.PlayerName,Event)
+           local coord=COORDINATE:NewFromVec3({y=Event.pos.y, x=Event.pos.x, z=Event.pos.z})
+           if self.debug then
+              local coordtext = coord:ToStringLLDDM()
+              local text = tostring(Event.text)
+              local m = MESSAGE:New(string.format("Mark changed at %s with text: %s",coordtext,text),10,"Info",false):ToAll()
+           end
+           local matchtable = self:_MatchKeywords(Eventtext)
+           self:MarkChanged(Eventtext,matchtable,coord,Event.idx,coalition,Event.PlayerName,Event)
         end
       end
     elseif Event.id==world.event.S_EVENT_MARK_REMOVED then

Moose Development/Moose/Core/Message.lua

@@ -206,7 +206,7 @@ end
 function MESSAGE:ToGroup( Group, Settings )
   self:F( Group.GroupName )
 
-  if Group then
+  if Group and Group:IsAlive() then
 
     if self.MessageType then
       local Settings = Settings or (Group and _DATABASE:GetPlayerSettings( Group:GetPlayerName() )) or _SETTINGS -- Core.Settings#SETTINGS
@@ -231,7 +231,7 @@ end
 function MESSAGE:ToUnit( Unit, Settings )
   self:F( Unit.IdentifiableName )
 
-  if Unit then
+  if Unit and Unit:IsAlive() then
     
     if self.MessageType then
       local Settings = Settings or ( Unit and _DATABASE:GetPlayerSettings( Unit:GetPlayerName() ) ) or _SETTINGS -- Core.Settings#SETTINGS
@@ -452,7 +452,7 @@ end
 _MESSAGESRS = {}
 
 --- Set up MESSAGE generally to allow Text-To-Speech via SRS and TTS functions. `SetMSRS()` will try to use as many attributes configured with @{Sound.SRS#MSRS.LoadConfigFile}() as possible.
--- @param #string PathToSRS (optional) Path to SRS Folder, defaults to "C:\\\\Program Files\\\\DCS-SimpleRadio-Standalone" or your configuration file setting.
+-- @param #string PathToSRS (optional) Path to SRS TTS Folder, defaults to "C:\\\\Program Files\\\\DCS-SimpleRadio-Standalone\\ExternalAudio" or your configuration file setting.
 -- @param #number Port Port (optional) number of SRS, defaults to 5002 or your configuration file setting.
 -- @param #string PathToCredentials (optional) Path to credentials file for Google.
 -- @param #number Frequency Frequency in MHz. Can also be given as a #table of frequencies.
@@ -468,13 +468,13 @@ _MESSAGESRS = {}
 -- @usage
 --          -- Mind the dot here, not using the colon this time around!
 --          -- Needed once only
---          MESSAGE.SetMSRS("D:\\Program Files\\DCS-SimpleRadio-Standalone",5012,nil,127,radio.modulation.FM,"female","en-US",nil,coalition.side.BLUE)
+--          MESSAGE.SetMSRS("D:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio",5012,nil,127,radio.modulation.FM,"female","en-US",nil,coalition.side.BLUE)
 --          -- later on in your code
 --          MESSAGE:New("Test message!",15,"SPAWN"):ToSRS()
 --          
 function MESSAGE.SetMSRS(PathToSRS,Port,PathToCredentials,Frequency,Modulation,Gender,Culture,Voice,Coalition,Volume,Label,Coordinate,Backend)
   
-  _MESSAGESRS.PathToSRS = PathToSRS or MSRS.path or "C:\\Program Files\\DCS-SimpleRadio-Standalone"
+  _MESSAGESRS.PathToSRS = PathToSRS or MSRS.path or "C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio"
   
   _MESSAGESRS.frequency = Frequency or MSRS.frequencies or 243
   _MESSAGESRS.modulation = Modulation or MSRS.modulations or radio.modulation.AM
@@ -535,7 +535,7 @@ end
 -- @usage
 --          -- Mind the dot here, not using the colon this time around!
 --          -- Needed once only
---          MESSAGE.SetMSRS("D:\\Program Files\\DCS-SimpleRadio-Standalone",5012,nil,127,radio.modulation.FM,"female","en-US",nil,coalition.side.BLUE)
+--          MESSAGE.SetMSRS("D:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio",5012,nil,127,radio.modulation.FM,"female","en-US",nil,coalition.side.BLUE)
 --          -- later on in your code
 --          MESSAGE:New("Test message!",15,"SPAWN"):ToSRS()
 --          
@@ -567,7 +567,7 @@ end
 -- @usage
 --          -- Mind the dot here, not using the colon this time around!
 --          -- Needed once only
---          MESSAGE.SetMSRS("D:\\Program Files\\DCS-SimpleRadio-Standalone",5012,nil,127,radio.modulation.FM,"female","en-US",nil,coalition.side.BLUE)
+--          MESSAGE.SetMSRS("D:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio",5012,nil,127,radio.modulation.FM,"female","en-US",nil,coalition.side.BLUE)
 --          -- later on in your code
 --          MESSAGE:New("Test message!",15,"SPAWN"):ToSRSBlue()
 --          
@@ -589,7 +589,7 @@ end
 -- @usage
 --          -- Mind the dot here, not using the colon this time around!
 --          -- Needed once only
---          MESSAGE.SetMSRS("D:\\Program Files\\DCS-SimpleRadio-Standalone",5012,nil,127,radio.modulation.FM,"female","en-US",nil,coalition.side.RED)
+--          MESSAGE.SetMSRS("D:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio",5012,nil,127,radio.modulation.FM,"female","en-US",nil,coalition.side.RED)
 --          -- later on in your code
 --          MESSAGE:New("Test message!",15,"SPAWN"):ToSRSRed()
 --          
@@ -611,7 +611,7 @@ end
 -- @usage
 --          -- Mind the dot here, not using the colon this time around!
 --          -- Needed once only
---          MESSAGE.SetMSRS("D:\\Program Files\\DCS-SimpleRadio-Standalone",5012,nil,127,radio.modulation.FM,"female","en-US",nil,coalition.side.NEUTRAL)
+--          MESSAGE.SetMSRS("D:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio",5012,nil,127,radio.modulation.FM,"female","en-US",nil,coalition.side.NEUTRAL)
 --          -- later on in your code
 --          MESSAGE:New("Test message!",15,"SPAWN"):ToSRSAll()
 --          

Moose Development/Moose/Core/Pathline.lua

@@ -5,13 +5,11 @@
 --    * Path from A to B
 --    * Arbitrary number of points
 --    * Automatically from lines drawtool
---    * Draw line or mark points on F10 map
---    * Find closest points to path
 --
 -- ===
 --
 -- ### Author: **funkyfranky**
---
+-- 
 -- ===
 -- @module Core.Pathline
 -- @image CORE_Pathline.png
@@ -23,7 +21,6 @@
 -- @field #string lid Class id string for output to DCS log file.
 -- @field #string name Name of the path line.
 -- @field #table points List of 3D points defining the path.
--- @field #number counter Running number counting the point IDs.
 -- @extends Core.Base#BASE
 
 --- *The shortest distance between two points is a straight line.* -- Archimedes
@@ -31,30 +28,30 @@
 -- ===
 --
 -- # The PATHLINE Concept
---
+-- 
 -- List of points defining a path from A to B. The pathline can consist of multiple points. Each point holds the information of its position, the surface type, the land height
 -- and the water depth (if over sea).
---
+-- 
 -- Line drawings created in the mission editor are automatically registered as pathlines and stored in the MOOSE database.
 -- They can be accessed with the @{#PATHLINE.FindByName) function.
---
+-- 
 -- # Constructor
---
+-- 
 -- The @{PATHLINE.New) function creates a new PATHLINE object. This does not hold any points. Points can be added with the @{#PATHLINE.AddPointFromVec2} and @{#PATHLINE.AddPointFromVec3}
---
+-- 
 -- For a given table of 2D or 3D positions, a new PATHLINE object can be created with the @{#PATHLINE.NewFromVec2Array} or @{#PATHLINE.NewFromVec3Array}, respectively.
---
+-- 
 -- # Line Drawings
---
+-- 
 -- The most convenient way to create a pathline is the draw panel feature in the DCS mission editor. You can select "Line" and then "Segments", "Segment" or "Free" to draw your lines.
 -- These line drawings are then automatically added to the MOOSE database as PATHLINE objects and can be retrieved with the @{#PATHLINE.FindByName) function, where the name is the one
 -- you specify in the draw panel.
---
+-- 
 -- # Mark on F10 map
---
--- The ponints of the PATHLINE can be marked on the F10 map with the @{#PATHLINE.MarkPoints}(`true`) function. The mark points contain information of the surface type, land height and
+-- 
+-- The ponints of the PATHLINE can be marked on the F10 map with the @{#PATHLINE.MarkPoints}(`true`) function. The mark points contain information of the surface type, land height and 
 -- water depth.
---
+-- 
 -- To remove the marks, use @{#PATHLINE.MarkPoints}(`false`).
 --
 -- @field #PATHLINE
@@ -62,39 +59,27 @@ PATHLINE = {
   ClassName      = "PATHLINE",
   lid            =   nil,
   points         =    {},
-  counter        =     0,
 }
 
 --- Point of line.
 -- @type PATHLINE.Point
--- @field #number uid Unique ID of this point.
--- @field #string mother Name of the pathline this point belongs to.
--- @field #string name Name of this point.
 -- @field DCS#Vec3 vec3 3D position.
 -- @field DCS#Vec2 vec2 2D position.
 -- @field #number surfaceType Surface type.
 -- @field #number landHeight Land height in meters.
 -- @field #number depth Water depth in meters.
 -- @field #number markerID Marker ID.
--- @field #number lineID Marker of pathline ID.
-
---- Segment of line.
--- @type PATHLINE.Segment
--- @field #PATHLINE.Point p1 First point.
--- @field #PATHLINE.Point p2 Second point.
 
 
 --- PATHLINE class version.
 -- @field #string version
-PATHLINE.version="0.3.0"
+PATHLINE.version="0.1.1"
 
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 -- TODO list
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
--- TODO: Read/write to JSON file
--- TODO: Translate/rotate pathline
--- TODO: Add color.
+-- TODO: A lot...
 
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 -- Constructor
@@ -108,10 +93,10 @@ function PATHLINE:New(Name)
 
   -- Inherit everything from INTEL class.
   local self=BASE:Inherit(self, BASE:New()) --#PATHLINE
-
+  
   self.name=Name or "Unknown Path"
 
-  self.lid=string.format("PATHLINE %s | ", self.name)
+  self.lid=string.format("PATHLINE %s | ", Name)
 
   return self
 end
@@ -166,70 +151,41 @@ end
 --- Add a point to the path from a given 2D position. The third dimension is determined from the land height.
 -- @param #PATHLINE self
 -- @param DCS#Vec2 Vec2 The 2D vector (x,y) to add.
--- @param #number Index Index to add this point, *e.g.* 1 for first point or 2 for second point. Default is at the end.
--- @param #PATHLINE.Point Point Add point after given point. Default is at the end or at given index.
 -- @return #PATHLINE self
-function PATHLINE:AddPointFromVec2(Vec2, Index, Point)
+function PATHLINE:AddPointFromVec2(Vec2)
 
   if Vec2 then
-
-    -- Create a new point.
+  
     local point=self:_CreatePoint(Vec2)
 
-    if Index then
-      -- Add at given index.
-      table.insert(self.points, Index, point)
-    else
-      if Point then
-        -- Get index of given point.
-        local i=self:_GetPointIndex(Point)
-        -- Add new point after given point.
-        table.insert(self.points, i+1, point)
-      else
-        -- Add add the end.
-        table.insert(self.points, point)
-      end
-    end
+    table.insert(self.points, point)
+    
   end
-
+  
   return self
 end
 
 --- Add a point to the path from a given 3D position.
 -- @param #PATHLINE self
 -- @param DCS#Vec3 Vec3 The 3D vector (x,y) to add.
--- @param #number Index Index to add this point, *e.g.* 1 for first point or 2 for second point. Default is at the end.
--- @param #PATHLINE.Point Point Add point after given point. Default is at the end or at given index.
--- @return #PATHLINE.Point Point that was added.
-function PATHLINE:AddPointFromVec3(Vec3, Index, Point)
+-- @return #PATHLINE self
+function PATHLINE:AddPointFromVec3(Vec3)
 
   if Vec3 then
-
+  
     local point=self:_CreatePoint(Vec3)
 
-    if Index then
-      -- Add add given index.
-      table.insert(self.points, Index, point)
-    else
-      if Point then
-        local i=self:_GetPointIndex(Point)
-        table.insert(self.points, i+1, point)
-      else
-        -- Add add the end.
-        table.insert(self.points, point)
-      end
-    end
-
-    return point
+    table.insert(self.points, point)
+    
   end
-
-  return nil
+  
+  return self
 end
 
 --- Get name of pathline.
 -- @param #PATHLINE self
 -- @return #string Name of the pathline.
-function PATHLINE:GetName()
+function PATHLINE:GetName()  
   return self.name
 end
 
@@ -243,35 +199,18 @@ end
 
 --- Get points of pathline. Not that points are tables, that contain more information as just the 2D or 3D position but also the surface type etc.
 -- @param #PATHLINE self
--- @return #list <Core.Pathline#PATHLINE.Point> List of points.
-function PATHLINE:GetPoints()
+-- @return #list <#PATHLINE.Point> List of points.
+function PATHLINE:GetPoints()  
   return self.points
 end
 
---- Get segments of pathline.
--- @param #PATHLINE self
--- @return #list <Core.Pathline#PATHLINE.Segment> List of points.
-function PATHLINE:GetSetments()
-
-  local segments={}
-
-  for i=1,#self.points-1 do
-    local segment={} --#PATHLINE.Segment
-    segment.p1=self.points[i]
-    segment.p2=self.points[i+1]
-    table.insert(segments, segment)
-  end
-
-  return segments
-end
-
 --- Get 3D points of pathline.
 -- @param #PATHLINE self
--- @return #list <DCS#Vec3> List of DCS#Vec3 points.
+-- @return <DCS#Vec3> List of DCS#Vec3 points.
 function PATHLINE:GetPoints3D()
 
   local vecs={}
-
+  
   for _,_point in pairs(self.points) do
     local point=_point --#PATHLINE.Point
     table.insert(vecs, point.vec3)
@@ -282,11 +221,11 @@ end
 
 --- Get 2D points of pathline.
 -- @param #PATHLINE self
--- @return #list <DCS#Vec2> List of DCS#Vec2 points.
+-- @return <DCS#Vec2> List of DCS#Vec2 points.
 function PATHLINE:GetPoints2D()
 
   local vecs={}
-
+  
   for _,_point in pairs(self.points) do
     local point=_point --#PATHLINE.Point
     table.insert(vecs, point.vec2)
@@ -301,11 +240,11 @@ end
 function PATHLINE:GetCoordinates()
 
   local vecs={}
-
+  
   for _,_point in pairs(self.points) do
     local point=_point --#PATHLINE.Point
     local coord=COORDINATE:NewFromVec3(point.vec3)
-    table.insert(vecs, coord)
+    table.insert(vecs,coord)
   end
 
   return vecs
@@ -318,11 +257,11 @@ end
 function PATHLINE:GetPointFromIndex(n)
 
   local N=self:GetNumberOfPoints()
-
+  
   n=n or 1
 
   local point=nil --#PATHLINE.Point
-
+  
   if n>=1 and n<=N then
     point=self.points[n]
   else
@@ -339,11 +278,11 @@ end
 function PATHLINE:GetPoint3DFromIndex(n)
 
   local point=self:GetPointFromIndex(n)
-
+  
   if point then
     return point.vec3
   end
-
+  
   return nil
 end
 
@@ -354,11 +293,11 @@ end
 function PATHLINE:GetPoint2DFromIndex(n)
 
   local point=self:GetPointFromIndex(n)
-
+  
   if point then
     return point.vec2
   end
-
+  
   return nil
 end
 
@@ -366,314 +305,33 @@ end
 --- Mark points on F10 map.
 -- @param #PATHLINE self
 -- @param #boolean Switch If `true` or nil, set marks. If `false`, remove marks.
--- @return #PATHLINE self
+-- @return <DCS#Vec3> List of DCS#Vec3 points.
 function PATHLINE:MarkPoints(Switch)
-
   for i,_point in pairs(self.points) do
     local point=_point --#PATHLINE.Point
-
     if Switch==false then
-
+      
       if point.markerID then
-        UTILS.RemoveMark(point.markerID)
+        UTILS.RemoveMark(point.markerID, Delay)
       end
-
+      
     else
-
+    
       if point.markerID then
         UTILS.RemoveMark(point.markerID)
       end
-
+    
       point.markerID=UTILS.GetMarkID()
-
-      local text=string.format("Pathline %s: Point #%d [UID=%d]\nSurface Type=%d\nHeight=%.1f m\nDepth=%.1f m", self.name, i, point.uid, point.surfaceType, point.landHeight, point.depth)
-
+      
+      local text=string.format("Pathline %s: Point #%d\nSurface Type=%d\nHeight=%.1f m\nDepth=%.1f m", self.name, i, point.surfaceType, point.landHeight, point.depth)
+      
       trigger.action.markToAll(point.markerID, text, point.vec3, "")
-
+    
     end
   end
-
-  return self
 end
 
 
---- Draw line on F10 map.
--- @param #PATHLINE self
--- @param #boolean Switch If `true` or nil, draw pathline. If `false`, remove drawing.
--- @param #number Coalition Coalition side. Default -1 for all.
--- @param #table Color RGB color and alpha `{r, g, b, a}`. Default {0, 1, 0, 0.5}.
--- @param #number LineType Line type. Default 1=solid.
--- @return #PATHLINE self
-function PATHLINE:Draw(Switch, Coalition, Color, LineType)
-
-  Coalition=Coalition or -1
-  Color=Color or {0, 1, 0, 0.5}
-  LineType=LineType or 1
-
-  if Switch==false then
-
-    for i,_point in pairs(self.points) do
-      local point=_point --#PATHLINE.Point
-
-      if point.lineID then
-        UTILS.RemoveMark(point.lineID)
-      end
-
-    end
-
-  else
-
-    for i=2,#self.points do
-
-      local p1=self.points[i-1] --#PATHLINE.Point
-      local p2=self.points[i]   --#PATHLINE.Point
-
-      if p2.lineID then
-        UTILS.RemoveMark(p2.lineID)
-      end
-
-      p2.lineID=UTILS.GetMarkID()
-
-      trigger.action.lineToAll(Coalition, p2.lineID, p1.vec3, p2.vec3, Color, LineType)
-
-    end
-
-  end
-
-  return self
-end
-
---- Get the closest point on the pathline for a given reference point.
--- @param #PATHLINE self
--- @param DCS#Vec2 Vec2 Reference Point in 2D.
--- @return DCS#Vec2 Cloest point on pathline.
--- @return #number Distance from closest point to ref point in meters.
--- @return #PATHLINE.Segment Closest segment of ref point.
-function PATHLINE:GetClosestPoint2D(Vec2)
-
-  local P=nil --DCS#Vec2
-  local D=math.huge
-  local S={} --#PATHLINE.Segment
-
-  for i=2,#self.points do
-
-    local A=self.points[i-1] --#PATHLINE.Point
-    local B=self.points[i]   --#PATHLINE.Point
-
-    local a=A.vec2
-    local b=B.vec2
-
-    local ab=UTILS.Vec2Substract(b, a)
-    local ap=UTILS.Vec2Substract(Vec2, a)
-
-    local proj=UTILS.Vec2Dot(ap, ab)
-
-    local lab=UTILS.Vec2Norm(ab)
-
-    local f=proj/lab/lab
-
-    -- Debug info.
-    local text=string.format("FF Proj=%.1f, |ab|=%.1f, f=%.1f", proj, lab, f)
-    self:T(self.lid..text)
-
-    -- Cases for finite segment.
-    local p=nil --DCS#Vec2
-    if f<0 then
-      p=a
-    elseif f>1 then
-      p=b
-    else
-      local r=UTILS.Vec2Mult(ab, f)
-      p=UTILS.Vec2Add(a, r)
-    end
-
-    -- Distance.
-    local d=UTILS.VecDist2D(p, Vec2)
-
-    if d<=D then
-      D=d
-      P=p
-      S.p1=A
-      S.p2=B
-    end
-
-  end
-
-  return P, D, S
-end
-
---- Get the closest point on the pathline for a given reference point.
--- This point does not necessarily is a node of the pathline. In general it will be somewhere in between the nodes defining the pathline.
--- @param #PATHLINE self
--- @param DCS#Vec3 Vec3 Reference Point in 3D. Can also be a `COORDINATE`.
--- @return DCS#Vec3 Closest point on pathline.
--- @return #number Distance from closest point to ref point in meters.
--- @return #PATHLINE.Segment Closest segment of ref point.
-function PATHLINE:GetClosestPoint3D(Vec3)
-
-  local P=nil --DCS#Vec3
-  local D=math.huge
-  local S={} --#PATHLINE.Segment
-
-  if not Vec3 then
-    self:E(self.lid.."ERROR: input Vec3 is nil!")
-    return nil, nil, nil
-  end
-
-  for i=2,#self.points do
-
-    local A=self.points[i-1] --#PATHLINE.Point
-    local B=self.points[i]   --#PATHLINE.Point
-
-    local a=A.vec3
-    local b=B.vec3
-
-    local ab=UTILS.VecSubstract(b, a)
-    local ap=UTILS.VecSubstract(Vec3, a)
-
-    local proj=UTILS.VecDot(ap, ab)
-
-    local lab=UTILS.VecNorm(ab)
-
-    local f=proj/lab/lab
-
-    -- Debug info.
-    self:T(self.lid..string.format("Proj=%.1f, |ab|=%.1f, f=%.1f", proj, lab, f))
-
-    -- Cases for finite segment.
-    local p=nil --DCS#Vec2
-    if f<0 then
-      p=a
-    elseif f>1 then
-      p=b
-    else
-      local r=UTILS.VecMult(ab, f)
-      p=UTILS.VecAdd(a, r)
-    end
-
-    -- Distance.
-    local d=UTILS.VecDist3D(p, Vec3)
-
-    if d<=D then
-      D=d
-      P=p
-      S.p1=A
-      S.p2=B
-    end
-
-  end
-
-  return P, D, S
-end
-
-
---- Write PATHLINE to JSON file.
--- **NOTE**: Requires `io` and `lfs` to be de-sanitized!
--- @param #PATHLINE self
--- @param #string FileName Name of the file. Default is the name of the pathline.
--- @return #PATHLINE self
-function PATHLINE:WriteJSON(FileName)
-
-  if io and lfs then
-
-    -- JSON script.
-    local json=loadfile("Scripts\\JSON.lua")()
-
-    local data={}
-
-    -- We store the name and the points.
-    data.name=self.name
-    data.points=self.points
-    for i,_point in pairs(self.points) do
-      local point=_point --#PATHLINE.Point
-      --point.markerID=nil
-    end
-
-    -- Encode data to raw JSON. Encode converts a lua table into JSON string that can be written to file.
-    local raw_json=json:encode(data)
-
-    -- Debug data.
-    self:T(data)
-
-    -- Write in "User/Saved Games/" Folder.
-    local filepath=lfs.writedir() .. FileName
-
-    -- Open file for writing.
-    local f = io.open(filepath, "wb")
-    if f then
-      f:write(raw_json)
-      f:close()
-      self:T(self.lid .. string.format("Saving PATHLINE %s file %s", self.name, tostring(filepath)))
-    else
-      self:E(self.lid .. string.format( "ERROR: Could not save PATHLINE to file %s", tostring(filepath)))
-    end
-
-  else
-    self:E(self.lid .. string.format( "ERROR: Could not save results because IO and/or LFS are not de-sanitized!"))
-  end
-
-end
-
---- Read PATHLINE from JSON file.
--- **NOTE**: Requires `io` and `lfs` to be de-sanitized!
--- @param #PATHLINE self
--- @param #string FileName Name of the file.
--- @return #PATHLINE self
-function PATHLINE:NewFromJSON(FileName)
-
-  if io and lfs then
-
-    -- JSON script.
-    local json=loadfile("Scripts\\JSON.lua")()
-
-    local data={}
-
-    -- Write in "User/Saved Games/" Folder.
-    local filepath=lfs.writedir() .. FileName
-
-    --env.info(filepath)
-
-    -- Open file in binary mode for reading.
-    local f = io.open(filepath, "rb")
-    if f then
-      data = f:read("*all")
-      f:close()
-    else
-      env.info(string.format("WARNING: Could not load PATHLINE from file %s!", tostring(filepath)))
-      return nil
-    end
-
-    -- Decode JSON data to get a lua table.
-    local data=json:decode(data)
-
-    if data and data.name then
-
-      -- Create a new pathline instance.
-      local self=PATHLINE:New(data.name)
-
-      for i=1,#data.points do
-        local point=data.points[i] --#PATHLINE.Point
-
-        -- Create new point from data.
-        local p=self:AddPointFromVec3(point.vec3)
-
-        -- Set name.
-        p.name=point.name
-
-        -- Remove marker ID.
-        p.markerID=nil
-      end
-
-      return self
-    else
-      BASE:E("ERROR: Cannot find pathline name in data from JSON file. File may be corrupted!")
-    end
-  else
-    BASE:E("ERROR: IO and/or LFS not de-sanitized! Cannot read file.")
-  end
-
-end
-
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 -- Private functions
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
@@ -681,56 +339,32 @@ end
 --- Get 3D points of pathline.
 -- @param #PATHLINE self
 -- @param DCS#Vec3 Vec Position vector. Can also be a DCS#Vec2 in which case the altitude at landheight is taken.
--- @return #PATHLINE.Point Pathline Point.
+-- @return #PATHLINE.Point
 function PATHLINE:_CreatePoint(Vec)
 
   local point={} --#PATHLINE.Point
 
-  self.counter=self.counter+1
-
-  point.uid=self.counter
-  point.mother=self.name
-
-  point.name=string.format("%s #%d", self.name, point.uid)
-
   if Vec.z then
     -- Given vec is 3D
     point.vec3=UTILS.DeepCopy(Vec)
     point.vec2={x=Vec.x, y=Vec.z}
   else
-    -- Given vec is 2D
+    -- Given vec is 2D  
     point.vec2=UTILS.DeepCopy(Vec)
     point.vec3={x=Vec.x, y=land.getHeight(Vec), z=Vec.y}
   end
 
   -- Get surface type.
   point.surfaceType=land.getSurfaceType(point.vec2)
-
+  
   -- Get land height and depth.
   point.landHeight, point.depth=land.getSurfaceHeightWithSeabed(point.vec2)
-
+  
   point.markerID=nil
 
   return point
 end
 
---- Get index of point in the lua table.
--- @param #PATHLINE self
--- @param #PATHLINE.Point Point Given point.
--- @return #number index
-function PATHLINE:_GetPointIndex(Point)
-
-  for i,_point in pairs(self.points) do
-    local point=_point --#PATHLINE.Point
-
-    if point.uid==Point.uid then
-      return i
-    end
-
-  end
-
-  return nil
-end
 
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Moose Development/Moose/Core/Point.lua

@@ -25,7 +25,7 @@
 
 do -- COORDINATE
   
-  ---
+  --- Coordinate class
   -- @type COORDINATE
   -- @field #string ClassName Name of the class
   -- @field #number x Component of the 3D vector.
@@ -59,6 +59,10 @@ do -- COORDINATE
   --   * @{#COORDINATE.SmokeOrange}(): To smoke the point in orange.
   --   * @{#COORDINATE.SmokeWhite}(): To smoke the point in white.
   --   * @{#COORDINATE.SmokeGreen}(): To smoke the point in green.
+  --   * @{#COORDINATE.SetSmokeOffsetDirection}(): To set an offset point direction for smoke.
+  --   * @{#COORDINATE.SetSmokeOffsetDistance}(): To set an offset point distance for smoke.
+  --   * @{#COORDINATE.SwitchSmokeOffsetOn}(): To set an offset point for smoke to on.
+  --   * @{#COORDINATE.SwitchSmokeOffsetOff}(): To set an offset point for smoke to off.
   --
   -- ## 2.2) Flare
   --
@@ -453,23 +457,6 @@ do -- COORDINATE
   end
 
 
-  --- Returns the coordinate from the latitude and longitude given in degrees, minutes and seconds (DMS).
-  -- @param #COORDINATE self
-  -- @param #string Latitude Latitude in DMS as string, e.g. "`42° 24' 14.3"`". Not that the characters `°`, `'` and `"` are important.
-  -- @param #string Longitude Longitude in DMS as string, e.g. "`42° 24' 14.3"`". Not that the characters `°`, `'` and `"` are important.
-  -- @param #number Altitude (Optional) Altitude in meters. Default is the land height at the coordinate.
-  -- @return #COORDINATE
-  function COORDINATE:NewFromLLDMS(Latitude, Longitude, Altitude)
-  
-    local lat=UTILS.LLDMSstringToDD(Latitude)
-    local lon=UTILS.LLDMSstringToDD(Longitude)
-    
-    self=COORDINATE:NewFromLLDD(lat, lon, Altitude)
-  
-    return self
-  end  
-
-
   --- Returns if the 2 coordinates are at the same 2D position.
   -- @param #COORDINATE self
   -- @param #COORDINATE Coordinate
@@ -678,7 +665,7 @@ do -- COORDINATE
     local _,_,_,_,_,scenerys=self:ScanObjects(radius, false, false, true)
 
     local set={}
-    
+
     for _,_scenery in pairs(scenerys) do
       local scenery=_scenery --DCS#Object
 
@@ -790,7 +777,9 @@ do -- COORDINATE
   -- @return DCS#Vec2 Vec2
   function COORDINATE:GetRandomVec2InRadius( OuterRadius, InnerRadius )
     self:F2( { OuterRadius, InnerRadius } )
-
+    math.random()
+    math.random()
+    math.random()
     local Theta = 2 * math.pi * math.random()
     local Radials = math.random() + math.random()
     if Radials > 1 then
@@ -850,6 +839,26 @@ do -- COORDINATE
     return land.getHeight( Vec2 )
   end
 
+  --- Returns a table of DCS#Vec3 points representing the terrain profile between two points.
+  -- @param #COORDINATE self
+  -- @param Destination DCS#Vec3 Ending point of the profile.
+  -- @return #table DCS#Vec3 table of the profile
+  function COORDINATE:GetLandProfileVec3(Destination)
+    return land.profile(self:GetVec3(), Destination)
+  end
+
+  --- Returns a table of #COORDINATE representing the terrain profile between two points.
+  -- @param #COORDINATE self
+  -- @param Destination #COORDINATE Ending coordinate of the profile.
+  -- @return #table #COORDINATE table of the profile
+  function COORDINATE:GetLandProfileCoordinates(Destination)
+    local points = self:GetLandProfileVec3(Destination:GetVec3())
+    local coords = {}
+    for _, point in ipairs(points) do
+      table.insert(coords, COORDINATE:NewFromVec3(point))
+    end
+    return coords
+  end
 
   --- Set the heading of the coordinate, if applicable.
   -- @param #COORDINATE self
@@ -2135,14 +2144,112 @@ do -- COORDINATE
   end
 
 
-  --- Smokes the point in a color.
+  --- Create colored smoke the point. The smoke we last up to 5 min (DCS limitation) but you can optionally specify a shorter duration or stop it manually.
   -- @param #COORDINATE self
-  -- @param Utilities.Utils#SMOKECOLOR SmokeColor
-  -- @param #string name (Optional) Name if you want to stop the smoke early (normal duration: 5mins)
-  function COORDINATE:Smoke( SmokeColor, name )
-    self:F2( { SmokeColor } )
-    self.firename = name or "Smoke-"..math.random(1,100000)
-    trigger.action.smoke( self:GetVec3(), SmokeColor, self.firename )
+  -- @param #number SmokeColor Color of smoke, e.g. `SMOKECOLOR.Green` for green smoke.
+  -- @param #number Duration (Optional) Duration of the smoke in seconds. DCS stopps the smoke automatically after 5 min.
+  -- @param #number Delay (Optional) Delay before the smoke is started in seconds.
+  -- @param #string Name (Optional) Name if you want to stop the smoke early (normal duration: 5mins)
+  -- @param #boolean Offset (Optional) If true, offset the smokle a bit.
+  -- @param #number Direction (Optional) If Offset is true this is the direction of the offset, 1-359 (degrees). Default random.
+  -- @param #number Distance (Optional) If Offset is true this is the distance of the offset in meters. Default random 10-20.
+  -- @return #COORDINATE self
+  function COORDINATE:Smoke( SmokeColor, Duration, Delay, Name, Offset,Direction,Distance)
+    self:F2( { SmokeColor, Name, Duration, Delay, Offset } )
+
+    SmokeColor=SmokeColor or SMOKECOLOR.Green
+    
+    if Delay and Delay>0 then
+      self:ScheduleOnce(Delay, COORDINATE.Smoke, self, SmokeColor, Duration, 0, Name, Direction,Distance)
+    else
+    
+      -- Create a name which is used to stop the smoke manually
+      self.firename = Name or "Smoke-"..math.random(1,100000)
+      
+      -- Create smoke
+      if Offset or self.SmokeOffset then
+        local Angle = Direction or self:GetSmokeOffsetDirection()
+        local Distance = Distance or self:GetSmokeOffsetDistance()
+        local newpos = self:Translate(Distance,Angle,true,false)
+        local newvec3 = newpos:GetVec3()
+        trigger.action.smoke( newvec3, SmokeColor, self.firename )
+      else
+        trigger.action.smoke( self:GetVec3(), SmokeColor, self.firename )
+      end
+      
+      -- Stop smoke
+      if Duration and Duration>0 then
+        self:ScheduleOnce(Duration, COORDINATE.StopSmoke, self, self.firename )
+      end
+    end
+    
+    return self
+  end
+  
+  --- Get the offset direction when using `COORDINATE:Smoke()`.
+  -- @param #COORDINATE self
+  -- @return #number Direction in degrees.
+  function COORDINATE:GetSmokeOffsetDirection()
+    local direction = self.SmokeOffsetDirection or math.random(1,359)
+    return direction
+  end
+  
+  --- Set the offset direction when using `COORDINATE:Smoke()`.
+  -- @param #COORDINATE self
+  -- @param #number Direction (Optional) This is the direction of the offset, 1-359 (degrees). Default random.
+  -- @return #COORDINATE self
+  function COORDINATE:SetSmokeOffsetDirection(Direction)
+    if self then
+      self.SmokeOffsetDirection = Direction or math.random(1,359)
+      return self
+    else
+      COORDINATE.SmokeOffsetDirection = Direction or math.random(1,359)
+    end
+  end
+  
+  --- Get the offset distance when using `COORDINATE:Smoke()`.
+  -- @param #COORDINATE self
+  -- @return #number Distance Distance in meters.
+  function COORDINATE:GetSmokeOffsetDistance()
+    local distance = self.SmokeOffsetDistance or math.random(10,20)
+    return distance
+  end
+  
+  --- Set the offset distance when using `COORDINATE:Smoke()`.
+  -- @param #COORDINATE self
+  -- @param #number Distance (Optional) This is the distance of the offset in meters. Default random 10-20.
+  -- @return #COORDINATE self
+  function COORDINATE:SetSmokeOffsetDistance(Distance)
+    if self then
+      self.SmokeOffsetDistance = Distance or math.random(10,20)
+      return self
+    else
+      COORDINATE.SmokeOffsetDistance = Distance or math.random(10,20)
+    end
+  end
+  
+  --- Set the offset on when using `COORDINATE:Smoke()`.
+  -- @param #COORDINATE self
+  -- @return #COORDINATE self
+  function COORDINATE:SwitchSmokeOffsetOn()
+    if self then
+      self.SmokeOffset = true
+      return self
+    else
+      COORDINATE.SmokeOffset = true
+    end
+  end
+  
+  --- Set the offset off when using `COORDINATE:Smoke()`.
+  -- @param #COORDINATE self
+  -- @return #COORDINATE self
+  function COORDINATE:SwitchSmokeOffsetOff()
+    if self then
+      self.SmokeOffset = false
+      return self
+    else
+      COORDINATE.SmokeOffset = false
+    end
   end
 
   --- Stops smoking the point in a color.
@@ -2154,49 +2261,83 @@ do -- COORDINATE
 
   --- Smoke the COORDINATE Green.
   -- @param #COORDINATE self
-  function COORDINATE:SmokeGreen()
-    self:F2()
-    self:Smoke( SMOKECOLOR.Green )
+  -- @param #number Duration (Optional) Duration of the smoke in seconds. DCS stopps the smoke automatically after 5 min.
+  -- @param #number Delay (Optional) Delay before the smoke is started in seconds.
+  -- @return #COORDINATE self
+  function COORDINATE:SmokeGreen(Duration, Delay)
+    self:Smoke( SMOKECOLOR.Green, Duration, Delay )
+    return self
   end
 
   --- Smoke the COORDINATE Red.
   -- @param #COORDINATE self
-  function COORDINATE:SmokeRed()
-    self:F2()
-    self:Smoke( SMOKECOLOR.Red )
+  -- @param #number Duration (Optional) Duration of the smoke in seconds. DCS stopps the smoke automatically after 5 min.
+  -- @param #number Delay (Optional) Delay before the smoke is started in seconds.
+  -- @return #COORDINATE self
+  function COORDINATE:SmokeRed(Duration, Delay)
+    self:Smoke( SMOKECOLOR.Red, Duration, Delay )
+    return self    
   end
 
   --- Smoke the COORDINATE White.
   -- @param #COORDINATE self
-  function COORDINATE:SmokeWhite()
-    self:F2()
-    self:Smoke( SMOKECOLOR.White )
+  -- @param #number Duration (Optional) Duration of the smoke in seconds. DCS stopps the smoke automatically after 5 min.
+  -- @param #number Delay (Optional) Delay before the smoke is started in seconds.
+  -- @return #COORDINATE self 
+  function COORDINATE:SmokeWhite(Duration, Delay)
+    self:Smoke( SMOKECOLOR.White, Duration, Delay )
+    return self    
   end
 
   --- Smoke the COORDINATE Orange.
   -- @param #COORDINATE self
-  function COORDINATE:SmokeOrange()
-    self:F2()
-    self:Smoke( SMOKECOLOR.Orange )
+  -- @param #number Duration (Optional) Duration of the smoke in seconds. DCS stopps the smoke automatically after 5 min.
+  -- @param #number Delay (Optional) Delay before the smoke is started in seconds.
+  -- @return #COORDINATE self
+  function COORDINATE:SmokeOrange(Duration, Delay)
+    self:Smoke( SMOKECOLOR.Orange, Duration, Delay )
+    return self    
   end
 
   --- Smoke the COORDINATE Blue.
   -- @param #COORDINATE self
-  function COORDINATE:SmokeBlue()
-    self:F2()
-    self:Smoke( SMOKECOLOR.Blue )
+  -- @param #number Duration (Optional) Duration of the smoke in seconds. DCS stopps the smoke automatically after 5 min.
+  -- @param #number Delay (Optional) Delay before the smoke is started in seconds.
+  -- @return #COORDINATE self
+  function COORDINATE:SmokeBlue(Duration, Delay)
+    self:Smoke( SMOKECOLOR.Blue, Duration, Delay )
+    return self    
   end
 
   --- Big smoke and fire at the coordinate.
   -- @param #COORDINATE self
-  -- @param Utilities.Utils#BIGSMOKEPRESET preset Smoke preset (1=small smoke and fire, 2=medium smoke and fire, 3=large smoke and fire, 4=huge smoke and fire, 5=small smoke, 6=medium smoke, 7=large smoke, 8=huge smoke).
-  -- @param #number density (Optional) Smoke density. Number in [0,...,1]. Default 0.5.
-  -- @param #string name (Optional) Name of the fire to stop it later again if not using the same COORDINATE object. Defaults to "Fire-" plus a random 5-digit-number.
-  function COORDINATE:BigSmokeAndFire( preset, density, name )
-    self:F2( { preset=preset, density=density } )
-    density=density or 0.5
-    self.firename = name or "Fire-"..math.random(1,10000)
-    trigger.action.effectSmokeBig( self:GetVec3(), preset, density, self.firename )
+  -- @param #number Preset Smoke preset (1=small smoke and fire, 2=medium smoke and fire, 3=large smoke and fire, 4=huge smoke and fire, 5=small smoke, 6=medium smoke, 7=large smoke, 8=huge smoke).
+  -- @param #number Density (Optional) Smoke density. Number in [0,...,1]. Default 0.5.
+  -- @param #number Duration (Optional) Duration of the smoke and fire in seconds.
+  -- @param #number Delay (Optional) Delay before the smoke and fire is started in seconds.
+  -- @param #string Name (Optional) Name of the fire to stop it later again if not using the same COORDINATE object. Defaults to "Fire-" plus a random 5-digit-number.
+  -- @return #COORDINATE self
+  function COORDINATE:BigSmokeAndFire( Preset, Density, Duration, Delay, Name )
+    self:F2( { preset=Preset, density=Density } )
+    
+    Preset=Preset or BIGSMOKEPRESET.SmallSmokeAndFire    
+    Density=Density or 0.5
+    
+    if Delay and Delay>0 then
+      self:ScheduleOnce(Delay, COORDINATE.BigSmokeAndFire, self, Preset, Density, Duration, 0, Name)
+    else
+    
+      self.firename = Name or "Fire-"..math.random(1,10000)
+      
+      trigger.action.effectSmokeBig( self:GetVec3(), Preset, Density, self.firename )
+      
+      -- Stop smoke
+      if Duration and Duration>0 then
+        self:ScheduleOnce(Duration, COORDINATE.StopBigSmokeAndFire, self, self.firename )
+      end      
+    end
+    
+    return self
   end
   
   --- Stop big smoke and fire at the coordinate.
@@ -2209,82 +2350,98 @@ do -- COORDINATE
 
   --- Small smoke and fire at the coordinate.
   -- @param #COORDINATE self
-  -- @param #number density (Optional) Smoke density. Number between 0 and 1. Default 0.5.
-  -- @param #string name (Optional) Name of the fire to stop it later again if not using the same COORDINATE object. Defaults to "Fire-" plus a random 5-digit-number.
-  function COORDINATE:BigSmokeAndFireSmall( density, name )
-    self:F2( { density=density } )
-    density=density or 0.5
-    self:BigSmokeAndFire(BIGSMOKEPRESET.SmallSmokeAndFire, density, name)
+  -- @param #number Density (Optional) Smoke density. Number between 0 and 1. Default 0.5.
+  -- @param #number Duration (Optional) Duration of the smoke and fire in seconds.
+  -- @param #number Delay (Optional) Delay before the smoke and fire is started in seconds.
+  -- @param #string Name (Optional) Name of the fire to stop it later again if not using the same COORDINATE object. Defaults to "Fire-" plus a random 5-digit-number.
+  -- @return #COORDINATE self
+  function COORDINATE:BigSmokeAndFireSmall( Density, Duration, Delay, Name )
+    self:BigSmokeAndFire(BIGSMOKEPRESET.SmallSmokeAndFire, Density, Duration, Delay, Name)
+    return self
   end
 
   --- Medium smoke and fire at the coordinate.
   -- @param #COORDINATE self
   -- @param #number density (Optional) Smoke density. Number between 0 and 1. Default 0.5.
+  -- @param #number Duration (Optional) Duration of the smoke and fire in seconds.
+  -- @param #number Delay (Optional) Delay before the smoke and fire is started in seconds.
   -- @param #string name (Optional) Name of the fire to stop it later again if not using the same COORDINATE object. Defaults to "Fire-" plus a random 5-digit-number.
-  function COORDINATE:BigSmokeAndFireMedium( density, name )
-    self:F2( { density=density } )
-    density=density or 0.5
-    self:BigSmokeAndFire(BIGSMOKEPRESET.MediumSmokeAndFire, density, name)
+  -- @return #COORDINATE self
+  function COORDINATE:BigSmokeAndFireMedium( Density, Duration, Delay, Name )
+    self:BigSmokeAndFire(BIGSMOKEPRESET.MediumSmokeAndFire, Density, Duration, Delay, Name)
+    return self    
   end
 
   --- Large smoke and fire at the coordinate.
   -- @param #COORDINATE self
   -- @param #number density (Optional) Smoke density. Number between 0 and 1. Default 0.5.
+  -- @param #number Duration (Optional) Duration of the smoke and fire in seconds.
+  -- @param #number Delay (Optional) Delay before the smoke and fire is started in seconds.
   -- @param #string name (Optional) Name of the fire to stop it later again if not using the same COORDINATE object. Defaults to "Fire-" plus a random 5-digit-number.
-  function COORDINATE:BigSmokeAndFireLarge( density, name )
-    self:F2( { density=density } )
-    density=density or 0.5
-    self:BigSmokeAndFire(BIGSMOKEPRESET.LargeSmokeAndFire, density, name)
+  -- @return #COORDINATE self
+  function COORDINATE:BigSmokeAndFireLarge( Density, Duration, Delay, Name )
+    self:BigSmokeAndFire(BIGSMOKEPRESET.LargeSmokeAndFire, Density, Duration, Delay, Name)
+    return self
   end
 
   --- Huge smoke and fire at the coordinate.
   -- @param #COORDINATE self
   -- @param #number density (Optional) Smoke density. Number between 0 and 1. Default 0.5.
+  -- @param #number Duration (Optional) Duration of the smoke and fire in seconds.
+  -- @param #number Delay (Optional) Delay before the smoke and fire is started in seconds.
   -- @param #string name (Optional) Name of the fire to stop it later again if not using the same COORDINATE object. Defaults to "Fire-" plus a random 5-digit-number.
-  function COORDINATE:BigSmokeAndFireHuge( density, name )
-    self:F2( { density=density } )
-    density=density or 0.5
-    self:BigSmokeAndFire(BIGSMOKEPRESET.HugeSmokeAndFire, density, name)
+  -- @return #COORDINATE self
+  function COORDINATE:BigSmokeAndFireHuge( Density, Duration, Delay, Name )
+    self:BigSmokeAndFire(BIGSMOKEPRESET.HugeSmokeAndFire, Density, Duration, Delay, Name)
+    return self
   end
 
   --- Small smoke at the coordinate.
   -- @param #COORDINATE self
   -- @param #number density (Optional) Smoke density. Number between 0 and 1. Default 0.5.
+  -- @param #number Duration (Optional) Duration of the smoke and fire in seconds.
+  -- @param #number Delay (Optional) Delay before the smoke and fire is started in seconds.
   -- @param #string name (Optional) Name of the fire to stop it later again if not using the same COORDINATE object. Defaults to "Fire-" plus a random 5-digit-number.
-  function COORDINATE:BigSmokeSmall( density, name )
-    self:F2( { density=density } )
-    density=density or 0.5
-    self:BigSmokeAndFire(BIGSMOKEPRESET.SmallSmoke, density, name)
+  -- @return #COORDINATE self
+  function COORDINATE:BigSmokeSmall( Density, Duration, Delay, Name )
+    self:BigSmokeAndFire(BIGSMOKEPRESET.SmallSmoke, Density, Duration, Delay, Name)
+    return self
   end
 
   --- Medium smoke at the coordinate.
   -- @param #COORDINATE self
   -- @param number density (Optional) Smoke density. Number between 0 and 1. Default 0.5.
+  -- @param #number Duration (Optional) Duration of the smoke and fire in seconds.
+  -- @param #number Delay (Optional) Delay before the smoke and fire is started in seconds.
   -- @param #string name (Optional) Name of the fire to stop it later again if not using the same COORDINATE object. Defaults to "Fire-" plus a random 5-digit-number.
-  function COORDINATE:BigSmokeMedium( density, name )
-    self:F2( { density=density } )
-    density=density or 0.5
-    self:BigSmokeAndFire(BIGSMOKEPRESET.MediumSmoke, density, name)
+  -- @return #COORDINATE self
+  function COORDINATE:BigSmokeMedium( Density, Duration, Delay, Name )
+    self:BigSmokeAndFire(BIGSMOKEPRESET.MediumSmoke, Density, Duration, Delay, Name)
+    return self
   end
 
   --- Large smoke at the coordinate.
   -- @param #COORDINATE self
   -- @param #number density (Optional) Smoke density. Number between 0 and 1. Default 0.5.
+  -- @param #number Duration (Optional) Duration of the smoke and fire in seconds.
+  -- @param #number Delay (Optional) Delay before the smoke and fire is started in seconds.
   -- @param #string name (Optional) Name of the fire to stop it later again if not using the same COORDINATE object. Defaults to "Fire-" plus a random 5-digit-number.
-  function COORDINATE:BigSmokeLarge( density, name )
-    self:F2( { density=density } )
-    density=density or 0.5
-    self:BigSmokeAndFire(BIGSMOKEPRESET.LargeSmoke, density,name)
+  -- @return #COORDINATE self
+  function COORDINATE:BigSmokeLarge( Density, Duration, Delay, Name )
+    self:BigSmokeAndFire(BIGSMOKEPRESET.LargeSmoke, Density, Duration, Delay, Name)
+    return self
   end
 
   --- Huge smoke at the coordinate.
   -- @param #COORDINATE self
   -- @param #number density (Optional) Smoke density. Number between 0 and 1. Default 0.5.
+  -- @param #number Duration (Optional) Duration of the smoke and fire in seconds.
+  -- @param #number Delay (Optional) Delay before the smoke and fire is started in seconds.
   -- @param #string name (Optional) Name of the fire to stop it later again if not using the same COORDINATE object. Defaults to "Fire-" plus a random 5-digit-number.
-  function COORDINATE:BigSmokeHuge( density, name )
-    self:F2( { density=density } )
-    density=density or 0.5
-    self:BigSmokeAndFire(BIGSMOKEPRESET.HugeSmoke, density,name)
+  -- @return #COORDINATE self
+  function COORDINATE:BigSmokeHuge( Density, Duration, Delay, Name )
+    self:BigSmokeAndFire(BIGSMOKEPRESET.HugeSmoke, Density, Duration, Delay, Name)
+    return self
   end
 
   --- Flares the point in a color.
@@ -2938,8 +3095,10 @@ do -- COORDINATE
       local sunrise=UTILS.GetSunRiseAndSet(DayOfYear, Latitude, Longitude, true, Tdiff)
       local sunset=UTILS.GetSunRiseAndSet(DayOfYear, Latitude, Longitude, false, Tdiff)
       
-      if sunrise == "N/R" then return false end
-      if sunrise == "N/S" then return true end
+      if type(sunrise) == "string" or type(sunset) == "string" then
+        if sunrise == "N/R" then return false end
+        if sunset == "N/S" then return true end
+      end
       
       local time=UTILS.ClockToSeconds(clock)
 
@@ -2957,6 +3116,11 @@ do -- COORDINATE
 
       -- Todays sun set in sec.
       local sunset=self:GetSunset(true)
+      
+      if type(sunrise) == "string" or type(sunset) == "string" then
+        if sunrise == "N/R" then return false end
+        if sunset == "N/S" then return true end
+      end
 
       -- Seconds passed since midnight.
       local time=UTILS.SecondsOfToday()
@@ -3655,7 +3819,26 @@ do -- COORDINATE
   function COORDINATE:GetRandomPointVec3InRadius( OuterRadius, InnerRadius )
     return COORDINATE:NewFromVec3( self:GetRandomVec3InRadius( OuterRadius, InnerRadius ) )
   end
-  
+
+
+--- Search for clear zones in a given area. A powerful and efficient function using Disposition to find clear areas for spawning ground units avoiding trees, water and map scenery.
+-- @param #number SearchRadius Radius of the search area.
+-- @param #number PosRadius Required clear radius around each position.
+-- @param #number NumPositions Number of positions to find.
+-- @return #table A table of Core.Point#COORDINATE that are clear of map objects within the given PosRadius. nil if no positions are found.
+  function COORDINATE:GetSimpleZones(SearchRadius, PosRadius, NumPositions)
+    local clearPositions = UTILS.GetSimpleZones(self:GetVec3(), SearchRadius, PosRadius, NumPositions)
+    if clearPositions and #clearPositions > 0 then
+        local coords = {}
+        for _, pos in pairs(clearPositions) do
+          local coord = COORDINATE:NewFromVec2(pos)
+          table.insert(coords, coord)
+        end
+        return coords
+    end
+    return nil
+  end
+
 end
 
 do 

Moose Development/Moose/Core/ScheduleDispatcher.lua

@@ -175,7 +175,7 @@ function SCHEDULEDISPATCHER:AddSchedule( Scheduler, ScheduleFunction, ScheduleAr
     local Name = Info.name or "?"
 
     local ErrorHandler = function( errmsg )
-      env.info( "Error in timer function: " .. errmsg )
+      env.info( "Error in timer function: " .. errmsg or "" )
       if BASE.Debug ~= nil then
         env.info( BASE.Debug.traceback() )
       end
@@ -326,7 +326,7 @@ function SCHEDULEDISPATCHER:Stop( Scheduler, CallID )
     local Schedule = self.Schedule[Scheduler][CallID] -- #SCHEDULEDISPATCHER.ScheduleData
 
     -- Only stop when there is a ScheduleID defined for the CallID. So, when the scheduler was stopped before, do nothing.
-    if Schedule.ScheduleID then
+    if Schedule and Schedule.ScheduleID then
 
       self:T( string.format( "SCHEDULEDISPATCHER stopping scheduler CallID=%s, ScheduleID=%s", tostring( CallID ), tostring( Schedule.ScheduleID ) ) )
 

Moose Development/Moose/Core/Set.lua

@@ -958,7 +958,26 @@ do -- SET_BASE
 
     return ObjectNames
   end
+  
+    --- Get a *new* set table that only contains alive objects.
+  -- @param #SET_BASE self
+  -- @return #table Set table of alive objects.
+  function SET_BASE:GetAliveSet()
+    --self:F2()
 
+    local AliveSet = {}
+    -- Clean the Set before returning with only the alive Objects.
+    for ObjectName, Object in pairs( self.Set ) do
+      if Object then
+        if Object:IsAlive() then
+          AliveSet[#AliveSet+1] = Object
+        end
+      end
+    end
+
+    return AliveSet or {}
+  end
+  
 end
 
 do 
@@ -1125,25 +1144,25 @@ do
     
   end
   
-  --- Get a *new* set that only contains alive groups.
+  --- Get a *new* set table that only contains alive groups.
   -- @param #SET_GROUP self
-  -- @return #SET_GROUP Set of alive groups.
+  -- @return #table Set of alive groups.
   function SET_GROUP:GetAliveSet()
     --self:F2()
 
-    local AliveSet = SET_GROUP:New()
-
+    --local AliveSet = SET_GROUP:New()
+    local AliveSet = {}
     -- Clean the Set before returning with only the alive Groups.
     for GroupName, GroupObject in pairs( self.Set ) do
       local GroupObject = GroupObject -- Wrapper.Group#GROUP
       if GroupObject then
         if GroupObject:IsAlive() then
-          AliveSet:Add( GroupName, GroupObject )
+          AliveSet[GroupName] = GroupObject
         end
       end
     end
 
-    return AliveSet.Set or {}
+    return AliveSet or {}
   end
 
   --- Returns a report of of unit types.
@@ -2595,18 +2614,16 @@ do -- SET_UNIT
   
   --- Gets the alive set.
   -- @param #SET_UNIT self
-  -- @return #table Table of SET objects
+  -- @return #table Table of alive UNIT objects
   -- @return #SET_UNIT AliveSet 
   function SET_UNIT:GetAliveSet()
 
     local AliveSet = SET_UNIT:New()
 
     -- Clean the Set before returning with only the alive Groups.
-    for GroupName, GroupObject in pairs(self.Set) do    
-      local GroupObject=GroupObject --Wrapper.Client#CLIENT
-      
+    for GroupName, GroupObject in pairs(self.Set) do       
       if GroupObject and GroupObject:IsAlive() then      
-        AliveSet:Add(GroupName, GroupObject)
+        AliveSet[GroupName] = GroupObject
       end
     end
 
@@ -4784,18 +4801,16 @@ do -- SET_CLIENT
   -- @return #table Table of SET objects
   function SET_CLIENT:GetAliveSet()
 
-    local AliveSet = SET_CLIENT:New()
+    local AliveSet = {}
 
     -- Clean the Set before returning with only the alive Groups.
-    for GroupName, GroupObject in pairs(self.Set) do    
-      local GroupObject=GroupObject --Wrapper.Client#CLIENT
-      
+    for GroupName, GroupObject in pairs(self.Set) do      
       if GroupObject and GroupObject:IsAlive() then      
-        AliveSet:Add(GroupName, GroupObject)
+        AliveSet[GroupName] = GroupObject
       end
     end
 
-    return AliveSet.Set or {}
+    return AliveSet or {}
   end
 
   --- [User] Add a custom condition function.
@@ -6676,6 +6691,8 @@ do -- SET_ZONE
   --          
   --          -- Stop watching after 1 hour
   --          zoneset:__TriggerStop(3600)
+  --          -- Call :SetPartlyInside() on any zone (or SET_ZONE) if you want GROUPs to count as inside when any of their units enters even if they are far apart.
+  --          -- Make sure to call :SetPartlyInside() before :Trigger()!.
   function SET_ZONE:Trigger(Objects)
     --self:I("Added Set_Zone Trigger")
     self:AddTransition("*","TriggerStart","TriggerRunning")
@@ -6690,6 +6707,7 @@ do -- SET_ZONE
     else
       self.objectset = {Objects}
     end
+    
     self:_TriggerCheck(true)
     self:__TriggerRunCheck(self.Checktime)
     return self
@@ -6726,6 +6744,20 @@ do -- SET_ZONE
     -- @param Core.Zone#ZONE_BASE Zone The zone left.
   end
   
+  --- Toggle “partly-inside” handling for every zone in the set when those zones are used with :Trigger().
+  -- * Call with no argument or **true** → enable for all.  
+  -- * Call with **false** → disable again (handy if it was enabled before).
+  -- @param #SET_ZONE self
+  -- @return #SET_ZONE self
+  function SET_ZONE:SetPartlyInside(state)
+    for _,Zone in pairs(self.Set) do
+        if Zone.SetPartlyInside then
+            Zone:SetPartlyInside(state)
+        end
+    end
+    return self
+  end
+  
   --- (Internal) Check the assigned objects for being in/out of the zone
   -- @param #SET_ZONE self
   -- @param #boolean fromstart If true, do the init of the objects
@@ -6761,8 +6793,13 @@ do -- SET_ZONE
               -- has not been tagged previously - wasn't in set! 
               obj.TriggerInZone[_zone.ZoneName] = false 
             end
-            -- is obj in zone?
-            local inzone = _zone:IsCoordinateInZone(obj:GetCoordinate())
+            -- is obj in this zone?
+            local inzone
+            if _zone.PartlyInside and obj.ClassName == "GROUP" then
+                inzone = obj:IsAnyInZone(_zone)                 -- TRUE as soon as any unit is inside
+            else
+                inzone = _zone:IsCoordinateInZone(obj:GetCoordinate())  -- original centroid test
+            end
             --self:I("Object "..obj:GetName().." is in zone: "..tostring(inzone))
             if inzone and not obj.TriggerInZone[_zone.ZoneName] then
               -- wasn't in zone before

Moose Development/Moose/Core/SpawnStatic.lua

@@ -149,6 +149,7 @@ function SPAWNSTATIC:NewFromStatic(SpawnTemplateName, SpawnCountryID)
     self.CategoryID          = CategoryID
     self.CoalitionID         = CoalitionID
     self.SpawnIndex          = 0
+    self.StaticCopyFrom      = SpawnTemplateName
   else
     error( "SPAWNSTATIC:New: There is no static declared in the mission editor with SpawnTemplatePrefix = '" .. tostring(SpawnTemplateName) .. "'" )
   end
@@ -302,12 +303,16 @@ end
 -- @param #number CallsignID Callsign ID. Default 1 (="London").
 -- @param #number Frequency Frequency in MHz. Default 127.5 MHz.
 -- @param #number Modulation Modulation 0=AM, 1=FM.
+-- @param #boolean DynamicSpawns If true, allow Dynamic Spawns
+-- @param #boolean DynamicHotStarts If true, and DynamicSpawns is true, then allow Dynamic Spawns with hot starts.
 -- @return #SPAWNSTATIC self
-function SPAWNSTATIC:InitFARP(CallsignID, Frequency, Modulation)
+function SPAWNSTATIC:InitFARP(CallsignID, Frequency, Modulation, DynamicSpawns,DynamicHotStarts)
   self.InitFarp=true
   self.InitFarpCallsignID=CallsignID or 1
   self.InitFarpFreq=Frequency or 127.5
   self.InitFarpModu=Modulation or 0
+  self.InitFarpDynamicSpawns = DynamicSpawns
+  self.InitFarpDynamicHotStarts = (DynamicSpawns == true and DynamicHotStarts == true) and true or nil
   return self
 end
 
@@ -459,8 +464,9 @@ end
 function SPAWNSTATIC:SpawnFromZone(Zone, Heading, NewName)
 
   -- Spawn the new static at the center of the zone.
-  local Static = self:SpawnFromPointVec2( Zone:GetPointVec2(), Heading, NewName )
-
+  --local Static = self:SpawnFromPointVec2( Zone:GetPointVec2(), Heading, NewName )
+  local Static = self:SpawnFromCoordinate(Zone:GetCoordinate(), Heading, NewName)
+    
   return Static
 end
 
@@ -549,6 +555,13 @@ function SPAWNSTATIC:_SpawnStatic(Template, CountryID)
     TemplateGroup.x=Template.x
     TemplateGroup.y=Template.y
     TemplateGroup.name=Template.name
+    
+    if self.InitFarpDynamicSpawns == true then
+      TemplateGroup.units[1].dynamicSpawn = true
+      if self.InitFarpDynamicHotStarts == true then
+        TemplateGroup.units[1].allowHotStart = true
+      end
+    end
 
     self:T("Spawning FARP")
     self:T({Template=Template})
@@ -556,7 +569,8 @@ function SPAWNSTATIC:_SpawnStatic(Template, CountryID)
 
     -- ED's dirty way to spawn FARPS.
     Static=coalition.addGroup(CountryID, -1, TemplateGroup)
-
+    --Static=coalition.addStaticObject(CountryID, Template)
+    
     -- Currently DCS 2.8 does not trigger birth events if FARPS are spawned!
     -- We create such an event. The airbase is registered in Core.Event
     local Event = {
@@ -594,6 +608,19 @@ function SPAWNSTATIC:_SpawnStatic(Template, CountryID)
     -- delay calling this for .3 seconds so that it hopefully comes after the BIRTH event of the group.
     self:ScheduleOnce(0.3, self.SpawnFunctionHook, mystatic, unpack(self.SpawnFunctionArguments))
   end
-
+  
+  if self.StaticCopyFrom ~= nil then
+    mystatic.StaticCopyFrom = self.StaticCopyFrom
+    if not _DATABASE.Templates.Statics[Template.name] then
+      local TemplateGroup={}
+      TemplateGroup.units={}
+      TemplateGroup.units[1]=Template
+      TemplateGroup.x=Template.x
+      TemplateGroup.y=Template.y
+      TemplateGroup.name=Template.name
+      _DATABASE:_RegisterStaticTemplate( TemplateGroup, self.CoalitionID, self.CategoryID, CountryID )
+    end
+  end
+  
   return mystatic
 end

Moose Development/Moose/Core/Zone.lua

@@ -70,6 +70,7 @@
 -- @field #table Table of any trigger zone properties from the ME. The key is the Name of the property, and the value is the property's Value.
 -- @field #number Surface Type of surface. Only determined at the center of the zone!
 -- @field #number Checktime Check every Checktime seconds, used for ZONE:Trigger()
+-- @field #boolean PartlyInside When called, a GROUP is considered inside as soon as any of its units enters the zone even if they are far apart.
 -- @extends Core.Fsm#FSM
 
 
@@ -305,20 +306,6 @@ function ZONE_BASE:GetCoordinate( Height ) --R2.1
   return self.Coordinate
 end
 
----  Returns the @{Core.Vector#VECTOR} of the zone.
--- @param #ZONE_BASE self
--- @param DCS#Distance Height The height in meters to add to the land height where the center of the zone is located.
--- @return Core.Vector#VECTOR The vector of the zone.
-function ZONE_BASE:GetVector( Height )
-  self:F2(self.ZoneName)
-
-  local Vec3 = self:GetVec3( Height )
-  
-  local vector=VECTOR:NewFromVec(Vec3)
-
-  return vector
-end
-
 --- Get 2D distance to a coordinate.
 -- @param #ZONE_BASE self
 -- @param Core.Point#COORDINATE Coordinate Reference coordinate. Can also be a DCS#Vec2 or DCS#Vec3 object.
@@ -548,6 +535,19 @@ function ZONE_BASE:GetZoneProbability()
   return self.ZoneProbability
 end
 
+--- Get the coordinate on the radius of the zone nearest to Outsidecoordinate. Useto e.g. find an ingress point.
+-- @param #ZONE_BASE self
+-- @param Core.Point#COORDINATE Outsidecoordinate The coordinate outside of the zone from where to look.
+-- @return Core.Point#COORDINATE CoordinateOnRadius
+function ZONE_BASE:FindNearestCoordinateOnRadius(Outsidecoordinate)
+  local Vec1 = self:GetVec2()
+  local Radius = self:GetRadius()
+  local Vec2 = Outsidecoordinate:GetVec2()
+  local Point = UTILS.FindNearestPointOnCircle(Vec1,Radius,Vec2)
+  local rc = COORDINATE:NewFromVec2(Point)
+  return rc
+end
+
 --- Get the zone taking into account the randomization probability of a zone to be selected.
 -- @param #ZONE_BASE self
 -- @return #ZONE_BASE The zone is selected taking into account the randomization probability factor.
@@ -613,6 +613,8 @@ end
 --
 --            -- Stop watching the zone after 1 hour
 --           triggerzone:__TriggerStop(3600)
+--            -- Call :SetPartlyInside() if you use SET_GROUP to count as inside when any of their units enters even when they are far apart.
+--            -- Make sure to call :SetPartlyInside() before :Trigger()!
 function ZONE_BASE:Trigger(Objects)
   --self:I("Added Zone Trigger")
   self:SetStartState("TriggerStopped")
@@ -681,6 +683,16 @@ function ZONE_BASE:Trigger(Objects)
   
 end
 
+  --- Toggle “partly-inside” handling for this zone. To be used before :Trigger().
+  -- * Default:* flag is **false** until you call the method.  
+  -- * Call with no argument or with **true** → enable.  
+  -- * Call with **false** → disable again (handy if it was enabled before).
+  -- @param #ZONE_BASE self
+  -- @return #ZONE_BASE self
+  function ZONE_BASE:SetPartlyInside(state)
+  self.PartlyInside = state or not ( state == false )
+  return self
+  end
 --- (Internal) Check the assigned objects for being in/out of the zone
 -- @param #ZONE_BASE self
 -- @param #boolean fromstart If true, do the init of the objects
@@ -719,7 +731,12 @@ function ZONE_BASE:_TriggerCheck(fromstart)
           obj.TriggerInZone[self.ZoneName] = false
         end
         -- is obj in zone?
-        local inzone = self:IsCoordinateInZone(obj:GetCoordinate())
+        local inzone
+        if self.PartlyInside and obj.ClassName == "GROUP" then
+            inzone = obj:IsAnyInZone(self)                     -- TRUE if any unit is inside
+        else
+            inzone = self:IsCoordinateInZone(obj:GetCoordinate()) -- original barycentre test
+        end
         --self:I("Object "..obj:GetName().." is in zone: "..tostring(inzone))
         if inzone and obj.TriggerInZone[self.ZoneName] then
           -- just count
@@ -1281,7 +1298,8 @@ end
 function ZONE_RADIUS:GetScannedSetGroup()
 
   self.ScanSetGroup=self.ScanSetGroup or SET_GROUP:New() --Core.Set#SET_GROUP
-
+  
+  self.ScanSetGroup:Clear(false)
   self.ScanSetGroup.Set={}
 
   if self.ScanData then
@@ -1523,6 +1541,26 @@ function ZONE_RADIUS:IsVec3InZone( Vec3 )
   return InZone
 end
 
+--- Search for clear ground spawn zones within this zone. A powerful and efficient function using Disposition to find clear areas for spawning ground units avoiding trees, water and map scenery.
+-- @param #ZONE_RADIUS self
+-- @param #number PosRadius Required clear radius around each position.
+-- @param #number NumPositions Number of positions to find.
+-- @return #table A table of DCS#Vec2 positions that are clear of map objects within the given PosRadius. nil if no clear positions are found.
+function ZONE_RADIUS:GetClearZonePositions(PosRadius, NumPositions)
+    return UTILS.GetClearZonePositions(self, PosRadius, NumPositions)
+end
+
+
+--- Search for a random clear ground spawn coordinate within this zone. A powerful and efficient function using Disposition to find clear areas for spawning ground units avoiding trees, water and map scenery.
+-- @param #ZONE_RADIUS self
+-- @param #number PosRadius (Optional) Required clear radius around each position. (Default is math.min(Radius/10, 200))
+-- @param #number NumPositions (Optional) Number of positions to find. (Default 50)
+-- @return Core.Point#COORDINATE A random coordinate for a clear zone. nil if no clear positions are found.
+-- @return #number Assigned radius for the found zones. nil if no clear positions are found.
+function ZONE_RADIUS:GetRandomClearZoneCoordinate(PosRadius, NumPositions)
+    return UTILS.GetRandomClearZoneCoordinate(self, PosRadius, NumPositions)
+end
+
 --- Returns a random Vec2 location within the zone.
 -- @param #ZONE_RADIUS self
 -- @param #number inner (Optional) Minimal distance from the center of the zone. Default is 0.
@@ -1534,6 +1572,10 @@ function ZONE_RADIUS:GetRandomVec2(inner, outer, surfacetypes)
   local Vec2 = self:GetVec2()
   local _inner = inner or 0
   local _outer = outer or self:GetRadius()
+  
+  math.random()
+  math.random()
+  math.random()
 
   if surfacetypes and type(surfacetypes)~="table" then
     surfacetypes={surfacetypes}
@@ -2501,6 +2543,26 @@ function ZONE_POLYGON_BASE:Flush()
   return self
 end
 
+--- Search for clear ground spawn zones within this zone. A powerful and efficient function using Disposition to find clear areas for spawning ground units avoiding trees, water and map scenery.
+-- @param #ZONE_POLYGON_BASE self
+-- @param #number PosRadius Required clear radius around each position.
+-- @param #number NumPositions Number of positions to find.
+-- @return #table A table of DCS#Vec2 positions that are clear of map objects within the given PosRadius. nil if no clear positions are found.
+function ZONE_POLYGON_BASE:GetClearZonePositions(PosRadius, NumPositions)
+    return UTILS.GetClearZonePositions(self, PosRadius, NumPositions)
+end
+
+
+--- Search for a random clear ground spawn coordinate within this zone. A powerful and efficient function using Disposition to find clear areas for spawning ground units avoiding trees, water and map scenery.
+-- @param #ZONE_POLYGON_BASE self
+-- @param #number PosRadius (Optional) Required clear radius around each position. (Default is math.min(Radius/10, 200))
+-- @param #number NumPositions (Optional) Number of positions to find. (Default 50)
+-- @return Core.Point#COORDINATE A random coordinate for a clear zone. nil if no clear positions are found.
+-- @return #number Assigned radius for the found zones. nil if no clear positions are found.
+function ZONE_POLYGON_BASE:GetRandomClearZoneCoordinate(PosRadius, NumPositions)
+    return UTILS.GetRandomClearZoneCoordinate(self, PosRadius, NumPositions)
+end
+
 --- Smokes the zone boundaries in a color.
 -- @param #ZONE_POLYGON_BASE self
 -- @param #boolean UnBound If true, the tyres will be destroyed.
@@ -2879,6 +2941,11 @@ end
 function ZONE_POLYGON_BASE:GetRandomVec2()
     -- make sure we assign weights to the triangles based on their surface area, otherwise
     -- we'll be more likely to generate random points in smaller triangles
+    
+    math.random()
+    math.random()
+    math.random()
+    
     local weights = {}
     for _, triangle in pairs(self._Triangles) do
         weights[triangle] = triangle.SurfaceArea / self.SurfaceArea
@@ -3218,12 +3285,7 @@ function ZONE_POLYGON:Scan( ObjectCategories, UnitCategories )
 
   local vectors = self:GetBoundingSquare()
 
-  local minVec3 = {x=vectors.x1, y=0, z=vectors.y1}
-  local maxVec3 = {x=vectors.x2, y=0, z=vectors.y2}
-
-  local minmarkcoord = COORDINATE:NewFromVec3(minVec3)
-  local maxmarkcoord = COORDINATE:NewFromVec3(maxVec3)
-  local ZoneRadius = minmarkcoord:Get2DDistance(maxmarkcoord)/2
+  local ZoneRadius = UTILS.VecDist2D({x=vectors.x1, y=vectors.y1}, {x=vectors.x2, y=vectors.y2})/2
 --  self:I("Scan Radius:" ..ZoneRadius)
   local CenterVec3 = self:GetCoordinate():GetVec3()
 

Moose Development/Moose/DCS.lua

@@ -198,7 +198,7 @@ end -- env
 
 do -- radio
 
-  ---@type radio
+  --@type radio
   -- @field #radio.modulation modulation
   
   ---

Moose Development/Moose/Functional/AICSAR.lua

@@ -22,7 +22,7 @@
 -- ===
 -- 
 -- ### Author: **Applevangelist**
--- Last Update Sept 2023
+-- Last Update July 2025
 --
 -- ===
 -- @module Functional.AICSAR
@@ -57,6 +57,8 @@
 -- @field #number Speed Default speed setting for the helicopter FLIGHTGROUP is 100kn.
 -- @field #boolean UseEventEject In case Event LandingAfterEjection isn't working, use set this to true.
 -- @field #number Delay In case of UseEventEject wait this long until we spawn a landed pilot.
+-- @field #boolean UseRescueZone If true, use a rescue zone and not the max distance to FARP/MASH
+-- @field Core.Zone#ZONE_RADIUS RescueZone Use this zone as operational area for the AICSAR instance.
 -- @extends Core.Fsm#FSM
 
 
@@ -153,10 +155,10 @@
 -- To set up AICSAR for SRS TTS output, add e.g. the following to your script:
 --              
 --              -- setup for google TTS, radio 243 AM, SRS server port 5002 with a google standard-quality voice (google cloud account required)
---              my_aicsar:SetSRSTTSRadio(true,"C:\\Program Files\\DCS-SimpleRadio-Standalone",243,radio.modulation.AM,5002,MSRS.Voices.Google.Standard.en_US_Standard_D,"en-US","female","C:\\Program Files\\DCS-SimpleRadio-Standalone\\google.json")
+--              my_aicsar:SetSRSTTSRadio(true,"C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio",243,radio.modulation.AM,5002,MSRS.Voices.Google.Standard.en_US_Standard_D,"en-US","female","C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio\\google.json")
 --              
 --              -- alternatively for MS Desktop TTS (voices need to be installed locally first!)
---              my_aicsar:SetSRSTTSRadio(true,"C:\\Program Files\\DCS-SimpleRadio-Standalone",243,radio.modulation.AM,5002,MSRS.Voices.Microsoft.Hazel,"en-GB","female")
+--              my_aicsar:SetSRSTTSRadio(true,"C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio",243,radio.modulation.AM,5002,MSRS.Voices.Microsoft.Hazel,"en-GB","female")
 --              
 --              -- define a different voice for the downed pilot(s)
 --              my_aicsar:SetPilotTTSVoice(MSRS.Voices.Google.Standard.en_AU_Standard_D,"en-AU","male")
@@ -177,7 +179,7 @@
 --           
 -- Switch on radio transmissions via **either** SRS **or** "normal" DCS radio e.g. like so:
 -- 
---          my_aicsar:SetSRSRadio(true,"C:\\Program Files\\DCS-SimpleRadio-Standalone",270,radio.modulation.AM,nil,5002)
+--          my_aicsar:SetSRSRadio(true,"C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio",270,radio.modulation.AM,nil,5002)
 --         
 -- or         
 --          
@@ -191,7 +193,7 @@
 -- @field #AICSAR
 AICSAR = {
   ClassName = "AICSAR",
-  version = "0.1.16",
+  version = "0.1.18",
   lid = "",
   coalition = coalition.side.BLUE,
   template = "",
@@ -236,6 +238,8 @@ AICSAR = {
   Altitude = 1500,
   UseEventEject = false,
   Delay = 100,
+  UseRescueZone = false,
+  RescueZone = nil,
 }
 
 -- TODO Messages
@@ -304,8 +308,9 @@ AICSAR.RadioLength = {
 -- @param #string Helotemplate Helicopter template name.
 -- @param Wrapper.Airbase#AIRBASE FARP FARP object or Airbase from where to start.
 -- @param Core.Zone#ZONE MASHZone Zone where to drop pilots after rescue.
+-- @param #number Helonumber Max number of alive Ai Helos at the same time. Defaults to three.
 -- @return #AICSAR self
-function AICSAR:New(Alias,Coalition,Pilottemplate,Helotemplate,FARP,MASHZone)
+function AICSAR:New(Alias,Coalition,Pilottemplate,Helotemplate,FARP,MASHZone,Helonumber)
   -- Inherit everything from FSM class.
   local self=BASE:Inherit(self, FSM:New())
   
@@ -373,7 +378,7 @@ function AICSAR:New(Alias,Coalition,Pilottemplate,Helotemplate,FARP,MASHZone)
   
   -- limit number of available helos at the same time
   self.limithelos = true
-  self.helonumber = 3
+  self.helonumber = Helonumber or 3
 
   -- localization
   self:InitLocalization()
@@ -524,10 +529,20 @@ function AICSAR:InitLocalization()
   return self
 end
 
+--- [User] Use a defined zone as area of operation and not the distance to FARP.
+-- @param #AICSAR self
+-- @param Core.Zone#ZONE Zone The operational zone to use. Downed pilots in this area will be rescued. Can be any known #ZONE type.
+-- @return #AICSAR self 
+function AICSAR:SetUsingRescueZone(Zone)
+  self.UseRescueZone = true
+  self.RescueZone = Zone
+  return self
+end
+
 --- [User] Switch sound output on and use SRS output for sound files.
 -- @param #AICSAR self
 -- @param #boolean OnOff Switch on (true) or off (false).
--- @param #string Path Path to your SRS Server Component, e.g. "C:\\\\Program Files\\\\DCS-SimpleRadio-Standalone"
+-- @param #string Path Path to your SRS Server External Audio Component, e.g. "C:\\\\Program Files\\\\DCS-SimpleRadio-Standalone\\\\ExternalAudio"
 -- @param #number Frequency Defaults to 243 (guard)
 -- @param #number Modulation Radio modulation. Defaults to radio.modulation.AM
 -- @param #string SoundPath Where to find the audio files. Defaults to nil, i.e. add messages via "Sound to..." in the Mission Editor.
@@ -538,7 +553,7 @@ function AICSAR:SetSRSRadio(OnOff,Path,Frequency,Modulation,SoundPath,Port)
   self.SRSRadio = OnOff and true
   self.SRSTTSRadio = false
   self.SRSFrequency = Frequency or 243
-  self.SRSPath = Path or MSRS.path or "C:\\Program Files\\DCS-SimpleRadio-Standalone"
+  self.SRSPath = Path or MSRS.path or "C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio"
   self.SRS:SetLabel("ACSR")
   self.SRS:SetCoalition(self.coalition)
   self.SRSModulation = Modulation or radio.modulation.AM
@@ -556,7 +571,7 @@ end
 -- See `AICSAR:SetPilotTTSVoice()` and `AICSAR:SetOperatorTTSVoice()`
 -- @param #AICSAR self
 -- @param #boolean OnOff Switch on (true) or off (false).
--- @param #string Path Path to your SRS Server Component, e.g. "E:\\\\Program Files\\\\DCS-SimpleRadio-Standalone"
+-- @param #string Path Path to your SRS Server Component, e.g. "E:\\\\Program Files\\\\DCS-SimpleRadio-Standalone\\ExternalAudio"
 -- @param #number Frequency (Optional) Defaults to 243 (guard)
 -- @param #number Modulation (Optional) Radio modulation. Defaults to radio.modulation.AM
 -- @param #number Port (Optional) Port of the SRS, defaults to 5002.
@@ -570,7 +585,7 @@ function AICSAR:SetSRSTTSRadio(OnOff,Path,Frequency,Modulation,Port,Voice,Cultur
   self.SRSTTSRadio = OnOff and true
   self.SRSRadio = false
   self.SRSFrequency = Frequency or 243
-  self.SRSPath = Path or MSRS.path or "C:\\Program Files\\DCS-SimpleRadio-Standalone"
+  self.SRSPath = Path or MSRS.path or "C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio"
   self.SRSModulation = Modulation or radio.modulation.AM
   self.SRSPort = Port or MSRS.port or 5002
   if OnOff then
@@ -693,7 +708,7 @@ function AICSAR:_EjectEventHandler(EventData)
       local _LandingPos = COORDINATE:NewFromVec3(_event.initiator:getPosition().p)
       local _country = _event.initiator:getCountry()
       local _coalition = coalition.getCountryCoalition( _country )
-      local data = UTILS.DeepCopy(EventData)
+      --local data = UTILS.DeepCopy(EventData)
       Unit.destroy(_event.initiator) -- shagrat remove static Pilot model
       self:ScheduleOnce(self.Delay,self._DelayedSpawnPilot,self,_LandingPos,_coalition)
     end
@@ -708,7 +723,14 @@ end
 -- @return #AICSAR self
 function AICSAR:_DelayedSpawnPilot(_LandingPos,_coalition)
 
-  local distancetofarp = _LandingPos:Get2DDistance(self.farp:GetCoordinate()) 
+  local distancetofarp = _LandingPos:Get2DDistance(self.farp:GetCoordinate())
+  if self.UseRescueZone == true and self.RescueZone ~= nil then
+    if self.RescueZone:IsCoordinateInZone(_LandingPos) then
+      distancetofarp = self.maxdistance - 10
+    else
+      distancetofarp = self.maxdistance + 10
+    end
+  end 
   -- Mayday Message
   local Text,Soundfile,Soundlength,Subtitle = self.gettext:GetEntry("PILOTDOWN",self.locale)
   local text = ""
@@ -795,7 +817,13 @@ function AICSAR:_EventHandler(EventData, FromEject)
 
   -- DONE: add distance check
   local distancetofarp = _LandingPos:Get2DDistance(self.farp:GetCoordinate())
-  
+  if self.UseRescueZone == true and self.RescueZone ~= nil then
+    if self.RescueZone:IsCoordinateInZone(_LandingPos) then
+      distancetofarp = self.maxdistance - 10
+    else
+      distancetofarp = self.maxdistance + 10
+    end
+  end 
   -- Mayday Message
   local Text,Soundfile,Soundlength,Subtitle = self.gettext:GetEntry("PILOTDOWN",self.locale)
   local text = ""
@@ -817,7 +845,6 @@ function AICSAR:_EventHandler(EventData, FromEject)
   if _coalition == self.coalition then
     if self.verbose then
       MESSAGE:New(msgtxt,15,"AICSAR"):ToCoalition(self.coalition)
-     -- MESSAGE:New(msgtxt,15,"AICSAR"):ToLog()
     end
     if self.SRSRadio then
       local sound = SOUNDFILE:New(Soundfile,self.SRSSoundPath,Soundlength)
@@ -869,6 +896,7 @@ function AICSAR:_GetFlight()
     :InitUnControlled(true)
     :OnSpawnGroup(
       function(Group)
+        Group:OptionPreferVerticalLanding()
         self:__HeloOnDuty(1,Group)
       end
     )
@@ -892,7 +920,7 @@ function AICSAR:_InitMission(Pilot,Index)
   --local pilotset = SET_GROUP:New()
   --pilotset:AddGroup(Pilot)
   
-    -- Cargo transport assignment.
+  -- Cargo transport assignment.
   local opstransport=OPSTRANSPORT:New(Pilot, pickupzone, self.farpzone)
   --opstransport:SetVerbosity(3)
   
@@ -934,6 +962,10 @@ function AICSAR:_InitMission(Pilot,Index)
     helo:__UnloadingDone(5)
   end
   
+  function helo:OnAfterLandAtAirbase(From,Event,To,airbase)
+    helo:Despawn(2)
+  end
+  
   self.helos[Index] = helo
   
   return self
@@ -984,7 +1016,9 @@ function AICSAR:_CheckHelos()
       local name = helo:GetName()
       self:T("Helo group "..name.." in state "..state)
       if state == "Arrived" then
-        helo:__Stop(5)
+        --helo:__Stop(5)
+        helo.OnAfterDead = nil
+        helo:Despawn(35)
         self.helos[_index] = nil
       end
     else
@@ -1025,7 +1059,7 @@ function AICSAR:_CheckQueue(OpsGroup)
      if self:_CheckInMashZone(_pilot) then
       self:T("Pilot" .. _pilot.GroupName .. " rescued!")
       if OpsGroup then
-        OpsGroup:Despawn(10)
+        --OpsGroup:Despawn(10)
       else 
         _pilot:Destroy(true,10)
       end

Moose Development/Moose/Functional/Autolase.lua

@@ -105,7 +105,7 @@ AUTOLASE = {
   debug = false,
   smokemenu = true,
   RoundingPrecision = 0,
-  increasegroundawareness = true,
+  increasegroundawareness = false,
   MonitorFrequency = 30,
 }
 
@@ -216,7 +216,7 @@ function AUTOLASE:New(RecceSet, Coalition, Alias, PilotSet)
   self.smokemenu = true
   self.threatmenu = true
   self.RoundingPrecision = 0
-  self.increasegroundawareness = true
+  self.increasegroundawareness = false
   self.MonitorFrequency = 30
   
   self:EnableSmokeMenu({Angle=math.random(0,359),Distance=math.random(10,20)})
@@ -493,7 +493,7 @@ end
 --- (User) Function enable sending messages via SRS.
 -- @param #AUTOLASE self
 -- @param #boolean OnOff Switch usage on and off
--- @param #string Path Path to SRS directory, e.g. C:\\Program Files\\DCS-SimpleRadio-Standalone
+-- @param #string Path Path to SRS TTS directory, e.g. C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio
 -- @param #number Frequency Frequency to send, e.g. 243
 -- @param #number Modulation Modulation i.e. radio.modulation.AM or radio.modulation.FM
 -- @param #string Label (Optional) Short label to be used on the SRS Client Overlay
@@ -508,7 +508,7 @@ end
 function AUTOLASE:SetUsingSRS(OnOff,Path,Frequency,Modulation,Label,Gender,Culture,Port,Voice,Volume,PathToGoogleKey)
   if OnOff then
     self.useSRS = true
-    self.SRSPath = Path or MSRS.path or "C:\\Program Files\\DCS-SimpleRadio-Standalone"
+    self.SRSPath = Path or MSRS.path or "C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio"
     self.SRSFreq = Frequency or 271
     self.SRSMod = Modulation or radio.modulation.AM
     self.Gender = Gender or MSRS.gender or "male"
@@ -1020,7 +1020,7 @@ function AUTOLASE:_Prescient()
            self:T(self.lid.."Checking possibly visible STATICs for Recce "..unit:GetName())
             for _,_static in pairs(Statics) do -- DCS static object here
               local static = STATIC:Find(_static)
-              if static and static:GetCoalition() ~= self.coalition then
+              if static and static:GetCoalition() ~= self.coalition and static:GetCoordinate() then
                 local IsLOS = position:IsLOS(static:GetCoordinate())
                 if IsLOS then
                   unit:KnowUnit(static,true,true)

Moose Development/Moose/Functional/Mantis.lua

@@ -22,7 +22,7 @@
 -- @module Functional.Mantis
 -- @image Functional.Mantis.jpg
 --
--- Last Update: Mar 2025
+-- Last Update: July 2025
 
 -------------------------------------------------------------------------
 --- **MANTIS** class, extends Core.Base#BASE
@@ -62,7 +62,9 @@
 -- @field #table FilterZones Table of Core.Zone#ZONE Zones Consider SAM groups in this zone(s) only for this MANTIS instance, must be handed as #table of Zone objects.
 -- @field #boolean SmokeDecoy If true, smoke short range SAM units as decoy if a plane is in firing range.
 -- @field #number SmokeDecoyColor Color to use, defaults to SMOKECOLOR.White
--- @field #number checkcounter Counter for SAM Table refreshes
+-- @field #number checkcounter Counter for SAM Table refreshes.
+-- @field #number DLinkCacheTime Seconds after which cached contacts in DLink will decay.
+-- @field #boolean logsamstatus Log SAM status in dcs.log every cycle if true
 -- @extends Core.Base#BASE
 
 
@@ -74,10 +76,9 @@
 -- 
 -- * Moose derived  Modular, Automatic and Network capable Targeting and Interception System.
 -- * Controls a network of SAM sites. Uses detection to switch on the SAM site closest to the enemy.
--- * **Automatic mode** (default since 0.8) will set-up your SAM site network automatically for you
--- * **Classic mode** behaves like before
--- * Leverage evasiveness from SEAD, leverage attack range setting
--- * Automatic setup of SHORAD based on groups of the class "short-range"
+-- * **Automatic mode** (default) will set-up your SAM site network automatically for you.
+-- * Leverage evasiveness from SEAD, leverage attack range setting.
+-- * Automatic setup of SHORAD based on groups of the class "short-range".
 --
 -- # 0. Base considerations and naming conventions
 -- 
@@ -110,7 +111,8 @@
 -- * Silkworm (though strictly speaking this is a surface to ship missile)
 -- * SA-2, SA-3, SA-5, SA-6, SA-7, SA-8, SA-9, SA-10, SA-11, SA-13, SA-15, SA-19
 -- * From IDF mod: STUNNER IDFA, TAMIR IDFA (Note all caps!)
--- * From HDS (see note on HDS below): SA-2, SA-3, SA-10B, SA-10C, SA-12, SA-17, SA-20A, SA-20B, SA-23, HQ-2
+-- * From HDS (see note on HDS below): SA-2, SA-3, SA-10B, SA-10C, SA-12, SA-17, SA-20A, SA-20B, SA-23, HQ-2, SAMP/T Block 1, SAMP/T Block 1INT,  SAMP/T Block2
+-- * Other Mods: Nike
 -- 
 -- * From SMA: RBS98M, RBS70, RBS90, RBS90M, RBS103A, RBS103B, RBS103AM, RBS103BM, Lvkv9040M 
 -- **NOTE** If you are using the Swedish Military Assets (SMA), please note that the **group name** for RBS-SAM types also needs to contain the keyword "SMA"
@@ -124,19 +126,20 @@
 -- * SA-2 (with V759 missile, e.g. "Red SAM SA-2 HDS")
 -- * SA-2 (with HQ-2 launcher, use HQ-2 in the group name, e.g. "Red SAM HQ-2" )
 -- * SA-3 (with V601P missile, e.g. "Red SAM SA-3 HDS")
--- * SA-10B (overlap with other SA-10 types, e.g. "Red SAM SA-10B HDS")
--- * SA-10C (overlap with other SA-10 types, e.g. "Red SAM SA-10C HDS")
--- * SA-12 (launcher dependent range, e.g. "Red SAM SA-12 HDS")
--- * SA-23 (launcher dependent range, e.g. "Red SAM SA-23 HDS") 
+-- * SA-10B (overlap with other SA-10 types, e.g. "Red SAM SA-10B HDS" with 5P85CE launcher)
+-- * SA-10C (overlap with other SA-10 types, e.g. "Red SAM SA-10C HDS" with 5P85SE launcher)
+-- * SA-12 (launcher dependent range, e.g. "Red SAM SA-12 HDS 2" for the 9A82 variant and "Red SAM SA-12 HDS 1" for the 9A83 variant)
+-- * SA-23 (launcher dependent range, e.g. "Red SAM SA-23 HDS 2" for the 9A82ME variant and "Red SAM SA-23 HDS 1" for the 9A83ME variant)
+-- * SAMP/T (launcher dependent range, e.g. "Blue SAM SAMPT Block 1 HDS" for Block 1, "Blue SAM SAMPT Block 1INT HDS", "Blue SAM SAMPT Block 2 HDS")
 -- 
 -- The other HDS types work like the rest of the known SAM systems.
 -- 
 -- # 0.1 Set-up in the mission editor
 -- 
--- Set up your SAM sites in the mission editor. Name the groups using a systematic approach like above.
--- Set up your EWR system in the mission editor. Name the groups using a systematic approach like above. Can be e.g. AWACS or a combination of AWACS and Search Radars like e.g. EWR 1L13 etc. 
+-- Set up your SAM sites in the mission editor. Name the groups using a systematic approach like above.Can be e.g. AWACS or a combination of AWACS and Search Radars like e.g. EWR 1L13 etc. 
 -- Search Radars usually have "SR" or "STR" in their names. Use the encyclopedia in the mission editor to inform yourself.
--- Set up your SHORAD systems. They need to be **close** to (i.e. around) the SAM sites to be effective. Use **one** group per SAM location. SA-15 TOR systems offer a good missile defense.
+-- Set up your SHORAD systems. They need to be **close** to (i.e. around) the SAM sites to be effective. Use **one unit ** per group (multiple groups) for the SAM location. 
+-- Else, evasive manoevers might club up all defenders in one place. Red SA-15 TOR systems offer a good missile defense.
 -- 
 -- [optional] Set up your HQ. Can be any group, e.g. a command vehicle.
 --
@@ -188,7 +191,7 @@
 -- 
 -- ## 2.1 Auto mode features
 -- 
--- ### 2.1.1 You can now add Accept-, Reject- and Conflict-Zones to your setup, e.g. to consider borders or de-militarized zones:   
+-- ### 2.1.1 You can add Accept-, Reject- and Conflict-Zones to your setup, e.g. to consider borders or de-militarized zones:   
 -- 
 --        -- Parameters are tables of Core.Zone#ZONE objects!   
 --        -- This is effectively a 3-stage filter allowing for zone overlap. A coordinate is accepted first when   
@@ -205,9 +208,6 @@
 -- ### 2.1.3 SHORAD/Point defense will automatically be added from SAM sites of type "point" or if the range is less than 5km or if the type is AAA. 
 --        
 -- ### 2.1.4 Advanced features   
--- 
---        -- Option to switch off auto mode **before** you start MANTIS (not recommended)   
---        mybluemantis.automode = false
 --        
 --        -- Option to set the scale of the activation range, i.e. don't activate at the fringes of max range, defaults below.   
 --        -- also see engagerange below.   
@@ -220,6 +220,12 @@
 -- 
 --        -- For some scenarios, like Cold War, it might be useful not to activate SAMs if friendly aircraft are around to avoid death by friendly fire.
 --        mybluemantis.checkforfriendlies = true  
+--        
+-- ### 2.1.6 Shoot & Scoot
+-- 
+--        -- Option to make the (driveable) SHORAD units drive around and shuffle positions
+--        -- We use a SET_ZONE for that, number of zones to consider defaults to three, Random is true for random coordinates and Formation is e.g. "Vee".
+--        mybluemantis:AddScootZones(ZoneSet, Number, Random, Formation)
 -- 
 -- # 3. Default settings [both modes unless stated otherwise]
 --
@@ -242,26 +248,8 @@
 --  E.g.        mymantis:SetAdvancedMode( true, 90 )
 --
 --  Use this option if you want to make use of or allow advanced SEAD tactics.
---
--- # 5. Integrate SHORAD [classic mode, not necessary in automode, not recommended for manual setup]
---
---  You can also choose to integrate Mantis with @{Functional.Shorad#SHORAD} for protection against HARMs and AGMs manually. When SHORAD detects a missile fired at one of MANTIS' SAM sites, it will activate SHORAD systems in
---  the given defense checkradius around that SAM site. Create a SHORAD object first, then integrate with MANTIS like so:
---
---          local SamSet = SET_GROUP:New():FilterPrefixes("Blue SAM"):FilterCoalitions("blue"):FilterStart()
---          myshorad = SHORAD:New("BlueShorad", "Blue SHORAD", SamSet, 22000, 600, "blue")
---          -- now set up MANTIS
---          mymantis = MANTIS:New("BlueMantis","Blue SAM","Blue EWR",nil,"blue",false,"Blue Awacs")
---          mymantis:AddShorad(myshorad,720)
---          mymantis:Start()
 --  
---  If you systematically name your SHORAD groups starting with "Blue SHORAD" you'll need exactly **one** SHORAD instance to manage all SHORAD groups.
---  
---  (Optionally) you can remove the link later on with
---
---          mymantis:RemoveShorad()
---
--- # 6. Integrated SEAD
+-- # 5. Integrated SEAD
 --  
 --  MANTIS is using @{Functional.Sead#SEAD} internally to both detect and evade HARM attacks. No extra efforts needed to set this up! 
 --  Once a HARM attack is detected, MANTIS (via SEAD) will shut down the radars of the attacked SAM site and take evasive action by moving the SAM
@@ -288,6 +276,7 @@
 MANTIS = {
   ClassName             = "MANTIS",
   name                  = "mymantis",
+  version               = "0.9.33",
   SAM_Templates_Prefix  = "",
   SAM_Group             = nil,
   EWR_Templates_Prefix  = "",
@@ -336,6 +325,8 @@ MANTIS = {
   SmokeDecoy            = false,
   SmokeDecoyColor       = SMOKECOLOR.White,
   checkcounter          = 1,
+  DLinkCacheTime        = 120,
+  logsamstatus          = false,
 }
 
 --- Advanced state enumerator
@@ -374,7 +365,7 @@ MANTIS.radiusscale[MANTIS.SamType.POINT] = 3
 MANTIS.SamData = {
   ["Hawk"] = { Range=35, Blindspot=0, Height=12, Type="Medium", Radar="Hawk" }, -- measures in km
   ["NASAMS"] = { Range=14, Blindspot=0, Height=7, Type="Short", Radar="NSAMS" }, -- AIM 120B
-  ["Patriot"] = { Range=99, Blindspot=0, Height=25, Type="Long", Radar="Patriot" },
+  ["Patriot"] = { Range=99, Blindspot=0, Height=25, Type="Long", Radar="Patriot str" },
   ["Rapier"] = { Range=10, Blindspot=0, Height=3, Type="Short", Radar="rapier" },
   ["SA-2"] = { Range=40, Blindspot=7, Height=25, Type="Medium", Radar="S_75M_Volhov" },
   ["SA-3"] = { Range=18, Blindspot=6, Height=18, Type="Short", Radar="5p73 s-125 ln" },
@@ -382,7 +373,8 @@ MANTIS.SamData = {
   ["SA-6"] = { Range=25, Blindspot=0, Height=8, Type="Medium", Radar="1S91" },
   ["SA-10"] = { Range=119, Blindspot=0, Height=18, Type="Long" , Radar="S-300PS 4"},
   ["SA-11"] = { Range=35, Blindspot=0, Height=20, Type="Medium", Radar="SA-11" },
-  ["Roland"] = { Range=5, Blindspot=0, Height=5, Type="Point", Radar="Roland" },
+  ["Roland"] = { Range=6, Blindspot=0, Height=5, Type="Short", Radar="Roland" },
+  ["Gepard"] = { Range=5, Blindspot=0, Height=4, Type="Point", Radar="Gepard" },
   ["HQ-7"] = { Range=12, Blindspot=0, Height=3, Type="Short", Radar="HQ-7" },
   ["SA-9"] = { Range=4, Blindspot=0, Height=3, Type="Point", Radar="Strela", Point="true" },
   ["SA-8"] = { Range=10, Blindspot=0, Height=5, Type="Short", Radar="Osa 9A33" },
@@ -393,14 +385,17 @@ MANTIS.SamData = {
   ["Chaparral"] = { Range=8, Blindspot=0, Height=3, Type="Short", Radar="Chaparral" },
   ["Linebacker"] = { Range=4, Blindspot=0, Height=3, Type="Point", Radar="Linebacker", Point="true" },
   ["Silkworm"] = { Range=90, Blindspot=1, Height=0.2, Type="Long", Radar="Silkworm" },
+  ["HEMTT_C-RAM_Phalanx"] = { Range=2, Blindspot=0, Height=2, Type="Point", Radar="HEMTT_C-RAM_Phalanx", Point="true" },
   -- units from HDS Mod, multi launcher options is tricky
   ["SA-10B"] = { Range=75, Blindspot=0, Height=18, Type="Medium" , Radar="SA-10B"},
-  ["SA-17"] = { Range=50, Blindspot=3, Height=30, Type="Medium", Radar="SA-17" },
+  ["SA-17"] = { Range=50, Blindspot=3, Height=50, Type="Medium", Radar="SA-17" },
   ["SA-20A"] = { Range=150, Blindspot=5, Height=27, Type="Long" , Radar="S-300PMU1"},
   ["SA-20B"] = { Range=200, Blindspot=4, Height=27, Type="Long" , Radar="S-300PMU2"},
   ["HQ-2"] = { Range=50, Blindspot=6, Height=35, Type="Medium", Radar="HQ_2_Guideline_LN" },
   ["TAMIR IDFA"] = { Range=20, Blindspot=0.6, Height=12.3, Type="Short", Radar="IRON_DOME_LN" },
-  ["STUNNER IDFA"] = { Range=250, Blindspot=1, Height=45, Type="Long", Radar="DAVID_SLING_LN" },   
+  ["STUNNER IDFA"] = { Range=250, Blindspot=1, Height=45, Type="Long", Radar="DAVID_SLING_LN" },
+  ["NIKE"] = { Range=155, Blindspot=6, Height=30, Type="Long", Radar="HIPAR" },
+  ["Dog Ear"] = { Range=11, Blindspot=0, Height=9, Type="Point", Radar="Dog Ear", Point="true" },
 }
 
 --- SAM data HDS
@@ -416,13 +411,17 @@ MANTIS.SamDataHDS = {
   -- group name MUST contain HDS to ID launcher type correctly!
   ["SA-2 HDS"] = { Range=56, Blindspot=7, Height=30, Type="Medium", Radar="V759" }, 
   ["SA-3 HDS"] = { Range=20, Blindspot=6, Height=30, Type="Short", Radar="V-601P" },  
-  ["SA-10C HDS 2"] = { Range=90, Blindspot=5, Height=25, Type="Long" , Radar="5P85DE ln"}, -- V55RUD
-  ["SA-10C HDS 1"] = { Range=90, Blindspot=5, Height=25, Type="Long" , Radar="5P85CE ln"}, -- V55RUD
-  ["SA-12 HDS 2"] = { Range=100, Blindspot=10, Height=25, Type="Long" , Radar="S-300V 9A82 l"},
-  ["SA-12 HDS 1"] = { Range=75, Blindspot=1, Height=25, Type="Long" , Radar="S-300V 9A83 l"},
+  ["SA-10B HDS"] = { Range=90, Blindspot=5, Height=25, Type="Long" , Radar="5P85CE ln"}, -- V55RUD
+  ["SA-10C HDS"] = { Range=75, Blindspot=5, Height=25, Type="Long" , Radar="5P85SE ln"}, -- V55RUD
+  ["SA-17 HDS"] = { Range=50, Blindspot=3, Height=50, Type="Medium", Radar="SA-17 " },
+  ["SA-12 HDS 2"] = { Range=100, Blindspot=13, Height=30, Type="Long" , Radar="S-300V 9A82 l"},
+  ["SA-12 HDS 1"] = { Range=75, Blindspot=6, Height=25, Type="Long" , Radar="S-300V 9A83 l"},
   ["SA-23 HDS 2"] = { Range=200, Blindspot=5, Height=37, Type="Long", Radar="S-300VM 9A82ME" },
   ["SA-23 HDS 1"] = { Range=100, Blindspot=1, Height=50, Type="Long", Radar="S-300VM 9A83ME" },
   ["HQ-2 HDS"] = { Range=50, Blindspot=6, Height=35, Type="Medium", Radar="HQ_2_Guideline_LN" },
+  ["SAMPT Block 1 HDS"] = { Range=120, Blindspot=1, Height=20, Type="long", Radar="SAMPT_MLT_Blk1" }, -- Block 1 Launcher
+  ["SAMPT Block 1INT HDS"] = { Range=150, Blindspot=1, Height=25, Type="long", Radar="SAMPT_MLT_Blk1NT" }, -- Block 1-INT Launcher
+  ["SAMPT Block 2 HDS"] = { Range=200, Blindspot=10, Height=70, Type="long", Radar="SAMPT_MLT_Blk2" }, -- Block 2 Launcher
 }
 
 --- SAM data SMA
@@ -625,7 +624,8 @@ do
       self.advAwacs = false
     end
     
-
+    self:SetDLinkCacheTime()
+    
     -- Set the string id for output to DCS.log file.
     self.lid=string.format("MANTIS %s | ", self.name)
 
@@ -658,6 +658,8 @@ do
       table.insert(self.ewr_templates,awacs)
     end
     
+    self.logsamstatus = false
+    
     self:T({self.ewr_templates})
     
     self.SAM_Group = SET_GROUP:New():FilterPrefixes(self.SAM_Templates_Prefix):FilterCoalitions(self.Coalition)
@@ -687,9 +689,6 @@ do
     -- counter for SAM table updates
     self.checkcounter = 1
     
-    -- TODO Version
-    -- @field #string version
-    self.version="0.9.27"
     self:I(string.format("***** Starting MANTIS Version %s *****", self.version))
 
     --- FSM Functions ---
@@ -1039,6 +1038,16 @@ do
     end
     return self
   end
+  
+  --- Function to set how long INTEL DLINK remembers contacts.
+  -- @param #MANTIS self
+  -- @param #number seconds Remember this many seconds, at least 5 seconds.
+  -- @return #MANTIS self
+  function MANTIS:SetDLinkCacheTime(seconds)
+    self.DLinkCacheTime = math.abs(seconds or 120)
+    if self.DLinkCacheTime < 5 then self.DLinkCacheTime = 5 end
+    return self
+  end
 
   --- Function to set the detection interval
   -- @param #MANTIS self
@@ -1431,7 +1440,9 @@ do
     --IntelTwo:SetClusterRadius(5000)
     IntelTwo:Start()
     
-    local IntelDlink = INTEL_DLINK:New({IntelOne,IntelTwo},self.name.." DLINK",22,300)
+    local CacheTime = self.DLinkCacheTime or 120
+    local IntelDlink = INTEL_DLINK:New({IntelOne,IntelTwo},self.name.." DLINK",22,CacheTime)
+    
     IntelDlink:__Start(1)
     
     self:SetUsingDLink(IntelDlink)
@@ -1493,7 +1504,7 @@ do
     elseif chm then
       SAMData = self.SamDataCH
     end
-    --self:T("Looking to auto-match for "..grpname)
+    --self:I("Looking to auto-match for "..grpname)
     for _,_unit in pairs(units) do
       local unit = _unit -- Wrapper.Unit#UNIT
       local type = string.lower(unit:GetTypeName())
@@ -1694,7 +1705,9 @@ do
           local grpname = group:GetName()
           local grpcoord = group:GetCoordinate()
           local grprange, grpheight,type,blind  = self:_GetSAMRange(grpname)
-          local radaralive = group:IsSAM()
+          -- TODO the below might stop working at some point after some hours, needs testing
+          --local radaralive = group:IsSAM()
+          local radaralive = true
           table.insert( SAM_Tbl, {grpname, grpcoord, grprange, grpheight, blind, type}) -- make the table lighter, as I don't really use the zone here
           table.insert( SEAD_Grps, grpname )
           if type == MANTIS.SamType.LONG and radaralive then
@@ -1791,7 +1804,7 @@ do
       if self.Shorad and self.Shorad.ActiveGroups and self.Shorad.ActiveGroups[name] then
        activeshorad = true
       end
-      if IsInZone and not suppressed and not activeshorad then --check any target in zone and not currently managed by SEAD
+      if IsInZone and (not suppressed) and (not activeshorad) then --check any target in zone and not currently managed by SEAD
         if samgroup:IsAlive() then
           -- switch on SAM
           local switch = false
@@ -1823,7 +1836,7 @@ do
           -- link in to SHORAD if available
           -- DONE: Test integration fully
           if self.ShoradLink and (Distance < self.ShoradActDistance or Distance < blind ) then -- don't give SHORAD position away too early
-            local Shorad = self.Shorad
+            local Shorad = self.Shorad  --Functional.Shorad#SHORAD
             local radius = self.checkradius
             local ontime = self.ShoradTime
             Shorad:WakeUpShorad(name, radius, ontime)
@@ -1856,7 +1869,7 @@ do
         end --end alive
       end --end check     
     end --for loop
-    if self.debug or self.verbose then
+    if self.debug or self.verbose or self.logsamstatus then
       for _,_status in pairs(self.SamStateTracker) do
         if _status == "GREEN" then
           instatusgreen=instatusgreen+1
@@ -1877,8 +1890,9 @@ do
   -- @param #MANTIS self
   -- @param Functional.Detection#DETECTION_AREAS detection Detection object
   -- @param #boolean dlink
+  -- @param #boolean reporttolog
   -- @return #MANTIS self
-  function MANTIS:_Check(detection,dlink)
+  function MANTIS:_Check(detection,dlink,reporttolog)
     self:T(self.lid .. "Check")
     --get detected set
     local detset = detection:GetDetectedItemCoordinates()
@@ -1905,7 +1919,8 @@ do
       local samset = self:_GetSAMTable() -- table of i.1=names, i.2=coordinates, i.3=firing range, i.4=firing height
       instatusred, instatusgreen, activeshorads = self:_CheckLoop(samset,detset,dlink,self.maxclassic)
     end
-    if self.debug or self.verbose then
+    
+    local function GetReport()
       local statusreport = REPORT:New("\nMANTIS Status "..self.name)
       statusreport:Add("+-----------------------------+")
       statusreport:Add(string.format("+ SAM in RED State: %2d",instatusred))
@@ -1914,7 +1929,15 @@ do
        statusreport:Add(string.format("+ SHORAD active: %2d",activeshorads))  
       end
       statusreport:Add("+-----------------------------+")
+      return statusreport
+    end
+    
+    if self.debug or self.verbose then
+      local statusreport = GetReport()
       MESSAGE:New(statusreport:Text(),10):ToAll():ToLog()
+    elseif reporttolog == true then
+      local statusreport = GetReport()
+      MESSAGE:New(statusreport:Text(),10):ToLog()
     end
     return self
   end
@@ -2022,7 +2045,7 @@ do
     self:T({From, Event, To})
     -- check detection
     if not self.state2flag then
-      self:_Check(self.Detection,self.DLink)
+      self:_Check(self.Detection,self.DLink,self.logsamstatus)
     end
   
     local EWRAlive = self:_CheckAnyEWRAlive()
@@ -2093,7 +2116,7 @@ do
     if self.debug and self.verbose then
       self:I(self.lid .. "Status Report")
       for _name,_state in pairs(self.SamStateTracker) do
-        self:I(string.format("Site %s\tStatus %s",_name,_state))
+        self:I(string.format("Site %s | Status %s",_name,_state))
       end
     end
     local interval = self.detectinterval * -1

Moose Development/Moose/Functional/MissileTrainer.lua

@@ -53,6 +53,8 @@
 --     
 -- # Developer Note
 -- 
+-- ![Banner Image](..\Images\deprecated.png)
+-- 
 -- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE.
 -- Therefore, this class is considered to be deprecated and superseded by the [Functional.Fox](https://flightcontrol-master.github.io/MOOSE_DOCS_DEVELOP/Documentation/Functional.Fox.html) class, which provides the same functionality.
 --

Moose Development/Moose/Functional/Range.lua

@@ -603,7 +603,7 @@ RANGE.MenuF10Root = nil
 
 --- Range script version.
 -- @field #string version
-RANGE.version = "2.8.0"
+RANGE.version = "2.8.1"
 
 -- TODO list:
 -- TODO: Verbosity level for messages.
@@ -2032,10 +2032,10 @@ function RANGE._OnImpact(weapon, self, playerData, attackHdg, attackAlt, attackV
 
   -- Smoke impact point of bomb.
   if playerData and playerData.smokebombimpact and insidezone then
-    if playerData and playerData.delaysmoke then
-      timer.scheduleFunction( self._DelayedSmoke, { coord = impactcoord, color = playerData.smokecolor }, timer.getTime() + self.TdelaySmoke )
+    if playerData.delaysmoke then
+      impactcoord:Smoke(playerData.smokecolor, 30, self.TdelaySmoke)
     else
-      impactcoord:Smoke( playerData.smokecolor )
+      impactcoord:Smoke(playerData.smokecolor, 30)
     end
   end
 
@@ -2102,7 +2102,12 @@ function RANGE._OnImpact(weapon, self, playerData, attackHdg, attackAlt, attackV
     result.attackHdg = attackHdg
     result.attackVel = attackVel
     result.attackAlt = attackAlt
-    result.date=os and os.date() or "n/a"
+    if os and os.date then
+        result.date=os.date()
+    else
+        self:E(self.lid.."os or os.date() not available")
+        result.date = "n/a"
+    end
 
     -- Add to table.
     table.insert( _results, result )
@@ -2635,13 +2640,6 @@ end
 -- Display Messages
 -----------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
---- Start smoking a coordinate with a delay.
--- @param #table _args Argements passed.
-function RANGE._DelayedSmoke( _args )
-  _args.coord:Smoke(_args.color)
-  --trigger.action.smoke( _args.coord:GetVec3(), _args.color )
-end
-
 --- Display top 10 stafing results of a specific player.
 -- @param #RANGE self
 -- @param #string _unitName Name of the player unit.

Moose Development/Moose/Functional/Scoring.lua

@@ -985,6 +985,7 @@ function SCORING:_EventOnHit( Event )
   local TargetUnitCoalition = nil
   local TargetUnitCategory = nil
   local TargetUnitType = nil
+  local TargetIsScenery = false
 
   if Event.IniDCSUnit then
 
@@ -1025,6 +1026,12 @@ function SCORING:_EventOnHit( Event )
     TargetCategory = Event.TgtCategory
     TargetType = Event.TgtTypeName
 
+    -- Scenery hit
+    if (not TargetCategory) and TargetUNIT ~= nil and TargetUnit:IsInstanceOf("SCENERY") then
+        TargetCategory = Unit.Category.STRUCTURE
+        TargetIsScenery = true
+    end
+    
     TargetUnitCoalition = _SCORINGCoalition[TargetCoalition]
     TargetUnitCategory = _SCORINGCategory[TargetCategory]
     TargetUnitType = TargetType
@@ -1117,17 +1124,22 @@ function SCORING:_EventOnHit( Event )
                                  MESSAGE.Type.Update )
                        :ToAllIf( self:IfMessagesHit() and self:IfMessagesToAll() )
                        :ToCoalitionIf( InitCoalition, self:IfMessagesHit() and self:IfMessagesToCoalition() )
-              else
+              elseif TargetIsScenery ~= true then
                 MESSAGE:NewType( self.DisplayMessagePrefix .. "Player '" .. InitPlayerName .. "' hit enemy target " .. TargetUnitCategory .. " ( " .. TargetType .. " ) " .. PlayerHit.ScoreHit .. " times. " ..
                                  "Score: " .. PlayerHit.Score .. ".  Score Total:" .. Player.Score - Player.Penalty,
                                  MESSAGE.Type.Update )
                        :ToAllIf( self:IfMessagesHit() and self:IfMessagesToAll() )
                        :ToCoalitionIf( InitCoalition, self:IfMessagesHit() and self:IfMessagesToCoalition() )
+              elseif TargetIsScenery == true then
+                MESSAGE:NewType( self.DisplayMessagePrefix .. "Player '" .. InitPlayerName .. "' hit scenery object." .. " Score: " .. PlayerHit.Score .. ".  Score Total:" .. Player.Score - Player.Penalty,
+                             MESSAGE.Type.Update )
+                   :ToAllIf( self:IfMessagesHit() and self:IfMessagesToAll() )
+                   :ToCoalitionIf( InitCoalition, self:IfMessagesHit() and self:IfMessagesToCoalition() )
               end
               self:ScoreCSV( InitPlayerName, TargetPlayerName, "HIT_SCORE", 1, 1, InitUnitName, InitUnitCoalition, InitUnitCategory, InitUnitType, TargetUnitName, TargetUnitCoalition, TargetUnitCategory, TargetUnitType )
             end
           else -- A scenery object was hit.
-            MESSAGE:NewType( self.DisplayMessagePrefix .. "Player '" .. InitPlayerName .. "' hit scenery object.",
+            MESSAGE:NewType( self.DisplayMessagePrefix .. "Player '" .. InitPlayerName .. "' hit nothing special.",
                              MESSAGE.Type.Update )
                    :ToAllIf( self:IfMessagesHit() and self:IfMessagesToAll() )
                    :ToCoalitionIf( InitCoalition, self:IfMessagesHit() and self:IfMessagesToCoalition() )

Moose Development/Moose/Functional/Warehouse.lua

@@ -3153,7 +3153,7 @@ end
 -- @param #WAREHOUSE self
 -- @return Core.Point#COORDINATE The coordinate of the warehouse.
 function WAREHOUSE:GetCoordinate()
-  return self.warehouse:GetCoordinate()
+  return self.warehouse:GetCoord()
 end
 
 --- Get 3D vector of warehouse static.
@@ -6893,7 +6893,7 @@ function WAREHOUSE:_CheckConquered()
     for _,_unit in pairs(units) do
       local unit=_unit --Wrapper.Unit#UNIT
 
-      local distance=coord:Get2DDistance(unit:GetCoordinate())
+      local distance=coord:Get2DDistance(unit:GetCoord())
 
       -- Filter only alive groud units. Also check distance again, because the scan routine might give some larger distances.
       if unit:IsGround() and unit:IsAlive() and distance <= radius then

Moose Development/Moose/Functional/ZoneGoalCargo.lua

@@ -7,6 +7,8 @@
 --
 -- # Developer Note
 -- 
+-- ![Banner Image](..\Images\deprecated.png)
+-- 
 -- Note while this class still works, it is no longer supported as the original author stopped active development of MOOSE
 -- Therefore, this class is considered to be deprecated
 --

Moose Development/Moose/Modules.lua

@@ -32,7 +32,6 @@ __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Core/MarkerOps_Base.lua' )
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Core/TextAndSound.lua' )
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Core/Pathline.lua' )
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Core/ClientMenu.lua')
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Core/Vector.lua')
 
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Wrapper/Object.lua' )
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Wrapper/Identifiable.lua' )
@@ -50,12 +49,6 @@ __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Wrapper/Net.lua' )
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Wrapper/Storage.lua' )
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Wrapper/DynamicCargo.lua' )
 
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Cargo/Cargo.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Cargo/CargoUnit.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Cargo/CargoSlingload.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Cargo/CargoCrate.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Cargo/CargoGroup.lua' )
-
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Functional/Scoring.lua' )
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Functional/CleanUp.lua' )
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Functional/Movement.lua' )
@@ -118,43 +111,6 @@ __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Ops/Squadron.lua' )
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Ops/Target.lua' )
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Ops/EasyGCICAP.lua' )
 
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/AI/AI_Balancer.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/AI/AI_Air.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/AI/AI_Air_Patrol.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/AI/AI_Air_Engage.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/AI/AI_A2A_Patrol.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/AI/AI_A2A_Cap.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/AI/AI_A2A_Gci.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/AI/AI_A2A_Dispatcher.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/AI/AI_A2G_BAI.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/AI/AI_A2G_CAS.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/AI/AI_A2G_SEAD.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/AI/AI_A2G_Dispatcher.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/AI/AI_Patrol.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/AI/AI_CAP.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/AI/AI_CAS.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/AI/AI_BAI.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/AI/AI_Formation.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/AI/AI_Escort.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/AI/AI_Escort_Request.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/AI/AI_Escort_Dispatcher.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/AI/AI_Escort_Dispatcher_Request.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/AI/AI_Cargo.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/AI/AI_Cargo_APC.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/AI/AI_Cargo_Helicopter.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/AI/AI_Cargo_Airplane.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/AI/AI_Cargo_Ship.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/AI/AI_Cargo_Dispatcher.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/AI/AI_Cargo_Dispatcher_APC.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/AI/AI_Cargo_Dispatcher_Helicopter.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/AI/AI_Cargo_Dispatcher_Airplane.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/AI/AI_Cargo_Dispatcher_Ship.lua' )
-
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Actions/Act_Assign.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Actions/Act_Route.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Actions/Act_Account.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Actions/Act_Assist.lua' )
-
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Shapes/ShapeBase.lua' )
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Shapes/Circle.lua' )
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Shapes/Cube.lua' )
@@ -170,26 +126,4 @@ __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Sound/RadioQueue.lua' )
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Sound/RadioSpeech.lua' )
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Sound/SRS.lua' )
 
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Tasking/CommandCenter.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Tasking/Mission.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Tasking/Task.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Tasking/TaskInfo.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Tasking/Task_Manager.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Tasking/DetectionManager.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Tasking/Task_A2G_Dispatcher.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Tasking/Task_A2G.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Tasking/Task_A2A_Dispatcher.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Tasking/Task_A2A.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Tasking/Task_CARGO.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Tasking/Task_Cargo_Transport.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Tasking/Task_Cargo_CSAR.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Tasking/Task_Cargo_Dispatcher.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Tasking/Task_Capture_Zone.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Tasking/Task_Capture_Dispatcher.lua' )
-
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Navigation/Beacons.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Navigation/Point.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Navigation/Procedure.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Navigation/FlightPlan.lua' )
-
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Globals.lua' )

Moose Development/Moose/Modules_local.lua

@@ -1,7 +1,6 @@
 __Moose.Include( 'Utilities\\Enums.lua' )
 __Moose.Include( 'Utilities\\Utils.lua' )
 __Moose.Include( 'Utilities\\Profiler.lua' )
---__Moose.Include( 'Utilities\\STTS.lua' )
 __Moose.Include( 'Utilities\\FiFo.lua' )
 __Moose.Include( 'Utilities\\Socket.lua' )
 
@@ -32,7 +31,6 @@ __Moose.Include( 'Core\\MarkerOps_Base.lua' )
 __Moose.Include( 'Core\\TextAndSound.lua' )
 __Moose.Include( 'Core\\Condition.lua' )
 __Moose.Include( 'Core\\ClientMenu.lua' )
-__Moose.Include( 'Core\\Vector.lua' )
 
 __Moose.Include( 'Wrapper\\Object.lua' )
 __Moose.Include( 'Wrapper\\Identifiable.lua' )
@@ -50,12 +48,6 @@ __Moose.Include( 'Wrapper\\Weapon.lua' )
 __Moose.Include( 'Wrapper\\Storage.lua' )
 __Moose.Include( 'Wrapper\\DynamicCargo.lua' )
 
-__Moose.Include( 'Cargo\\Cargo.lua' )
-__Moose.Include( 'Cargo\\CargoUnit.lua' )
-__Moose.Include( 'Cargo\\CargoSlingload.lua' )
-__Moose.Include( 'Cargo\\CargoCrate.lua' )
-__Moose.Include( 'Cargo\\CargoGroup.lua' )
-
 __Moose.Include( 'Functional\\Scoring.lua' )
 __Moose.Include( 'Functional\\CleanUp.lua' )
 __Moose.Include( 'Functional\\Movement.lua' )
@@ -116,44 +108,6 @@ __Moose.Include( 'Ops\\Operation.lua' )
 __Moose.Include( 'Ops\\FlightControl.lua' )
 __Moose.Include( 'Ops\\PlayerRecce.lua' )
 __Moose.Include( 'Ops\\EasyGCICAP.lua' )
-__Moose.Include( 'Ops\\EasyA2G.lua' )
-
-__Moose.Include( 'AI\\AI_Balancer.lua' )
-__Moose.Include( 'AI\\AI_Air.lua' )
-__Moose.Include( 'AI\\AI_Air_Patrol.lua' )
-__Moose.Include( 'AI\\AI_Air_Engage.lua' )
-__Moose.Include( 'AI\\AI_A2A_Patrol.lua' )
-__Moose.Include( 'AI\\AI_A2A_Cap.lua' )
-__Moose.Include( 'AI\\AI_A2A_Gci.lua' )
-__Moose.Include( 'AI\\AI_A2A_Dispatcher.lua' )
-__Moose.Include( 'AI\\AI_A2G_BAI.lua' )
-__Moose.Include( 'AI\\AI_A2G_CAS.lua' )
-__Moose.Include( 'AI\\AI_A2G_SEAD.lua' )
-__Moose.Include( 'AI\\AI_A2G_Dispatcher.lua' )
-__Moose.Include( 'AI\\AI_Patrol.lua' )
-__Moose.Include( 'AI\\AI_Cap.lua' )
-__Moose.Include( 'AI\\AI_Cas.lua' )
-__Moose.Include( 'AI\\AI_Bai.lua' )
-__Moose.Include( 'AI\\AI_Formation.lua' )
-__Moose.Include( 'AI\\AI_Escort.lua' )
-__Moose.Include( 'AI\\AI_Escort_Request.lua' )
-__Moose.Include( 'AI\\AI_Escort_Dispatcher.lua' )
-__Moose.Include( 'AI\\AI_Escort_Dispatcher_Request.lua' )
-__Moose.Include( 'AI\\AI_Cargo.lua' )
-__Moose.Include( 'AI\\AI_Cargo_APC.lua' )
-__Moose.Include( 'AI\\AI_Cargo_Helicopter.lua' )
-__Moose.Include( 'AI\\AI_Cargo_Airplane.lua' )
-__Moose.Include( 'AI\\AI_Cargo_Ship.lua' )
-__Moose.Include( 'AI\\AI_Cargo_Dispatcher.lua' )
-__Moose.Include( 'AI\\AI_Cargo_Dispatcher_APC.lua' )
-__Moose.Include( 'AI\\AI_Cargo_Dispatcher_Helicopter.lua' )
-__Moose.Include( 'AI\\AI_Cargo_Dispatcher_Airplane.lua' )
-__Moose.Include( 'AI\\AI_Cargo_Dispatcher_Ship.lua' )
-
-__Moose.Include( 'Actions\\Act_Assign.lua' )
-__Moose.Include( 'Actions\\Act_Route.lua' )
-__Moose.Include( 'Actions\\Act_Account.lua' )
-__Moose.Include( 'Actions\\Act_Assist.lua' )
 
 __Moose.Include( 'Sound\\UserSound.lua' )
 __Moose.Include( 'Sound\\SoundOutput.lua' )
@@ -162,24 +116,4 @@ __Moose.Include( 'Sound\\RadioQueue.lua' )
 __Moose.Include( 'Sound\\RadioSpeech.lua' )
 __Moose.Include( 'Sound\\SRS.lua' )
 
-__Moose.Include( 'Tasking\\CommandCenter.lua' )
-__Moose.Include( 'Tasking\\Mission.lua' )
-__Moose.Include( 'Tasking\\Task.lua' )
-__Moose.Include( 'Tasking\\TaskInfo.lua' )
-__Moose.Include( 'Tasking\\Task_Manager.lua' )
-__Moose.Include( 'Tasking\\DetectionManager.lua' )
-__Moose.Include( 'Tasking\\Task_A2G_Dispatcher.lua' )
-__Moose.Include( 'Tasking\\Task_A2G.lua' )
-__Moose.Include( 'Tasking\\Task_A2A_Dispatcher.lua' )
-__Moose.Include( 'Tasking\\Task_A2A.lua' )
-__Moose.Include( 'Tasking\\Task_Cargo.lua' )
-__Moose.Include( 'Tasking\\Task_Cargo_Transport.lua' )
-__Moose.Include( 'Tasking\\Task_Cargo_CSAR.lua' )
-__Moose.Include( 'Tasking\\Task_Cargo_Dispatcher.lua' )
-__Moose.Include( 'Tasking\\Task_Capture_Zone.lua' )
-__Moose.Include( 'Tasking\\Task_Capture_Dispatcher.lua' )
-
-__Moose.Include( 'Navigation\\Point.lua' )
-__Moose.Include( 'Navigation\\Beacons.lua' )
-
 __Moose.Include( 'Globals.lua' )

Moose Development/Moose/Navigation/Beacons.lua

@@ -1,139 +0,0 @@
---- **NAVIGATION** - Beacons of the map/theatre.
---
--- **Main Features:**
---
---    * Beacons of the map
--- 
--- ===
---
--- ## Example Missions:
---
--- Demo missions can be found on [github](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/Navigation%20-%20Beacons).
--- 
--- ===
---
--- ### Author: **funkyfranky**
--- 
--- ===
--- @module Navigation.Beacons
--- @image NAVIGATION_Beacons.png
-
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- BEACONS class.
--- @type BEACONS
--- 
--- @field #string ClassName Name of the class.
--- @field #number verbose Verbosity of output.
--- @field #table beacons Beacons.
--- 
--- @extends Core.Base#BASE
-
---- *A fleet of British ships at war are the best negotiators.* -- Horatio Nelson
---
--- ===
---
--- # The BEACONS Concept
---
--- The NAVFIX class has a great concept!
--- 
--- Bla, bla...
--- 
--- # Basic Setup
--- 
--- A new `BEACONS` object can be created with the @{#BEACONS.New}() function.
--- 
---     local beacons=BEACONS:New("G:\Games\DCS World Testing\Mods\terrains\GermanyColdWar\beacons.lua")
---     
--- This is how it works.
---
--- @field #BEACONS
-BEACONS = {
-  ClassName  = "BEACONS",
-  verbose    =         0,
-  beacons    =        {},
-}
-
---- BEACONS class version.
--- @field #string version
-BEACONS.version="0.0.0"
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- ToDo list
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
--- TODO: A lot...
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- Constructor(s)
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- Create a new BECAONS class instance from a given file.
--- @param #BEACONS self
--- @param #string FileName Full path to the file containing the map beacons.
--- @return #BEACONS self
-function BEACONS:NewFromFile(FileName)
-
-  -- Inherit everything from BASE class.
-  self=BASE:Inherit(self, BASE:New()) -- #BEACONS
-
-  return self
-end
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- User Functions
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- Add marker all beacons on the F10 map.
--- @param #BEACONS self
--- @return #BEACONS self
-function BEACONS:MarkerShow()
-
-  return self
-end
-
---- Remove markers of all beacons from the F10 map.
--- @param #BEACONS self
--- @return #BEACONS self
-function BEACONS:MarkerRemove()
-
-  return self
-end
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- Private Functions
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- Get text displayed in the F10 marker.
--- @param #BEACONS self
--- @return #string Marker text.
-function BEACONS:_GetMarkerText(beacon)
-
-  local altmin=self.altMin and tostring(self.altMin) or ""
-  local altmax=self.altMax and tostring(self.altMax) or ""
-  local speedmin=self.speedMin and tostring(self.speedMin) or ""
-  local speedmax=self.speedMax and tostring(self.speedMax) or ""
-
-
-  local text=string.format("NAVFIX %s", self.name)
-  if self.isIAF then
-    text=text..string.format(" (IAF)")
-  end
-  if self.isIF then
-    text=text..string.format(" (IF)")
-  end
-  text=text..string.format("\nAltitude [ft]: %s - %s", altmin, altmax)
-  text=text..string.format("\nSpeed [knots]: %s - %s", speedmin, speedmax)
-  text=text..string.format("\nCompulsory: %s", tostring(self.isCompulsory))
-  text=text..string.format("\nFly Over: %s", tostring(self.isFlyover))
-  
-  return text
-end
-
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Moose Development/Moose/Navigation/FlightPlan.lua

@@ -1,481 +0,0 @@
---- **NAVIGATION** - Flight Plan.
---
--- **Main Features:**
---
---    * Manage navigation aids
---    * VOR, NDB
--- 
--- ===
---
--- ## Example Missions:
---
--- Demo missions can be found on [github](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/Ops%20-%20FlightPlan).
--- 
--- ===
---
--- ### Author: **funkyfranky**
--- 
--- ===
--- @module Navigation.FlightPlan
--- @image NAVIGATION_FlightPlan.png
-
-
---- FLIGHTPLAN class.
--- @type FLIGHTPLAN
--- @field #string ClassName Name of the class.
--- @field #number verbose Verbosity of output.
--- @field #table fixes Navigation fixes.
--- @field Core.Pathline#PATHLINE pathline Pathline of the plan.
--- @field Wrapper.Airbase#AIRBASE departureAirbase Departure airbase.
--- @field Wrapper.Airbase#AIRBASE destinationAirbase Destination airbase.
--- @field #number altitudeCruiseMin Minimum cruise altitude in feet MSL.
--- @field #number altitudeCruiseMax Maximum cruise altitude in feet MSL.
--- @extends Core.Pathline#PATHLINE
-
---- *Life is what happens to us while we are making other plans.* -- Allen Saunders
---
--- ===
---
--- # The FLIGHTPLAN Concept
---
--- This class has a great concept!
--- 
--- # Basic Setup
--- 
--- A new `FLIGHTPLAN` object can be created with the @{#FLIGHTPLAN.New}() function.
--- 
---     myFlightplan=FLIGHTPLAN:New("Plan A")
---     myFleet:SetPortZone(ZonePort1stFleet)
---     myFleet:Start()
---     
--- A fleet needs a *port zone*, which is set via the @{#FLIGHTPLAN.SetPortZone}(`PortZone`) function. This is the zone where the naval assets are spawned and return to.
--- 
--- Finally, the fleet needs to be started using the @{#FLIGHTPLAN.Start}() function. If the fleet is not started, it will not process any requests.
---
--- @field #FLIGHTPLAN
-FLIGHTPLAN = {
-  ClassName       = "FLIGHTPLAN",
-  verbose         =       0,
-  fixes           = {}
-}
-
---- Type of  flightplan.
--- @type FLIGHTPLAN.Type
--- @field #string IFRH Instrument Flying Rules High Altitude.
--- @field #string IFRL Instrument Flying Rules Low Altitude.
--- @field #string VFR Visual Flight Rules.
-FLIGHTPLAN.Type={
-  IFRH = "IFR High",
-  IFRL = "IFR Low",
-  VFR  = "VFR",
-}
-
-
-  
---- FLIGHTPLAN class version.
--- @field #string version
-FLIGHTPLAN.version="0.0.1"
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- ToDo list
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
--- TODO: How to connect SID, STAR, ENROUTE, TRANSITION, APPROACH. Typical flightplan SID --> ENROUTE --> STAR --> APPROACH
--- TODO: Add approach.
--- DONE: How to handle the FLIGHTGROUP:_LandAtAirBase
--- TODO: Do we always need a holding pattern? https://www.faa.gov/air_traffic/publications/atpubs/aip_html/part2_enr_section_1.5.html#:~:text=If%20no%20holding%20pattern%20is,than%20that%20desired%20by%20ATC.
--- DOEN: Read from MSFS file.
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- Constructor
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- Create a new FLIGHTPLAN instance.
--- @param #FLIGHTPLAN self
--- @param #string Name Name of this flight plan.
--- @return #FLIGHTPLAN self
-function FLIGHTPLAN:New(Name)
-
-  -- Inherit everything from BASE class.
-  self=BASE:Inherit(self, PATHLINE:New(Name)) -- #FLIGHTPLAN
-
-  -- Set alias.
-  self.alias=tostring(Name)
-  
-  -- Set some string id for output to DCS.log file.
-  self.lid=string.format("FLIGHTPLAN %s | ", self.alias)
-  
-  --self.pathline=PATHLINE:New(Name)
-  
-  -- Debug info.
-  self:I(self.lid..string.format("Created FLIGHTPLAN!"))
-
-  return self
-end
-
---- Create a new FLIGHTPLAN instance from another FLIGHTPLAN acting as blue print.
--- The newly created flight plan is deep copied from the given one.
--- @param #FLIGHTPLAN self
--- @param #FLIGHTPLAN FlightPlan Blue print of the flight plan to copy.
--- @return #FLIGHTPLAN self
-function FLIGHTPLAN:NewFromFlightPlan(FlightPlan)
-  self=UTILS.DeepCopy(FlightPlan)
-  return self
-end
-
-
---- Create a new FLIGHTPLAN instance from a given file.
--- Currently, the file has to be an MSFS 2020 .pln file as, *e.g.*, exported from [Navigraph](https://navigraph.com/).
--- 
--- **Note** that the flight plan does only cover the departure, enroute and arrival portions but **not the approach** part!
--- @param #FLIGHTPLAN self
--- @param #string FileName Full path to file.
--- @return #FLIGHTPLAN self
-function FLIGHTPLAN:NewFromFile(FileName)
-
-  if UTILS.FileExists(FileName) then
-  
-    self=FLIGHTPLAN._ReadFileMSFS(FileName)  
-  
-  else
-    error(string.format("ERROR: File not found! File name=%s", tostring(FileName)))  
-  end
-
-  return self
-end
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- User Functions
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- Add navigation fix to the flight plan.
--- @param #FLIGHTPLAN self
--- @param Navigation.Point#NAVPOINT NavFix The nav fix.
--- @return #FLIGHTPLAN self
-function FLIGHTPLAN:AddNavFix(NavFix)
-
-  table.insert(self.fixes, NavFix)
-  
-  local point=self:AddPointFromVec3(NavFix.vector:GetVec3(true))
-  
-  point.navpoint=NavFix
-
-  return self
-end
-
-
---- Set departure airbase.
--- @param #FLIGHTPLAN self
--- @param #string AirbaseName Name of the airbase or AIRBASE object.
--- @return #FLIGHTPLAN self
-function FLIGHTPLAN:SetDepartureAirbase(AirbaseName)
-
-  self.departureAirbase=AIRBASE:FindByName(AirbaseName)
- 
-  return self
-end
-
---- Set destination airbase.
--- @param #FLIGHTPLAN self
--- @param #string AirbaseName Name of the airbase or AIRBASE object.
--- @return #FLIGHTPLAN self
-function FLIGHTPLAN:SetDestinationAirbase(AirbaseName)
-
-  self.destinationAirbase=AIRBASE:FindByName(AirbaseName)
-
-  return self
-end
-
-
---- Set cruise altitude.
--- @param #FLIGHTPLAN self
--- @param #number AltMin Minimum altitude in feet MSL.
--- @param #number AltMax Maximum altitude in feet MSL. Default is `AltMin`.
--- @return #FLIGHTPLAN self
-function FLIGHTPLAN:SetCruiseAltitude(AltMin, AltMax)
-
-  self.altitudeCruiseMin=AltMin
-  self.altitudeCruiseMax=AltMax or self.altitudeCruiseMin
-
-  return self
-end
-
---- Set cruise speed.
--- @param #FLIGHTPLAN self
--- @param #number SpeedMin Minimum speed in knots.
--- @param #number SpeedMax Maximum speed in knots. Default is `SpeedMin`.
--- @return #FLIGHTPLAN self
-function FLIGHTPLAN:SetCruiseSpeed(SpeedMin, SpeedMax)
-
-  self.speedCruiseMin=SpeedMin
-  self.speedCruiseMax=SpeedMax or self.speedCruiseMin
-
-  return self
-end
-
-
---- Get the name of this flight plan.
--- @param #FLIGHTPLAN self
--- @return #string The name.
-function FLIGHTPLAN:GetName()
-  return self.alias
-end
-
-
---- Get cruise altitude. This returns a random altitude between the set min/max cruise altitudes.
--- @param #FLIGHTPLAN self
--- @return #number Cruise altitude in feet MSL.
-function FLIGHTPLAN:GetCruiseAltitude()
-
-  local alt=10000
-  if self.altitudeCruiseMin and self.altitudeCruiseMax then
-    alt=math.random(self.altitudeCruiseMin, self.altitudeCruiseMax)
-  elseif self.altitudeCruiseMin then
-    alt=self.altitudeCruiseMin
-  elseif self.altitudeCruiseMax then
-    alt=self.altitudeCruiseMax
-  end
-  
-  return alt
-end
-
---- Get cruise speed. This returns a random speed between the set min/max cruise speeds.
--- @param #FLIGHTPLAN self
--- @return #number Cruise speed in knots.
-function FLIGHTPLAN:GetCruiseSpeed()
-
-  local speed=250
-  
-  if self.speedCruiseMin and self.speedCruiseMax then
-    speed=math.random(self.speedCruiseMin, self.speedCruiseMax)
-  elseif self.speedCruiseMin then
-    speed=self.speedCruiseMin
-  elseif self.altitudeCruiseMax then
-    speed=self.speedCruiseMax
-  end
-  
-  return speed
-end
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- Private Functions
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- Read flight plan from a given MSFS 2020 .plt file.
--- @param #string FileName Name of the file.
--- @return #FLIGHTPLAN The flight plan.
-function FLIGHTPLAN._ReadFileMSFS(FileName)
-
-  local function readfile(filename)
-
-    local lines = {}
-    
-    -- Open file in read binary mode.
-    local file=assert(io.open(filename, "rb"), string.format("File not found! File name = %s", tostring(filename)))
-
-    for line in file:lines() do
-        lines[#lines+1] = line
-    end
-    
-    -- Close file.
-    file:close()
-  
-    -- Return data
-    return lines
-  end
-
-
-  --- This function returns an XML element, i.e. the string between <...> and </...>.
-  local function getXMLelement(line)
-    local element=string.match(line, ">(.+)<")
-    return element
-  end
-
-  --- This function returns Latitude and Longitude
-  local function getLatLong(line)
-    local latlong=getXMLelement(line)
-    -- The format is "N41° 38' 20.00",E41° 33' 19.00",+000000.00" so we still need to process that.
-    local lat,long=string.match(latlong, "(.+),(.+),")
-    return lat,long
-  end
-  
-  -- Read data from file.
-  local data=readfile(FileName)
-
-  local flightplan={}
-  local waypoints={}
-  local wp=nil
-  
-  local gotwaypoint=false
-  for i,line in pairs(data) do
-  
-  
-    --print(line)
-  
-    -- Title  
-    if string.find(line, "<Title>") then
-      flightplan.title=getXMLelement(line)
-    end
-  
-    -- Departure ICAO
-    if string.find(line, "<DepartureID>") then
-      flightplan.departureICAO=getXMLelement(line)
-    end
-  
-    -- Destination ICAO
-    if string.find(line, "<DestinationID>") then
-      flightplan.destinationICAO=getXMLelement(line)
-    end
-  
-    -- FPType  
-    if string.find(line, "<FPType>") then
-      flightplan.plantype=getXMLelement(line)
-    end
-    
-    -- Route type  
-    if string.find(line, "<RouteType>") then
-      flightplan.routetype=getXMLelement(line)
-    end
-  
-    -- Cruise alt in feet
-    if string.find(line, "<CruisingAlt>") then
-      flightplan.altCruise=getXMLelement(line)
-    end
-  
-    -- Departure LLA
-    if string.find(line, "<DepartureLLA>") then
-      local lat,long=getLatLong(line)    
-    end
-    
-    -- Destination LLA
-    if string.find(line, "<DestinationLLA>") then
-      local lat,long=getLatLong(line)    
-    end  
-  
-    -- Departure Name
-    if string.find(line, "<DepartureName>") then
-      local DepartureName=getXMLelement(line)
-    end
-      
-    -- DestinationName
-    if string.find(line, "<DestinationName>") then
-      local DestinationName=getXMLelement(line)
-    end
-      
-    ---
-    -- Waypoint stuff
-    ---
-  
-    -- New waypoint starts.
-    if string.find(line, "ATCWaypoint id") then
-    
-      --Get string inside quotes " and ". 
-      local wpid=string.match(line, [["(.+)"]]) 
-      
-      -- Create a new wp table.
-      wp={}
-      
-      -- Set waypoint name.
-      wp.name=wpid
-    end
-    
-    -- Waypoint info ends.
-    if string.find(line, "</ATCWaypoint>") then
-      -- This is the end of the waypoint.
-      
-      -- Add info to waypoints table.
-      table.insert(waypoints, wp)
-      
-      -- Set waypoint to nil. We create an empty table if the next wp starts.
-      wp=nil
-    end
-    
-    -- Waypoint type (Airport, Intersection, NDB, VORTAC)
-    if string.find(line, "<ATCWaypointType>") then
-      local wptype=getXMLelement(line)
-      wp.type=wptype
-    end
-    
-    -- Waypoint position.
-    if string.find(line, "<WorldPosition>") then
-      wp.lat, wp.long=getLatLong(line)
-    end
-    
-    -- Runway should exist for initial and final WP if it is an airport.
-    if string.find(line, "RunwayNumberFP") then
-      wp.runway=getXMLelement(line)
-    end
-    
-    -- Runway designator: LEFT, RIGHT, CENTER
-    if string.find(line, "RunwayDesignatorFP") then 
-      wp.runwayDesignator=getXMLelement(line)
-    end  
-    
-    -- Segment is Departure
-    if string.find(line, "<DepartureFP>") then
-      wp.segment="Departure"
-    end
-    
-    -- Segment is Arrival
-    if string.find(line, "<ArrivalFP>") then
-      wp.segment="Arrival"
-    end
-    
-    -- Segment is Enroute
-    if string.find(line, "<ATCAirway>") then
-      wp.segment="Enroute"
-    end
-  
-    -- Approach type: VORDME, LOCALIZER
-    if string.find(line, "ApproachTypeFP") then
-      flightplan.approachtype=getXMLelement(line)
-    end
-  
-    -- Approach type suffic: Z
-    if string.find(line, "SuffixFP") then
-      local SuffixFP=getXMLelement(line)
-    end
-    
-  end
-    
-  for key, value in pairs(flightplan) do
-    env.info(string.format("Flightplan %s=%s", key, tostring(value)))
-  end
-
-  env.info(string.format("Number of waypoints=%d", #waypoints))  
-  for i,wp in pairs(waypoints) do
-    env.info(string.format("Waypoint name=%s type=%s segment=%s runway=%s lat=%s long=%s", wp.name, wp.type, tostring(wp.segment), tostring(wp.runway)..tostring(wp.runwayDesignator or ""), wp.lat, wp.long))
-  end
-  
-  -- Create a new flightplan.
-  local fp=FLIGHTPLAN:New(flightplan.title)
-  
-  -- Set cruise altitude.
-  fp:SetCruiseAltitude(flightplan.altCruise)
-  
-  -- Set departure and destination airports.
-  fp:SetDepartureAirbase(flightplan.departureICAO)
-  fp:SetDestinationAirbase(flightplan.destinationICAO)
-  
-  --TODO: Remove first and last waypoint if they are identical to the departure/destination airport!
-  
-  for i,wp in pairs(waypoints) do
-      
-    -- Create a navpoint.
-    local navpoint=NAVPOINT:NewFromLLDMS(wp.name, wp.type, wp.lat, wp.long)
-    
-    navpoint:SetAltMin(flightplan.altCruise)
-  
-    -- Add point to flightplan.
-    -- TODO: section departure, enroute, arrival.
-    fp:AddNavFix(navpoint)  
-  end
-
-  
-
-  return fp
-end
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Moose Development/Moose/Navigation/Point.lua

@@ -1,587 +0,0 @@
---- **NAVIGATION** - Navigation Airspace Points, Fixes and Aids.
---
--- **Main Features:**
---
---    * Stuff
---    * More Stuff
--- 
--- ===
---
--- ## Example Missions:
---
--- Demo missions can be found on [github](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/Navigation%20-%20NavFix).
--- 
--- ===
---
--- ### Author: **funkyfranky**
--- 
--- ===
--- @module Navigation.Point
--- @image NAVIGATION_Point.png
-
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- NAVFIX class.
--- @type NAVFIX
--- 
--- @field #string ClassName Name of the class.
--- @field #number verbose Verbosity of output.
--- @field #string name Name of the point.
--- @field #string typePoint Type of the point, *e.g. "Intersection", "VOR", "Airport".
--- @field Core.Vector#VECTOR vector Position vector of the fix.
--- @field Wrapper.Marker#MARKER marker Marker on F10 map.
--- @field #number altMin Minimum altitude in meters.
--- @field #number altMax Maximum altitude in meters.
--- @field #number speedMin Minimum speed in knots.
--- @field #number speedMax Maximum speed in knots.
--- 
--- @field #boolean isCompulsory Is this a compulsory fix.
--- @field #boolean isFlyover Is this a flyover fix (`true`) or turning point otherwise.
--- @field #boolean isFAF Is this a final approach fix.
--- @field #boolean isIAF Is this an initial approach fix.
--- @field #boolean isIF Is this an initial fix.
--- @field #boolean isMAF Is this an initial fix.
--- 
--- @extends Core.Base#BASE
-
---- *A fleet of British ships at war are the best negotiators.* -- Horatio Nelson
---
--- ===
---
--- # The NAVFIX Concept
---
--- The NAVFIX class has a great concept!
--- 
--- A NAVFIX describes a geo position and can, *e.g.*, be part of a FLIGHTPLAN. It has a unique name and is of a certain type, *e.g.* "Intersection", "VOR", "Airbase" etc.
--- It can also have further properties as min/max altitudes and speeds that aircraft need to obey when they pass the point.
--- 
--- # Basic Setup
--- 
--- A new `NAVFIX` object can be created with the @{#NAVFIX.New}() function.
--- 
---     myNavPoint=NAVFIX:New()
---     myTemplate:SetXYZ(X, Y, Z)
---     
--- This is how it works.
---
--- @field #NAVFIX
-NAVFIX = {
-  ClassName       = "NAVFIX",
-  verbose         =          0,
-}
-
---- Type of point.
--- @type NAVFIX.Type
--- @field #string POINT Waypoint.
--- @field #string INTERSECTION Intersection of airway.
--- @field #string AIRPORT Airport.
--- @field #string VOR Very High Frequency Omnidirectional Range Station.
--- @field #string DME Distance Measuring Equipment.
--- @field #string NDB Non-Directional Beacon.
--- @field #string VORDME Combined VHF omnidirectional range (VOR) with a distance-measuring equipment (DME).
--- @field #string LOC Localizer.
--- @field #string ILS Instrument Landing System.
--- @field #string TACAN TACtical Air Navigation System (TACAN).
-NAVFIX.Type={
-  POINT="Point",
-  INTERSECTION="Intersection",
-  AIRPORT="Airport",
-  NDB="NDB",
-  VOR="VOR",
-  DME="DME",
-  VORDME="VOR/DME",
-  LOC="Localizer",
-  ILS="ILS",
-  TACAN="TACAN"
-}
-
---- NAVFIX class version.
--- @field #string version
-NAVFIX.version="0.0.1"
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- ToDo list
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
--- TODO: A lot...
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- Constructor(s)
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- Create a new NAVFIX class instance from a given VECTOR.
--- @param #NAVFIX self
--- @param #string Name Name/ident of the point. Should be unique!
--- @param #string Type Type of the point. Default `NAVFIX.Type.POINT`.
--- @param Core.Vector#VECTOR Vector Position vector of the navpoint.
--- @return #NAVFIX self
-function NAVFIX:NewFromVector(Name, Type, Vector)
-
-  -- Inherit everything from BASE class.
-  self=BASE:Inherit(self, BASE:New()) -- #NAVFIX
-  
-  -- Vector of point.
-  self.vector=Vector
-  
-  -- Name of point.
-  self.name=Name
-  
-  -- Type of the point.
-  self.typePoint=Type or NAVFIX.Type.POINT
-  
-  local coord=COORDINATE:NewFromVec3(self.vector)
-  
-  -- Marker on F10.
-  self.marker=MARKER:New(coord, self:_GetMarkerText())
-  
-  -- Log ID string.
-  self.lid=string.format("NAVFIX %s [%s] | ", tostring(self.name), tostring(self.typePoint))
-  
-  -- Debug info.
-  self:I(self.lid..string.format("Created NAVFIX"))
-
-  return self
-end
-
-
---- Create a new NAVFIX class instance from a given COORDINATE.
--- @param #NAVFIX self
--- @param #string Name Name of the fix. Should be unique!
--- @param #string Type Type of the point. Default `NAVFIX.Type.POINT`.
--- @param Core.Point#COORDINATE Coordinate Coordinate of the point.
--- @return #NAVFIX self
-function NAVFIX:NewFromCoordinate(Name, Type, Coordinate)
-
-  -- Create a VECTOR from the coordinate.
-  local Vector=VECTOR:NewFromVec(Coordinate)
-  
-  -- Create NAVFIX.
-  self=NAVFIX:NewFromVector(Name, Type, Vector)
-  
-  return self
-end
-
-
---- Create a new NAVFIX instance from given latitude and longitude in degrees, minutes and seconds (DMS).
--- @param #NAVFIX self
--- @param #string Name Name of the fix. Should be unique!
--- @param #string Type Type of the point. Default `NAVFIX.Type.POINT`.
--- @param #string Latitude Latitude in DMS as string.
--- @param #string Longitude Longitude in DMS as string.
--- @return #NAVFIX self
-function NAVFIX:NewFromLLDMS(Name, Type, Latitude, Longitude)
-
-  -- Create a VECTOR from the coordinate.
-  local Vector=VECTOR:NewFromLLDMS(Latitude, Longitude)
-
-  -- Create NAVFIX.
-  self=NAVFIX:NewFromVector(Name, Type, Vector)
-  
-  return self  
-end
-
---- Create a new NAVFIX instance from given latitude and longitude in decimal degrees (DD).
--- @param #NAVFIX self
--- @param #string Name Name of the fix. Should be unique!
--- @param #string Type Type of the point. Default `NAVFIX.Type.POINT`.
--- @param #number Latitude Latitude in DD.
--- @param #number Longitude Longitude in DD.
--- @return #NAVFIX self
-function NAVFIX:NewFromLLDD(Name, Type, Latitude, Longitude)
-
-  -- Create a VECTOR from the coordinate.
-  local Vector=VECTOR:NewFromLLDD(Latitude, Longitude)
-
-  -- Create NAVFIX.
-  self=NAVFIX:NewFromVector(Name, Type, Vector)
-  
-  return self  
-end
-
-
---- Create a new NAVFIX class instance relative to a given other NAVFIX.
--- You have to specify the distance and bearing from the new point to the given point. *E.g.*, for a distance of 5 NM and a bearing of 090° (West), the
--- new nav point is created 5 NM East of the given nav point. The reason is that this corresponts to convention used in most maps.
--- You can, however, use the `Reciprocal` switch to create the new point in the direction you specify.
--- @param #NAVFIX self
--- @param #string Name Name of the fix. Should be unique!
--- @param #string Type Type of navfix.
--- @param #NAVFIX NavFix The given/existing navigation fix relative to which the new fix is created.
--- @param #number Distance Distance from the given to the new point in nautical miles.
--- @param #number Bearing Bearing [Deg] from the new point to the given one.
--- @param #boolean Reciprocal If `true` the reciprocal `Bearing` is taken so it specifies the direction from the given point to the new one. 
--- @return #NAVFIX self
-function NAVFIX:NewFromNavFix(Name, Type, NavFix, Distance, Bearing, Reciprocal)
-
-  -- Convert magnetic to true bearing by adding magnetic declination, e.g. mag. bearing 10°M ==> true bearing 16°M (for 6° variation on Caucasus map)
-  Bearing=Bearing+UTILS.GetMagneticDeclination()
-
-  if Reciprocal then
-    Bearing=Bearing-180
-  end
-  
-  -- Translate.
-  local Vector=NavFix.vector:Translate(UTILS.NMToMeters(Distance), Bearing, true)
-  
-  self=NAVFIX:NewFromVector(Name, Type, Vector)
-  
-  return self
-end
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- User Functions
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- Set whether this is the intermediate fix (IF).
--- @param #NAVFIX self
--- @return #NAVFIX self
-function NAVFIX:SetIntermediateFix(IntermediateFix)
-  self.isIF=IntermediateFix
-  return self
-end
-
---- Set whether this is an initial approach fix (IAF).
--- The IAF is the point where the initial approach segment of an instrument approach begins.
--- It is usually a designated intersection, VHF omidirectional range (VOR) non-directional beacon (NDB)
--- or distance measuring equipment (DME) fix.
--- The IAF may be collocated with the intermediate fix (IF) of the instrument apprach an in such case they designate the
--- beginning of the intermediate segment of the approach. When the IAF and the IF are combined, there is no inital approach segment.
--- @param #NAVFIX self
--- @param #boolean IntermediateFix If `true`, this is an intermediate fix.
--- @return #NAVFIX self
-function NAVFIX:SetInitialApproachFix(IntermediateFix)
-  self.isIAF=IntermediateFix
-  return self
-end
-
-
---- Set whether this is the final approach fix (FAF).
--- @param #NAVFIX self
--- @param #boolean FinalApproachFix If `true`, this is a final approach fix.
--- @return #NAVFIX self
-function NAVFIX:SetFinalApproachFix(FinalApproachFix)
-  self.isFAF=FinalApproachFix
-  return self
-end
-
---- Set whether this is the final approach fix (FAF).
--- @param #NAVFIX self
--- @param #boolean FinalApproachFix If `true`, this is a final approach fix.
--- @return #NAVFIX self
-function NAVFIX:SetMissedApproachFix(MissedApproachFix)
-  self.isMAF=MissedApproachFix
-  return self
-end
-
-
---- Set minimum altitude.
--- @param #NAVFIX self
--- @param #number Altitude Min altitude in feet.
--- @return #NAVFIX self
-function NAVFIX:SetAltMin(Altitude)
-
-  self.altMin=Altitude
-
-  return self
-end
-
---- Set maximum altitude.
--- @param #NAVFIX self
--- @param #number Altitude Max altitude in feet.
--- @return #NAVFIX self
-function NAVFIX:SetAltMax(Altitude)
-
-  self.altMax=Altitude
-
-  return self
-end
-
---- Set mandatory altitude (min alt = max alt).
--- @param #NAVFIX self
--- @param #number Altitude Altitude in feet.
--- @return #NAVFIX self
-function NAVFIX:SetAltMandatory(Altitude)
-
-  self.altMin=Altitude
-  self.altMax=Altitude
-
-  return self
-end
-
---- Set minimum allowed speed at this fix.
--- @param #NAVFIX self
--- @param #number Speed Min speed in knots.
--- @return #NAVFIX self
-function NAVFIX:SetSpeedMin(Speed)
-
-  self.speedMin=Speed
-
-  return self
-end
-
---- Set maximum allowed speed at this fix.
--- @param #NAVFIX self
--- @param #number Speed Max speed in knots.
--- @return #NAVFIX self
-function NAVFIX:SetSpeedMax(Speed)
-
-  self.speedMax=Speed
-
-  return self
-end
-
---- Set mandatory speed (min speed = max speed) at this fix.
--- @param #NAVFIX self
--- @param #number Speed Mandatory speed in knots.
--- @return #NAVFIX self
-function NAVFIX:SetSpeedMandatory(Speed)
-
-  self.speedMin=Speed
-  self.speedMax=Speed
-
-  return self
-end
-
-
---- Set whether this fix is compulsory.
--- @param #NAVFIX self
--- @param #boolean Compulsory If `true`, this is a compusory fix. If `false` or nil, it is non-compulsory.
--- @return #NAVFIX self
-function NAVFIX:SetCompulsory(Compulsory)
-  self.isCompulsory=Compulsory
-  return self
-end
-
---- Set whether this is a fly-over fix fix.
--- @param #NAVFIX self
--- @param #boolean FlyOver If `true`, this is a fly over fix. If `false` or nil, it is not.
--- @return #NAVFIX self
-function NAVFIX:SetFlyOver(FlyOver)
-  self.isFlyover=FlyOver
-  return self
-end
-
-
---- Get the altitude in feet MSL. If min and max altitudes are set, it will return a random altitude between min and max.
--- @param #NAVFIX self
--- @return #number Altitude in feet MSL. Can be `nil`, if neither min nor max altitudes have beeen set. 
-function NAVFIX:GetAltitude()
-
-  local alt=nil
-  if self.altMin and self.altMax and self.altMin~=self.altMax then
-    alt=math.random(self.altMin, self.altMax)
-  elseif self.altMin then
-    alt=self.altMin
-  elseif self.altMax then
-    alt=self.altMax
-  end
-
-  return alt
-end
-
-
---- Get the speed. If min and max speeds are set, it will return a random speed between min and max.
--- @param #NAVFIX self
--- @return #number Speed in knots. Can be `nil`, if neither min nor max speeds have beeen set. 
-function NAVFIX:GetSpeed()
-
-  local speed=nil
-  if self.speedMin and self.speedMax and self.speedMin~=self.speedMax then
-    speed=math.random(self.speedMin, self.speedMax)
-  elseif self.speedMin then
-    speed=self.speedMin
-  elseif self.speedMax then
-    speed=self.speedMax
-  end
-
-  return speed
-end
-
-
-
---- Add marker the NAVFIX on the F10 map.
--- @param #NAVFIX self
--- @return #NAVFIX self
-function NAVFIX:MarkerShow()
-
-  self.marker:ToAll()
-
-  return self
-end
-
---- Remove marker of the NAVFIX from the F10 map.
--- @param #NAVFIX self
--- @return #NAVFIX self
-function NAVFIX:MarkerRemove()
-
-  self.marker:Remove()
-
-  return self
-end
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- Private Functions
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- Get text displayed in the F10 marker.
--- @param #NAVFIX self
--- @return #string Marker text.
-function NAVFIX:_GetMarkerText()
-
-  local altmin=self.altMin and tostring(self.altMin) or ""
-  local altmax=self.altMax and tostring(self.altMax) or ""
-  local speedmin=self.speedMin and tostring(self.speedMin) or ""
-  local speedmax=self.speedMax and tostring(self.speedMax) or ""
-
-
-  local text=string.format("NAVFIX %s", self.name)
-  if self.isIAF then
-    text=text..string.format(" (IAF)")
-  end
-  if self.isIF then
-    text=text..string.format(" (IF)")
-  end
-  text=text..string.format("\nAltitude [ft]: %s - %s", altmin, altmax)
-  text=text..string.format("\nSpeed [knots]: %s - %s", speedmin, speedmax)
-  text=text..string.format("\nCompulsory: %s", tostring(self.isCompulsory))
-  text=text..string.format("\nFly Over: %s", tostring(self.isFlyover))
-  
-  return text
-end
-
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- NAVAID class.
--- @type NAVAID
--- @field #string ClassName Name of the class.
--- @field #number verbose Verbosity of output.
--- @extends Navigation.Point#NAVFIX
-
---- *A fleet of British ships at war are the best negotiators.* -- Horatio Nelson
---
--- ===
---
--- # The NAVAID Concept
---
--- A NAVAID consists of one or multiple FLOTILLAs. These flotillas "live" in a WAREHOUSE that has a phyiscal struction (STATIC or UNIT) and can be captured or destroyed.
--- 
--- # Basic Setup
--- 
--- A new `NAVAID` object can be created with the @{#NAVAID.New}(`WarehouseName`, `FleetName`) function, where `WarehouseName` is the name of the static or unit object hosting the fleet
--- and `FleetName` is the name you want to give the fleet. This must be *unique*!
--- 
---     myFleet=NAVAID:New("myWarehouseName", "1st Fleet")
---     myFleet:SetPortZone(ZonePort1stFleet)
---     myFleet:Start()
---     
--- A fleet needs a *port zone*, which is set via the @{#NAVAID.SetPortZone}(`PortZone`) function. This is the zone where the naval assets are spawned and return to.
--- 
--- Finally, the fleet needs to be started using the @{#NAVAID.Start}() function. If the fleet is not started, it will not process any requests.
---
--- @field #NAVAID
-NAVAID = {
-  ClassName       = "NAVAID",
-  verbose         =       0,
-}
-  
---- NAVAID class version.
--- @field #string version
-NAVAID.version="0.0.1"
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- ToDo list
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
--- TODO: Add frequencies. Which unit MHz, kHz, Hz?
--- TODO: Add radial function
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- Constructor
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- Create a new NAVAID class instance.
--- @param #NAVAID self
--- @param #string Name Name/ident of this navaid.
--- @param #string Type Type of the point. Default `NAVFIX.Type.POINT`.
--- @param #string ZoneName Name of the zone to scan the scenery.
--- @param #string SceneryName Name of the scenery object.
--- @return #NAVAID self
-function NAVAID:NewFromScenery(Name, Type, ZoneName, SceneryName)
-
-  -- Get the zone.
-  local zone=ZONE:FindByName(ZoneName)
-  
-  -- Get coordinate.
-  local Coordinate=zone:GetCoordinate()
-
-  -- Inherit everything from NAVFIX class.
-  self=BASE:Inherit(self, NAVFIX:NewFromCoordinate(Name, Type, Coordinate)) -- #NAVAID
-
-  -- Set zone.
-  self.zone=ZONE:FindByName(ZoneName)
-
-  -- Try to get the scenery object. Note not all can be found unfortunately.
-  if SceneryName then
-    self.scenery=SCENERY:FindByNameInZone(SceneryName, ZoneName)
-    if not self.scenery then
-      self:E(string.format("ERROR: Could not find scenery object %s in zone %s", SceneryName, ZoneName))
-    end
-  end
-  
-  -- Alias.  
-  self.alias=string.format("%s %s %s", tostring(ZoneName), tostring(SceneryName), tostring(Type))
-  
-  -- Set some string id for output to DCS.log file.
-  self.lid=string.format("NAVAID %s | ", self.alias)
-  
-  -- Debug info.
-  self:I(self.lid..string.format("Created NAVAID!"))
-
-  return self
-end
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- User Functions
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- Set frequency the beacon transmits on.
--- @param #NAVAID self
--- @param #number Frequency Frequency in Hz.
--- @return #NAVAID self
-function NAVAID:SetFrequency(Frequency)
-
-  self.frequency=Frequency
-
-  return self
-end
-
---- Set channel of, *e.g.*, TACAN beacons.
--- @param #NAVAID self
--- @param #number Channel The channel.
--- @param #string Band The band either `"X"` (default) or `"Y"`. 
--- @return #NAVAID self
-function NAVAID:SetChannel(Channel, Band)
-
-  self.channel=Channel
-  self.band=Band or "X"
-
-  return self
-end
-
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- Private Functions
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
--- Add private CLASS functions here.
--- No private NAVAID functions yet.
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Moose Development/Moose/Navigation/Procedure.lua

@@ -1,333 +0,0 @@
---- **NAVIGATION** - Prodedures for Departure (*e.g.* SID), Enroute, Arrival (*e.g.* STAR) and Approach.
---
--- **Main Features:**
---
---    * Stuff
---    * More Stuff
--- 
--- ===
---
--- ## Example Missions:
---
--- Demo missions can be found on [github](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/Navigation%20-%20Template).
--- 
--- ===
---
--- ### Author: **funkyfranky**
--- 
--- ===
--- @module Navigation.Procedure
--- @image NAVIGATION_Procedure.png
-
-
---- APPROACH class.
--- @type APPROACH
--- @field #string ClassName Name of the class.
--- @field #number verbose Verbosity of output.
--- @field #string apptype Approach type (ILS, VOR, LOC).
--- @field Wrapper.Airbase#AIRBASE airbase Airbase of this approach.
--- @field Wrapper.Airbase#AIRBASE.Runway runway Runway of this approach.
--- @field Navigation.Point#NAVAID navaid Primary navigation aid.
--- @field #number wpcounter Running number counting the waypoints to generate its UID.
--- @list <#APPROACH.Waypoint> path Path of approach consisting of waypoints.
--- @extends Core.Base#BASE
-
---- *A fleet of British ships at war are the best negotiators.* -- Horatio Nelson
---
--- ===
---
--- # The APPROACH Concept
--- 
--- A typical approach has (up to) four segments. It starts with the initial approach segment, followed by the intermediate approach segment, followed
--- by the final approach segment. In case something goes wrong during the final approach, the missed approach segment kicks in. 
--- 
--- The initial approach segment starts at the initial approach fix (IAF). The segment can contain multiple other fixes, that need to be passed.
--- Note, that an approach procedure can have more than one intitial approach segment and IAF.
--- 
--- The intermediate approach segment starts at the intermediate fix (IF). The intermediate approach segment blends the initial approach segment into the final approach segment. 
--- It is the segment in which aircraft configuration, speed, and positioning adjustments are made for entry into the final approach segment.
--- 
--- 
--- https://en.wikipedia.org/wiki/Visual_approach
--- https://en.wikipedia.org/wiki/Instrument_approach
--- 
--- # Basic Setup
--- 
--- A new `APPROACH` object can be created with the @{#APPROACH.New}() function.
--- 
---     myTemplate=APPROACH:New()
---     myTemplate:SetXYZ(X, Y, Z)
---     
--- This is how it works.
---
--- @field #APPROACH
-APPROACH = {
-  ClassName       = "APPROACH",
-  verbose         =       0,
-  wpcounter       =       0,
-}
-
---- Type of approach.
--- @type APPROACH.Type
--- @field #string VFR Visual Flight Rules.
--- @field #string VOR VOR
--- @field #string NDB NDB
-APPROACH.Type={
-  VFR="VFR",
-  VOR="VOR",
-  ILS="ILS",
-}
-
-
---- Setments of  approach.
--- @type APPROACH.Segment
--- @field #string INITIAL Initial approach segment.
--- @field #string INTERMEDIATE Intermediate approach segment.
--- @field #string FINAL Final approach segment.
--- @field #string MISSED Missed approach segment.
-APPROACH.Segment={
-  INITIAL="Initial",
-  INTERMEDIATE="Intermediate",
-  FINAL="Final",
-  MISSED="Missed",
-}
- 
---- Waypoint of the approach.
--- @type APPROACH.Waypoint
--- @field #number uid Unique ID of the point.
--- @field #string segment The segment this point belongs to.
--- @field Navigation.Point#NAVFIX navfix The navigation fix that determines the coordinates of this point.
-  
---- APPROACH class version.
--- @field #string version
-APPROACH.version="0.0.1"
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- ToDo list
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
--- TODO: A lot...
--- Initial approach segment --> Intermediate approach segment: starts at IF --> Final approach segment
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- Constructor
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- Create a new APPROACH class instance.
--- @param #APPROACH self
--- @param #string Type Type of approach (ILS, VOR, LOC).
--- @param Wrapper.Airbase#AIRBASE Airbase The airbase or name of the airbase.
--- @param Wrapper.Airbase#AIRBASE.Runway Runway The runway or name of the runway.
--- @return #APPROACH self
-function APPROACH:New(Type, Airbase, Runway)
-
-  -- Inherit everything from BASE class.
-  self=BASE:Inherit(self, BASE:New()) -- #APPROACH
-  
-  -- Set approach type.
-  -- TODO: Check if this is a valid/known approach type.
-  self.apptype=Type
-  
-  if type(Airbase)=="string" then
-    self.airbase=AIRBASE:FindByName(Airbase)
-  else
-    self.airbase=Airbase
-  end
-  
-  if type(Runway)=="string" then
-    self.runway=self.airbase:GetRunwayByName(Runway)
-  else
-    self.runway=Runway
-  end
-  
-  -- Debug info.
-  self:I("Created new approach for airbase %s: type=%s, runway=%s", self.airbase:GetName(), self.apptype, self.runway.name)
-  
-  return self
-end
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- User Functions
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- Set the primary navigation aid used in the approach.
--- @param #APPROACH self
--- @param Navigation.Point#NAVAID NavAid The NAVAID.
--- @return #APPROACH self
-function APPROACH:SetNavAid(NavAid)
-
-  self.navaid=NavAid
-
-  return self
-end
-
---- Add a waypoint to the path of the approach.
--- @param #APPROACH self
--- @param Navigation.Point#NAVFIX NavFix The navigation fix.
--- @param #string Segment The approach segment this fix belongs to.
--- @return #APPROACH.Waypoint The waypoint data table.
-function APPROACH:AddNavFix(NavFix, Segment)
-
-  self.wpcounter=self.wpcounter+1
-
-  local point={} --#APPROACH.Waypoint
-  point.uid=self.wpcounter
-  point.segment=Segment
-  point.navfix=NavFix
-
-  table.insert(self.path, point)
-
-  return point
-end
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- Private Functions
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
--- Add private functions here.
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- DEPARTURE class.
--- @type DEPARTURE
--- @field #string ClassName Name of the class.
--- @field #number verbose Verbosity of output.
--- @field #string apptype DEPARTURE type (ILS, VOR, LOC).
--- @field Wrapper.Airbase#AIRBASE airbase Airbase of this DEPARTURE.
--- @field Wrapper.Airbase#AIRBASE.Runway runway Runway of this DEPARTURE.
--- @field Navigation.Point#NAVAID navaid Primary navigation aid.
--- @field #number wpcounter Running number counting the waypoints to generate its UID.
--- @list <#DEPARTURE.Waypoint> path Path of DEPARTURE consisting of waypoints.
--- @extends Core.Base#BASE
-
---- *A fleet of British ships at war are the best negotiators.* -- Horatio Nelson
---
--- ===
---
--- # The DEPARTURE Concept
--- 
--- Bla.
---
--- @field #DEPARTURE
-DEPARTURE = {
-  ClassName       = "DEPARTURE",
-  verbose         =       0,
-  wpcounter       =       0,
-}
-
---- Type of DEPARTURE.
--- @type DEPARTURE.Type
--- @field #string VOR VOR
--- @field #string NDB NDB
-DEPARTURE.Type={
-  VOR="VOR",
-  ILS="ILS",
-}
-
-
---- Setments of  DEPARTURE.
--- @type DEPARTURE.Segment
--- @field #string INITIAL Initial DEPARTURE segment.
--- @field #string INTERMEDIATE Intermediate DEPARTURE segment.
--- @field #string FINAL Final DEPARTURE segment.
--- @field #string MISSED Missed DEPARTURE segment.
-DEPARTURE.Segment={
-  INITIAL="Initial",
-  INTERMEDIATE="Intermediate",
-  FINAL="Final",
-  MISSED="Missed",
-}
- 
---- Waypoint of the DEPARTURE.
--- @type DEPARTURE.Waypoint
--- @field #number uid Unique ID of the point.
--- @field #string segment The segment this point belongs to.
--- @field Navigation.Point#NAVFIX navfix The navigation fix that determines the coordinates of this point.
-  
---- DEPARTURE class version.
--- @field #string version
-DEPARTURE.version="0.0.1"
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- ToDo list
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
--- TODO: A lot...
--- Initial DEPARTURE segment --> Intermediate DEPARTURE segment: starts at IF --> Final DEPARTURE segment
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- Constructor
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- Create a new DEPARTURE class instance.
--- @param #DEPARTURE self
--- @param Wrapper.Airbase#AIRBASE Airbase The airbase or name of the airbase.
--- @param Wrapper.Airbase#AIRBASE.Runway Runway The runway or name of the runway.
--- @param #string Type Type of DEPARTURE (ILS, VOR, LOC).
--- @return #DEPARTURE self
-function DEPARTURE:New(Airbase, Runway)
-
-  -- Inherit everything from BASE class.
-  self=BASE:Inherit(self, BASE:New()) -- #DEPARTURE
-
-  if type(Airbase)=="string" then
-    self.airbase=AIRBASE:FindByName(Airbase)
-  else
-    self.airbase=Airbase
-  end
-  
-  if type(Runway)=="string" then
-    self.runway=self.airbase:GetRunwayByName(Runway)
-  else
-    self.runway=Runway
-  end
-
-  return self
-end
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- User Functions
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- Set the primary navigation aid used in the DEPARTURE.
--- @param #DEPARTURE self
--- @param Navigation.Point#NAVAID NavAid The NAVAID.
--- @return #DEPARTURE self
-function DEPARTURE:SetNavAid(NavAid)
-
-  self.navaid=NavAid
-
-  return self
-end
-
---- Add a waypoint to the path of the DEPARTURE.
--- @param #DEPARTURE self
--- @param Navigation.Point#NAVFIX NavFix The navigation fix.
--- @param #string Segment The DEPARTURE segment this fix belongs to.
--- @return #DEPARTURE.Waypoint The waypoint data.
-function DEPARTURE:AddWaypoint(NavFix, Segment)
-
-  self.wpcounter=self.wpcounter+1
-
-  local point={} --#DEPARTURE.Waypoint
-  point.uid=self.wpcounter
-  point.segment=Segment
-  point.navfix=NavFix
-
-  table.insert(self.path, point)
-
-  return point
-end
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- Private Functions
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
--- Add DEPARTURE private functions here.
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-

Moose Development/Moose/Navigation/Template.lua

@@ -1,108 +0,0 @@
---- **NAVIGATION** - Template.
---
--- **Main Features:**
---
---    * Stuff
---    * More Stuff
--- 
--- ===
---
--- ## Example Missions:
---
--- Demo missions can be found on [github](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/Navigation%20-%20Template).
--- 
--- ===
---
--- ### Author: **funkyfranky**
--- 
--- ===
--- @module Navigation.Template
--- @image NAVIGATION_Template.png
-
-
---- TEMPLATE class.
--- @type TEMPLATE
--- @field #string ClassName Name of the class.
--- @field #number verbose Verbosity of output.
--- @extends Core.Base#BASE
-
---- *A fleet of British ships at war are the best negotiators.* -- Horatio Nelson
---
--- ===
---
--- # The TEMPLATE Concept
---
--- The TEMPLATE class has a great concept!
--- 
--- # Basic Setup
--- 
--- A new `TEMPLATE` object can be created with the @{#TEMPLATE.New}() function.
--- 
---     myTemplate=TEMPLATE:New()
---     myTemplate:SetXYZ(X, Y, Z)
---     
--- This is how it works.
---
--- @field #TEMPLATE
-TEMPLATE = {
-  ClassName       = "TEMPLATE",
-  verbose         =       0,
-}
-
---- Type of navaid
--- @type TEMPLATE.Type
--- @field #string VOR VOR
--- @field #string NDB NDB
-TEMPLATE.TYPE={
-  VOR="VOR",
-  NDB="NDB",
-}
-  
---- TEMPLATE class version.
--- @field #string version
-TEMPLATE.version="0.0.1"
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- ToDo list
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
--- TODO: A lot...
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- Constructor
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- Create a new TEMPLATE class instance.
--- @param #TEMPLATE self
--- @return #TEMPLATE self
-function TEMPLATE:New()
-
-  -- Inherit everything from SCENERY class.
-  self=BASE:Inherit(self, BASE:New()) -- #TEMPLATE
-
-  return self
-end
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- User Functions
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- Set frequency.
--- @param #TEMPLATE self
--- @param #number Frequency Frequency in Hz.
--- @return #TEMPLATE self
-function TEMPLATE:SetFrequency(Frequency)
-
-  self.frequency=Frequency
-
-  return self
-end
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- Private Functions
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Moose Development/Moose/Ops/ATIS.lua

@@ -2798,7 +2798,7 @@ function ATIS:onafterBroadcast( From, Event, To )
 
     end
     _RUNACT = subtitle
-    alltext = alltext .. ";\n" .. subtitle
+    --alltext = alltext .. ";\n" .. subtitle
 
     -- Runway length.
     if self.rwylength then

Moose Development/Moose/Ops/AirWing.lua

@@ -159,6 +159,8 @@ AIRWING = {
 -- @field #number refuelsystem Refueling system type: `0=Unit.RefuelingSystem.BOOM_AND_RECEPTACLE`, `1=Unit.RefuelingSystem.PROBE_AND_DROGUE`.
 -- @field #number noccupied Number of flights on this patrol point.
 -- @field Wrapper.Marker#MARKER marker F10 marker.
+-- @field #boolean IsZonePoint flag for using a (moving) zone as point for patrol etc.
+-- @field Core.Zone#ZONE_BASE patrolzone in case Patrol coordinate was handed as zone, store here.
 
 --- Patrol zone.
 -- @type AIRWING.PatrolZone
@@ -187,13 +189,14 @@ AIRWING = {
 
 --- AIRWING class version.
 -- @field #string version
-AIRWING.version="0.9.6"
+AIRWING.version="0.9.7"
 
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 -- ToDo list
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
 -- TODO: Check that airbase has enough parking spots if a request is BIG.
+-- DONE: Allow (moving) zones as base for patrol points.
 -- DONE: Spawn in air ==> Needs WAREHOUSE update.
 -- DONE: Spawn hot.
 -- DONE: Make special request to transfer squadrons to anther airwing (or warehouse).
@@ -807,13 +810,22 @@ function AIRWING:_PatrolPointMarkerText(point)
 end
 
 --- Update marker of the patrol point.
+-- @param #AIRWING self
 -- @param #AIRWING.PatrolData point Patrol point table.
 function AIRWING:UpdatePatrolPointMarker(point)
-  if self.markpoints then -- sometimes there's a direct call from #OPSGROUP
+
+  if self and self.markpoints then -- sometimes there's a direct call from #OPSGROUP
     local text=string.format("%s Occupied=%d\nheading=%03d, leg=%d NM, alt=%d ft, speed=%d kts",
     point.type, point.noccupied, point.heading, point.leg, point.altitude, point.speed)
-
-    point.marker:UpdateText(text, 1)
+ 
+    if point.IsZonePoint and point.IsZonePoint == true and point.patrolzone then
+      -- update position
+      local Coordinate = point.patrolzone:GetCoordinate()
+      point.marker:UpdateCoordinate(Coordinate)
+      point.marker:UpdateText(text, 1.5)
+    else
+      point.marker:UpdateText(text, 1)
+    end
   end
 end
 
@@ -821,7 +833,7 @@ end
 --- Create a new generic patrol point.
 -- @param #AIRWING self
 -- @param #string Type Patrol point type, e.g. "CAP" or "AWACS". Default "Unknown".
--- @param Core.Point#COORDINATE Coordinate Coordinate of the patrol point. Default 10-15 NM away from the location of the airwing.
+-- @param Core.Point#COORDINATE Coordinate Coordinate of the patrol point. Default 10-15 NM away from the location of the airwing. Can be handed as a Core.Zone#ZONE object (e.g. in case you want  the point to align with a moving zone).
 -- @param #number Altitude Orbit altitude in feet. Default random between Angels 10 and 20.
 -- @param #number Heading Heading in degrees. Default random (0, 360] degrees.
 -- @param #number LegLength Length of race-track orbit in NM. Default 15 NM.
@@ -830,14 +842,16 @@ end
 -- @return #AIRWING.PatrolData Patrol point table.
 function AIRWING:NewPatrolPoint(Type, Coordinate, Altitude, Speed, Heading, LegLength, RefuelSystem)
 
-  -- Check if a zone was passed instead of a coordinate.
-  if Coordinate and Coordinate:IsInstanceOf("ZONE_BASE") then
-    Coordinate=Coordinate:GetCoordinate()
-  end
-
   local patrolpoint={}  --#AIRWING.PatrolData
   patrolpoint.type=Type or "Unknown"
   patrolpoint.coord=Coordinate or self:GetCoordinate():Translate(UTILS.NMToMeters(math.random(10, 15)), math.random(360))
+  if Coordinate:IsInstanceOf("ZONE_BASE") then
+    patrolpoint.IsZonePoint = true
+    patrolpoint.patrolzone = Coordinate
+    patrolpoint.coord = patrolpoint.patrolzone:GetCoordinate()
+  else
+    patrolpoint.IsZonePoint = false
+  end
   patrolpoint.heading=Heading or math.random(360)
   patrolpoint.leg=LegLength or 15
   patrolpoint.altitude=Altitude or math.random(10,20)*1000
@@ -847,7 +861,7 @@ function AIRWING:NewPatrolPoint(Type, Coordinate, Altitude, Speed, Heading, LegL
 
   if self.markpoints then
     patrolpoint.marker=MARKER:New(Coordinate, "New Patrol Point"):ToAll()
-    AIRWING.UpdatePatrolPointMarker(patrolpoint)
+    self:UpdatePatrolPointMarker(patrolpoint)
   end
 
   return patrolpoint
@@ -855,7 +869,7 @@ end
 
 --- Add a patrol Point for CAP missions.
 -- @param #AIRWING self
--- @param Core.Point#COORDINATE Coordinate Coordinate of the patrol point.
+-- @param Core.Point#COORDINATE Coordinate Coordinate of the patrol point. Can be handed as a Core.Zone#ZONE object (e.g. in case you want  the point to align with a moving zone).
 -- @param #number Altitude Orbit altitude in feet.
 -- @param #number Speed Orbit speed in knots.
 -- @param #number Heading Heading in degrees.
@@ -872,7 +886,7 @@ end
 
 --- Add a patrol Point for RECON missions.
 -- @param #AIRWING self
--- @param Core.Point#COORDINATE Coordinate Coordinate of the patrol point.
+-- @param Core.Point#COORDINATE Coordinate Coordinate of the patrol point. Can be handed as a Core.Zone#ZONE object (e.g. in case you want  the point to align with a moving zone).
 -- @param #number Altitude Orbit altitude in feet.
 -- @param #number Speed Orbit speed in knots.
 -- @param #number Heading Heading in degrees.
@@ -889,7 +903,7 @@ end
 
 --- Add a patrol Point for TANKER missions.
 -- @param #AIRWING self
--- @param Core.Point#COORDINATE Coordinate Coordinate of the patrol point.
+-- @param Core.Point#COORDINATE Coordinate Coordinate of the patrol point. Can be handed as a Core.Zone#ZONE object (e.g. in case you want  the point to align with a moving zone).
 -- @param #number Altitude Orbit altitude in feet.
 -- @param #number Speed Orbit speed in knots.
 -- @param #number Heading Heading in degrees.
@@ -907,7 +921,7 @@ end
 
 --- Add a patrol Point for AWACS missions.
 -- @param #AIRWING self
--- @param Core.Point#COORDINATE Coordinate Coordinate of the patrol point.
+-- @param Core.Point#COORDINATE Coordinate Coordinate of the patrol point. Can be handed as a Core.Zone#ZONE object (e.g. in case you want  the point to align with a moving zone).
 -- @param #number Altitude Orbit altitude in feet.
 -- @param #number Speed Orbit speed in knots.
 -- @param #number Heading Heading in degrees.
@@ -974,6 +988,46 @@ function AIRWING:SetTakeoffAir()
   return self
 end
 
+--- Set the aircraft of the AirWing to land straight in.
+-- @param #AIRWING self
+-- @return #FLIGHTGROUP self
+function AIRWING:SetLandingStraightIn()
+  self.OptionLandingStraightIn = true
+  return self
+end
+
+--- Set the aircraft of the AirWing to land in pairs for groups > 1 aircraft.
+-- @param #AIRWING self
+-- @return #AIRWING self
+function AIRWING:SetLandingForcePair()
+  self.OptionLandingForcePair = true
+  return self
+end
+
+--- Set the aircraft of the AirWing to NOT land in pairs.
+-- @param #AIRWING self
+-- @return #AIRWING self
+function AIRWING:SetLandingRestrictPair()
+  self.OptionLandingRestrictPair = true
+  return self
+end
+
+--- Set the aircraft of the AirWing to land after overhead break.
+-- @param #AIRWING self
+-- @return #AIRWING self
+function AIRWING:SetLandingOverheadBreak()
+  self.OptionLandingOverheadBreak = true
+  return self
+end
+
+--- [Helicopter] Set the aircraft of the AirWing to prefer vertical takeoff and landing.
+-- @param #AIRWING self
+-- @return #AIRWING self
+function AIRWING:SetOptionPreferVerticalLanding()
+  self.OptionPreferVerticalLanding = true
+  return self
+end
+
 --- Set despawn after landing. Aircraft will be despawned after the landing event.
 -- Can help to avoid DCS AI taxiing issues.
 -- @param #AIRWING self
@@ -1136,6 +1190,10 @@ function AIRWING:_GetPatrolData(PatrolPoints, RefuelSystem)
 
     for _,_patrolpoint in pairs(PatrolPoints) do
       local patrolpoint=_patrolpoint --#AIRWING.PatrolData
+      if patrolpoint.IsZonePoint and patrolpoint.IsZonePoint == true and patrolpoint.patrolzone then
+        -- update
+        patrolpoint.coord = patrolpoint.patrolzone:GetCoordinate()
+      end
       if (RefuelSystem and patrolpoint.refuelsystem and RefuelSystem==patrolpoint.refuelsystem) or RefuelSystem==nil or patrolpoint.refuelsystem==nil then
         return patrolpoint
       end
@@ -1195,7 +1253,7 @@ function AIRWING:CheckCAP()
 
     patrol.noccupied=patrol.noccupied+1
 
-    if self.markpoints then AIRWING.UpdatePatrolPointMarker(patrol) end
+    if self.markpoints then self:UpdatePatrolPointMarker(patrol) end
 
     self:AddMission(missionCAP)
 
@@ -1247,7 +1305,7 @@ function AIRWING:CheckRECON()
 
     patrol.noccupied=patrol.noccupied+1
 
-    if self.markpoints then AIRWING.UpdatePatrolPointMarker(patrol) end
+    if self.markpoints then self:UpdatePatrolPointMarker(patrol) end
 
     self:AddMission(missionRECON)
 
@@ -1292,7 +1350,7 @@ function AIRWING:CheckTANKER()
 
     patrol.noccupied=patrol.noccupied+1
 
-    if self.markpoints then AIRWING.UpdatePatrolPointMarker(patrol) end
+    if self.markpoints then self:UpdatePatrolPointMarker(patrol) end
 
     self:AddMission(mission)
 
@@ -1311,7 +1369,7 @@ function AIRWING:CheckTANKER()
 
     patrol.noccupied=patrol.noccupied+1
 
-    if self.markpoints then AIRWING.UpdatePatrolPointMarker(patrol) end
+    if self.markpoints then self:UpdatePatrolPointMarker(patrol) end
 
     self:AddMission(mission)
 
@@ -1349,7 +1407,7 @@ function AIRWING:CheckAWACS()
 
     patrol.noccupied=patrol.noccupied+1
 
-    if self.markpoints then AIRWING.UpdatePatrolPointMarker(patrol) end
+    if self.markpoints then self:UpdatePatrolPointMarker(patrol) end
 
     self:AddMission(mission)
 
@@ -1464,7 +1522,21 @@ function AIRWING:onafterFlightOnMission(From, Event, To, FlightGroup, Mission)
   self:T(self.lid..string.format("Group %s on %s mission %s", FlightGroup:GetName(), Mission:GetType(), Mission:GetName()))
   if self.UseConnectedOpsAwacs and self.ConnectedOpsAwacs then
     self.ConnectedOpsAwacs:__FlightOnMission(2,FlightGroup,Mission)
-  end  
+  end
+  -- Landing Options  
+  if self.OptionLandingForcePair then
+    FlightGroup:SetOptionLandingForcePair()
+  elseif self.OptionLandingOverheadBreak then
+   FlightGroup:SetOptionLandingOverheadBreak()
+  elseif self.OptionLandingRestrictPair then
+   FlightGroup:SetOptionLandingRestrictPair()
+  elseif self.OptionLandingStraightIn then
+    FlightGroup:SetOptionLandingStraightIn()
+  end
+  -- Landing Options Helo
+  if self.OptionPreferVerticalLanding then
+    FlightGroup:SetOptionPreferVertical()
+  end
 end
 
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Moose Development/Moose/Ops/Auftrag.lua

@@ -397,6 +397,7 @@ AUFTRAG = {
   conditionPush      =    {},
   conditionSuccessSet = false,
   conditionFailureSet = false,
+  repeatDelay = 1,
 }
 
 --- Global mission counter.
@@ -1428,7 +1429,7 @@ function AUFTRAG:NewCAP(ZoneCAP, Altitude, Speed, Coordinate, Heading, Leg, Targ
   mission:_SetLogID()
 
   -- DCS task parameters:
-  mission.engageZone=ZoneCAP
+  mission.engageZone=ZoneCAP or Coordinate
   mission.engageTargetTypes=TargetTypes or {"Air"}
 
   -- Mission options:
@@ -1715,9 +1716,45 @@ function AUFTRAG:NewSEAD(Target, Altitude)
   return mission
 end
 
+--- **[AIR]** Create a SEAD in Zone mission.
+-- @param #AUFTRAG self
+-- @param Core.Zone#ZONE TargetZone The target zone to attack.
+-- @param #number Altitude Engage altitude in feet. Default 25000 ft.
+-- @param #table TargetTypes Table of string of DCS known target types, defaults to {"Air Defence"}. See [DCS Target Attributes](https://wiki.hoggitworld.com/view/DCS_enum_attributes)
+-- @param #number Duration Engage this much time when the AUFTRAG starts executing.
+-- @return #AUFTRAG self
+function AUFTRAG:NewSEADInZone(TargetZone, Altitude, TargetTypes, Duration)
+
+  local mission=AUFTRAG:New(AUFTRAG.Type.SEAD)
+
+  --mission:_TargetFromObject(TargetZone)
+
+  -- DCS Task options:
+  mission.engageWeaponType=ENUMS.WeaponFlag.Auto
+  mission.engageWeaponExpend=AI.Task.WeaponExpend.ALL
+  mission.engageAltitude=UTILS.FeetToMeters(Altitude or 25000)
+  mission.engageZone = TargetZone
+  mission.engageTargetTypes = TargetTypes or {"Air Defence"}
+
+  -- Mission options:
+  mission.missionTask=ENUMS.MissionTask.SEAD
+  mission.missionAltitude=mission.engageAltitude
+  mission.missionFraction=0.2
+  mission.optionROE=ENUMS.ROE.OpenFire
+  mission.optionROT=ENUMS.ROT.EvadeFire
+
+  mission.categories={AUFTRAG.Category.AIRCRAFT}
+
+  mission.DCStask=mission:GetDCSMissionTask()
+  
+  mission:SetDuration(Duration or 1800)
+
+  return mission
+end
+
 --- **[AIR]** Create a STRIKE mission. Flight will attack the closest map object to the specified coordinate.
 -- @param #AUFTRAG self
--- @param Core.Point#COORDINATE Target The target coordinate. Can also be given as a GROUP, UNIT, STATIC or TARGET object.
+-- @param Core.Point#COORDINATE Target The target coordinate. Can also be given as a GROUP, UNIT, STATIC, SET_GROUP, SET_UNIT, SET_STATIC or TARGET object.
 -- @param #number Altitude Engage altitude in feet. Default 2000 ft.
 -- @param #number EngageWeaponType Which weapon to use. Defaults to auto, ie ENUMS.WeaponFlag.Auto. See ENUMS.WeaponFlag for options.
 -- @return #AUFTRAG self
@@ -1749,11 +1786,12 @@ end
 --- **[AIR]** Create a BOMBING mission. Flight will drop bombs a specified coordinate.
 -- See [DCS task bombing](https://wiki.hoggitworld.com/view/DCS_task_bombing).
 -- @param #AUFTRAG self
--- @param Core.Point#COORDINATE Target Target coordinate. Can also be specified as a GROUP, UNIT, STATIC or TARGET object.
+-- @param Core.Point#COORDINATE Target Target coordinate. Can also be specified as a GROUP, UNIT, STATIC, SET_GROUP, SET_UNIT, SET_STATIC or TARGET object.
 -- @param #number Altitude Engage altitude in feet. Default 25000 ft.
 -- @param #number EngageWeaponType Which weapon to use. Defaults to auto, ie ENUMS.WeaponFlag.Auto. See ENUMS.WeaponFlag for options.
+-- @param #boolean Divebomb If true, use a dive bombing attack approach.
 -- @return #AUFTRAG self
-function AUFTRAG:NewBOMBING(Target, Altitude, EngageWeaponType)
+function AUFTRAG:NewBOMBING(Target, Altitude, EngageWeaponType, Divebomb)
 
   local mission=AUFTRAG:New(AUFTRAG.Type.BOMBING)
 
@@ -1770,6 +1808,7 @@ function AUFTRAG:NewBOMBING(Target, Altitude, EngageWeaponType)
   mission.missionFraction=0.5
   mission.optionROE=ENUMS.ROE.OpenFire
   mission.optionROT=ENUMS.ROT.NoReaction   -- No reaction is better.
+  mission.optionDivebomb = Divebomb or nil
 
   -- Evaluate result after 5 min. We might need time until the bombs have dropped and targets have been detroyed.
   mission.dTevaluate=5*60
@@ -2966,6 +3005,16 @@ function AUFTRAG:SetRepeat(Nrepeat)
   return self
 end
 
+
+--- **[LEGION, COMMANDER, CHIEF]** Set the repeat delay in seconds after a mission is successful/failed. Only valid if the mission is handled by a LEGION (AIRWING, BRIGADE, FLEET) or higher level.
+-- @param #AUFTRAG self
+-- @param #number Nrepeat Repeat delay in seconds. Default 1.
+-- @return #AUFTRAG self
+function AUFTRAG:SetRepeatDelay(RepeatDelay)
+  self.repeatDelay = RepeatDelay
+  return self
+end
+
 --- **[LEGION, COMMANDER, CHIEF]** Set how many times the mission is repeated if it fails. Only valid if the mission is handled by a LEGION (AIRWING, BRIGADE, FLEET) or higher level.
 -- @param #AUFTRAG self
 -- @param #number Nrepeat Number of repeats. Default 0.
@@ -4765,6 +4814,8 @@ end
 -- @return #boolean If `true`, all groups are done with the mission.
 function AUFTRAG:CheckGroupsDone()
 
+  local fsmState = self:GetState()
+
   -- Check status of all OPS groups.
   for groupname,data in pairs(self.groupdata) do
     local groupdata=data --#AUFTRAG.GroupData
@@ -4822,6 +4873,11 @@ function AUFTRAG:CheckGroupsDone()
     self:T(self.lid..string.format("CheckGroupsDone: Mission is STARTED state %s [FSM=%s] but count of alive OPSGROUP is zero. Mission DONE!", self.status, self:GetState()))
     return true
   end
+  
+  if (self:IsStarted() or self:IsExecuting()) and (fsmState == AUFTRAG.Status.STARTED or fsmState == AUFTRAG.Status.EXECUTING) and self:CountOpsGroups()>0 then
+    self:T(self.lid..string.format("CheckGroupsDone: Mission is STARTED state %s [FSM=%s] and count of alive OPSGROUP > zero. Mission NOT DONE!", self.status, self:GetState()))
+    return false
+  end
 
   return true
 end
@@ -5160,7 +5216,7 @@ function AUFTRAG:onafterSuccess(From, Event, To)
 
     -- Repeat mission.
     self:T(self.lid..string.format("Mission SUCCESS! Repeating mission for the %d time (max %d times) ==> Repeat mission!", self.repeated+1, N))
-    self:Repeat()
+    self:__Repeat(self.repeatDelay)
 
   else
 
@@ -5202,7 +5258,7 @@ function AUFTRAG:onafterFailed(From, Event, To)
 
     -- Repeat mission.
     self:T(self.lid..string.format("Mission FAILED! Repeating mission for the %d time (max %d times) ==> Repeat mission!", self.repeated+1, N))
-    self:Repeat()
+    self:__Repeat(self.repeatDelay)
 
   else
 
@@ -6108,10 +6164,13 @@ function AUFTRAG:GetDCSMissionTask()
     -- BOMBING Mission --
     ---------------------
 
-    local DCStask=CONTROLLABLE.TaskBombing(nil, self:GetTargetVec2(), self.engageAsGroup, self.engageWeaponExpend, self.engageQuantity, self.engageDirection, self.engageAltitude, self.engageWeaponType, Divebomb)
+    local coords = self.engageTarget:GetCoordinates()
+    for _, coord in pairs(coords) do
+        local DCStask = CONTROLLABLE.TaskBombing(nil, coord:GetVec2(), self.engageAsGroup, self.engageWeaponExpend, self.engageQuantity, self.engageDirection, self.engageAltitude, self.engageWeaponType, self.optionDivebomb)
+
+        table.insert(DCStasks, DCStask)
+    end
 
-    table.insert(DCStasks, DCStask)
-    
   elseif self.type==AUFTRAG.Type.STRAFING then
 
     ----------------------
@@ -6147,8 +6206,16 @@ function AUFTRAG:GetDCSMissionTask()
     -----------------
     -- CAP Mission --
     -----------------
-
-    local DCStask=CONTROLLABLE.EnRouteTaskEngageTargetsInZone(nil, self.engageZone:GetVec2(), self.engageZone:GetRadius(), self.engageTargetTypes, Priority)
+    
+    local Vec2 = self.engageZone:GetVec2()
+    local Radius
+    if self.engageZone:IsInstanceOf("COORDINATE") then
+      Radius = UTILS.NMToMeters(20)
+    else
+      Radius = self.engageZone:GetRadius()
+    end
+        
+    local DCStask=CONTROLLABLE.EnRouteTaskEngageTargetsInZone(nil, Vec2, Radius, self.engageTargetTypes, Priority)
 
     table.insert(self.enrouteTasks, DCStask)
 
@@ -6302,18 +6369,47 @@ function AUFTRAG:GetDCSMissionTask()
     -- Add enroute task SEAD. Disabled that here because the group enganges everything on its route.
     --local DCStask=CONTROLLABLE.EnRouteTaskSEAD(nil, self.TargetType)
     --table.insert(self.enrouteTasks, DCStask)
-
-    self:_GetDCSAttackTask(self.engageTarget, DCStasks)
-
+    
+    if self.engageZone then
+    
+      --local DCStask=CONTROLLABLE.EnRouteTaskSEAD(nil, self.engageTargetTypes)
+      --table.insert(self.enrouteTasks, DCStask)
+      self.engageZone:Scan({Object.Category.UNIT},{Unit.Category.GROUND_UNIT})
+      local ScanUnitSet = self.engageZone:GetScannedSetUnit()
+      local SeadUnitSet = SET_UNIT:New()
+      for _,_unit in pairs (ScanUnitSet.Set) do
+        local unit = _unit -- Wrapper.Unit#UNTI
+        if unit and unit:IsAlive() and unit:HasSEAD() then
+          self:T("Adding UNIT for SEAD: "..unit:GetName())
+          local task = CONTROLLABLE.TaskAttackUnit(nil,unit,GroupAttack,AI.Task.WeaponExpend.ALL,1,Direction,self.engageAltitude,2956984318)
+          table.insert(DCStasks, task)
+          SeadUnitSet:AddUnit(unit)
+        end
+      end
+      self.engageTarget = TARGET:New(SeadUnitSet)
+      --local OrbitTask = CONTROLLABLE.TaskOrbitCircle(nil,self.engageAltitude,self.missionSpeed,self.engageZone:GetCoordinate())
+      --local Point = self.engageZone:GetVec2()
+      --local OrbitTask = CONTROLLABLE.TaskOrbitCircleAtVec2(nil,Point,self.engageAltitude,self.missionSpeed)
+      --table.insert(DCStasks, OrbitTask)
+     
+    else
+    
+      self:_GetDCSAttackTask(self.engageTarget, DCStasks)
+    
+    end
+    
   elseif self.type==AUFTRAG.Type.STRIKE then
 
     --------------------
     -- STRIKE Mission --
     --------------------
 
-    local DCStask=CONTROLLABLE.TaskAttackMapObject(nil, self:GetTargetVec2(), self.engageAsGroup, self.engageWeaponExpend, self.engageQuantity, self.engageDirection, self.engageAltitude, self.engageWeaponType)
+    local coords = self.engageTarget:GetCoordinates()
+    for _, coord in pairs(coords) do
+        local DCStask=CONTROLLABLE.TaskAttackMapObject(nil, coord:GetVec2(), self.engageAsGroup, self.engageWeaponExpend, self.engageQuantity, self.engageDirection, self.engageAltitude, self.engageWeaponType)
 
-    table.insert(DCStasks, DCStask)
+        table.insert(DCStasks, DCStask)
+    end
 
   elseif self.type==AUFTRAG.Type.TANKER or self.type==AUFTRAG.Type.RECOVERYTANKER then
 

Moose Development/Moose/Ops/Awacs.lua

@@ -17,7 +17,7 @@
 -- ===
 --
 -- ### Author: **applevangelist**
--- @date Last Update Jan 2025
+-- @date Last Update July 2025
 -- @module Ops.AWACS
 -- @image OPS_AWACS.jpg
 
@@ -237,7 +237,7 @@ do
 --            -- Callsign will be "Focus". We'll be a Angels 30, doing 300 knots, orbit leg to 88deg with a length of 25nm.
 --            testawacs:SetAwacsDetails(CALLSIGN.AWACS.Focus,1,30,300,88,25)
 --            -- Set up SRS on port 5010 - change the below to your path and port
---            testawacs:SetSRS("C:\\Program Files\\DCS-SimpleRadio-Standalone","female","en-GB",5010)
+--            testawacs:SetSRS("C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio","female","en-GB",5010)
 --            -- Add a "red" border we don't want to cross, set up in the mission editor with a late activated helo named "Red Border#ZONE_POLYGON"
 --            testawacs:SetRejectionZone(ZONE:FindByName("Red Border"))
 --            -- Our CAP flight will have the callsign "Ford", we want 4 AI planes, Time-On-Station is four hours, doing 300 kn IAS.
@@ -255,7 +255,7 @@ do
 --            -- The CAP station zone is called "Fremont". We will be on 255 AM. Note the Orbit Zone is given as *nil* in the `New()`-Statement
 --            local testawacs = AWACS:New("GCI Senaki",AwacsAW,"blue",AIRBASE.Caucasus.Senaki_Kolkhi,nil,ZONE:FindByName("Rock"),"Fremont",255,radio.modulation.AM )
 --            -- Set up SRS on port 5010 - change the below to your path and port
---            testawacs:SetSRS("C:\\Program Files\\DCS-SimpleRadio-Standalone","female","en-GB",5010)
+--            testawacs:SetSRS("C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio","female","en-GB",5010)
 --            -- Add a "red" border we don't want to cross, set up in the mission editor with a late activated helo named "Red Border#ZONE_POLYGON"
 --            testawacs:SetRejectionZone(ZONE:FindByName("Red Border"))
 --            -- Our CAP flight will have the callsign "Ford", we want 4 AI planes, Time-On-Station is four hours, doing 300 kn IAS.
@@ -509,7 +509,7 @@ do
 -- @field #AWACS
 AWACS = {
   ClassName = "AWACS", -- #string
-  version = "0.2.71", -- #string
+  version = "0.2.72", -- #string
   lid = "", -- #string
   coalition = coalition.side.BLUE, -- #number
   coalitiontxt = "blue", -- #string
@@ -1123,7 +1123,7 @@ function AWACS:New(Name,AirWing,Coalition,AirbaseName,AwacsOrbit,OpsZone,Station
   self.EscortMissionReplacement = {}
   
   -- SRS
-  self.PathToSRS = "C:\\Program Files\\DCS-SimpleRadio-Standalone"
+  self.PathToSRS = "C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio"
   self.Gender = "female"
   self.Culture = "en-GB"
   self.Voice = nil
@@ -1242,6 +1242,8 @@ function AWACS:New(Name,AirWing,Coalition,AirbaseName,AwacsOrbit,OpsZone,Station
   self:AddTransition("*",             "Intercept",          "*")
   self:AddTransition("*",             "InterceptSuccess",   "*")
   self:AddTransition("*",             "InterceptFailure",   "*")
+  self:AddTransition("*",             "VIDSuccess",   "*")
+  self:AddTransition("*",             "VIDFailure",   "*")
   self:AddTransition("*",             "Stop",               "Stopped")     -- Stop FSM.
   
   
@@ -1365,18 +1367,38 @@ function AWACS:New(Name,AirWing,Coalition,AirbaseName,AwacsOrbit,OpsZone,Station
   -- @param #string To To state.
   
   --- On After "InterceptSuccess" event. Intercept successful.
-  -- @function [parent=#AWACS] OnAfterIntercept
+  -- @function [parent=#AWACS] OnAfterInterceptSuccess
   -- @param #AWACS self
   -- @param #string From From state.
   -- @param #string Event Event.
   -- @param #string To To state.
   
   --- On After "InterceptFailure" event. Intercept failure.
-  -- @function [parent=#AWACS] OnAfterIntercept
+  -- @function [parent=#AWACS] OnAfterInterceptFailure
   -- @param #AWACS self
   -- @param #string From From state.
   -- @param #string Event Event.
   -- @param #string To To state.
+
+  --- On After "VIDSuccess" event. Intercept successful.
+  -- @function [parent=#AWACS] OnAfterVIDSuccess
+  -- @param #AWACS self
+  -- @param #string From From state.
+  -- @param #string Event Event.
+  -- @param #string To To state.
+  -- @param #number GID Managed group ID (Player)
+  -- @param Wrapper.Group#GROUP Group (Player) Group done the VID
+  -- @param #AWACS.ManagedContact Contact The contact that was VID'd 
+  
+  --- On After "VIDFailure" event. Intercept failure.
+  -- @function [parent=#AWACS] OnAfterVIDFailure
+  -- @param #AWACS self
+  -- @param #string From From state.
+  -- @param #string Event Event.
+  -- @param #string To To state.
+  -- @param #number GID Managed group ID (Player)
+  -- @param Wrapper.Group#GROUP Group (Player) Group done the VID
+  -- @param #AWACS.ManagedContact Contact The contact that was VID'd 
   
   return self
 end
@@ -2091,7 +2113,7 @@ end
 
 --- [User] Set AWACS SRS TTS details - see @{Sound.SRS} for details. `SetSRS()` will try to use as many attributes configured with @{Sound.SRS#MSRS.LoadConfigFile}() as possible.
 -- @param #AWACS self
--- @param #string PathToSRS Defaults to "C:\\Program Files\\DCS-SimpleRadio-Standalone"
+-- @param #string PathToSRS Defaults to "C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio"
 -- @param #string Gender Defaults to "male"
 -- @param #string Culture Defaults to "en-US"
 -- @param #number Port Defaults to 5002
@@ -2104,7 +2126,7 @@ end
 -- @return #AWACS self
 function AWACS:SetSRS(PathToSRS,Gender,Culture,Port,Voice,Volume,PathToGoogleKey,AccessKey,Backend)
   self:T(self.lid.."SetSRS")
-  self.PathToSRS = PathToSRS or MSRS.path or "C:\\Program Files\\DCS-SimpleRadio-Standalone" 
+  self.PathToSRS = PathToSRS or MSRS.path or "C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio" 
   self.Gender = Gender or MSRS.gender or "male"
   self.Culture = Culture or MSRS.culture or "en-US"
   self.Port = Port or MSRS.port or 5002
@@ -3263,12 +3285,14 @@ function AWACS:_VID(Group,Declaration)
           local vidpos = self.gettext:GetEntry("VIDPOS",self.locale)
           text = string.format(vidpos,Callsign,self.callsigntxt, Declaration)
           self:T(text)
+          self:__VIDSuccess(3,GID,group,cluster)
         else
           -- too far away
           self:T("Contact VID not close enough")
           local vidneg = self.gettext:GetEntry("VIDNEG",self.locale)
           text = string.format(vidneg,Callsign,self.callsigntxt)
           self:T(text)
+          self:__VIDFailure(3,GID,group,cluster)
         end
         self:_NewRadioEntry(text,text,GID,Outcome,true,true,false,true)
       end

Moose Development/Moose/Ops/Brigade.lua

@@ -599,80 +599,7 @@ function BRIGADE:onafterStatus(From, Event, To)
       text=text..string.format("\n* %s: spawned=%s", asset.spawngroupname, tostring(asset.spawned))      
     end
     self:I(self.lid..text)
-  end
-
-  if self.verbose>=3 then
-  
-    -- Count numbers
-    local Ntotal=0
-    local Nspawned=0
-    local Nrequested=0
-    local Nreserved=0
-    local Nstock=0
-    
-    local text="\n===========================================\n"
-    text=text.."Assets:"
-    local legion=self --Ops.Legion#LEGION
-
-    for _,_cohort in pairs(legion.cohorts) do
-      local cohort=_cohort --Ops.Cohort#COHORT
-      
-      for _,_asset in pairs(cohort.assets) do
-        local asset=_asset --Functional.Warehouse#WAREHOUSE.Assetitem
-
-        local state="In Stock"
-        if asset.flightgroup then
-          state=asset.flightgroup:GetState()
-          local mission=legion:GetAssetCurrentMission(asset)
-          if mission then
-            state=state..string.format(", Mission \"%s\" [%s]", mission:GetName(), mission:GetType())
-          end
-        else
-          if asset.spawned then
-            env.info("FF ERROR: asset has opsgroup but is NOT spawned!")
-          end
-          if asset.requested and asset.isReserved then
-            env.info("FF ERROR: asset is requested and reserved. Should not be both!")
-            state="Reserved+Requested!"
-          elseif asset.isReserved then
-            state="Reserved"
-          elseif asset.requested then
-            state="Requested"
-          end
-        end
-                    
-        -- Text.
-        text=text..string.format("\n[UID=%03d] %s Legion=%s [%s]: State=%s [RID=%s]", 
-        asset.uid, asset.spawngroupname, legion.alias, cohort.name, state, tostring(asset.rid))
-        
-        
-        if asset.spawned then
-          Nspawned=Nspawned+1
-        end            
-        if asset.requested then
-          Nrequested=Nrequested+1
-        end  
-        if asset.isReserved then
-          Nreserved=Nreserved+1
-        end                      
-        if not (asset.spawned or asset.requested or asset.isReserved) then
-          Nstock=Nstock+1
-        end
-        
-        Ntotal=Ntotal+1
-        
-      end
-  
-    end
-    text=text.."\n-------------------------------------------"
-    text=text..string.format("\nNstock     = %d", Nstock)
-    text=text..string.format("\nNreserved  = %d", Nreserved)
-    text=text..string.format("\nNrequested = %d", Nrequested)
-    text=text..string.format("\nNspawned   = %d", Nspawned)
-    text=text..string.format("\nNtotal     = %d (=%d)", Ntotal, Nstock+Nspawned+Nrequested+Nreserved)
-    text=text.."\n==========================================="
-    self:I(self.lid..text)
-  end  
+  end    
 
 end
 

Moose Development/Moose/Ops/Commander.lua

@@ -136,6 +136,7 @@ COMMANDER = {
   awacsZones      =    {},
   tankerZones     =    {},
   limitMission    =    {},
+  maxMissionsAssignPerCycle = 1,
 }
 
 --- COMMANDER class version.
@@ -1535,6 +1536,8 @@ function COMMANDER:CheckMissionQueue()
     end
   end
 
+  local missionsAssigned = 0
+
   -- Loop over missions in queue.
   for _,_mission in pairs(self.missionqueue) do
     local mission=_mission --Ops.Auftrag#AUFTRAG
@@ -1594,9 +1597,12 @@ function COMMANDER:CheckMissionQueue()
           -- Recruited assets but no requested escort available. Unrecruit assets!
           LEGION.UnRecruitAssets(assets, mission)
         end        
-    
-        -- Only ONE mission is assigned.
-        return        
+
+        missionsAssigned = missionsAssigned + 1
+        if missionsAssigned >= (self.maxMissionsAssignPerCycle or 1) then
+            return
+        end
+
       end
       
     else
@@ -1611,6 +1617,16 @@ function COMMANDER:CheckMissionQueue()
   
 end
 
+--- Set how many missions can be assigned in a single status iteration. (eg. This is useful for persistent missions where you need to load all AUFTRAGs on mission start and then change it back to default)
+--- Warning: Increasing this value will increase the number of missions started per iteration and thus may lead to performance issues if too many missions are started at once.
+-- @param #COMMANDER self
+-- @param #number Number of missions assigned per status iteration. Default is 1.
+-- @return #COMMANDER self.
+function COMMANDER:SetMaxMissionsAssignPerCycle(MaxMissionsAssignPerCycle)
+  self.maxMissionsAssignPerCycle = MaxMissionsAssignPerCycle or 1
+  return self
+end
+
 --- Get cohorts.
 -- @param #COMMANDER self
 -- @param #table Legions Special legions.
@@ -1670,9 +1686,12 @@ function COMMANDER:_GetCohorts(Legions, Cohorts, Operation)
     for _,_legion in pairs(Legions or {}) do
       local legion=_legion --Ops.Legion#LEGION
   
-      -- Check that runway is operational.    
-      local Runway=legion:IsAirwing() and legion:IsRunwayOperational() or true
-      
+      -- Check that runway is operational.
+      local Runway=true
+      if legion:IsAirwing() then
+        Runway=legion:IsRunwayOperational() and legion.airbase and legion.airbase:GetCoalition() == legion:GetCoalition()
+      end
+
       -- Legion has to be running.
       if legion:IsRunning() and Runway then
       
@@ -1703,9 +1722,12 @@ function COMMANDER:_GetCohorts(Legions, Cohorts, Operation)
     for _,_legion in pairs(self.legions) do
       local legion=_legion --Ops.Legion#LEGION
       
-      -- Check that runway is operational.    
-      local Runway=legion:IsAirwing() and legion:IsRunwayOperational() or true
-      
+      -- Check that runway is operational.
+      local Runway=true
+      if legion:IsAirwing() then
+        Runway=legion:IsRunwayOperational() and legion.airbase and legion.airbase:GetCoalition() == legion:GetCoalition()
+      end
+
       -- Legion has to be running.
       if legion:IsRunning() and Runway then
       

Moose Development/Moose/Ops/EasyGCICAP.lua

@@ -1,13 +1,18 @@
 -------------------------------------------------------------------------
 -- Easy CAP/GCI Class, based on OPS classes
 -------------------------------------------------------------------------
--- Documentation
+-- 
+-- ## Documentation:
 -- 
 -- https://flightcontrol-master.github.io/MOOSE_DOCS_DEVELOP/Documentation/Ops.EasyGCICAP.html
 -- 
+-- ## Example Missions:
+--
+-- Demo missions can be found on [github](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/Ops/EasyGCICAP).
+-- 
 -------------------------------------------------------------------------
 -- Date: September 2023
--- Last Update: July 2024
+-- Last Update: Aug 2025
 -------------------------------------------------------------------------
 --
 --- **Ops** - Easy GCI & CAP Manager
@@ -70,6 +75,10 @@
 -- @field #boolean DespawnAfterLanding
 -- @field #boolean DespawnAfterHolding
 -- @field #list<Ops.Auftrag#AUFTRAG> ListOfAuftrag
+-- @field #string defaulttakeofftype Take off type
+-- @field #number FuelLowThreshold
+-- @field #number FuelCriticalThreshold
+-- @field #boolean showpatrolpointmarks
 -- @extends Core.Fsm#FSM
 
 --- *“Airspeed, altitude, and brains. Two are always needed to successfully complete the flight.”* -- Unknown.
@@ -223,7 +232,11 @@ EASYGCICAP = {
   ReadyFlightGroups = {},
   DespawnAfterLanding = false,
   DespawnAfterHolding = true,
-  ListOfAuftrag = {}
+  ListOfAuftrag = {},
+  defaulttakeofftype = "hot",
+  FuelLowThreshold = 25,
+  FuelCriticalThreshold = 10,
+  showpatrolpointmarks = false,
 }
 
 --- Internal Squadron data type
@@ -256,10 +269,11 @@ EASYGCICAP = {
 -- @field #number Speed
 -- @field #number Heading
 -- @field #number LegLength
+-- @field Core.Zone#ZONE_BASE Zone
 
 --- EASYGCICAP class version.
 -- @field #string version
-EASYGCICAP.version="0.1.18"
+EASYGCICAP.version="0.1.27"
 
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 -- TODO list
@@ -312,6 +326,10 @@ function EASYGCICAP:New(Alias, AirbaseName, Coalition, EWRName)
   self.DespawnAfterLanding = false
   self.DespawnAfterHolding = true
   self.ListOfAuftrag = {}
+  self.defaulttakeofftype = "hot"
+  self.FuelLowThreshold = 25
+  self.FuelCriticalThreshold = 10
+  self.showpatrolpointmarks = false
   
   -- Set some string id for output to DCS.log file.
   self.lid=string.format("EASYGCICAP %s | ", self.alias)
@@ -336,6 +354,63 @@ end
 -- Functions
 -------------------------------------------------------------------------
 
+--- Get a specific managed AirWing by name
+-- @param #EASYGCICAP self
+-- @param #string AirbaseName Airbase name of the home of this wing.
+-- @return Ops.AirWing#AIRWING Airwing or nil if not found
+function EASYGCICAP:GetAirwing(AirbaseName)
+  self:T(self.lid.."GetAirwing")
+  if self.wings[AirbaseName] then
+    return self.wings[AirbaseName][1]
+  end
+  return nil
+end
+
+--- Get a table of all managed AirWings
+-- @param #EASYGCICAP self
+-- @return #table Table of Ops.AirWing#AIRWING Airwings
+function EASYGCICAP:GetAirwingTable()
+  self:T(self.lid.."GetAirwingTable")
+  local Wingtable = {}
+  for _,_object in pairs(self.wings or {}) do
+    table.insert(Wingtable,_object[1])
+  end
+  return Wingtable
+end
+
+--- Set "fuel low" threshold for CAP and INTERCEPT flights.
+-- @param #EASYGCICAP self
+-- @param #number Percent RTB if fuel at this percent. Values: 1..100, defaults to 25.
+-- @return #EASYGCICAP self
+function EASYGCICAP:SetFuelLow(Percent)
+  self:T(self.lid.."SetFuelLow")
+  self.FuelLowThreshold = Percent or 25
+  return self
+end
+
+--- Set markers on the map for Patrol Points.
+-- @param #EASYGCICAP self
+-- @param #boolean onoff Set to true to switch markers on.
+-- @return #EASYGCICAP self
+function EASYGCICAP:ShowPatrolPointMarkers(onoff)
+  if onoff then
+    self.showpatrolpointmarks = true
+  else
+    self.showpatrolpointmarks = false
+  end
+  return self
+end
+
+--- Set "fuel critical" threshold for CAP and INTERCEPT flights.
+-- @param #EASYGCICAP self
+-- @param #number Percent RTB if fuel at this percent. Values: 1..100, defaults to 10.
+-- @return #EASYGCICAP self
+function EASYGCICAP:SetFuelCritical(Percent)
+  self:T(self.lid.."SetFuelCritical")
+  self.FuelCriticalThreshold = Percent or 10
+  return self
+end
+
 --- Set CAP formation.
 -- @param #EASYGCICAP self
 -- @param #number Formation Formation to fly, defaults to ENUMS.Formation.FixedWing.FingerFour.Group
@@ -356,7 +431,7 @@ function EASYGCICAP:SetTankerAndAWACSInvisible(Switch)
   return self
 end
 
---- Count alive missions in our internal stack.
+--- (internal) Count alive missions in our internal stack.
 -- @param #EASYGCICAP self
 -- @return #number count
 function EASYGCICAP:_CountAliveAuftrags()
@@ -400,6 +475,16 @@ function EASYGCICAP:SetDefaultRepeatOnFailure(Retries)
   return self
 end
 
+--- Add default take off type for the airwings.
+-- @param #EASYGCICAP self
+-- @param #string Takeoff Can be "hot", "cold", or "air" - default is "hot".
+-- @return #EASYGCICAP self 
+function EASYGCICAP:SetDefaultTakeOffType(Takeoff)
+  self:T(self.lid.."SetDefaultTakeOffType")
+  self.defaulttakeofftype = Takeoff or "hot"
+  return self
+end
+
 --- Set default CAP Speed in knots
 -- @param #EASYGCICAP self
 -- @param #number Speed Speed defaults to 300
@@ -569,6 +654,13 @@ function EASYGCICAP:_AddAirwing(Airbasename, Alias)
   local DespawnAfterLanding = self.DespawnAfterLanding
   local DespawnAfterHolding = self.DespawnAfterHolding
   
+  -- Check STATIC name
+  local check = STATIC:FindByName(Airbasename,false) or UNIT:FindByName(Airbasename)
+  if check == nil then
+    MESSAGE:New(self.lid.."There's no warehouse static on the map (wrong naming?) for airbase "..tostring(Airbasename).."!",30,"CHECK"):ToAllIf(self.debug):ToLog()
+    return
+  end
+  
   -- Create Airwing
   local CAP_Wing = AIRWING:New(Airbasename,Alias)
   CAP_Wing:SetVerbosityLevel(0)
@@ -578,6 +670,10 @@ function EASYGCICAP:_AddAirwing(Airbasename, Alias)
   CAP_Wing:SetRespawnAfterDestroyed()
   CAP_Wing:SetNumberCAP(self.capgrouping)
   CAP_Wing:SetCapCloseRaceTrack(true)
+    
+  if self.showpatrolpointmarks then
+    CAP_Wing:ShowPatrolPointMarkers(true)
+  end
   
   if self.capOptionVaryStartTime then
     CAP_Wing:SetCapStartTimeVariation(self.capOptionVaryStartTime,self.capOptionVaryEndTime)
@@ -596,9 +692,8 @@ function EASYGCICAP:_AddAirwing(Airbasename, Alias)
   if #self.ManagedREC > 0 then
     CAP_Wing:SetNumberRecon(1)
   end
-  --local PatrolCoordinateKutaisi = ZONE:New(CapZoneName):GetCoordinate()
-  --CAP_Wing:AddPatrolPointCAP(PatrolCoordinateKutaisi,self.capalt,UTILS.KnotsToAltKIAS(self.capspeed,self.capalt),self.capdir,self.capleg)
-  CAP_Wing:SetTakeoffHot()
+
+  CAP_Wing:SetTakeoffType(self.defaulttakeofftype)
   CAP_Wing:SetLowFuelThreshold(0.3)
   CAP_Wing.RandomAssetScore = math.random(50,100)
   CAP_Wing:Start()
@@ -606,6 +701,11 @@ function EASYGCICAP:_AddAirwing(Airbasename, Alias)
   local Intel = self.Intel
   
   local TankerInvisible = self.TankerInvisible
+  local engagerange = self.engagerange
+  local GoZoneSet = self.GoZoneSet
+  local NoGoZoneSet = self.NoGoZoneSet
+  local FuelLow = self.FuelLowThreshold or 25
+  local FuelCritical = self.FuelCriticalThreshold or 10
   
   function CAP_Wing:onbeforeFlightOnMission(From, Event, To, Flightgroup, Mission)
     local flightgroup = Flightgroup -- Ops.FlightGroup#FLIGHTGROUP
@@ -617,10 +717,15 @@ function EASYGCICAP:_AddAirwing(Airbasename, Alias)
     flightgroup:SetDestinationbase(AIRBASE:FindByName(Airbasename))
     flightgroup:GetGroup():CommandEPLRS(true,5)
     flightgroup:GetGroup():SetOptionRadarUsingForContinousSearch()
+    flightgroup:GetGroup():SetOptionLandingOverheadBreak()
     if Mission.type ~= AUFTRAG.Type.TANKER and Mission.type ~= AUFTRAG.Type.AWACS and Mission.type ~= AUFTRAG.Type.RECON then
       flightgroup:SetDetection(true)
-      flightgroup:SetEngageDetectedOn(self.engagerange,{"Air"},self.GoZoneSet,self.NoGoZoneSet)
+      flightgroup:SetEngageDetectedOn(engagerange,{"Air"},GoZoneSet,NoGoZoneSet)
       flightgroup:SetOutOfAAMRTB()
+      flightgroup:SetFuelLowRTB(true)
+      flightgroup:SetFuelLowThreshold(FuelLow)
+      flightgroup:SetFuelCriticalRTB(true)
+      flightgroup:SetFuelCriticalThreshold(FuelCritical)
       if CapFormation then
         flightgroup:GetGroup():SetOption(AI.Option.Air.id.FORMATION,CapFormation)
       end
@@ -659,24 +764,30 @@ end
 --- Add a CAP patrol point to a Wing
 -- @param #EASYGCICAP self
 -- @param #string AirbaseName Name of the Wing's airbase
--- @param Core.Point#COORDINATE Coordinate.
+-- @param Core.Point#COORDINATE Coordinate. Can be handed as a Core.Zone#ZONE object (e.g. in case you want  the point to align with a moving zone).
 -- @param #number Altitude Defaults to 25000 feet ASL.
 -- @param #number Speed  Defaults to 300 knots TAS.
 -- @param #number Heading Defaults to 90 degrees (East).
 -- @param #number LegLength Defaults to 15 NM.
 -- @return #EASYGCICAP self
 function EASYGCICAP:AddPatrolPointCAP(AirbaseName,Coordinate,Altitude,Speed,Heading,LegLength)
-  self:T(self.lid.."AddPatrolPointCAP "..Coordinate:ToStringLLDDM())
-  local EntryCAP = {} -- #EASYGCICAP.CapPoint
+  self:T(self.lid.."AddPatrolPointCAP")--..Coordinate:ToStringLLDDM())
+  local coordinate = Coordinate
+  local EntryCAP = {} -- #EASYGCICAP.CapPoint  
+  if Coordinate:IsInstanceOf("ZONE_BASE") then
+    -- adjust coordinate and get the coordinate from the zone
+    coordinate = Coordinate:GetCoordinate()
+    EntryCAP.Zone = Coordinate
+  end
   EntryCAP.AirbaseName = AirbaseName
-  EntryCAP.Coordinate = Coordinate
+  EntryCAP.Coordinate = coordinate
   EntryCAP.Altitude = Altitude or 25000
   EntryCAP.Speed = Speed or 300
   EntryCAP.Heading = Heading or 90
   EntryCAP.LegLength = LegLength or 15
   self.ManagedCP[#self.ManagedCP+1] = EntryCAP
   if self.debug then
-    local mark = MARKER:New(Coordinate,self.lid.."Patrol Point"):ToAll()
+    local mark = MARKER:New(coordinate,self.lid.."Patrol Point"):ToAll()
   end
   return self
 end
@@ -684,7 +795,7 @@ end
 --- Add a RECON patrol point to a Wing
 -- @param #EASYGCICAP self
 -- @param #string AirbaseName Name of the Wing's airbase
--- @param Core.Point#COORDINATE Coordinate.
+-- @param Core.Point#COORDINATE Coordinate. Can be handed as a Core.Zone#ZONE object (e.g. in case you want  the point to align with a moving zone).
 -- @param #number Altitude Defaults to 25000 feet.
 -- @param #number Speed  Defaults to 300 knots.
 -- @param #number Heading Defaults to 90 degrees (East).
@@ -709,7 +820,7 @@ end
 --- Add a TANKER patrol point to a Wing
 -- @param #EASYGCICAP self
 -- @param #string AirbaseName Name of the Wing's airbase
--- @param Core.Point#COORDINATE Coordinate.
+-- @param Core.Point#COORDINATE Coordinate. Can be handed as a Core.Zone#ZONE object (e.g. in case you want  the point to align with a moving zone).
 -- @param #number Altitude Defaults to 25000 feet.
 -- @param #number Speed  Defaults to 300 knots.
 -- @param #number Heading Defaults to 90 degrees (East).
@@ -734,7 +845,7 @@ end
 --- Add an AWACS patrol point to a Wing
 -- @param #EASYGCICAP self
 -- @param #string AirbaseName Name of the Wing's airbase
--- @param Core.Point#COORDINATE Coordinate.
+-- @param Core.Point#COORDINATE Coordinate. Can be handed as a Core.Zone#ZONE object (e.g. in case you want  the point to align with a moving zone).
 -- @param #number Altitude Defaults to 25000 feet.
 -- @param #number Speed  Defaults to 300 knots.
 -- @param #number Heading Defaults to 90 degrees (East).
@@ -763,6 +874,11 @@ function EASYGCICAP:_SetTankerPatrolPoints()
   self:T(self.lid.."_SetTankerPatrolPoints")
   for _,_data in pairs(self.ManagedTK) do
     local data = _data --#EASYGCICAP.CapPoint
+    self:T("Airbasename = "..data.AirbaseName)
+    if not self.wings[data.AirbaseName] then
+      MESSAGE:New(self.lid.."You are trying to create a TANKER point for which there is no wing! "..tostring(data.AirbaseName),30,"CHECK"):ToAllIf(self.debug):ToLog()
+      return
+    end
     local Wing = self.wings[data.AirbaseName][1] -- Ops.Airwing#AIRWING
     local Coordinate = data.Coordinate
     local Altitude = data.Altitude
@@ -782,6 +898,11 @@ function EASYGCICAP:_SetAwacsPatrolPoints()
   self:T(self.lid.."_SetAwacsPatrolPoints")
   for _,_data in pairs(self.ManagedEWR) do
     local data = _data --#EASYGCICAP.CapPoint
+    self:T("Airbasename = "..data.AirbaseName)
+    if not self.wings[data.AirbaseName] then
+      MESSAGE:New(self.lid.."You are trying to create an AWACS point for which there is no wing! "..tostring(data.AirbaseName),30,"CHECK"):ToAllIf(self.debug):ToLog()
+      return
+    end
     local Wing = self.wings[data.AirbaseName][1] -- Ops.Airwing#AIRWING
     local Coordinate = data.Coordinate
     local Altitude = data.Altitude
@@ -801,13 +922,23 @@ function EASYGCICAP:_SetCAPPatrolPoints()
   self:T(self.lid.."_SetCAPPatrolPoints")
   for _,_data in pairs(self.ManagedCP) do
     local data = _data --#EASYGCICAP.CapPoint
+    self:T("Airbasename = "..data.AirbaseName)
+    if not self.wings[data.AirbaseName] then
+      MESSAGE:New(self.lid.."You are trying to create a CAP point for which there is no wing! "..tostring(data.AirbaseName),30,"CHECK"):ToAllIf(self.debug):ToLog()
+      return
+    end
     local Wing = self.wings[data.AirbaseName][1] -- Ops.Airwing#AIRWING
     local Coordinate = data.Coordinate
     local Altitude = data.Altitude
     local Speed = data.Speed 
     local Heading = data.Heading
     local LegLength = data.LegLength
-    Wing:AddPatrolPointCAP(Coordinate,Altitude,Speed,Heading,LegLength)
+    local Zone = _data.Zone
+    if Zone then
+        Wing:AddPatrolPointCAP(Zone,Altitude,Speed,Heading,LegLength)
+    else
+        Wing:AddPatrolPointCAP(Coordinate,Altitude,Speed,Heading,LegLength)
+    end
   end
   
   return self
@@ -820,6 +951,11 @@ function EASYGCICAP:_SetReconPatrolPoints()
   self:T(self.lid.."_SetReconPatrolPoints")
   for _,_data in pairs(self.ManagedREC) do
     local data = _data --#EASYGCICAP.CapPoint
+    self:T("Airbasename = "..data.AirbaseName)
+    if not self.wings[data.AirbaseName] then
+      MESSAGE:New(self.lid.."You are trying to create a RECON point for which there is no wing! "..tostring(data.AirbaseName),30,"CHECK"):ToAllIf(self.debug):ToLog()
+      return
+    end
     local Wing = self.wings[data.AirbaseName][1] -- Ops.Airwing#AIRWING
     local Coordinate = data.Coordinate
     local Altitude = data.Altitude
@@ -868,7 +1004,7 @@ end
 -- @param #string SquadName Squadron name - must be unique!
 -- @param #string AirbaseName Name of the airbase the airwing resides on, e.g. AIRBASE.Caucasus.Kutaisi
 -- @param #number AirFrames Number of available airframes, e.g. 20.
--- @param #string Skill(optional) Skill level, e.g. AI.Skill.AVERAGE
+-- @param #string Skill (optional) Skill level, e.g. AI.Skill.AVERAGE
 -- @param #string Modex (optional) Modex to be used,e.g. 402.
 -- @param #string Livery (optional) Livery name to be used.
 -- @return #EASYGCICAP self 
@@ -1157,19 +1293,19 @@ end
 -- @return #boolean assigned
 -- @return #number leftover
 function EASYGCICAP:_TryAssignIntercept(ReadyFlightGroups,InterceptAuftrag,Group,WingSize)
-  self:I("_TryAssignIntercept for size "..WingSize or 1)
+  self:T("_TryAssignIntercept for size "..WingSize or 1)
   local assigned = false
   local wingsize = WingSize or 1
   local mindist = 0
   local disttable = {}
   if Group and Group:IsAlive() then
     local gcoord = Group:GetCoordinate() or COORDINATE:New(0,0,0)
-    self:I(self.lid..string.format("Assignment for %s",Group:GetName()))
+    self:T(self.lid..string.format("Assignment for %s",Group:GetName()))
     for _name,_FG in pairs(ReadyFlightGroups or {}) do
       local FG = _FG -- Ops.FlightGroup#FLIGHTGROUP
       local fcoord = FG:GetCoordinate()
       local dist = math.floor(UTILS.Round(fcoord:Get2DDistance(gcoord)/1000,1))
-      self:I(self.lid..string.format("FG %s Distance %dkm",_name,dist))
+      self:T(self.lid..string.format("FG %s Distance %dkm",_name,dist))
       disttable[#disttable+1] = { FG=FG, dist=dist}
       if dist>mindist then mindist=dist end
     end
@@ -1186,7 +1322,7 @@ function EASYGCICAP:_TryAssignIntercept(ReadyFlightGroups,InterceptAuftrag,Group
       local cm = FG:GetMissionCurrent()
       if cm then cm:Cancel() end
       wingsize = wingsize - 1
-      self:I(self.lid..string.format("Assigned to FG %s Distance %dkm",FG:GetName(),_entry.dist))
+      self:T(self.lid..string.format("Assigned to FG %s Distance %dkm",FG:GetName(),_entry.dist))
       if wingsize == 0 then 
         assigned = true
         break 
@@ -1216,7 +1352,7 @@ function EASYGCICAP:_AssignIntercept(Cluster)
   local conflictzoneset = self.ConflictZoneSet
   local ReadyFlightGroups = self.ReadyFlightGroups
   
-    -- Aircraft?
+  -- Aircraft?
   if Cluster.ctype ~= INTEL.Ctype.AIRCRAFT then return end
   -- Threatlevel 0..10
   local contact = self.Intel:GetHighestThreatContact(Cluster)
@@ -1261,6 +1397,10 @@ function EASYGCICAP:_AssignIntercept(Cluster)
       local data = _data -- #EASYGCICAP.CapPoint
       local name = data.AirbaseName
       local zonecoord = data.Coordinate
+      if data.Zone then
+            -- refresh coordinate in case we have a (moving) zone
+            zonecoord = data.Zone:GetCoordinate()
+      end
       local airwing = wings[name][1]
       local coa = AIRBASE:FindByName(name):GetCoalition()
       local samecoalitionab = coa == self.coalition and true or false
@@ -1362,7 +1502,7 @@ function EASYGCICAP:_StartIntel()
 end
 
 -------------------------------------------------------------------------
--- FSM Functions
+-- TODO FSM Functions
 -------------------------------------------------------------------------
 
 --- (Internal) FSM Function onafterStart
@@ -1458,7 +1598,7 @@ function EASYGCICAP:onafterStatus(From,Event,To)
         local engage = FG:IsEngaging()
         local hasmissiles = FG:IsOutOfMissiles() == nil and true or false
         local ready = hasmissiles and FG:IsFuelGood() and FG:IsAirborne()
-        --self:I(string.format("Flightgroup %s Engaging = %s Ready = %s",tostring(name),tostring(engage),tostring(ready)))
+        --self:T(string.format("Flightgroup %s Engaging = %s Ready = %s",tostring(name),tostring(engage),tostring(ready)))
         if ready then
           self.ReadyFlightGroups[name] = FG
         end
@@ -1493,5 +1633,8 @@ end
 function EASYGCICAP:onafterStop(From,Event,To)
   self:T({From,Event,To})
   self.Intel:Stop()
+  for _,_wing in pairs(self.wings or {}) do
+    _wing:Stop()
+  end
   return self
 end

Moose Development/Moose/Ops/FlightGroup.lua

@@ -259,7 +259,7 @@ function FLIGHTGROUP:New(group)
   local self=BASE:Inherit(self, OPSGROUP:New(group)) -- #FLIGHTGROUP
 
   -- Set some string id for output to DCS.log file.
-  self.lid=string.format("FLIGHTGROUP %s | ", self.groupname)
+  self.lid=string.format("FLIGHTGROUP %s | ", self.groupname or "N/A")
 
   -- Defaults
   self:SetDefaultROE()
@@ -779,6 +779,61 @@ function FLIGHTGROUP:SetJettisonWeapons(Switch)
   return self
 end
 
+--- Set the aircraft to land straight in.
+-- @param #FLIGHTGROUP self
+-- @return #FLIGHTGROUP self
+function FLIGHTGROUP:SetOptionLandingStraightIn()
+  self.OptionLandingStraightIn = true
+  if self:GetGroup():IsAlive() then
+    self:GetGroup():SetOptionLandingStraightIn()
+  end
+  return self
+end
+
+--- Set the aircraft to land in pairs.
+-- @param #FLIGHTGROUP self
+-- @return #FLIGHTGROUP self
+function FLIGHTGROUP:SetOptionLandingForcePair()
+  self.OptionLandingForcePair = true
+  if self:GetGroup():IsAlive() then
+    self:GetGroup():SetOptionLandingForcePair()
+  end
+  return self
+end
+
+--- Set the aircraft to NOT land in pairs.
+-- @param #FLIGHTGROUP self
+-- @return #FLIGHTGROUP self
+function FLIGHTGROUP:SetOptionLandingRestrictPair()
+  self.OptionLandingRestrictPair = true
+  if self:GetGroup():IsAlive() then
+    self:GetGroup():SetOptionLandingRestrictPair()
+  end
+  return self
+end
+
+--- Set the aircraft to land after overhead break.
+-- @param #FLIGHTGROUP self
+-- @return #FLIGHTGROUP self
+function FLIGHTGROUP:SetOptionLandingOverheadBreak()
+  self.OptionLandingOverheadBreak = true
+  if self:GetGroup():IsAlive() then
+    self:GetGroup():SetOptionLandingOverheadBreak()
+  end
+  return self
+end
+
+--- [HELICOPTER] Set the aircraft to prefer takeoff and landing vertically.
+-- @param #FLIGHTGROUP self
+-- @return #FLIGHTGROUP self
+function FLIGHTGROUP:SetOptionPreferVertical()
+  self.OptionPreferVertical = true
+  if self:GetGroup():IsAlive() then
+    self:GetGroup():OptionPreferVerticalLanding()
+  end
+  return self
+end
+
 --- Set if group is ready for taxi/takeoff if controlled by a `FLIGHTCONTROL`.
 -- @param #FLIGHTGROUP self
 -- @param #boolean ReadyTO If `true`, flight is ready for takeoff.
@@ -2002,6 +2057,9 @@ function FLIGHTGROUP:onafterElementAirborne(From, Event, To, Element)
 
   -- Debug info.
   self:T2(self.lid..string.format("Element airborne %s", Element.name))
+  
+  -- Set parking spot to free. Also for FC. This is usually done after taxiing but doing it here in case the group is teleported.
+  self:_SetElementParkingFree(Element)  
 
   -- Set element status.
   self:_UpdateStatus(Element, OPSGROUP.ElementStatus.AIRBORNE)
@@ -3076,7 +3134,7 @@ function FLIGHTGROUP:onbeforeLandAtAirbase(From, Event, To, airbase)
     local Tsuspend=nil
 
     if airbase==nil then
-      self:T(self.lid.."ERROR: Airbase is nil in LandAtAirase() call!")
+      self:T(self.lid.."ERROR: Airbase is nil in LandAtAirbase() call!")
       allowed=false
     end
 
@@ -4494,6 +4552,11 @@ function FLIGHTGROUP:GetParkingSpot(element, maxdist, airbase)
   -- Airbase.
   airbase=airbase or self:GetClosestAirbase()
 
+  if airbase == nil then
+    self:T(self.lid.."No airbase found for element "..element.name)
+    return nil
+  end
+
   -- Parking table of airbase.
   local parking=airbase.parking --:GetParkingSpotsTable()
 
@@ -4604,10 +4667,12 @@ function FLIGHTGROUP:GetParking(airbase)
     local coords={}
     for clientname, client in pairs(clients) do
       local template=_DATABASE:GetGroupTemplateFromUnitName(clientname)
-      local units=template.units
-      for i,unit in pairs(units) do
-        local coord=COORDINATE:New(unit.x, unit.alt, unit.y)
-        coords[unit.name]=coord
+      if template then
+        local units=template.units
+        for i,unit in pairs(units) do
+          local coord=COORDINATE:New(unit.x, unit.alt, unit.y)
+          coords[unit.name]=coord
+        end
       end
     end
     return coords

Moose Development/Moose/Ops/Intelligence.lua

@@ -2324,7 +2324,7 @@ INTEL_DLINK = {
   verbose         =     0,
   lid             =   nil,
   alias           =   nil,
-  cachetime       =   300,
+  cachetime       =   120,
   interval        =   20,
   contacts        =   {},
   clusters        =   {},
@@ -2333,7 +2333,7 @@ INTEL_DLINK = {
 
 --- Version string
 -- @field #string version
-INTEL_DLINK.version = "0.0.1"
+INTEL_DLINK.version = "0.0.2"
 
 --- Function to instantiate a new object
 -- @param #INTEL_DLINK self
@@ -2384,15 +2384,15 @@ function INTEL_DLINK:New(Intels, Alias, Interval, Cachetime)
     self.alias="SPECTRE"
   end
 
-  -- Cache time
-  self.cachetime = Cachetime or 300
-
   -- Interval
   self.interval = Interval or 20
 
   -- Set some string id for output to DCS.log file.
   self.lid=string.format("INTEL_DLINK %s | ", self.alias)
 
+  -- Cache time
+  self:SetDLinkCacheTime(Cachetime or 120)
+  
     -- Start State.
   self:SetStartState("Stopped")
 
@@ -2477,6 +2477,16 @@ function INTEL_DLINK:onafterStart(From, Event, To)
   return self
 end
 
+  --- Function to set how long INTEL DLINK remembers contacts.
+  -- @param #INTEL_DLINK self
+  -- @param #number seconds Remember this many seconds. Defaults to 180.
+  -- @return #INTEL_DLINK self
+  function INTEL_DLINK:SetDLinkCacheTime(seconds)
+    self.cachetime = math.abs(seconds or 120)
+    self:I(self.lid.."Caching for "..self.cachetime.." seconds.")
+    return self
+  end
+
 --- Function to collect data from the various #INTEL
 -- @param #INTEL_DLINK self
 -- @param #string From The From state

Moose Development/Moose/Ops/Legion.lua

@@ -2513,9 +2513,12 @@ function LEGION._GetCohorts(Legions, Cohorts, Operation, OpsQueue)
     for _,_legion in pairs(Legions or {}) do
       local legion=_legion --Ops.Legion#LEGION
   
-      -- Check that runway is operational.    
-      local Runway=legion:IsAirwing() and legion:IsRunwayOperational() or true
-      
+      -- Check that runway is operational.
+      local Runway=true
+      if legion:IsAirwing() then
+        Runway=legion:IsRunwayOperational() and legion.airbase and legion.airbase:GetCoalition() == legion:GetCoalition()
+      end
+
       -- Legion has to be running.
       if legion:IsRunning() and Runway then
       

Moose Development/Moose/Ops/OpsGroup.lua

@@ -445,7 +445,6 @@ OPSGROUP.TaskType={
 -- @field Wrapper.Marker#MARKER marker Marker on the F10 map.
 -- @field #string formation Ground formation. Similar to action but on/off road.
 -- @field #number missionUID Mission UID (Auftragsnr) this waypoint belongs to.
--- @field Navigation.FlightPlan#FLIGHTPLAN flightplan Flightplan this waypoint belongs to.
 
 --- Cargo Carrier status.
 -- @type OPSGROUP.CarrierStatus
@@ -574,11 +573,6 @@ function OPSGROUP:New(group)
 
   -- Set DCS group and controller.
   self.dcsgroup=self:GetDCSGroup()
-  
-  if not self.dcsgroup then
-    return
-  end
-  
   self.controller=self.dcsgroup:getController()
 
   -- Category.
@@ -5595,10 +5589,13 @@ function OPSGROUP:onafterUnpauseMission(From, Event, To)
     -- Debug info.
     self:T(self.lid..string.format("Unpausing mission %s [%s]", mission:GetName(), mission:GetType()))
     
+    -- Set state of mission, e.g. for not teleporting again
+    mission.unpaused=true
+    
     -- Start mission.
     self:MissionStart(mission)
     
-    -- Remove mission from 
+    -- Remove mission from pausedmissions queue
     for i,mid in pairs(self.pausedmissions) do
       --self:T(self.lid..string.format("Checking paused mission", mid))
       if mid==mission.auftragsnummer then
@@ -5733,7 +5730,7 @@ function OPSGROUP:onafterMissionDone(From, Event, To, Mission)
   -- Decrease patrol data.
   if Mission.patroldata then
     Mission.patroldata.noccupied=Mission.patroldata.noccupied-1
-    AIRWING.UpdatePatrolPointMarker(Mission.patroldata)
+    AIRWING.UpdatePatrolPointMarker(self,Mission.patroldata)
   end
 
   -- Switch auto engage detected off. This IGNORES that engage detected had been activated for the group!
@@ -6238,7 +6235,7 @@ function OPSGROUP:RouteToMission(mission, delay)
     end
     
     -- Check if group is mobile. Note that some immobile units report a speed of 1 m/s = 3.6 km/h.
-    if self.speedMax<=3.6 or mission.teleport then
+    if (self.speedMax<=3.6 or mission.teleport) and not mission.unpaused then
 
       -- Teleport to waypoint coordinate. Mission will not be paused.
       self:Teleport(waypointcoord, nil, true)
@@ -11355,9 +11352,9 @@ function OPSGROUP:_SimpleTaskFunction(Function, uid)
   return DCSTask
 end
 
---- Enhanced waypoint table.
+--- Enhance waypoint table.
 -- @param #OPSGROUP self
--- @param #OPSGROUP.Waypoint waypoint Waypoint data.
+-- @param #OPSGROUP.Waypoint Waypoint data.
 -- @return #OPSGROUP.Waypoint Modified waypoint data.
 function OPSGROUP:_CreateWaypoint(waypoint)
 
@@ -12785,7 +12782,7 @@ function OPSGROUP:_UpdatePosition()
     self.positionLast=self.position or self:GetVec3()
     self.headingLast=self.heading or self:GetHeading()
     self.orientXLast=self.orientX or self:GetOrientationX()
-    self.velocityLast=self.velocity or self.group:GetVelocityMPS()
+  self.velocityLast=self.velocity or self.group:GetVelocityMPS()
 
     -- Current state.
     self.position=self:GetVec3()
@@ -13613,24 +13610,20 @@ end
 -- @return Core.Point#COORDINATE The coordinate of the object.
 function OPSGROUP:_CoordinateFromObject(Object)
 
-  env.info("FF coordfrom object")
   if Object then
-    if VECTOR._IsVector(Object) then
-      env.info("FF VECTOR")
-      return Object:GetCoordinate()
-    elseif Object:IsInstanceOf("COORDINATE") then
+    if Object:IsInstanceOf("COORDINATE") then
       return Object
     else
       if Object:IsInstanceOf("POSITIONABLE") or Object:IsInstanceOf("ZONE_BASE") then
-        self:E(self.lid.."WARNING: Coordinate is not a COORDINATE but a POSITIONABLE or ZONE. Trying to get coordinate")
+        self:T(self.lid.."WARNING: Coordinate is not a COORDINATE but a POSITIONABLE or ZONE. Trying to get coordinate")
         local coord=Object:GetCoordinate()
         return coord
       else
-        self:E(self.lid.."ERROR: Coordinate is neither a COORDINATE nor any POSITIONABLE or ZONE!")
+        self:T(self.lid.."ERROR: Coordinate is neither a COORDINATE nor any POSITIONABLE or ZONE!")
       end
     end
   else
-    self:E(self.lid.."ERROR: Object passed is nil!")
+    self:T(self.lid.."ERROR: Object passed is nil!")
   end
 
   return nil

Moose Development/Moose/Ops/OpsZone.lua

@@ -53,7 +53,8 @@
 -- @field #number threatlevelCapture Threat level necessary to capture a zone.
 -- @field Core.Set#SET_UNIT ScanUnitSet Set of scanned units.
 -- @field Core.Set#SET_GROUP ScanGroupSet Set of scanned groups.
--- @extends Core.Fsm#FSM
+-- @field #number UpdateSeconds Run status every this many seconds.
+-- @extends Core.Fsm#FSM 
 
 --- *Gentlemen, when the enemy is committed to a mistake we must not interrupt him too soon.* --- Horation Nelson
 --
@@ -77,6 +78,7 @@ OPSZONE = {
   Tnut           =     0,
   chiefs         =    {},
   Missions       =    {},
+  UpdateSeconds  =    120,
 }
 
 --- OPSZONE.MISSION
@@ -97,7 +99,7 @@ OPSZONE.ZoneType={
 
 --- OPSZONE class version.
 -- @field #string version
-OPSZONE.version="0.6.1"
+OPSZONE.version="0.6.2"
 
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 -- ToDo list
@@ -733,7 +735,8 @@ function OPSZONE:onafterStart(From, Event, To)
   self.timerStatus=self.timerStatus or TIMER:New(OPSZONE.Status, self)
   
   -- Status update.
-  self.timerStatus:Start(1, 120)
+  local EveryUpdateIn = self.UpdateSeconds or 120
+  self.timerStatus:Start(1, EveryUpdateIn)
   
   -- Handle base captured event.
   if self.airbase then

Moose Development/Moose/Ops/PlayerRecce.lua

@@ -1544,7 +1544,7 @@ end
 -- @param #PLAYERRECCE self
 -- @param #number Frequency Frequency to be used. Can also be given as a table of multiple frequencies, e.g. 271 or {127,251}. There needs to be exactly the same number of modulations!
 -- @param #number Modulation Modulation to be used. Can also be given as a table of multiple modulations, e.g. radio.modulation.AM or {radio.modulation.FM,radio.modulation.AM}. There needs to be exactly the same number of frequencies!
--- @param #string PathToSRS Defaults to "C:\\Program Files\\DCS-SimpleRadio-Standalone"
+-- @param #string PathToSRS Defaults to "C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio"
 -- @param #string Gender (Optional) Defaults to "male"
 -- @param #string Culture (Optional) Defaults to "en-US"
 -- @param #number Port (Optional) Defaults to 5002
@@ -1556,7 +1556,7 @@ end
 -- @return #PLAYERRECCE self
 function PLAYERRECCE:SetSRS(Frequency,Modulation,PathToSRS,Gender,Culture,Port,Voice,Volume,PathToGoogleKey,Backend)
   self:T(self.lid.."SetSRS")
-  self.PathToSRS = PathToSRS or MSRS.path or "C:\\Program Files\\DCS-SimpleRadio-Standalone" --
+  self.PathToSRS = PathToSRS or MSRS.path or "C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio" --
   self.Gender = Gender or MSRS.gender or "male" --
   self.Culture = Culture or MSRS.culture or "en-US" --
   self.Port = Port or MSRS.port or 5002 --

Moose Development/Moose/Ops/PlayerTask.lua

@@ -21,7 +21,7 @@
 -- ===
 -- @module Ops.PlayerTask
 -- @image OPS_PlayerTask.jpg
--- @date Last Update Jan 2025
+-- @date Last Update May 2025
 
 
 do
@@ -98,7 +98,7 @@ PLAYERTASK = {
 
 --- PLAYERTASK class version.
 -- @field #string version
-PLAYERTASK.version="0.1.25"
+PLAYERTASK.version="0.1.27"
 
 --- Generic task condition.
 -- @type PLAYERTASK.Condition
@@ -556,6 +556,7 @@ end
 -- @param #PLAYERTASK self
 -- @param #SET_BASE CaptureSquadGroupNamePrefix The prefix of the group name that needs to capture the zone.
 -- @param #number Coalition The coalition that needs to capture the zone.
+-- @param #boolean CheckClientInZone If true, a CLIENT assigned to this task also needs to be in the zone for the task to be successful.
 -- @return #PLAYERTASK self
 -- @usage
 -- -- We can use either STATIC, SET_STATIC, SCENERY or SET_SCENERY as target objects.
@@ -570,20 +571,20 @@ end
 --
 -- -- We set CaptureSquadGroupNamePrefix the group name prefix as set in the ME or the spawn of the group that need to be present at the OpsZone like a capture squad,
 -- -- and set the capturing Coalition in order to trigger a successful task.
--- mytask:AddOpsZoneCaptureSuccessCondition("capture-squad", coalition.side.BLUE)
+-- mytask:AddOpsZoneCaptureSuccessCondition("capture-squad", coalition.side.BLUE, false)
 --
 -- playerTaskManager:AddPlayerTaskToQueue(mytask)
-function PLAYERTASK:AddOpsZoneCaptureSuccessCondition(CaptureSquadGroupNamePrefix, Coalition)
+function PLAYERTASK:AddOpsZoneCaptureSuccessCondition(CaptureSquadGroupNamePrefix, Coalition, CheckClientInZone)
     local task = self
     task:AddConditionSuccess(
             function(target)
                 if target:IsInstanceOf("OPSZONE") then
-                    return task:_CheckCaptureOpsZoneSuccess(target, CaptureSquadGroupNamePrefix, Coalition, true)
+                    return task:_CheckCaptureOpsZoneSuccess(target, CaptureSquadGroupNamePrefix, Coalition, CheckClientInZone or true)
                 elseif target:IsInstanceOf("SET_OPSZONE") then
                     local successes = 0
                     local isClientInZone = false
                     target:ForEachZone(function(opszone)
-                        if task:_CheckCaptureOpsZoneSuccess(opszone, CaptureSquadGroupNamePrefix, Coalition) then
+                        if task:_CheckCaptureOpsZoneSuccess(opszone, CaptureSquadGroupNamePrefix, Coalition, CheckClientInZone or true) then
                             successes = successes + 1
                         end
 
@@ -979,6 +980,12 @@ function PLAYERTASK:onafterStatus(From, Event, To)
   
   if status == "Stopped" then return self end
   
+  -- update marker in case target is moving
+  if self.TargetMarker then
+    local coordinate = self.Target:GetCoordinate() 
+    self.TargetMarker:UpdateCoordinate(coordinate,0.5) 
+  end
+  
   -- Check Target status
   local targetdead = false
   
@@ -1433,9 +1440,9 @@ do
 --            taskmanager:AddRejectZone(ZONE:FindByName("RejectZone"))
 --            
 --            -- Set up using SRS for messaging
---            local hereSRSPath = "C:\\Program Files\\DCS-SimpleRadio-Standalone"
+--            local hereSRSPath = "C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio"
 --            local hereSRSPort = 5002
---            -- local hereSRSGoogle = "C:\\Program Files\\DCS-SimpleRadio-Standalone\\yourkey.json"
+--            -- local hereSRSGoogle = "C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio\\yourkey.json"
 --            taskmanager:SetSRS({130,255},{radio.modulation.AM,radio.modulation.AM},hereSRSPath,"female","en-GB",hereSRSPort,"Microsoft Hazel Desktop",0.7,hereSRSGoogle)
 --            
 --            -- Controller will announce itself under these broadcast frequencies, handy to use cold-start frequencies here of your aircraft
@@ -1902,7 +1909,7 @@ PLAYERTASKCONTROLLER.Messages = {
   
 --- PLAYERTASK class version.
 -- @field #string version
-PLAYERTASKCONTROLLER.version="0.1.69"
+PLAYERTASKCONTROLLER.version="0.1.70"
 
 --- Create and run a new TASKCONTROLLER instance.
 -- @param #PLAYERTASKCONTROLLER self
@@ -1944,7 +1951,7 @@ function PLAYERTASKCONTROLLER:New(Name, Coalition, Type, ClientFilter)
   self.taskinfomenu = false
   self.activehasinfomenu = false
   self.MenuName = nil
-  self.menuitemlimit = 5
+  self.menuitemlimit = 6
   self.holdmenutime = 30
   
   self.MarkerReadOnly = false
@@ -2415,7 +2422,7 @@ function PLAYERTASKCONTROLLER:EnablePrecisionBombing(FlightGroup,LaserCode,Holdi
         end  
       )
     else
-      self:E(self.lid.."No FLIGHTGROUP object passed or FLIGHTGROUP is not alive!")
+      self:E(self.lid.."No OPSGROUP/SET_OPSGROUP object passed or object is not alive!")
     end
   else
     self.autolase = nil
@@ -2574,7 +2581,7 @@ function PLAYERTASKCONTROLLER:SetMenuOptions(InfoMenu,ItemLimit,HoldTime)
   if self.activehasinfomenu then
     self:EnableTaskInfoMenu()
   end
-  self.menuitemlimit = ItemLimit or 5
+  self.menuitemlimit = ItemLimit+1 or 6
   self.holdmenutime = HoldTime or 30
   return self
 end
@@ -3479,7 +3486,7 @@ end
 -- @param #PLAYERTASKCONTROLLER self
 -- @param Ops.PlayerTask#PLAYERTASK PlayerTask
 -- @param #boolean Silent If true, make no "has new task" announcement
--- @param #boolen TaskFilter If true, apply the white/black-list task filters here, also
+-- @param #boolean TaskFilter If true, apply the white/black-list task filters here, also
 -- @return #PLAYERTASKCONTROLLER self
 -- @usage
 -- Example to create a PLAYERTASK of type CTLD and give Players 10 minutes to complete:
@@ -3703,6 +3710,7 @@ function PLAYERTASKCONTROLLER:_ActiveTaskInfo(Task, Group, Client)
     else
       CoordText = Coordinate:ToStringA2A(Client,nil,self.ShowMagnetic)
     end
+    --self:I("CoordText = "..CoordText)
     -- Threat Level
     local ThreatLevel = task.Target:GetThreatLevelMax()
     --local ThreatLevelText = "high"
@@ -3837,7 +3845,8 @@ function PLAYERTASKCONTROLLER:_ActiveTaskInfo(Task, Group, Client)
         Text = string.gsub(Text,"9","niner")
         CoordText = "MGRS;"..Text
         if self.PathToGoogleKey then
-          CoordText = string.format("<say-as interpret-as='characters'>%s</say-as>",CoordText)
+          --CoordText = string.format("<say-as interpret-as=\'characters\'>%s</say-as>",CoordText)
+          --doesn't seem to work any longer
         end
         --self:I(self.lid.." | ".. CoordText)
       end
@@ -3855,10 +3864,12 @@ function PLAYERTASKCONTROLLER:_ActiveTaskInfo(Task, Group, Client)
         CoordText = string.gsub(ttstext," BR, "," Bee, Arr, ")
        end
       elseif task:HasFreetext() then
+      
         -- add tts freetext
         local brieftxt = self.gettext:GetEntry("BRIEFING",self.locale)
         ttstext = ttstext .. string.format("; %s: ",brieftxt)..task:GetFreetextTTS()
       end
+      --self:I("**** TTS Text ****\n"..ttstext.."\n*****")
       self.SRSQueue:NewTransmission(ttstext,nil,self.SRS,nil,2)
     end  
   else
@@ -4357,7 +4368,7 @@ function PLAYERTASKCONTROLLER:SwitchDetectStatics(OnOff)
   return self
 end
 
---- [User] Add accept zone to INTEL detection. You need to set up detection with @{#PLAYERTASKCONTROLLER.SetupIntel}() **before** using this.
+--- [User] Add an accept zone to INTEL detection. You need to set up detection with @{#PLAYERTASKCONTROLLER.SetupIntel}() **before** using this.
 -- @param #PLAYERTASKCONTROLLER self
 -- @param Core.Zone#ZONE AcceptZone Add a zone to the accept zone set.
 -- @return #PLAYERTASKCONTROLLER self
@@ -4371,7 +4382,7 @@ function PLAYERTASKCONTROLLER:AddAcceptZone(AcceptZone)
   return self
 end
 
---- [User] Add accept SET_ZONE to INTEL detection. You need to set up detection with @{#PLAYERTASKCONTROLLER.SetupIntel}() **before** using this.
+--- [User] Add an accept SET_ZONE to INTEL detection. You need to set up detection with @{#PLAYERTASKCONTROLLER.SetupIntel}() **before** using this.
 -- @param #PLAYERTASKCONTROLLER self
 -- @param Core.Set#SET_ZONE AcceptZoneSet Add a SET_ZONE to the accept zone set.
 -- @return #PLAYERTASKCONTROLLER self
@@ -4385,7 +4396,7 @@ function PLAYERTASKCONTROLLER:AddAcceptZoneSet(AcceptZoneSet)
   return self
 end
 
---- [User] Add reject zone to INTEL detection. You need to set up detection with @{#PLAYERTASKCONTROLLER.SetupIntel}() **before** using this.
+--- [User] Add a reject zone to INTEL detection. You need to set up detection with @{#PLAYERTASKCONTROLLER.SetupIntel}() **before** using this.
 -- @param #PLAYERTASKCONTROLLER self
 -- @param Core.Zone#ZONE RejectZone Add a zone to the reject zone set.
 -- @return #PLAYERTASKCONTROLLER self
@@ -4399,7 +4410,7 @@ function PLAYERTASKCONTROLLER:AddRejectZone(RejectZone)
   return self
 end
 
---- [User] Add reject SET_ZONE to INTEL detection. You need to set up detection with @{#PLAYERTASKCONTROLLER.SetupIntel}() **before** using this.
+--- [User] Add a reject SET_ZONE to INTEL detection. You need to set up detection with @{#PLAYERTASKCONTROLLER.SetupIntel}() **before** using this.
 -- @param #PLAYERTASKCONTROLLER self
 -- @param Core.Set#SET_ZONE  RejectZoneSet Add a zone to the reject zone set.
 -- @return #PLAYERTASKCONTROLLER self
@@ -4413,9 +4424,37 @@ function PLAYERTASKCONTROLLER:AddRejectZoneSet(RejectZoneSet)
   return self
 end
 
---- [User] Remove accept zone from INTEL detection. You need to set up detection with @{#PLAYERTASKCONTROLLER.SetupIntel}() **before** using this.
+--- [User] Add a conflict zone to INTEL detection. You need to set up detection with @{#PLAYERTASKCONTROLLER.SetupIntel}() **before** using this.
 -- @param #PLAYERTASKCONTROLLER self
--- @param Core.Zone#ZONE AcceptZone Add a zone to the accept zone set.
+-- @param Core.Zone#ZONE ConflictZone Add a zone to the conflict zone set.
+-- @return #PLAYERTASKCONTROLLER self
+function PLAYERTASKCONTROLLER:AddConflictZone(ConflictZone)
+  self:T(self.lid.."AddConflictZone")
+  if self.Intel then
+    self.Intel:AddConflictZone(ConflictZone)
+  else
+    self:E(self.lid.."*****NO detection has been set up (yet)!")
+  end
+  return self
+end
+
+--- [User] Add a conflict SET_ZONE to INTEL detection. You need to set up detection with @{#PLAYERTASKCONTROLLER.SetupIntel}() **before** using this.
+-- @param #PLAYERTASKCONTROLLER self
+-- @param Core.Set#SET_ZONE ConflictZoneSet Add a zone to the conflict zone set.
+-- @return #PLAYERTASKCONTROLLER self
+function PLAYERTASKCONTROLLER:AddConflictZoneSet(ConflictZoneSet)
+  self:T(self.lid.."AddConflictZoneSet")
+  if self.Intel then
+    self.Intel.conflictzoneset:AddSet(ConflictZoneSet)
+  else
+    self:E(self.lid.."*****NO detection has been set up (yet)!")
+  end
+  return self
+end
+
+--- [User] Remove an accept zone from INTEL detection. You need to set up detection with @{#PLAYERTASKCONTROLLER.SetupIntel}() **before** using this.
+-- @param #PLAYERTASKCONTROLLER self
+-- @param Core.Zone#ZONE AcceptZone Remove this zone from the accept zone set.
 -- @return #PLAYERTASKCONTROLLER self
 function PLAYERTASKCONTROLLER:RemoveAcceptZone(AcceptZone)
   self:T(self.lid.."RemoveAcceptZone")
@@ -4427,11 +4466,11 @@ function PLAYERTASKCONTROLLER:RemoveAcceptZone(AcceptZone)
   return self
 end
 
---- [User] Remove reject zone from INTEL detection. You need to set up detection with @{#PLAYERTASKCONTROLLER.SetupIntel}() **before** using this.
+--- [User] Remove a reject zone from INTEL detection. You need to set up detection with @{#PLAYERTASKCONTROLLER.SetupIntel}() **before** using this.
 -- @param #PLAYERTASKCONTROLLER self
--- @param Core.Zone#ZONE RejectZone Add a zone to the reject zone set.
+-- @param Core.Zone#ZONE RejectZone Remove this zone from the reject zone set.
 -- @return #PLAYERTASKCONTROLLER self
-function PLAYERTASKCONTROLLER:RemoveRejectZoneSet(RejectZone)
+function PLAYERTASKCONTROLLER:RemoveRejectZone(RejectZone)
   self:T(self.lid.."RemoveRejectZone")
   if self.Intel then
     self.Intel:RemoveRejectZone(RejectZone)
@@ -4441,6 +4480,20 @@ function PLAYERTASKCONTROLLER:RemoveRejectZoneSet(RejectZone)
   return self
 end
 
+--- [User] Remove a conflict zone from INTEL detection. You need to set up detection with @{#PLAYERTASKCONTROLLER.SetupIntel}() **before** using this.
+-- @param #PLAYERTASKCONTROLLER self
+-- @param Core.Zone#ZONE ConflictZone Remove this zone from the conflict zone set.
+-- @return #PLAYERTASKCONTROLLER self
+function PLAYERTASKCONTROLLER:RemoveConflictZone(ConflictZone)
+  self:T(self.lid.."RemoveConflictZone")
+  if self.Intel then
+    self.Intel:RemoveConflictZone(ConflictZone)
+  else
+    self:E(self.lid.."*****NO detection has been set up (yet)!")
+  end
+  return self
+end
+
 --- [User] Set the top menu name to a custom string.
 -- @param #PLAYERTASKCONTROLLER self
 -- @param #string Name The name to use as the top menu designation.
@@ -4553,7 +4606,7 @@ end
 -- @param #PLAYERTASKCONTROLLER self
 -- @param #number Frequency Frequency to be used. Can also be given as a table of multiple frequencies, e.g. 271 or {127,251}. There needs to be exactly the same number of modulations!
 -- @param #number Modulation Modulation to be used. Can also be given as a table of multiple modulations, e.g. radio.modulation.AM or {radio.modulation.FM,radio.modulation.AM}. There needs to be exactly the same number of frequencies!
--- @param #string PathToSRS Defaults to "C:\\Program Files\\DCS-SimpleRadio-Standalone"
+-- @param #string PathToSRS Defaults to "C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio"
 -- @param #string Gender (Optional) Defaults to "male"
 -- @param #string Culture (Optional) Defaults to "en-US"
 -- @param #number Port (Optional) Defaults to 5002
@@ -4567,7 +4620,7 @@ end
 -- @return #PLAYERTASKCONTROLLER self
 function PLAYERTASKCONTROLLER:SetSRS(Frequency,Modulation,PathToSRS,Gender,Culture,Port,Voice,Volume,PathToGoogleKey,AccessKey,Coordinate,Backend)
   self:T(self.lid.."SetSRS")
-  self.PathToSRS = PathToSRS or MSRS.path or "C:\\Program Files\\DCS-SimpleRadio-Standalone" --
+  self.PathToSRS = PathToSRS or MSRS.path or "C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio" --
   self.Gender = Gender or MSRS.gender or "male" --
   self.Culture = Culture or MSRS.culture or "en-US" --
   self.Port = Port or MSRS.port or 5002 --

Moose Development/Moose/Ops/Target.lua

@@ -1715,6 +1715,26 @@ function TARGET:GetAverageCoordinate()
   return nil
 end
 
+
+--- Get coordinates of all targets. (e.g. for a SET_STATIC)
+-- @param #TARGET self
+-- @return #table Table with coordinates of all targets.
+function TARGET:GetCoordinates()
+    local coordinates={}
+
+    for _,_target in pairs(self.targets) do
+        local target=_target --#TARGET.Object
+
+        local coordinate=self:GetTargetCoordinate(target)
+        if coordinate then
+            table.insert(coordinates, coordinate)
+        end
+
+    end
+
+    return coordinates
+end
+
 --- Get heading of target.
 -- @param #TARGET self
 -- @return #number Heading of the target in degrees.
@@ -1968,6 +1988,21 @@ function TARGET:GetObject(RefCoordinate, Coalitions)
   return nil
 end
 
+--- Get all target objects.
+-- @param #TARGET self
+-- @return #table List of target objects.
+function TARGET:GetObjects()
+    local objects={}
+
+    for _,_target in pairs(self.targets) do
+        local target=_target --#TARGET.Object
+
+        table.insert(objects, target.Object)
+    end
+
+    return objects
+end
+
 --- Count alive objects.
 -- @param #TARGET self
 -- @param #TARGET.Object Target Target objective.

Moose Development/Moose/Shapes/Circle.lua

@@ -72,7 +72,7 @@ end
 
 --- Checks if a point is contained within the circle.
 -- @param #table point The point to check
--- @return #bool True if the point is contained, false otherwise
+-- @return #boolean True if the point is contained, false otherwise
 function CIRCLE:ContainsPoint(point)
     if ((point.x - self.CenterVec2.x) ^ 2 + (point.y - self.CenterVec2.y) ^ 2) ^ 0.5 <= self.Radius then
         return true
@@ -226,6 +226,11 @@ end
 --- Returns a random Vec2 within the circle.
 -- @return #table The random Vec2
 function CIRCLE:GetRandomVec2()
+
+    math.random()
+    math.random()
+    math.random()
+    
     local angle = math.random() * 2 * math.pi
 
     local rx = math.random(0, self.Radius) * math.cos(angle) + self.CenterVec2.x
@@ -237,6 +242,11 @@ end
 --- Returns a random Vec2 on the border of the circle.
 -- @return #table The random Vec2
 function CIRCLE:GetRandomVec2OnBorder()
+    
+    math.random()
+    math.random()
+    math.random()
+
     local angle = math.random() * 2 * math.pi
 
     local rx = self.Radius * math.cos(angle) + self.CenterVec2.x

Moose Development/Moose/Shapes/Polygon.lua

@@ -352,6 +352,7 @@ end
 --- Returns a random Vec2 within the polygon. The Vec2 is weighted by the areas of the triangles that make up the polygon.
 -- @return #table The random Vec2
 function POLYGON:GetRandomVec2()
+
     local weights = {}
     for _, triangle in pairs(self.Triangles) do
         weights[triangle] = triangle.SurfaceArea / self.SurfaceArea

Moose Development/Moose/Shapes/Triangle.lua

@@ -73,6 +73,11 @@ end
 -- @param #table points The points of the triangle, or 3 other points if you're just using the TRIANGLE class without an object of it
 -- @return #table The random Vec2
 function TRIANGLE:GetRandomVec2(points)
+
+    math.random()
+    math.random()
+    math.random()
+    
     points = points or self.Points
     local pt = {math.random(), math.random()}
     table.sort(pt)

Moose Development/Moose/Sound/RadioQueue.lua

@@ -361,7 +361,6 @@ end
 -- @param #RADIOQUEUE self
 -- @param #RADIOQUEUE.Transmission transmission The transmission.
 function RADIOQUEUE:Broadcast(transmission)
-  self:T("Broadcast")
 
   if ((transmission.soundfile and transmission.soundfile.useSRS) or transmission.soundtext) and self.msrs then
     self:_BroadcastSRS(transmission)
@@ -377,6 +376,9 @@ function RADIOQUEUE:Broadcast(transmission)
   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 init: %s", sender:GetName(),tostring(self.senderinit)))
+    
+    
     self:T(self.lid..string.format("Broadcasting from aircraft %s", sender:GetName()))
     
     
@@ -421,7 +423,7 @@ function RADIOQUEUE:Broadcast(transmission)
     -- Debug message.
     if self.Debugmode then
       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):ToAll()
+      MESSAGE:New(text, 2, "RADIOQUEUE "..self.alias):ToAll():ToLog()
     end
       
   else
@@ -453,7 +455,7 @@ function RADIOQUEUE:Broadcast(transmission)
       -- Debug message.
       if self.Debugmode then
         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):ToAll()
+        MESSAGE:New(string.format(text, filename, transmission.duration, transmission.subtitle or ""), 5, "RADIOQUEUE "..self.alias):ToAll():ToLog()
       end
     else
       self:E("ERROR: Could not get vec3 to determine transmission origin! Did you specify a sender and is it still alive?")
@@ -486,7 +488,7 @@ end
 --- Check radio queue for transmissions to be broadcasted.
 -- @param #RADIOQUEUE self
 function RADIOQUEUE:_CheckRadioQueue()
-
+  self:T("_CheckRadioQueue")
   -- Check if queue is empty.
   if #self.queue==0 then
     -- Queue is now empty. Nothing to else to do.

Moose Development/Moose/Sound/SRS.lua

@@ -443,28 +443,32 @@ MSRS.Voices = {
        ["en_AU_Standard_B"] = 'en-AU-Standard-B', -- [2] MALE
        ["en_AU_Standard_C"] = 'en-AU-Standard-C', -- [3] FEMALE
        ["en_AU_Standard_D"] = 'en-AU-Standard-D', -- [4] MALE
-       ["en_IN_Standard_A"] = 'en-IN-Standard-A', -- [5] FEMALE
-       ["en_IN_Standard_B"] = 'en-IN-Standard-B', -- [6] MALE
-       ["en_IN_Standard_C"] = 'en-IN-Standard-C', -- [7] MALE
-       ["en_IN_Standard_D"] = 'en-IN-Standard-D', -- [8] FEMALE
+       -- IN
+        ["en_IN_Standard_A"] = 'en-IN-Standard-A', -- Female
+        ["en_IN_Standard_B"] = 'en-IN-Standard-B', -- Male
+        ["en_IN_Standard_C"] = 'en-IN-Standard-C', -- Male
+        ["en_IN_Standard_D"] = 'en-IN-Standard-D', -- Female
+        ["en_IN_Standard_E"] = 'en-IN-Standard-E', -- Female
+        ["en_IN_Standard_F"] = 'en-IN-Standard-F', -- Male
        -- 2025 changes
-       ["en_GB_Standard_A"] = 'en-GB-Standard-N', -- [9] FEMALE
-       ["en_GB_Standard_B"] = 'en-GB-Standard-O', -- [10] MALE
-       ["en_GB_Standard_C"] = 'en-GB-Standard-N', -- [11] FEMALE
-       ["en_GB_Standard_D"] = 'en-GB-Standard-O', -- [12] MALE
-       ["en_GB_Standard_F"] = 'en-GB-Standard-N', -- [13] FEMALE
-       ["en_GB_Standard_O"] = 'en-GB-Standard-O', -- [12] MALE
-       ["en_GB_Standard_N"] = 'en-GB-Standard-N', -- [13] FEMALE
-       ["en_US_Standard_A"] = 'en-US-Standard-A', -- [14] MALE
-       ["en_US_Standard_B"] = 'en-US-Standard-B', -- [15] MALE
-       ["en_US_Standard_C"] = 'en-US-Standard-C', -- [16] FEMALE
-       ["en_US_Standard_D"] = 'en-US-Standard-D', -- [17] MALE
-       ["en_US_Standard_E"] = 'en-US-Standard-E', -- [18] FEMALE
-       ["en_US_Standard_F"] = 'en-US-Standard-F', -- [19] FEMALE
-       ["en_US_Standard_G"] = 'en-US-Standard-G', -- [20] FEMALE
-       ["en_US_Standard_H"] = 'en-US-Standard-H', -- [21] FEMALE
-       ["en_US_Standard_I"] = 'en-US-Standard-I', -- [22] MALE
-       ["en_US_Standard_J"] = 'en-US-Standard-J', -- [23] MALE
+       ["en_GB_Standard_A"] = 'en-GB-Standard-A', -- Female
+       ["en_GB_Standard_B"] = 'en-GB-Standard-B', -- Male
+       ["en_GB_Standard_C"] = 'en-GB-Standard-C', -- Female
+       ["en_GB_Standard_D"] = 'en-GB-Standard-D', -- Male
+       ["en_GB_Standard_F"] = 'en-GB-Standard-F', -- Female
+       ["en_GB_Standard_N"] = 'en-GB-Standard-N', -- Female
+       ["en_GB_Standard_O"] = 'en-GB-Standard-O', -- Male
+       -- US
+       ["en_US_Standard_A"] = 'en-US-Standard-A', -- Male
+       ["en_US_Standard_B"] = 'en-US-Standard-B', -- Male
+       ["en_US_Standard_C"] = 'en-US-Standard-C', -- Female
+       ["en_US_Standard_D"] = 'en-US-Standard-D', -- Male
+       ["en_US_Standard_E"] = 'en-US-Standard-E', -- Female
+       ["en_US_Standard_F"] = 'en-US-Standard-F', -- Female
+       ["en_US_Standard_G"] = 'en-US-Standard-G', -- Female
+       ["en_US_Standard_H"] = 'en-US-Standard-H', -- Female
+       ["en_US_Standard_I"] = 'en-US-Standard-I', -- Male
+       ["en_US_Standard_J"] = 'en-US-Standard-J', -- Male
        -- 2025 catalog changes
        ["fr_FR_Standard_A"] = "fr-FR-Standard-F", -- Female
        ["fr_FR_Standard_B"] = "fr-FR-Standard-G", -- Male
@@ -474,14 +478,15 @@ MSRS.Voices = {
        ["fr_FR_Standard_G"] = "fr-FR-Standard-G", -- Male
        ["fr_FR_Standard_F"] = "fr-FR-Standard-F", -- Female
        -- 2025 catalog changes
-       ["de_DE_Standard_A"] = "de-DE-Standard-G", -- Female
-       ["de_DE_Standard_B"] = "de-DE-Standard-H", -- Male
-       ["de_DE_Standard_C"] = "de-DE-Standard-G", -- Female
-       ["de_DE_Standard_D"] = "de-DE-Standard-H", -- Male
-       ["de_DE_Standard_E"] = "de-DE-Standard-H", -- Male
-       ["de_DE_Standard_F"] = "de-DE-Standard-G", -- Female
-       ["de_DE_Standard_H"] = "de-DE-Standard-H", -- Male
-       ["de_DE_Standard_G"] = "de-DE-Standard-G", -- Female
+      ["de_DE_Standard_A"] = 'de-DE-Standard-A', -- Female
+      ["de_DE_Standard_B"] = 'de-DE-Standard-B', -- Male
+      ["de_DE_Standard_C"] = 'de-DE-Standard-C', -- Female
+      ["de_DE_Standard_D"] = 'de-DE-Standard-D', -- Male
+      ["de_DE_Standard_E"] = 'de-DE-Standard-E', -- Male
+      ["de_DE_Standard_F"] = 'de-DE-Standard-F', -- Female
+      ["de_DE_Standard_G"] = 'de-DE-Standard-G', -- Female
+      ["de_DE_Standard_H"] = 'de-DE-Standard-H', -- Male
+      -- ES
        ["es_ES_Standard_A"] = "es-ES-Standard-E", -- Female
        ["es_ES_Standard_B"] = "es-ES-Standard-F", -- Male
        ["es_ES_Standard_C"] = "es-ES-Standard-E", -- Female
@@ -497,32 +502,36 @@ MSRS.Voices = {
        ["it_IT_Standard_F"] = "it-IT-Standard-F", -- Male
       },
       Wavenet = {
-       ["en_AU_Wavenet_A"] = 'en-AU-Wavenet-A', -- [1] FEMALE
-       ["en_AU_Wavenet_B"] = 'en-AU-Wavenet-B', -- [2] MALE
-       ["en_AU_Wavenet_C"] = 'en-AU-Wavenet-C', -- [3] FEMALE
-       ["en_AU_Wavenet_D"] = 'en-AU-Wavenet-D', -- [4] MALE
-       ["en_IN_Wavenet_A"] = 'en-IN-Wavenet-A', -- [5] FEMALE
-       ["en_IN_Wavenet_B"] = 'en-IN-Wavenet-B', -- [6] MALE
-       ["en_IN_Wavenet_C"] = 'en-IN-Wavenet-C', -- [7] MALE
-       ["en_IN_Wavenet_D"] = 'en-IN-Wavenet-D', -- [8] FEMALE
+       ["en_AU_Wavenet_A"] = 'en-AU-Wavenet-A', -- Female
+       ["en_AU_Wavenet_B"] = 'en-AU-Wavenet-B', -- Male
+       ["en_AU_Wavenet_C"] = 'en-AU-Wavenet-C', -- Female
+       ["en_AU_Wavenet_D"] = 'en-AU-Wavenet-D', -- Male
+       -- IN
+        ["en_IN_Wavenet_A"] = 'en-IN-Wavenet-A', -- Female
+        ["en_IN_Wavenet_B"] = 'en-IN-Wavenet-B', -- Male
+        ["en_IN_Wavenet_C"] = 'en-IN-Wavenet-C', -- Male
+        ["en_IN_Wavenet_D"] = 'en-IN-Wavenet-D', -- Female
+        ["en_IN_Wavenet_E"] = 'en-IN-Wavenet-E', -- Female
+        ["en_IN_Wavenet_F"] = 'en-IN-Wavenet-F', -- Male
        -- 2025 changes
-       ["en_GB_Wavenet_A"] = 'en-GB-Wavenet-N', -- [9] FEMALE
-       ["en_GB_Wavenet_B"] = 'en-GB-Wavenet-O', -- [10] MALE
-       ["en_GB_Wavenet_C"] = 'en-GB-Wavenet-N', -- [11] FEMALE
-       ["en_GB_Wavenet_D"] = 'en-GB-Wavenet-O', -- [12] MALE
-       ["en_GB_Wavenet_F"] = 'en-GB-Wavenet-N', -- [13] FEMALE
+       ["en_GB_Wavenet_A"] = 'en-GB-Wavenet-A', -- [9] FEMALE
+       ["en_GB_Wavenet_B"] = 'en-GB-Wavenet-B', -- [10] MALE
+       ["en_GB_Wavenet_C"] = 'en-GB-Wavenet-C', -- [11] FEMALE
+       ["en_GB_Wavenet_D"] = 'en-GB-Wavenet-D', -- [12] MALE
+       ["en_GB_Wavenet_F"] = 'en-GB-Wavenet-F', -- [13] FEMALE
        ["en_GB_Wavenet_O"] = 'en-GB-Wavenet-O', -- [12] MALE
-       ["en_GB_Wavenet_N"] = 'en-GB-Wavenet-N', -- [13] FEMALE     
-       ["en_US_Wavenet_A"] = 'en-US-Wavenet-N', -- [14] MALE
-       ["en_US_Wavenet_B"] = 'en-US-Wavenet-B', -- [15] MALE
-       ["en_US_Wavenet_C"] = 'en-US-Wavenet-C', -- [16] FEMALE
-       ["en_US_Wavenet_D"] = 'en-US-Wavenet-D', -- [17] MALE
-       ["en_US_Wavenet_E"] = 'en-US-Wavenet-E', -- [18] FEMALE
-       ["en_US_Wavenet_F"] = 'en-US-Wavenet-F', -- [19] FEMALE
-       ["en_US_Wavenet_G"] = 'en-US-Wavenet-G', -- [20] FEMALE
-       ["en_US_Wavenet_H"] = 'en-US-Wavenet-H', -- [21] FEMALE
-       ["en_US_Wavenet_I"] = 'en-US-Wavenet-I', -- [22] MALE
-       ["en_US_Wavenet_J"] = 'en-US-Wavenet-J', -- [23] MALE
+       ["en_GB_Wavenet_N"] = 'en-GB-Wavenet-N', -- [13] FEMALE  
+       -- US   
+       ["en_US_Wavenet_A"] = 'en-US-Wavenet-A', -- Male
+       ["en_US_Wavenet_B"] = 'en-US-Wavenet-B', -- Male
+       ["en_US_Wavenet_C"] = 'en-US-Wavenet-C', -- Female
+       ["en_US_Wavenet_D"] = 'en-US-Wavenet-D', -- Male
+       ["en_US_Wavenet_E"] = 'en-US-Wavenet-E', -- Female
+       ["en_US_Wavenet_F"] = 'en-US-Wavenet-F', -- Female
+       ["en_US_Wavenet_G"] = 'en-US-Wavenet-G', -- Female
+       ["en_US_Wavenet_H"] = 'en-US-Wavenet-H', -- Female
+       ["en_US_Wavenet_I"] = 'en-US-Wavenet-I', -- Male
+       ["en_US_Wavenet_J"] = 'en-US-Wavenet-J', -- Male
        -- 2025 catalog changes
        ["fr_FR_Wavenet_A"] = "fr-FR-Wavenet-F", -- Female
        ["fr_FR_Wavenet_B"] = "fr-FR-Wavenet-G", -- Male
@@ -532,14 +541,15 @@ MSRS.Voices = {
        ["fr_FR_Wavenet_G"] = "fr-FR-Wavenet-G", -- Male
        ["fr_FR_Wavenet_F"] = "fr-FR-Wavenet-F", -- Female
        -- 2025 catalog changes
-       ["de_DE_Wavenet_A"] = "de-DE-Wavenet-G", -- Female
-       ["de_DE_Wavenet_B"] = "de-DE-Wavenet-H", -- Male
-       ["de_DE_Wavenet_C"] = "de-DE-Wavenet-G", -- Female
-       ["de_DE_Wavenet_D"] = "de-DE-Wavenet-H", -- Male
-       ["de_DE_Wavenet_E"] = "de-DE-Wavenet-H", -- Male
-       ["de_DE_Wavenet_F"] = "de-DE-Wavenet-G", -- Female
-       ["de_DE_Wavenet_H"] = "de-DE-Wavenet-H", -- Male
-       ["de_DE_Wavenet_G"] = "de-DE-Wavenet-G", -- Female
+        ["de_DE_Wavenet_A"] = 'de-DE-Wavenet-A', -- Female
+        ["de_DE_Wavenet_B"] = 'de-DE-Wavenet-B', -- Male
+        ["de_DE_Wavenet_C"] = 'de-DE-Wavenet-C', -- Female
+        ["de_DE_Wavenet_D"] = 'de-DE-Wavenet-D', -- Male
+        ["de_DE_Wavenet_E"] = 'de-DE-Wavenet-E', -- Male
+        ["de_DE_Wavenet_F"] = 'de-DE-Wavenet-F', -- Female
+        ["de_DE_Wavenet_G"] = 'de-DE-Wavenet-G', -- Female
+        ["de_DE_Wavenet_H"] = 'de-DE-Wavenet-H', -- Male
+       -- ES
        ["es_ES_Wavenet_B"] = "es-ES-Wavenet-E", -- Male
        ["es_ES_Wavenet_C"] = "es-ES-Wavenet-F", -- Female
        ["es_ES_Wavenet_D"] = "es-ES-Wavenet-E", -- Female
@@ -553,6 +563,134 @@ MSRS.Voices = {
        ["it_IT_Wavenet_E"] = "it-IT-Wavenet-E", -- Female
        ["it_IT_Wavenet_F"] = "it-IT-Wavenet-F", -- Male
       } ,
+      Chirp3HD = {
+       ["en_GB_Chirp3_HD_Aoede"] = 'en-GB-Chirp3-HD-Aoede', -- Female
+       ["en_GB_Chirp3_HD_Charon"] = 'en-GB-Chirp3-HD-Charon', -- Male
+       ["en_GB_Chirp3_HD_Fenrir"] = 'en-GB-Chirp3-HD-Fenrir', -- Male
+       ["en_GB_Chirp3_HD_Kore"] = 'en-GB-Chirp3-HD-Kore', -- Female
+       ["en_GB_Chirp3_HD_Leda"] = 'en-GB-Chirp3-HD-Leda', -- Female
+       ["en_GB_Chirp3_HD_Orus"] = 'en-GB-Chirp3-HD-Orus', -- Male
+       ["en_GB_Chirp3_HD_Puck"] = 'en-GB-Chirp3-HD-Puck', -- Male
+       ["en_GB_Chirp3_HD_Zephyr"] = 'en-GB-Chirp3-HD-Zephyr', -- Female
+       --["de_DE_Chirp3_HD_Aoede"] = 'de-DE-Chirp3-HD-Aoede', -- Female (Datenfehler im Original)
+       ["en_US_Chirp3_HD_Charon"] = 'en-US-Chirp3-HD-Charon', -- Male
+       ["en_US_Chirp3_HD_Fenrir"] = 'en-US-Chirp3-HD-Fenrir', -- Male
+       ["en_US_Chirp3_HD_Kore"] = 'en-US-Chirp3-HD-Kore', -- Female
+       ["en_US_Chirp3_HD_Leda"] = 'en-US-Chirp3-HD-Leda', -- Female
+       ["en_US_Chirp3_HD_Orus"] = 'en-US-Chirp3-HD-Orus', -- Male
+       ["en_US_Chirp3_HD_Puck"] = 'en-US-Chirp3-HD-Puck', -- Male
+       --["de_DE_Chirp3_HD_Zephyr"] = 'de-DE-Chirp3-HD-Zephyr', -- Female (Datenfehler im Original)
+       -- DE
+       ["de_DE_Chirp3_HD_Aoede"] = 'de-DE-Chirp3-HD-Aoede', -- Female
+       ["de_DE_Chirp3_HD_Charon"] = 'de-DE-Chirp3-HD-Charon', -- Male
+       ["de_DE_Chirp3_HD_Fenrir"] = 'de-DE-Chirp3-HD-Fenrir', -- Male
+       ["de_DE_Chirp3_HD_Kore"] = 'de-DE-Chirp3-HD-Kore', -- Female
+       ["de_DE_Chirp3_HD_Leda"] = 'de-DE-Chirp3-HD-Leda', -- Female
+       ["de_DE_Chirp3_HD_Orus"] = 'de-DE-Chirp3-HD-Orus', -- Male
+       ["de_DE_Chirp3_HD_Puck"] = 'de-DE-Chirp3-HD-Puck', -- Male
+       ["de_DE_Chirp3_HD_Zephyr"] = 'de-DE-Chirp3-HD-Zephyr', -- Female
+       -- AU
+       ["en_AU_Chirp3_HD_Aoede"] = 'en-AU-Chirp3-HD-Aoede', -- Female
+       ["en_AU_Chirp3_HD_Charon"] = 'en-AU-Chirp3-HD-Charon', -- Male
+       ["en_AU_Chirp3_HD_Fenrir"] = 'en-AU-Chirp3-HD-Fenrir', -- Male
+       ["en_AU_Chirp3_HD_Kore"] = 'en-AU-Chirp3-HD-Kore', -- Female
+       ["en_AU_Chirp3_HD_Leda"] = 'en-AU-Chirp3-HD-Leda', -- Female
+       ["en_AU_Chirp3_HD_Orus"] = 'en-AU-Chirp3-HD-Orus', -- Male
+       ["en_AU_Chirp3_HD_Puck"] = 'en-AU-Chirp3-HD-Puck', -- Male
+       ["en_AU_Chirp3_HD_Zephyr"] = 'en-AU-Chirp3-HD-Zephyr', -- Female
+       -- IN
+       ["en_IN_Chirp3_HD_Aoede"] = 'en-IN-Chirp3-HD-Aoede', -- Female
+       ["en_IN_Chirp3_HD_Charon"] = 'en-IN-Chirp3-HD-Charon', -- Male
+       ["en_IN_Chirp3_HD_Fenrir"] = 'en-IN-Chirp3-HD-Fenrir', -- Male
+       ["en_IN_Chirp3_HD_Kore"] = 'en-IN-Chirp3-HD-Kore', -- Female
+       ["en_IN_Chirp3_HD_Leda"] = 'en-IN-Chirp3-HD-Leda', -- Female
+       ["en_IN_Chirp3_HD_Orus"] = 'en-IN-Chirp3-HD-Orus', -- Male
+      },
+      ChirpHD = {
+       ["en_US_Chirp_HD_D"] = 'en-US-Chirp-HD-D', -- Male
+       ["en_US_Chirp_HD_F"] = 'en-US-Chirp-HD-F', -- Female
+       ["en_US_Chirp_HD_O"] = 'en-US-Chirp-HD-O', -- Female
+       -- DE
+       ["de_DE_Chirp_HD_D"] = 'de-DE-Chirp-HD-D', -- Male
+       ["de_DE_Chirp_HD_F"] = 'de-DE-Chirp-HD-F', -- Female
+       ["de_DE_Chirp_HD_O"] = 'de-DE-Chirp-HD-O', -- Female
+       -- AU
+       ["en_AU_Chirp_HD_D"] = 'en-AU-Chirp-HD-D', -- Male
+       ["en_AU_Chirp_HD_F"] = 'en-AU-Chirp-HD-F', -- Female
+       ["en_AU_Chirp_HD_O"] = 'en-AU-Chirp-HD-O', -- Female
+       -- IN
+       ["en_IN_Chirp_HD_D"] = 'en-IN-Chirp-HD-D', -- Male
+       ["en_IN_Chirp_HD_F"] = 'en-IN-Chirp-HD-F', -- Female
+       ["en_IN_Chirp_HD_O"] = 'en-IN-Chirp-HD-O', -- Female
+      },
+    },
+    Neural2 = {
+       ["en_GB_Neural2_A"] = 'en-GB-Neural2-A', -- Female
+       ["en_GB_Neural2_B"] = 'en-GB-Neural2-B', -- Male
+       ["en_GB_Neural2_C"] = 'en-GB-Neural2-C', -- Female
+       ["en_GB_Neural2_D"] = 'en-GB-Neural2-D', -- Male
+       ["en_GB_Neural2_F"] = 'en-GB-Neural2-F', -- Female
+       ["en_GB_Neural2_N"] = 'en-GB-Neural2-N', -- Female
+       ["en_GB_Neural2_O"] = 'en-GB-Neural2-O', -- Male
+       -- US
+       ["en_US_Neural2_A"] = 'en-US-Neural2-A', -- Male
+       ["en_US_Neural2_C"] = 'en-US-Neural2-C', -- Female
+       ["en_US_Neural2_D"] = 'en-US-Neural2-D', -- Male
+       ["en_US_Neural2_E"] = 'en-US-Neural2-E', -- Female
+       ["en_US_Neural2_F"] = 'en-US-Neural2-F', -- Female
+       ["en_US_Neural2_G"] = 'en-US-Neural2-G', -- Female
+       ["en_US_Neural2_H"] = 'en-US-Neural2-H', -- Female
+       ["en_US_Neural2_I"] = 'en-US-Neural2-I', -- Male
+       ["en_US_Neural2_J"] = 'en-US-Neural2-J', -- Male
+       -- DE
+       ["de_DE_Neural2_G"] = 'de-DE-Neural2-G', -- Female
+       ["de_DE_Neural2_H"] = 'de-DE-Neural2-H', -- Male
+       -- AU
+       ["en_AU_Neural2_A"] = 'en-AU-Neural2-A', -- Female
+       ["en_AU_Neural2_B"] = 'en-AU-Neural2-B', -- Male
+       ["en_AU_Neural2_C"] = 'en-AU-Neural2-C', -- Female
+       ["en_AU_Neural2_D"] = 'en-AU-Neural2-D', -- Male
+       -- IN
+       ["en_IN_Neural2_A"] = 'en-IN-Neural2-A', -- Female
+       ["en_IN_Neural2_B"] = 'en-IN-Neural2-B', -- Male
+       ["en_IN_Neural2_C"] = 'en-IN-Neural2-C', -- Male
+       ["en_IN_Neural2_D"] = 'en-IN-Neural2-D', -- Female
+    },
+    News = {
+       ["en_GB_News_G"] = 'en-GB-News-G', -- Female
+       ["en_GB_News_H"] = 'en-GB-News-H', -- Female
+       ["en_GB_News_I"] = 'en-GB-News-I', -- Female
+       ["en_GB_News_J"] = 'en-GB-News-J', -- Male
+       ["en_GB_News_K"] = 'en-GB-News-K', -- Male
+       ["en_GB_News_L"] = 'en-GB-News-L', -- Male
+       ["en_GB_News_M"] = 'en-GB-News-M', -- Male
+       -- US
+       ["en_US_News_K"] = 'en-US-News-K', -- Female
+       ["en_US_News_L"] = 'en-US-News-L', -- Female
+       ["en_US_News_N"] = 'en-US-News-N', -- Male
+       -- AU
+       ["en_AU_News_E"] = 'en-AU-News-E', -- Female
+       ["en_AU_News_F"] = 'en-AU-News-F', -- Female
+       ["en_AU_News_G"] = 'en-AU-News-G', -- Male
+    },
+    Casual = {
+       ["en_US_Casual_K"] = 'en-US-Casual-K', -- Male
+    },
+    Polyglot = {
+       ["en_US_Polyglot_1"] = 'en-US-Polyglot-1', -- Male
+       ["de_DE_Polyglot_1"] = 'de-DE-Polyglot-1', -- Male
+       ["en_AU_Polyglot_1"] = 'en-AU-Polyglot-1', -- Male
+    },
+    Studio = {
+       -- Englisch (UK) - Studio
+       ["en_GB_Studio_B"] = 'en-GB-Studio-B', -- Male
+       ["en_GB_Studio_C"] = 'en-GB-Studio-C', -- Female
+       -- Englisch (USA) - Studio
+       ["en_US_Studio_O"] = 'en-US-Studio-O', -- Female
+       ["en_US_Studio_Q"] = 'en-US-Studio-Q', -- Male
+       -- DE
+       ["de_DE_Studio_B"] = 'de-DE-Studio-B', -- Male
+       ["de_DE_Studio_C"] = 'de-DE-Studio-C', -- Female
     },
   }
 
@@ -632,7 +770,7 @@ end
 -- set the path to the exe file via @{#MSRS.SetPath}.
 --
 -- @param #MSRS self
--- @param #string Path Path to SRS directory. Default `C:\\Program Files\\DCS-SimpleRadio-Standalone`.
+-- @param #string Path Path to SRS directory. Default `C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio`.
 -- @param #number Frequency Radio frequency in MHz. Default 143.00 MHz. Can also be given as a #table of multiple frequencies.
 -- @param #number Modulation Radio modulation: 0=AM (default), 1=FM. See `radio.modulation.AM` and `radio.modulation.FM` enumerators. Can also be given as a #table of multiple modulations.
 -- @param #string Backend Backend used: `MSRS.Backend.SRSEXE` (default) or `MSRS.Backend.GRPC`.
@@ -767,13 +905,13 @@ end
 
 --- Set path to SRS install directory. More precisely, path to where the `DCS-SR-ExternalAudio.exe` is located.
 -- @param #MSRS self
--- @param #string Path Path to the directory, where the sound file is located. Default is `C:\\Program Files\\DCS-SimpleRadio-Standalone`.
+-- @param #string Path Path to the directory, where the sound file is located. Default is `C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio`.
 -- @return #MSRS self
 function MSRS:SetPath(Path)
   self:F( {Path=Path} )
 
   -- Set path.
-  self.path=Path or "C:\\Program Files\\DCS-SimpleRadio-Standalone"
+  self.path=Path or "C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio"
 
   -- Remove (back)slashes.
   local n=1 ; local nmax=1000
@@ -1817,7 +1955,7 @@ end
 --
 --     -- Moose MSRS default Config
 --     MSRS_Config = {
---       Path = "C:\\Program Files\\DCS-SimpleRadio-Standalone", -- Path to SRS install directory.
+--       Path = "C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio", -- Path to SRS install directory.
 --       Port = 5002,            -- Port of SRS server. Default 5002.
 --       Backend = "srsexe",     -- Interface to SRS: "srsexe" or "grpc".
 --       Frequency = {127, 243}, -- Default frequences. Must be a table 1..n entries!
@@ -1837,7 +1975,7 @@ end
 --       -- Google Cloud
 --       gcloud = {
 --         voice = "en-GB-Standard-A", -- The Google Cloud voice to use (see https://cloud.google.com/text-to-speech/docs/voices).
---         credentials="C:\\Program Files\\DCS-SimpleRadio-Standalone\\yourfilename.json", -- Full path to credentials JSON file (only for SRS-TTS.exe backend)
+--         credentials="C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio\\yourfilename.json", -- Full path to credentials JSON file (only for SRS-TTS.exe backend)
 --         key="Your access Key", -- Google API access key (only for DCS-gRPC backend)
 --       },
 --       -- Amazon Web Service
@@ -1905,7 +2043,7 @@ function MSRS:LoadConfigFile(Path,Filename)
 
       local Self = self or MSRS  --#MSRS
 
-      Self.path = MSRS_Config.Path or "C:\\Program Files\\DCS-SimpleRadio-Standalone"
+      Self.path = MSRS_Config.Path or "C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio"
       Self.port = MSRS_Config.Port or 5002
       Self.backend = MSRS_Config.Backend or MSRS.Backend.SRSEXE
       Self.frequencies = MSRS_Config.Frequency or {127,243}

Moose Development/Moose/Sound/SoundOutput.lua

@@ -291,7 +291,8 @@ do -- Sound File
 end
 
 do -- Text-To-Speech
-
+  
+  ---
   -- @type SOUNDTEXT
   -- @field #string ClassName Name of the class
   -- @field #string text Text to speak.