Warehouse & OpsTransport

**WAREHOUSE**
- Switched from AI_CARGO_DISPATCHER to OPSTRANSPORT

**OPSTRANSPORT**
- Fixed bugs

.github/workflows/build-docs.yml

@@ -3,7 +3,7 @@ name: Moose-Docs
 on:
   push:
     branches:
-      - master
+      - master-ng
       - develop
     paths:
       - 'Moose Setup/**/*.lua'
@@ -77,11 +77,11 @@ jobs:
 
       - name: Install markdown (prereq for LuaDocumentor)
         run: |
-          sudo luarocks install markdown 0.32-2
+          sudo luarocks install markdown 0.33-1
 
       - name: Install penlight (prereq for LuaDocumentor)
         run: |
-          sudo luarocks install penlight 1.11.0-1
+          sudo luarocks install penlight 1.14.0-3
 
       - name: Install metalua-compiler (prereq for LuaDocumentor)
         run: |
@@ -113,7 +113,7 @@ jobs:
 
       - name: Check replacement of head tag
         run: |
-          head -10 ${{ github.workspace }}/build/doc/AI.AI_A2A_Cap.html
+          head -10 ${{ github.workspace }}/build/doc/Core.Menu.html
 
       #########################################################################
       # Push to MOOSE_DOCS
@@ -122,7 +122,7 @@ jobs:
         shell: bash
         id: set_doc_repo
         run: |
-          if [[ $GITHUB_REF == 'refs/heads/master' ]]; then
+          if [[ $GITHUB_REF == 'refs/heads/master-ng' ]]; then
               echo "docrepo=MOOSE_DOCS" >> "$GITHUB_OUTPUT"
           else
               echo "docrepo=MOOSE_DOCS_DEVELOP" >> "$GITHUB_OUTPUT"
@@ -134,7 +134,7 @@ jobs:
           repository: ${{ github.repository_owner }}/${{ steps.set_doc_repo.outputs.docrepo }}
           path: './build/MOOSE_DOCS'
           fetch-depth: 0
-          ref: 'master'
+          ref: 'master-ng'
           token: ${{ secrets.BOT_TOKEN }}
 
       - name: Delete folder to remove deleted files
@@ -155,7 +155,7 @@ jobs:
           git config user.email "MooseBotter@users.noreply.github.com"
           git add .
           git commit --allow-empty -m "Auto commit by GitHub Actions Workflow"
-          git push --set-upstream origin master
+          git push --set-upstream origin 'master-ng'
 
         working-directory: ${{ github.workspace }}/build/MOOSE_DOCS
 

.github/workflows/build-includes.yml

@@ -3,7 +3,7 @@ name: Moose-Includes
 on:
   push:
     branches:
-      - master
+      - master-ng
       - develop
       - Apple/Develop
       
@@ -105,7 +105,7 @@ jobs:
         if: ${{ vars.SKIP_LUACHECK != true }}
         continue-on-error: true
         run: |
-          luacheck --std=lua51c --config=.luacheckrc -gurasqq "Moose Development/Moose"
+          luacheck --std=lua51c --config=.luacheckrc -guras "Moose Development/Moose"
 
       - name: Run LuaSrcDiet
         run: |

.github/workflows/gh-pages.yml

@@ -8,7 +8,7 @@ name: Deploy Jekyll site to Pages
 
 on:
   push:
-    branches: ["master"]
+    branches: ["master-ng"]
     paths:
       - 'docs/**'
       - '.github/workflows/gh-pages.yml'

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/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, 
-      POINT_VEC3.RoutePointType.TurningPoint, 
-      POINT_VEC3.RoutePointAction.TurningPoint, 
-      RTBSpeed, 
-      true 
-    )
-
-    --- Create a route point of type air.
-    local ToRTBRoutePoint = ToAirbaseCoord:WaypointAir( 
-      self.PatrolAltType, 
-      POINT_VEC3.RoutePointType.TurningPoint, 
-      POINT_VEC3.RoutePointAction.TurningPoint, 
-      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, POINT_VEC3.RoutePointType.TurningPoint, POINT_VEC3.RoutePointAction.TurningPoint, ToRefuelSpeed, true)
-
-      --- Create a route point of type air. NOT used!
-      local ToRefuelRoutePoint = Tanker:GetCoordinate():WaypointAir(self.PatrolAltType, POINT_VEC3.RoutePointType.TurningPoint, POINT_VEC3.RoutePointAction.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", POINT_VEC3.RoutePointType.TurningPoint, POINT_VEC3.RoutePointAction.TurningPoint, EngageSpeed, true)
-        
-        EngageRoute[#EngageRoute+1] = FromWP
-  
-        self:SetTargetDistance( TargetCoord ) -- For RTB status check
-        
-        local FromEngageAngle = DefenderCoord:GetAngleDegrees( DefenderCoord:GetDirectionVec3( TargetCoord ) )
-        local ToCoord=DefenderCoord:Translate( EngageDistance, FromEngageAngle, true )
-        
-        local ToWP = ToCoord:WaypointAir(self.PatrolAltType or "RADIO", POINT_VEC3.RoutePointType.TurningPoint, POINT_VEC3.RoutePointAction.TurningPoint, EngageSpeed, true)
-  
-        EngageRoute[#EngageRoute+1] = ToWP
-
-        AttackTasks[#AttackTasks+1] = DefenderGroup:TaskFunction( "AI_AIR_ENGAGE.___EngageRoute", self, AttackSetUnit )
-        EngageRoute[#EngageRoute].task = DefenderGroup:TaskCombo( AttackTasks )
-        
-        DefenderGroup:OptionROEReturnFire()
-        DefenderGroup:OptionROTEvadeFire()
-        
-        DefenderGroup:Route( EngageRoute, self.TaskDelay 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", POINT_VEC3.RoutePointType.TurningPoint, POINT_VEC3.RoutePointAction.TurningPoint, EngageSpeed, true)
-      EngageRoute[#EngageRoute+1] = FromWP
-
-      self:SetTargetDistance( TargetCoord ) -- For RTB status check
-
-      local FromEngageAngle = DefenderCoord:GetAngleDegrees( DefenderCoord:GetDirectionVec3( TargetCoord ) )
-      local ToCoord=DefenderCoord:Translate( EngageDistance, FromEngageAngle, true )
-      
-      local ToWP = ToCoord:WaypointAir(self.EngageAltType or "RADIO", POINT_VEC3.RoutePointType.TurningPoint, POINT_VEC3.RoutePointAction.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", POINT_VEC3.RoutePointType.TurningPoint, POINT_VEC3.RoutePointAction.TurningPoint, ToTargetSpeed, true)
-    PatrolRoute[#PatrolRoute+1] = FromWP
-
-    if self.racetrack then
-
-      -- Random heading.
-      local heading = math.random(self.racetrackheadingmin, self.racetrackheadingmax)
-
-      -- Random leg length.
-      local leg=math.random(self.racetracklegmin, self.racetracklegmax)
-
-      -- Random duration if any.
-      local duration = self.racetrackdurationmin
-      if self.racetrackdurationmax then
-        duration=math.random(self.racetrackdurationmin, self.racetrackdurationmax)
-      end
-
-      -- CAP coordinate.
-      local c0=self.PatrolZone:GetRandomCoordinate()
-      if self.racetrackcapcoordinates and #self.racetrackcapcoordinates>0 then
-        c0=self.racetrackcapcoordinates[math.random(#self.racetrackcapcoordinates)]
-      end
-
-      -- Race track points.
-      local c1=c0:SetAltitude(altitude) --Core.Point#COORDINATE
-      local c2=c1:Translate(leg, heading):SetAltitude(altitude)
-
-      self:SetTargetDistance(c0) -- For RTB status check
-
-      -- Debug:
-      self:T(string.format("Patrol zone race track: v=%.1f knots, h=%.1f ft, heading=%03d, leg=%d m, t=%s sec", UTILS.KmphToKnots(speedkmh), UTILS.MetersToFeet(altitude), heading, leg, tostring(duration)))
-      --c1:MarkToAll("Race track c1")
-      --c2:MarkToAll("Race track c2")
-
-      -- Task to orbit.              
-      local taskOrbit=AIPatrol:TaskOrbit(c1, altitude, UTILS.KmphToMps(speedkmh), c2)
-
-      -- Task function to redo the patrol at other random position.
-      local taskPatrol=AIPatrol:TaskFunction("AI_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, POINT_VEC3.RoutePointType.TurningPoint, POINT_VEC3.RoutePointAction.TurningPoint, ToTargetSpeed, true)  
-      PatrolRoute[#PatrolRoute+1] = ToWP
-
-      local Tasks = {}
-      Tasks[#Tasks+1] = AIPatrol:TaskFunction("AI_AIR_PATROL.___PatrolRoute", self)
-      PatrolRoute[#PatrolRoute].task = AIPatrol:TaskCombo( Tasks )
-
-    end
-
-    AIPatrol:OptionROEReturnFire()
-    AIPatrol:OptionROTEvadeFire()
-
-    AIPatrol:Route( PatrolRoute, self.TaskDelay )
-
-  end
-
-end
-
---- 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,652 +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 = POINT_VEC3:New( CurrentVec2.x, CurrentAltitude, CurrentVec2.y )
-    local ToEngageZoneSpeed = self.PatrolMaxSpeed
-    local CurrentRoutePoint = CurrentPointVec3:WaypointAir( 
-        self.PatrolAltType, 
-        POINT_VEC3.RoutePointType.TurningPoint, 
-        POINT_VEC3.RoutePointAction.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 = POINT_VEC3:New( ToTargetVec2.x, self.EngageAltitude, ToTargetVec2.y )
-    
-    --- Create a route point of type air.
-    local ToTargetRoutePoint = ToTargetPointVec3:WaypointAir( 
-      self.PatrolAltType, 
-      POINT_VEC3.RoutePointType.TurningPoint, 
-      POINT_VEC3.RoutePointAction.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,314 +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.
-      --TODO: i need to rework the POINT_VEC2 thing.
-      local PointVec2 = POINT_VEC2:New( AIGroup:GetVec2().x, AIGroup:GetVec2().y  )
-      local ClosestAirbase = self.ReturnAirbaseSet:FindNearestAirbaseFromPointVec2( PointVec2 )
-      self:T( ClosestAirbase.AirbaseName )
-      --[[
-      AIGroup:MessageToRed( "Returning to " .. ClosestAirbase:GetName().. " ...", 30 )
-      local RTBRoute = AIGroup:RouteReturnToAirbase( ClosestAirbase )
-      AIGroupTemplate.route = RTBRoute
-      AIGroup:Respawn( AIGroupTemplate )
-      ]]
-      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 = POINT_VEC3:New( CurrentVec2.x, CurrentAltitude, CurrentVec2.y )
-    local ToEngageZoneSpeed = self.PatrolMaxSpeed
-    local CurrentRoutePoint = CurrentPointVec3:WaypointAir(
-        self.PatrolAltType,
-        POINT_VEC3.RoutePointType.TurningPoint,
-        POINT_VEC3.RoutePointAction.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 = POINT_VEC3:New( ToTargetVec2.x, ToTargetAltitude, ToTargetVec2.y )
-
-    --- Create a route point of type air.
-    local ToPatrolRoutePoint = ToTargetPointVec3:WaypointAir(
-      self.PatrolAltType,
-      POINT_VEC3.RoutePointType.TurningPoint,
-      POINT_VEC3.RoutePointAction.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,570 +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 = POINT_VEC3:New( CurrentVec2.x, CurrentAltitude, CurrentVec2.y )
-    local ToEngageZoneSpeed = self.PatrolMaxSpeed
-    local CurrentRoutePoint = CurrentPointVec3:WaypointAir( 
-        self.PatrolAltType, 
-        POINT_VEC3.RoutePointType.TurningPoint, 
-        POINT_VEC3.RoutePointAction.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 = POINT_VEC3:New( ToTargetVec2.x, self.EngageAltitude, ToTargetVec2.y )
-    
-    --- Create a route point of type air.
-    local ToTargetRoutePoint = ToTargetPointVec3:WaypointAir( 
-      self.PatrolAltType, 
-      POINT_VEC3.RoutePointType.TurningPoint, 
-      POINT_VEC3.RoutePointAction.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(POINT_VEC3.RoutePointAltType.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", 
---            POINT_VEC3.RoutePointType.TurningPoint, 
---            POINT_VEC3.RoutePointAction.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", 
-          POINT_VEC3.RoutePointType.TurningPoint, 
-          POINT_VEC3.RoutePointAction.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", POINT_VEC3.RoutePointType.TurningPoint, POINT_VEC3.RoutePointAction.TurningPoint, 50, true)
-    Route[#Route+1] = WaypointTo
-    
-    local Tasks = {}
-    Tasks[#Tasks+1] = Helicopter:TaskOrbitCircle( math.random( 30, 80 ), 150, CoordinateTo:GetRandomCoordinateInRadius( 800, 500 ) )
-    Route[#Route].task = Helicopter:TaskCombo( Tasks )
-
-    Route[#Route+1] = WaypointTo
-
-    -- Now route the helicopter
-    Helicopter:Route(Route, 0)
-  end
-end
-
-
-
---- 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", POINT_VEC3.RoutePointType.TurningPoint, POINT_VEC3.RoutePointAction.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", POINT_VEC3.RoutePointType.TurningPoint, POINT_VEC3.RoutePointAction.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", POINT_VEC3.RoutePointType.TurningPoint, POINT_VEC3.RoutePointAction.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", POINT_VEC3.RoutePointType.TurningPoint, POINT_VEC3.RoutePointAction.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", POINT_VEC3.RoutePointType.TurningPoint, POINT_VEC3.RoutePointAction.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", POINT_VEC3.RoutePointType.TurningPoint, POINT_VEC3.RoutePointAction.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,939 +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 = POINT_VEC3:New( CurrentVec2.x, CurrentAltitude, CurrentVec2.y )
-      local ToPatrolZoneSpeed = self.PatrolMaxSpeed
-      local CurrentRoutePoint = CurrentPointVec3:WaypointAir( 
-          self.PatrolAltType, 
-          POINT_VEC3.RoutePointType.TakeOffParking, 
-          POINT_VEC3.RoutePointAction.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 = POINT_VEC3:New( CurrentVec2.x, CurrentAltitude, CurrentVec2.y )
-      local ToPatrolZoneSpeed = self.PatrolMaxSpeed
-      local CurrentRoutePoint = CurrentPointVec3:WaypointAir( 
-          self.PatrolAltType, 
-          POINT_VEC3.RoutePointType.TurningPoint, 
-          POINT_VEC3.RoutePointAction.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 = POINT_VEC3:New( ToTargetVec2.x, ToTargetAltitude, ToTargetVec2.y )
-    
-    --- Create a route point of type air.
-    local ToTargetRoutePoint = ToTargetPointVec3:WaypointAir( 
-      self.PatrolAltType, 
-      POINT_VEC3.RoutePointType.TurningPoint, 
-      POINT_VEC3.RoutePointAction.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
-    else
-    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 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 = POINT_VEC3:New( CurrentVec2.x, CurrentAltitude, CurrentVec2.y )
-    local ToPatrolZoneSpeed = self.PatrolMaxSpeed
-    local CurrentRoutePoint = CurrentPointVec3:WaypointAir( 
-        self.PatrolAltType, 
-        POINT_VEC3.RoutePointType.TurningPoint, 
-        POINT_VEC3.RoutePointAction.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/Cargo.lua

@@ -2,6 +2,8 @@
 --
 -- ===
 -- 
+-- ![Banner Image](..\Images\deprecated.png)
+-- 
 -- # 1) MOOSE Cargo System.
 -- 
 -- #### Those who have used the mission editor, know that the DCS mission editor provides cargo facilities.
@@ -275,14 +277,14 @@
 -- The cargo must be in the **Loaded** state.
 -- @function [parent=#CARGO] UnBoard
 -- @param #CARGO self
--- @param Core.Point#POINT_VEC2 ToPointVec2 (optional) @{Core.Point#POINT_VEC2) to where the cargo should run after onboarding. If not provided, the cargo will run to 60 meters behind the Carrier location.
+-- @param Core.Point#COORDINATE ToPointVec2 (optional) @{Core.Point#COORDINATE) to where the cargo should run after onboarding. If not provided, the cargo will run to 60 meters behind the Carrier location.
 
 --- UnBoards the cargo to a Carrier. The event will create a movement (= running or driving) of the cargo from the Carrier.
 -- The cargo must be in the **Loaded** state.
 -- @function [parent=#CARGO] __UnBoard
 -- @param #CARGO self
 -- @param #number DelaySeconds The amount of seconds to delay the action.
--- @param Core.Point#POINT_VEC2 ToPointVec2 (optional) @{Core.Point#POINT_VEC2) to where the cargo should run after onboarding. If not provided, the cargo will run to 60 meters behind the Carrier location.
+-- @param Core.Point#COORDINATE ToPointVec2 (optional) @{Core.Point#COORDINATE) to where the cargo should run after onboarding. If not provided, the cargo will run to 60 meters behind the Carrier location.
 
 
 -- Load
@@ -307,14 +309,14 @@
 -- The cargo must be in the **Loaded** state.
 -- @function [parent=#CARGO] UnLoad
 -- @param #CARGO self
--- @param Core.Point#POINT_VEC2 ToPointVec2 (optional) @{Core.Point#POINT_VEC2) to where the cargo will be placed after unloading. If not provided, the cargo will be placed 60 meters behind the Carrier location.
+-- @param Core.Point#COORDINATE ToPointVec2 (optional) @{Core.Point#COORDINATE) to where the cargo will be placed after unloading. If not provided, the cargo will be placed 60 meters behind the Carrier location.
 
 --- UnLoads the cargo to a Carrier. The event will unload the cargo from the Carrier. There will be no movement simulated of the cargo loading.
 -- The cargo must be in the **Loaded** state.
 -- @function [parent=#CARGO] __UnLoad
 -- @param #CARGO self
 -- @param #number DelaySeconds The amount of seconds to delay the action.
--- @param Core.Point#POINT_VEC2 ToPointVec2 (optional) @{Core.Point#POINT_VEC2) to where the cargo will be placed after unloading. If not provided, the cargo will be placed 60 meters behind the Carrier location.
+-- @param Core.Point#COORDINATE ToPointVec2 (optional) @{Core.Point#COORDINATE) to where the cargo will be placed after unloading. If not provided, the cargo will be placed 60 meters behind the Carrier location.
 
 -- State Transition Functions
 
@@ -370,7 +372,7 @@ CARGOS = {}
 
 do -- CARGO
 
-  -- @type CARGO
+  --- @type CARGO
   -- @extends Core.Fsm#FSM_PROCESS
   -- @field #string Type A string defining the type of the cargo. eg. Engineers, Equipment, Screwdrivers.
   -- @field #string Name A string defining the name of the cargo. The name is the unique identifier of the cargo.
@@ -467,7 +469,7 @@ do -- CARGO
     self.Type = Type
     self.Name = Name
     self.Weight = Weight or 0
-    self.CargoObject = nil
+    self.CargoObject = nil -- Wrapper.Group#GROUP
     self.CargoCarrier = nil -- Wrapper.Client#CLIENT
     self.Representable = false
     self.Slingloadable = false
@@ -897,7 +899,7 @@ do -- CARGO
 
   --- Get the current PointVec2 of the cargo.
   -- @param #CARGO self
-  -- @return Core.Point#POINT_VEC2
+  -- @return Core.Point#COORDINATE
   function CARGO:GetPointVec2()
     return self.CargoObject:GetPointVec2()
   end
@@ -1094,7 +1096,7 @@ do -- CARGO_REPRESENTABLE
 
   --- Route a cargo unit to a PointVec2.
   -- @param #CARGO_REPRESENTABLE self
-  -- @param Core.Point#POINT_VEC2 ToPointVec2
+  -- @param Core.Point#COORDINATE ToPointVec2
   -- @param #number Speed
   -- @return #CARGO_REPRESENTABLE
   function CARGO_REPRESENTABLE:RouteTo( ToPointVec2, Speed )

Moose Development/Moose/Cargo/CargoCrate.lua

@@ -22,6 +22,9 @@ do -- CARGO_CRATE
   -- @type CARGO_CRATE
   -- @extends Cargo.Cargo#CARGO_REPRESENTABLE
   
+  ---
+  -- ![Banner Image](..\Images\deprecated.png)
+  --
   --- 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.
   -- 
@@ -114,7 +117,7 @@ do -- CARGO_CRATE
   -- @param #string Event
   -- @param #string From
   -- @param #string To
-  -- @param Core.Point#POINT_VEC2
+  -- @param Core.Point#COORDINATE
   function CARGO_CRATE:onenterUnLoaded( From, Event, To, ToPointVec2 )
     --self:T( { ToPointVec2, From, Event, To } )
   

Moose Development/Moose/Cargo/CargoGroup.lua

@@ -22,9 +22,12 @@ 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.
+  -- 
+  -- ![Banner Image](..\Images\deprecated.png)
   -- 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:
@@ -410,7 +413,7 @@ do -- CARGO_GROUP
   -- @param #string Event
   -- @param #string From
   -- @param #string To
-  -- @param Core.Point#POINT_VEC2 ToPointVec2
+  -- @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 } )
@@ -453,7 +456,7 @@ do -- CARGO_GROUP
   -- @param #string Event
   -- @param #string From
   -- @param #string To
-  -- @param Core.Point#POINT_VEC2 ToPointVec2
+  -- @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 } )
@@ -491,7 +494,7 @@ do -- CARGO_GROUP
   -- @param #string Event
   -- @param #string From
   -- @param #string To
-  -- @param Core.Point#POINT_VEC2 ToPointVec2
+  -- @param Core.Point#COORDINATE ToPointVec2
   function CARGO_GROUP:onafterUnLoad( From, Event, To, ToPointVec2, ... )
     --self:T( { From, Event, To, ToPointVec2 } )
   
@@ -771,3 +774,4 @@ do -- CARGO_GROUP
     
 
 end -- CARGO_GROUP
+

Moose Development/Moose/Cargo/CargoSlingload.lua

@@ -32,6 +32,8 @@ do -- CARGO_SLINGLOAD
   --
   -- # 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/Cargo/CargoUnit.lua

@@ -30,6 +30,8 @@ do -- CARGO_UNIT
   --
   -- # 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
   --
@@ -72,7 +74,7 @@ do -- CARGO_UNIT
   -- @param #string Event
   -- @param #string From
   -- @param #string To
-  -- @param Core.Point#POINT_VEC2 ToPointVec2
+  -- @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 } )
@@ -145,7 +147,7 @@ do -- CARGO_UNIT
   -- @param #string Event
   -- @param #string From
   -- @param #string To
-  -- @param Core.Point#POINT_VEC2 ToPointVec2
+  -- @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 } )
@@ -171,7 +173,7 @@ do -- CARGO_UNIT
   -- @param #string Event
   -- @param #string From
   -- @param #string To
-  -- @param Core.Point#POINT_VEC2 ToPointVec2
+  -- @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 } )
@@ -197,7 +199,7 @@ do -- CARGO_UNIT
   -- @param #string Event
   -- @param #string From
   -- @param #string To
-  -- @param Core.Point#POINT_VEC2
+  -- @param Core.Point#COORDINATE
   function CARGO_UNIT:onenterUnLoaded( From, Event, To, ToPointVec2 )
     self:T( { ToPointVec2, From, Event, To } )
   

Moose Development/Moose/Core/Base.lua

@@ -34,11 +34,12 @@ local _TraceClassMethod = {}
 
 local _ClassID = 0
 
----
+--- Base class of everything
 -- @type BASE
--- @field ClassName The name of the class.
--- @field ClassID The ID number of the class.
--- @field ClassNameAndID The name of the class concatenated with the ID number of the class.
+-- @field #string ClassName The name of the class.
+-- @field #number ClassID The ID number of the class.
+-- @field #string ClassNameAndID The name of the class concatenated with the ID number of the class.
+-- @field Core.Scheduler#SCHEDULER Scheduler The scheduler object.
 
 --- BASE class
 --
@@ -200,6 +201,7 @@ BASE = {
   States = {},
   Debug = debug,
   Scheduler = nil,
+  Properties = {},
 }
 
 -- @field #BASE.__
@@ -210,14 +212,6 @@ BASE._ = {
   Schedules = {}, --- Contains the Schedulers Active
 }
 
---- The Formation Class
--- @type FORMATION
--- @field Cone A cone formation.
-FORMATION = {
-  Cone = "Cone",
-  Vee = "Vee",
-}
-
 --- BASE constructor.
 --
 -- This is an example how to use the BASE:New() constructor in a new class definition when inheriting from BASE.
@@ -980,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, ... )
   
@@ -1116,6 +1110,31 @@ function BASE:ClearState( Object, StateName )
   end
 end
 
+--- Set one property of an object.
+-- @param #BASE self
+-- @param Key The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!
+-- @param Value The value that is stored. Note that the value can be a #string, but it can also be any other type!
+function BASE:SetProperty(Key,Value)
+  self.Properties = self.Properties or {}
+  self.Properties[Key] = Value
+end
+            
+--- Get one property of an object by the key.
+-- @param #BASE self
+-- @param Key The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!
+-- @return Value The value that is stored. Note that the value can be a #string, but it can also be any other type! Nil if not found.         
+function BASE:GetProperty(Key)
+  self.Properties = self.Properties or {}
+  return self.Properties[Key]
+end
+
+--- Get all of the properties of an object in a table.
+-- @param #BASE self
+-- @return #table of values, indexed by keys.
+function BASE:GetProperties()
+  return self.Properties
+end
+            
 -- Trace section
 
 -- Log a trace (only shown when trace is on)
@@ -1416,7 +1435,7 @@ function BASE:E( Arguments )
 
     env.info( string.format( "%6d(%6d)/%1s:%30s%05d.%s(%s)", LineCurrent, LineFrom, "E", self.ClassName, self.ClassID, Function, UTILS.BasicSerialize( Arguments ) ) )
   else
-    env.info( string.format( "%1s:%30s%05d(%s)", "E", self.ClassName, self.ClassID, BASE:_Serialize(Arguments) ) )
+    env.info( string.format( "%1s:%30s%05d(%s)", "E", self.ClassName, self.ClassID, UTILS.BasicSerialize(Arguments) ) )
   end
 
 end
@@ -1443,8 +1462,7 @@ function BASE:I( Arguments )
 
     env.info( string.format( "%6d(%6d)/%1s:%30s%05d.%s(%s)", LineCurrent, LineFrom, "I", self.ClassName, self.ClassID, Function, UTILS.BasicSerialize( Arguments ) ) )
   else
-    env.info( string.format( "%1s:%30s%05d(%s)", "I", self.ClassName, self.ClassID, BASE:_Serialize(Arguments)) )
+    env.info( string.format( "%1s:%30s%05d(%s)", "I", self.ClassName, self.ClassID, UTILS.BasicSerialize(Arguments)) )
   end
 
 end
-

Moose Development/Moose/Core/ClientMenu.lua

@@ -20,7 +20,7 @@
 -- 
 -- @module Core.ClientMenu
 -- @image Core_Menu.JPG
--- last change: May 2024
+-- last change: Sept 2025
 
 -- TODO
 ----------------------------------------------------------------------------------------------------------------
@@ -57,9 +57,9 @@
 ---
 -- @field #CLIENTMENU
 CLIENTMENU = {
-  ClassName = "CLIENTMENUE",
+  ClassName = "CLIENTMENU",
   lid = "",
-  version = "0.1.2",
+  version = "0.1.3",
   name = nil,
   path = nil,
   group = nil,
@@ -417,7 +417,7 @@ end
 CLIENTMENUMANAGER = {
   ClassName = "CLIENTMENUMANAGER",
   lid = "",
-  version = "0.1.6",
+  version = "0.1.7",
   name = nil,
   clientset = nil,
   menutree = {},
@@ -455,7 +455,7 @@ end
 -- @param #CLIENTMENUMANAGER self
 -- @param Core.Event#EVENTDATA EventData
 -- @return #CLIENTMENUMANAGER self
-function CLIENTMENUMANAGER:_EventHandler(EventData)
+function CLIENTMENUMANAGER:_EventHandler(EventData,Retry)
   self:T(self.lid.."_EventHandler: "..EventData.id)
   --self:I(self.lid.."_EventHandler: "..tostring(EventData.IniPlayerName))
   if EventData.id == EVENTS.PlayerLeaveUnit or EventData.id == EVENTS.Ejection or EventData.id == EVENTS.Crash or EventData.id == EVENTS.PilotDead then
@@ -468,6 +468,10 @@ function CLIENTMENUMANAGER:_EventHandler(EventData)
     if EventData.IniPlayerName and EventData.IniGroup then
       if (not self.clientset:IsIncludeObject(_DATABASE:FindClient( EventData.IniUnitName ))) then
         self:T(self.lid.."Client not in SET: "..EventData.IniPlayerName)
+        if not Retry then
+          -- try again in 2 secs
+          self:ScheduleOnce(2,CLIENTMENUMANAGER._EventHandler,self,EventData,true)
+        end
         return self
       end
       --self:I(self.lid.."Join event for player: "..EventData.IniPlayerName)
@@ -524,7 +528,7 @@ function CLIENTMENUMANAGER:InitAutoPropagation()
   self:HandleEvent(EVENTS.PilotDead, self._EventHandler)
   self:HandleEvent(EVENTS.PlayerEnterAircraft, self._EventHandler)
   self:HandleEvent(EVENTS.PlayerEnterUnit, self._EventHandler)
-  self:SetEventPriority(5) 
+  self:SetEventPriority(6) 
   return self 
 end
 
@@ -802,6 +806,16 @@ function CLIENTMENUMANAGER:ResetMenuComplete()
   return self
 end
 
+--- Remove the entry and all entries below the given entry from the client's F10 menus.
+-- @param #CLIENTMENUMANAGER self
+-- @param #CLIENTMENU Entry The entry to remove
+-- @param Wrapper.Client#CLIENT Client (optional) If given, make this change only for this client. 
+-- @return #CLIENTMENUMANAGER self
+function CLIENTMENUMANAGER:DeleteEntry(Entry,Client)
+  self:T(self.lid.."DeleteEntry")
+  return self:DeleteF10Entry(Entry,Client)
+end
+
 --- Remove the entry and all entries below the given entry from the client's F10 menus.
 -- @param #CLIENTMENUMANAGER self
 -- @param #CLIENTMENU Entry The entry to remove

Moose Development/Moose/Core/Database.lua

@@ -211,10 +211,9 @@ function DATABASE:AddStatic( DCSStaticName )
 
   if not self.STATICS[DCSStaticName] then
     self.STATICS[DCSStaticName] = STATIC:Register( DCSStaticName )
-    return self.STATICS[DCSStaticName]
   end
 
-  return nil
+  return self.STATICS[DCSStaticName]
 end
 
 
@@ -224,12 +223,11 @@ function DATABASE:DeleteStatic( DCSStaticName )
   self.STATICS[DCSStaticName] = nil
 end
 
---- Finds a STATIC based on the StaticName.
+--- Finds a STATIC based on the Static Name.
 -- @param #DATABASE self
--- @param #string StaticName
+-- @param #string StaticName Name of the static object.
 -- @return Wrapper.Static#STATIC The found STATIC.
 function DATABASE:FindStatic( StaticName )
-
   local StaticFound = self.STATICS[StaticName]
   return StaticFound
 end
@@ -241,9 +239,8 @@ end
 function DATABASE:AddDynamicCargo( Name )
   if not self.DYNAMICCARGO[Name] then
     self.DYNAMICCARGO[Name] = DYNAMICCARGO:Register(Name)
-    return self.DYNAMICCARGO[Name]
   end
-  return nil
+  return self.DYNAMICCARGO[Name]
 end
 
 --- Finds a DYNAMICCARGO based on the Dynamic Cargo Name.
@@ -580,13 +577,19 @@ do -- Zones and Pathlines
             -- For a rectangular polygon drawing, we have the width (y) and height (x).
             local w=objectData.width
             local h=objectData.height
+            local rotation = UTILS.ToRadian(objectData.angle or 0)
 
-            -- Create points from center using with and height (width for y and height for x is a bit confusing, but this is how ED implemented it).
-            local points={}
-            points[1]={x=vec2.x-h/2, y=vec2.y+w/2} --Upper left
-            points[2]={x=vec2.x+h/2, y=vec2.y+w/2} --Upper right
-            points[3]={x=vec2.x+h/2, y=vec2.y-w/2} --Lower right
-            points[4]={x=vec2.x-h/2, y=vec2.y-w/2} --Lower left
+            local sinRot = math.sin(rotation)
+            local cosRot = math.cos(rotation)
+            local dx = h / 2
+            local dy = w / 2
+
+            local points = {
+                { x = -dx * cosRot - (-dy * sinRot) + vec2.x, y = -dx * sinRot + (-dy * cosRot) + vec2.y },
+                { x = dx * cosRot - (-dy * sinRot) + vec2.x, y = dx * sinRot + (-dy * cosRot) + vec2.y },
+                { x = dx * cosRot - (dy * sinRot) + vec2.x, y = dx * sinRot + (dy * cosRot) + vec2.y },
+                { x = -dx * cosRot - (dy * sinRot) + vec2.x, y = -dx * sinRot + (dy * cosRot) + vec2.y },
+            }
 
             --local coord=COORDINATE:NewFromVec2(vec2):MarkToAll("MapX, MapY")
 
@@ -875,6 +878,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
@@ -1113,7 +1118,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
@@ -1122,7 +1127,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
@@ -1383,7 +1388,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
 
@@ -1395,7 +1400,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
 
@@ -1407,7 +1412,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
 
@@ -1582,12 +1587,29 @@ end
 -- @param DCS#Airbase airbase Airbase.
 -- @return #DATABASE self
 function DATABASE:_RegisterAirbase(airbase)
-
+  
+  local IsSyria = UTILS.GetDCSMap() == "Syria" and true or false
+  local countHSyria = 0
+  
   if airbase then
 
     -- Get the airbase name.
     local DCSAirbaseName = airbase:getName()
-
+    
+    -- DCS 2.9.8.1107 added 143 helipads all named H with the same object ID ..
+    if IsSyria and DCSAirbaseName == "H" and countHSyria > 0 then
+      --[[
+      local p = airbase:getPosition().p
+      local mgrs = COORDINATE:New(p.x,p.z,p.y):ToStringMGRS()
+      self:I("Airbase on Syria map named H @ "..mgrs)
+      countHSyria = countHSyria + 1
+      if countHSyria > 1 then return self end
+      --]]
+      return self
+    elseif IsSyria and DCSAirbaseName == "H" and countHSyria == 0 then
+      countHSyria = countHSyria + 1
+    end
+    
     -- This gave the incorrect value to be inserted into the airdromeID for DCS 2.5.6. Is fixed now.
     local airbaseID=airbase:getID()
 
@@ -1683,7 +1705,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
@@ -1798,7 +1820,7 @@ function DATABASE:_EventOnPlayerEnterUnit( Event )
 
   if Event.IniDCSUnit then
     -- Player entering a CA slot
-    if Event.IniObjectCategory == 1 and Event.IniGroup and Event.IniGroup:IsGround() then
+    if Event.IniObjectCategory == 1 and Event.IniUnit and Event.IniUnit:IsGround() then
         
       local IsPlayer = Event.IniDCSUnit:getPlayerName()
       if IsPlayer then

Moose Development/Moose/Core/Event.lua

@@ -184,6 +184,7 @@ EVENT = {
   ClassName = "EVENT",
   ClassID = 0,
   MissionEnd = false,
+  CreateMarkCoordinateOnEvent = false,
 }
 
 world.event.S_EVENT_NEW_CARGO = world.event.S_EVENT_MAX + 1000
@@ -339,14 +340,18 @@ EVENTS = {
 -- @field #string WeaponName Name of the weapon.
 -- @field DCS#Unit WeaponTgtDCSUnit Target DCS unit of the weapon.
 --
--- @field Cargo.Cargo#CARGO Cargo The cargo object.
--- @field #string CargoName The name of the cargo object.
---
 -- @field Core.Zone#ZONE Zone The zone object.
 -- @field #string ZoneName The name of the zone.
 -- 
 -- @field Wrapper.DynamicCargo#DYNAMICCARGO IniDynamicCargo The dynamic cargo object.
 -- @field #string IniDynamicCargoName The dynamic cargo unit name.
+-- 
+-- @field #number MarkCoalition Coalition of a marker (if any)
+-- @field DCS#Vec3 MarkVec3 Position of a marker
+-- @field #string MarkText Text content of a marker, if any
+-- @field #number MarkID ID of the marker, for deletion
+-- @field #number MarkGroupID Group ID of the group that created the marker
+-- @field Core.Point#COORDINATE Coordinate object of the marker, only filled if EVENT.CreateMarkCoordinateOnEvent is set to true (off by default)
 
 
 
@@ -1063,36 +1068,6 @@ end
 
 do -- Event Creation
 
-  --- Creation of a New Cargo Event.
-  -- @param #EVENT self
-  -- @param AI.AI_Cargo#AI_CARGO Cargo The Cargo created.
-  function EVENT:CreateEventNewCargo( Cargo )
-    self:F( { Cargo } )
-
-    local Event = {
-      id = EVENTS.NewCargo,
-      time = timer.getTime(),
-      cargo = Cargo,
-      }
-
-    world.onEvent( Event )
-  end
-
-  --- Creation of a Cargo Deletion Event.
-  -- @param #EVENT self
-  -- @param AI.AI_Cargo#AI_CARGO Cargo The Cargo created.
-  function EVENT:CreateEventDeleteCargo( Cargo )
-    self:F( { Cargo } )
-
-    local Event = {
-      id = EVENTS.DeleteCargo,
-      time = timer.getTime(),
-      cargo = Cargo,
-      }
-
-    world.onEvent( Event )
-  end
-
   --- Creation of a New Zone Event.
   -- @param #EVENT self
   -- @param Core.Zone#ZONE_BASE Zone The Zone created.
@@ -1329,6 +1304,7 @@ function EVENT:onEvent( Event )
           end
           
           Event.IniDCSGroupName = Event.IniUnit and Event.IniUnit.GroupName or ""
+          Event.IniGroupName=Event.IniDCSGroupName --At least set the group name because group might not exist any more
           if Event.IniDCSGroup and Event.IniDCSGroup:isExist() then
             Event.IniDCSGroupName = Event.IniDCSGroup:getName()
             Event.IniGroup = GROUP:FindByName( Event.IniDCSGroupName )
@@ -1360,7 +1336,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
@@ -1371,11 +1348,14 @@ function EVENT:onEvent( Event )
           -- Scenery
           ---          
           Event.IniDCSUnit = Event.initiator
-          Event.IniDCSUnitName = Event.IniDCSUnit:getName()
+          Event.IniDCSUnitName = ( Event.IniDCSUnit and Event.IniDCSUnit.getName ) and Event.IniDCSUnit:getName() or "Scenery no name "..math.random(1,20000)
           Event.IniUnitName = Event.IniDCSUnitName
-          Event.IniUnit = SCENERY:Register( Event.IniDCSUnitName, Event.initiator )
-          Event.IniCategory = Event.IniDCSUnit:getDesc().category
-          Event.IniTypeName = Event.initiator:isExist() and Event.IniDCSUnit:getTypeName() or "SCENERY"
+          local ID = (Event.IniDCSUnit and Event.IniDCSUnit.getID) and Event.IniDCSUnit:getID() or Event.IniDCSUnitName
+          Event.IniUnit = (_SCENERY ~= nil) and _SCENERY[ID] or nil
+          --Event.IniUnit = SCENERY:Register( Event.IniDCSUnitName, Event.initiator )
+          Event.IniCategory =  (Event.IniDCSUnit and Event.IniDCSUnit.getDesc ) and Event.IniDCSUnit:getDesc().category
+          Event.IniTypeName = (Event.initiator and Event.initiator.isExist          
+          and Event.initiator:isExist() and Event.IniDCSUnit and Event.IniDCSUnit.getTypeName) and Event.IniDCSUnit:getTypeName() or "SCENERY"
 
         elseif Event.IniObjectCategory == Object.Category.BASE then
           ---
@@ -1473,11 +1453,15 @@ function EVENT:onEvent( Event )
           -- SCENERY
           ---
           Event.TgtDCSUnit = Event.target
-          Event.TgtDCSUnitName = Event.TgtDCSUnit:getName()
-          Event.TgtUnitName = Event.TgtDCSUnitName
-          Event.TgtUnit = SCENERY:Register( Event.TgtDCSUnitName, Event.target )
-          Event.TgtCategory = Event.TgtDCSUnit:getDesc().category
-          Event.TgtTypeName = Event.TgtDCSUnit:getTypeName()
+          Event.TgtDCSUnitName = Event.TgtDCSUnit.getName and Event.TgtDCSUnit:getName() or nil
+          if Event.TgtDCSUnitName~=nil then
+            Event.TgtUnitName = Event.TgtDCSUnitName
+            local ID = (Event.TgtDCSUnit and Event.TgtDCSUnit.getID) and Event.TgtDCSUnit:getID() or Event.TgtDCSUnitName
+            --Event.TgtUnit = SCENERY:Register( Event.TgtDCSUnitName, Event.target )
+            Event.TgtUnit = (_SCENERY ~= nil) and _SCENERY[ID] or nil
+            Event.TgtCategory = Event.TgtDCSUnit:getDesc().category
+            Event.TgtTypeName = Event.TgtDCSUnit:getTypeName()
+          end
         end
       end
 
@@ -1504,7 +1488,9 @@ function EVENT:onEvent( Event )
         else  
           if Event.place:isExist() and Object.getCategory(Event.place) ~= Object.Category.SCENERY then
             Event.Place=AIRBASE:Find(Event.place)
-            Event.PlaceName=Event.Place:GetName()
+            if Event.Place then
+              Event.PlaceName=Event.Place:GetName()
+            end
           end
         end
       end
@@ -1513,7 +1499,9 @@ function EVENT:onEvent( Event )
       if Event.idx then
         Event.MarkID=Event.idx
         Event.MarkVec3=Event.pos
-        Event.MarkCoordinate=COORDINATE:NewFromVec3(Event.pos)
+        if self.CreateMarkCoordinateOnEvent == true then
+          Event.MarkCoordinate=COORDINATE:NewFromVec3(Event.pos)
+        end
         Event.MarkText=Event.text
         Event.MarkCoalition=Event.coalition
         Event.IniCoalition=Event.coalition

Moose Development/Moose/Core/Fsm.lua

@@ -79,6 +79,7 @@
 
 do -- FSM
 
+  --- FSM class
   -- @type FSM
   -- @field #string ClassName Name of the class.
   -- @field Core.Scheduler#SCHEDULER CallScheduler Call scheduler.
@@ -948,7 +949,8 @@ do -- FSM
 end
 
 do -- FSM_CONTROLLABLE
-
+  
+  ---
   -- @type FSM_CONTROLLABLE
   -- @field Wrapper.Controllable#CONTROLLABLE Controllable
   -- @extends Core.Fsm#FSM
@@ -1081,7 +1083,8 @@ do -- FSM_CONTROLLABLE
 end
 
 do -- FSM_PROCESS
-
+  
+  ---
   -- @type FSM_PROCESS
   -- @field Tasking.Task#TASK Task
   -- @extends Core.Fsm#FSM_CONTROLLABLE

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.5",
   debug = false,
   Casesensitive = true,
 }
@@ -59,9 +59,8 @@ MARKEROPS_BASE = {
 -- @param #MARKEROPS_BASE self
 -- @param #string Tagname Name to identify us from the event text.
 -- @param #table Keywords Table of keywords  recognized from the event text.
--- @param #boolean Casesensitive (Optional) Switch case sensitive identification of Tagname. Defaults to true.
 -- @return #MARKEROPS_BASE self
-function MARKEROPS_BASE:New(Tagname,Keywords,Casesensitive)
+function MARKEROPS_BASE:New(Tagname,Keywords)
    -- Inherit FSM
   local self=BASE:Inherit(self, FSM:New()) -- #MARKEROPS_BASE
   
@@ -72,11 +71,7 @@ function MARKEROPS_BASE:New(Tagname,Keywords,Casesensitive)
   self.Keywords = Keywords or {} -- #table - might want to use lua regex here, too
   self.debug = false
   self.Casesensitive = true
-  
-  if Casesensitive and Casesensitive == false then
-    self.Casesensitive = false
-  end
-  
+
   -----------------------
   --- FSM Transitions ---
   -----------------------
@@ -108,26 +103,30 @@ function MARKEROPS_BASE:New(Tagname,Keywords,Casesensitive)
    --- On after "MarkAdded" event. Triggered when a Marker is added to the F10 map.
    -- @function [parent=#MARKEROPS_BASE] OnAfterMarkAdded
    -- @param #MARKEROPS_BASE self
-   -- @param #string From The From state
-   -- @param #string Event The Event called
-   -- @param #string To The To state
-   -- @param #string Text The text on the marker
-   -- @param #table Keywords Table of matching keywords found in the Event text
+   -- @param #string From The From state.
+   -- @param #string Event The Event called.
+   -- @param #string To The To state.
+   -- @param #string Text The text on the marker.
+   -- @param #table Keywords Table of matching keywords found in the Event text.
    -- @param Core.Point#COORDINATE Coord Coordinate of the marker.
-   -- @param #number MarkerID Id of this marker
-   -- @param #number CoalitionNumber Coalition of the marker creator
+   -- @param #number MarkerID Id of this marker.
+   -- @param #number CoalitionNumber Coalition of the marker creator.
+   -- @param #string PlayerName Name of the player creating/changing the mark. nil if it cannot be obtained. 
+   -- @param Core.Event#EVENTDATA EventData the event data table. 
    
    --- On after "MarkChanged" event. Triggered when a Marker is changed on the F10 map.
    -- @function [parent=#MARKEROPS_BASE] OnAfterMarkChanged
    -- @param #MARKEROPS_BASE self
-   -- @param #string From The From state
-   -- @param #string Event The Event called
-   -- @param #string To The To state
-   -- @param #string Text The text on the marker
-   -- @param #table Keywords Table of matching keywords found in the Event text
+   -- @param #string From The From state.
+   -- @param #string Event The Event called.
+   -- @param #string To The To state.
+   -- @param #string Text The text on the marker.
+   -- @param #table Keywords Table of matching keywords found in the Event text.
    -- @param Core.Point#COORDINATE Coord Coordinate of the marker.
-   -- @param #number MarkerID Id of this marker
-   -- @param #number CoalitionNumber Coalition of the marker creator
+   -- @param #number MarkerID Id of this marker.
+   -- @param #number CoalitionNumber Coalition of the marker creator.
+   -- @param #string PlayerName Name of the player creating/changing the mark. nil if it cannot be obtained. 
+   -- @param Core.Event#EVENTDATA EventData the event data table
 
    --- On after "MarkDeleted" event. Triggered when a Marker is deleted from the F10 map.
    -- @function [parent=#MARKEROPS_BASE] OnAfterMarkDeleted
@@ -141,7 +140,7 @@ function MARKEROPS_BASE:New(Tagname,Keywords,Casesensitive)
 
 end
 
---- (internal) Handle events.
+--- (Internal) Handle events.
 -- @param #MARKEROPS_BASE self
 -- @param Core.Event#EVENTDATA Event
 function MARKEROPS_BASE:OnEventMark(Event)
@@ -150,14 +149,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
@@ -166,8 +158,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)
+          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
@@ -176,8 +174,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)
+           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
@@ -192,15 +196,17 @@ function MARKEROPS_BASE:OnEventMark(Event)
     end
 end
 
---- (internal) Match tag.
+--- (Internal) Match tag.
 -- @param #MARKEROPS_BASE self
 -- @param #string Eventtext Text added to the marker.
 -- @return #boolean
 function MARKEROPS_BASE:_MatchTag(Eventtext)
   local matches = false
-  if not self.Casesensitive then
+  --self:I(self.lid .. "Casesensitive "..tostring(self.Casesensitive))
+  if self.Casesensitive == false then
+    --self:I(self.lid .. "Marker non-casesensitive "..Eventtext)
     local type = string.lower(self.Tag) -- #string
-    if string.find(string.lower(Eventtext),type) then
+    if string.find(string.lower(Eventtext),type,1,true) then
       matches = true --event text contains tag
     end
   else
@@ -212,7 +218,7 @@ function MARKEROPS_BASE:_MatchTag(Eventtext)
   return matches
 end
 
---- (internal) Match keywords table.
+--- (Internal) Match keywords table.
 -- @param #MARKEROPS_BASE self
 -- @param #string Eventtext Text added to the marker.
 -- @return #table
@@ -277,6 +283,22 @@ function MARKEROPS_BASE:onenterStopped(From,Event,To)
   self:UnHandleEvent(EVENTS.MarkRemoved)
 end
 
+--- Switch off case sensitive matching
+ -- @param #MARKEROPS_BASE self
+ -- @return self
+function MARKEROPS_BASE:SwitchCaseSensitiveOff()
+  self.Casesensitive = false
+  return self
+end
+
+--- Switch on case sensitive matching
+ -- @param #MARKEROPS_BASE self
+ -- @return self
+function MARKEROPS_BASE:SwitchCaseSensitiveOn()
+  self.Casesensitive = true
+  return self
+end
+
 --------------------------------------------------------------------------
 -- MARKEROPS_BASE Class Definition End.
 --------------------------------------------------------------------------

Moose Development/Moose/Core/Menu.lua

@@ -105,6 +105,7 @@ function MENU_INDEX:PrepareCoalition( CoalitionSide )
     self.Coalition[CoalitionSide] = self.Coalition[CoalitionSide] or {}
     self.Coalition[CoalitionSide].Menus = self.Coalition[CoalitionSide].Menus or {}
 end
+
 ---
 -- @param Wrapper.Group#GROUP Group
 function MENU_INDEX:PrepareGroup( Group )
@@ -118,9 +119,11 @@ end
 function MENU_INDEX:HasMissionMenu( Path )
   return self.MenuMission.Menus[Path]
 end
+
 function MENU_INDEX:SetMissionMenu( Path, Menu )
   self.MenuMission.Menus[Path] = Menu
 end
+
 function MENU_INDEX:ClearMissionMenu( Path )
   self.MenuMission.Menus[Path] = nil
 end
@@ -128,9 +131,11 @@ end
 function MENU_INDEX:HasCoalitionMenu( Coalition, Path )
   return self.Coalition[Coalition].Menus[Path]
 end
+
 function MENU_INDEX:SetCoalitionMenu( Coalition, Path, Menu )
   self.Coalition[Coalition].Menus[Path] = Menu
 end
+
 function MENU_INDEX:ClearCoalitionMenu( Coalition, Path )
   self.Coalition[Coalition].Menus[Path] = nil
 end
@@ -138,19 +143,24 @@ end
 function MENU_INDEX:HasGroupMenu( Group, Path )
   if Group and Group:IsAlive() then
     local MenuGroupName = Group:GetName()
-    return self.Group[MenuGroupName].Menus[Path]
+    if self.Group[MenuGroupName] and self.Group[MenuGroupName].Menus and self.Group[MenuGroupName].Menus[Path] then
+      return self.Group[MenuGroupName].Menus[Path]
+    end
   end
   return nil
 end
+
 function MENU_INDEX:SetGroupMenu( Group, Path, Menu )
   local MenuGroupName = Group:GetName()
-  Group:F({MenuGroupName=MenuGroupName,Path=Path})
+  --Group:F({MenuGroupName=MenuGroupName,Path=Path})
   self.Group[MenuGroupName].Menus[Path] = Menu
 end
+
 function MENU_INDEX:ClearGroupMenu( Group, Path )
   local MenuGroupName = Group:GetName()
   self.Group[MenuGroupName].Menus[Path] = nil
 end
+
 function MENU_INDEX:Refresh( Group )
     for MenuID, Menu in pairs( self.MenuMission.Menus ) do
       Menu:Refresh()

Moose Development/Moose/Core/Message.lua

@@ -75,35 +75,37 @@ MESSAGE.Type = {
 
 --- Creates a new MESSAGE object. Note that these MESSAGE objects are not yet displayed on the display panel. You must use the functions @{#MESSAGE.ToClient} or @{#MESSAGE.ToCoalition} or @{#MESSAGE.ToAll} to send these Messages to the respective recipients.
 -- @param self
--- @param #string MessageText is the text of the Message.
--- @param #number MessageDuration is a number in seconds of how long the MESSAGE should be shown on the display panel.
--- @param #string MessageCategory (optional) is a string expressing the "category" of the Message. The category will be shown as the first text in the message followed by a ": ".
+-- @param #string Text is the text of the Message.
+-- @param #number Duration Duration in seconds how long the message text is shown.
+-- @param #string Category (Optional) String expressing the "category" of the Message. The category will be shown as the first text in the message followed by a ": ".
 -- @param #boolean ClearScreen (optional) Clear all previous messages if true.
--- @return #MESSAGE
+-- @return #MESSAGE self
 -- @usage
 --
---    -- Create a series of new Messages.
---    -- MessageAll is meant to be sent to all players, for 25 seconds, and is classified as "Score".
---    -- MessageRED is meant to be sent to the RED players only, for 10 seconds, and is classified as "End of Mission", with ID "Win".
---    -- MessageClient1 is meant to be sent to a Client, for 25 seconds, and is classified as "Score", with ID "Score".
---    -- MessageClient1 is meant to be sent to a Client, for 25 seconds, and is classified as "Score", with ID "Score".
+--   -- Create a series of new Messages.
+--   -- MessageAll is meant to be sent to all players, for 25 seconds, and is classified as "Score".
+--   -- MessageRED is meant to be sent to the RED players only, for 10 seconds, and is classified as "End of Mission", with ID "Win".
+--   -- MessageClient1 is meant to be sent to a Client, for 25 seconds, and is classified as "Score", with ID "Score".
+--   -- MessageClient1 is meant to be sent to a Client, for 25 seconds, and is classified as "Score", with ID "Score".
 --   MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!",  25, "End of Mission" )
 --   MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", 25, "Penalty" )
 --   MessageClient1 = MESSAGE:New( "Congratulations, you've just hit a target",  25, "Score" )
 --   MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", 25, "Score")
 --
-function MESSAGE:New( MessageText, MessageDuration, MessageCategory, ClearScreen )
+function MESSAGE:New( Text, Duration, Category, ClearScreen )
+
   local self = BASE:Inherit( self, BASE:New() )
-  self:F( { MessageText, MessageDuration, MessageCategory } )
+  
+  self:F( { Text, Duration, Category } )
 
   self.MessageType = nil
 
   -- When no MessageCategory is given, we don't show it as a title... 
-  if MessageCategory and MessageCategory ~= "" then
-    if MessageCategory:sub( -1 ) ~= "\n" then
-      self.MessageCategory = MessageCategory .. ": "
+  if Category and Category ~= "" then
+    if Category:sub( -1 ) ~= "\n" then
+      self.MessageCategory = Category .. ": "
     else
-      self.MessageCategory = MessageCategory:sub( 1, -2 ) .. ":\n"
+      self.MessageCategory = Category:sub( 1, -2 ) .. ":\n"
     end
   else
     self.MessageCategory = ""
@@ -114,9 +116,9 @@ function MESSAGE:New( MessageText, MessageDuration, MessageCategory, ClearScreen
     self.ClearScreen = ClearScreen
   end
 
-  self.MessageDuration = MessageDuration or 5
+  self.MessageDuration = Duration or 5
   self.MessageTime = timer.getTime()
-  self.MessageText = MessageText:gsub( "^\n", "", 1 ):gsub( "\n$", "", 1 )
+  self.MessageText = Text:gsub( "^\n", "", 1 ):gsub( "\n$", "", 1 )
 
   self.MessageSent = false
   self.MessageGroup = false
@@ -204,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
@@ -229,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
@@ -450,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.
@@ -462,16 +464,17 @@ _MESSAGESRS = {}
 -- @param #number Volume (optional) Volume, can be between 0.0 and 1.0 (loudest).
 -- @param #string Label (optional) Label, defaults to "MESSAGE" or the Message Category set.
 -- @param Core.Point#COORDINATE Coordinate (optional) Coordinate this messages originates from.
+-- @param #string Backend (optional) Backend to be used, can be MSRS.Backend.SRSEXE or MSRS.Backend.GRPC
 -- @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)
+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
@@ -487,6 +490,10 @@ function MESSAGE.SetMSRS(PathToSRS,Port,PathToCredentials,Frequency,Modulation,G
     _MESSAGESRS.MSRS:SetCoordinate(Coordinate)
   end
   
+  if Backend then
+   _MESSAGESRS.MSRS:SetBackend(Backend)
+  end
+  
   _MESSAGESRS.Culture = Culture or MSRS.culture or "en-GB"
   _MESSAGESRS.MSRS:SetCulture(Culture)
 
@@ -528,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()
 --          
@@ -560,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()
 --          
@@ -582,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()
 --          
@@ -604,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

@@ -49,7 +49,7 @@
 -- 
 -- # 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 points 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`).
@@ -69,11 +69,12 @@ PATHLINE = {
 -- @field #number landHeight Land height in meters.
 -- @field #number depth Water depth in meters.
 -- @field #number markerID Marker ID.
+-- @field #number lineID Line marker ID.
 
 
 --- PATHLINE class version.
 -- @field #string version
-PATHLINE.version="0.1.1"
+PATHLINE.version="0.2.0"
 
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 -- TODO list
@@ -301,18 +302,42 @@ function PATHLINE:GetPoint2DFromIndex(n)
   return nil
 end
 
+--- Calculate the length of the line.
+-- @param #PATHLINE self
+-- @param #boolean Project2D Calculate 2D distance between points.
+-- @return #number Length in meters.
+function PATHLINE:GetLength(Project2D)
+  local l=0
+
+  local np=#self.points
+
+  for i=1,np-1 do
+    local p1=self.points[i]   --#PATHLINE.Point
+    local p2=self.points[i+1] --#PATHLINE.Point
+    
+    if Project2D then
+      l=l+UTILS.VecDist2D(p1.vec2, p2.vec2)
+    else
+      l=l+UTILS.VecDist3D(p1.vec3, p2.vec3)
+    end
+    
+  end
+  
+  return l
+end
+
 
 --- Mark points on F10 map.
 -- @param #PATHLINE self
 -- @param #boolean Switch If `true` or nil, set marks. If `false`, remove marks.
--- @return <DCS#Vec3> List of DCS#Vec3 points.
+-- @return #PATHLINE self
 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, Delay)
+        UTILS.RemoveMark(point.markerID)
       end
       
     else
@@ -329,6 +354,56 @@ function PATHLINE:MarkPoints(Switch)
     
     end
   end
+  return self
+end
+
+--- Draw line on F10 map.
+-- @param #PATHLINE self
+-- @param #number Recipient Recipent of the line: -1=All.
+-- @param #table Color Color as RGB table plus alpha value. Default {1, 0, 0, 1.0}.
+-- @param #number LineType Line type: 1=Solid (default).
+-- @return #PATHLINE self
+function PATHLINE:DrawLine(Recipient, Color, LineType)
+  
+  -- Input
+  Recipient= Recipient or -1
+  Color= Color or {1,0,0, 1.0}
+  LineType=LineType or 1
+  local ReadOnly=false
+  
+
+  local np=#self.points
+
+  for i=1,np-1 do
+    local p1=self.points[i]   --#PATHLINE.Point
+    local p2=self.points[i+1] --#PATHLINE.Point
+    
+    p1.lineID = UTILS.GetMarkID()
+    
+    trigger.action.lineToAll(Recipient, p1.lineID, p1.vec3, p2.vec3, Color, LineType, ReadOnly, "")
+    
+  end
+
+  return self
+end
+
+--- Remove line on F10 map.
+-- @param #PATHLINE self
+-- @param #number Delay Delay in seconds before line is removed.
+-- @return #PATHLINE self
+function PATHLINE:UnDrawLine(Delay)
+  
+
+  local np=#self.points
+
+  for _,_point in pairs(self.points) do
+    local p=_point   --#PATHLINE.Point
+    if p.lineID then
+      UTILS.RemoveMark(p.lineID, Delay)
+    end    
+  end
+
+  return self
 end
 
 

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/Settings.lua

@@ -494,7 +494,7 @@ do -- SETTINGS
     return (self.A2ASystem and self.A2ASystem == "MGRS") or (not self.A2ASystem and _SETTINGS:IsA2A_MGRS())
   end
 
-  -- @param #SETTINGS self
+  --- @param #SETTINGS self
   -- @param Wrapper.Group#GROUP MenuGroup Group for which to add menus.
   -- @param #table RootMenu Root menu table
   -- @return #SETTINGS
@@ -948,49 +948,49 @@ do -- SETTINGS
     return self
   end
 
-  -- @param #SETTINGS self
+  --- @param #SETTINGS self
   function SETTINGS:A2GMenuSystem( MenuGroup, RootMenu, A2GSystem )
     self.A2GSystem = A2GSystem
     MESSAGE:New( string.format( "Settings: Default A2G coordinate system set to %s for all players!", A2GSystem ), 5 ):ToAll()
     self:SetSystemMenu( MenuGroup, RootMenu )
   end
 
-  -- @param #SETTINGS self
+  --- @param #SETTINGS self
   function SETTINGS:A2AMenuSystem( MenuGroup, RootMenu, A2ASystem )
     self.A2ASystem = A2ASystem
     MESSAGE:New( string.format( "Settings: Default A2A coordinate system set to %s for all players!", A2ASystem ), 5 ):ToAll()
     self:SetSystemMenu( MenuGroup, RootMenu )
   end
 
-  -- @param #SETTINGS self
+  --- @param #SETTINGS self
   function SETTINGS:MenuLL_DDM_Accuracy( MenuGroup, RootMenu, LL_Accuracy )
     self.LL_Accuracy = LL_Accuracy
     MESSAGE:New( string.format( "Settings: Default LL accuracy set to %s for all players!", LL_Accuracy ), 5 ):ToAll()
     self:SetSystemMenu( MenuGroup, RootMenu )
   end
 
-  -- @param #SETTINGS self
+  --- @param #SETTINGS self
   function SETTINGS:MenuMGRS_Accuracy( MenuGroup, RootMenu, MGRS_Accuracy )
     self.MGRS_Accuracy = MGRS_Accuracy
     MESSAGE:New( string.format( "Settings: Default MGRS accuracy set to %s for all players!", MGRS_Accuracy ), 5 ):ToAll()
     self:SetSystemMenu( MenuGroup, RootMenu )
   end
 
-  -- @param #SETTINGS self
+  --- @param #SETTINGS self
   function SETTINGS:MenuMWSystem( MenuGroup, RootMenu, MW )
     self.Metric = MW
     MESSAGE:New( string.format( "Settings: Default measurement format set to %s for all players!", MW and "Metric" or "Imperial" ), 5 ):ToAll()
     self:SetSystemMenu( MenuGroup, RootMenu )
   end
 
-  -- @param #SETTINGS self
+  --- @param #SETTINGS self
   function SETTINGS:MenuMessageTimingsSystem( MenuGroup, RootMenu, MessageType, MessageTime )
     self:SetMessageTime( MessageType, MessageTime )
     MESSAGE:New( string.format( "Settings: Default message time set for %s to %d.", MessageType, MessageTime ), 5 ):ToAll()
   end
 
   do
-    -- @param #SETTINGS self
+    --- @param #SETTINGS self
     function SETTINGS:MenuGroupA2GSystem( PlayerUnit, PlayerGroup, PlayerName, A2GSystem )
       --BASE:E( {PlayerUnit:GetName(), A2GSystem } )
       self.A2GSystem = A2GSystem
@@ -1001,7 +1001,7 @@ do -- SETTINGS
       end
     end
 
-    -- @param #SETTINGS self
+    --- @param #SETTINGS self
     function SETTINGS:MenuGroupA2ASystem( PlayerUnit, PlayerGroup, PlayerName, A2ASystem )
       self.A2ASystem = A2ASystem
       MESSAGE:New( string.format( "Settings: A2A format set to %s for player %s.", A2ASystem, PlayerName ), 5 ):ToGroup( PlayerGroup )
@@ -1011,7 +1011,7 @@ do -- SETTINGS
       end
     end
 
-    -- @param #SETTINGS self
+    --- @param #SETTINGS self
     function SETTINGS:MenuGroupLL_DDM_AccuracySystem( PlayerUnit, PlayerGroup, PlayerName, LL_Accuracy )
       self.LL_Accuracy = LL_Accuracy
       MESSAGE:New( string.format( "Settings: LL format accuracy set to %d decimal places for player %s.", LL_Accuracy, PlayerName ), 5 ):ToGroup( PlayerGroup )
@@ -1021,7 +1021,7 @@ do -- SETTINGS
       end
     end
 
-    -- @param #SETTINGS self
+    --- @param #SETTINGS self
     function SETTINGS:MenuGroupMGRS_AccuracySystem( PlayerUnit, PlayerGroup, PlayerName, MGRS_Accuracy )
       self.MGRS_Accuracy = MGRS_Accuracy
       MESSAGE:New( string.format( "Settings: MGRS format accuracy set to %d for player %s.", MGRS_Accuracy, PlayerName ), 5 ):ToGroup( PlayerGroup )
@@ -1031,7 +1031,7 @@ do -- SETTINGS
       end
     end
 
-    -- @param #SETTINGS self
+    --- @param #SETTINGS self
     function SETTINGS:MenuGroupMWSystem( PlayerUnit, PlayerGroup, PlayerName, MW )
       self.Metric = MW
       MESSAGE:New( string.format( "Settings: Measurement format set to %s for player %s.", MW and "Metric" or "Imperial", PlayerName ), 5 ):ToGroup( PlayerGroup )
@@ -1041,7 +1041,7 @@ do -- SETTINGS
       end
     end
 
-    -- @param #SETTINGS self
+    --- @param #SETTINGS self
     function SETTINGS:MenuGroupMessageTimingsSystem( PlayerUnit, PlayerGroup, PlayerName, MessageType, MessageTime )
       self:SetMessageTime( MessageType, MessageTime )
       MESSAGE:New( string.format( "Settings: Default message time set for %s to %d.", MessageType, MessageTime ), 5 ):ToGroup( PlayerGroup )

Moose Development/Moose/Core/Spawn.lua

@@ -1049,6 +1049,23 @@ function SPAWN:InitSetUnitAbsolutePositions(Positions)
   return self
 end
 
+
+--- Uses Disposition and other fallback logic to find better ground positions for ground units.
+--- NOTE: This is not a spawn randomizer.
+--- It will try to find clear ground locations avoiding trees, water, roads, runways, map scenery, statics and other units in the area.
+--- Maintains the original layout and unit positions as close as possible by searching for the next closest valid position to each unit.
+-- @param #SPAWN self
+-- @param #boolean OnOff Enable/disable the feature.
+-- @param #number MaxRadius (Optional) Max radius to search for valid ground locations in meters. Default is double the max radius of the units.
+-- @param #number Spacing (Optional) Minimum spacing between units in meters. Default is 5% of the search radius or 5 meters, whichever is larger.
+-- @return #SPAWN
+function SPAWN:InitValidateAndRepositionGroundUnits(OnOff, MaxRadius, Spacing)
+    self.SpawnValidateAndRepositionGroundUnits = OnOff
+    self.SpawnValidateAndRepositionGroundUnitsRadius = MaxRadius
+    self.SpawnValidateAndRepositionGroundUnitsSpacing = Spacing
+    return self
+end
+
 --- This method is rather complicated to understand. But I'll try to explain.
 -- This method becomes useful when you need to spawn groups with random templates of groups defined within the mission editor,
 -- but they will all follow the same Template route and have the same prefix name.
@@ -1081,7 +1098,7 @@ function SPAWN:InitRandomizeTemplate( SpawnTemplatePrefixTable )
   self.SpawnRandomizeTemplate = true
 
   for SpawnGroupID = 1, self.SpawnMaxGroups do
-    self:_RandomizeTemplate( SpawnGroupID )
+    self:_RandomizeTemplate( SpawnGroupID, RandomizePositionInZone )
   end
 
   return self
@@ -1093,6 +1110,7 @@ end
 -- In other words, this method randomizes between a defined set of groups the template to be used for each new spawn of a group.
 -- @param #SPAWN self
 -- @param Core.Set#SET_GROUP SpawnTemplateSet A SET_GROUP object set, that contains the groups that are possible unit representatives of the group to be spawned.
+-- @param #boolean RandomizePositionInZone If nil or true, also the position inside the selected random zone will be randomized. Set to false to use the center of the zone.
 -- @return #SPAWN
 -- @usage
 --
@@ -1111,11 +1129,11 @@ end
 --   Spawn_US_Platoon_Middle = SPAWN:New( 'US Tank Platoon Middle' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplateSet( Spawn_US_PlatoonSet ):InitRandomizeRoute( 3, 3, 2000 )
 --   Spawn_US_Platoon_Right = SPAWN:New( 'US Tank Platoon Right' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplateSet( Spawn_US_PlatoonSet ):InitRandomizeRoute( 3, 3, 2000 )
 --
-function SPAWN:InitRandomizeTemplateSet( SpawnTemplateSet )
+function SPAWN:InitRandomizeTemplateSet( SpawnTemplateSet,RandomizePositionInZone )
   --self:F( { self.SpawnTemplatePrefix } )
 
   local setnames = SpawnTemplateSet:GetSetNames()
-  self:InitRandomizeTemplate(setnames)
+  self:InitRandomizeTemplate(setnames,RandomizePositionInZone)
   
   return self
 end
@@ -1125,7 +1143,8 @@ end
 -- but they will all follow the same Template route and have the same prefix name.
 -- In other words, this method randomizes between a defined set of groups the template to be used for each new spawn of a group.
 -- @param #SPAWN self
--- @param #string SpawnTemplatePrefixes A string or a list of string that contains the prefixes of the groups that are possible unit representatives of the group to be spawned. 
+-- @param #string SpawnTemplatePrefixes A string or a list of string that contains the prefixes of the groups that are possible unit representatives of the group to be spawned.
+-- @param #boolean RandomizePositionInZone If nil or true, also the position inside the selected random zone will be randomized. Set to false to use the center of the zone. 
 -- @return #SPAWN
 -- @usage
 --
@@ -1141,12 +1160,12 @@ end
 --   Spawn_US_Platoon_Middle = SPAWN:New( 'US Tank Platoon Middle' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplatePrefixes( "US Tank Platoon Templates" ):InitRandomizeRoute( 3, 3, 2000 )
 --   Spawn_US_Platoon_Right = SPAWN:New( 'US Tank Platoon Right' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplatePrefixes( "US Tank Platoon Templates" ):InitRandomizeRoute( 3, 3, 2000 )
 --
-function SPAWN:InitRandomizeTemplatePrefixes( SpawnTemplatePrefixes ) -- R2.3
+function SPAWN:InitRandomizeTemplatePrefixes( SpawnTemplatePrefixes, RandomizePositionInZone ) -- R2.3
   --self:F( { self.SpawnTemplatePrefix } )
 
   local SpawnTemplateSet = SET_GROUP:New():FilterPrefixes( SpawnTemplatePrefixes ):FilterOnce()
 
-  self:InitRandomizeTemplateSet( SpawnTemplateSet )
+  self:InitRandomizeTemplateSet( SpawnTemplateSet, RandomizePositionInZone )
 
   return self
 end
@@ -1166,6 +1185,7 @@ end
 --- This method provides the functionality to randomize the spawning of the Groups at a given list of zones of different types.
 -- @param #SPAWN self
 -- @param #table SpawnZoneTable A table with @{Core.Zone} objects. If this table is given, then each spawn will be executed within the given list of @{Core.Zone}s objects.
+-- @param #boolean RandomizePositionInZone If nil or true, also the position inside the selected random zone will be randomized. Set to false to use the center of the zone.
 -- @return #SPAWN self
 -- @usage
 --
@@ -1178,7 +1198,7 @@ end
 --                           :InitRandomizeZones( ZoneTable )
 --                           :SpawnScheduled( 5, .5 )
 --
-function SPAWN:InitRandomizeZones( SpawnZoneTable )
+function SPAWN:InitRandomizeZones( SpawnZoneTable, RandomizePositionInZone )
   --self:F( { self.SpawnTemplatePrefix, SpawnZoneTable } )
   
   local temptable = {}
@@ -1190,7 +1210,7 @@ function SPAWN:InitRandomizeZones( SpawnZoneTable )
   self.SpawnRandomizeZones = true
 
   for SpawnGroupID = 1, self.SpawnMaxGroups do
-    self:_RandomizeZones( SpawnGroupID )
+    self:_RandomizeZones( SpawnGroupID, RandomizePositionInZone )
   end
 
   return self
@@ -1275,6 +1295,7 @@ end
 
 --- Respawn group after landing.
 -- @param #SPAWN self
+-- @param #number WaitingTime Wait this many seconds before despawning the alive group after landing. Defaults to 3 .
 -- @return #SPAWN self
 -- @usage
 --
@@ -1282,15 +1303,16 @@ end
 --   -- Re-SPAWN the Group(s) after each landing and Engine Shut-Down automatically.
 --   SpawnRU_SU34 = SPAWN:New( 'Su-34' )
 --                       :InitRandomizeRoute( 1, 1, 3000 )
---                       :InitRepeatOnLanding()
+--                       :InitRepeatOnLanding(20)
 --                       :Spawn()
 --
-function SPAWN:InitRepeatOnLanding()
+function SPAWN:InitRepeatOnLanding(WaitingTime)
   --self:F( { self.SpawnTemplatePrefix } )
 
   self:InitRepeat()
   self.RepeatOnEngineShutDown = false
   self.RepeatOnLanding = true
+  self.RepeatOnLandingTime = (WaitingTime and WaitingTime > 3) and WaitingTime or 3
 
   return self
 end
@@ -1626,7 +1648,7 @@ function SPAWN:SpawnWithIndex( SpawnIndex, NoBirth )
 
       if SpawnTemplate then
 
-        local PointVec3 = POINT_VEC3:New( SpawnTemplate.route.points[1].x, SpawnTemplate.route.points[1].alt, SpawnTemplate.route.points[1].y )
+        local PointVec3 = COORDINATE:New( SpawnTemplate.route.points[1].x, SpawnTemplate.route.points[1].alt, SpawnTemplate.route.points[1].y )
         --self:T2( { "Current point of ", self.SpawnTemplatePrefix, PointVec3 } )
 
         -- If RandomizePosition, then Randomize the formation in the zone band, keeping the template.
@@ -1645,6 +1667,9 @@ function SPAWN:SpawnWithIndex( SpawnIndex, NoBirth )
 
         -- If RandomizeUnits, then Randomize the formation at the start point.
         if self.SpawnRandomizeUnits then
+          if self.SpawnRandomizePosition then
+            PointVec3 = COORDINATE:New( SpawnTemplate.x, SpawnTemplate.route.points[1].alt, SpawnTemplate.y )
+          end
           for UnitID = 1, #SpawnTemplate.units do
             local RandomVec2 = PointVec3:GetRandomVec2InRadius( self.SpawnOuterRadius, self.SpawnInnerRadius )
             if (SpawnZone) then
@@ -1824,7 +1849,13 @@ function SPAWN:SpawnWithIndex( SpawnIndex, NoBirth )
         if self.SpawnHiddenOnMap then
           SpawnTemplate.hidden=self.SpawnHiddenOnMap
         end
-        
+
+        if self.SpawnValidateAndRepositionGroundUnits then
+            local units = SpawnTemplate.units
+            local gPos = { x = SpawnTemplate.x, y = SpawnTemplate.y }
+            UTILS.ValidateAndRepositionGroundUnits(units, gPos, self.SpawnValidateAndRepositionGroundUnitsRadius, self.SpawnValidateAndRepositionGroundUnitsSpacing)
+        end
+
         -- Set country, coalition and category.
         SpawnTemplate.CategoryID = self.SpawnInitCategory or SpawnTemplate.CategoryID
         SpawnTemplate.CountryID = self.SpawnInitCountry or SpawnTemplate.CountryID
@@ -2028,12 +2059,10 @@ end
 --
 --   Spawn_Plane:SpawnAtAirbase( AIRBASE:FindByName( AIRBASE.Caucasus.Krymsk ), SPAWN.Takeoff.Cold, nil, AIRBASE.TerminalType.OpenBig )
 --
-function SPAWN:SpawnAtAirbase( SpawnAirbase, Takeoff, TakeoffAltitude, TerminalType, EmergencyAirSpawn, Parkingdata ) -- R2.2, R2.4
-  --self:F( { self.SpawnTemplatePrefix, SpawnAirbase, Takeoff, TakeoffAltitude, TerminalType } )
+function SPAWN:SpawnAtAirbase( SpawnAirbase, Takeoff, TakeoffAltitude, TerminalType, EmergencyAirSpawn, Parkingdata )
 
   -- Get position of airbase.
   local PointVec3 = SpawnAirbase:GetCoordinate()
-  --self:T2( PointVec3 )
 
   -- Set take off type. Default is hot.
   Takeoff = Takeoff or SPAWN.Takeoff.Hot
@@ -2043,39 +2072,24 @@ function SPAWN:SpawnAtAirbase( SpawnAirbase, Takeoff, TakeoffAltitude, TerminalT
     EmergencyAirSpawn = true
   end
 
-  --self:F( { SpawnIndex = self.SpawnIndex } )
-
   if self:_GetSpawnIndex( self.SpawnIndex + 1 ) then
 
     -- Get group template.
     local SpawnTemplate = self.SpawnGroups[self.SpawnIndex].SpawnTemplate
 
-    --self:F( { SpawnTemplate = SpawnTemplate } )
-
     if SpawnTemplate then
 
-      -- Check if the aircraft with the specified SpawnIndex is already spawned.
-      -- If yes, ensure that the aircraft is spawned at the same aircraft spot.
-
-      local GroupAlive = self:GetGroupFromIndex( self.SpawnIndex )
-
-      --self:F( { GroupAlive = GroupAlive } )
-
-      -- Debug output
-      --self:T2( { "Current point of ", self.SpawnTemplatePrefix, SpawnAirbase } )
-
       -- Template group, unit and its attributes.
-      local TemplateGroup = GROUP:FindByName( self.SpawnTemplatePrefix )
-      local TemplateUnit = TemplateGroup:GetUnit( 1 )
+      local group = GROUP:FindByName( self.SpawnTemplatePrefix )
+      local unit  = group:GetUnit( 1 )
 
       -- General category of spawned group.
-      local group = TemplateGroup
       local istransport = group:HasAttribute( "Transports" ) and group:HasAttribute( "Planes" )
       local isawacs = group:HasAttribute( "AWACS" )
       local isfighter = group:HasAttribute( "Fighters" ) or group:HasAttribute( "Interceptors" ) or group:HasAttribute( "Multirole fighters" ) or (group:HasAttribute( "Bombers" ) and not group:HasAttribute( "Strategic bombers" ))
       local isbomber = group:HasAttribute( "Strategic bombers" )
       local istanker = group:HasAttribute( "Tankers" )
-      local ishelo = TemplateUnit:HasAttribute( "Helicopters" )
+      local ishelo = unit:HasAttribute( "Helicopters" )
 
       -- Number of units in the group. With grouping this can actually differ from the template group size!
       local nunits = #SpawnTemplate.units
@@ -2093,40 +2107,32 @@ function SPAWN:SpawnAtAirbase( SpawnAirbase, Takeoff, TakeoffAltitude, TerminalT
       local AirbaseCategory = SpawnAirbase:GetAirbaseCategory()
       --self:F( { AirbaseCategory = AirbaseCategory } )
 
-      -- Set airdromeId.
+      -- Set airdrome ID. For helipads and ships we need to add the helipad ID and linked unit.
+      -- Note, it is important not to set the airdrome ID for at least ships, because spawn will happen at origin of the map
       if AirbaseCategory == Airbase.Category.SHIP then
         SpawnPoint.linkUnit = AirbaseID
         SpawnPoint.helipadId = AirbaseID
       elseif AirbaseCategory == Airbase.Category.HELIPAD then
         SpawnPoint.linkUnit = AirbaseID
         SpawnPoint.helipadId = AirbaseID
-      elseif AirbaseCategory == Airbase.Category.AIRDROME then
+      else
         SpawnPoint.airdromeId = AirbaseID
       end
 
       -- Set waypoint type/action.
-      SpawnPoint.alt = 0
-      SpawnPoint.type = GROUPTEMPLATE.Takeoff[Takeoff][1] -- type
+      SpawnPoint.alt    = 0
+      SpawnPoint.type   = GROUPTEMPLATE.Takeoff[Takeoff][1] -- type
       SpawnPoint.action = GROUPTEMPLATE.Takeoff[Takeoff][2] -- action
 
       -- Check if we spawn on ground. 
       local spawnonground = not (Takeoff == SPAWN.Takeoff.Air)
-      --self:T2( { spawnonground = spawnonground, TOtype = Takeoff, TOair = Takeoff == SPAWN.Takeoff.Air } )
 
       -- Check where we actually spawn if we spawn on ground.
-      local spawnonship = false
-      local spawnonfarp = false
-      local spawnonrunway = false
-      local spawnonairport = false
-      if spawnonground then
-        if AirbaseCategory == Airbase.Category.SHIP then
-          spawnonship = true
-        elseif AirbaseCategory == Airbase.Category.HELIPAD then
-          spawnonfarp = true
-        elseif AirbaseCategory == Airbase.Category.AIRDROME then
-          spawnonairport = true
-        end
-        spawnonrunway = Takeoff == SPAWN.Takeoff.Runway
+      local autoparking=false
+      if SpawnAirbase.isAirdrome then
+        autoparking=false
+      else
+        autoparking=true
       end
 
       -- Array with parking spots coordinates.
@@ -2142,8 +2148,8 @@ function SPAWN:SpawnAtAirbase( SpawnAirbase, Takeoff, TakeoffAltitude, TerminalT
 
         -- Set terminal type.
         local termtype = TerminalType
-        if spawnonrunway then
-          if spawnonship then
+        if Takeoff==SPAWN.Takeoff.Runway then
+          if SpawnAirbase.isShip then
             -- Looks like there are no runway spawn spots on the stennis!
             if ishelo then
               termtype = AIRBASE.TerminalType.HelicopterUsable
@@ -2163,34 +2169,31 @@ function SPAWN:SpawnAtAirbase( SpawnAirbase, Takeoff, TakeoffAltitude, TerminalT
         local verysafe = false
 
         -- Number of free parking spots at the airbase.
-        if spawnonship or spawnonfarp or spawnonrunway then
+        if autoparking then
           -- These places work procedural and have some kind of build in queue ==> Less effort.
-          --self:T2( string.format( "Group %s is spawned on farp/ship/runway %s.", self.SpawnTemplatePrefix, SpawnAirbase:GetName() ) )
           nfree = SpawnAirbase:GetFreeParkingSpotsNumber( termtype, true )
           spots = SpawnAirbase:GetFreeParkingSpotsTable( termtype, true )
-          --[[
         elseif Parkingdata~=nil then
-          -- Parking data explicitly set by user as input parameter.
+          -- Parking data explicitly set by user as input parameter. (This was commented out for some unknown reason. But I need it this way.)
           nfree=#Parkingdata
           spots=Parkingdata
-        ]]
         else
           if ishelo then
             if termtype == nil then
               -- Helo is spawned. Try exclusive helo spots first.
               --self:T2( string.format( "Helo group %s is at %s using terminal type %d.", self.SpawnTemplatePrefix, SpawnAirbase:GetName(), AIRBASE.TerminalType.HelicopterOnly ) )
-              spots = SpawnAirbase:FindFreeParkingSpotForAircraft( TemplateGroup, AIRBASE.TerminalType.HelicopterOnly, scanradius, scanunits, scanstatics, scanscenery, verysafe, nunits, Parkingdata )
+              spots = SpawnAirbase:FindFreeParkingSpotForAircraft( group, AIRBASE.TerminalType.HelicopterOnly, scanradius, scanunits, scanstatics, scanscenery, verysafe, nunits, Parkingdata )
               nfree = #spots
               if nfree < nunits then
                 -- Not enough helo ports. Let's try also other terminal types.
                 --self:T2( string.format( "Helo group %s is at %s using terminal type %d.", self.SpawnTemplatePrefix, SpawnAirbase:GetName(), AIRBASE.TerminalType.HelicopterUsable ) )
-                spots = SpawnAirbase:FindFreeParkingSpotForAircraft( TemplateGroup, AIRBASE.TerminalType.HelicopterUsable, scanradius, scanunits, scanstatics, scanscenery, verysafe, nunits, Parkingdata )
+                spots = SpawnAirbase:FindFreeParkingSpotForAircraft( group, AIRBASE.TerminalType.HelicopterUsable, scanradius, scanunits, scanstatics, scanscenery, verysafe, nunits, Parkingdata )
                 nfree = #spots
               end
             else
               -- No terminal type specified. We try all spots except shelters.
               --self:T2( string.format( "Helo group %s is at %s using terminal type %d.", self.SpawnTemplatePrefix, SpawnAirbase:GetName(), termtype ) )
-              spots = SpawnAirbase:FindFreeParkingSpotForAircraft( TemplateGroup, termtype, scanradius, scanunits, scanstatics, scanscenery, verysafe, nunits, Parkingdata )
+              spots = SpawnAirbase:FindFreeParkingSpotForAircraft( group, termtype, scanradius, scanunits, scanstatics, scanscenery, verysafe, nunits, Parkingdata )
               nfree = #spots
             end
           else
@@ -2199,44 +2202,33 @@ function SPAWN:SpawnAtAirbase( SpawnAirbase, Takeoff, TakeoffAltitude, TerminalT
               if isbomber or istransport or istanker or isawacs then
                 -- First we fill the potentially bigger spots.
                 --self:T2( string.format( "Transport/bomber group %s is at %s using terminal type %d.", self.SpawnTemplatePrefix, SpawnAirbase:GetName(), AIRBASE.TerminalType.OpenBig ) )
-                spots = SpawnAirbase:FindFreeParkingSpotForAircraft( TemplateGroup, AIRBASE.TerminalType.OpenBig, scanradius, scanunits, scanstatics, scanscenery, verysafe, nunits, Parkingdata )
+                spots = SpawnAirbase:FindFreeParkingSpotForAircraft( group, AIRBASE.TerminalType.OpenBig, scanradius, scanunits, scanstatics, scanscenery, verysafe, nunits, Parkingdata )
                 nfree = #spots
                 if nfree < nunits then
                   -- Now we try the smaller ones.
                   --self:T2( string.format( "Transport/bomber group %s is at %s using terminal type %d.", self.SpawnTemplatePrefix, SpawnAirbase:GetName(), AIRBASE.TerminalType.OpenMedOrBig ) )
-                  spots = SpawnAirbase:FindFreeParkingSpotForAircraft( TemplateGroup, AIRBASE.TerminalType.OpenMedOrBig, scanradius, scanunits, scanstatics, scanscenery, verysafe, nunits, Parkingdata )
+                  spots = SpawnAirbase:FindFreeParkingSpotForAircraft( group, AIRBASE.TerminalType.OpenMedOrBig, scanradius, scanunits, scanstatics, scanscenery, verysafe, nunits, Parkingdata )
                   nfree = #spots
                 end
               else
                 --self:T2( string.format( "Fighter group %s is at %s using terminal type %d.", self.SpawnTemplatePrefix, SpawnAirbase:GetName(), AIRBASE.TerminalType.FighterAircraft ) )
-                spots = SpawnAirbase:FindFreeParkingSpotForAircraft( TemplateGroup, AIRBASE.TerminalType.FighterAircraft, scanradius, scanunits, scanstatics, scanscenery, verysafe, nunits, Parkingdata )
+                spots = SpawnAirbase:FindFreeParkingSpotForAircraft( group, AIRBASE.TerminalType.FighterAircraft, scanradius, scanunits, scanstatics, scanscenery, verysafe, nunits, Parkingdata )
                 nfree = #spots
               end
             else
               -- Terminal type explicitly given.
               --self:T2( string.format( "Plane group %s is at %s using terminal type %s.", self.SpawnTemplatePrefix, SpawnAirbase:GetName(), tostring( termtype ) ) )
-              spots = SpawnAirbase:FindFreeParkingSpotForAircraft( TemplateGroup, termtype, scanradius, scanunits, scanstatics, scanscenery, verysafe, nunits, Parkingdata )
+              spots = SpawnAirbase:FindFreeParkingSpotForAircraft( group, termtype, scanradius, scanunits, scanstatics, scanscenery, verysafe, nunits, Parkingdata )
               nfree = #spots
             end
           end
         end
 
-        -- Debug: Get parking data.
-        --[[
-        local parkingdata=SpawnAirbase:GetParkingSpotsTable(termtype)
-        --self:T2(string.format("Parking at %s, terminal type %s:", SpawnAirbase:GetName(), tostring(termtype)))
-        for _,_spot in pairs(parkingdata) do
-          --self:T2(string.format("%s, Termin Index = %3d, Term Type = %03d, Free = %5s, TOAC = %5s, Term ID0 = %3d, Dist2Rwy = %4d",
-          SpawnAirbase:GetName(), _spot.TerminalID, _spot.TerminalType,tostring(_spot.Free),tostring(_spot.TOAC),_spot.TerminalID0,_spot.DistToRwy))
-        end
-        --self:T2(string.format("%s at %s: free parking spots = %d - number of units = %d", self.SpawnTemplatePrefix, SpawnAirbase:GetName(), nfree, nunits))
-        ]]
-
         -- Set this to true if not enough spots are available for emergency air start.
         local _notenough = false
 
         -- Need to differentiate some cases again.
-        if spawnonship or spawnonfarp or spawnonrunway then
+        if autoparking then
 
           -- On free spot required in these cases.
           if nfree >= 1 then
@@ -2254,7 +2246,7 @@ function SPAWN:SpawnAtAirbase( SpawnAirbase, Takeoff, TakeoffAltitude, TerminalT
             _notenough = true
           end
 
-        elseif spawnonairport then
+        else
 
           if nfree >= nunits then
 
@@ -2276,13 +2268,10 @@ function SPAWN:SpawnAtAirbase( SpawnAirbase, Takeoff, TakeoffAltitude, TerminalT
             self:E( string.format( "WARNING: Group %s has no parking spots at %s ==> air start!", self.SpawnTemplatePrefix, SpawnAirbase:GetName() ) )
 
             -- Not enough parking spots at the airport ==> Spawn in air.
-            spawnonground = false
-            spawnonship = false
-            spawnonfarp = false
-            spawnonrunway = false
+            autoparking=false
 
             -- Set waypoint type/action to turning point.
-            SpawnPoint.type = GROUPTEMPLATE.Takeoff[GROUP.Takeoff.Air][1] -- type   = Turning Point
+            SpawnPoint.type   = GROUPTEMPLATE.Takeoff[GROUP.Takeoff.Air][1] -- type   = Turning Point
             SpawnPoint.action = GROUPTEMPLATE.Takeoff[GROUP.Takeoff.Air][2] -- action = Turning Point
 
             -- Adjust altitude to be 500-1000 m above the airbase.
@@ -2324,7 +2313,6 @@ function SPAWN:SpawnAtAirbase( SpawnAirbase, Takeoff, TakeoffAltitude, TerminalT
         SpawnTemplate.parked = true
 
         for UnitID = 1, nunits do
-          --self:T2( 'Before Translation SpawnTemplate.units[' .. UnitID .. '].x = ' .. SpawnTemplate.units[UnitID].x .. ', SpawnTemplate.units[' .. UnitID .. '].y = ' .. SpawnTemplate.units[UnitID].y )
 
           -- Template of the current unit.
           local UnitTemplate = SpawnTemplate.units[UnitID]
@@ -2340,9 +2328,7 @@ function SPAWN:SpawnAtAirbase( SpawnAirbase, Takeoff, TakeoffAltitude, TerminalT
           if spawnonground then
 
             -- Ships and FARPS seem to have a build in queue.
-            if spawnonship or spawnonfarp or spawnonrunway then
-
-              --self:T2( string.format( "Group %s spawning at farp, ship or runway %s.", self.SpawnTemplatePrefix, SpawnAirbase:GetName() ) )
+            if autoparking then
 
               -- Spawn on ship. We take only the position of the ship.
               SpawnTemplate.units[UnitID].x = PointVec3.x -- TX
@@ -2351,20 +2337,15 @@ function SPAWN:SpawnAtAirbase( SpawnAirbase, Takeoff, TakeoffAltitude, TerminalT
 
             else
 
-              --self:T2( string.format( "Group %s spawning at airbase %s on parking spot id %d", self.SpawnTemplatePrefix, SpawnAirbase:GetName(), parkingindex[UnitID] ) )
-
               -- Get coordinates of parking spot.
               SpawnTemplate.units[UnitID].x = parkingspots[UnitID].x
               SpawnTemplate.units[UnitID].y = parkingspots[UnitID].z
               SpawnTemplate.units[UnitID].alt = parkingspots[UnitID].y
 
-              -- parkingspots[UnitID]:MarkToAll(string.format("Group %s spawning at airbase %s on parking spot id %d", self.SpawnTemplatePrefix, SpawnAirbase:GetName(), parkingindex[UnitID]))
             end
 
           else
 
-            --self:T2( string.format( "Group %s spawning in air at %s.", self.SpawnTemplatePrefix, SpawnAirbase:GetName() ) )
-
             -- Spawn in air as requested initially. Original template orientation is perserved, altitude is already correctly set.
             SpawnTemplate.units[UnitID].x = TX
             SpawnTemplate.units[UnitID].y = TY
@@ -2378,11 +2359,6 @@ function SPAWN:SpawnAtAirbase( SpawnAirbase, Takeoff, TakeoffAltitude, TerminalT
           if parkingindex[UnitID] then
             UnitTemplate.parking = parkingindex[UnitID]
           end
-
-          -- Debug output.
-          --self:T2( string.format( "Group %s unit number %d: Parking    = %s", self.SpawnTemplatePrefix, UnitID, tostring( UnitTemplate.parking ) ) )
-          --self:T2( string.format( "Group %s unit number %d: Parking ID = %s", self.SpawnTemplatePrefix, UnitID, tostring( UnitTemplate.parking_id ) ) )
-          --self:T2( 'After Translation SpawnTemplate.units[' .. UnitID .. '].x = ' .. SpawnTemplate.units[UnitID].x .. ', SpawnTemplate.units[' .. UnitID .. '].y = ' .. SpawnTemplate.units[UnitID].y )
         end
       end
 
@@ -2402,14 +2378,15 @@ function SPAWN:SpawnAtAirbase( SpawnAirbase, Takeoff, TakeoffAltitude, TerminalT
       -- When spawned in the air, we need to generate a Takeoff Event.
       if Takeoff == GROUP.Takeoff.Air then
         for UnitID, UnitSpawned in pairs( GroupSpawned:GetUnits() ) do
-          SCHEDULER:New( nil, BASE.CreateEventTakeoff, { GroupSpawned, timer.getTime(), UnitSpawned:GetDCSObject() }, 5 )
+          --SCHEDULER:New( nil, BASE.CreateEventTakeoff, { GroupSpawned, timer.getTime(), UnitSpawned:GetDCSObject() }, 5 )  --No need to create a new SCHEDULER instance every time!
+          self:ScheduleOnce(5, BASE.CreateEventTakeoff, {GroupSpawned, timer.getTime(), UnitSpawned:GetDCSObject()})
         end
       end
 
       -- Check if we accidentally spawned on the runway. Needs to be schedules, because group is not immidiately alive.
-      if Takeoff ~= SPAWN.Takeoff.Runway and Takeoff ~= SPAWN.Takeoff.Air and spawnonairport then
-        SCHEDULER:New( nil, AIRBASE.CheckOnRunWay, { SpawnAirbase, GroupSpawned, 75, true }, 1.0 )
-      end
+      --if Takeoff ~= SPAWN.Takeoff.Runway and Takeoff ~= SPAWN.Takeoff.Air and spawnonairport then
+      --  SCHEDULER:New( nil, AIRBASE.CheckOnRunWay, { SpawnAirbase, GroupSpawned, 75, true }, 1.0 )
+      --end
 
       return GroupSpawned
     end
@@ -2879,7 +2856,7 @@ end
 function SPAWN:SpawnFromVec3( Vec3, SpawnIndex )
   --self:F( { self.SpawnTemplatePrefix, Vec3, SpawnIndex } )
 
-  local PointVec3 = POINT_VEC3:NewFromVec3( Vec3 )
+  local PointVec3 = COORDINATE:NewFromVec3( Vec3 )
   --self:T2( PointVec3 )
 
   if SpawnIndex then
@@ -2955,7 +2932,7 @@ end
 -- Note that each point in the route assigned to the spawning group is reset to the point of the spawn.
 -- You can use the returned group to further define the route to be followed.
 -- @param #SPAWN self
--- @param Core.Point#POINT_VEC3 PointVec3 The PointVec3 coordinates where to spawn the group.
+-- @param Core.Point#COORDINATE PointVec3 The COORDINATE coordinates where to spawn the group.
 -- @param #number SpawnIndex (optional) The index which group to spawn within the given zone.
 -- @return Wrapper.Group#GROUP that was spawned or #nil if nothing was spawned.
 -- @usage
@@ -3003,12 +2980,12 @@ function SPAWN:SpawnFromVec2( Vec2, MinHeight, MaxHeight, SpawnIndex )
   return self:SpawnFromVec3( { x = Vec2.x, y = Height, z = Vec2.y }, SpawnIndex ) -- y can be nil. In this case, spawn on the ground for vehicles, and in the template altitude for air.
 end
 
---- Will spawn a group from a POINT_VEC2 in 3D space.
+--- Will spawn a group from a COORDINATE in 3D space.
 -- This method is mostly advisable to be used if you want to simulate spawning groups on the ground from air units, like vehicles.
 -- Note that each point in the route assigned to the spawning group is reset to the point of the spawn.
 -- You can use the returned group to further define the route to be followed.
 -- @param #SPAWN self
--- @param Core.Point#POINT_VEC2 PointVec2 The PointVec2 coordinates where to spawn the group.
+-- @param Core.Point#COORDINATE PointVec2 The coordinates where to spawn the group.
 -- @param #number MinHeight (optional) The minimum height to spawn an airborne group into the zone.
 -- @param #number MaxHeight (optional) The maximum height to spawn an airborne group into the zone.
 -- @param #number SpawnIndex (optional) The index which group to spawn within the given zone.
@@ -3544,6 +3521,11 @@ function SPAWN:_Prepare( SpawnTemplatePrefix, SpawnIndex ) -- R2.2
         max = 18 
         ctable = CALLSIGN.F15E
       end
+      if SpawnTemplate.units[1].type == "A6E" then
+        min = 4
+        max = 18 
+        ctable = CALLSIGN.Intruder
+      end
       local callsignnr = math.random(min,max)
       local callsignname = "Enfield"
       for name, value in pairs(ctable) do
@@ -3814,8 +3796,9 @@ end
 --- Private method that randomizes the @{Core.Zone}s where the Group will be spawned.
 -- @param #SPAWN self
 -- @param #number SpawnIndex
+-- @param #boolean RandomizePositionInZone If nil or true, also the position inside the selected random zone will be randomized. Set to false to use the center of the zone.
 -- @return #SPAWN self
-function SPAWN:_RandomizeZones( SpawnIndex )
+function SPAWN:_RandomizeZones( SpawnIndex,  RandomizePositionInZone)
   --self:F( { self.SpawnTemplatePrefix, SpawnIndex, self.SpawnRandomizeZones } )
 
   if self.SpawnRandomizeZones then
@@ -3829,7 +3812,11 @@ function SPAWN:_RandomizeZones( SpawnIndex )
 
     --self:T2( "Preparing Spawn in Zone", SpawnZone:GetName() )
 
-    local SpawnVec2 = SpawnZone:GetRandomVec2()
+    local SpawnVec2 = SpawnZone:GetVec2()
+
+    if RandomizePositionInZone ~= false then
+        SpawnVec2 = SpawnZone:GetRandomVec2()
+    end
 
     --self:T2( { SpawnVec2 = SpawnVec2 } )
 
@@ -3956,12 +3943,17 @@ end
 -- @return #number count
 function SPAWN:_CountAliveUnits()
   local count = 0
+  --self:I("self.SpawnAliasPrefix="..tostring(self.SpawnAliasPrefix).." | self.SpawnTemplatePrefix="..tostring(self.SpawnTemplatePrefix))
   if self.SpawnAliasPrefix then
     if not self.SpawnAliasPrefixEscaped then self.SpawnAliasPrefixEscaped = string.gsub(self.SpawnAliasPrefix,"[%p%s]",".") end
+    --self:I("self.SpawnAliasPrefixEscaped="..tostring(self.SpawnAliasPrefixEscaped))
     local SpawnAliasPrefix = self.SpawnAliasPrefixEscaped
     local agroups = GROUP:FindAllByMatching(SpawnAliasPrefix)
     for _,_grp in pairs(agroups) do
+      --self:I("Group Name = " .. _grp:GetName())
       local game = self:_GetPrefixFromGroupName(_grp.GroupName)
+      --self:I("Game = "..game)
+      --self:I("Count = ".._grp:CountAliveUnits())
       if game and game == self.SpawnAliasPrefix then
         count = count + _grp:CountAliveUnits()
       end
@@ -3977,15 +3969,16 @@ function SPAWN:_CountAliveUnits()
       end
     end
   end
-  return count
+  self.AliveUnits = count
+  return self
 end
 
 ---
 -- @param #SPAWN self 
 -- @param Core.Event#EVENTDATA EventData
 function SPAWN:_OnDeadOrCrash( EventData )
-  --self:T2( "Dead or crash event ID "..tostring(EventData.id or 0))
-  --self:T2( "Dead or crash event for "..tostring(EventData.IniUnitName or "none") )
+  --self:I( "Dead or crash event ID "..tostring(EventData.id or 0))
+  --self:I( "Dead or crash event for "..tostring(EventData.IniUnitName or "none") )
   
   --if EventData.id == EVENTS.Dead then return end
   
@@ -3997,11 +3990,12 @@ function SPAWN:_OnDeadOrCrash( EventData )
     local EventPrefix = self:_GetPrefixFromGroupName(unit.GroupName)
    
     if EventPrefix then -- EventPrefix can be nil if no # is found, which means, no spawnable group!
-      --self:T2(string.format("EventPrefix = %s | SpawnAliasPrefix = %s  | Old AliveUnits = %d",EventPrefix or "",self.SpawnAliasPrefix or "",self.AliveUnits or 0))
+      --self:I(string.format("EventPrefix = %s | SpawnAliasPrefix = %s  | Old AliveUnits = %d",EventPrefix or "",self.SpawnAliasPrefix or "",self.AliveUnits or 0))
       if EventPrefix == self.SpawnTemplatePrefix or ( self.SpawnAliasPrefix and EventPrefix == self.SpawnAliasPrefix ) and self.AliveUnits > 0 then
-        --self:I( { "Dead event: " .. EventPrefix } )
-       --self.AliveUnits = self.AliveUnits - 1   
-       self.AliveUnits = self:_CountAliveUnits()
+       --self:I( { "Dead event: " .. EventPrefix } )
+       --self.AliveUnits = self.AliveUnits - 1
+       self:ScheduleOnce(1,self._CountAliveUnits,self)   
+       --self.AliveUnits = self:_CountAliveUnits()
        --self:I( "New Alive Units: " .. self.AliveUnits ) 
       end
     end
@@ -4049,7 +4043,7 @@ function SPAWN:_OnLand( EventData )
           -- self:ReSpawn( SpawnGroupIndex )
           -- Delay respawn by three seconds due to DCS 2.5.4.26368 OB bug https://github.com/FlightControl-Master/MOOSE/issues/1076
           -- Bug was initially only for engine shutdown event but after ED "fixed" it, it now happens on landing events.
-          SCHEDULER:New( nil, self.ReSpawn, { self, SpawnGroupIndex }, 3 )
+          SCHEDULER:New( nil, self.ReSpawn, { self, SpawnGroupIndex }, self.RepeatOnLandingTime or 3 )
         end
       end
     end

Moose Development/Moose/Core/SpawnStatic.lua

@@ -105,7 +105,7 @@
 --
 --   * @{#SPAWNSTATIC.Spawn}(Heading, NewName) spawns the static with the set parameters. Optionally, heading and name can be given. The name **must be unique**!
 --   * @{#SPAWNSTATIC.SpawnFromCoordinate}(Coordinate, Heading, NewName) spawn the static at the given coordinate. Optionally, heading and name can be given. The name **must be unique**!
---   * @{#SPAWNSTATIC.SpawnFromPointVec2}(PointVec2, Heading, NewName) spawns the static at a POINT_VEC2 coordinate. Optionally, heading and name can be given. The name **must be unique**!
+--   * @{#SPAWNSTATIC.SpawnFromPointVec2}(PointVec2, Heading, NewName) spawns the static at a COORDINATE coordinate. Optionally, heading and name can be given. The name **must be unique**!
 --   * @{#SPAWNSTATIC.SpawnFromZone}(Zone, Heading, NewName) spawns the static at the center of a @{Core.Zone}. Optionally, heading and name can be given. The name **must be unique**!
 --
 -- @field #SPAWNSTATIC SPAWNSTATIC
@@ -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
 
@@ -329,6 +334,31 @@ function SPAWNSTATIC:InitCargo(IsCargo)
   return self
 end
 
+--- Hide the static on the map view (visible to game master slots!).
+-- @param #SPAWN self
+-- @param #boolean OnOff Defaults to true
+-- @return #SPAWN The SPAWN object
+function SPAWNSTATIC:InitHiddenOnMap(OnOff)
+  self.SpawnHiddenOnMap = OnOff == false and false or true
+  return self
+end
+
+--- Hide the static on MFDs (visible to game master slots!).
+-- @param #SPAWN self
+-- @return #SPAWN The SPAWN object
+function SPAWNSTATIC:InitHiddenOnMFD()
+  self.SpawnHiddenOnMFD = true
+  return self
+end
+
+--- Hide the static on planner (visible to game master slots!).
+-- @param #SPAWN self
+-- @return #SPAWN The SPAWN object
+function SPAWNSTATIC:InitHiddenOnPlanner()
+  self.SpawnHiddenOnPlanner = true
+  return self
+end
+
 --- Initialize as dead.
 -- @param #SPAWNSTATIC self
 -- @param #boolean IsDead If true, this static is dead.
@@ -373,6 +403,20 @@ function SPAWNSTATIC:InitLinkToUnit(Unit, OffsetX, OffsetY, OffsetAngle)
   return self
 end
 
+--- Uses Disposition and other fallback logic to find a better and valid ground spawn position.
+--- NOTE: This is not a spawn randomizer.
+--- It will try to a find clear ground location avoiding trees, water, roads, runways, map scenery, other statics and other units in the area.
+--- Uses the initial position if it's a valid location.
+-- @param #SPAWNSTATIC self
+-- @param #boolean OnOff Enable/disable the feature.
+-- @param #number MaxRadius (Optional) Max radius to search for a valid ground location in meters. Default is 10 times the max radius of the static.
+-- @return #SPAWNSTATIC self
+function SPAWNSTATIC:InitValidateAndRepositionStatic(OnOff, MaxRadius)
+    self.ValidateAndRepositionStatic = OnOff
+    self.ValidateAndRepositionStaticMaxRadius = MaxRadius
+    return self
+end
+
 --- Allows to place a CallFunction hook when a new static spawns.
 -- The provided method will be called when a new group is spawned, including its given parameters.
 -- The first parameter of the SpawnFunction is the @{Wrapper.Static#STATIC} that was spawned.
@@ -411,9 +455,9 @@ function SPAWNSTATIC:Spawn(Heading, NewName)
 
 end
 
---- Creates a new @{Wrapper.Static} from a POINT_VEC2.
+--- Creates a new @{Wrapper.Static} from a COORDINATE.
 -- @param #SPAWNSTATIC self
--- @param Core.Point#POINT_VEC2 PointVec2 The 2D coordinate where to spawn the static.
+-- @param Core.Point#COORDINATE PointVec2 The 2D coordinate where to spawn the static.
 -- @param #number Heading The heading of the static, which is a number in degrees from 0 to 360.
 -- @param #string NewName (Optional) The name of the new static.
 -- @return Wrapper.Static#STATIC The static spawned.
@@ -459,8 +503,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
 
@@ -513,6 +558,19 @@ function SPAWNSTATIC:_SpawnStatic(Template, CountryID)
     Template.mass=self.InitStaticCargoMass
   end
 
+    -- hiding options
+    if self.SpawnHiddenOnPlanner then
+      Template.hiddenOnPlanner=true
+    end
+
+    if self.SpawnHiddenOnMFD then
+      Template.hiddenOnMFD=true
+    end
+
+    if self.SpawnHiddenOnMap then
+      Template.hidden=self.SpawnHiddenOnMap
+    end
+
   if self.InitLinkUnit then
     Template.linkUnit=self.InitLinkUnit:GetID()
     Template.linkOffset=true
@@ -535,15 +593,17 @@ function SPAWNSTATIC:_SpawnStatic(Template, CountryID)
   -- Name of the spawned static.
   Template.name = self.InitStaticName or string.format("%s#%05d", self.SpawnTemplatePrefix, self.SpawnIndex)
 
-  -- Add and register the new static.
-  local mystatic=_DATABASE:AddStatic(Template.name)
-
-  -- Debug output.
-  self:T(Template)
-
   -- Add static to the game.
   local Static=nil  --DCS#StaticObject
 
+  if self.ValidateAndRepositionStatic then
+    local validPos = UTILS.ValidateAndRepositionStatic(CountryID, Template.category, Template.type, Template, Template.shape_name, self.ValidateAndRepositionStaticMaxRadius)
+    if validPos then
+        Template.x = validPos.x
+        Template.y = validPos.y
+    end
+  end
+
   if self.InitFarp then
 
     local TemplateGroup={}
@@ -555,6 +615,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})
@@ -562,7 +629,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 = {
@@ -577,13 +645,41 @@ function SPAWNSTATIC:_SpawnStatic(Template, CountryID)
     self:T("Spawning Static")
     self:T2({Template=Template})
     Static=coalition.addStaticObject(CountryID, Template)
+    
+    if Static then
+      self:T(string.format("Succesfully spawned static object \"%s\" ID=%d", Static:getName(), Static:getID()))
+      --[[
+      local static=StaticObject.getByName(Static:getName())
+      if static then
+        env.info(string.format("FF got static from StaticObject.getByName"))
+      else
+        env.error(string.format("FF error did NOT get static from StaticObject.getByName"))
+      end ]]      
+    else
+      self:E(string.format("ERROR: DCS static object \"%s\" is nil!", tostring(Template.name)))
+    end
   end
   
+  -- Add and register the new static.
+  local mystatic=_DATABASE:AddStatic(Template.name)
+  
   -- If there is a SpawnFunction hook defined, call it.
   if self.SpawnFunctionHook then
     -- 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))
+    self:ScheduleOnce(0.3, self.SpawnFunctionHook, mystatic, unpack(self.SpawnFunctionArguments))
+  end
+  
+  if self.StaticCopyFrom ~= nil then
+    mystatic.StaticCopyFrom = self.StaticCopyFrom
   end
 
+  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 )
+  
   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
 
 
@@ -213,7 +214,7 @@ end
 
 --- Returns if a PointVec3 is within the zone.
 -- @param #ZONE_BASE self
--- @param Core.Point#POINT_VEC3 PointVec3 The PointVec3 to test.
+-- @param Core.Point#COORDINATE PointVec3 The PointVec3 to test.
 -- @return #boolean true if the PointVec3 is within the zone.
 function ZONE_BASE:IsPointVec3InZone( PointVec3 )
   local InZone = self:IsPointVec2InZone( PointVec3 )
@@ -227,16 +228,16 @@ function ZONE_BASE:GetVec2()
   return nil
 end
 
---- Returns a @{Core.Point#POINT_VEC2} of the zone.
+--- Returns a @{Core.Point#COORDINATE} of the zone.
 -- @param #ZONE_BASE self
 -- @param DCS#Distance Height The height to add to the land height where the center of the zone is located.
--- @return Core.Point#POINT_VEC2 The PointVec2 of the zone.
+-- @return Core.Point#COORDINATE The COORDINATE of the zone.
 function ZONE_BASE:GetPointVec2()
   --self:F2( self.ZoneName )
 
   local Vec2 = self:GetVec2()
 
-  local PointVec2 = POINT_VEC2:NewFromVec2( Vec2 )
+  local PointVec2 = COORDINATE:NewFromVec2( Vec2 )
 
   --self:T2( { PointVec2 } )
 
@@ -261,16 +262,16 @@ function ZONE_BASE:GetVec3( Height )
   return Vec3
 end
 
---- Returns a @{Core.Point#POINT_VEC3} of the zone.
+--- Returns a @{Core.Point#COORDINATE} of the zone.
 -- @param #ZONE_BASE self
 -- @param DCS#Distance Height The height to add to the land height where the center of the zone is located.
--- @return Core.Point#POINT_VEC3 The PointVec3 of the zone.
+-- @return Core.Point#COORDINATE The PointVec3 of the zone.
 function ZONE_BASE:GetPointVec3( Height )
   --self:F2( self.ZoneName )
 
   local Vec3 = self:GetVec3( Height )
 
-  local PointVec3 = POINT_VEC3:NewFromVec3( Vec3 )
+  local PointVec3 = COORDINATE:NewFromVec3( Vec3 )
 
   --self:T2( { PointVec3 } )
 
@@ -330,16 +331,16 @@ function ZONE_BASE:GetRandomVec2()
   return nil
 end
 
---- Define a random @{Core.Point#POINT_VEC2} within the zone. Note that this is actually a @{Core.Point#COORDINATE} type object, and not a simple Vec2 table.
+--- Define a random @{Core.Point#COORDINATE} within the zone. Note that this is actually a @{Core.Point#COORDINATE} type object, and not a simple Vec2 table.
 -- @param #ZONE_BASE self
--- @return Core.Point#POINT_VEC2 The PointVec2 coordinates.
+-- @return Core.Point#COORDINATE The COORDINATE coordinates.
 function ZONE_BASE:GetRandomPointVec2()
   return nil
 end
 
---- Define a random @{Core.Point#POINT_VEC3} within the zone. Note that this is actually a @{Core.Point#COORDINATE} type object, and not a simple Vec3 table.
+--- Define a random @{Core.Point#COORDINATE} within the zone. Note that this is actually a @{Core.Point#COORDINATE} type object, and not a simple Vec3 table.
 -- @param #ZONE_BASE self
--- @return Core.Point#POINT_VEC3 The PointVec3 coordinates.
+-- @return Core.Point#COORDINATE The COORDINATE coordinates.
 function ZONE_BASE:GetRandomPointVec3()
   return nil
 end
@@ -534,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.
@@ -599,16 +613,21 @@ 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")
   self:AddTransition("TriggerStopped","TriggerStart","TriggerRunning")
   self:AddTransition("*","EnteredZone","*")
   self:AddTransition("*","LeftZone","*")
+  self:AddTransition("*","ZoneEmpty","*")
+  self:AddTransition("*","ObjectDead","*")
   self:AddTransition("*","TriggerRunCheck","*")
   self:AddTransition("*","TriggerStop","TriggerStopped")
   self:TriggerStart()
   self.checkobjects = Objects
+  self.ObjectsInZone = false
   if UTILS.IsInstanceOf(Objects,"SET_BASE") then
     self.objectset = Objects.Set
   else
@@ -646,8 +665,34 @@ function ZONE_BASE:Trigger(Objects)
   -- @param #string Event Event.
   -- @param #string To To state.
   -- @param Wrapper.Controllable#CONTROLLABLE Controllable The controllable leaving the zone.
+  
+  --- On After "ObjectDead" event. An observed object has left the zone.
+  -- @function [parent=#ZONE_BASE] OnAfterObjectDead
+  -- @param #ZONE_BASE self
+  -- @param #string From From state.
+  -- @param #string Event Event.
+  -- @param #string To To state.
+  -- @param Wrapper.Controllable#CONTROLLABLE Controllable The controllable which died. Might be nil.
+  
+  --- On After "ZoneEmpty" event. All observed objects have left the zone or are dead.
+  -- @function [parent=#ZONE_BASE] OnAfterZoneEmpty
+  -- @param #ZONE_BASE self
+  -- @param #string From From state.
+  -- @param #string Event Event.
+  -- @param #string To To state.
+  
 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
@@ -659,9 +704,13 @@ function ZONE_BASE:_TriggerCheck(fromstart)
     -- just earmark everyone in/out
     for _,_object in pairs(objectset) do
       local obj = _object -- Wrapper.Controllable#CONTROLLABLE
-      if not obj.TriggerInZone then obj.TriggerInZone = {} end
+      if not obj.TriggerInZone then 
+        obj.TriggerInZone = {}
+        obj.TriggerZoneDeadNotification = false 
+      end
       if obj and obj:IsAlive() and self:IsCoordinateInZone(obj:GetCoordinate()) then
         obj.TriggerInZone[self.ZoneName] = true
+        self.ObjectsInZone = true
       else
         obj.TriggerInZone[self.ZoneName] = false
       end
@@ -669,6 +718,7 @@ function ZONE_BASE:_TriggerCheck(fromstart)
     end
   else
     -- Check for changes
+    local objcount = 0
     for _,_object in pairs(objectset) do
       local obj = _object -- Wrapper.Controllable#CONTROLLABLE
       if obj and obj:IsAlive() then
@@ -681,13 +731,27 @@ 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
+          objcount = objcount + 1
+          self.ObjectsInZone = true
+          obj.TriggerZoneDeadNotification = false
+        end
         if inzone and not obj.TriggerInZone[self.ZoneName] then
           -- wasn't in zone before
           --self:I("Newly entered")
           self:__EnteredZone(0.5,obj)
           obj.TriggerInZone[self.ZoneName] = true
+          objcount = objcount + 1
+          self.ObjectsInZone = true
+          obj.TriggerZoneDeadNotification = false
         elseif (not inzone) and obj.TriggerInZone[self.ZoneName] then
           -- has left the zone
           --self:I("Newly left")
@@ -696,8 +760,21 @@ function ZONE_BASE:_TriggerCheck(fromstart)
         else
           --self:I("Not left or not entered, or something went wrong!")
         end
+      else
+        -- object dead
+        if not obj.TriggerZoneDeadNotification == true then
+          obj.TriggerInZone = nil
+          self:__ObjectDead(0.5,obj)
+          obj.TriggerZoneDeadNotification = true
+        end
       end
     end
+    -- zone empty?
+    if objcount == 0 and self.ObjectsInZone == true then
+      -- zone was not but is now empty
+      self.ObjectsInZone = false
+      self:__ZoneEmpty(0.5)
+    end
   end
   return self
 end
@@ -706,7 +783,7 @@ end
 -- @param #ZONE_BASE self
 -- @param #string From
 -- @param #string Event
--- @param #string to
+-- @param #string To
 -- @return #ZONE_BASE self
 function ZONE_BASE:onafterTriggerRunCheck(From,Event,To)
   if self:GetState() ~= "TriggerStopped" then
@@ -768,8 +845,8 @@ end
 -- Various functions exist to find random points within the zone.
 --
 --   * @{#ZONE_RADIUS.GetRandomVec2}(): Gets a random 2D point in the zone.
---   * @{#ZONE_RADIUS.GetRandomPointVec2}(): Gets a @{Core.Point#POINT_VEC2} object representing a random 2D point in the zone.
---   * @{#ZONE_RADIUS.GetRandomPointVec3}(): Gets a @{Core.Point#POINT_VEC3} object representing a random 3D point in the zone. Note that the height of the point is at landheight.
+--   * @{#ZONE_RADIUS.GetRandomPointVec2}(): Gets a @{Core.Point#COORDINATE} object representing a random 2D point in the zone.
+--   * @{#ZONE_RADIUS.GetRandomPointVec3}(): Gets a @{Core.Point#COORDINATE} object representing a random 3D point in the zone. Note that the height of the point is at landheight.
 --
 -- ## Draw zone
 --
@@ -964,7 +1041,7 @@ function ZONE_RADIUS:SmokeZone( SmokeColor, Points, AddHeight, AngleOffset )
     local Radial = ( Angle + AngleOffset ) * RadialBase / 360
     Point.x = Vec2.x + math.cos( Radial ) * self:GetRadius()
     Point.y = Vec2.y + math.sin( Radial ) * self:GetRadius()
-    POINT_VEC2:New( Point.x, Point.y, AddHeight ):Smoke( SmokeColor )
+    COORDINATE:New( Point.x, AddHeight, Point.y  ):Smoke( SmokeColor )
   end
 
   return self
@@ -994,7 +1071,7 @@ function ZONE_RADIUS:FlareZone( FlareColor, Points, Azimuth, AddHeight )
     local Radial = Angle * RadialBase / 360
     Point.x = Vec2.x + math.cos( Radial ) * self:GetRadius()
     Point.y = Vec2.y + math.sin( Radial ) * self:GetRadius()
-    POINT_VEC2:New( Point.x, Point.y, AddHeight ):Flare( FlareColor, Azimuth )
+    COORDINATE:New( Point.x, AddHeight, Point.y ):Flare( FlareColor, Azimuth )
   end
 
   return self
@@ -1081,17 +1158,17 @@ end
 --    myzone:Scan({Object.Category.UNIT},{Unit.Category.GROUND_UNIT})
 --    local IsAttacked = myzone:IsSomeInZoneOfCoalition( self.Coalition )
 function ZONE_RADIUS:Scan( ObjectCategories, UnitCategories )
-
+  
   self.ScanData = {}
   self.ScanData.Coalitions = {}
   self.ScanData.Scenery = {}
   self.ScanData.SceneryTable = {}
   self.ScanData.Units = {}
 
-  local ZoneCoord = self:GetCoordinate()
+  local ZoneCoord = self:GetCoordinate():SetAlt()
   local ZoneRadius = self:GetRadius()
 
-  --self:F({ZoneCoord = ZoneCoord, ZoneRadius = ZoneRadius, ZoneCoordLL = ZoneCoord:ToStringLLDMS()})
+  --self:I({x = ZoneCoord.x, y=ZoneCoord.y, z=ZoneCoord.z, ZoneRadius = ZoneRadius})
 
   local SphereSearch = {
     id = world.VolumeType.SPHERE,
@@ -1103,15 +1180,14 @@ function ZONE_RADIUS:Scan( ObjectCategories, UnitCategories )
 
   local function EvaluateZone( ZoneObject )
     --if ZoneObject:isExist() then --FF: isExist always returns false for SCENERY objects since DCS 2.2 and still in DCS 2.5
-    if ZoneObject then
+
+    if ZoneObject and self:IsVec3InZone(ZoneObject:getPoint()) then
 
       -- Get object category.
       local ObjectCategory = Object.getCategory(ZoneObject)
 
       if ( ObjectCategory == Object.Category.UNIT and ZoneObject:isExist() and ZoneObject:isActive() ) or (ObjectCategory == Object.Category.STATIC and ZoneObject:isExist()) then
 
-        local CoalitionDCSUnit = ZoneObject:getCoalition()
-
         local Include = false
         if not UnitCategories then
           -- Anything found is included.
@@ -1190,38 +1266,48 @@ end
 
 --- Get a set of scanned units.
 -- @param #ZONE_RADIUS self
+-- @param #number Coalition (optional) Filter for this coalition only.
 -- @return Core.Set#SET_UNIT Set of units and statics inside the zone.
-function ZONE_RADIUS:GetScannedSetUnit()
-
-  local SetUnit = SET_UNIT:New()
+function ZONE_RADIUS:GetScannedSetUnit(Coalition)
 
+  self.SetUnit = self.SetUnit or SET_UNIT:New()
+  self.SetUnit:Clear(false)
+  self.SetUnit.Set={}
+  
   if self.ScanData then
     for ObjectID, UnitObject in pairs( self.ScanData.Units ) do
       local UnitObject = UnitObject -- DCS#Unit
       if UnitObject:isExist() then
         local FoundUnit = UNIT:FindByName( UnitObject:getName() )
-        if FoundUnit then
-          SetUnit:AddUnit( FoundUnit )
+        local FoundCoalition = FoundUnit and FoundUnit:GetCoalition() or nil
+        local includeoncoalition = true
+        if Coalition ~= nil and FoundCoalition==Coalition then includeoncoalition = true else includeoncoalition = false end
+        if Coalition == nil then includeoncoalition = true end
+        --self:I(string.format("Unit name %s coalition %s filter coalition = %s include = %s",FoundUnit:GetName(),tostring(FoundCoalition),tostring(Coalition),tostring(includeoncoalition)))
+        if FoundUnit and includeoncoalition then
+          self.SetUnit:AddUnit( FoundUnit )
         else
           local FoundStatic = STATIC:FindByName( UnitObject:getName(), false )
           if FoundStatic then
-            SetUnit:AddUnit( FoundStatic )
+            self.SetUnit:AddUnit( FoundStatic )
           end
         end
       end
     end
   end
 
-  return SetUnit
+  return self.SetUnit
 end
 
 --- Get a set of scanned groups.
 -- @param #ZONE_RADIUS self
+-- @param #number Coalition (optional) Filter for this coalition only.
 -- @return Core.Set#SET_GROUP Set of groups.
-function ZONE_RADIUS:GetScannedSetGroup()
+function ZONE_RADIUS:GetScannedSetGroup(Coalition)
 
   self.ScanSetGroup=self.ScanSetGroup or SET_GROUP:New() --Core.Set#SET_GROUP
-
+  
+  self.ScanSetGroup:Clear(false)
   self.ScanSetGroup.Set={}
 
   if self.ScanData then
@@ -1230,7 +1316,12 @@ function ZONE_RADIUS:GetScannedSetGroup()
       if UnitObject:isExist() then
 
         local FoundUnit=UNIT:FindByName(UnitObject:getName())
-        if FoundUnit then
+        local FoundCoalition = FoundUnit and FoundUnit:GetCoalition() or nil
+        local includeoncoalition = true
+        if Coalition ~= nil and FoundCoalition==Coalition then includeoncoalition = true else includeoncoalition = false end
+        if Coalition == nil then includeoncoalition = true end
+        --self:I(string.format("Unit name %s coalition %s filter coalition = %s include = %s",FoundUnit:GetName(),tostring(FoundCoalition),tostring(Coalition),tostring(includeoncoalition)))
+        if FoundUnit and includeoncoalition then
           local group=FoundUnit:GetGroup()
           self.ScanSetGroup:AddGroup(group)
         end
@@ -1415,7 +1506,7 @@ function ZONE_RADIUS:SearchZone( EvaluateFunction, ObjectCategories )
     id = world.VolumeType.SPHERE,
       params = {
       point = ZoneCoord:GetVec3(),
-      radius = ZoneRadius / 2,
+      radius = ZoneRadius,
       }
     }
 
@@ -1463,6 +1554,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.
@@ -1474,6 +1585,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}
@@ -1515,15 +1630,15 @@ function ZONE_RADIUS:GetRandomVec2(inner, outer, surfacetypes)
   return point
 end
 
---- Returns a @{Core.Point#POINT_VEC2} object reflecting a random 2D location within the zone. Note that this is actually a @{Core.Point#COORDINATE} type object, and not a simple Vec2 table.
+--- Returns a @{Core.Point#COORDINATE} object reflecting a random 2D location within the zone. Note that this is actually a @{Core.Point#COORDINATE} type object, and not a simple Vec2 table.
 -- @param #ZONE_RADIUS self
 -- @param #number inner (optional) Minimal distance from the center of the zone. Default is 0.
 -- @param #number outer (optional) Maximal distance from the outer edge of the zone. Default is the radius of the zone.
--- @return Core.Point#POINT_VEC2 The @{Core.Point#POINT_VEC2} object reflecting the random 3D location within the zone.
+-- @return Core.Point#COORDINATE The @{Core.Point#COORDINATE} object reflecting the random 3D location within the zone.
 function ZONE_RADIUS:GetRandomPointVec2( inner, outer )
   --self:F( self.ZoneName, inner, outer )
 
-  local PointVec2 = POINT_VEC2:NewFromVec2( self:GetRandomVec2( inner, outer ) )
+  local PointVec2 = COORDINATE:NewFromVec2( self:GetRandomVec2( inner, outer ) )
 
   --self:T3( { PointVec2 } )
 
@@ -1546,15 +1661,15 @@ function ZONE_RADIUS:GetRandomVec3( inner, outer )
 end
 
 
---- Returns a @{Core.Point#POINT_VEC3} object reflecting a random 3D location within the zone. Note that this is actually a @{Core.Point#COORDINATE} type object, and not a simple Vec3 table.
+--- Returns a @{Core.Point#COORDINATE} object reflecting a random 3D location within the zone. Note that this is actually a @{Core.Point#COORDINATE} type object, and not a simple Vec3 table.
 -- @param #ZONE_RADIUS self
 -- @param #number inner (optional) Minimal distance from the center of the zone. Default is 0.
 -- @param #number outer (optional) Maximal distance from the outer edge of the zone. Default is the radius of the zone.
--- @return Core.Point#POINT_VEC3 The @{Core.Point#POINT_VEC3} object reflecting the random 3D location within the zone.
+-- @return Core.Point#COORDINATE The @{Core.Point#COORDINATE} object reflecting the random 3D location within the zone.
 function ZONE_RADIUS:GetRandomPointVec3( inner, outer )
   --self:F( self.ZoneName, inner, outer )
 
-  local PointVec3 = POINT_VEC3:NewFromVec2( self:GetRandomVec2( inner, outer ) )
+  local PointVec3 = COORDINATE:NewFromVec2( self:GetRandomVec2( inner, outer ) )
 
   --self:T3( { PointVec3 } )
 
@@ -1835,6 +1950,21 @@ function ZONE_UNIT:New( ZoneName, ZoneUNIT, Radius, Offset)
   return self
 end
 
+--- Updates the current location from a @{Wrapper.Group}.
+-- @param #ZONE_UNIT self
+-- @param Wrapper.Group#GROUP Group (optional) Update from this Unit, if nil, update from the UNIT this zone is based on.
+-- @return self
+function ZONE_UNIT:UpdateFromUnit(Unit)
+  if Unit and Unit:IsAlive() then
+    local vec2 = Unit:GetVec2()
+    self.LastVec2 = vec2
+  elseif self.ZoneUNIT and self.ZoneUNIT:IsAlive() then
+    local ZoneVec2 = self.ZoneUNIT:GetVec2()
+    self.LastVec2 = ZoneVec2
+  end
+  return self
+end
+
 
 --- Returns the current location of the @{Wrapper.Unit#UNIT}.
 -- @param #ZONE_UNIT self
@@ -1972,6 +2102,22 @@ function ZONE_GROUP:GetVec2()
   return ZoneVec2
 end
 
+--- Updates the current location from a @{Wrapper.Group}.
+-- @param #ZONE_GROUP self
+-- @param Wrapper.Group#GROUP Group (optional) Update from this Group, if nil, update from the GROUP this zone is based on.
+-- @return self
+function ZONE_GROUP:UpdateFromGroup(Group)
+  if Group and Group:IsAlive() then
+    local vec2 = Group:GetVec2()
+    self.Vec2 = vec2
+  elseif self._.ZoneGROUP and self._.ZoneGROUP:IsAlive() then
+    local ZoneVec2 = self._.ZoneGROUP:GetVec2()
+    self.Vec2 = ZoneVec2
+    self._.ZoneVec2Cache = ZoneVec2
+  end
+  return self
+end
+
 --- Returns a random location within the zone of the @{Wrapper.Group}.
 -- @param #ZONE_GROUP self
 -- @return DCS#Vec2 The random location of the zone based on the @{Wrapper.Group} location.
@@ -1990,15 +2136,15 @@ function ZONE_GROUP:GetRandomVec2()
   return Point
 end
 
---- Returns a @{Core.Point#POINT_VEC2} object reflecting a random 2D location within the zone. Note that this is actually a @{Core.Point#COORDINATE} type object, and not a simple Vec2 table.
+--- Returns a @{Core.Point#COORDINATE} object reflecting a random 2D location within the zone. Note that this is actually a @{Core.Point#COORDINATE} type object, and not a simple Vec2 table.
 -- @param #ZONE_GROUP self
 -- @param #number inner (optional) Minimal distance from the center of the zone. Default is 0.
 -- @param #number outer (optional) Maximal distance from the outer edge of the zone. Default is the radius of the zone.
--- @return Core.Point#POINT_VEC2 The @{Core.Point#POINT_VEC2} object reflecting the random 3D location within the zone.
+-- @return Core.Point#COORDINATE The @{Core.Point#COORDINATE} object reflecting the random 3D location within the zone.
 function ZONE_GROUP:GetRandomPointVec2( inner, outer )
   --self:F( self.ZoneName, inner, outer )
 
-  local PointVec2 = POINT_VEC2:NewFromVec2( self:GetRandomVec2() )
+  local PointVec2 = COORDINATE:NewFromVec2( self:GetRandomVec2() )
 
   --self:T3( { PointVec2 } )
 
@@ -2046,7 +2192,7 @@ function _ZONE_TRIANGLE:New(p1, p2, p3)
     end
 
     self.SurfaceArea = math.abs((p2.x - p1.x) * (p3.y - p1.y) - (p3.x - p1.x) * (p2.y - p1.y)) * 0.5
-
+    
     return self
 end
 
@@ -2054,7 +2200,7 @@ end
 -- @param #_ZONE_TRIANGLE self
 -- @param #table pt The point to check
 -- @param #table points (optional) The points of the triangle, or 3 other points if you're just using the TRIANGLE class without an object of it
--- @return #bool True if the point is contained, false otherwise
+-- @return #boolean True if the point is contained, false otherwise
 function _ZONE_TRIANGLE:ContainsPoint(pt, points)
     points = points or self.Points
 
@@ -2146,8 +2292,8 @@ end
 -- Various functions exist to find random points within the zone.
 --
 --   * @{#ZONE_POLYGON_BASE.GetRandomVec2}(): Gets a random 2D point in the zone.
---   * @{#ZONE_POLYGON_BASE.GetRandomPointVec2}(): Return a @{Core.Point#POINT_VEC2} object representing a random 2D point within the zone.
---   * @{#ZONE_POLYGON_BASE.GetRandomPointVec3}(): Return a @{Core.Point#POINT_VEC3} object representing a random 3D point at landheight within the zone.
+--   * @{#ZONE_POLYGON_BASE.GetRandomPointVec2}(): Return a @{Core.Point#COORDINATE} object representing a random 2D point within the zone.
+--   * @{#ZONE_POLYGON_BASE.GetRandomPointVec3}(): Return a @{Core.Point#COORDINATE} object representing a random 3D point at landheight within the zone.
 --
 -- ## Draw zone
 --
@@ -2441,6 +2587,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.
@@ -2563,7 +2729,7 @@ function ZONE_POLYGON_BASE:ReFill(Color,Alpha)
     self.FillTriangles = {}
   end
   -- refill
-  for _, triangle in pairs(self._Triangles) do
+  for _,triangle in pairs(self._Triangles) do
       local draw_ids = triangle:Fill(coalition,color,alpha,nil)
       self.FillTriangles = draw_ids
       table.combine(self.DrawID, draw_ids)
@@ -2723,7 +2889,7 @@ function ZONE_POLYGON_BASE:SmokeZone( SmokeColor, Segments )
     for Segment = 0, Segments do -- We divide each line in 5 segments and smoke a point on the line.
       local PointX = self._.Polygon[i].x + ( Segment * DeltaX / Segments )
       local PointY = self._.Polygon[i].y + ( Segment * DeltaY / Segments )
-      POINT_VEC2:New( PointX, PointY ):Smoke( SmokeColor )
+      COORDINATE:New( PointX, 0, PointY ):Smoke( SmokeColor )
     end
     j = i
     i = i + 1
@@ -2758,7 +2924,7 @@ function ZONE_POLYGON_BASE:FlareZone( FlareColor, Segments, Azimuth, AddHeight )
     for Segment = 0, Segments do -- We divide each line in 5 segments and smoke a point on the line.
       local PointX = self._.Polygon[i].x + ( Segment * DeltaX / Segments )
       local PointY = self._.Polygon[i].y + ( Segment * DeltaY / Segments )
-      POINT_VEC2:New( PointX, PointY, AddHeight ):Flare(FlareColor, Azimuth)
+      COORDINATE:New( PointX, AddHeight, PointY ):Flare(FlareColor, Azimuth)
     end
     j = i
     i = i + 1
@@ -2819,6 +2985,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
@@ -2834,26 +3005,26 @@ function ZONE_POLYGON_BASE:GetRandomVec2()
     end
 end
 
---- Return a @{Core.Point#POINT_VEC2} object representing a random 2D point at landheight within the zone. Note that this is actually a @{Core.Point#COORDINATE} type object, and not a simple Vec2 table.
+--- Return a @{Core.Point#COORDINATE} object representing a random 2D point at landheight within the zone. Note that this is actually a @{Core.Point#COORDINATE} type object, and not a simple Vec2 table.
 -- @param #ZONE_POLYGON_BASE self
--- @return @{Core.Point#POINT_VEC2}
+-- @return @{Core.Point#COORDINATE}
 function ZONE_POLYGON_BASE:GetRandomPointVec2()
   --self:F2()
 
-  local PointVec2 = POINT_VEC2:NewFromVec2( self:GetRandomVec2() )
+  local PointVec2 = COORDINATE:NewFromVec2( self:GetRandomVec2() )
 
   --self:T2( PointVec2 )
 
   return PointVec2
 end
 
---- Return a @{Core.Point#POINT_VEC3} object representing a random 3D point at landheight within the zone. Note that this is actually a @{Core.Point#COORDINATE} type object, and not a simple Vec3 table.
+--- Return a @{Core.Point#COORDINATE} object representing a random 3D point at landheight within the zone. Note that this is actually a @{Core.Point#COORDINATE} type object, and not a simple Vec3 table.
 -- @param #ZONE_POLYGON_BASE self
--- @return @{Core.Point#POINT_VEC3}
+-- @return @{Core.Point#COORDINATE}
 function ZONE_POLYGON_BASE:GetRandomPointVec3()
   --self:F2()
 
-  local PointVec3 = POINT_VEC3:NewFromVec2( self:GetRandomVec2() )
+  local PointVec3 = COORDINATE:NewFromVec2( self:GetRandomVec2() )
 
   --self:T2( PointVec3 )
 
@@ -3158,12 +3329,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()
 
@@ -3187,14 +3353,12 @@ function ZONE_POLYGON:Scan( ObjectCategories, UnitCategories )
 
   local function EvaluateZone( ZoneObject )
 
-    if ZoneObject then
+    if ZoneObject and self:IsVec3InZone(ZoneObject:getPoint()) then
 
       local ObjectCategory = Object.getCategory(ZoneObject)
 
       if ( ObjectCategory == Object.Category.UNIT and ZoneObject:isExist() and ZoneObject:isActive() ) or (ObjectCategory == Object.Category.STATIC and ZoneObject:isExist()) then
 
-        local CoalitionDCSUnit = ZoneObject:getCoalition()
-
         local Include = false
         if not UnitCategories then
           -- Anything found is included.
@@ -3226,13 +3390,13 @@ function ZONE_POLYGON:Scan( ObjectCategories, UnitCategories )
       end
 
       -- trying with box search
-      if ObjectCategory == Object.Category.SCENERY and self:IsVec3InZone(ZoneObject:getPoint()) then
+      if ObjectCategory == Object.Category.SCENERY then
         local SceneryType = ZoneObject:getTypeName()
         local SceneryName = ZoneObject:getName()
         self.ScanData.Scenery[SceneryType] = self.ScanData.Scenery[SceneryType] or {}
         self.ScanData.Scenery[SceneryType][SceneryName] = SCENERY:Register( SceneryName, ZoneObject )
         table.insert(self.ScanData.SceneryTable,self.ScanData.Scenery[SceneryType][SceneryName])
-        --self:T( { SCENERY =  self.ScanData.Scenery[SceneryType][SceneryName] } )
+        --self:I( { SCENERY =  self.ScanData.Scenery[SceneryType][SceneryName] } )
       end
 
     end
@@ -3536,7 +3700,37 @@ do -- ZONE_ELASTIC
 
     return self
   end
+  
+  --- Remove a vertex (point) from the polygon.
+  -- @param #ZONE_ELASTIC self
+  -- @param DCS#Vec2 Vec2 Point in 2D (with x and y coordinates).
+  -- @return #ZONE_ELASTIC self
+  function ZONE_ELASTIC:RemoveVertex2D(Vec2)
+    
+    local found = false
+    local findex = 0
+    for _id,_vec2 in pairs(self.points) do
+      if _vec2.x == Vec2.x and _vec2.y == Vec2.y then
+        found = true
+        findex = _id
+        break
+      end
+    end
+    
+    if found == true and findex >  0 then
+      table.remove(self.points,findex)
+    end
 
+    return self
+  end
+    
+  --- Remove a vertex (point) from the polygon.
+  -- @param #ZONE_ELASTIC self
+  -- @param DCS#Vec3 Vec3 Point in 3D (with x, y and z coordinates). Only the x and z coordinates are used.
+  -- @return #ZONE_ELASTIC self
+  function ZONE_ELASTIC:RemoveVertex3D(Vec3)
+    return self:RemoveVertex2D({x=Vec3.x, y=Vec3.z})
+  end
 
   --- Add a vertex (point) to the polygon.
   -- @param #ZONE_ELASTIC self
@@ -3574,7 +3768,7 @@ do -- ZONE_ELASTIC
 
     -- Debug info.
     --self:T(string.format("Updating ZONE_ELASTIC %s", tostring(self.ZoneName)))
-
+    
     -- Copy all points.
     local points=UTILS.DeepCopy(self.points or {})
 
@@ -3592,6 +3786,9 @@ do -- ZONE_ELASTIC
 
     -- Update polygon verticies from points.
     self._.Polygon=self:_ConvexHull(points)
+          
+    self._Triangles = self:_Triangulate()
+    self.SurfaceArea = self:_CalculateSurfaceArea()
 
     if Draw~=false then
       if self.DrawID or Draw==true then
@@ -3790,7 +3987,7 @@ end
 --- Checks if a point is contained within the oval.
 -- @param #ZONE_OVAL self
 -- @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 ZONE_OVAL:IsVec2InZone(vec2)
     local cos, sin = math.cos, math.sin
     local dx = vec2.x - self.CenterVec2.x
@@ -3852,18 +4049,18 @@ function ZONE_OVAL:GetRandomVec2()
     return {x=rx, y=ry}
 end
 
---- Define a random @{Core.Point#POINT_VEC2} within the zone. Note that this is actually a @{Core.Point#COORDINATE} type object, and not a simple Vec2 table.
+--- Define a random @{Core.Point#COORDINATE} within the zone. Note that this is actually a @{Core.Point#COORDINATE} type object, and not a simple Vec2 table.
 -- @param #ZONE_OVAL self
--- @return Core.Point#POINT_VEC2 The PointVec2 coordinates.
+-- @return Core.Point#COORDINATE The COORDINATE coordinates.
 function ZONE_OVAL:GetRandomPointVec2()
-    return POINT_VEC2:NewFromVec2(self:GetRandomVec2())
+    return COORDINATE:NewFromVec2(self:GetRandomVec2())
 end
 
---- Define a random @{Core.Point#POINT_VEC2} within the zone. Note that this is actually a @{Core.Point#COORDINATE} type object, and not a simple Vec3 table.
+--- Define a random @{Core.Point#COORDINATE} within the zone. Note that this is actually a @{Core.Point#COORDINATE} type object, and not a simple Vec3 table.
 -- @param #ZONE_OVAL self
--- @return Core.Point#POINT_VEC2 The PointVec2 coordinates.
+-- @return Core.Point#COORDINATE The COORDINATE coordinates.
 function ZONE_OVAL:GetRandomPointVec3()
-    return POINT_VEC3:NewFromVec3(self:GetRandomVec2())
+    return COORDINATE:NewFromVec3(self:GetRandomVec2())
 end
 
 --- Draw the zone on the F10 map.
@@ -4003,15 +4200,15 @@ do -- ZONE_AIRBASE
     return ZoneVec2
   end
 
-  --- Returns a @{Core.Point#POINT_VEC2} object reflecting a random 2D location within the zone. Note that this is actually a @{Core.Point#COORDINATE} type object, and not a simple Vec2 table.
+  --- Returns a @{Core.Point#COORDINATE} object reflecting a random 2D location within the zone. Note that this is actually a @{Core.Point#COORDINATE} type object, and not a simple Vec2 table.
   -- @param #ZONE_AIRBASE self
   -- @param #number inner (optional) Minimal distance from the center of the zone. Default is 0.
   -- @param #number outer (optional) Maximal distance from the outer edge of the zone. Default is the radius of the zone.
-  -- @return Core.Point#POINT_VEC2 The @{Core.Point#POINT_VEC2} object reflecting the random 3D location within the zone.
+  -- @return Core.Point#COORDINATE The @{Core.Point#COORDINATE} object reflecting the random 3D location within the zone.
   function ZONE_AIRBASE:GetRandomPointVec2( inner, outer )
     --self:F( self.ZoneName, inner, outer )
 
-    local PointVec2 = POINT_VEC2:NewFromVec2( self:GetRandomVec2() )
+    local PointVec2 = COORDINATE:NewFromVec2( self:GetRandomVec2() )
 
     --self:T3( { PointVec2 } )
 

Moose Development/Moose/Core/Zone_Detection.lua

@@ -107,7 +107,7 @@ function ZONE_DETECTION:SmokeZone( SmokeColor, Points, AddHeight, AngleOffset )
     local Radial = ( Angle + AngleOffset ) * RadialBase / 360
     Point.x = Vec2.x + math.cos( Radial ) * self:GetRadius()
     Point.y = Vec2.y + math.sin( Radial ) * self:GetRadius()
-    POINT_VEC2:New( Point.x, Point.y, AddHeight ):Smoke( SmokeColor )
+    COORDINATE:New( Point.x, AddHeight, Point.y):Smoke( SmokeColor )
   end
 
   return self
@@ -138,7 +138,7 @@ function ZONE_DETECTION:FlareZone( FlareColor, Points, Azimuth, AddHeight )
     local Radial = Angle * RadialBase / 360
     Point.x = Vec2.x + math.cos( Radial ) * self:GetRadius()
     Point.y = Vec2.y + math.sin( Radial ) * self:GetRadius()
-    POINT_VEC2:New( Point.x, Point.y, AddHeight ):Flare( FlareColor, Azimuth )
+    COORDINATE:New( Point.x, AddHeight, Point.y ):Flare( FlareColor, Azimuth )
   end
 
   return self
@@ -202,4 +202,3 @@ function ZONE_DETECTION:IsVec3InZone( Vec3 )
 
   return InZone
 end
-

Moose Development/Moose/DCS.lua

@@ -14,6 +14,7 @@ do -- world
   -- @field #world.event event [https://wiki.hoggitworld.com/view/DCS_enum_world](https://wiki.hoggitworld.com/view/DCS_enum_world)
   -- @field #world.BirthPlace BirthPlace The birthplace enumerator is used to define where an aircraft or helicopter has spawned in association with birth events.
   -- @field #world.VolumeType VolumeType The volumeType enumerator defines the types of 3d geometery used within the [world.searchObjects](https://wiki.hoggitworld.com/view/DCS_func_searchObjects) function.
+  -- @field #world.weather weather Weather functions for fog etc.
 
   --- The world singleton contains functions centered around two different but extremely useful functions.
   -- * Events and event handlers are all governed within world.
@@ -132,6 +133,36 @@ do -- world
   -- @function [parent=#world] getAirbases
   -- @param #number coalitionId The coalition side number ID. Default is all airbases are returned.
   -- @return #table Table of DCS airbase objects.
+
+
+  --- Weather functions.
+  -- @type world.weather
+
+  --- Fog animation data structure.
+  -- @type world.FogAnimation
+  -- @field #number time
+  -- @field #number visibility
+  -- @field #number thickness
+
+  --- Returns the current fog thickness.
+  -- @function [parent=#world.weather] getFogThickness Returns the fog thickness.
+  -- @return #number Fog thickness in meters. If there is no fog, zero is returned.
+
+  --- Sets the fog thickness instantly. Any current fog animation is discarded.
+  -- @function [parent=#world.weather] setFogThickness
+  -- @param #number thickness Fog thickness in meters. Set to zero to disable fog.
+
+  --- Returns the current fog visibility distance.
+  -- @function [parent=#world.weather] getFogVisibilityDistance Returns the current maximum visibility distance in meters. Returns zero if fog is not present.
+
+  --- Instantly sets the maximum visibility distance of fog at sea level when looking at the horizon. Any current fog animation is discarded. Set zero to disable the fog.
+  -- @function [parent=#world.weather] setFogVisibilityDistance
+  -- @param #number visibility Max fog visibility in meters. Set to zero to disable fog.
+
+  --- Sets fog animation keys. Time is set in seconds and relative to the current simulation time, where time=0 is the current moment. 
+  -- Time must be increasing. Previous animation is always discarded despite the data being correct.
+  -- @function [parent=#world.weather] setFogAnimation
+  -- @param #world.FogAnimation animation List of fog animations
  
 end -- world
 
@@ -167,7 +198,7 @@ end -- env
 
 do -- radio
 
-  ---@type radio
+  --@type radio
   -- @field #radio.modulation modulation
   
   ---
@@ -407,7 +438,7 @@ do -- coalition
   -- @param #table groupData Group data table.
   -- @return DCS#Group The spawned Group object.
 
-  --- Dynamically spawns a static object. See [hoggit](https://wiki.hoggitworld.com/view/DCS_func_addGroup)
+  --- Dynamically spawns a static object. See [hoggit](https://wiki.hoggitworld.com/view/DCS_func_addStaticObject)
   -- @function [parent=#coalition] addStaticObject
   -- @param #number countryId Id of the country.
   -- @param #table groupData Group data table.
@@ -420,6 +451,7 @@ end -- coalition
 
 do -- Types
 
+  --- Descriptors.
   -- @type Desc
   -- @field #number speedMax0 Max speed in meters/second at zero altitude.
   -- @field #number massEmpty Empty mass in kg.
@@ -598,9 +630,13 @@ do -- Object
   --- @function [parent=#Object] destroy
   -- @param #Object self
   
-  --- @function [parent=#Object] getCategory
+  --- Returns an enumerator of the category for the specific object. 
+  -- The enumerator returned is dependent on the category of the object and how the function is called. 
+  -- As of DCS 2.9.2 when this function is called on an Object, Unit, Weapon, or Airbase a 2nd value will be returned which details the object sub-category value.
+  -- @function [parent=#Object] getCategory
   -- @param #Object self
-  -- @return #Object.Category
+  -- @return #Object.Category The object category (1=UNIT, 2=WEAPON, 3=STATIC, 4=BASE, 5=SCENERY, 6=Cargo)
+  -- @return #number The subcategory of the passed object, e.g. Unit.Category if a unit object was passed.
   
   --- Returns type name of the Object.
   -- @function [parent=#Object] getTypeName
@@ -1013,14 +1049,16 @@ do -- Spot
 end -- Spot
 
 do -- Controller
+
   --- Controller is an object that performs A.I.-tasks. Other words controller is an instance of A.I.. Controller stores current main task, active enroute tasks and behavior options. Controller performs commands. Please, read DCS A-10C GUI Manual EN.pdf chapter "Task Planning for Unit Groups", page 91 to understand A.I. system of DCS:A-10C. 
   -- 
   -- This class has 2 types of functions:
   -- 
   -- * Tasks
-  -- * Commands: Commands are instant actions those required zero time to perform. Commands may be used both for control unit/group behavior and control game mechanics. 
+  -- * Commands: Commands are instant actions those required zero time to perform. Commands may be used both for control unit/group behavior and control game mechanics.
+  -- 
   -- @type Controller
-  -- @field #Controller.Detection Detection Enum contains identifiers of surface types. 
+  -- @field #Controller.Detection Detection Enum contains identifiers of surface types.
   
   --- Enables and disables the controller.
   -- Note: Now it works only for ground / naval groups!
@@ -1079,18 +1117,18 @@ do -- Controller
   
   -- Detection
   
-  --- Enum contains identifiers of surface types. 
+  --- Enum containing detection types.
   -- @type Controller.Detection
-  -- @field VISUAL
-  -- @field OPTIC
-  -- @field RADAR
-  -- @field IRST
-  -- @field RWR
-  -- @field DLINK
+  -- @field #number VISUAL Visual detection. Numeric value 1.
+  -- @field #number OPTIC Optical detection. Numeric value 2.
+  -- @field #number RADAR Radar detection. Numeric value 4.
+  -- @field #number IRST Infra-red search and track detection. Numeric value 8.
+  -- @field #number RWR Radar Warning Receiver detection. Numeric value 16.
+  -- @field #number DLINK Data link detection. Numeric value 32.
   
   --- Detected target. 
-  -- @type DetectedTarget
-  -- @field Wrapper.Object#Object object The target
+  -- @type Controller.DetectedTarget
+  -- @field DCS#Object object The target
   -- @field #boolean visible The target is visible
   -- @field #boolean type The target type is known
   -- @field #boolean distance Distance to the target is known
@@ -1103,9 +1141,9 @@ do -- Controller
   -- @param #Controller.Detection detection Controller.Detection detection1, Controller.Detection detection2, ... Controller.Detection detectionN 
   -- @return #boolean detected True if the target is detected. 
   -- @return #boolean visible Has effect only if detected is true. True if the target is visible now. 
+  -- @return #boolean type Has effect only if detected is true. True if the target type is known.
+  -- @return #boolean distance Has effect only if detected is true. True if the distance to the target is known.
   -- @return #ModelTime lastTime Has effect only if visible is false. Last time when target was seen. 
-  -- @return #boolean type Has effect only if detected is true. True if the target type is known. 
-  -- @return #boolean distance Has effect only if detected is true. True if the distance to the target is known. 
   -- @return #Vec3 lastPos Has effect only if visible is false. Last position of the target when it was seen. 
   -- @return #Vec3 lastVel Has effect only if visible is false. Last velocity of the target when it was seen. 
   
@@ -1131,6 +1169,7 @@ end -- Controller
 
 do -- Unit
 
+  --- Unit.
   -- @type Unit
   -- @extends #CoalitionObject
   -- @field ID Identifier of an unit. It assigned to an unit by the Mission Editor automatically. 

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/ATC_Ground.lua

@@ -18,7 +18,7 @@
 -- ### Author: FlightControl - Framework Design &  Programming
 -- ### Refactoring to use the Runway auto-detection: Applevangelist
 -- @date August 2022
--- Last Update Nov 2023
+-- Last Update Feb 2025
 --
 -- ===
 -- 
@@ -416,7 +416,7 @@ end
 -- @field #ATC_GROUND_UNIVERSAL
 ATC_GROUND_UNIVERSAL = {
   ClassName = "ATC_GROUND_UNIVERSAL",
-  Version = "0.0.1",
+  Version = "0.0.2",
   SetClient = nil,
   Airbases = nil,
   AirbaseList = nil,
@@ -441,17 +441,25 @@ function ATC_GROUND_UNIVERSAL:New(AirbaseList)
   self:T( { self.ClassName } )
 
   self.Airbases = {}
-
-  for _name,_ in pairs(_DATABASE.AIRBASES) do
-    self.Airbases[_name]={}  
-  end
   
   self.AirbaseList = AirbaseList
   
   if not self.AirbaseList then
     self.AirbaseList = {}
-    for _name,_ in pairs(_DATABASE.AIRBASES) do
-      self.AirbaseList[_name]=_name 
+    for _name,_base in pairs(_DATABASE.AIRBASES) do
+      -- DONE exclude FARPS and Ships
+      if _base and _base.isAirdrome == true then
+        self.AirbaseList[_name]=_name
+        self.Airbases[_name]={}
+      end
+    end
+  else
+    for _,_name in pairs(AirbaseList) do
+      -- DONE exclude FARPS and Ships
+      local airbase = _DATABASE:FindAirbase(_name)
+      if airbase and (airbase.isAirdrome == true) then
+        self.Airbases[_name]={} 
+      end 
     end
   end
   
@@ -721,14 +729,18 @@ function ATC_GROUND_UNIVERSAL:_AirbaseMonitor()
 
             if NotInRunwayZone then
               
+              local Taxi = Client:GetState( self, "Taxi" )
+              
               if IsOnGround then
-                local Taxi = Client:GetState( self, "Taxi" )
+                
                 self:T( Taxi )
                 if Taxi == false then
                   local Velocity = VELOCITY:New( AirbaseMeta.KickSpeed or self.KickSpeed )
                   Client:Message( "Welcome to " .. AirbaseID .. ". The maximum taxiing speed is " .. 
                                   Velocity:ToString() , 20, "ATC" )
                   Client:SetState( self, "Taxi", true )
+                  Client:SetState( self, "Speeding", false )
+                  Client:SetState( self, "Warnings", 0 )
                 end
   
                 -- TODO: GetVelocityKMH function usage
@@ -737,7 +749,7 @@ function ATC_GROUND_UNIVERSAL:_AirbaseMonitor()
                 local IsAboveRunway = Client:IsAboveRunway()
                 self:T( {IsAboveRunway, IsOnGround, Velocity:Get() })
   
-                if IsOnGround then
+                if IsOnGround and not Taxi then
                   local Speeding = false
                   if AirbaseMeta.MaximumKickSpeed then 
                     if Velocity:Get() > AirbaseMeta.MaximumKickSpeed then
@@ -749,15 +761,17 @@ function ATC_GROUND_UNIVERSAL:_AirbaseMonitor()
                     end
                   end
                   if Speeding == true then
-                    MESSAGE:New( "Penalty! Player " .. Client:GetPlayerName() .. 
-                                 " has been kicked, due to a severe airbase traffic rule violation ...", 10, "ATC" ):ToAll()
-                    Client:Destroy()
-                    Client:SetState( self, "Speeding", false )
-                    Client:SetState( self, "Warnings", 0 )
+                    --MESSAGE:New( "Penalty! Player " .. Client:GetPlayerName() .. 
+                    --             " has been kicked, due to a severe airbase traffic rule violation ...", 10, "ATC" ):ToAll()
+                    --Client:Destroy()
+                    Client:SetState( self, "Speeding", true )
+                    local SpeedingWarnings = Client:GetState( self, "Warnings" )
+                    Client:SetState( self, "Warnings", SpeedingWarnings + 1 )
+                    Client:Message( "Warning " .. SpeedingWarnings .. "/3! Airbase traffic rule violation! Slow down now! Your speed is " .. 
+                                        Velocity:ToString(), 5, "ATC" )
                   end
                 end                  
-                  
-  
+           
                 if IsOnGround then
   
                   local Speeding = false
@@ -1035,23 +1049,23 @@ end
 -- The following airbases are monitored at the Nevada region.
 -- Use the @{Wrapper.Airbase#AIRBASE.Nevada} enumeration to select the airbases to be monitored.
 -- 
---    * `AIRBASE.Nevada.Beatty_Airport`
---    * `AIRBASE.Nevada.Boulder_City_Airport`
---    * `AIRBASE.Nevada.Creech_AFB`
+--    * `AIRBASE.Nevada.Beatty`
+--    * `AIRBASE.Nevada.Boulder_City`
+--    * `AIRBASE.Nevada.Creech`
 --    * `AIRBASE.Nevada.Echo_Bay`
---    * `AIRBASE.Nevada.Groom_Lake_AFB`
---    * `AIRBASE.Nevada.Henderson_Executive_Airport`
---    * `AIRBASE.Nevada.Jean_Airport`
---    * `AIRBASE.Nevada.Laughlin_Airport`
+--    * `AIRBASE.Nevada.Groom_Lake`
+--    * `AIRBASE.Nevada.Henderson_Executive`
+--    * `AIRBASE.Nevada.Jean`
+--    * `AIRBASE.Nevada.Laughlin`
 --    * `AIRBASE.Nevada.Lincoln_County`
---    * `AIRBASE.Nevada.McCarran_International_Airport`
+--    * `AIRBASE.Nevada.McCarran_International`
 --    * `AIRBASE.Nevada.Mesquite`
---    * `AIRBASE.Nevada.Mina_Airport`
---    * `AIRBASE.Nevada.Nellis_AFB`
+--    * `AIRBASE.Nevada.Mina`
+--    * `AIRBASE.Nevada.Nellis`
 --    * `AIRBASE.Nevada.North_Las_Vegas`
---    * `AIRBASE.Nevada.Pahute_Mesa_Airstrip`
---    * `AIRBASE.Nevada.Tonopah_Airport`
---    * `AIRBASE.Nevada.Tonopah_Test_Range_Airfield`
+--    * `AIRBASE.Nevada.Pahute_Mesa`
+--    * `AIRBASE.Nevada.Tonopah`
+--    * `AIRBASE.Nevada.Tonopah_Test_Range`
 --
 -- # Installation
 -- 
@@ -1088,10 +1102,10 @@ end
 --    
 --     -- Monitor specific airbases.
 --     ATC_Ground = ATC_GROUND_NEVADA:New(              
---       { AIRBASE.Nevada.Laughlin_Airport,                        
+--       { AIRBASE.Nevada.Laughlin,                        
 --         AIRBASE.Nevada.Lincoln_County,               
 --         AIRBASE.Nevada.North_Las_Vegas,              
---         AIRBASE.Nevada.McCarran_International_Airport
+--         AIRBASE.Nevada.McCarran_International
 --       }                                              
 --     )                                                
 -- 
@@ -1330,33 +1344,33 @@ end
 -- The following airbases are monitored at the PersianGulf region.
 -- Use the @{Wrapper.Airbase#AIRBASE.PersianGulf} enumeration to select the airbases to be monitored.
 -- 
---   * `AIRBASE.PersianGulf.Abu_Musa_Island_Airport`
---   * `AIRBASE.PersianGulf.Al_Dhafra_AB`
+--   * `AIRBASE.PersianGulf.Abu_Musa_Island`
+--   * `AIRBASE.PersianGulf.Al_Dhafra_AFB`
 --   * `AIRBASE.PersianGulf.Al_Maktoum_Intl`
---   * `AIRBASE.PersianGulf.Al_Minhad_AB`
+--   * `AIRBASE.PersianGulf.Al_Minhad_AFB`
 --   * `AIRBASE.PersianGulf.Bandar_Abbas_Intl`
 --   * `AIRBASE.PersianGulf.Bandar_Lengeh`
 --   * `AIRBASE.PersianGulf.Dubai_Intl`
 --   * `AIRBASE.PersianGulf.Fujairah_Intl`
 --   * `AIRBASE.PersianGulf.Havadarya`
---   * `AIRBASE.PersianGulf.Kerman_Airport`
+--   * `AIRBASE.PersianGulf.Kerman`
 --   * `AIRBASE.PersianGulf.Khasab`
---   * `AIRBASE.PersianGulf.Lar_Airbase`
+--   * `AIRBASE.PersianGulf.Lar`
 --   * `AIRBASE.PersianGulf.Qeshm_Island`
 --   * `AIRBASE.PersianGulf.Sharjah_Intl`
---   * `AIRBASE.PersianGulf.Shiraz_International_Airport`
+--   * `AIRBASE.PersianGulf.Shiraz_Intl`
 --   * `AIRBASE.PersianGulf.Sir_Abu_Nuayr`
 --   * `AIRBASE.PersianGulf.Sirri_Island`
 --   * `AIRBASE.PersianGulf.Tunb_Island_AFB`
 --   * `AIRBASE.PersianGulf.Tunb_Kochak`
---   * `AIRBASE.PersianGulf.Sas_Al_Nakheel_Airport`
---   * `AIRBASE.PersianGulf.Bandar_e_Jask_airfield`
---   * `AIRBASE.PersianGulf.Abu_Dhabi_International_Airport`
---   * `AIRBASE.PersianGulf.Al_Bateen_Airport`
---   * `AIRBASE.PersianGulf.Kish_International_Airport`
---   * `AIRBASE.PersianGulf.Al_Ain_International_Airport`
---   * `AIRBASE.PersianGulf.Lavan_Island_Airport`
---   * `AIRBASE.PersianGulf.Jiroft_Airport`
+--   * `AIRBASE.PersianGulf.Sas_Al_Nakheel`
+--   * `AIRBASE.PersianGulf.Bandar_e_Jask`
+--   * `AIRBASE.PersianGulf.Abu_Dhabi_Intl`
+--   * `AIRBASE.PersianGulf.Al_Bateen`
+--   * `AIRBASE.PersianGulf.Kish_Intl`
+--   * `AIRBASE.PersianGulf.Al_Ain_Intl`
+--   * `AIRBASE.PersianGulf.Lavan_Island`
+--   * `AIRBASE.PersianGulf.Jiroft`
 --
 -- # Installation
 -- 
@@ -1391,8 +1405,8 @@ end
 --     AirbasePoliceCaucasus = ATC_GROUND_PERSIANGULF:New()
 --     
 --     ATC_Ground = ATC_GROUND_PERSIANGULF:New( 
---       { AIRBASE.PersianGulf.Kerman_Airport,
---         AIRBASE.PersianGulf.Al_Minhad_AB 
+--       { AIRBASE.PersianGulf.Kerman,
+--         AIRBASE.PersianGulf.Al_Minhad_AFB 
 --       } 
 --     )
 -- 
@@ -1441,11 +1455,10 @@ function ATC_GROUND_PERSIANGULF:Start( RepeatScanSeconds )
   self.AirbaseMonitor = SCHEDULER:New( self, self._AirbaseMonitor, { self }, 0, RepeatScanSeconds )
 end
           
-
- -- @type ATC_GROUND_MARIANAISLANDS
+---
+-- @type ATC_GROUND_MARIANAISLANDS
 -- @extends #ATC_GROUND
 
-     
 
 --- # ATC\_GROUND\_MARIANA, extends @{#ATC_GROUND}
 -- 

Moose Development/Moose/Functional/Artillery.lua

@@ -27,7 +27,7 @@
 --
 -- ### Author: **funkyfranky**
 --
--- ### Contributions: FlightControl
+-- ### Contributions: FlightControl, Applevangelist
 --
 -- ====
 -- @module Functional.Artillery
@@ -619,63 +619,148 @@ ARTY.WeaponType={
 }
 
 --- Database of common artillery unit properties.
+-- @type ARTY.dbitem
+-- @field #string displayname Name displayed in ME.
+-- @field #number minrange Minimum firing range in meters.
+-- @field #number maxrange Maximum firing range in meters.
+-- @field #number reloadtime Reload time in seconds.
+
+--- Database of common artillery unit properties.
+-- Table key is the "type name" and table value is and `ARTY.dbitem`.
 -- @type ARTY.db
 ARTY.db={
-  ["2B11 mortar"] = {  -- type "2B11 mortar"
-    minrange   = 500,  -- correct?
-    maxrange   = 7000, -- 7 km
-    reloadtime = 30,   -- 30 sec
+  ["LeFH_18-40-105"] = {
+    displayname = "FH LeFH-18 105mm", -- name displayed in the ME
+    minrange    = 500,                -- min range (green circle) in meters
+    maxrange    = 10500,              -- max range (red circle) in meters
+    reloadtime  = nil,                -- reload time in seconds
   },
-  ["SPH 2S1 Gvozdika"] = { -- type "SAU Gvozdika"
-    minrange   = 300,      -- correct?
-    maxrange   = 15000,    -- 15 km
-    reloadtime = nil,      -- unknown
+  ["M2A1-105"] = {
+    displayname = "FH M2A1 105mm",
+    minrange    = 500,
+    maxrange    = 11500,
+    reloadtime  = nil,
   },
-  ["SPH 2S19 Msta"] = { --type "SAU Msta", alias "2S19 Msta"
-    minrange   = 300,     -- correct?
-    maxrange   = 23500,   -- 23.5 km
-    reloadtime = nil,     -- unknown
+  ["Pak40"] = {
+    displayname = "FH Pak 40 75mm",
+    minrange    = 500,
+    maxrange    = 3000,
+    reloadtime  = nil,
+  },      
+  ["L118_Unit"] = {
+    displayname = "L118 Light Artillery Gun",
+    minrange    = 500,
+    maxrange    = 17500,
+    reloadtime  = nil,
   },
-  ["SPH 2S3 Akatsia"] = { -- type "SAU Akatsia", alias "2S3 Akatsia"
-    minrange   = 300,   -- correct?
-    maxrange   = 17000, -- 17 km
-    reloadtime = nil,   -- unknown
+  ["Smerch"] = {
+    displayname = "MLRS 9A52 Smerch CM 300mm",
+    minrange    = 20000,
+    maxrange    = 70000,
+    reloadtime  = 2160,
   },
-  ["SPH 2S9 Nona"] = { --type "SAU 2-C9"
-    minrange   = 500,   -- correct?
-    maxrange   = 7000,  -- 7 km
-    reloadtime = nil,   -- unknown
+  ["Smerch_HE"] = {
+    displayname = "MLRS 9A52 Smerch HE 300mm",
+    minrange    = 20000,
+    maxrange    = 70000,
+    reloadtime  = 2160,
   },
-  ["SPH M109 Paladin"] = { -- type "M-109", alias "M109"
-    minrange   = 300,     -- correct?
-    maxrange   = 22000,   -- 22 km
-    reloadtime = nil,   -- unknown
+  ["Uragan_BM-27"] = {
+    displayname = "MLRS 9K57 Uragan BM-27 220mm",
+    minrange   = 11500,
+    maxrange   = 35800,
+    reloadtime = 840,
   },
-  ["SpGH Dana"] = {       -- type "SpGH_Dana"
-    minrange   = 300,     -- correct?
-    maxrange   = 18700,   -- 18.7 km
-    reloadtime = nil,     -- unknown
+  ["Grad-URAL"] = {
+    displayname = "MLRS BM-21 Grad 122mm",
+    minrange   = 5000,
+    maxrange   = 19000,
+    reloadtime = 420,
   },
-  ["MLRS BM-21 Grad"] = { --type "Grad-URAL", alias "MLRS BM-21 Grad"
-    minrange = 5000,  --  5 km
-    maxrange = 19000, -- 19 km
-    reloadtime = 420, -- 7 min
+  ["HL_B8M1"] = {
+    displayname = "MLRS HL with B8M1 80mm",
+    minrange   = 500,
+    maxrange   = 5000,
+    reloadtime = nil,
   },
-  ["MLRS 9K57 Uragan BM-27"] = { -- type "Uragan_BM-27"
-    minrange   = 11500, -- 11.5 km
-    maxrange   = 35800, -- 35.8 km
-    reloadtime = 840,   -- 14 min
+  ["tt_B8M1"] = {
+    displayname = "MLRS LC with B8M1 80mm",
+    minrange   = 500,
+    maxrange   = 5000,
+    reloadtime = nil,
   },
-  ["MLRS 9A52 Smerch"] = { -- type "Smerch"
-    minrange   = 20000, -- 20 km
-    maxrange   = 70000, -- 70 km
-    reloadtime = 2160,  -- 36 min
+  ["MLRS"] = {
+    displayname = "MLRS M270 227mm",
+    minrange   = 10000,
+    maxrange   = 32000,
+    reloadtime = 540,
   },
-  ["MLRS M270"] = { --type "MRLS", alias "M270 MRLS"
-    minrange   = 10000, -- 10 km
-    maxrange   = 32000, -- 32 km
-    reloadtime = 540,   -- 9 min
+  ["2B11 mortar"] = {
+    displayname = "Mortar 2B11 120mm", 
+    minrange    = 500,
+    maxrange    = 7000,
+    reloadtime  = 30,
   },
+  ["PLZ05"] = {
+    displayname = "PLZ-05", 
+    minrange    = 500,
+    maxrange    = 23500,
+    reloadtime  = nil,
+  },
+  ["SAU Gvozdika"] = {
+    displayname = "SPH 2S1 Gvozdika 122mm",
+    minrange    = 300,
+    maxrange    = 15000,
+    reloadtime  = nil,
+  },
+  ["SAU Msta"] = {
+    displayname = "SPH 2S19 Msta 152mm",
+    minrange    = 300,
+    maxrange    = 23500,
+    reloadtime  = nil,
+  },
+  ["SAU Akatsia"] = {
+    displayname = "SPH 2S3 Akatsia 152mm",
+    minrange    = 300,
+    maxrange    = 17000,
+    reloadtime  = nil,
+  },
+  ["SpGH_Dana"] = {
+    displayname = "SPH Dana vz77 152mm",
+    minrange    = 300,
+    maxrange    = 18700,
+    reloadtime  = nil,
+  },
+  ["M-109"] = {
+    displayname = "SPH M109 Paladin 155mm",
+    minrange    = 300,
+    maxrange    = 22000,
+    reloadtime  = nil,
+  }, 
+  ["M12_GMC"] = {
+    displayname = "SPH M12 GMC 155mm",
+    minrange    = 300,
+    maxrange    = 18200,
+    reloadtime  = nil,
+  },
+  ["Wespe124"] = {
+    displayname = "SPH Sd.Kfz.124 Wespe 105mm",
+    minrange    = 300,
+    maxrange    = 7000,
+    reloadtime  = nil,
+  },
+  ["T155_Firtina"] = {
+    displayname = "SPH T155 Firtina 155mm",
+    minrange    = 300,
+    maxrange    = 41000,
+    reloadtime  = nil,
+  },
+  ["SAU 2-C9"] = {
+    displayname = "SPM 2S9 Nona 120mm M",
+    minrange    = 500,
+    maxrange    = 7000,
+    reloadtime  = nil,
+  },  
 }
 
 --- Target.
@@ -695,7 +780,7 @@ ARTY.db={
 
 --- Arty script version.
 -- @field #string version
-ARTY.version="1.3.1"
+ARTY.version="1.3.4"
 
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
@@ -797,8 +882,8 @@ function ARTY:New(group, alias)
   -- Maximum speed in km/h.
   self.SpeedMax=group:GetSpeedMax()
 
-  -- Group is mobile or not (e.g. mortars).
-  if self.SpeedMax>1 then
+  -- Group is mobile or not (e.g. mortars). Some immobile units have a speed of 1 m/s = 3.6 km/h. So we check this number.
+  if self.SpeedMax>3.6 then
     self.ismobile=true
   else
     self.ismobile=false
@@ -1923,7 +2008,7 @@ function ARTY:onafterStart(Controllable, From, Event, To)
   end
 
   -- Check if we have and arty type that is in the DB.
-  local _dbproperties=self:_CheckDB(self.DisplayName)
+  local _dbproperties=self:_CheckDB(self.Type)
   self:T({dbproperties=_dbproperties})
   if _dbproperties~=nil then
     for property,value in pairs(_dbproperties) do
@@ -1969,8 +2054,8 @@ function ARTY:onafterStart(Controllable, From, Event, To)
   text=text..string.format("Type                = %s\n", self.Type)
   text=text..string.format("Display Name        = %s\n", self.DisplayName)
   text=text..string.format("Number of units     = %d\n", self.IniGroupStrength)
-  text=text..string.format("Speed max           = %d km/h\n", self.SpeedMax)
-  text=text..string.format("Speed default       = %d km/h\n", self.Speed)
+  text=text..string.format("Speed max           = %.1f km/h\n", self.SpeedMax)
+  text=text..string.format("Speed default       = %.1f km/h\n", self.Speed)
   text=text..string.format("Is mobile           = %s\n", tostring(self.ismobile))
   text=text..string.format("Is cargo            = %s\n", tostring(self.iscargo))
   text=text..string.format("Min range           = %.1f km\n", self.minrange/1000)
@@ -2183,7 +2268,7 @@ function ARTY._FuncTrack(weapon, self, target)
     if _dist<target.radius then
   
       -- Get random coordinate within a certain radius.
-      local _cr=_coord:GetRandomCoordinateInRadius(_data.target.radius)
+      local _cr=_coord:GetRandomCoordinateInRadius(target.radius)
   
       -- Fire smoke at this coordinate.
       _cr:Smoke(self.smokeColor)
@@ -3049,7 +3134,7 @@ function ARTY:onafterOpenFire(Controllable, From, Event, To, target)
   local nfire=Narty
   local _type="shots"
   if target.weapontype==ARTY.WeaponType.Auto then
-    nfire=Narty
+    nfire=Nammo  -- We take everything that is available
     _type="shots"
   elseif target.weapontype==ARTY.WeaponType.Cannon then
     nfire=Narty
@@ -3070,6 +3155,8 @@ function ARTY:onafterOpenFire(Controllable, From, Event, To, target)
     nfire=Nmissiles
     _type="cruise missiles"
   end
+  
+  --env.info(string.format("FF type=%s, Nrockets=%d, Nfire=%d target.nshells=%d", _type, Nrockets, nfire, target.nshells))
 
   -- Adjust if less than requested ammo is left.
   target.nshells=math.min(target.nshells, nfire)

Moose Development/Moose/Functional/Autolase.lua

@@ -74,7 +74,7 @@
 -- @image Designation.JPG
 --
 -- Date: 24 Oct 2021
--- Last Update: May 2024
+-- Last Update: Mar 2025
 --
 --- Class AUTOLASE
 -- @type AUTOLASE
@@ -89,6 +89,10 @@
 -- @field #table playermenus
 -- @field #boolean smokemenu
 -- @field #boolean threatmenu
+-- @field #number RoundingPrecision
+-- @field #table smokeoffset
+-- @field #boolean increasegroundawareness
+-- @field #number MonitorFrequency
 -- @extends Ops.Intel#INTEL
 
 ---
@@ -100,6 +104,9 @@ AUTOLASE = {
   alias = "",
   debug = false,
   smokemenu = true,
+  RoundingPrecision = 0,
+  increasegroundawareness = false,
+  MonitorFrequency = 30,
 }
 
 --- Laser spot info
@@ -118,7 +125,7 @@ AUTOLASE = {
 
 --- AUTOLASE class version.
 -- @field #string version
-AUTOLASE.version = "0.1.25"
+AUTOLASE.version = "0.1.31"
 
 -------------------------------------------------------------------
 -- Begin Functional.Autolase.lua
@@ -191,6 +198,7 @@ function AUTOLASE:New(RecceSet, Coalition, Alias, PilotSet)
   self.reporttimelong = 30
   self.smoketargets = false
   self.smokecolor = SMOKECOLOR.Red
+  self.smokeoffset = nil
   self.notifypilots = true
   self.targetsperrecce = {}
   self.RecceUnits = {}
@@ -207,6 +215,11 @@ function AUTOLASE:New(RecceSet, Coalition, Alias, PilotSet)
   self.playermenus = {}
   self.smokemenu = true
   self.threatmenu = true
+  self.RoundingPrecision = 0
+  self.increasegroundawareness = false
+  self.MonitorFrequency = 30
+  
+  self:EnableSmokeMenu({Angle=math.random(0,359),Distance=math.random(10,20)})
   
   -- Set some string id for output to DCS.log file.
   self.lid=string.format("AUTOLASE %s (%s) | ", self.alias, self.coalition and UTILS.GetCoalitionName(self.coalition) or "unknown")
@@ -309,16 +322,41 @@ end
 -- Helper Functions
 -------------------------------------------------------------------
 
+--- [User] When using Monitor, set the frequency here in which the report will appear
+-- @param #AUTOLASE self
+-- @param #number Seconds Run the report loop every number of seconds defined here.
+-- @return #AUTOLASE self
+function AUTOLASE:SetMonitorFrequency(Seconds)
+  self.MonitorFrequency = Seconds or 30
+  return self
+end
+
 --- [User] Set a table of possible laser codes.
--- Each new RECCE can select a code from this table, default is { 1688, 1130, 4785, 6547, 1465, 4578 } .
+-- Each new RECCE can select a code from this table, default is { 1688, 1130, 4785, 6547, 1465, 4578 }.
 -- @param #AUTOLASE self
 -- @param #list<#number> LaserCodes
--- @return #AUTOLASE
+-- @return #AUTOLASE self
 function AUTOLASE:SetLaserCodes( LaserCodes )
   self.LaserCodes = ( type( LaserCodes ) == "table" ) and LaserCodes or { LaserCodes }
   return self
 end
 
+--- [User] Improve ground unit detection by using a zone scan and LOS check.
+-- @param #AUTOLASE self
+-- @return #AUTOLASE self 
+function AUTOLASE:EnableImproveGroundUnitsDetection()
+  self.increasegroundawareness = true
+  return self
+end
+
+--- [User] Do not improve ground unit detection by using a zone scan and LOS check.
+-- @param #AUTOLASE self
+-- @return #AUTOLASE self 
+function AUTOLASE:DisableImproveGroundUnitsDetection()
+  self.increasegroundawareness = false
+  return self
+end
+
 --- (Internal) Function to set pilot menu.
 -- @param #AUTOLASE self
 -- @return #AUTOLASE self 
@@ -455,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
@@ -470,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"
@@ -600,11 +638,26 @@ function AUTOLASE:SetSmokeTargets(OnOff,Color)
   return self
 end
 
+--- (User) Function to set rounding precision for BR distance output.
+-- @param #AUTOLASE self
+-- @param #number IDP Rounding precision before/after the decimal sign. Defaults to zero. Positive values round right of the decimal sign, negative ones left of the decimal sign. 
+-- @return #AUTOLASE self 
+function AUTOLASE:SetRoundingPrecsion(IDP)
+  self.RoundingPrecision = IDP or 0
+  return self
+end
+
 --- (User) Show the "Switch smoke target..." menu entry for pilots. On by default.
 -- @param #AUTOLASE self
+-- @param #table Offset (Optional) Define an offset for the smoke, i.e. not directly on the unit itself, angle is degrees and distance is meters. E.g. `autolase:EnableSmokeMenu({Angle=30,Distance=20})`
 -- @return #AUTOLASE self 
-function AUTOLASE:EnableSmokeMenu()
+function AUTOLASE:EnableSmokeMenu(Offset)
   self.smokemenu = true
+  if Offset then
+    self.smokeoffset = {}
+    self.smokeoffset.Distance = Offset.Distance or math.random(10,20)
+    self.smokeoffset.Angle = Offset.Angle or math.random(0,359)
+  end
   return self
 end
 
@@ -613,6 +666,7 @@ end
 -- @return #AUTOLASE self 
 function AUTOLASE:DisableSmokeMenu()
   self.smokemenu = false
+  self.smokeoffset = nil
   return self
 end
 
@@ -639,7 +693,7 @@ end
 function AUTOLASE:GetLosFromUnit(Unit)
   local lasedistance = self.LaseDistance
   local unitheight = Unit:GetHeight()
-  local coord = Unit:GetCoordinate()
+  local coord = Unit:GetCoord()
   local landheight = coord:GetLandHeight()
   local asl = unitheight - landheight
   if asl > 100 then
@@ -671,7 +725,8 @@ function AUTOLASE:CleanCurrentLasing()
       local unit = recce:GetUnit(1)
       local name = unit:GetName()
       if not self.RecceUnits[name] then
-        self.RecceUnits[name] = { name=name, unit=unit, cooldown = false, timestamp = timer.getAbsTime() }
+        local isground = (unit and unit.IsGround) and unit:IsGround() or false
+        self.RecceUnits[name] = { name=name, unit=unit, cooldown = false, timestamp = timer.getAbsTime(), isground=isground }
       end
     end
   end
@@ -757,9 +812,11 @@ function AUTOLASE:ShowStatus(Group,Unit)
       end
       local code = self:GetLaserCode(unit:GetName())
       report:Add(string.format("Recce %s has code %d",name,code))
+      report:Add("---------------")
     end
   end
   report:Add(string.format("Lasing min threat level %d",self.minthreatlevel))
+  report:Add("---------------")
   local lines = 0
   for _ind,_entry in pairs(self.CurrentLasing) do
     local entry = _entry -- #AUTOLASE.LaserSpot
@@ -779,22 +836,28 @@ function AUTOLASE:ShowStatus(Group,Unit)
     if playername then
       local settings = _DATABASE:GetPlayerSettings(playername)
       if settings then
-        self:I("Get Settings ok!")
+        self:T("Get Settings ok!")
         if settings:IsA2G_MGRS() then
           locationstring = entry.coordinate:ToStringMGRS(settings)
         elseif settings:IsA2G_LL_DMS() then
           locationstring = entry.coordinate:ToStringLLDMS(settings)
+        elseif settings:IsA2G_LL_DDM() then
+         locationstring = entry.coordinate:ToStringLLDDM(settings)
         elseif settings:IsA2G_BR() then
-          locationstring = entry.coordinate:ToStringBR(Group:GetCoordinate() or Unit:GetCoordinate(),settings)
+          -- attention this is the distance from the ASKING unit to target, not from RECCE to target!
+          local startcoordinate = Unit:GetCoord() or Group:GetCoord()
+          locationstring = entry.coordinate:ToStringBR(startcoordinate,settings,false,self.RoundingPrecision)
         end
       end
     end
-    local text = string.format("%s lasing %s code %d\nat %s",reccename,typename,code,locationstring)
+    local text = string.format("+ %s lasing %s code %d\nat %s",reccename,typename,code,locationstring)
     report:Add(text)
+    report:Add("---------------")
     lines = lines + 1
   end
   if lines == 0 then
     report:Add("No targets!")
+    report:Add("---------------")
   end
   local reporttime = self.reporttimelong
   if lines == 0 then reporttime = self.reporttimeshort end
@@ -900,8 +963,8 @@ function AUTOLASE:CanLase(Recce,Unit)
       end
     end
     -- calculate LOS
-    local reccecoord = Recce:GetCoordinate()
-    local unitcoord = Unit:GetCoordinate()
+    local reccecoord = Recce:GetCoord()
+    local unitcoord = Unit:GetCoord()
     local islos = reccecoord:IsLOS(unitcoord,2.5)
     -- calculate distance
     local distance = math.floor(reccecoord:Get3DDistance(unitcoord))
@@ -913,6 +976,65 @@ function AUTOLASE:CanLase(Recce,Unit)
   return canlase
 end
 
+--- (Internal) Function to do a zone check per ground Recce and make found units and statics "known".
+-- @param #AUTOLASE self
+-- @return #AUTOLASE self 
+function AUTOLASE:_Prescient()
+  -- self.RecceUnits[name] = { name=name, unit=unit, cooldown = false, timestamp = timer.getAbsTime(), isground=isground }
+  for _,_data in pairs(self.RecceUnits) do
+    -- ground units only
+    if _data.isground and _data.unit and _data.unit:IsAlive() then
+      local unit = _data.unit -- Wrapper.Unit#UNIT
+      local position = unit:GetCoordinate() -- Core.Point#COORDINATE
+      local needsinit = false
+      if position then
+        local lastposition = unit:GetProperty("lastposition")
+        -- property initiated?
+        if not lastposition then
+          unit:SetProperty("lastposition",position)
+          lastposition = position
+          needsinit = true
+        end
+        -- has moved?
+        local dist = position:Get2DDistance(lastposition)
+        -- refresh?
+        local TNow = timer.getAbsTime()
+        -- check
+        if dist > 10 or needsinit==true or TNow - _data.timestamp > 29 then
+          -- init scan objects
+          local hasunits,hasstatics,_,Units,Statics = position:ScanObjects(self.LaseDistance,true,true,false)
+          -- loop found units
+          if hasunits then
+            self:T(self.lid.."Checking possibly visible UNITs for Recce "..unit:GetName())
+            for _,_target in pairs(Units) do -- Wrapper.Unit#UNIT object here
+              local target = _target -- Wrapper.Unit#UNIT
+              if target and target:GetCoalition() ~= self.coalition then
+                if unit:IsLOS(target) and (not target:IsUnitDetected(unit))then
+                  unit:KnowUnit(target,true,true)
+                end
+              end
+            end
+          end
+          -- loop found statics
+          if hasstatics then
+           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 and static:GetCoord() then
+                local IsLOS = position:IsLOS(static:GetCoord())
+                if IsLOS then
+                  unit:KnowUnit(static,true,true)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+  return self
+end
+
 -------------------------------------------------------------------
 -- FSM Functions
 -------------------------------------------------------------------
@@ -925,6 +1047,9 @@ end
 -- @return #AUTOLASE self
 function AUTOLASE:onbeforeMonitor(From, Event, To)
   self:T({From, Event, To})
+  if self.increasegroundawareness then
+    self:_Prescient()
+  end
   -- Check if group has detected any units.
   self:UpdateIntel()
   return self
@@ -953,10 +1078,10 @@ function AUTOLASE:onafterMonitor(From, Event, To)
     local grp = contact.group
     local coord = contact.position
     local reccename = contact.recce or "none"
-  local threat = contact.threatlevel or 0
+    local threat = contact.threatlevel or 0
     local reccegrp = UNIT:FindByName(reccename)
     if reccegrp then
-      local reccecoord = reccegrp:GetCoordinate()
+      local reccecoord = reccegrp:GetCoord()
       local distance = math.floor(reccecoord:Get3DDistance(coord))
       local text = string.format("%s of %s | Distance %d km | Threatlevel %d",contact.attribute, contact.groupname, math.floor(distance/1000), contact.threatlevel)
       report:Add(text)
@@ -995,7 +1120,6 @@ function AUTOLASE:onafterMonitor(From, Event, To)
         local unit = _unit -- Wrapper.Unit#UNIT
         if unit and unit:IsAlive() then
           local threat = unit:GetThreatLevel()
-          local coord = unit:GetCoordinate()
           if threat >= self.minthreatlevel then
             local unitname = unit:GetName()
             -- prefer radar units
@@ -1051,16 +1175,16 @@ function AUTOLASE:onafterMonitor(From, Event, To)
         local code = self:GetLaserCode(reccename)
         local spot = SPOT:New(recce)
         spot:LaseOn(unit,code,self.LaseDuration)
-        local locationstring = unit:GetCoordinate():ToStringLLDDM()    
+        local locationstring = unit:GetCoord():ToStringLLDDM()
         if _SETTINGS:IsA2G_MGRS() then
           local precision = _SETTINGS:GetMGRS_Accuracy()
           local settings = {}
           settings.MGRS_Accuracy = precision
-          locationstring = unit:GetCoordinate():ToStringMGRS(settings)
+          locationstring = unit:GetCoord():ToStringMGRS(settings)
         elseif _SETTINGS:IsA2G_LL_DMS() then
-          locationstring = unit:GetCoordinate():ToStringLLDMS(_SETTINGS)
+          locationstring = unit:GetCoord():ToStringLLDMS(_SETTINGS)
         elseif _SETTINGS:IsA2G_BR() then
-          locationstring = unit:GetCoordinate():ToStringBULLS(self.coalition,_SETTINGS)
+          locationstring = unit:GetCoord():ToStringBULLS(self.coalition,_SETTINGS)
         end
   
         local laserspot = { -- #AUTOLASE.LaserSpot
@@ -1073,10 +1197,13 @@ function AUTOLASE:onafterMonitor(From, Event, To)
           unitname = unitname,
           reccename = reccename,
           unittype = unit:GetTypeName(),
-          coordinate = unit:GetCoordinate(),
+          coordinate = unit:GetCoord(),
           }
        if self.smoketargets then
           local coord = unit:GetCoordinate()
+          if self.smokeoffset then
+            coord:Translate(self.smokeoffset.Distance,self.smokeoffset.Angle,true,true)
+          end
           local color = self:GetSmokeColor(reccename)
           coord:Smoke(color)
        end
@@ -1087,7 +1214,8 @@ function AUTOLASE:onafterMonitor(From, Event, To)
     end
   end
   
-  self:__Monitor(-30)
+  local nextloop = -self.MonitorFrequency or -30
+  self:__Monitor(nextloop)
   return self
 end
 

Moose Development/Moose/Functional/CleanUp.lua

@@ -357,7 +357,7 @@ function CLEANUP_AIRBASE.__:EventAddForCleanUp( Event )
   self:F({Event})
 
 
-	if Event.IniDCSUnit and Event.IniCategory == Object.Category.UNIT then
+	if Event.IniDCSUnit and Event.IniUnit and Event.IniCategory == Object.Category.UNIT then
 		if self.CleanUpList[Event.IniDCSUnitName] == nil then
 			if self:IsInAirbase( Event.IniUnit:GetVec2() ) then
 				self:AddForCleanUp( Event.IniUnit, Event.IniDCSUnitName )
@@ -365,7 +365,7 @@ function CLEANUP_AIRBASE.__:EventAddForCleanUp( Event )
 		end
 	end
 
-	if Event.TgtDCSUnit and Event.TgtCategory == Object.Category.UNIT then
+	if Event.TgtDCSUnit and Event.TgtUnit and Event.TgtCategory == Object.Category.UNIT then
 		if self.CleanUpList[Event.TgtDCSUnitName] == nil then
 			if self:IsInAirbase( Event.TgtUnit:GetVec2() ) then
 				self:AddForCleanUp( Event.TgtUnit, Event.TgtDCSUnitName )
@@ -387,7 +387,7 @@ function CLEANUP_AIRBASE.__:CleanUpSchedule()
 		local CleanUpUnit = CleanUpListData.CleanUpUnit -- Wrapper.Unit#UNIT
 		local CleanUpGroupName = CleanUpListData.CleanUpGroupName
 
-		if CleanUpUnit:IsAlive() ~= nil then
+		if CleanUpUnit and CleanUpUnit:IsAlive() ~= nil then
 
 		  if self:IsInAirbase( CleanUpUnit:GetVec2() ) then
 
@@ -414,7 +414,7 @@ function CLEANUP_AIRBASE.__:CleanUpSchedule()
   					end
   				end
   				-- Clean Units which are waiting for a very long time in the CleanUpZone.
-  				if CleanUpUnit and not CleanUpUnit:GetPlayerName() then
+  				if CleanUpUnit and (CleanUpUnit.GetPlayerName == nil or not CleanUpUnit:GetPlayerName()) then
   					local CleanUpUnitVelocity = CleanUpUnit:GetVelocityKMH()
   					if CleanUpUnitVelocity < 1 then
   						if CleanUpListData.CleanUpMoved then

Moose Development/Moose/Functional/Detection.lua

@@ -652,7 +652,7 @@ do -- DETECTION_BASE
 
           if DetectedObject:isExist() then
 
-            local TargetIsDetected, TargetIsVisible, TargetLastTime, TargetKnowType, TargetKnowDistance, TargetLastPos, TargetLastVelocity = DetectionUnit:IsTargetDetected(
+            local TargetIsDetected, TargetIsVisible, TargetKnowType, TargetKnowDistance, TargetLastTime, TargetLastPos, TargetLastVelocity = DetectionUnit:IsTargetDetected(
               DetectedObject,
               self.DetectVisual,
               self.DetectOptical,

Moose Development/Moose/Functional/Escort.lua

@@ -1154,8 +1154,6 @@ function ESCORT:_ReportTargetsScheduler()
 
   if self.EscortGroup:IsAlive() and self.EscortClient:IsAlive() then
 
-    if true then
-
       local EscortGroupName = self.EscortGroup:GetName() 
     
       self.EscortMenuAttackNearbyTargets:RemoveSubMenus()
@@ -1226,177 +1224,6 @@ function ESCORT:_ReportTargetsScheduler()
       end
       
       return true
-    else
---      local EscortGroupName = self.EscortGroup:GetName()
---      local EscortTargets = self.EscortGroup:GetDetectedTargets()
---  
---      local ClientEscortTargets = self.EscortClient._EscortGroups[EscortGroupName].Targets
---  
---      local EscortTargetMessages = ""
---      for EscortTargetID, EscortTarget in pairs( EscortTargets ) do
---        local EscortObject = EscortTarget.object
---        self:T( EscortObject )
---        if EscortObject and EscortObject:isExist() and EscortObject.id_ < 50000000 then
---  
---          local EscortTargetUnit = UNIT:Find( EscortObject )
---          local EscortTargetUnitName = EscortTargetUnit:GetName()
---  
---  
---  
---          --          local EscortTargetIsDetected,
---          --                EscortTargetIsVisible,
---          --                EscortTargetLastTime,
---          --                EscortTargetKnowType,
---          --                EscortTargetKnowDistance,
---          --                EscortTargetLastPos,
---          --                EscortTargetLastVelocity
---          --                = self.EscortGroup:IsTargetDetected( EscortObject )
---          --
---          --          self:T( { EscortTargetIsDetected,
---          --                EscortTargetIsVisible,
---          --                EscortTargetLastTime,
---          --                EscortTargetKnowType,
---          --                EscortTargetKnowDistance,
---          --                EscortTargetLastPos,
---          --                EscortTargetLastVelocity } )
---  
---  
---          local EscortTargetUnitVec3 = EscortTargetUnit:GetVec3()
---          local EscortVec3 = self.EscortGroup:GetVec3()
---          local Distance = ( ( EscortTargetUnitVec3.x - EscortVec3.x )^2 +
---            ( EscortTargetUnitVec3.y - EscortVec3.y )^2 +
---            ( EscortTargetUnitVec3.z - EscortVec3.z )^2
---            ) ^ 0.5 / 1000
---  
---          self:T( { self.EscortGroup:GetName(), EscortTargetUnit:GetName(), Distance, EscortTarget } )
---  
---          if Distance <= 15 then
---  
---            if not ClientEscortTargets[EscortTargetUnitName] then
---              ClientEscortTargets[EscortTargetUnitName] = {}
---            end
---            ClientEscortTargets[EscortTargetUnitName].AttackUnit = EscortTargetUnit
---            ClientEscortTargets[EscortTargetUnitName].visible = EscortTarget.visible
---            ClientEscortTargets[EscortTargetUnitName].type = EscortTarget.type
---            ClientEscortTargets[EscortTargetUnitName].distance = EscortTarget.distance
---          else
---            if ClientEscortTargets[EscortTargetUnitName] then
---              ClientEscortTargets[EscortTargetUnitName] = nil
---            end
---          end
---        end
---      end
---  
---      self:T( { "Sorting Targets Table:", ClientEscortTargets } )
---      table.sort( ClientEscortTargets, function( a, b ) return a.Distance < b.Distance end )
---      self:T( { "Sorted Targets Table:", ClientEscortTargets } )
---  
---      -- Remove the sub menus of the Attack menu of the Escort for the EscortGroup.
---      self.EscortMenuAttackNearbyTargets:RemoveSubMenus()
---  
---      if self.EscortMenuTargetAssistance then
---        self.EscortMenuTargetAssistance:RemoveSubMenus()
---      end
---  
---      --for MenuIndex = 1, #self.EscortMenuAttackTargets do
---      --  self:T( { "Remove Menu:", self.EscortMenuAttackTargets[MenuIndex] } )
---      --  self.EscortMenuAttackTargets[MenuIndex] = self.EscortMenuAttackTargets[MenuIndex]:Remove()
---      --end
---  
---  
---      if ClientEscortTargets then
---        for ClientEscortTargetUnitName, ClientEscortTargetData in pairs( ClientEscortTargets ) do
---  
---          for ClientEscortGroupName, EscortGroupData in pairs( self.EscortClient._EscortGroups ) do
---  
---            if ClientEscortTargetData and ClientEscortTargetData.AttackUnit:IsAlive() then
---  
---              local EscortTargetMessage = ""
---              local EscortTargetCategoryName = ClientEscortTargetData.AttackUnit:GetCategoryName()
---              local EscortTargetCategoryType = ClientEscortTargetData.AttackUnit:GetTypeName()
---              if ClientEscortTargetData.type then
---                EscortTargetMessage = EscortTargetMessage .. EscortTargetCategoryName .. " (" .. EscortTargetCategoryType .. ") at "
---              else
---                EscortTargetMessage = EscortTargetMessage .. "Unknown target at "
---              end
---  
---              local EscortTargetUnitVec3 = ClientEscortTargetData.AttackUnit:GetVec3()
---              local EscortVec3 = self.EscortGroup:GetVec3()
---              local Distance = ( ( EscortTargetUnitVec3.x - EscortVec3.x )^2 +
---                ( EscortTargetUnitVec3.y - EscortVec3.y )^2 +
---                ( EscortTargetUnitVec3.z - EscortVec3.z )^2
---                ) ^ 0.5 / 1000
---  
---              self:T( { self.EscortGroup:GetName(), ClientEscortTargetData.AttackUnit:GetName(), Distance, ClientEscortTargetData.AttackUnit } )
---              if ClientEscortTargetData.visible == false then
---                EscortTargetMessage = EscortTargetMessage .. string.format( "%.2f", Distance ) .. " estimated km"
---              else
---                EscortTargetMessage = EscortTargetMessage .. string.format( "%.2f", Distance ) .. " km"
---              end
---  
---              if ClientEscortTargetData.visible then
---                EscortTargetMessage = EscortTargetMessage .. ", visual"
---              end
---  
---              if ClientEscortGroupName == EscortGroupName then
---  
---                MENU_GROUP_COMMAND:New( self.EscortClient,
---                  EscortTargetMessage,
---                  self.EscortMenuAttackNearbyTargets,
---                  ESCORT._AttackTarget,
---                  { ParamSelf = self,
---                    ParamUnit = ClientEscortTargetData.AttackUnit
---                  }
---                )
---                EscortTargetMessages = EscortTargetMessages .. "\n - " .. EscortTargetMessage
---              else
---                if self.EscortMenuTargetAssistance then
---                  local MenuTargetAssistance = MENU_GROUP:New( self.EscortClient, EscortGroupData.EscortName, self.EscortMenuTargetAssistance )
---                  MENU_GROUP_COMMAND:New( self.EscortClient,
---                    EscortTargetMessage,
---                    MenuTargetAssistance,
---                    ESCORT._AssistTarget,
---                    self,
---                    EscortGroupData.EscortGroup,
---                    ClientEscortTargetData.AttackUnit
---                  )
---                end
---              end
---            else
---              ClientEscortTargetData = nil
---            end
---          end
---        end
---  
---        if EscortTargetMessages ~= "" and self.ReportTargets == true then
---          self.EscortGroup:MessageToClient( "Detected targets within 15 km range:" .. EscortTargetMessages:gsub("\n$",""), 20, self.EscortClient )
---        else
---          self.EscortGroup:MessageToClient( "No targets detected!", 20, self.EscortClient )
---        end
---      end
---  
---      if self.EscortMenuResumeMission then
---        self.EscortMenuResumeMission:RemoveSubMenus()
---  
---        --    if self.EscortMenuResumeWayPoints then
---        --      for MenuIndex = 1, #self.EscortMenuResumeWayPoints do
---        --        self:T( { "Remove Menu:", self.EscortMenuResumeWayPoints[MenuIndex] } )
---        --        self.EscortMenuResumeWayPoints[MenuIndex] = self.EscortMenuResumeWayPoints[MenuIndex]:Remove()
---        --      end
---        --    end
---  
---        local TaskPoints = self:RegisterRoute()
---        for WayPointID, WayPoint in pairs( TaskPoints ) do
---          local EscortVec3 = self.EscortGroup:GetVec3()
---          local Distance = ( ( WayPoint.x - EscortVec3.x )^2 +
---            ( WayPoint.y - EscortVec3.z )^2
---            ) ^ 0.5 / 1000
---          MENU_GROUP_COMMAND:New( self.EscortClient, "Waypoint " .. WayPointID .. " at " .. string.format( "%.2f", Distance ).. "km", self.EscortMenuResumeMission, ESCORT._ResumeMission, { ParamSelf = self, ParamWayPoint = WayPointID } )
---        end
---      end
---  
---      return true
-    end
   end
   
   return false

Moose Development/Moose/Functional/Fox.lua

@@ -1060,7 +1060,7 @@ function FOX:onafterMissileLaunch(From, Event, To, missile)
 
   -- Tracking info and init of last bomb position.
   local text=string.format("FOX: Tracking missile %s(%s) - target %s - shooter %s", missile.missileType, missile.missileName, tostring(missile.targetName), missile.shooterName)
-  self:I(FOX.lid..text)
+  self:T(FOX.lid..text)
   MESSAGE:New(text, 10):ToAllIf(self.Debug)
 
   -- Loop over players.

Moose Development/Moose/Functional/MissileTrainer.lua

@@ -1,734 +0,0 @@
---- **Functional** - Train missile defence and deflection.
---
--- ===
---
--- ## Features:
---
---   * Track the missiles fired at you and other players, providing bearing and range information of the missiles towards the airplanes.
---   * Provide alerts of missile launches, including detailed information of the units launching, including bearing, range
---   * Provide alerts when a missile would have killed your aircraft.
---   * Provide alerts when the missile self destructs.
---   * Enable / Disable and Configure the Missile Trainer using the various menu options.
---
--- ===
---
--- ## Missions:
---
--- [MIT - Missile Trainer](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/Functional/MissileTrainer)
---
--- ===
---
--- Uses the MOOSE messaging system to be alerted of any missiles fired, and when a missile would hit your aircraft,
--- the class will destroy the missile within a certain range, to avoid damage to your aircraft.
---
--- When running a mission where the missile trainer is used, the following radio menu structure ( 'Radio Menu' -> 'Other (F10)' -> 'MissileTrainer' ) options are available for the players:
---
---  * **Messages**: Menu to configure all messages.
---     * **Messages On**: Show all messages.
---     * **Messages Off**: Disable all messages.
---  * **Tracking**: Menu to configure missile tracking messages.
---     * **To All**: Shows missile tracking messages to all players.
---     * **To Target**: Shows missile tracking messages only to the player where the missile is targeted at.
---     * **Tracking On**: Show missile tracking messages.
---     * **Tracking Off**: Disable missile tracking messages.
---     * **Frequency Increase**: Increases the missile tracking message frequency with one second.
---     * **Frequency Decrease**: Decreases the missile tracking message frequency with one second.
---  * **Alerts**: Menu to configure alert messages.
---     * **To All**: Shows alert messages to all players.
---     * **To Target**: Shows alert messages only to the player where the missile is (was) targeted at.
---     * **Hits On**: Show missile hit alert messages.
---     * **Hits Off**: Disable missile hit alert messages.
---     * **Launches On**: Show missile launch messages.
---     * **Launches Off**: Disable missile launch messages.
---  * **Details**: Menu to configure message details.
---     * **Range On**: Shows range information when a missile is fired to a target.
---     * **Range Off**: Disable range information when a missile is fired to a target.
---     * **Bearing On**: Shows bearing information when a missile is fired to a target.
---     * **Bearing Off**: Disable bearing information when a missile is fired to a target.
---  * **Distance**: Menu to configure the distance when a missile needs to be destroyed when near to a player, during tracking. This will improve/influence hit calculation accuracy, but has the risk of damaging the aircraft when the missile reaches the aircraft before the distance is measured.
---     * **50 meter**: Destroys the missile when the distance to the aircraft is below or equal to 50 meter.
---     * **100 meter**: Destroys the missile when the distance to the aircraft is below or equal to 100 meter.
---     * **150 meter**: Destroys the missile when the distance to the aircraft is below or equal to 150 meter.
---     * **200 meter**: Destroys the missile when the distance to the aircraft is below or equal to 200 meter.
---     
--- # 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 and superseded by the [Functional.Fox](https://flightcontrol-master.github.io/MOOSE_DOCS_DEVELOP/Documentation/Functional.Fox.html) class, which provides the same functionality.
---
--- ===
---
--- ### Authors: **FlightControl**
---
--- ### Contributions:
---
---    * **Stuka (Danny)**: Who you can search on the Eagle Dynamics Forums. Working together with Danny has resulted in the MISSILETRAINER class.
---      Danny has shared his ideas and together we made a design.
---      Together with the **476 virtual team**, we tested the MISSILETRAINER class, and got much positive feedback!
---    * **132nd Squadron**: Testing and optimizing the logic.
---
--- ===
---
--- @module Functional.MissileTrainer
--- @image Missile_Trainer.JPG
-
----
--- @type MISSILETRAINER
--- @field Core.Set#SET_CLIENT DBClients
--- @extends Core.Base#BASE
-
-
----
---
--- # Constructor:
---
--- Create a new MISSILETRAINER object with the @{#MISSILETRAINER.New} method:
---
---   * @{#MISSILETRAINER.New}: Creates a new MISSILETRAINER object taking the maximum distance to your aircraft to evaluate when a missile needs to be destroyed.
---
--- MISSILETRAINER will collect each unit declared in the mission with a skill level "Client" and "Player", and will monitor the missiles shot at those.
---
--- # Initialization:
---
--- A MISSILETRAINER object will behave differently based on the usage of initialization methods:
---
---  * @{#MISSILETRAINER.InitMessagesOnOff}: Sets by default the display of any message to be ON or OFF.
---  * @{#MISSILETRAINER.InitTrackingToAll}: Sets by default the missile tracking report for all players or only for those missiles targeted to you.
---  * @{#MISSILETRAINER.InitTrackingOnOff}: Sets by default the display of missile tracking report to be ON or OFF.
---  * @{#MISSILETRAINER.InitTrackingFrequency}: Increases, decreases the missile tracking message display frequency with the provided time interval in seconds.
---  * @{#MISSILETRAINER.InitAlertsToAll}: Sets by default the display of alerts to be shown to all players or only to you.
---  * @{#MISSILETRAINER.InitAlertsHitsOnOff}: Sets by default the display of hit alerts ON or OFF.
---  * @{#MISSILETRAINER.InitAlertsLaunchesOnOff}: Sets by default the display of launch alerts ON or OFF.
---  * @{#MISSILETRAINER.InitRangeOnOff}: Sets by default the display of range information of missiles ON of OFF.
---  * @{#MISSILETRAINER.InitBearingOnOff}: Sets by default the display of bearing information of missiles ON of OFF.
---  * @{#MISSILETRAINER.InitMenusOnOff}: Allows to configure the options through the radio menu.
---  
--- # 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 and superseded by the [Functional.Fox](https://flightcontrol-master.github.io/MOOSE_DOCS_DEVELOP/Documentation/Functional.Fox.html) class, which provides the same functionality.
---
--- @field #MISSILETRAINER
-MISSILETRAINER = {
-  ClassName = "MISSILETRAINER",
-  TrackingMissiles = {},
-}
-
-function MISSILETRAINER._Alive( Client, self )
-
-  if self.Briefing then
-    Client:Message( self.Briefing, 15, "Trainer" )
-  end
-
-  if self.MenusOnOff == true then
-    Client:Message( "Use the 'Radio Menu' -> 'Other (F10)' -> 'Missile Trainer' menu options to change the Missile Trainer settings (for all players).", 15, "Trainer" )
-
-    Client.MainMenu = MENU_GROUP:New( Client:GetGroup(), "Missile Trainer", nil ) -- Menu#MENU_GROUP
-
-    Client.MenuMessages = MENU_GROUP:New( Client:GetGroup(), "Messages", Client.MainMenu )
-    Client.MenuOn = MENU_GROUP_COMMAND:New( Client:GetGroup(), "Messages On", Client.MenuMessages, self._MenuMessages, { MenuSelf = self, MessagesOnOff = true } )
-    Client.MenuOff = MENU_GROUP_COMMAND:New( Client:GetGroup(), "Messages Off", Client.MenuMessages, self._MenuMessages, { MenuSelf = self, MessagesOnOff = false } )
-
-    Client.MenuTracking = MENU_GROUP:New( Client:GetGroup(), "Tracking", Client.MainMenu )
-    Client.MenuTrackingToAll = MENU_GROUP_COMMAND:New( Client:GetGroup(), "To All", Client.MenuTracking, self._MenuMessages, { MenuSelf = self, TrackingToAll = true } )
-    Client.MenuTrackingToTarget = MENU_GROUP_COMMAND:New( Client:GetGroup(), "To Target", Client.MenuTracking, self._MenuMessages, { MenuSelf = self, TrackingToAll = false } )
-    Client.MenuTrackOn = MENU_GROUP_COMMAND:New( Client:GetGroup(), "Tracking On", Client.MenuTracking, self._MenuMessages, { MenuSelf = self, TrackingOnOff = true } )
-    Client.MenuTrackOff = MENU_GROUP_COMMAND:New( Client:GetGroup(), "Tracking Off", Client.MenuTracking, self._MenuMessages, { MenuSelf = self, TrackingOnOff = false } )
-    Client.MenuTrackIncrease = MENU_GROUP_COMMAND:New( Client:GetGroup(), "Frequency Increase", Client.MenuTracking, self._MenuMessages, { MenuSelf = self, TrackingFrequency = -1 } )
-    Client.MenuTrackDecrease = MENU_GROUP_COMMAND:New( Client:GetGroup(), "Frequency Decrease", Client.MenuTracking, self._MenuMessages, { MenuSelf = self, TrackingFrequency = 1 } )
-
-    Client.MenuAlerts = MENU_GROUP:New( Client:GetGroup(), "Alerts", Client.MainMenu )
-    Client.MenuAlertsToAll = MENU_GROUP_COMMAND:New( Client:GetGroup(), "To All", Client.MenuAlerts, self._MenuMessages, { MenuSelf = self, AlertsToAll = true } )
-    Client.MenuAlertsToTarget = MENU_GROUP_COMMAND:New( Client:GetGroup(), "To Target", Client.MenuAlerts, self._MenuMessages, { MenuSelf = self, AlertsToAll = false } )
-    Client.MenuHitsOn = MENU_GROUP_COMMAND:New( Client:GetGroup(), "Hits On", Client.MenuAlerts, self._MenuMessages, { MenuSelf = self, AlertsHitsOnOff = true } )
-    Client.MenuHitsOff = MENU_GROUP_COMMAND:New( Client:GetGroup(), "Hits Off", Client.MenuAlerts, self._MenuMessages, { MenuSelf = self, AlertsHitsOnOff = false } )
-    Client.MenuLaunchesOn = MENU_GROUP_COMMAND:New( Client:GetGroup(), "Launches On", Client.MenuAlerts, self._MenuMessages, { MenuSelf = self, AlertsLaunchesOnOff = true } )
-    Client.MenuLaunchesOff = MENU_GROUP_COMMAND:New( Client:GetGroup(), "Launches Off", Client.MenuAlerts, self._MenuMessages, { MenuSelf = self, AlertsLaunchesOnOff = false } )
-
-    Client.MenuDetails = MENU_GROUP:New( Client:GetGroup(), "Details", Client.MainMenu )
-    Client.MenuDetailsDistanceOn = MENU_GROUP_COMMAND:New( Client:GetGroup(), "Range On", Client.MenuDetails, self._MenuMessages, { MenuSelf = self, DetailsRangeOnOff = true } )
-    Client.MenuDetailsDistanceOff = MENU_GROUP_COMMAND:New( Client:GetGroup(), "Range Off", Client.MenuDetails, self._MenuMessages, { MenuSelf = self, DetailsRangeOnOff = false } )
-    Client.MenuDetailsBearingOn = MENU_GROUP_COMMAND:New( Client:GetGroup(), "Bearing On", Client.MenuDetails, self._MenuMessages, { MenuSelf = self, DetailsBearingOnOff = true } )
-    Client.MenuDetailsBearingOff = MENU_GROUP_COMMAND:New( Client:GetGroup(), "Bearing Off", Client.MenuDetails, self._MenuMessages, { MenuSelf = self, DetailsBearingOnOff = false } )
-
-    Client.MenuDistance = MENU_GROUP:New( Client:GetGroup(), "Set distance to plane", Client.MainMenu )
-    Client.MenuDistance50 = MENU_GROUP_COMMAND:New( Client:GetGroup(), "50 meter", Client.MenuDistance, self._MenuMessages, { MenuSelf = self, Distance = 50 / 1000 } )
-    Client.MenuDistance100 = MENU_GROUP_COMMAND:New( Client:GetGroup(), "100 meter", Client.MenuDistance, self._MenuMessages, { MenuSelf = self, Distance = 100 / 1000 } )
-    Client.MenuDistance150 = MENU_GROUP_COMMAND:New( Client:GetGroup(), "150 meter", Client.MenuDistance, self._MenuMessages, { MenuSelf = self, Distance = 150 / 1000 } )
-    Client.MenuDistance200 = MENU_GROUP_COMMAND:New( Client:GetGroup(), "200 meter", Client.MenuDistance, self._MenuMessages, { MenuSelf = self, Distance = 200 / 1000 } )
-  else
-    if Client.MainMenu then
-      Client.MainMenu:Remove()
-    end
-  end
-
-  local ClientID = Client:GetID()
-  self:T( ClientID )
-  if not self.TrackingMissiles[ClientID] then
-    self.TrackingMissiles[ClientID] = {}
-  end
-  self.TrackingMissiles[ClientID].Client = Client
-  if not self.TrackingMissiles[ClientID].MissileData then
-    self.TrackingMissiles[ClientID].MissileData = {}
-  end
-end
-
---- Creates the main object which is handling missile tracking.
--- When a missile is fired a SCHEDULER is set off that follows the missile. When near a certain a client player, the missile will be destroyed.
--- @param #MISSILETRAINER self
--- @param #number Distance The distance in meters when a tracked missile needs to be destroyed when close to a player.
--- @param #string Briefing (Optional) Will show a text to the players when starting their mission. Can be used for briefing purposes.
--- @return #MISSILETRAINER
-function MISSILETRAINER:New( Distance, Briefing )
-  local self = BASE:Inherit( self, BASE:New() )
-  self:F( Distance )
-
-  if Briefing then
-    self.Briefing = Briefing
-  end
-
-  self.Schedulers = {}
-  self.SchedulerID = 0
-
-  self.MessageInterval = 2
-  self.MessageLastTime = timer.getTime()
-
-  self.Distance = Distance / 1000
-
-  self:HandleEvent( EVENTS.Shot )
-
-  self.DBClients = SET_CLIENT:New():FilterStart()
-
-
---  for ClientID, Client in pairs( self.DBClients.Database ) do
---      self:F( "ForEach:" .. Client.UnitName )
---      Client:Alive( self._Alive, self )
---  end
---
-  self.DBClients:ForEachClient(
-    function( Client )
-      self:F( "ForEach:" .. Client.UnitName )
-      Client:Alive( self._Alive, self )
-    end
-  )
-
-
-
---  	self.DB:ForEachClient(
---  	 -- @param Wrapper.Client#CLIENT Client
---  	 function( Client )
---
---        ... actions ...
---
---  	 end
---  	)
-
-  self.MessagesOnOff = true
-
-  self.TrackingToAll = false
-  self.TrackingOnOff = true
-  self.TrackingFrequency = 3
-
-  self.AlertsToAll = true
-  self.AlertsHitsOnOff = true
-  self.AlertsLaunchesOnOff = true
-
-  self.DetailsRangeOnOff = true
-  self.DetailsBearingOnOff = true
-
-  self.MenusOnOff = true
-
-  self.TrackingMissiles = {}
-
-  self.TrackingScheduler = SCHEDULER:New( self, self._TrackMissiles, {}, 0.5, 0.05, 0 )
-
-  return self
-end
-
--- Initialization methods.
-
-
-
---- Sets by default the display of any message to be ON or OFF.
--- @param #MISSILETRAINER self
--- @param #boolean MessagesOnOff true or false
--- @return #MISSILETRAINER self
-function MISSILETRAINER:InitMessagesOnOff( MessagesOnOff )
-  self:F( MessagesOnOff )
-
-  self.MessagesOnOff = MessagesOnOff
-  if self.MessagesOnOff == true then
-    MESSAGE:New( "Messages ON", 15, "Menu" ):ToAll()
-  else
-    MESSAGE:New( "Messages OFF", 15, "Menu" ):ToAll()
-  end
-
-  return self
-end
-
---- Sets by default the missile tracking report for all players or only for those missiles targeted to you.
--- @param #MISSILETRAINER self
--- @param #boolean TrackingToAll true or false
--- @return #MISSILETRAINER self
-function MISSILETRAINER:InitTrackingToAll( TrackingToAll )
-  self:F( TrackingToAll )
-
-  self.TrackingToAll = TrackingToAll
-  if self.TrackingToAll == true then
-    MESSAGE:New( "Missile tracking to all players ON", 15, "Menu" ):ToAll()
-  else
-    MESSAGE:New( "Missile tracking to all players OFF", 15, "Menu" ):ToAll()
-  end
-
-  return self
-end
-
---- Sets by default the display of missile tracking report to be ON or OFF.
--- @param #MISSILETRAINER self
--- @param #boolean TrackingOnOff true or false
--- @return #MISSILETRAINER self
-function MISSILETRAINER:InitTrackingOnOff( TrackingOnOff )
-  self:F( TrackingOnOff )
-
-  self.TrackingOnOff = TrackingOnOff
-  if self.TrackingOnOff == true then
-    MESSAGE:New( "Missile tracking ON", 15, "Menu" ):ToAll()
-  else
-    MESSAGE:New( "Missile tracking OFF", 15, "Menu" ):ToAll()
-  end
-
-  return self
-end
-
---- Increases, decreases the missile tracking message display frequency with the provided time interval in seconds.
--- The default frequency is a 3 second interval, so the Tracking Frequency parameter specifies the increase or decrease from the default 3 seconds or the last frequency update.
--- @param #MISSILETRAINER self
--- @param #number TrackingFrequency Provide a negative or positive value in seconds to incraese or decrease the display frequency.
--- @return #MISSILETRAINER self
-function MISSILETRAINER:InitTrackingFrequency( TrackingFrequency )
-  self:F( TrackingFrequency )
-
-  self.TrackingFrequency = self.TrackingFrequency + TrackingFrequency
-  if self.TrackingFrequency < 0.5 then
-    self.TrackingFrequency = 0.5
-  end
-  if self.TrackingFrequency then
-    MESSAGE:New( "Missile tracking frequency is " .. self.TrackingFrequency .. " seconds.", 15, "Menu" ):ToAll()
-  end
-
-  return self
-end
-
---- Sets by default the display of alerts to be shown to all players or only to you.
--- @param #MISSILETRAINER self
--- @param #boolean AlertsToAll true or false
--- @return #MISSILETRAINER self
-function MISSILETRAINER:InitAlertsToAll( AlertsToAll )
-  self:F( AlertsToAll )
-
-  self.AlertsToAll = AlertsToAll
-  if self.AlertsToAll == true then
-    MESSAGE:New( "Alerts to all players ON", 15, "Menu" ):ToAll()
-  else
-    MESSAGE:New( "Alerts to all players OFF", 15, "Menu" ):ToAll()
-  end
-
-  return self
-end
-
---- Sets by default the display of hit alerts ON or OFF.
--- @param #MISSILETRAINER self
--- @param #boolean AlertsHitsOnOff true or false
--- @return #MISSILETRAINER self
-function MISSILETRAINER:InitAlertsHitsOnOff( AlertsHitsOnOff )
-  self:F( AlertsHitsOnOff )
-
-  self.AlertsHitsOnOff = AlertsHitsOnOff
-  if self.AlertsHitsOnOff == true then
-    MESSAGE:New( "Alerts Hits ON", 15, "Menu" ):ToAll()
-  else
-    MESSAGE:New( "Alerts Hits OFF", 15, "Menu" ):ToAll()
-  end
-
-  return self
-end
-
---- Sets by default the display of launch alerts ON or OFF.
--- @param #MISSILETRAINER self
--- @param #boolean AlertsLaunchesOnOff true or false
--- @return #MISSILETRAINER self
-function MISSILETRAINER:InitAlertsLaunchesOnOff( AlertsLaunchesOnOff )
-  self:F( AlertsLaunchesOnOff )
-
-  self.AlertsLaunchesOnOff = AlertsLaunchesOnOff
-  if self.AlertsLaunchesOnOff == true then
-    MESSAGE:New( "Alerts Launches ON", 15, "Menu" ):ToAll()
-  else
-    MESSAGE:New( "Alerts Launches OFF", 15, "Menu" ):ToAll()
-  end
-
-  return self
-end
-
---- Sets by default the display of range information of missiles ON of OFF.
--- @param #MISSILETRAINER self
--- @param #boolean DetailsRangeOnOff true or false
--- @return #MISSILETRAINER self
-function MISSILETRAINER:InitRangeOnOff( DetailsRangeOnOff )
-  self:F( DetailsRangeOnOff )
-
-  self.DetailsRangeOnOff = DetailsRangeOnOff
-  if self.DetailsRangeOnOff == true then
-    MESSAGE:New( "Range display ON", 15, "Menu" ):ToAll()
-  else
-    MESSAGE:New( "Range display OFF", 15, "Menu" ):ToAll()
-  end
-
-  return self
-end
-
---- Sets by default the display of bearing information of missiles ON of OFF.
--- @param #MISSILETRAINER self
--- @param #boolean DetailsBearingOnOff true or false
--- @return #MISSILETRAINER self
-function MISSILETRAINER:InitBearingOnOff( DetailsBearingOnOff )
-  self:F( DetailsBearingOnOff )
-
-  self.DetailsBearingOnOff = DetailsBearingOnOff
-  if self.DetailsBearingOnOff == true then
-    MESSAGE:New( "Bearing display OFF", 15, "Menu" ):ToAll()
-  else
-    MESSAGE:New( "Bearing display OFF", 15, "Menu" ):ToAll()
-  end
-
-  return self
-end
-
---- Enables / Disables the menus.
--- @param #MISSILETRAINER self
--- @param #boolean MenusOnOff true or false
--- @return #MISSILETRAINER self
-function MISSILETRAINER:InitMenusOnOff( MenusOnOff )
-  self:F( MenusOnOff )
-
-  self.MenusOnOff = MenusOnOff
-  if self.MenusOnOff == true then
-    MESSAGE:New( "Menus are ENABLED (only when a player rejoins a slot)", 15, "Menu" ):ToAll()
-  else
-    MESSAGE:New( "Menus are DISABLED", 15, "Menu" ):ToAll()
-  end
-
-  return self
-end
-
-
--- Menu functions
-
-function MISSILETRAINER._MenuMessages( MenuParameters )
-
-  local self = MenuParameters.MenuSelf
-
-  if MenuParameters.MessagesOnOff ~= nil then
-    self:InitMessagesOnOff( MenuParameters.MessagesOnOff )
-  end
-
-  if MenuParameters.TrackingToAll ~= nil then
-    self:InitTrackingToAll( MenuParameters.TrackingToAll )
-  end
-
-  if MenuParameters.TrackingOnOff ~= nil then
-    self:InitTrackingOnOff( MenuParameters.TrackingOnOff )
-  end
-
-  if MenuParameters.TrackingFrequency ~= nil then
-    self:InitTrackingFrequency( MenuParameters.TrackingFrequency )
-  end
-
-  if MenuParameters.AlertsToAll ~= nil then
-    self:InitAlertsToAll( MenuParameters.AlertsToAll )
-  end
-
-  if MenuParameters.AlertsHitsOnOff ~= nil then
-    self:InitAlertsHitsOnOff( MenuParameters.AlertsHitsOnOff )
-  end
-
-  if MenuParameters.AlertsLaunchesOnOff ~= nil then
-    self:InitAlertsLaunchesOnOff( MenuParameters.AlertsLaunchesOnOff )
-  end
-
-  if MenuParameters.DetailsRangeOnOff ~= nil then
-    self:InitRangeOnOff( MenuParameters.DetailsRangeOnOff )
-  end
-
-  if MenuParameters.DetailsBearingOnOff ~= nil then
-    self:InitBearingOnOff( MenuParameters.DetailsBearingOnOff )
-  end
-
-  if MenuParameters.Distance ~= nil then
-    self.Distance = MenuParameters.Distance
-    MESSAGE:New( "Hit detection distance set to " .. ( self.Distance * 1000 ) .. " meters", 15, "Menu" ):ToAll()
-  end
-
-end
-
---- Detects if an SA site was shot with an anti radiation missile. In this case, take evasive actions based on the skill level set within the ME.
--- @param #MISSILETRAINER self
--- @param Core.Event#EVENTDATA EventData
-function MISSILETRAINER:OnEventShot( EVentData )
-  self:F( { EVentData } )
-
-  local TrainerSourceDCSUnit = EVentData.IniDCSUnit
-  local TrainerSourceDCSUnitName = EVentData.IniDCSUnitName
-  local TrainerWeapon = EVentData.Weapon -- Identify the weapon fired
-  local TrainerWeaponName = EVentData.WeaponName	-- return weapon type
-
-  self:T( "Missile Launched = " .. TrainerWeaponName )
-
-  local TrainerTargetDCSUnit = TrainerWeapon:getTarget() -- Identify target
-  if TrainerTargetDCSUnit then
-    local TrainerTargetDCSUnitName = Unit.getName( TrainerTargetDCSUnit )
-    local TrainerTargetSkill =  _DATABASE.Templates.Units[TrainerTargetDCSUnitName].Template.skill
-
-    self:T(TrainerTargetDCSUnitName )
-
-    local Client = self.DBClients:FindClient( TrainerTargetDCSUnitName )
-    if Client then
-
-      local TrainerSourceUnit = UNIT:Find( TrainerSourceDCSUnit )
-      local TrainerTargetUnit = UNIT:Find( TrainerTargetDCSUnit )
-
-      if self.MessagesOnOff == true and self.AlertsLaunchesOnOff == true then
-
-        local Message = MESSAGE:New(
-          string.format( "%s launched a %s",
-            TrainerSourceUnit:GetTypeName(),
-            TrainerWeaponName
-          ) .. self:_AddRange( Client, TrainerWeapon ) .. self:_AddBearing( Client, TrainerWeapon ), 5, "Launch Alert" )
-
-        if self.AlertsToAll then
-          Message:ToAll()
-        else
-          Message:ToClient( Client )
-        end
-      end
-
-      local ClientID = Client:GetID()
-      self:T( ClientID )
-      local MissileData = {}
-      MissileData.TrainerSourceUnit = TrainerSourceUnit
-      MissileData.TrainerWeapon = TrainerWeapon
-      MissileData.TrainerTargetUnit = TrainerTargetUnit
-      MissileData.TrainerWeaponTypeName = TrainerWeapon:getTypeName()
-      MissileData.TrainerWeaponLaunched = true
-      table.insert( self.TrackingMissiles[ClientID].MissileData, MissileData )
-      --self:T( self.TrackingMissiles )
-    end
-  else
-     -- TODO: some weapons don't know the target unit... Need to develop a workaround for this.
- if ( TrainerWeapon:getTypeName() == "9M311" ) then
-		SCHEDULER:New( TrainerWeapon, TrainerWeapon.destroy, {}, 1 )
-		else
-		end
-  end
-end
-
-function MISSILETRAINER:_AddRange( Client, TrainerWeapon )
-
-  local RangeText = ""
-
-  if self.DetailsRangeOnOff then
-
-    local PositionMissile = TrainerWeapon:getPoint()
-    local TargetVec3 = Client:GetVec3()
-
-    local Range = ( ( PositionMissile.x - TargetVec3.x )^2 +
-      ( PositionMissile.y - TargetVec3.y )^2 +
-      ( PositionMissile.z - TargetVec3.z )^2
-      ) ^ 0.5 / 1000
-
-    RangeText = string.format( ", at %4.2fkm", Range )
-  end
-
-  return RangeText
-end
-
-function MISSILETRAINER:_AddBearing( Client, TrainerWeapon )
-
-  local BearingText = ""
-
-  if self.DetailsBearingOnOff then
-
-    local PositionMissile = TrainerWeapon:getPoint()
-    local TargetVec3 = Client:GetVec3()
-
-    self:T2( { TargetVec3, PositionMissile })
-
-    local DirectionVector = { x = PositionMissile.x - TargetVec3.x, y = PositionMissile.y - TargetVec3.y, z = PositionMissile.z - TargetVec3.z }
-    local DirectionRadians = math.atan2( DirectionVector.z, DirectionVector.x )
-
-    if DirectionRadians < 0 then
-      DirectionRadians = DirectionRadians + 2 * math.pi
-    end
-    local DirectionDegrees = DirectionRadians * 180 / math.pi
-
-    BearingText = string.format( ", %d degrees", DirectionDegrees )
-  end
-
-  return BearingText
-end
-
-
-function MISSILETRAINER:_TrackMissiles()
-  self:F2()
-
-
-  local ShowMessages = false
-  if self.MessagesOnOff and self.MessageLastTime + self.TrackingFrequency <= timer.getTime() then
-    self.MessageLastTime = timer.getTime()
-    ShowMessages = true
-  end
-
-  -- ALERTS PART
-
-  -- Loop for all Player Clients to check the alerts and deletion of missiles.
-  for ClientDataID, ClientData in pairs( self.TrackingMissiles ) do
-
-    local Client = ClientData.Client
-
-    if Client and Client:IsAlive() then
-
-      for MissileDataID, MissileData in pairs( ClientData.MissileData ) do
-        self:T3( MissileDataID )
-
-        local TrainerSourceUnit = MissileData.TrainerSourceUnit
-        local TrainerWeapon = MissileData.TrainerWeapon
-        local TrainerTargetUnit = MissileData.TrainerTargetUnit
-        local TrainerWeaponTypeName = MissileData.TrainerWeaponTypeName
-        local TrainerWeaponLaunched = MissileData.TrainerWeaponLaunched
-
-        if Client and Client:IsAlive() and TrainerSourceUnit and TrainerSourceUnit:IsAlive() and TrainerWeapon and TrainerWeapon:isExist() and TrainerTargetUnit and TrainerTargetUnit:IsAlive() then
-          local PositionMissile = TrainerWeapon:getPosition().p
-          local TargetVec3 = Client:GetVec3()
-
-          local Distance = ( ( PositionMissile.x - TargetVec3.x )^2 +
-            ( PositionMissile.y - TargetVec3.y )^2 +
-            ( PositionMissile.z - TargetVec3.z )^2
-            ) ^ 0.5 / 1000
-
-          if Distance <= self.Distance then
-            -- Hit alert
-            TrainerWeapon:destroy()
-            if self.MessagesOnOff == true and self.AlertsHitsOnOff == true then
-
-              self:T( "killed" )
-
-              local Message = MESSAGE:New(
-                string.format( "%s launched by %s killed %s",
-                  TrainerWeapon:getTypeName(),
-                  TrainerSourceUnit:GetTypeName(),
-                  TrainerTargetUnit:GetPlayerName()
-                ), 15, "Hit Alert" )
-
-              if self.AlertsToAll == true then
-                Message:ToAll()
-              else
-                Message:ToClient( Client )
-              end
-
-              MissileData = nil
-              table.remove( ClientData.MissileData, MissileDataID )
-              self:T(ClientData.MissileData)
-            end
-          end
-        else
-          if not ( TrainerWeapon and TrainerWeapon:isExist() ) then
-            if self.MessagesOnOff == true and self.AlertsLaunchesOnOff == true then
-              -- Weapon does not exist anymore. Delete from Table
-              local Message = MESSAGE:New(
-                string.format( "%s launched by %s self destructed!",
-                  TrainerWeaponTypeName,
-                  TrainerSourceUnit:GetTypeName()
-                ), 5, "Tracking" )
-
-              if self.AlertsToAll == true then
-                Message:ToAll()
-              else
-                Message:ToClient( Client )
-              end
-            end
-            MissileData = nil
-            table.remove( ClientData.MissileData, MissileDataID )
-            self:T( ClientData.MissileData )
-          end
-        end
-      end
-    else
-      self.TrackingMissiles[ClientDataID] = nil
-    end
-  end
-
-  if ShowMessages == true and self.MessagesOnOff == true and self.TrackingOnOff == true then -- Only do this when tracking information needs to be displayed.
-
-    -- TRACKING PART
-
-    -- For the current client, the missile range and bearing details are displayed To the Player Client.
-    -- For the other clients, the missile range and bearing details are displayed To the other Player Clients.
-    -- To achieve this, a cross loop is done for each Player Client <-> Other Player Client missile information.
-
-    -- Main Player Client loop
-    for ClientDataID, ClientData in pairs( self.TrackingMissiles ) do
-
-      local Client = ClientData.Client
-      --self:T2( { Client:GetName() } )
-
-
-      ClientData.MessageToClient = ""
-      ClientData.MessageToAll = ""
-
-      -- Other Players Client loop
-      for TrackingDataID, TrackingData in pairs( self.TrackingMissiles ) do
-
-        for MissileDataID, MissileData in pairs( TrackingData.MissileData ) do
-          --self:T3( MissileDataID )
-
-          local TrainerSourceUnit = MissileData.TrainerSourceUnit
-          local TrainerWeapon = MissileData.TrainerWeapon
-          local TrainerTargetUnit = MissileData.TrainerTargetUnit
-          local TrainerWeaponTypeName = MissileData.TrainerWeaponTypeName
-          local TrainerWeaponLaunched = MissileData.TrainerWeaponLaunched
-
-          if Client and Client:IsAlive() and TrainerSourceUnit and TrainerSourceUnit:IsAlive() and TrainerWeapon and TrainerWeapon:isExist() and TrainerTargetUnit and TrainerTargetUnit:IsAlive() then
-
-            if ShowMessages == true then
-              local TrackingTo
-              TrackingTo = string.format( "  -> %s",
-                TrainerWeaponTypeName
-              )
-
-              if ClientDataID == TrackingDataID then
-                if ClientData.MessageToClient == "" then
-                  ClientData.MessageToClient = "Missiles to You:\n"
-                end
-                ClientData.MessageToClient = ClientData.MessageToClient .. TrackingTo .. self:_AddRange( ClientData.Client, TrainerWeapon ) .. self:_AddBearing( ClientData.Client, TrainerWeapon ) .. "\n"
-              else
-                if self.TrackingToAll == true then
-                  if ClientData.MessageToAll == "" then
-                    ClientData.MessageToAll = "Missiles to other Players:\n"
-                  end
-                  ClientData.MessageToAll = ClientData.MessageToAll .. TrackingTo .. self:_AddRange( ClientData.Client, TrainerWeapon ) .. self:_AddBearing( ClientData.Client, TrainerWeapon ) .. " ( " .. TrainerTargetUnit:GetPlayerName()  ..   " )\n"
-                end
-              end
-            end
-          end
-        end
-      end
-
-      -- Once the Player Client and the Other Player Client tracking messages are prepared, show them.
-      if ClientData.MessageToClient ~= "" or ClientData.MessageToAll ~= "" then
-        local Message = MESSAGE:New( ClientData.MessageToClient .. ClientData.MessageToAll, 1, "Tracking" ):ToClient( Client )
-      end
-    end
-  end
-
-  return true
-end

Moose Development/Moose/Functional/PseudoATC.lua

@@ -100,7 +100,7 @@ PSEUDOATC.id="PseudoATC | "
 
 --- PSEUDOATC version.
 -- @field #number version
-PSEUDOATC.version="0.10.5"
+PSEUDOATC.version="0.10.6"
 
 -----------------------------------------------------------------------------------------------------------------------------------------
 
@@ -579,6 +579,9 @@ function PSEUDOATC:MenuAirports(GID,UID)
     -- Create menu reporting commands
     missionCommands.addCommandForGroup(GID, "Weather Report", submenu, self.ReportWeather, self, GID, UID, pos, name)
     missionCommands.addCommandForGroup(GID, "Request BR", submenu, self.ReportBR, self, GID, UID, pos, name)
+    if self.radios then
+      missionCommands.addCommandForGroup(GID, "Radios", submenu, self.ReportRadios, self, GID, UID, pos, name)
+    end
     
     -- Debug message.
     self:T(string.format(PSEUDOATC.id.."Creating airport menu item %s for ID %d", name, GID))
@@ -705,7 +708,30 @@ function PSEUDOATC:ReportWeather(GID, UID, position, location)
   
 end
 
---- Report absolute bearing and range form player unit to airport.
+--- Report airport radio information.
+-- @param #PSEUDOATC self
+-- @param #number GID Group id of player unit.
+-- @param #number UID Unit id of player. 
+-- @param Core.Point#COORDINATE position Coordinate of the airport.
+-- @param #string location Name of the airport.
+function PSEUDOATC:ReportRadios(GID, UID, position, location)
+  self:F({GID=GID, UID=UID, position=position, location=location})
+  if self.radios then
+    local Text=""
+    local radio = self.radios:GetClosestRadio(position,9) --Navigation.Radios#RADIOS.Radio
+    if radio then 
+      Text=self.radios:_GetMarkerText(radio)
+    else
+      Text=self.group[GID].player[UID].playername..", no radio information found!"
+    end
+    -- Send message
+    self:_DisplayMessageToGroup(self.group[GID].player[UID].unit, Text, self.mdur, true)
+  end
+  return self
+end
+
+
+--- Report absolute bearing and range from player unit to airport.
 -- @param #PSEUDOATC self
 -- @param #number GID Group id of player unit.
 -- @param #number UID Unit id of player. 
@@ -979,3 +1005,22 @@ function PSEUDOATC:_myname(unitname)
   
   return string.format("%s (%s)", csign, pname)
 end
+
+--- Returns a string which consits of this callsign and the player name.  
+-- @param #PSEUDOATC self
+-- @param #string path Path to map data, e.g. `[[<DCS_Install_Directory>\Mods\terrains\<Map_Name>\Radio.lua]]` (replace with correct path).
+-- Needs `lfs` and `io` to be desanitized in the `MissionScripting.lua` in `<DCS_Install_Directory>\Scripts`
+-- @return #PSEUDOATC self
+-- @usage
+-- 
+--          mypseudoatc:SetUsingRadioInformationFromMap([[C:\Program Files\Eagle Dynamics\DCS World.Openbeta\Mods\terrains\Caucasus\Radio.lua]])
+--  
+function PSEUDOATC:SetUsingRadioInformationFromMap(path)
+  if RADIOS and lfs and io then
+    self.radios = RADIOS:NewFromFile(path)
+  else
+    self:E("PSEUDOATC:SetUsingRadioInformationFromMap Needs `lfs`and `io` to be desanitized in the `MissionScripting.lua` in `<DCS_Install_Directory>/Scripts`")
+  end
+  return self
+end
+

Moose Development/Moose/Functional/RAT.lua

@@ -1805,6 +1805,17 @@ function RAT:SetMaxCruiseSpeed(speed)
   return self
 end
 
+--- Set the minimum cruise speed of the aircraft.
+-- @param #RAT self
+-- @param #number speed Speed in km/h.
+-- @return #RAT RAT self object.
+function RAT:SetMinCruiseSpeed(speed)
+  self:F2(speed)
+  -- Convert to m/s.
+  self.Vcruisemin=speed/3.6
+  return self
+end
+
 --- Set the climb rate. This automatically sets the climb angle.
 -- @param #RAT self
 -- @param #number rate Climb rate in ft/min. Default is 1500 ft/min. Minimum is 100 ft/min. Maximum is 15,000 ft/min.
@@ -2135,10 +2146,18 @@ function RAT:_InitAircraft(DCSgroup)
     self.aircraft.length=16
     self.aircraft.height=5
     self.aircraft.width=9
-  elseif DCStype == "Saab340" then      --   <- These lines added
-    self.aircraft.length=19.73          --   <- These lines added
-    self.aircraft.height=6.97           --   <- These lines added
-    self.aircraft.width=21.44           --   <- These lines added
+  elseif DCStype == "Saab340" then
+    self.aircraft.length=19.73
+    self.aircraft.height=6.97
+    self.aircraft.width=21.44
+  elseif DCStype == "vwv_l-1049" then
+    self.aircraft.length=35.41
+    self.aircraft.height=7.54
+    self.aircraft.width=38.47
+  elseif DCStype == "uh2b" then
+    self.aircraft.length=11.48          
+    self.aircraft.height=4.11
+    self.aircraft.width=13.41
   end
 
   self.aircraft.box=math.max(self.aircraft.length,self.aircraft.width)
@@ -2813,9 +2832,15 @@ function RAT:_SetRoute(takeoff, landing, _departure, _destination, _waypoint)
     -- Max cruise speed 90% of Vmax or 900 km/h whichever is lower.
     VxCruiseMax = math.min(self.aircraft.Vmax*0.90, 250)
   end
-
-  -- Min cruise speed 70% of max cruise or 600 km/h whichever is lower.
-  local VxCruiseMin = math.min(VxCruiseMax*0.70, 166)
+  
+    -- Min cruise speed.
+  local VxCruiseMin
+  if self.Vcruisemin then
+    VxCruiseMin = self.Vcruisemin
+  else
+    -- Min cruise speed 70% of max cruise or 600 km/h whichever is lower.
+    VxCruiseMin = math.min(VxCruiseMax*0.70, 166)
+  end
 
   -- Cruise speed (randomized). Expectation value at midpoint between min and max.
   local VxCruise = UTILS.RandomGaussian((VxCruiseMax-VxCruiseMin)/2+VxCruiseMin, (VxCruiseMax-VxCruiseMax)/4, VxCruiseMin, VxCruiseMax)
@@ -3814,15 +3839,20 @@ function RAT:Status(message, forID)
       local N0units=group:GetInitialSize()
 
       -- Monitor travelled distance since last check.
-      local Pnow=coords
-      local Dtravel=Pnow:Get2DDistance(ratcraft.Pnow)
-      ratcraft.Pnow=Pnow
+      local Dtravel=0
+      if coords and ratcraft.Pnow then
+        local Dtravel=coords:Get2DDistance(ratcraft.Pnow)
+        ratcraft.Pnow=coords
+      end
 
       -- Add up the travelled distance.
       ratcraft.Distance=ratcraft.Distance+Dtravel
 
       -- Distance remaining to destination.
-      local Ddestination=Pnow:Get2DDistance(ratcraft.destination:GetCoordinate())
+      local Ddestination=-1
+      if ratcraft.Pnow then
+        Ddestination=ratcraft.Pnow:Get2DDistance(ratcraft.destination:GetCoordinate())
+      end
 
       -- Status report.
       if (forID and spawnindex==forID) or (not forID) then
@@ -5579,7 +5609,7 @@ end
 -- @param #string dest Name of the destination airport.
 function RAT:_ATCAddFlight(name, dest)
   -- Debug info
-  BASE:I(RAT.id..string.format("ATC %s: Adding flight %s with destination %s.", dest, name, dest))
+  BASE:T(RAT.id..string.format("ATC %s: Adding flight %s with destination %s.", dest, name, dest))
 
   -- Create new flight  
   local flight={} --#RAT.AtcFlight
@@ -5598,7 +5628,7 @@ end
 function RAT._ATCDelFlight(t,entry)
   for k,_ in pairs(t) do
     if k==entry then
-      BASE:I(RAT.id..string.format("Removing flight %s from queue", entry))
+      BASE:T(RAT.id..string.format("Removing flight %s from queue", entry))
       t[entry]=nil
     end
   end
@@ -5609,7 +5639,7 @@ end
 -- @param #string name Group name of the flight.
 -- @param #number time Time the fight first registered.
 function RAT._ATCRegisterFlight(name, time)
-  BASE:I(RAT.id..string.format("Flight %s registered at ATC for landing clearance.", name))
+  BASE:T(RAT.id..string.format("Flight %s registered at ATC for landing clearance.", name))
   RAT.ATC.flight[name].Tarrive=time
   RAT.ATC.flight[name].holding=0
 end
@@ -5644,15 +5674,16 @@ function RAT._ATCStatus()
   
         -- Aircraft is holding.
         local text=string.format("ATC %s: Flight %s is holding for %i:%02d. %s.", dest, name, hold/60, hold%60, busy)
-        BASE:I(RAT.id..text)
+        BASE:T(RAT.id..text)
   
       elseif hold==RAT.ATC.onfinal then
   
         -- Aircarft is on final approach for landing.
-        local Tfinal=Tnow-flight.Tonfinal
+        local Tonfinal = flight.Tonfinal or timer.getTime()-1
+        local Tfinal=Tnow-Tonfinal
   
         local text=string.format("ATC %s: Flight %s is on final. Waiting %i:%02d for landing event.", dest, name, Tfinal/60, Tfinal%60)
-        BASE:I(RAT.id..text)
+        BASE:T(RAT.id..text)
   
       elseif hold==RAT.ATC.unregistered then
   
@@ -5706,13 +5737,13 @@ function RAT._ATCCheck()
         -- Debug message.
         local text=string.format("ATC %s: Flight %s runway is busy. You are #%d of %d in landing queue. Your holding time is %i:%02d.", 
         airportname, flightname, qID, nqueue, flight.holding/60, flight.holding%60)
-        BASE:I(RAT.id..text)
+        BASE:T(RAT.id..text)
 
       else
 
         local text=string.format("ATC %s: Flight %s was cleared for landing. Your holding time was %i:%02d.", 
         airportname, flightname, flight.holding/60, flight.holding%60)
-        BASE:I(RAT.id..text)
+        BASE:T(RAT.id..text)
 
         -- Clear flight for landing.
         RAT._ATCClearForLanding(airportname, flightname)
@@ -5767,7 +5798,7 @@ function RAT._ATCClearForLanding(airportname, flightname)
 
   
     -- Debug message.
-    BASE:I(RAT.id..string.format("ATC %s: Flight %s cleared for landing", airportname, flightname))
+    BASE:T(RAT.id..string.format("ATC %s: Flight %s cleared for landing", airportname, flightname))
   
     if string.find(flightname,"#") then
       flightname =  string.match(flightname,"^(.+)#")
@@ -5794,8 +5825,9 @@ function RAT._ATCFlightLanded(name)
 
     -- Times for holding and final approach.
     local Tnow=timer.getTime()
-    local Tfinal=Tnow-flight.Tonfinal
-    local Thold=flight.Tonfinal-flight.Tarrive
+    local Tonfinal = flight.Tonfinal or timer.getTime()-1
+    local Tfinal=Tnow-Tonfinal
+    local Thold=Tonfinal-flight.Tarrive
     
     local airport=RAT.ATC.airport[dest] --#RAT.AtcAirport
 
@@ -5818,9 +5850,9 @@ function RAT._ATCFlightLanded(name)
     local TrafficPerHour=airport.traffic/(timer.getTime()-RAT.ATC.T0)*3600
 
     -- Debug info
-    BASE:I(RAT.id..string.format("ATC %s: Flight %s landed. Tholding = %i:%02d, Tfinal = %i:%02d.", dest, name, Thold/60, Thold%60, Tfinal/60, Tfinal%60))
-    BASE:I(RAT.id..string.format("ATC %s: Number of flights still on final %d.", dest, airport.Nonfinal))
-    BASE:I(RAT.id..string.format("ATC %s: Traffic report: Number of planes landed in total %d. Flights/hour = %3.2f.", dest, airport.traffic, TrafficPerHour))
+    BASE:T(RAT.id..string.format("ATC %s: Flight %s landed. Tholding = %i:%02d, Tfinal = %i:%02d.", dest, name, Thold/60, Thold%60, Tfinal/60, Tfinal%60))
+    BASE:T(RAT.id..string.format("ATC %s: Number of flights still on final %d.", dest, airport.Nonfinal))
+    BASE:T(RAT.id..string.format("ATC %s: Traffic report: Number of planes landed in total %d. Flights/hour = %3.2f.", dest, airport.traffic, TrafficPerHour))
     
     if string.find(name,"#") then
       name =  string.match(name,"^(.+)#")

Moose Development/Moose/Functional/Range.lua

@@ -107,6 +107,8 @@
 -- @field Sound.SRS#MSRSQUEUE instructsrsQ SRS queue for range instructor.
 -- @field #number Coalition Coalition side for the menu, if any.
 -- @field Core.Menu#MENU_MISSION menuF10root Specific user defined root F10 menu.
+-- @field #number ceilingaltitude Range ceiling altitude in ft MSL.  Aircraft above this altitude are not considered to be in the range. Default is 20000 ft.
+-- @field #boolean ceilingenabled Range has a ceiling and is not unlimited.  Default is false.
 -- @extends Core.Fsm#FSM
 
 --- *Don't only practice your art, but force your way into its secrets; art deserves that, for it and knowledge can raise man to the Divine.* - Ludwig van Beethoven
@@ -273,6 +275,10 @@
 --      -- Create a range object.
 --      GoldwaterRange=RANGE:New("Goldwater Range")
 --
+--      -- Set and enable the range ceiling altitude in feet MSL.  If aircraft are above this altitude they are not considered to be in the range.
+--      GoldwaterRange:SetRangeCeiling(20000)
+--      GoldwaterRange:EnableRangeCeiling(true)
+--
 --      -- Distance between strafe target and foul line. You have to specify the names of the unit or static objects.
 --      -- Note that this could also be done manually by simply measuring the distance between the target and the foul line in the ME.
 --      GoldwaterRange:GetFoullineDistance("GWR Strafe Pit Left 1", "GWR Foul Line Left")
@@ -358,6 +364,8 @@ RANGE = {
   targetpath = nil,
   targetprefix = nil,
   Coalition = nil,
+  ceilingaltitude = 20000,
+  ceilingenabled = false,
   }
 
 --- Default range parameters.
@@ -594,7 +602,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.
@@ -1085,6 +1093,37 @@ function RANGE:SetRangeZone( zone )
   return self
 end
 
+--- Set range ceiling altitude in feet MSL.
+-- @param #RANGE self
+-- @param #number altitude (optional) Ceiling altitude of the range in ft MSL. Default 20000ft MSL
+-- @return #RANGE self
+function RANGE:SetRangeCeiling( altitude )
+  self:T(self.lid.."SetRangeCeiling")
+  if altitude and type(altitude) == "number" then
+    self.ceilingaltitude=altitude
+  else
+    self:E(self.lid.."Altitude either not provided or is not a number, using default setting (20000).")
+    self.ceilingaltitude=20000
+  end
+  return self
+end
+
+--- Enable range ceiling. Aircraft must be below the ceiling altitude to be considered in the range zone. 
+-- @param #RANGE self
+-- @param #boolean enabled True if you would like to enable the ceiling check.  If no value give, will Default to false.
+-- @return #RANGE self
+function RANGE:EnableRangeCeiling( enabled )
+  self:T(self.lid.."EnableRangeCeiling")
+  if enabled and type(enabled) == "boolean" then
+    self.ceilingenabled=enabled
+  else
+    self:E(self.lid.."Enabled either not provide or is not a boolean, using default setting (false).")
+    self.ceilingenabled=false
+  end
+
+  return self
+end
+
 --- Set smoke color for marking bomb targets. By default bomb targets are marked by red smoke.
 -- @param #RANGE self
 -- @param Utilities.Utils#SMOKECOLOR colorid Color id. Default `SMOKECOLOR.Red`.
@@ -1231,6 +1270,9 @@ function RANGE:SetSRS(PathToSRS, Port, Coalition, Frequency, Modulation, Volume,
     self.controlmsrs:SetCoalition(Coalition or coalition.side.BLUE)
     self.controlmsrs:SetLabel("RANGEC")
     self.controlmsrs:SetVolume(Volume or 1.0)
+    if self.rangezone then
+      self.controlmsrs:SetCoordinate(self.rangezone:GetCoordinate())
+    end
     self.controlsrsQ = MSRSQUEUE:New("CONTROL")
 
     self.instructmsrs=MSRS:New(PathToSRS or MSRS.path, Frequency or 305, Modulation or radio.modulation.AM)
@@ -1238,6 +1280,9 @@ function RANGE:SetSRS(PathToSRS, Port, Coalition, Frequency, Modulation, Volume,
     self.instructmsrs:SetCoalition(Coalition or coalition.side.BLUE)
     self.instructmsrs:SetLabel("RANGEI")
     self.instructmsrs:SetVolume(Volume or 1.0)
+    if self.rangezone then
+      self.instructmsrs:SetCoordinate(self.rangezone:GetCoordinate())
+    end
     self.instructsrsQ = MSRSQUEUE:New("INSTRUCT")
     
     if PathToGoogleKey then 
@@ -1276,8 +1321,13 @@ function RANGE:SetSRSRangeControl( frequency, modulation, voice, culture, gender
   self.rangecontrol = true
   if relayunitname then
     local unit = UNIT:FindByName(relayunitname)
-    local Coordinate = unit:GetCoordinate()
-    self.rangecontrolrelayname = relayunitname
+    if unit then
+      local Coordinate = unit:GetCoordinate()
+      self.rangecontrolrelayname = relayunitname
+      self.controlmsrs:SetCoordinate(Coordinate)
+    else
+      MESSAGE:New("RANGE: Control Relay Unit "..relayunitname.." not found!",15,"ERROR"):ToAllIf(self.Debug):ToLog()
+    end
   end
   return self
 end
@@ -1305,9 +1355,13 @@ function RANGE:SetSRSRangeInstructor( frequency, modulation, voice, culture, gen
   self.instructor = true
   if relayunitname then
     local unit = UNIT:FindByName(relayunitname)
-    local Coordinate = unit:GetCoordinate()
-    self.instructmsrs:SetCoordinate(Coordinate)
-    self.instructorrelayname = relayunitname
+    if unit then
+      local Coordinate = unit:GetCoordinate()
+      self.instructmsrs:SetCoordinate(Coordinate)
+      self.instructorrelayname = relayunitname
+    else
+      MESSAGE:New("RANGE: Instructor Relay Unit "..relayunitname.." not found!",15,"ERROR"):ToAllIf(self.Debug):ToLog()
+    end
   end
   return self
 end
@@ -1893,7 +1947,7 @@ function RANGE:OnEventHit( EventData )
   local _currentTarget = self.strafeStatus[_unitID] --#RANGE.StrafeStatus
 
   -- Player has rolled in on a strafing target.
-  if _currentTarget and target:IsAlive() then
+  if _currentTarget and target and target:IsAlive() then
 
     local playerPos = _unit:GetCoordinate()
     local targetPos = target:GetCoordinate()
@@ -1992,10 +2046,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
 
@@ -2062,7 +2116,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 )
@@ -2595,13 +2654,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.
@@ -2987,7 +3039,7 @@ function RANGE:_DisplayBombTargets( _unitname )
       end
     end
 
-    self:_DisplayMessageToGroup( _unit, _text, 120, true, true, _multiplayer )
+    self:_DisplayMessageToGroup( _unit, _text, 150, true, true, _multiplayer )
   end
 end
 
@@ -3112,7 +3164,10 @@ function RANGE:_CheckPlayers()
 
     if unit and unit:IsAlive() then
 
-      if unit:IsInZone( self.rangezone ) then
+      local unitalt = unit:GetAltitude(false)
+      local unitaltinfeet = UTILS.MetersToFeet(unitalt)
+
+      if unit:IsInZone(self.rangezone) and (not self.ceilingenabled or unitaltinfeet < self.ceilingaltitude) then
 
         ------------------------------
         -- Player INSIDE Range Zone --
@@ -3453,10 +3508,10 @@ function RANGE:_AddF10Commands( _unitName )
         -- Range menu
         local _rangePath = MENU_GROUP:New( group, self.rangename, _rootMenu )
 
-        local _statsPath = MENU_GROUP:New( group, "Statistics", _rangePath )
-        local _markPath = MENU_GROUP:New( group, "Mark Targets", _rangePath )
-        local _settingsPath = MENU_GROUP:New( group, "My Settings", _rangePath )
         local _infoPath = MENU_GROUP:New( group, "Range Info", _rangePath )
+        local _markPath = MENU_GROUP:New( group, "Mark Targets", _rangePath )
+        local _statsPath = MENU_GROUP:New( group, "Statistics", _rangePath )
+        local _settingsPath = MENU_GROUP:New( group, "My Settings", _rangePath )
 
         -- F10/On the Range/<Range Name>/My Settings/
         local _mysmokePath = MENU_GROUP:New( group, "Smoke Color", _settingsPath )

Moose Development/Moose/Functional/Scoring.lua

@@ -90,7 +90,8 @@
 -- @image Scoring.JPG
 
 --- @type SCORING
--- @field Players A collection of the current players that have joined the game.
+-- @field #table Players A collection of the current players that have joined the game.
+-- @field Core.Set#SET_SCENERY ScoringScenery 
 -- @extends Core.Base#BASE
 
 --- SCORING class
@@ -229,7 +230,10 @@ SCORING = {
   ClassID = 0,
   Players = {},
   AutoSave = true,
-  version = "1.18.4"
+  version = "1.18.5",
+  ScoringScenery = nil, -- Core.Set#SET_SCENERY
+  SceneryHitsInZone = false,
+  LoadSave = false,
 }
 
 local _SCORINGCoalition = {
@@ -248,15 +252,16 @@ local _SCORINGCategory = {
 --- Creates a new SCORING object to administer the scoring achieved by players.
 -- @param #SCORING self
 -- @param #string GameName The name of the game. This name is also logged in the CSV score file.
--- @param #string SavePath (Optional) Path where to save the CSV file, defaults to your **<User>\\Saved Games\\DCS\\Logs** folder.
--- @param #boolean AutoSave (Optional) If passed as `false`, then swith autosave off.
+-- @param #string SavePath (Optional) Path where to save the CSV files, defaults to your **<User>\\Saved Games\\DCS\\Logs** folder. See next two options.
+-- @param #boolean AutoSave (Optional) If passed as `false`, then swith autosave off. This stores a detailed table which will never be loaded again by SCORING (for e.g. Discord purposes).
+-- @param #boolean LoadSave (Optional) If passed as `true` save summary scores per player, and load at restart of the mission.
 -- @return #SCORING self
 -- @usage
 --
 --   -- Define a new scoring object for the mission Gori Valley.
 --   ScoringObject = SCORING:New( "Gori Valley" )
 --
-function SCORING:New( GameName, SavePath, AutoSave )
+function SCORING:New( GameName, SavePath, AutoSave, LoadSave )
 
   -- Inherits from BASE
   local self = BASE:Inherit( self, BASE:New() ) -- #SCORING
@@ -264,7 +269,7 @@ function SCORING:New( GameName, SavePath, AutoSave )
   if GameName then
     self.GameName = GameName
   else
-    error( "A game name must be given to register the scoring results" )
+    error( "A game name must be given to register the scoring results!" )
   end
 
   -- Additional Object scores
@@ -299,6 +304,12 @@ function SCORING:New( GameName, SavePath, AutoSave )
   self.penaltyoncoalitionchange = true
   
   self:SetDisplayMessagePrefix()
+  
+  self.SceneryHitsInZone = false
+  
+  if LoadSave then
+    self.LoadSave = LoadSave
+  end
 
   -- Event handlers  
   self:HandleEvent( EVENTS.Dead, self._EventOnDeadOrCrash )
@@ -320,13 +331,67 @@ function SCORING:New( GameName, SavePath, AutoSave )
 
   -- Create the CSV file.
   self.AutoSavePath = SavePath
-  self.AutoSave = AutoSave or true
-  self:OpenCSV( GameName )
+  self.AutoSave = (AutoSave == nil or AutoSave == true) and true or false
+  if self.AutoSavePath and self.AutoSave == true then
+    self:OpenCSV( GameName )
+  end
 
+  self:I("SCORING "..tostring(GameName).." started! v"..self.version)
+  
+  if LoadSave == true then
+    self:_LoadPlayerSummaryScore()
+  end
+  
   return self
 
 end
 
+--- [Internal] Helper to load scores from disk at scoring start
+-- @param #SCORING self
+-- @return #SCORING self
+function SCORING:_LoadPlayerSummaryScore()
+
+  if lfs and io and self.LoadSave == true then
+    local path = self.AutoSavePath or lfs.writedir() .. [[Logs\]]
+    local filename = self.GameName or "PlayerScoresSummary"
+    filename = filename..".csv"
+    if UTILS.CheckFileExists(path,filename) then
+      local ok, data = UTILS.LoadFromFile(path,filename)
+      -- Playername;;Score;;Penalty
+      table.remove(data,1)
+      for _,_data in pairs(data) do
+        local line = UTILS.Split(_data,";;")
+        local playername = tostring(line[1])
+        local score = tonumber(line[2])
+        local penalty = tonumber(line[3])
+        self:I(string.format("Player %s Score %d Penalty %d",playername,score,penalty))
+        local PlayerData = self.Players[playername]
+        if not PlayerData then
+          PlayerData = {}
+          PlayerData.Hit = {}
+          PlayerData.Destroy = {}
+          PlayerData.Goals = {}
+          PlayerData.Goals[self.GameName] = {Score = score, Penalty = penalty}
+          PlayerData.Mission = {}
+          PlayerData.HitPlayers = {}
+          PlayerData.Score = score
+          PlayerData.Penalty = penalty
+          PlayerData.PenaltyCoalition = 0
+          PlayerData.PenaltyWarning = 0 
+          self.Players[playername] = PlayerData
+        else
+          PlayerData.Score = score
+          PlayerData.Penalty =penalty
+          self.Players[playername] = PlayerData
+          PlayerData.Goals[self.GameName] = {Score = score, Penalty = penalty}
+        end
+      end
+    end
+  end
+  
+  return self
+end
+
 --- Set a prefix string that will be displayed at each scoring message sent.
 -- @param #SCORING self
 -- @param #string DisplayMessagePrefix (Default="Scoring: ") The scoring prefix string.
@@ -375,7 +440,7 @@ function SCORING:AddUnitScore( ScoreUnit, Score )
   return self
 end
 
---- Removes a @{Wrapper.Unit} for additional scoring when the @{Wrapper.Unit} is destroyed.
+--- Removes a @{Wrapper.Unit} for scoring when the @{Wrapper.Unit} is destroyed.
 -- @param #SCORING self
 -- @param Wrapper.Unit#UNIT ScoreUnit The @{Wrapper.Unit} for which the Score needs to be given.
 -- @return #SCORING
@@ -392,10 +457,26 @@ end
 -- Note that if there was already a @{Wrapper.Static} declared within the scoring with the same name,
 -- then the old @{Wrapper.Static}  will be replaced with the new @{Wrapper.Static}.
 -- @param #SCORING self
--- @param Wrapper.Static#UNIT ScoreStatic The @{Wrapper.Static} for which the Score needs to be given.
+-- @param Wrapper.Static#STATIC ScoreStatic The @{Wrapper.Static} for which the Score needs to be given.
 -- @param #number Score The Score value.
 -- @return #SCORING
 function SCORING:AddStaticScore( ScoreStatic, Score )
+  return self:AddScoreStatic( ScoreStatic, Score ) 
+end
+
+--- Add a @{Wrapper.Static} for additional scoring when the @{Wrapper.Static} is destroyed.
+-- Note that if there was already a @{Wrapper.Static} declared within the scoring with the same name,
+-- then the old @{Wrapper.Static}  will be replaced with the new @{Wrapper.Static}.
+-- @param #SCORING self
+-- @param Wrapper.Static#STATIC ScoreStatic The @{Wrapper.Static} for which the Score needs to be given.
+-- @param #number Score The Score value.
+-- @return #SCORING
+function SCORING:AddScoreStatic( ScoreStatic, Score )
+
+  if ScoreStatic == nil then
+    BASE:E("SCORING.AddStaticScore: Parameter ScoreStatic is nil!")
+    return self
+  end
 
   local StaticName = ScoreStatic:GetName()
 
@@ -404,7 +485,61 @@ function SCORING:AddStaticScore( ScoreStatic, Score )
   return self
 end
 
---- Removes a @{Wrapper.Static} for additional scoring when the @{Wrapper.Static} is destroyed.
+--- Add a @{Wrapper.Scenery} for additional scoring when the @{Wrapper.Scenery} is destroyed.
+-- @param #SCORING self
+-- @param Wrapper.Scenery#SCENERY ScoreScenery The @{Wrapper.Scenery} for which the Score needs to be given.
+-- @param #number Score The Score value.
+-- @return #SCORING
+function SCORING:AddScoreScenery( ScoreScenery, Score )
+
+  if ScoreScenery == nil then
+    self:E("SCORING.ScoreScenery: Parameter ScoreScenery is nil!")
+    return self
+  end
+  
+  if not self.ScoringScenery then
+    self.ScoringScenery = SET_SCENERY:New() -- Core.Set#SET_SCENERY
+  end
+  
+  local StaticName = ScoreScenery:GetName()
+  self:T("Scenery name = ".. StaticName)
+
+  self.ScoringScenery:AddScenery(ScoreScenery)
+
+  return self
+end
+
+--- Removes a @{Wrapper.Scenery} for scoring when the @{Wrapper.Scenery} is destroyed.
+-- @param #SCORING self
+-- @param Wrapper.Scenery#SCENERY ScoreStatic The @{Wrapper.Scenery} for which the Score needs to be given.
+-- @return #SCORING
+function SCORING:RemoveSceneryScore( ScoreScenery )
+
+  local StaticName = ScoreScenery:GetName()
+
+  self.ScoringObjects[StaticName] = nil
+
+  return self
+end
+
+--- Specify a special additional score for a @{Core.Set#SET_SCENERY}.
+-- @param #SCORING self
+-- @param Core.Set#SET_SCENERY Set The @{Core.Set#SET_SCENERY} for which each @{Wrapper.Scenery} in the SET a Score is given.
+-- @param #number Score The Score value.
+-- @return #SCORING
+function SCORING:AddScoreSetScenery(Set, Score)
+  local set = Set.Set
+  
+  for _,_static in pairs (set) do
+    if _static ~= nil then
+      self:AddScoreScenery(_static,Score)
+    end
+  end
+ 
+  return self
+end
+
+--- Removes a @{Wrapper.Static} for scoring when the @{Wrapper.Static} is destroyed.
 -- @param #SCORING self
 -- @param Wrapper.Static#UNIT ScoreStatic The @{Wrapper.Static} for which the Score needs to be given.
 -- @return #SCORING
@@ -459,6 +594,31 @@ function SCORING:AddScoreSetGroup(Set, Score)
   return self
 end
 
+--- Specify a special additional score for a @{Core.Set#SET_STATIC}.
+-- @param #SCORING self
+-- @param Core.Set#SET_STATIC Set The @{Core.Set#SET_STATIC} for which each @{Wrapper.Static} in the SET a Score is given.
+-- @param #number Score The Score value.
+-- @return #SCORING
+function SCORING:AddScoreSetStatic(Set, Score)
+  local set = Set:GetSetObjects()
+  
+  for _,_static in pairs (set) do
+    if _static and _static:IsAlive() then
+      self:AddStaticScore(_static,Score)
+    end
+  end
+  
+  local function AddScore(static)
+    self:AddStaticScore(static,Score)
+  end
+  
+  function Set:OnAfterAdded(From,Event,To,ObjectName,Object)
+    AddScore(Object)
+  end
+  
+  return self
+end
+
 --- Add a @{Core.Zone} to define additional scoring when any object is destroyed in that zone.
 -- Note that if a @{Core.Zone} with the same name is already within the scoring added, the @{Core.Zone} (type) and Score will be replaced!
 -- This allows for a dynamic destruction zone evolution within your mission.
@@ -478,7 +638,40 @@ function SCORING:AddZoneScore( ScoreZone, Score )
   return self
 end
 
---- Remove a @{Core.Zone} for additional scoring.
+--- Allow Scenery hits in Zones to count (no specific(!) scenery targets). NOTE - Allowing this can spam your scoring display!
+-- @param #SCORING self
+-- @return #SCORING self
+function SCORING:EnableSceneryHitsinZones()
+  self.SceneryHitsInZone = true
+  return self
+end
+
+--- Disallow Scenery hits in Zones to count (no specific(!) scenery targets).
+-- @param #SCORING self
+-- @return #SCORING self
+function SCORING:DisableSceneryHitsinZones()
+  self.SceneryHitsInZone = false
+  return self
+end
+
+--- Add a @{Core.Set#SET_ZONE} to define additional scoring when any object is destroyed in that zone.
+-- Note that if a @{Core.Zone} with the same name is already within the scoring added, the @{Core.Zone} (type) and Score will be replaced!
+-- This allows for a dynamic destruction zone evolution within your mission.
+-- @param #SCORING self
+-- @param Core.Set#SET_ZONE ScoreZoneSet The @{Core.Set#SET_ZONE} which defines the destruction score perimeters.
+-- Note that a zone can be a polygon or a moving zone.
+-- @param #number Score The Score value.
+-- @return #SCORING
+function SCORING:AddZoneScoreSet( ScoreZoneSet, Score )
+  
+  for _,_zone in pairs(ScoreZoneSet.Set or {}) do
+    self:AddZoneScore(_zone,Score)
+  end
+ 
+  return self
+end
+
+--- Remove a @{Core.Zone} for scoring.
 -- The scoring will search if any @{Core.Zone} is added with the given name, and will remove that zone from the scoring.
 -- This allows for a dynamic destruction zone evolution within your mission.
 -- @param #SCORING self
@@ -759,6 +952,20 @@ function SCORING:AddGoalScorePlayer( PlayerName, GoalTag, Text, Score )
   -- PlayerName can be nil, if the Unit with the player crashed or due to another reason.
   if PlayerName then
     local PlayerData = self.Players[PlayerName]
+    if not PlayerData then
+      PlayerData = {}
+      PlayerData.Goals = {}
+      PlayerData.Hit = {}
+      PlayerData.Destroy = {}
+      PlayerData.Goals = {}
+      PlayerData.Mission = {}
+      PlayerData.HitPlayers = {}
+      PlayerData.Score = 0
+      PlayerData.Penalty = 0
+      PlayerData.PenaltyCoalition = 0
+      PlayerData.PenaltyWarning = 0  
+      self.Players[PlayerName] = PlayerData
+    end
 
     PlayerData.Goals[GoalTag] = PlayerData.Goals[GoalTag] or { Score = 0 }
     PlayerData.Goals[GoalTag].Score = PlayerData.Goals[GoalTag].Score + Score
@@ -956,7 +1163,7 @@ end
 -- @param #SCORING self
 -- @param Core.Event#EVENTDATA Event
 function SCORING:_EventOnHit( Event )
-  self:F( { Event } )
+  --self:F( { Event } )
 
   local InitUnit = nil
   local InitUNIT = nil
@@ -985,6 +1192,8 @@ function SCORING:_EventOnHit( Event )
   local TargetUnitCoalition = nil
   local TargetUnitCategory = nil
   local TargetUnitType = nil
+  local TargetIsScenery = false
+  local TargetSceneryObject = nil
 
   if Event.IniDCSUnit then
 
@@ -1006,7 +1215,7 @@ function SCORING:_EventOnHit( Event )
     InitUnitCategory = _SCORINGCategory[InitCategory]
     InitUnitType = InitType
 
-    self:T( { InitUnitName, InitGroupName, InitPlayerName, InitCoalition, InitCategory, InitType, InitUnitCoalition, InitUnitCategory, InitUnitType } )
+    --self:T( { InitUnitName, InitGroupName, InitPlayerName, InitCoalition, InitCategory, InitType, InitUnitCoalition, InitUnitCategory, InitUnitType } )
   end
 
   if Event.TgtDCSUnit then
@@ -1024,12 +1233,23 @@ function SCORING:_EventOnHit( Event )
     -- TargetCategory = TargetUnit:getDesc().category
     TargetCategory = Event.TgtCategory
     TargetType = Event.TgtTypeName
+    
 
+    -- Scenery hit
+    if TargetUNIT ~= nil and TargetUNIT:IsInstanceOf("SCENERY") then
+        TargetCategory = Unit.Category.STRUCTURE
+        TargetIsScenery = true
+        TargetType = "Scenery"
+        TargetSceneryObject = TargetUNIT
+        self:T("***** Target is Scenery and TargetUNIT is SCENERY object!")
+        --UTILS.PrintTableToLog(TargetSceneryObject)
+    end
+    
     TargetUnitCoalition = _SCORINGCoalition[TargetCoalition]
     TargetUnitCategory = _SCORINGCategory[TargetCategory]
     TargetUnitType = TargetType
 
-    self:T( { TargetUnitName, TargetGroupName, TargetPlayerName, TargetCoalition, TargetCategory, TargetType, TargetUnitCoalition, TargetUnitCategory, TargetUnitType } )
+    --self:T( { TargetUnitName=TargetUnitName, TargetGroupName=TargetGroupName, TargetPlayerName=TargetPlayerName, TargetCoalition=TargetCoalition, TargetCategory=TargetCategory, TargetType=TargetType, TargetUnitCoalition=TargetUnitCoalition, TargetUnitCategory=TargetUnitCategory, TargetUnitType=TargetUnitType } )
   end
 
   if InitPlayerName ~= nil then -- It is a player that is hitting something
@@ -1042,7 +1262,7 @@ function SCORING:_EventOnHit( Event )
       self:T( "Hitting Something" )
 
       -- What is he hitting?
-      if TargetCategory then
+      if (TargetCategory ~=nil) and (TargetIsScenery == false) then
 
         -- A target got hit, score it.
         -- Player contains the score data from self.Players[InitPlayerName]
@@ -1062,7 +1282,7 @@ function SCORING:_EventOnHit( Event )
         PlayerHit.TimeStamp = PlayerHit.TimeStamp or 0
         PlayerHit.UNIT = PlayerHit.UNIT or TargetUNIT
         -- After an instant kill we can't compute the threat level anymore. To fix this we compute at OnEventBirth
-        if PlayerHit.UNIT.ThreatType == nil then
+        if PlayerHit.UNIT and PlayerHit.UNIT.ThreatType == nil then
           PlayerHit.ThreatLevel, PlayerHit.ThreatType = PlayerHit.UNIT:GetThreatLevel()
           -- if this fails for some reason, set a good default value
           if PlayerHit.ThreatType == nil or PlayerHit.ThreatType == "" then
@@ -1117,17 +1337,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() )
@@ -1143,21 +1368,21 @@ function SCORING:_EventOnHit( Event )
 
   -- It is a weapon initiated by a player, that is hitting something
   -- This seems to occur only with scenery and static objects.
-  if Event.WeaponPlayerName ~= nil then
-    self:_AddPlayerFromUnit( Event.WeaponUNIT )
-    if self.Players[Event.WeaponPlayerName] then -- This should normally not happen, but i'll test it anyway.
-      if TargetPlayerName ~= nil then -- It is a player hitting another player ...
-        self:_AddPlayerFromUnit( TargetUNIT )
-      end
+  if Event.WeaponPlayerName ~= nil or TargetIsScenery == true then
+    
+    local playername = Event.WeaponPlayerName or Event.IniPlayerName or "Ghost"
+  
+    --self:_AddPlayerFromUnit( Event.WeaponUNIT )
+    if self.Players[playername] then -- This should normally not happen, but i'll test it anyway.
 
-      self:T( "Hitting Scenery" )
+      self:T( "Hitting Scenery or Static" )
 
       -- What is he hitting?
-      if TargetCategory then
+      if Event.TgtObjectCategory then
 
         -- A scenery or static got hit, score it.
         -- Player contains the score data from self.Players[WeaponPlayerName]
-        local Player = self.Players[Event.WeaponPlayerName]
+        local Player = self.Players[playername]
 
         -- Ensure there is a hit table per TargetCategory and TargetUnitName.
         Player.Hit[TargetCategory] = Player.Hit[TargetCategory] or {}
@@ -1165,15 +1390,17 @@ function SCORING:_EventOnHit( Event )
 
         -- PlayerHit contains the score counters and data per unit that was hit.
         local PlayerHit = Player.Hit[TargetCategory][TargetUnitName]
-
+        
+        -- Init player scores
         PlayerHit.Score = PlayerHit.Score or 0
         PlayerHit.Penalty = PlayerHit.Penalty or 0
         PlayerHit.ScoreHit = PlayerHit.ScoreHit or 0
         PlayerHit.PenaltyHit = PlayerHit.PenaltyHit or 0
         PlayerHit.TimeStamp = PlayerHit.TimeStamp or 0
         PlayerHit.UNIT = PlayerHit.UNIT or TargetUNIT
+        
         -- After an instant kill we can't compute the threat level anymore. To fix this we compute at OnEventBirth
-        if PlayerHit.UNIT.ThreatType == nil then
+        if PlayerHit.UNIT and PlayerHit.UNIT.ThreatType == nil then
           PlayerHit.ThreatLevel, PlayerHit.ThreatType = PlayerHit.UNIT:GetThreatLevel()
           -- if this fails for some reason, set a good default value
           if PlayerHit.ThreatType == nil then
@@ -1181,8 +1408,8 @@ function SCORING:_EventOnHit( Event )
             PlayerHit.ThreatType = "Unknown"
           end
         else
-          PlayerHit.ThreatLevel = PlayerHit.UNIT.ThreatLevel
-          PlayerHit.ThreatType = PlayerHit.UNIT.ThreatType
+          PlayerHit.ThreatLevel = PlayerHit.UNIT and PlayerHit.UNIT.ThreatLevel or 1
+          PlayerHit.ThreatType = PlayerHit.UNIT and PlayerHit.UNIT.ThreatType or "Unknown"
         end
 
         -- Only grant hit scores if there was more than one second between the last hit.        
@@ -1190,50 +1417,69 @@ function SCORING:_EventOnHit( Event )
           PlayerHit.TimeStamp = timer.getTime()
 
           local Score = 0
-
-          if InitCoalition then -- A coalition object was hit, probably a static.
-            if InitCoalition == TargetCoalition then
-              -- TODO: Penalty according scale
-              local Penalty = 10
-              Player.Penalty = Player.Penalty + Penalty --* self.ScaleDestroyPenalty
-              PlayerHit.Penalty = PlayerHit.Penalty + Penalty --* self.ScaleDestroyPenalty
-              PlayerHit.PenaltyHit = PlayerHit.PenaltyHit + 1 * self.ScaleDestroyPenalty
-      
-              MESSAGE
-                :NewType( self.DisplayMessagePrefix .. "Player '" .. Event.WeaponPlayerName .. "' hit friendly target " .. 
-                      TargetUnitCategory .. " ( " .. TargetType .. " ) " .. 
-                      "Penalty: -" .. Penalty .. " = " .. Player.Score - Player.Penalty,
-                      MESSAGE.Type.Update
-                    )
-                :ToAllIf( self:IfMessagesHit() and self:IfMessagesToAll() )
-                :ToCoalitionIf( Event.WeaponCoalition, self:IfMessagesHit() and self:IfMessagesToCoalition() )
-              self:ScoreCSV( Event.WeaponPlayerName, TargetPlayerName, "HIT_PENALTY", 1, -10, Event.WeaponName, Event.WeaponCoalition, Event.WeaponCategory, Event.WeaponTypeName, TargetUnitName, TargetUnitCoalition, TargetUnitCategory, TargetUnitType )
-            else
+          
+          local TgtName = Event.TgtDCSUnit and Event.TgtDCSUnit.getName and Event.TgtDCSUnit:getName() or "Unknown"
+          
+          --if InitCoalition then -- A coalition object was hit, probably a static.
+            if TargetIsScenery == true and self.ScoringScenery:IsInSet(TargetSceneryObject) then
               Player.Score = Player.Score + self.ScoreIncrementOnHit
               PlayerHit.Score = PlayerHit.Score + self.ScoreIncrementOnHit
               PlayerHit.ScoreHit = PlayerHit.ScoreHit + 1
-              MESSAGE:NewType( self.DisplayMessagePrefix .. "Player '" .. Event.WeaponPlayerName .. "' hit enemy target " .. TargetUnitCategory .. " ( " .. TargetType .. " ) " ..
+              MESSAGE:NewType( self.DisplayMessagePrefix .. "Player '" .. playername .. "' hit scenery target " .. TargetUnitCategory .. " ( " .. TargetType .. " ) " ..
                                "Score: " .. PlayerHit.Score .. ".  Score Total:" .. Player.Score - Player.Penalty,
                                MESSAGE.Type.Update )
                      :ToAllIf( self:IfMessagesHit() and self:IfMessagesToAll() )
                      :ToCoalitionIf( Event.WeaponCoalition, self:IfMessagesHit() and self:IfMessagesToCoalition() )
 
-              self:ScoreCSV( Event.WeaponPlayerName, TargetPlayerName, "HIT_SCORE", 1, 1, Event.WeaponName, Event.WeaponCoalition, Event.WeaponCategory, Event.WeaponTypeName, TargetUnitName, TargetUnitCoalition, TargetUnitCategory, TargetUnitType )
-            end
-          else -- A scenery object was hit.
-            MESSAGE:NewType( self.DisplayMessagePrefix .. "Player '" .. Event.WeaponPlayerName .. "' hit scenery object.",
-                             MESSAGE.Type.Update )
-                   :ToAllIf( self:IfMessagesHit() and self:IfMessagesToAll() )
-                   :ToCoalitionIf( InitCoalition, self:IfMessagesHit() and self:IfMessagesToCoalition() )
+              self:ScoreCSV( playername, TargetPlayerName, "HIT_SCORE", 1, 1, Event.WeaponName, Event.WeaponCoalition, Event.WeaponCategory, Event.WeaponTypeName, TargetUnitName, TargetUnitCoalition, TargetUnitCategory, TargetUnitType )
+           elseif TargetIsScenery == false and Event.TgtObjectCategory == Object.Category.STATIC and self.ScoringObjects[TgtName] then
+              Player.Score = Player.Score + self.ScoreIncrementOnHit
+              PlayerHit.Score = PlayerHit.Score + self.ScoreIncrementOnHit
+              PlayerHit.ScoreHit = PlayerHit.ScoreHit + 1
+              MESSAGE:NewType( self.DisplayMessagePrefix .. "Player '" .. playername .. "' hit static target " .. TargetUnitCategory .. " ( " .. TargetType .. " ) " ..
+                               "Score: " .. PlayerHit.Score .. ".  Score Total:" .. Player.Score - Player.Penalty,
+                               MESSAGE.Type.Update )
+                     :ToAllIf( self:IfMessagesHit() and self:IfMessagesToAll() )
+                     :ToCoalitionIf( Event.WeaponCoalition, self:IfMessagesHit() and self:IfMessagesToCoalition() )
 
-            self:ScoreCSV( Event.WeaponPlayerName, "", "HIT_SCORE", 1, 0, Event.WeaponName, Event.WeaponCoalition, Event.WeaponCategory, Event.WeaponTypeName, TargetUnitName, "", "Scenery", TargetUnitType )
-          end
+              self:ScoreCSV( playername, TargetPlayerName, "HIT_SCORE", 1, 1, Event.WeaponName, Event.WeaponCoalition, Event.WeaponCategory, Event.WeaponTypeName, TargetUnitName, TargetUnitCoalition, TargetUnitCategory, TargetUnitType )
+            
+            else
+              self:E("Hit unregistered scenery or static object - NO target! ("..TgtName..")")
+            end
+          --end
         end
       end
     end
+  
+    -- Check if there are Zones where the destruction happened.
+  for ZoneName, ScoreZoneData in pairs( self.ScoringZones ) do
+    self:F( { ScoringZone = ScoreZoneData } )
+    local hit=Event.TgtUnit
+    local ScoreZone = ScoreZoneData.ScoreZone -- Core.Zone#ZONE_BASE
+    local Score = ScoreZoneData.Score
+    if TargetUNIT and ScoreZone:IsVec2InZone( TargetUNIT:GetVec2() ) then
+      -- A scenery or static got hit, score it.
+      -- Player contains the score data from self.Players[WeaponPlayerName]
+      local PlayerName = Event.IniPlayerName or "Ghost"
+      local Player = self.Players[PlayerName]
+      if Player then  
+        Player.Score = Player.Score + Score
+        Player.Score = Player.Score + self.ScoreIncrementOnHit
+        MESSAGE:NewType( self.DisplayMessagePrefix .. "hit in zone '" .. ScoreZone:GetName() .. "'." ..
+                         "Player '" .. PlayerName .. "' receives an extra " .. Score .. " points! " .. "Total: " .. Player.Score - Player.Penalty,
+                         MESSAGE.Type.Information )
+               :ToAllIf( self:IfMessagesZone() and self:IfMessagesToAll() )
+               :ToCoalitionIf( InitCoalition, self:IfMessagesZone() and self:IfMessagesToCoalition() )
+    
+        self:ScoreCSV( PlayerName, "", "HIT_SCORE", 1, Score, InitUnitName, InitUnitCoalition, InitUnitCategory, InitUnitType, TargetUnitName, "", "Zone", TargetUnitType )
+        end
+        end
+    end
   end
-end
-
+  
+ end
+ 
 --- Track  DEAD or CRASH events for the scoring.
 -- @param #SCORING self
 -- @param Core.Event#EVENTDATA Event
@@ -1291,7 +1537,7 @@ function SCORING:_EventOnDeadOrCrash( Event )
       local Destroyed = false
 
       -- What is the player destroying?
-      if Player and Player.Hit and Player.Hit[TargetCategory] and Player.Hit[TargetCategory][TargetUnitName] and Player.Hit[TargetCategory][TargetUnitName].TimeStamp ~= 0 and (TargetUnit.BirthTime == nil or Player.Hit[TargetCategory][TargetUnitName].TimeStamp > TargetUnit.BirthTime) then -- Was there a hit for this unit for this player before registered???
+      if Player and Player.Hit and Player.Hit[TargetCategory] and Player.Hit[TargetCategory][TargetUnitName] and Player.Hit[TargetCategory][TargetUnitName].TimeStamp ~= 0 and TargetUnit and (TargetUnit.BirthTime == nil or Player.Hit[TargetCategory][TargetUnitName].TimeStamp > TargetUnit.BirthTime) then -- Was there a hit for this unit for this player before registered???
 
         local TargetThreatLevel = Player.Hit[TargetCategory][TargetUnitName].ThreatLevel
         local TargetThreatType = Player.Hit[TargetCategory][TargetUnitName].ThreatType
@@ -1411,22 +1657,24 @@ function SCORING:_EventOnDeadOrCrash( Event )
 
           end
         else
-          -- Check if there are Zones where the destruction happened.
-          for ZoneName, ScoreZoneData in pairs( self.ScoringZones ) do
-            self:F( { ScoringZone = ScoreZoneData } )
-            local ScoreZone = ScoreZoneData.ScoreZone -- Core.Zone#ZONE_BASE
-            local Score = ScoreZoneData.Score
-            if ScoreZone:IsVec2InZone( TargetUnit:GetVec2() ) then
-              Player.Score = Player.Score + Score
-              TargetDestroy.Score = TargetDestroy.Score + Score
-              MESSAGE:NewType( self.DisplayMessagePrefix .. "Scenery destroyed in zone '" .. ScoreZone:GetName() .. "'." ..
-                               "Player '" .. PlayerName .. "' receives an extra " .. Score .. " points! " .. "Total: " .. Player.Score - Player.Penalty,
-                               MESSAGE.Type.Information )
-                     :ToAllIf( self:IfMessagesZone() and self:IfMessagesToAll() )
-                     :ToCoalitionIf( InitCoalition, self:IfMessagesZone() and self:IfMessagesToCoalition() )
-
-              self:ScoreCSV( PlayerName, "", "DESTROY_SCORE", 1, Score, InitUnitName, InitUnitCoalition, InitUnitCategory, InitUnitType, TargetUnitName, "", "Scenery", TargetUnitType )
-              Destroyed = true
+          if self.SceneryHitsInZone == true then
+            -- Check if there are Zones where the destruction happened.
+            for ZoneName, ScoreZoneData in pairs( self.ScoringZones ) do
+              self:F( { ScoringZone = ScoreZoneData } )
+              local ScoreZone = ScoreZoneData.ScoreZone -- Core.Zone#ZONE_BASE
+              local Score = ScoreZoneData.Score
+              if ScoreZone:IsVec2InZone( TargetUnit:GetVec2() ) then
+                Player.Score = Player.Score + Score
+                TargetDestroy.Score = TargetDestroy.Score + Score
+                MESSAGE:NewType( self.DisplayMessagePrefix .. "Scenery destroyed in zone '" .. ScoreZone:GetName() .. "'." ..
+                                 "Player '" .. PlayerName .. "' receives an extra " .. Score .. " points! " .. "Total: " .. Player.Score - Player.Penalty,
+                                 MESSAGE.Type.Information )
+                       :ToAllIf( self:IfMessagesZone() and self:IfMessagesToAll() )
+                       :ToCoalitionIf( InitCoalition, self:IfMessagesZone() and self:IfMessagesToCoalition() )
+  
+                self:ScoreCSV( PlayerName, "", "DESTROY_SCORE", 1, Score, InitUnitName, InitUnitCoalition, InitUnitCategory, InitUnitType, TargetUnitName, "", "Scenery", TargetUnitType )
+                Destroyed = true
+              end
             end
           end
         end
@@ -1770,9 +2018,12 @@ end
 --- Report all players score
 -- @param #SCORING self
 -- @param Wrapper.Group#GROUP PlayerGroup The player group.
-function SCORING:ReportScoreAllSummary( PlayerGroup )
+-- @param #boolean JustScore If this is true, return just a table with playernames and overall scores.
+-- @return #table ReportTable Table returned if JustScore is true. 
+function SCORING:ReportScoreAllSummary( PlayerGroup, JustScore )
 
   local PlayerMessage = ""
+  local ReportTable = {}
 
   self:T( { "Summary Score Report of All Players", Players = self.Players } )
 
@@ -1804,20 +2055,28 @@ function SCORING:ReportScoreAllSummary( PlayerGroup )
 
       local PlayerScore = ScoreHits + ScoreDestroys + ScoreCoalitionChanges + ScoreGoals + ScoreMissions
       local PlayerPenalty = PenaltyHits + PenaltyDestroys + PenaltyCoalitionChanges + PenaltyGoals + PenaltyMissions
-  
-      PlayerMessage = 
-        string.format( "Player '%s' Score = %d ( %d Score, -%d Penalties )", 
-                       PlayerName, 
-                       PlayerScore - PlayerPenalty, 
-                       PlayerScore, 
-                       PlayerPenalty 
-                     )
-      MESSAGE:NewType( PlayerMessage, MESSAGE.Type.Overview ):ToGroup( PlayerGroup )
+      
+      if JustScore~=true then
+        PlayerMessage = 
+          string.format( "Player '%s' Score = %d ( %d Score, -%d Penalties )", 
+                         PlayerName, 
+                         PlayerScore - PlayerPenalty, 
+                         PlayerScore, 
+                         PlayerPenalty 
+                       )
+        MESSAGE:NewType( PlayerMessage, MESSAGE.Type.Overview ):ToGroup( PlayerGroup )
+      else
+        ReportTable[PlayerName] = {["Score"]=PlayerScore,["Penalty"]=PlayerPenalty}
+      end
     end
   end
-
+  return ReportTable
 end
 
+--- Opens a score CSV file to log the scores.
+-- @param #SCORING self
+-- @param #number sSeconds
+-- @return #string ClockString
 function SCORING:SecondsToClock( sSeconds )
   local nSeconds = sSeconds
   if nSeconds == 0 then
@@ -1923,7 +2182,7 @@ function SCORING:ScoreCSV( PlayerName, TargetPlayerName, ScoreType, ScoreTimes,
   TargetUnitType = TargetUnitType or ""
   TargetUnitName = TargetUnitName or ""
 
-  if lfs and io and os and self.AutoSave then
+  if lfs and io and os and self.AutoSave == true and self.CSVFile ~= nil then
     self.CSVFile:write(
       '"' .. self.GameName        .. '"' .. ',' ..
       '"' .. self.RunTime         .. '"' .. ',' ..
@@ -1945,6 +2204,23 @@ function SCORING:ScoreCSV( PlayerName, TargetPlayerName, ScoreType, ScoreTimes,
 
     self.CSVFile:write( "\n" )
   end
+  
+  if lfs and io and self.LoadSave == true then
+    local path = self.AutoSavePath or lfs.writedir() .. [[Logs\]]
+    local filename = self.GameName or "PlayerScoresSummary"
+    filename = filename..".csv"
+    local data = self:ReportScoreAllSummary("",true)
+    local text = "-- Playername;;Score;;Penalty\n"
+    for _playername,_data in pairs(data or {}) do
+      -- ReportTable[PlayerName] = {["Score"]=PlayerScore,["Penalty"]=PlayerPenalty}
+      local Playername = _playername or "Ghost"
+      local Score = _data.Score or 0
+      local Penalty = _data.Penalty or 0
+      text = text..string.format("%s;;%d;;%d\n",Playername,Score,Penalty)
+    end
+    UTILS.SaveToFile(path,filename,text)
+  end
+  
 end
 
 --- Close CSV file

Moose Development/Moose/Functional/Sead.lua

@@ -19,7 +19,7 @@
 --
 -- ### Authors: **applevangelist**, **FlightControl**
 --
--- Last Update: Dec 2023
+-- Last Update: January 2026
 --
 -- ===
 --
@@ -28,6 +28,16 @@
 
 ---
 -- @type SEAD
+-- @field #string ClassName The Class Name.
+-- @field #table TargetSkill Table of target skills.
+-- @field #table SEADGroupPrefixes Table of SEAD prefixes.
+-- @field #table SuppressedGroups Table of currently suppressed groups.
+-- @field #number EngagementRange Engagement Range.
+-- @field #number Padding Padding in seconds.
+-- @field #function CallBack Callback function for suppression plans.
+-- @field #boolean UseCallBack Switch for callback function to be used.
+-- @field #boolean debug Debug switch.
+-- @field #boolen WeaponTrack Track switch, if true track weapon speed for 30 secs.
 -- @extends Core.Base#BASE
 
 --- Make SAM sites execute evasive and defensive behaviour when being fired upon.
@@ -56,10 +66,11 @@ SEAD = {
   SEADGroupPrefixes = {},
   SuppressedGroups = {},
   EngagementRange = 75, --  default 75% engagement range Feature Request #1355
-  Padding = 10,
+  Padding = 15,
   CallBack = nil,
   UseCallBack = false,
   debug = false,
+  WeaponTrack = false,
 }
 
   --- Missile enumerators
@@ -69,6 +80,7 @@ SEAD = {
   ["AGM_122"] = "AGM_122",
   ["AGM_84"] = "AGM_84",
   ["AGM_45"] = "AGM_45",
+  ["AGM_65"] = "AGM_65",
   ["ALARM"] = "ALARM",
   ["LD-10"] = "LD-10",
   ["X_58"] = "X_58",
@@ -88,6 +100,7 @@ SEAD = {
   -- km and mach
   ["AGM_88"] = { 150, 3},
   ["AGM_45"] = { 12, 2},
+  ["AGM_65"] = { 16, 0.9},
   ["AGM_122"] = { 16.5, 2.3},
   ["AGM_84"] = { 280, 0.8},
   ["ALARM"] = { 45, 2},
@@ -144,7 +157,7 @@ function SEAD:New( SEADGroupPrefixes, Padding )
   self:AddTransition("*",             "ManageEvasion",                "*")
   self:AddTransition("*",             "CalculateHitZone",             "*")
   
-  self:I("*** SEAD - Started Version 0.4.6")
+  self:I("*** SEAD - Started Version 0.4.11")
   return self
 end
 
@@ -305,7 +318,7 @@ function SEAD:onafterCalculateHitZone(From,Event,To,SEADWeapon,pos0,height,SEADG
     elseif height <= 12500 then
       Ropt = Ropt * 0.98
     end
-    
+    local WeaponWrapper = WEAPON:New(SEADWeapon)
     -- look at a couple of zones across the trajectory
     for n=1,3 do
       local dist = Ropt - ((n-1)*20000)
@@ -329,7 +342,7 @@ function SEAD:onafterCalculateHitZone(From,Event,To,SEADWeapon,pos0,height,SEADG
             _targetgroupname = tgtgrp:GetName() -- group name
             _targetskill = tgtgrp:GetUnit(1):GetSkill()
             self:T("*** Found Target = ".. _targetgroupname)
-            self:ManageEvasion(_targetskill,_targetgroup,pos0,"AGM_88",SEADGroup, 20)
+            self:ManageEvasion(_targetskill,_targetgroup,pos0,"AGM_88",SEADGroup, 20, WeaponWrapper)
           end
         --end
       end
@@ -371,7 +384,7 @@ function SEAD:onafterManageEvasion(From,Event,To,_targetskill,_targetgroup,SEADP
         reach = wpndata[1] * 1.1
         local mach = wpndata[2]
         wpnspeed = math.floor(mach * 340.29)
-        if Weapon then
+        if Weapon and Weapon:GetSpeed() > 0 then
           wpnspeed = Weapon:GetSpeed()
           self:T(string.format("*** SEAD - Weapon Speed from WEAPON: %f m/s",wpnspeed))
         end
@@ -429,7 +442,18 @@ function SEAD:onafterManageEvasion(From,Event,To,_targetskill,_targetgroup,SEADP
         local SuppressionStartTime = timer.getTime() + delay
         local SuppressionEndTime = timer.getTime() + delay + _tti + self.Padding + delay
         local _targetgroupname = _targetgroup:GetName()
-        if not self.SuppressedGroups[_targetgroupname] then
+        local shoradactive = _targetgroup:GetProperty("SHORAD_ACTIVE")
+        if not self.SuppressedGroups[_targetgroupname] and shoradactive ~= true then
+          -- TODO: ask callback if suppression is allowed BEFORE scheduling timers
+          local allow = true
+          if self.UseCallBack and self.CallBack and self.CallBack.SeadAllowSuppression then
+            allow = self.CallBack:SeadAllowSuppression(_targetgroup,_targetgroupname,SEADGroup,SEADWeaponName,Weapon,_tti,delay)
+          end
+          if not allow then
+            self:T(string.format("*** SEAD - %s | Suppression vetoed by callback", _targetgroupname))
+            -- Important: do NOT schedule SuppressionStart/Stop and do NOT flip SuppressedGroups true.
+            return self
+          end
           self:T(string.format("*** SEAD - %s | Parameters TTI %ds | Switch-Off in %ds",_targetgroupname,_tti,delay))
           timer.scheduleFunction(SuppressionStart,{_targetgroup,_targetgroupname, SEADGroup},SuppressionStartTime)
           timer.scheduleFunction(SuppressionStop,{_targetgroup,_targetgroupname},SuppressionEndTime)
@@ -452,29 +476,38 @@ end
 -- @return #SEAD self
 function SEAD:HandleEventShot( EventData )
   self:T( { EventData.id } )
-  local SEADPlane = EventData.IniUnit -- Wrapper.Unit#UNIT
-  local SEADGroup = EventData.IniGroup -- Wrapper.Group#GROUP
-  local SEADPlanePos = SEADPlane:GetCoordinate() -- Core.Point#COORDINATE
-  local SEADUnit = EventData.IniDCSUnit
-  local SEADUnitName = EventData.IniDCSUnitName
-  local SEADWeapon = EventData.Weapon -- Identify the weapon fired
-  local SEADWeaponName = EventData.WeaponName -- return weapon type
-
-  local WeaponWrapper = WEAPON:New(EventData.Weapon)
-  --local SEADWeaponSpeed = WeaponWrapper:GetSpeed() -- mps
   
-  self:T( "*** SEAD - Missile Launched = " .. SEADWeaponName)
-  --self:T({ SEADWeapon })
-
+  local SEADWeapon = EventData.Weapon -- Identify the weapon fired
+  local SEADWeaponName = EventData.WeaponName or "None" -- return weapon type
+  
   if self:_CheckHarms(SEADWeaponName) then
+    --UTILS.PrintTableToLog(EventData)
+    local SEADPlane = EventData.IniUnit -- Wrapper.Unit#UNIT
+    
+    if not SEADPlane then return self end -- case IniUnit is empty
+    
+    local SEADGroup = EventData.IniGroup -- Wrapper.Group#GROUP
+    local SEADPlanePos = SEADPlane:GetCoordinate() -- Core.Point#COORDINATE
+    local SEADUnit = EventData.IniDCSUnit
+    local SEADUnitName = EventData.IniDCSUnitName
+  
+    local WeaponWrapper = WEAPON:New(EventData.Weapon) -- Wrapper.Weapon#WEAPON
+    
+    self:T( "*** SEAD - Missile Launched = " .. SEADWeaponName)
+
     self:T( '*** SEAD - Weapon Match' )
+    if self.WeaponTrack == true then
+      WeaponWrapper:SetFuncTrack(function(weapon) env.info(string.format("*** Weapon Speed: %d m/s",weapon:GetSpeed() or -1)) end)
+      WeaponWrapper:StartTrack(0.1)
+      WeaponWrapper:StopTrack(30)
+    end
     local _targetskill = "Random"
     local _targetgroupname = "none"
     local _target = EventData.Weapon:getTarget() -- Identify target
     if not _target or self.debug  then -- AGM-88 or 154 w/o target data
       self:E("***** SEAD - No target data for " .. (SEADWeaponName or "None"))
       if string.find(SEADWeaponName,"AGM_88",1,true) or string.find(SEADWeaponName,"AGM_154",1,true) then
-        self:I("**** Tracking AGM-88/154 with no target data.")
+        self:T("**** Tracking AGM-88/154 with no target data.")
         local pos0 = SEADPlane:GetCoordinate()
         local fheight = SEADPlane:GetHeight()
         self:__CalculateHitZone(20,SEADWeapon,pos0,fheight,SEADGroup,SEADWeaponName)
@@ -520,7 +553,7 @@ function SEAD:HandleEventShot( EventData )
     end
     if SEADGroupFound == true then -- yes we are being attacked
       if string.find(SEADWeaponName,"ADM_141",1,true) then
-        self:__ManageEvasion(2,_targetskill,_targetgroup,SEADPlanePos,SEADWeaponName,SEADGroup,0,WeaponWrapper)
+        self:__ManageEvasion(2,_targetskill,_targetgroup,SEADPlanePos,SEADWeaponName,SEADGroup,2,WeaponWrapper)
       else
         self:ManageEvasion(_targetskill,_targetgroup,SEADPlanePos,SEADWeaponName,SEADGroup,0,WeaponWrapper)
       end

Moose Development/Moose/Functional/Shorad.lua

@@ -21,7 +21,7 @@
 -- @image Functional.Shorad.jpg
 --
 -- Date: Nov 2021
--- Last Update: Nov 2023
+-- Last Update: Jan 2026
 
 -------------------------------------------------------------------------
 --- **SHORAD** class, extends Core.Base#BASE
@@ -48,7 +48,9 @@
 -- @field #number minscootdist Min distance of the next zone
 -- @field #number maxscootdist Max distance of the next zone
 -- @field #boolean scootrandomcoord If true, use a random coordinate in the zone and not the center
--- @field #string scootformation Formation to take for scooting, e.g. "Vee" or "Cone"  
+-- @field #string scootformation Formation to take for scooting, e.g. "Vee" or "Cone" 
+-- @field #boolean SmokeDecoy = false,
+-- @field #number SmokeDecoyColor = SMOKECOLOR.White  
 -- @extends Core.Base#BASE
 
 
@@ -113,8 +115,10 @@ SHORAD = {
   SkateNumber = 3,
   SkateZones = nil,
   minscootdist = 100,
-  minscootdist = 3000,
-  scootrandomcoord = false,  
+  maxscootdist = 3000,
+  scootrandomcoord = false, 
+  SmokeDecoy = false,
+  SmokeDecoyColor = SMOKECOLOR.White 
 }
 
 -----------------------------------------------------------------------
@@ -161,8 +165,10 @@ do
   -- @param #number ActiveTimer Determines how many seconds the systems stay on red alert after wake-up call
   -- @param #string Coalition Coalition, i.e. "blue", "red", or "neutral"
   -- @param #boolean UseEmOnOff Use Emissions On/Off rather than Alarm State Red/Green (default: use Emissions switch)
+  -- @param #boolean SmokeDecoy Throw smoke decoy when getting activated. Defaults to false.
+  -- @param #number SmokeDecoyColor SMOLECOLOR to use. Defaults to SMOLECOLOR.White
   -- @return #SHORAD self
-  function SHORAD:New(Name, ShoradPrefix, Samset, Radius, ActiveTimer, Coalition, UseEmOnOff) 
+  function SHORAD:New(Name, ShoradPrefix, Samset, Radius, ActiveTimer, Coalition, UseEmOnOff, SmokeDecoy, SmokeDecoyColor) 
     local self = BASE:Inherit( self, FSM:New() )
     self:T({Name, ShoradPrefix, Samset, Radius, ActiveTimer, Coalition})
     
@@ -171,6 +177,7 @@ do
     self.name = Name or "MyShorad"
     self.Prefixes = ShoradPrefix or "SAM SHORAD"
     self.Radius = Radius or 20000
+    if type(Coalition) == "number" then Coalition = string.lower(UTILS.GetCoalitionName(Coalition)) end
     self.Coalition = Coalition or "blue"
     self.Samset = Samset or GroupSet
     self.ActiveTimer = ActiveTimer or 600
@@ -181,8 +188,15 @@ do
     self.DefenseLowProb = 70 -- probability to detect a missile shot, low margin
     self.DefenseHighProb = 90  -- probability to detect a missile shot, high margin
     self.UseEmOnOff = true -- Decide if we are using Emission on/off (default) or AlarmState red/green
+    
     if UseEmOnOff == false then self.UseEmOnOff = UseEmOnOff end
-    self:I("*** SHORAD - Started Version 0.3.4")
+    
+    if SmokeDecoy then
+      self.SmokeDecoy = SmokeDecoy
+      self.SmokeDecoyColor = SmokeDecoyColor or SMOKECOLOR.White
+    end
+    
+    self:I("*** SHORAD - Started Version 0.3.6")
     -- Set the string id for output to DCS.log file.
     self.lid=string.format("SHORAD %s | ", self.name)
     self:_InitState()
@@ -443,12 +457,51 @@ do
     for _,_groups in pairs (shoradset) do
       local groupname = _groups:GetName()
       if string.find(groupname, tgtgrp, 1, true) then
-        returnname = true
+        if _groups:IsSAM() then
+          returnname = true
+        end
       end
     end
     return returnname
   end
   
+  --- Set an object to call back when going evasive.
+  -- @param #SHORAD self
+  -- @param #table Object The object to call. 
+  -- @return #SHORAD self
+  function SHORAD:AddCallBack(Object)
+    self:T({Class=Object.ClassName})
+    self.CallBack = Object
+    self.UseCallBack = true
+    return self
+  end
+  
+  --- Smoke a SHORAD Group
+  -- @param #SHORAD self
+  -- @param Wrapper.Group#GROUP Group The Shorad Group to Smoke
+  -- @return self
+  function SHORAD:_SmokeUnits(Group)
+    if self.SmokeDecoy == true then
+      if Group and Group:IsAlive() then
+        local units = Group:GetUnits()
+        for _,_unit in pairs(units) do
+          local unit = _unit -- Wrapper.Unit#UNIT
+          if unit and unit:IsAlive() then
+            local coordinate = unit:GetCoordinate()
+            if coordinate then
+              coordinate:SwitchSmokeOffsetOn()
+              coordinate:Smoke(self.SmokeDecoyColor,Duration,nil,Name,true,1,20)
+              coordinate:Smoke(self.SmokeDecoyColor,Duration,nil,Name,true,180,20)
+              coordinate:Smoke(self.SmokeDecoyColor,Duration,nil,Name,true,270,20)
+              coordinate:Smoke(self.SmokeDecoyColor,Duration,nil,Name,true,90,20)
+            end
+          end
+        end
+      end
+    end
+    return self
+  end
+  
   --- Calculate if the missile shot is detected
   -- @param #SHORAD self
   -- @return #boolean Returns true for a detection, else false
@@ -470,6 +523,7 @@ do
   -- @param #number Radius Radius of the #ZONE
   -- @param #number ActiveTimer Number of seconds to stay active
   -- @param #number TargetCat (optional) Category, i.e. Object.Category.UNIT or Object.Category.STATIC
+  -- @param #boolean ShotAt If true, function is called after a shot
   -- @return #SHORAD self 
   -- @usage Use this function to integrate with other systems, example   
   -- 
@@ -479,9 +533,58 @@ do
   -- mymantis = MANTIS:New("BlueMantis","Blue SAM","Blue EWR",nil,"blue",false,"Blue Awacs")
   -- mymantis:AddShorad(myshorad,720)
   -- mymantis:Start()
-  function SHORAD:onafterWakeUpShorad(From, Event, To, TargetGroup, Radius, ActiveTimer, TargetCat)
+  function SHORAD:onafterWakeUpShorad(From, Event, To, TargetGroup, Radius, ActiveTimer, TargetCat, ShotAt)
     self:T(self.lid .. " WakeUpShorad")
-    self:T({TargetGroup, Radius, ActiveTimer, TargetCat})
+    --self:T({TargetGroup, Radius, ActiveTimer, TargetCat})
+    
+    local TDiff = 4
+    
+    -- local function to switch off shorad again
+    local function SleepShorad(group)
+      if group and group:IsAlive() then
+        local groupname = group:GetName()
+        self.ActiveGroups[groupname] = nil
+        if self.UseEmOnOff then
+          group:EnableEmission(false)
+        else
+          group:OptionAlarmStateGreen()
+        end
+        group:SetProperty("SHORAD_ACTIVE",false)
+        local text = string.format("Sleeping SHORAD %s", group:GetName())
+        self:T(text)
+        local m = MESSAGE:New(text,10,"SHORAD"):ToAllIf(self.debug)
+        --Shoot and Scoot
+        if self.shootandscoot then
+          self:__ShootAndScoot(1,group)
+        else
+          --group:RelocateGroundRandomInRadius(30,500,false,true,"Diamond",true)
+        end
+      end
+    end
+    
+    local function WakeUp(_group,groupname)
+      -- shot at a group we protect
+      local text = string.format("Waking up SHORAD %s", _group:GetName())
+      self:T(text)
+      local m = MESSAGE:New(text,10,"SHORAD"):ToAllIf(self.debug)
+      if self.UseEmOnOff then
+        _group:EnableEmission(true)
+      end
+      _group:OptionAlarmStateRed()
+      _group:SetProperty("SHORAD_ACTIVE",true)
+      self:_SmokeUnits(_group)
+      if self.ActiveGroups[groupname] == nil then -- no timer yet for this group
+        self.ActiveGroups[groupname] = { Timing = ActiveTimer }
+        local endtime = timer.getTime() + (ActiveTimer * math.random(75,100) / 100 ) -- randomize wakeup a bit
+        self.ActiveGroups[groupname].Timer = TIMER:New(SleepShorad,_group):Start(endtime)
+        --Shoot and Scoot
+        if self.shootandscoot then
+          self:__ShootAndScoot(TDiff,_group)
+          TDiff=TDiff+1
+        end
+      end
+    end   
+    
     local targetcat = TargetCat or Object.Category.UNIT
     local targetgroup = TargetGroup
     local targetvec2 = nil
@@ -498,50 +601,41 @@ do
     local groupset = self.Groupset --Core.Set#SET_GROUP
     local shoradset = groupset:GetAliveSet() --#table
     
-    -- local function to switch off shorad again
-    local function SleepShorad(group)
-      if group and group:IsAlive() then
-        local groupname = group:GetName()
-        self.ActiveGroups[groupname] = nil
-        if self.UseEmOnOff then
-          group:EnableEmission(false)
-        else
-          group:OptionAlarmStateGreen()
-        end
-        local text = string.format("Sleeping SHORAD %s", group:GetName())
-        self:T(text)
-        local m = MESSAGE:New(text,10,"SHORAD"):ToAllIf(self.debug)
-        --Shoot and Scoot
-        if self.shootandscoot then
-          self:__ShootAndScoot(1,group)
-        end
-      end
-    end
-    
     -- go through set and find the one(s) to activate
-    local TDiff = 4
+   
     for _,_group in pairs (shoradset) do
-      if _group:IsAnyInZone(targetzone) then
-        local text = string.format("Waking up SHORAD %s", _group:GetName())
-        self:T(text)
-        local m = MESSAGE:New(text,10,"SHORAD"):ToAllIf(self.debug)
-        if self.UseEmOnOff then
-          _group:EnableEmission(true)
+      
+      local groupname = _group:GetName()
+      
+      if groupname == TargetGroup and ShotAt==true then
+        -- Shot at a SHORAD group
+        local allow = false
+        if self.CallBack and self.UseCallBack == true then
+          allow = self.CallBack:SeadAllowSuppression(_group,groupname)
         end
-        _group:OptionAlarmStateRed()
-        local groupname = _group:GetName()
-        if self.ActiveGroups[groupname] == nil then -- no timer yet for this group
-          self.ActiveGroups[groupname] = { Timing = ActiveTimer }
-          local endtime = timer.getTime() + (ActiveTimer * math.random(75,100) / 100 ) -- randomize wakeup a bit
-          self.ActiveGroups[groupname].Timer = TIMER:New(SleepShorad,_group):Start(endtime)
+        if allow == true then
+          if self.UseEmOnOff then
+            _group:EnableEmission(false)
+          end
+          _group:OptionAlarmStateGreen()
+          self.ActiveGroups[groupname] = nil
+          local text = string.format("Shot at SHORAD %s! Evading!", _group:GetName())
+          self:T(text)
+          local m = MESSAGE:New(text,10,"SHORAD"):ToAllIf(self.debug)
+          self:_SmokeUnits(_group)
           --Shoot and Scoot
           if self.shootandscoot then
-            self:__ShootAndScoot(TDiff,_group)
-            TDiff=TDiff+1
+            self:__ShootAndScoot(1,_group)
+          else
+            _group:RelocateGroundRandomInRadius(30,500,false,true,"Diamond",true)
           end
+        else
+          WakeUp(_group,groupname)
         end
-      end
-    end
+      elseif _group:IsAnyInZone(targetzone) or groupname == TargetGroup then
+        WakeUp(_group,groupname)
+      end -- end if
+    end -- end in pairs
     return self
   end
   
@@ -607,7 +701,7 @@ do
             _targetgroupname = tgtgrp:GetName() -- group name
             _targetskill = tgtgrp:GetUnit(1):GetSkill()
             self:T("*** Found Target = ".. _targetgroupname)
-            self:WakeUpShorad(_targetgroupname, self.Radius, self.ActiveTimer, Object.Category.UNIT)
+            self:WakeUpShorad(_targetgroupname, self.Radius, self.ActiveTimer, Object.Category.UNIT,true)
           end
         end
       end     
@@ -657,11 +751,12 @@ do
   -- @param Core.Event#EVENTDATA EventData The event details table data set
   -- @return #SHORAD self 
   function SHORAD:HandleEventShot( EventData )
-    self:T( { EventData } )
+    --self:T( { EventData.id } )
     self:T(self.lid .. " HandleEventShot")
     local ShootingWeapon = EventData.Weapon -- Identify the weapon fired
     local ShootingWeaponName = EventData.WeaponName -- return weapon type
     -- get firing coalition
+    if not EventData.IniGroup then return self end
     local weaponcoalition = EventData.IniGroup:GetCoalition()
     -- get detection probability
     if self:_CheckCoalition(weaponcoalition) then --avoid overhead on friendly fire
@@ -681,7 +776,7 @@ do
         -- Is there target data?
         if not targetdata or self.debug then 
           if string.find(ShootingWeaponName,"AGM_88",1,true) then
-            self:I("**** Tracking AGM-88 with no target data.")
+            self:T("**** Tracking AGM-88 with no target data.")
             local pos0 = EventData.IniUnit:GetCoordinate()
             local fheight = EventData.IniUnit:GetHeight()
             self:__CalculateHitZone(20,ShootingWeapon,pos0,fheight,EventData.IniGroup)
@@ -736,7 +831,7 @@ do
           -- if being shot at, find closest SHORADs to activate
           if shotatsams or shotatus then
             self:T({shotatsams=shotatsams,shotatus=shotatus})
-            self:WakeUpShorad(targetgroupname, self.Radius, self.ActiveTimer, targetcat)
+            self:WakeUpShorad(targetgroupname, self.Radius, self.ActiveTimer, targetcat, true)
           end
         end  
       end

Moose Development/Moose/Functional/Warehouse.lua

@@ -35,7 +35,6 @@
 -- ===
 --
 -- ### Author: **funkyfranky**
--- ### Co-author: FlightControl (cargo dispatcher classes)
 --
 -- ===
 --
@@ -132,14 +131,7 @@
 -- a reasonable degree in DCS at the moment and hence cannot be used yet.
 --
 -- Furthermore, ground assets can be transferred between warehouses by transport units. These are APCs, helicopters and airplanes. The transportation process is modeled
--- in a realistic way by using the corresponding cargo dispatcher classes, i.e.
---
--- * @{AI.AI_Cargo_Dispatcher_APC#AI_DISPATCHER_APC}
--- * @{AI.AI_Cargo_Dispatcher_Helicopter#AI_DISPATCHER_HELICOPTER}
--- * @{AI.AI_Cargo_Dispatcher_Airplane#AI_DISPATCHER_AIRPLANE}
---
--- Depending on which cargo dispatcher is used (ground or airbore), similar considerations like in the self propelled case are necessary. Howver, note that
--- the dispatchers as of yet cannot use user defined off road paths for example since they are classes of their own and use a different routing logic.
+-- in a realistic way by using the @{Ops.OpsTransport#OPSTRANSPORT} class.
 --
 -- ===
 --
@@ -230,18 +222,6 @@
 --  of 630 kg. This is important as groups cannot be split between carrier units when transporting, i.e. the total weight of the whole group must be smaller than the
 --  cargo bay of the transport carrier.
 --
--- ### Setting the Load Radius
--- Boading and loading of cargo into a carrier is modeled in a realistic fashion in the AI\_CARGO\DISPATCHER classes, which are used inernally by the WAREHOUSE class.
--- Meaning that troops (cargo) will board, i.e. run or drive to the carrier, and only once they are in close proximity to the transporter they will be loaded (disappear).
---
--- Unfortunately, there are some situations where problems can occur. For example, in DCS tanks have the strong tentendcy not to drive around obstacles but rather to roll over them.
--- I have seen cases where an aircraft of the same coalition as the tank was in its way and the tank drove right through the plane waiting on a parking spot and destroying it.
---
--- As a workaround it is possible to set a larger load radius so that the cargo units are despawned further away from the carrier via the optional **loadradius** parameter:
---
---     warehouseBatumi:AddAsset("Leopard 2", nil, nil, nil, nil, 250)
---
--- Adding the asset like this will cause the units to be loaded into the carrier already at a distance of 250 meters.
 --
 -- ### Setting the AI Skill
 --
@@ -486,7 +466,7 @@
 -- and the road connection is less than 3 km.
 --
 -- The user can set the road connection manually with the @{#WAREHOUSE.SetRoadConnection} function. This is only functional for self propelled assets at the moment
--- and not if using the AI dispatcher classes since these have a different logic to find the route.
+-- and not if using the OPSTRANSPORT class since this has a different logic to find the route.
 --
 -- ## Off Road Connections
 --
@@ -595,7 +575,7 @@
 --
 -- ## Cargo Bay and Weight Limitations
 --
--- The transportation of cargo is handled by the AI\_Dispatcher classes. These take the cargo bay of a carrier and the weight of
+-- The transportation of cargo is handled by the `OPSTRANSPORT` class. This takes the cargo bay of a carrier and the weight of
 -- the cargo into account so that a carrier can only load a realistic amount of cargo.
 --
 -- However, if troops are supposed to be transported between warehouses, there is one important limitations one has to keep in mind.
@@ -1132,7 +1112,7 @@
 -- specify an "Assignment". This can be later used to identify the request and take the right actions.
 --
 -- Once the request is processed, the @{#WAREHOUSE.OnAfterSelfRequest} function is called. This is where we hook in and postprocess the spawned assets.
--- In particular, we use the @{AI.AI_Formation#AI_FORMATION} class to make some nice escorts for our carrier.
+-- In particular, we use the @{Functional.Formation#FORMATION} class to make some nice escorts for our carrier.
 --
 -- When the resue helo is spawned, we can check that this is the correct asset and make the helo go into formation with the carrier.
 -- Once the helo runs out of fuel, it will automatically return to the ship and land. For the warehouse, this means that the "cargo", i.e. the helicopter
@@ -1175,7 +1155,7 @@
 --
 --         -- Define AI Formation object.
 --         -- Note that this has to be a global variable or the garbage collector will remove it for some reason!
---         CarrierFormationLeft = AI_FORMATION:New(Mother, groupset, "Left Formation with Carrier", "Escort Carrier.")
+--         CarrierFormationLeft = FORMATION:New(Mother, groupset, "Left Formation with Carrier")
 --
 --         -- Formation parameters.
 --         CarrierFormationLeft:FormationLeftWing(200 ,50, 0, 0, 500, 50)
@@ -1190,7 +1170,7 @@
 --
 --         -- Define AI Formation object.
 --         -- Note that this has to be a global variable or the garbage collector will remove it for some reason!
---         CarrierFormationRight = AI_FORMATION:New(Mother, groupset, "Right Formation with Carrier", "Escort Carrier.")
+--         CarrierFormationRight = FORMATION:New(Mother, groupset, "Right Formation with Carrier")
 --
 --         -- Formation parameters.
 --         CarrierFormationRight:FormationRightWing(200 ,50, 0, 0, 500, 50)
@@ -1208,7 +1188,7 @@
 --         group:StartUncontrolled()
 --
 --         -- Define AI Formation object.
---         CarrierFormationHelo = AI_FORMATION:New(Mother, groupset, "Helo Formation with Carrier", "Fly Formation.")
+--         CarrierFormationHelo = FORMATION:New(Mother, groupset, "Helo Formation with Carrier")
 --
 --         -- Formation parameters.
 --         CarrierFormationHelo:FormationCenterWing(-150, 50, 20, 50, 100, 50)
@@ -1798,12 +1778,13 @@ _WAREHOUSEDB  = {
 
 --- Warehouse class version.
 -- @field #string version
-WAREHOUSE.version="1.0.2a"
+WAREHOUSE.version="2.0.0"
 
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 -- TODO: Warehouse todo list.
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
+-- DONE: Switch from AI Dispatchers to OPSTRANSPORT
 -- TODO: Add check if assets "on the move" are stationary. Can happen if ground units get stuck in buildings. If stationary auto complete transport by adding assets to request warehouse? Time?
 -- TODO: Optimize findpathonroad. Do it only once (first time) and safe paths between warehouses similar to off-road paths.
 -- NOGO: Spawn assets only virtually, i.e. remove requested assets from stock but do NOT spawn them ==> Interface to A2A dispatcher! Maybe do a negative sign on asset number?
@@ -3153,7 +3134,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.
@@ -3340,7 +3321,6 @@ function WAREHOUSE:FindAssetInDB(group)
   if aid~=nil then
 
     local asset=_WAREHOUSEDB.Assets[aid]
-    self:T2({asset=asset})
     if asset==nil then
       self:_ErrorMessage(string.format("ERROR: Asset for group %s not found in the data base!", group:GetName()), 0)
     end
@@ -3744,12 +3724,15 @@ function WAREHOUSE:_JobDone()
   
               -- Check conditions for being back home.
               local ishome=false
-              if category==Group.Category.GROUND or category==Group.Category.HELICOPTER then
-                -- Units go back to the spawn zone, helicopters land and they should not move any more.
-                ishome=inspawnzone and onground and notmoving
+              if category==Group.Category.GROUND then
+                -- Ground units go back to the spawn zone and they should not move any more.
+                ishome=inspawnzone and notmoving
               elseif category==Group.Category.AIRPLANE then
                 -- Planes need to be on ground at their home airbase and should not move any more.
                 ishome=athomebase and onground and notmoving
+              elseif category==Group.Category.HELICOPTER then
+                -- Helicopters go back to their airbase or spawn zone and should not move any more.
+                ishome=(athomebase or inspawnzone) and onground and notmoving
               end
   
               -- Debug text.
@@ -3918,7 +3901,7 @@ end
 -- @param #string assignment A free to choose string specifying an assignment for the asset. This can be used with the @{#WAREHOUSE.OnAfterNewAsset} function.
 -- @param #table other (Optional) Table of other useful data. Can be collected via WAREHOUSE.OnAfterNewAsset() function for example
 function WAREHOUSE:onafterAddAsset(From, Event, To, group, ngroups, forceattribute, forcecargobay, forceweight, loadradius, skill, liveries, assignment, other)
-  self:T({group=group, ngroups=ngroups, forceattribute=forceattribute, forcecargobay=forcecargobay, forceweight=forceweight})
+  --self:T({group=group:GetName(), ngroups=ngroups, forceattribute=forceattribute, forcecargobay=forcecargobay, forceweight=forceweight})
 
   -- Set default.
   local n=ngroups or 1
@@ -4113,10 +4096,10 @@ function WAREHOUSE:_RegisterAsset(group, ngroups, forceattribute, forcecargobay,
 
   -- Get name of template group.
   local templategroupname=group:GetName()
-
-  local Descriptors=group:GetUnit(1):GetDesc()
+  local unit = group:GetUnit(1)
+  local Descriptors= (unit and unit:IsAlive()) and unit:GetDesc() or {}
   local Category=group:GetCategory()
-  local TypeName=group:GetTypeName()
+  local TypeName=group:GetTypeName() or "none"
   local SpeedMax=group:GetSpeedMax()
   local RangeMin=group:GetRange()
   local smax,sx,sy,sz=_GetObjectSize(Descriptors)
@@ -4247,6 +4230,16 @@ function WAREHOUSE:_AssetItemInfo(asset)
   self:T3({Template=asset.template})
 end
 
+--- This function uses Disposition and other fallback logic to find better ground positions for ground units.
+--- NOTE: This is not a spawn randomizer.
+--- It will try to find clear ground locations avoiding trees, water, roads, runways, map scenery, statics and other units in the area and modifies the provided positions table.
+--- Maintains the original layout and unit positions as close as possible by searching for the next closest valid position to each unit.
+--- Uses UTILS.ValidateAndRepositionGroundUnits.
+-- @param #boolean Enabled Enable/disable the feature.
+function WAREHOUSE:SetValidateAndRepositionGroundUnits(Enabled)
+    self.ValidateAndRepositionGroundUnits = Enabled
+end
+
 --- On after "NewAsset" event. A new asset has been added to the warehouse stock.
 -- @param #WAREHOUSE self
 -- @param #string From From state.
@@ -4436,7 +4429,6 @@ end
 -- @param #WAREHOUSE.Queueitem Request Information table of the request.
 -- @return #boolean If true, request is granted.
 function WAREHOUSE:onbeforeRequest(From, Event, To, Request)
-  self:T3({warehouse=self.alias, request=Request})
 
   -- Distance from warehouse to requesting warehouse.
   local distance=self:GetCoordinate():Get2DDistance(Request.warehouse:GetCoordinate())
@@ -4689,136 +4681,48 @@ function WAREHOUSE:onafterRequestSpawned(From, Event, To, Request, CargoGroupSet
   ------------------------------------------------------------------------------------------------------------------------------------
   -- Prepare cargo groups for transport
   ------------------------------------------------------------------------------------------------------------------------------------
+  
+  -- TODO: set asset.weight for cargos
 
-  -- Board radius, i.e. when the cargo will begin to board the carrier
-  local _boardradius=500
+  -------------------------
+  -- Create OPSTRANSPORT --
+  -------------------------
 
-  if Request.transporttype==WAREHOUSE.TransportType.AIRPLANE then
-    _boardradius=5000
-  elseif Request.transporttype==WAREHOUSE.TransportType.HELICOPTER then
-    --_loadradius=1000
-    --_boardradius=nil
-  elseif Request.transporttype==WAREHOUSE.TransportType.APC then
-    --_boardradius=nil
-  elseif Request.transporttype==WAREHOUSE.TransportType.SHIP or Request.transporttype==WAREHOUSE.TransportType.AIRCRAFTCARRIER 
-      or Request.transporttype==WAREHOUSE.TransportType.ARMEDSHIP or Request.transporttype==WAREHOUSE.TransportType.WARSHIP then
-    _boardradius=6000
-  end
-
-  -- Empty cargo group set.
-  local CargoGroups=SET_CARGO:New()
-
-  -- Add cargo groups to set.
-  for _,_group in pairs(CargoGroupSet:GetSetObjects()) do
-
-    -- Find asset belonging to this group.
-    local asset=self:FindAssetInDB(_group)
-    -- New cargo group object.
-    local cargogroup=CARGO_GROUP:New(_group, _cargotype,_group:GetName(),_boardradius, asset.loadradius)
-
-    -- Set weight for this group.
-    cargogroup:SetWeight(asset.weight)
-
-    -- Add group to group set.
-    CargoGroups:AddCargo(cargogroup)
-
-  end
-
-  ------------------------
-  -- Create Dispatchers --
-  ------------------------
-
-  -- Cargo dispatcher.
-  local CargoTransport --AI.AI_Cargo_Dispatcher#AI_CARGO_DISPATCHER
+  -- OPSTRANSPORT
+  local CargoTransport --Ops.OpsTransport#OPSTRANSPORT
 
   if Request.transporttype==WAREHOUSE.TransportType.AIRPLANE then
 
-    -- Pickup and deploy zones.
-    local PickupAirbaseSet = SET_ZONE:New():AddZone(ZONE_AIRBASE:New(self.airbase:GetName()))
-    local DeployAirbaseSet = SET_ZONE:New():AddZone(ZONE_AIRBASE:New(Request.airbase:GetName()))
-
-    -- Define dispatcher for this task.
-    CargoTransport = AI_CARGO_DISPATCHER_AIRPLANE:New(TransportGroupSet, CargoGroups, PickupAirbaseSet, DeployAirbaseSet)
-
-    -- Set home zone.
-    CargoTransport:SetHomeZone(ZONE_AIRBASE:New(self.airbase:GetName()))
+    CargoTransport = OPSTRANSPORT:New(CargoGroupSet, ZONE_AIRBASE:New(self.airbase:GetName()), ZONE_AIRBASE:New(Request.airbase:GetName()))
+    CargoTransport:SetEmbarkZone(self.spawnzone)
+    CargoTransport:SetDisembarkZone(Request.warehouse.spawnzone)
 
   elseif Request.transporttype==WAREHOUSE.TransportType.HELICOPTER then
-
-    -- Pickup and deploy zones.
-    local PickupZoneSet = SET_ZONE:New():AddZone(self.spawnzone)
-    local DeployZoneSet = SET_ZONE:New():AddZone(Request.warehouse.spawnzone)
-
-    -- Define dispatcher for this task.
-    CargoTransport = AI_CARGO_DISPATCHER_HELICOPTER:New(TransportGroupSet, CargoGroups, PickupZoneSet, DeployZoneSet)
-
-    -- Home zone.
-    CargoTransport:SetHomeZone(self.spawnzone)
+    
+    CargoTransport = OPSTRANSPORT:New(CargoGroupSet, self.spawnzone, Request.warehouse.spawnzone)
 
   elseif Request.transporttype==WAREHOUSE.TransportType.APC then
 
-    -- Pickup and deploy zones.
-    local PickupZoneSet = SET_ZONE:New():AddZone(self.spawnzone)
-    local DeployZoneSet = SET_ZONE:New():AddZone(Request.warehouse.spawnzone)
-
-    -- Define dispatcher for this task.
-    CargoTransport = AI_CARGO_DISPATCHER_APC:New(TransportGroupSet, CargoGroups, PickupZoneSet, DeployZoneSet, 0)
-
-    -- Set home zone.
-    CargoTransport:SetHomeZone(self.spawnzone)
+    CargoTransport = OPSTRANSPORT:New(CargoGroupSet, self.spawnzone, Request.warehouse.spawnzone)
 
   elseif Request.transporttype==WAREHOUSE.TransportType.SHIP or Request.transporttype==WAREHOUSE.TransportType.AIRCRAFTCARRIER 
-      or Request.transporttype==WAREHOUSE.TransportType.ARMEDSHIP or Request.transporttype==WAREHOUSE.TransportType.WARSHIP then
-
-    -- Pickup and deploy zones.
-    local PickupZoneSet = SET_ZONE:New():AddZone(self.portzone)
-    PickupZoneSet:AddZone(self.harborzone)
-    local DeployZoneSet = SET_ZONE:New():AddZone(Request.warehouse.harborzone)
-
+      or Request.transporttype==WAREHOUSE.TransportType.ARMEDSHIP or Request.transporttype==WAREHOUSE.TransportType.WARSHIP then    
+    
+    CargoTransport = OPSTRANSPORT:New(CargoGroupSet, self.portzone, Request.warehouse.portzone)
+    CargoTransport:SetEmbarkZone(self.spawnzone)
+    CargoTransport:SetDisembarkZone(Request.warehouse.spawnzone)    
 
     -- Get the shipping lane to use and pass it to the Dispatcher
     local remotename = Request.warehouse.warehouse:GetName()
     local ShippingLane = self.shippinglanes[remotename][math.random(#self.shippinglanes[remotename])]
-
-    -- Define dispatcher for this task.
-    CargoTransport = AI_CARGO_DISPATCHER_SHIP:New(TransportGroupSet, CargoGroups, PickupZoneSet, DeployZoneSet, ShippingLane)
-
-    -- Set home zone
-    CargoTransport:SetHomeZone(self.portzone)
+    
+    -- TODO: Add shipping lane
+    -- CargoTransport:AddPathTransport(PathGroup)
 
   else
     self:E(self.lid.."ERROR: Unknown transporttype!")
   end
 
-  -- Set pickup and deploy radii.
-  -- The 20 m inner radius are to ensure that the helo does not land on the warehouse itself in the middle of the default spawn zone.
-  local pickupouter = 200
-  local pickupinner = 0
-  local deployouter = 200
-  local deployinner = 0
-  if Request.transporttype==WAREHOUSE.TransportType.SHIP or Request.transporttype==WAREHOUSE.TransportType.AIRCRAFTCARRIER 
-    or Request.transporttype==WAREHOUSE.TransportType.ARMEDSHIP or Request.transporttype==WAREHOUSE.TransportType.WARSHIP then
-    pickupouter=1000
-    pickupinner=20
-    deployouter=1000
-    deployinner=0
-  else 
-    pickupouter=200
-    pickupinner=0
-    if self.spawnzone.Radius~=nil then
-      pickupouter=self.spawnzone.Radius
-      pickupinner=20
-    end
-    deployouter=200
-    deployinner=0
-    if self.spawnzone.Radius~=nil then
-      deployouter=Request.warehouse.spawnzone.Radius
-      deployinner=20
-    end
-  end
-  CargoTransport:SetPickupRadius(pickupouter, pickupinner)
-  CargoTransport:SetDeployRadius(deployouter, deployinner)
-
 
   -- Adjust carrier units. This has to come AFTER the dispatchers have been defined because they set the cargobay free weight!
   Request.carriercargo={}
@@ -4839,111 +4743,63 @@ function WAREHOUSE:onafterRequestSpawned(From, Event, To, Request, CargoGroupSet
     end
   end
 
-  --------------------------------
-  -- Dispatcher Event Functions --
-  --------------------------------
+  ----------------------------------
+  -- Opstransport Event Functions --
+  ----------------------------------
 
-  --- Function called after carrier picked up something.
-  function CargoTransport:OnAfterPickedUp(From, Event, To, Carrier, PickupZone)
-
-    -- Get warehouse state.
-    local warehouse=Carrier:GetState(Carrier, "WAREHOUSE") --#WAREHOUSE
-
-    -- Debug message.
-    local text=string.format("Carrier group %s picked up at pickup zone %s.", Carrier:GetName(), PickupZone:GetName())
-    warehouse:T(warehouse.lid..text)
-
-  end
-
-  --- Function called if something was deployed.
-  function CargoTransport:OnAfterDeployed(From, Event, To, Carrier, DeployZone)
-
-    -- Get warehouse state.
-    local warehouse=Carrier:GetState(Carrier, "WAREHOUSE") --#WAREHOUSE
-
-    -- Debug message.
-    -- TODO: Depoloy zone is nil!
-    --local text=string.format("Carrier group %s deployed at deploy zone %s.", Carrier:GetName(), DeployZone:GetName())
-    --warehouse:T(warehouse.lid..text)
-
-  end
-
-  --- Function called if carrier group is going home.
-  function CargoTransport:OnAfterHome(From, Event, To, Carrier, Coordinate, Speed, Height, HomeZone)
-
-    -- Get warehouse state.
-    local warehouse=Carrier:GetState(Carrier, "WAREHOUSE") --#WAREHOUSE
-
-    -- Debug message.
-    local text=string.format("Carrier group %s going home to zone %s.", Carrier:GetName(), HomeZone:GetName())
-    warehouse:T(warehouse.lid..text)
-
-  end
+  CargoTransport.warehouse = self
 
   --- Function called when a carrier unit has loaded a cargo group.
-  function CargoTransport:OnAfterLoaded(From, Event, To, Carrier, Cargo, CarrierUnit, PickupZone)
+  function CargoTransport:OnAfterLoaded(From, Event, To, OpsGroupCargo, OpsGroupCarrier, CarrierElement)
 
     -- Get warehouse state.
-    local warehouse=Carrier:GetState(Carrier, "WAREHOUSE") --#WAREHOUSE
-
-    -- Debug message.
-    local text=string.format("Carrier group %s loaded cargo %s into unit %s in pickup zone %s", Carrier:GetName(), Cargo:GetName(), CarrierUnit:GetName(), PickupZone:GetName())
-    warehouse:T(warehouse.lid..text)
+    local warehouse=CargoTransport.warehouse --#WAREHOUSE
 
     -- Get cargo group object.
-    local group=Cargo:GetObject() --Wrapper.Group#GROUP
+    local group=OpsGroupCargo:GetGroup() --Cargo:GetObject() --Wrapper.Group#GROUP
 
      -- Get request.
     local request=warehouse:_GetRequestOfGroup(group, warehouse.pending)
 
     -- Add cargo group to this carrier.
-    table.insert(request.carriercargo[CarrierUnit:GetName()], warehouse:_GetNameWithOut(Cargo:GetName()))
+    table.insert(request.carriercargo[CarrierElement.name], warehouse:_GetNameWithOut(group:GetName()))
 
   end
 
   --- Function called when cargo has arrived and was unloaded.
-  function CargoTransport:OnAfterUnloaded(From, Event, To, Carrier, Cargo, CarrierUnit, DeployZone)
+  function CargoTransport:OnAfterUnloaded(From, Event, To, OpsGroupCargo, OpsGroupCarrier)
 
     -- Get warehouse state.
-    local warehouse=Carrier:GetState(Carrier, "WAREHOUSE") --#WAREHOUSE
+    local warehouse=CargoTransport.warehouse --Carrier:GetState(Carrier, "WAREHOUSE") --#WAREHOUSE
 
     -- Get group obejet.
-    local group=Cargo:GetObject() --Wrapper.Group#GROUP
+    local group=OpsGroupCargo:GetGroup() --Cargo:GetObject() --Wrapper.Group#GROUP
 
     -- Debug message.
-    local text=string.format("Cargo group %s was unloaded from carrier unit %s.", tostring(group:GetName()), tostring(CarrierUnit:GetName()))
+    local text=string.format("Cargo group %s was unloaded from carrier group %s.", tostring(group:GetName()), tostring(OpsGroupCarrier:GetName()))
     warehouse:T(warehouse.lid..text)
 
-    -- Load the cargo in the warehouse.
-    --Cargo:Load(warehouse.warehouse)
-
     -- Trigger Arrived event.
     warehouse:Arrived(group)
   end
+  
+  -- TODO: Probably can also add some cargo/carrier dead functions here to simplify things at other places
 
-  --- On after BackHome event.
-  function CargoTransport:OnAfterBackHome(From, Event, To, Carrier)
-
-    -- Intellisense.
-    local carrier=Carrier --Wrapper.Group#GROUP
-
-    -- Get warehouse state.
-    local warehouse=carrier:GetState(carrier, "WAREHOUSE") --#WAREHOUSE
-    carrier:SmokeWhite()
-
-    -- Debug info.
-    local text=string.format("Carrier %s is back home at warehouse %s.", tostring(Carrier:GetName()), tostring(warehouse.warehouse:GetName()))
-    MESSAGE:New(text, 5):ToAllIf(warehouse.Debug)
-    warehouse:I(warehouse.lid..text)
-
-    -- Call arrived event for carrier.
-    warehouse:__Arrived(1, Carrier)
 
+  -- Assign cargo to carriers  
+  for _,carriergroup in pairs(TransportGroupSet:GetSetObjects()) do
+    local opsgroup=nil
+    if Request.transporttype==WAREHOUSE.TransportType.AIRPLANE or Request.transporttype==WAREHOUSE.TransportType.HELICOPTER then
+      opsgroup=FLIGHTGROUP:New(carriergroup)
+    elseif Request.transporttype==WAREHOUSE.TransportType.APC then
+      opsgroup=ARMYGROUP:New(carriergroup)
+    elseif Request.transporttype==WAREHOUSE.TransportType.SHIP or Request.transporttype==WAREHOUSE.TransportType.AIRCRAFTCARRIER 
+        or Request.transporttype==WAREHOUSE.TransportType.ARMEDSHIP or Request.transporttype==WAREHOUSE.TransportType.WARSHIP then
+      opsgroup=NAVYGROUP:New(carriergroup)
+    end  
+    opsgroup:AddOpsTransport(CargoTransport)
   end
 
-  -- Start dispatcher.
-  CargoTransport:__Start(5)
-
 end
 
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
@@ -5965,6 +5821,10 @@ function WAREHOUSE:_SpawnAssetGroundNaval(alias, asset, request, spawnzone, late
     template.y   = coord.z
     template.alt = coord.y
 
+    if self.ValidateAndRepositionGroundUnits then
+      UTILS.ValidateAndRepositionGroundUnits(template.units)
+    end
+
     -- Spawn group.
     local group=_DATABASE:Spawn(template) --Wrapper.Group#GROUP
 
@@ -6047,7 +5907,7 @@ function WAREHOUSE:_SpawnAssetAircraft(alias, asset, request, parking, uncontrol
 
     else
 
-      if #parking<#template.units and not airstart then
+      if parking and #parking<#template.units and not airstart then
         local text=string.format("ERROR: Not enough parking! Free parking = %d < %d aircraft to be spawned.", #parking, #template.units)
         self:_DebugMessage(text)
         return nil
@@ -6089,7 +5949,7 @@ function WAREHOUSE:_SpawnAssetAircraft(alias, asset, request, parking, uncontrol
           terminal=parking[i].TerminalID
         end
 
-        if self.Debug then
+        if self.Debug and terminal then
           local text=string.format("Spawnplace unit %s terminal %d.", unit.name, terminal)
           coord:MarkToAll(text)
           env.info(text)
@@ -6120,6 +5980,7 @@ function WAREHOUSE:_SpawnAssetAircraft(alias, asset, request, parking, uncontrol
         unit.onboard_num=asset.modex[i]
       end
       if asset.callsign then
+        --UTILS.PrintTableToLog(asset.callsign)
         unit.callsign=asset.callsign[i]
       end
 
@@ -6139,9 +6000,6 @@ function WAREHOUSE:_SpawnAssetAircraft(alias, asset, request, parking, uncontrol
     -- Uncontrolled spawning.
     template.uncontrolled=uncontrolled
 
-    -- Debug info.
-    self:T2({airtemplate=template})
-
     -- Spawn group.
     local group=_DATABASE:Spawn(template) --Wrapper.Group#GROUP
 
@@ -6893,7 +6751,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
@@ -8122,9 +7980,11 @@ function WAREHOUSE:_FindParkingForAssets(airbase, assets)
               -- Debug output for occupied spots.            
               if self.Debug then
                 local coord=problem.coord --Core.Point#COORDINATE
-                local text=string.format("Obstacle %s [type=%s] blocking spot=%d! Size=%.1f m and distance=%.1f m.", problem.name, problem.type, _termid, problem.size, problem.dist)
-                self:I(self.lid..text)
-                coord:MarkToAll(string.format(text))
+                if coord then
+                    local text=string.format("Obstacle %s [type=%s] blocking spot=%d! Size=%.1f m and distance=%.1f m.", problem.name, problem.type, _termid, problem.size, problem.dist)
+                    self:I(self.lid..text)
+                    coord:MarkToAll(text)
+                end
               else
                 self:T(self.lid..string.format("Parking spot %d is occupied or not big enough!", _termid))
               end
@@ -8433,12 +8293,14 @@ function WAREHOUSE:_GetAttribute(group)
   local attribute=WAREHOUSE.Attribute.OTHER_UNKNOWN --#WAREHOUSE.Attribute
 
   if group then
+  
+    local groupCat=group:GetCategory()
 
     -----------
     --- Air ---
     -----------
     -- Planes
-    local transportplane=group:HasAttribute("Transports") and group:HasAttribute("Planes")
+    local transportplane=group:HasAttribute("Transports") and group:HasAttribute("Planes") and groupCat==Group.Category.AIRPLANE
     local awacs=group:HasAttribute("AWACS")
     local fighter=group:HasAttribute("Fighters") or group:HasAttribute("Interceptors") or group:HasAttribute("Multirole fighters") or (group:HasAttribute("Bombers") and not group:HasAttribute("Strategic bombers"))
     local bomber=group:HasAttribute("Strategic bombers")
@@ -8583,6 +8445,8 @@ function WAREHOUSE:_DeleteStockItem(stockitem)
     local item=self.stock[i] --#WAREHOUSE.Assetitem
     if item.uid==stockitem.uid then
       table.remove(self.stock,i)
+      -- remove also from warehouse DB (not good! causes an error if the asset needs to be added to a requesting wherehouse)
+      --_WAREHOUSEDB.Assets[stockitem.uid]=nil
       break
     end
   end
@@ -8593,7 +8457,6 @@ end
 -- @param #WAREHOUSE.Queueitem qitem Item of queue to be removed.
 -- @param #table queue The queue from which the item should be deleted.
 function WAREHOUSE:_DeleteQueueItem(qitem, queue)
-  self:F({qitem=qitem, queue=queue})
 
   for i=1,#queue do
     local _item=queue[i] --#WAREHOUSE.Queueitem

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/Globals.lua

@@ -10,7 +10,7 @@ _SCHEDULEDISPATCHER = SCHEDULEDISPATCHER:New() -- Core.ScheduleDispatcher#SCHEDU
 _DATABASE = DATABASE:New() -- Core.Database#DATABASE
 
 --- Settings
-_SETTINGS = SETTINGS:Set()
+_SETTINGS = SETTINGS:Set() -- Core.Settings#SETTINGS
 _SETTINGS:SetPlayerMenuOn()
 
 --- Register cargos.
@@ -20,6 +20,13 @@ _DATABASE:_RegisterCargos()
 _DATABASE:_RegisterZones()
 _DATABASE:_RegisterAirbases()
 
+--- Function that writes to DCS log file
+-- @param #string text Formatted text.
+-- @param ... Format passed to string.format().
+function printf(text, ...)
+  env.info(string.format(text, ...))
+end
+
 --- Check if os etc is available.
 BASE:I("Checking de-sanitization of os, io and lfs:")
 local __na = false

Moose Development/Moose/Modules.lua

@@ -1,8 +1,6 @@
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Utilities/Enums.lua' )
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Utilities/Utils.lua' )
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Utilities/Profiler.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Utilities/Templates.lua' )
---__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Utilities/STTS.lua' )
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Utilities/FiFo.lua' )
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Utilities/Socket.lua' )
 
@@ -34,6 +32,7 @@ __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' )
@@ -62,7 +61,6 @@ __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Functional/CleanUp.lua' )
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Functional/Movement.lua' )
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Functional/Sead.lua' )
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Functional/Escort.lua' )
-__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Functional/MissileTrainer.lua' )
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Functional/ATC_Ground.lua' )
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Functional/Detection.lua' )
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Functional/DetectionZones.lua' )
@@ -86,6 +84,7 @@ __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Functional/ZoneGoalCargo.lua'
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Functional/Tiresias.lua' )
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Functional/Stratego.lua' )
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Functional/ClientWatch.lua')
+__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Functional/Formation.lua')
 
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Ops/Airboss.lua' )
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Ops/RecoveryTanker.lua' )
@@ -118,43 +117,7 @@ __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Ops/PlayerRecce.lua' )
 __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/Ops/EasyA2G.lua' )
 
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Shapes/ShapeBase.lua' )
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Shapes/Circle.lua' )
@@ -171,21 +134,9 @@ __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/Point.lua' )
+__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Navigation/Beacons.lua' )
+__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Navigation/Radios.lua' )
+__Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Navigation/Towns.lua' )
 
 __Moose.Include( MOOSE_DEVELOPMENT_FOLDER..'/Moose/Globals.lua' )

Moose Development/Moose/Modules_local.lua

@@ -1,181 +0,0 @@
-__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' )
-
-__Moose.Include( 'Core\\Base.lua' )
-__Moose.Include( 'Core\\Beacon.lua' )
-__Moose.Include( 'Core\\UserFlag.lua' )
-__Moose.Include( 'Core\\Report.lua' )
-__Moose.Include( 'Core\\Scheduler.lua' )
-__Moose.Include( 'Core\\ScheduleDispatcher.lua' )
-__Moose.Include( 'Core\\Event.lua' )
-__Moose.Include( 'Core\\Settings.lua' )
-__Moose.Include( 'Core\\Menu.lua' )
-__Moose.Include( 'Core\\Zone.lua' )
-__Moose.Include( 'Core\\Velocity.lua' )
-__Moose.Include( 'Core\\Database.lua' )
-__Moose.Include( 'Core\\Set.lua' )
-__Moose.Include( 'Core\\Point.lua' )
-__Moose.Include( 'Core\\Pathline.lua' )
-__Moose.Include( 'Core\\Message.lua' )
-__Moose.Include( 'Core\\Fsm.lua' )
-__Moose.Include( 'Core\\Spawn.lua' )
-__Moose.Include( 'Core\\SpawnStatic.lua' )
-__Moose.Include( 'Core\\Timer.lua' )
-__Moose.Include( 'Core\\Goal.lua' )
-__Moose.Include( 'Core\\Spot.lua' )
-__Moose.Include( 'Core\\Astar.lua' )
-__Moose.Include( 'Core\\MarkerOps_Base.lua' )
-__Moose.Include( 'Core\\TextAndSound.lua' )
-__Moose.Include( 'Core\\Condition.lua' )
-__Moose.Include( 'Core\\ClientMenu.lua' )
-
-__Moose.Include( 'Wrapper\\Object.lua' )
-__Moose.Include( 'Wrapper\\Identifiable.lua' )
-__Moose.Include( 'Wrapper\\Positionable.lua' )
-__Moose.Include( 'Wrapper\\Controllable.lua' )
-__Moose.Include( 'Wrapper\\Group.lua' )
-__Moose.Include( 'Wrapper\\Unit.lua' )
-__Moose.Include( 'Wrapper\\Client.lua' )
-__Moose.Include( 'Wrapper\\Static.lua' )
-__Moose.Include( 'Wrapper\\Airbase.lua' )
-__Moose.Include( 'Wrapper\\Scenery.lua' )
-__Moose.Include( 'Wrapper\\Marker.lua' )
-__Moose.Include( 'Wrapper\\Net.lua' )
-__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' )
-__Moose.Include( 'Functional\\Sead.lua' )
-__Moose.Include( 'Functional\\Escort.lua' )
-__Moose.Include( 'Functional\\MissileTrainer.lua' )
-__Moose.Include( 'Functional\\ATC_Ground.lua' )
-__Moose.Include( 'Functional\\Detection.lua' )
-__Moose.Include( 'Functional\\DetectionZones.lua' )
-__Moose.Include( 'Functional\\Designate.lua' )
-__Moose.Include( 'Functional\\RAT.lua' )
-__Moose.Include( 'Functional\\Range.lua' )
-__Moose.Include( 'Functional\\ZoneGoal.lua' )
-__Moose.Include( 'Functional\\ZoneGoalCoalition.lua' )
-__Moose.Include( 'Functional\\ZoneCaptureCoalition.lua' )
-__Moose.Include( 'Functional\\Artillery.lua' )
-__Moose.Include( 'Functional\\Suppression.lua' )
-__Moose.Include( 'Functional\\PseudoATC.lua' )
-__Moose.Include( 'Functional\\Warehouse.lua' )
-__Moose.Include( 'Functional\\Fox.lua' )
-__Moose.Include( 'Functional\\Mantis.lua' )
-__Moose.Include( 'Functional\\Shorad.lua' )
-__Moose.Include( 'Functional\\Autolase.lua' )
-__Moose.Include( 'Functional\\AICSAR.lua' )
-__Moose.Include( 'Functional\\AmmoTruck.lua' )
-__Moose.Include( 'Functional\\Tiresias.lua' )
-__Moose.Include( 'Functional\\Stratego.lua' )
-__Moose.Include( 'Functional\\ClientWatch.lua' )
-
-__Moose.Include( 'Ops\\Airboss.lua' )
-__Moose.Include( 'Ops\\RecoveryTanker.lua' )
-__Moose.Include( 'Ops\\RescueHelo.lua' )
-__Moose.Include( 'Ops\\ATIS.lua' )
-__Moose.Include( 'Ops\\Auftrag.lua' )
-__Moose.Include( 'Ops\\Target.lua' )
-__Moose.Include( 'Ops\\OpsGroup.lua' )
-__Moose.Include( 'Ops\\FlightGroup.lua' )
-__Moose.Include( 'Ops\\NavyGroup.lua' )
-__Moose.Include( 'Ops\\ArmyGroup.lua' )
-__Moose.Include( 'Ops\\Cohort.lua' )
-__Moose.Include( 'Ops\\Squadron.lua' )
-__Moose.Include( 'Ops\\Platoon.lua' )
-__Moose.Include( 'Ops\\Legion.lua' )
-__Moose.Include( 'Ops\\AirWing.lua' )
-__Moose.Include( 'Ops\\Brigade.lua' )
-__Moose.Include( 'Ops\\Intelligence.lua' )
-__Moose.Include( 'Ops\\Commander.lua' )
-__Moose.Include( 'Ops\\OpsTransport.lua' )
-__Moose.Include( 'Ops\\CSAR.lua' )
-__Moose.Include( 'Ops\\CTLD.lua' )
-__Moose.Include( 'Ops\\OpsZone.lua' )
-__Moose.Include( 'Ops\\Chief.lua' )
-__Moose.Include( 'Ops\\Flotilla.lua' )
-__Moose.Include( 'Ops\\Fleet.lua' )
-__Moose.Include( 'Ops\\Awacs.lua' )
-__Moose.Include( 'Ops\\PlayerTask.lua' )
-__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' )
-__Moose.Include( 'Sound\\Radio.lua' )
-__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( 'Globals.lua' )

Moose Development/Moose/Navigation/Beacons.lua

@@ -0,0 +1,434 @@
+--- **NAVIGATION** - Beacons of the map/theatre.
+--
+-- **Main Features:**
+--
+--    * Access beacons of the map
+--    * Find closest beacon
+--    * Get frequencies and channels
+-- 
+-- ===
+--
+-- ## 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 MOOSE.JPG
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+--- 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
+
+--- *Hope is the beacon that guides lost ships back to the shore.*
+--
+-- ===
+--
+-- # The BEACONS Concept
+--
+-- This class is designed to make information about beacons of a map/theatre easier accessible. The information contains location, type and frequencies of all or specific beacons of the map.
+-- 
+-- **Note** that try to avoid hard coding stuff in Moose since DCS is updated frequently and things change. Therefore, the main source of information is either a file `beacons.lua` that can be
+-- found in the installation directory of DCS for each map or a table that the user needs to provide.
+-- **Note** your `MissionScripting` environment needs to be desanitized to read this data. `Package` als needs to be available.
+-- 
+-- # Basic Setup
+-- 
+-- A new `BEACONS` object can be created with the @{#BEACONS.NewFromFile}(*beacons_lua_file*) function.
+-- 
+--     local beacons=BEACONS:NewFromFile("<DCS_Install_Directory>\Mods\terrains\<Map_Name>\beacons.lua")
+--     beacons:MarkerShow()
+-- 
+-- This will load the beacons from the `<DCS_Install_Directory>` for the specific map and place markers on the F10 map. This is the first step you should do to ensure that the file
+-- you provided is correct and all relevant beacons are present.
+-- 
+-- # User Functions
+-- 
+-- ## F10 Map Markers
+-- 
+-- ## Position
+-- 
+-- ## Get Closest Beacon
+-- 
+--
+-- @field #BEACONS
+BEACONS = {
+  ClassName  = "BEACONS",
+  verbose    =         1,
+  beacons    =        {},
+}
+
+--- Mission capability.
+-- @type BEACONS.Beacon
+-- @field #function display_name Function that returns the localized name.
+-- @field #number type Beacon type.
+-- @field #string beaconId Beacon ID.
+-- @field #string callsign Call sign.
+-- @field #number frequency Frequency in Hz.
+-- @field #number channel TACAN, RSBN or PRMG channel depending on type.
+-- @field #table position Position table.
+-- @field #number direction Direction in degrees.
+-- @field #table positionGeo Table with latitude and longitude.
+-- @field #table sceneObjects Table with scenery objects, e.g. `{t:393396742}`.
+-- @field #number chartOffsetX No idea what this offset is?!
+-- @field DCS#Vec3 vec3 Position vector 3D.
+-- @field #number markerID ID for the F10 marker.
+-- @field #string typeName Name of becon type.
+-- @field Wrapper.Scenery#SCENERY scenery The scenery object.
+
+--- BEACONS class version.
+-- @field #string version
+BEACONS.version="0.1.0"
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- ToDo list
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+-- TODO: A lot...
+-- DONE: TACAN channel from frequency (was already in beacon.lua as channel)
+-- DONE: Scenery object
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- Constructor(s)
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+--- Create a new BEACONS class instance from a given table.
+-- @param #BEACONS self
+-- @param #table BeaconTable Table with beacon info.
+-- @return #BEACONS self
+function BEACONS:NewFromTable(BeaconTable)
+
+  -- Inherit everything from BASE class.
+  self=BASE:Inherit(self, BASE:New()) -- #BEACONS
+  
+  for _,_beacon in pairs(BeaconTable) do
+    local beacon=_beacon --#BEACONS.Beacon
+    
+    -- Get 3D vector
+    beacon.vec3={x=beacon.position[1], y=beacon.position[2], z=beacon.position[3]}
+    
+    -- Get coordinate
+    beacon.coordinate=COORDINATE:NewFromVec3(beacon.vec3)
+    
+    -- Get type name
+    beacon.typeName=self:_GetTypeName(beacon.type)
+    
+    -- Find closest scenery object from scan
+    beacon.scenery=beacon.coordinate:FindClosestScenery(20)
+    
+    -- Debug stuff for scenery object
+    if false then
+      if beacon.scenery then
+        env.info(string.format("FF Beacon %s %s %s got scenery object %s, %s", beacon.callsign, beacon.beaconId, beacon.typeName, beacon.scenery:GetName(), beacon.scenery:GetTypeName() ))
+        UTILS.PrintTableToLog(beacon.scenery.SceneryObject)
+        UTILS.PrintTableToLog(beacon.sceneObjects)
+      else
+        env.info(string.format("FF NO scenery object  %s %s %s ", beacon.callsign, beacon.beaconId, beacon.typeName))
+      end
+    end
+    
+    -- Add to table
+    table.insert(self.beacons, beacon)
+  end
+  
+  -- Debug output
+  self:I(string.format("Added %d beacons", #self.beacons))
+  
+  if self.verbose > 0 then
+    local text="Beacon types:"
+    for typeName,typeID in pairs(BEACON.Type) do
+      local n=self:CountBeacons(typeID)
+      text=text..string.format("\n%s = %d", typeName, n)      
+    end
+    self:I(text)
+  end
+  
+  return self
+end
+
+
+--- Create a new BEACONS 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
+  
+  local exists=UTILS.FileExists(FileName)
+  
+  if exists==false then
+    self:E(string.format("ERROR: file with beacon info does not exist!"))
+    return nil
+  end
+
+  -- This will create a global table `beacons`  
+  dofile(FileName)
+
+  -- Get beacons from table.
+  self=self:NewFromTable(beacons)
+  
+  return self
+end
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- User Functions
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+--- Get 3D position vector of a specific beacon.
+-- @param #BEACONS self
+-- @param #BEACONS.Beacon beacon The beacon data structure.
+-- @return DCS#Vec3 Position vector.
+function BEACONS:GetVec3(beacon)
+  return beacon.vec3
+end
+
+--- Get COORDINATE of a specific beacon.
+-- @param #BEACONS self
+-- @param #BEACONS.Beacon beacon The beacon data structure.
+-- @return Core.Point#COORDINATE The coordinate.
+function BEACONS:GetCoordinate(beacon)
+  local coordinate=COORDINATE:NewFromVec3(beacon.vec3)
+  return coordinate
+end
+
+--- Find closest beacon to a given coordinate.
+-- @param #BEACONS self
+-- @param Core.Point#COORDINATE Coordinate The reference coordinate.
+-- @param #number TypeID (Optional) Only search for specific beacon types, *e.g.* `BEACON.Type.TACAN`.
+-- @param #number DistMax (Optional) Max search distance in meters.
+-- @param #table ExcludeList (Optional) List of beacons to exclude.
+-- @return #BEACONS.Beacon The closest beacon.
+function BEACONS:GetClosestBeacon(Coordinate, TypeID, DistMax, ExcludeList)
+
+  local beacon=nil --#BEACONS.Beacon
+  local distmin=math.huge
+  
+  ExcludeList=ExcludeList or {}
+  
+  for _,_beacon in pairs(self.beacons) do
+    local bc=_beacon --#BEACONS.Beacon
+    
+    if (TypeID==nil or TypeID==bc.type) and (not UTILS.IsInTable(ExcludeList, bc, "beaconId")) then
+    
+      local dist=Coordinate:Get2DDistance(bc.vec3)
+      
+      if dist<distmin and (DistMax==nil or dist<=DistMax) then
+        distmin=dist
+        beacon=bc
+      end
+      
+    end
+    
+  end  
+  
+  return beacon
+end
+
+--- Find closest beacons to a given coordinate.
+-- @param #BEACONS self
+-- @param Core.Point#COORDINATE Coordinate The reference coordinate.
+-- @param #number Nmax Max number of beacons. Default 5.
+-- @param #number TypeID (Optional) Only search for specific beacon types, *e.g.* `BEACON.Type.TACAN`.
+-- @param #number DistMax (Optional) Max search distance in meters.
+-- @return #table Table of #BEACONS.Beacon closest beacons.
+function BEACONS:GetClosestBeacons(Coordinate, Nmax, TypeID, DistMax)
+
+    Nmax=Nmax or 5
+    
+    local closest={}
+    for i=1,Nmax do
+    
+      local beacon=self:GetClosestBeacon(Coordinate, TypeID, DistMax, closest)
+      
+      if beacon then
+        table.insert(closest, beacon)
+      else
+        break
+      end
+      
+    end
+
+  return closest
+end
+
+--- Get table of all beacons, optionally of a given type.
+-- @param #BEACONS self
+-- @param #number TypeID (Optional) Only return specific beacon types, *e.g.* `BEACON.Type.TACAN`. Can be handed in as tanle of beacon types.
+-- @return #table Table of beacons. Each element is of type #BEACON.Beacon.
+function BEACONS:GetBeacons(TypeID)
+
+  local beacons={}
+  local keys = {}
+  
+  if TypeID~=nil and type(TypeID) ~= "table" then 
+    TypeID = {TypeID}
+  end
+  
+  for _,_typeid in pairs(TypeID or {}) do
+    if _typeid ~= nil then
+      keys[_typeid] = _typeid
+    end
+  end
+
+  for _,_beacon in pairs(self.beacons) do
+    local bc=_beacon --#BEACONS.Beacon
+    
+    if TypeID==nil or keys[bc.type] ~= nil then
+      table.insert(beacons, bc)
+    end
+    
+  end  
+
+  return beacons
+end
+
+--- Count beacons, optionally of a given type.
+-- @param #BEACONS self
+-- @param #number TypeID (Optional) Only count specific beacon types, *e.g.* `BEACON.Type.TACAN`.
+-- @return #number Number of beacons.
+function BEACONS:CountBeacons(TypeID)
+
+  local n=0
+  
+  if TypeID then
+    for _,_beacon in pairs(self.beacons) do
+      local bc=_beacon --#BEACONS.Beacon
+      
+      if TypeID==bc.type then
+        n=n+1
+      end 
+    end
+  else
+    n=#self.beacons
+  end
+
+  return n
+end
+
+--- Add markers for all beacons on the F10 map. Optionally, only a specific beacon or a certain beacon type can be marked.
+-- @param #BEACONS self
+-- @param #BEACONS.Beacon Beacon (Optional) Only this specifc beacon.
+-- @param #number TypeID (Optional) Only show specific beacon types, *e.g.* `BEACON.Type.TACAN`.
+-- @return #BEACONS self
+function BEACONS:MarkerShow(Beacon, TypeID)
+
+  for _,_beacon in pairs(self.beacons) do
+    local beacon=_beacon --#BEACONS.Beacon
+    if Beacon==nil or Beacon.beaconId==beacon.beaconId then
+      if TypeID==nil or beacon.type==TypeID then
+        local text=self:_GetMarkerText(beacon)
+        local coord=COORDINATE:NewFromVec3(beacon.vec3)
+        if beacon.markerID then
+          UTILS.RemoveMark(beacon.markerID)
+        end
+        beacon.markerID=coord:MarkToAll(text)
+      end
+    end
+  end
+
+  return self
+end
+
+--- Remove markers of all beacons from the F10 map. Optionally, remove only marker of a specific beacon or a certain beacon type.
+-- @param #BEACONS self
+-- @param #BEACONS.Beacon Beacon (Optional) Only this specifc beacon.
+-- @param #number TypeID (Optional) Only show specific beacon types, *e.g.* `BEACON.Type.TACAN`.
+-- @return #BEACONS self
+function BEACONS:MarkerRemove(Beacon, TypeID)
+
+  for _,_beacon in pairs(self.beacons) do
+    local beacon=_beacon --#BEACONS.Beacon
+    if Beacon==nil or Beacon.beaconId==beacon.beaconId then    
+      if TypeID==nil or beacon.type==TypeID then    
+        if beacon.markerID then
+          UTILS.RemoveMark(beacon.markerID)
+          beacon.markerID=nil
+        end
+      end
+    end
+  end
+
+  return self
+end
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- Private Functions
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+--- Get text displayed in the F10 marker.
+-- @param #BEACONS self
+-- @param #BEACONS.Beacon beacon The beacon data structure.
+-- @return #string Marker text.
+function BEACONS:_GetMarkerText(beacon)
+
+  local frequency, funit=self:_GetFrequency(beacon.frequency)
+  local direction=beacon.direction~=nil and beacon.direction or -1
+
+  local text=string.format("Beacon %s [ID=%s]", tostring(beacon.typeName), tostring(beacon.beaconId))  
+  text=text..string.format("\nCallsign: %s", tostring(beacon.callsign))
+  if UTILS.IsInTable({BEACON.Type.TACAN, BEACON.Type.RSBN, BEACON.Type.PRMG_GLIDESLOPE, BEACON.Type.PRMG_LOCALIZER}, beacon.type) then
+    text=text..string.format("\nChannel: %s", tostring(beacon.channel))
+  end
+  text=text..string.format("\nFrequency: %.3f %s", frequency, funit)
+  text=text..string.format("\nDirection: %.1f°", direction)
+  
+  return text
+end
+
+
+--- Get converted frequency.
+-- @param #BEACONS self
+-- @param #number freq Frequency in Hz.
+-- @return #number Frequency in better unit.
+-- @return #string Unit ("Hz", "kHz", "MHz").
+function BEACONS:_GetFrequency(freq)
+
+  freq=freq or 0
+  local unit="Hz"
+  
+  if freq>=1e6 then
+    freq=freq/1e6
+    unit="MHz"
+  elseif freq>=1e3 then
+    freq=freq/1e3
+    unit="kHz"
+  end
+
+  return freq, unit
+end
+
+--- Get name of beacon type.
+-- @param #BEACONS self
+-- @param #number typeID Beacon type number.
+-- @return #string Type name.
+function BEACONS:_GetTypeName(typeID)
+
+  if typeID~=nil then  
+    for typeName,_typeID in pairs(BEACON.Type) do
+      if _typeID==typeID then
+        return typeName
+      end  
+    end
+  end
+
+  return "Unknown"
+end
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Moose Development/Moose/Navigation/Point.lua

@@ -0,0 +1,602 @@
+--- **NAVIGATION** - Navigation Airspace Points, Fixes and Aids.
+--
+-- **Main Features:**
+--
+--    * Navigation Fixes
+--    * Navigation Aids
+-- 
+-- ===
+--
+-- ## 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 MOOSE.JPG
+
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+--- 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.1.0"
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- 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
+
+--- Create a new NAVFIX class instance from  BEACONS.Beacon data.
+-- @param #NAVFIX self
+-- @param Navigation.Beacons#BEACONS.Beacon Beacon The beacon data.
+-- @return #NAVFIX self
+function NAVFIX:NewFromBeacon(Beacon)
+  local frequency, unit = BEACONS:_GetFrequency(Beacon.frequency)
+  frequency = string.format("%.3f",frequency)
+  if Beacon.typeName == "TACAN" then
+    frequency = Beacon.channel
+    unit = "X"
+  end
+  self = NAVFIX:NewFromVector(string.format("%s %s %s",Beacon.typeName,frequency,unit),Beacon.typeName,Beacon.vec3)
+  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 compulsory 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.1.0"
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- 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/Radios.lua

@@ -0,0 +1,423 @@
+--- **NAVIGATION** - Airbase radios.
+--
+-- **Main Features:**
+--
+--    * Get radio frequencies of airbases
+--    * Find closest airbase radios
+--    * Mark radio frequencies on F10 map
+-- 
+-- ===
+--
+-- ## Example Missions:
+--
+-- Demo missions can be found on [github](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/Navigation%20-%20Radios).
+-- 
+-- ===
+--
+-- ### Author: **funkyfranky**
+-- 
+-- ===
+-- @module Navigation.Radios
+-- @image MOOSE.JPG
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+--- RADIOS class.
+-- @type RADIOS
+-- 
+-- @field #string ClassName Name of the class.
+-- @field #number verbose Verbosity of output.
+-- @field #table radios Radios.
+-- 
+-- @extends Core.Base#BASE
+
+--- *It's not true I had nothing on, I had the radio on.* -- *Marilyn Monroe*
+--
+-- ===
+--
+-- # The RADIOS Concept
+--
+-- This class is designed to make information about radios of a map/theatre easier accessible. The information contains mostly the frequencies of airbases of the map.
+-- 
+-- **Note** that try to avoid hard coding stuff in Moose since DCS is updated frequently and things change. Therefore, the main source of information is either a file `radio.lua` that can be
+-- found in the installation directory of DCS for each map or a table that the user needs to provide.
+-- **Note** your `MissionScripting` environment needs to be desanitized to read this data.
+-- 
+-- # Basic Setup
+-- 
+-- A new `RADIOS` object can be created with the @{#RADIOS.NewFromFile}(*radio_lua_file*) function.
+-- 
+--     local radios=RADIOS:NewFromFile("<DCS_Install_Directory>\Mods\terrains\<Map_Name>\Radio.lua")
+--     radios:MarkerShow()
+-- 
+-- This will load the radios from the `<DCS_Install_Directory>` for the specific map and place markers on the F10 map. This is the first step you should do to ensure that the file
+-- you provided is correct and all relevant radios are present.
+-- 
+-- # User Functions
+-- 
+-- ## F10 Map Markers
+-- 
+-- ## Position
+-- 
+-- ## Closest Radio
+-- 
+--
+-- @field #RADIOS
+RADIOS = {
+  ClassName  = "RADIOS",
+  verbose    =        0,
+  radios    =        {},
+}
+
+--- Radio item data structure.
+-- @type RADIOS.Radio
+-- @field #string radioId Radio ID.
+-- @field #table role Roles of the radio (usually {"ground", "tower", "approach"}).
+-- @field #table callsign Callsigns of the radio (usually the airbase name).
+-- @field #table frequency Frequencies of the radios.
+-- @field #table position Position table.
+-- @field #table sceneObjects Scenery objects.
+-- @field #string name Name of the airbase.
+-- @field Wrapper.Airbase#AIRBASE airbase Airbase.
+-- @field Core.Point#COORDINATE coordinate The COORDINATE of the radio.
+-- @field DCS#Vec3 vec3 3D vector.
+-- @field #number markerID Marker ID.
+
+--- Radio item data structure.
+-- @type RADIOS.Frequency
+-- @field #number modu Modulation type.
+-- @field #number freq Frequency in Hz.
+
+
+--- RADIOS class version.
+-- @field #string version
+RADIOS.version="0.1.0"
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- ToDo list
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+-- TODO: A lot...
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- Constructor(s)
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+--- Create a new RADIOS class instance from a given table.
+-- @param #RADIOS self
+-- @param #table RadioTable Table with radios info.
+-- @return #RADIOS self
+function RADIOS:NewFromTable(RadioTable)
+
+  -- Inherit everything from BASE class.
+  self=BASE:Inherit(self, BASE:New()) -- #RADIOS
+  
+  --local airbasenames=AIRBASE.GetAllAirbaseNames()
+  
+  -- Get all airdromes
+  local airdromes=AIRBASE.GetAllAirbases(nil, Airbase.Category.AIRDROME)
+  
+  for _,_radio in pairs(RadioTable) do
+    local radio=_radio --#RADIOS.Radio
+
+    -- The table structure of callsign is a bit awkward. We need to get the airbase name.
+    -- Note that unfortunately, the callsign does not always correspond to the airbase name.
+    if false then
+      local cs=radio.callsign[1]
+      if cs and cs.common then
+        radio.name=cs.common[1]
+      elseif cs and cs.nato then
+        radio.name=cs.nato[1]
+      else
+        radio.name="Unknown"
+      end
+      radio.name=self:_GetAirbaseName(airbasenames, radio.name)    
+      radio.airbase=AIRBASE:FindByName(radio.name)
+    end
+    
+    -- Each radio item has a key radioId = 'airfield106_0', where 106 is the UID of the airbase.
+    -- So we can use that to get the airbase.
+    local aid = tonumber(string.match(radio.radioId, "airfield(%d+)_"))
+    
+    -- Get airbase
+    radio.airbase=self:_GetAirbaseByID(airdromes, aid)
+    
+    -- Set other stuff
+    if radio.airbase then
+      radio.coordinate=radio.airbase:GetCoordinate()
+      radio.vec3=radio.airbase:GetVec3()
+      radio.name=radio.airbase:GetName()
+    end
+    
+    -- Add to table
+    table.insert(self.radios, radio)
+  end
+  
+  -- Debug output
+  self:I(string.format("Added %d radios", #self.radios))
+  
+  return self
+end
+
+
+--- Create a new RADIOS class instance from a given file.
+-- @param #RADIOS self
+-- @param #string FileName Full path to the file containing the map radios.
+-- @return #RADIOS self
+function RADIOS:NewFromFile(FileName)
+
+  -- Inherit everything from BASE class.
+  self=BASE:Inherit(self, BASE:New()) -- #RADIOS
+  
+  local exists=UTILS.FileExists(FileName)
+  
+  if exists==false then
+    self:E(string.format("ERROR: file with radios info does not exist! File=%s", tostring(FileName)))
+    return nil
+  end
+  
+  -- Backup DCS radio table
+  local radiobak=UTILS.DeepCopy(radio)
+
+  -- This will create a global table `radio`  
+  dofile(FileName)
+
+  -- Get radios from table.
+  self=self:NewFromTable(radio)
+  
+  -- Restore DCS radio table
+  radio=UTILS.DeepCopy(radiobak)
+  
+  return self
+end
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- User Functions
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+--- Get 3D position vector of a specific radio.
+-- @param #RADIOS self
+-- @param #RADIOS.Radio radio The radio data structure.
+-- @return DCS#Vec3 Position vector.
+function RADIOS:GetVec3(radio)
+  return radio.vec3
+end
+
+--- Get COORDINATE of a specific radio.
+-- @param #RADIOS self
+-- @param #RADIOS.Radio radio The radio data structure.
+-- @return Core.Point#COORDINATE The coordinate.
+function RADIOS:GetCoordinate(radio)
+  return radio.coordinate
+end
+
+
+--- Find closest radio to a given coordinate.
+-- @param #RADIOS self
+-- @param Core.Point#COORDINATE Coordinate The reference coordinate.
+-- @param #number DistMax (Optional) Max search distance in meters.
+-- @param #table ExcludeList (Optional) List of radios to exclude.
+-- @return #RADIOS.Radio The closest radio.
+function RADIOS:GetClosestRadio(Coordinate, DistMax, ExcludeList)
+
+  local radio=nil --#RADIOS.Radio
+  local distmin=math.huge
+  
+  ExcludeList=ExcludeList or {}
+  
+  for _,_radio in pairs(self.radios) do
+    local ra=_radio --#RADIOS.Radio
+    
+    if (not UTILS.IsInTable(ExcludeList, ra, "radioId")) then
+    
+      local dist=Coordinate:Get2DDistance(ra.coordinate)
+      
+      if dist<distmin and (DistMax==nil or dist<=DistMax) then
+        distmin=dist
+        radio=ra
+      end
+      
+    end
+    
+  end  
+  
+  return radio
+end
+
+--- Find closest radios to a given coordinate.
+-- @param #RADIOS self
+-- @param Core.Point#COORDINATE Coordinate The reference coordinate.
+-- @param #number Nmax Max number of radios. Default 5.
+-- @param #number DistMax (Optional) Max search distance in meters.
+-- @return #table Table of #RADIOS.Radio closest radios.
+function RADIOS:GetClosestRadios(Coordinate, Nmax, DistMax)
+
+    Nmax=Nmax or 5
+    
+    local closest={}
+    for i=1,Nmax do
+    
+      local radio=self:GetClosestRadio(Coordinate, DistMax, closest)
+      
+      if radio then
+        table.insert(closest, radio)
+      else
+        break
+      end
+      
+    end
+
+  return closest
+end
+
+
+--- Add markers for all radios on the F10 map.
+-- @param #RADIOS self
+-- @param #RADIOS.Radio Radio (Optional) Only this specifc radio.
+-- @return #RADIOS self
+function RADIOS:MarkerShow(Radio)
+
+  for _,_radio in pairs(self.radios) do
+    local radio=_radio --#RADIOS.Radio
+    if Radio==nil or Radio.radioId==radio.radioId then
+      local coord=self:GetCoordinate(radio)
+      if coord then
+        local text=self:_GetMarkerText(radio)
+        if radio.markerID then
+          UTILS.RemoveMark(radio.markerID)
+        end
+        radio.markerID=coord:MarkToAll(text)
+      end
+    end
+  end
+
+  return self
+end
+
+--- Remove markers of all radios from the F10 map.
+-- @param #RADIOS self
+-- @param #RADIOS.Radio Radio (Optional) Only this specifc radio.
+-- @return #RADIOS self
+function RADIOS:MarkerRemove(Radio)
+
+  for _,_radio in pairs(self.radios) do
+    local radio=_radio --#RADIOS.Radio
+    if Radio==nil or Radio.radioId==radio.radioId then    
+      if radio.markerID then
+        UTILS.RemoveMark(radio.markerID)
+        radio.markerID=nil
+      end
+    end
+  end
+
+  return self
+end
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- Private Functions
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+--- Get text displayed in the F10 marker.
+-- @param #RADIOS self
+-- @param #RADIOS.Radio radio The radio data structure.
+-- @return #string Marker text.
+function RADIOS:_GetMarkerText(radio)
+
+  local text=string.format("Radio %s", tostring(radio.name))
+  for b,f in pairs(radio.frequency) do
+    local frequency=f --#RADIOS.Frequency
+    local mod=frequency[1]
+    local fre=frequency[2]
+    local freq, funit=self:_GetFrequency(fre)
+    --UTILS.PrintTableToLog(frequency)
+    local band=self:_GetBandName(b)
+    text=text..string.format("\n%s: %.3f %s", band, freq, funit)
+  end
+    
+  return text
+end
+
+
+--- Get converted frequency.
+-- @param #RADIOS self
+-- @param #number freq Frequency in Hz.
+-- @return #number Frequency in better unit.
+-- @return #string Unit ("Hz", "kHz", "MHz").
+function RADIOS:_GetFrequency(freq)
+
+  freq=freq or 0
+  local unit="Hz"
+  
+  if freq>=1e6 then
+    freq=freq/1e6
+    unit="MHz"
+  elseif freq>=1e3 then
+    freq=freq/1e3
+    unit="kHz"
+  end
+
+  return freq, unit
+end
+
+--- Get name of frequency band.
+-- @param #RADIOS self
+-- @param #number BandNumber Band as number.
+-- @return #string Band name.
+function RADIOS:_GetBandName(BandNumber)
+
+  if BandNumber~=nil then  
+    for bandName,bandNumber in pairs(ENUMS.FrequencyBand) do
+      if bandNumber==BandNumber then
+        return bandName
+      end  
+    end
+  end
+
+  return "Unknown"
+end
+
+--- Get name of frequency band.
+-- @param #RADIOS self
+-- @param #table airbasenames Names of all airbases.
+-- @param #string name Name of airbase.
+-- @return #string Name of airbase
+function RADIOS:_GetAirbaseName(airbasenames, name)
+
+  local airbase=AIRBASE:FindByName(name)
+  
+  if airbase then
+    return name    
+  else
+    for _,airbasename in pairs(airbasenames) do
+      if string.find(airbasename, name) then
+        return airbasename
+      end    
+    end
+  end
+
+  return "Unknown"
+end
+
+--- Get name of frequency band.
+-- @param #RADIOS self
+-- @param #table airbases Table of airbases.
+-- @param #number aid Airbase ID.
+-- @return Wrapper.Airbase#AIRBASE Airbase matching the ID or nil.
+function RADIOS:_GetAirbaseByID(airbases, aid)
+
+  for _,_airbase in pairs(airbases) do
+    local airbase=_airbase --Wrapper.Airbase#AIRBASE
+    local id=airbase:GetID(true)
+    if id==aid then
+      return airbase
+    end
+  end
+
+  return nil
+end
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Moose Development/Moose/Navigation/Towns.lua

@@ -0,0 +1,332 @@
+--- **NAVIGATION** - Towns of the map/theatre.
+--
+-- **Main Features:**
+--
+--    * Find towns of map
+--    * Road and rail connections
+--    * Find closest town to a given coordinate
+-- 
+-- ===
+--
+-- ## Example Missions:
+--
+-- Demo missions can be found on [github](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/Navigation%20-%20Towns).
+-- 
+-- ===
+--
+-- ### Author: **funkyfranky**
+-- 
+-- ===
+-- @module Navigation.Towns
+-- @image MOOSE.JPG
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+--- TOWNS class.
+-- @type TOWNS
+-- 
+-- @field #string ClassName Name of the class.
+-- @field #number verbose Verbosity of output.
+-- @field #table towns Towns.
+-- 
+-- @extends Core.Base#BASE
+
+--- *Hope is the beacon that guides lost ships back to the shore.*
+--
+-- ===
+--
+-- # The TOWNS Concept
+--
+-- This class is designed to make information about towns of a map/theatre easier accessible. The information contains location and road/rail connections of the towns.
+-- 
+-- **Note** that try to avoid hard coding stuff in Moose since DCS is updated frequently and things change. Therefore, the main source of information is either a file `towns.lua` that can be
+-- found in the installation directory of DCS for each map or a table that the user needs to provide.
+-- **Note** your `MissionScripting` environment needs to be desanitized to read this data.
+-- 
+-- # Basic Setup
+-- 
+-- A new `TOWNS` object can be created with the @{#TOWNS.NewFromFile}(*towns_lua_file*) function.
+-- 
+--     local towns=TOWNS:NewFromFile("<DCS_Install_Directory>\Mods\terrains\<Map_Name>\map\towns.lua")
+--     towns:MarkerShow()
+-- 
+-- This will load the towns from the `<DCS_Install_Directory>` for the specific map and place markers on the F10 map. This is the first step you should do to ensure that the file
+-- you provided is correct and all relevant towns are present.
+-- 
+-- # User Functions
+-- 
+-- ## F10 Map Markers
+-- 
+-- ## Position
+-- 
+-- ## Get Closest Town
+-- 
+--
+-- @field #TOWNS
+TOWNS = {
+  ClassName  =   "TOWNS",
+  verbose    =         0,
+  towns      =        {},
+}
+
+--- Town data.
+-- @type TOWNS.Town
+-- @field #string display_name Displayed name.
+-- @field #string name Name of the town.
+-- @field #number latitude Latitude.
+-- @field #number longitude Longitude
+-- @field DCS#Vec3 vec3 Position vector 3D.
+-- @field Core.Point#COORDINATE coordinate The coordinate.
+-- @field Core.Point#COORDINATE coordRoad The coordinate of the closest road.
+-- @field Core.Point#COORDINATE coordRail The coordinate of the closest railway.
+-- @field #number markerID ID for the F10 marker.
+
+--- TOWNS class version.
+-- @field #string version
+TOWNS.version="0.1.0"
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- ToDo list
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+-- TODO: A lot...
+-- DONE: Road connection
+-- DONE: Rail connection
+-- DONE: Connection between towns
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- Constructor(s)
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+--- Create a new TOWNS class instance from a given table.
+-- @param #TOWNS self
+-- @param #table TownTable Table with all towns data.
+-- @return #TOWNS self
+function TOWNS:NewFromTable(TownTable)
+
+  -- Inherit everything from BASE class.
+  self=BASE:Inherit(self, BASE:New()) -- #TOWNS
+  
+  for TownName,_town in pairs(TownTable) do
+    local town=_town --#TOWNS.Town
+    
+    town.name=TownName    
+
+    -- Get coordinate
+    town.coordinate=COORDINATE:NewFromLLDD(town.latitude, town.longitude)
+    
+    -- Get coordinate of closest road
+    town.coordRoad=town.coordinate:GetClosestPointToRoad()
+    
+    -- Get coordinate of closest rail
+    town.coordRail=town.coordinate:GetClosestPointToRoad(true)
+    
+    -- Add to table
+    table.insert(self.towns, town)
+  end
+  
+  -- Debug output
+  self:I(string.format("Added %d towns", #self.towns))
+  
+  return self
+end
+
+
+--- Create a new TOWNS class instance from a given file.
+-- @param #TOWNS self
+-- @param #string FileName Full path to the file containing the towns data.
+-- @return #TOWNS self
+function TOWNS:NewFromFile(FileName)
+
+  -- Inherit everything from BASE class.
+  self=BASE:Inherit(self, BASE:New()) -- #TOWNS
+  
+  local exists=UTILS.FileExists(FileName)
+  
+  if exists==false then
+    self:E(string.format("ERROR: file with towns info does not exist!"))
+    return nil
+  end
+
+  -- This will create a global table `towns`  
+  dofile(FileName)
+
+  -- Get towns from table.
+  self=self:NewFromTable(towns)
+  
+  return self
+end
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- User Functions
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+--- Get 3D position vector of a specific town.
+-- @param #TOWNS self
+-- @param #TOWNS.Town town The town data structure.
+-- @return DCS#Vec3 Position vector.
+function TOWNS:GetVec3(town)
+  return town.vec3
+end
+
+--- Get COORDINATE of a specific town.
+-- @param #TOWNS self
+-- @param #TOWNS.Town town The town data structure.
+-- @return Core.Point#COORDINATE The coordinate.
+function TOWNS:GetCoordinate(town)
+  return town.coordinate
+end
+
+--- Get closest road coordinate of a town.
+-- @param #TOWNS self
+-- @param #TOWNS.Town town The town data structure.
+-- @return Core.Point#COORDINATE The closest road coordinate.
+function TOWNS:GetCoordRoad(town)
+  return town.coordRoad
+end
+
+--- Get closest rail coordinate of a town.
+-- @param #TOWNS self
+-- @param #TOWNS.Town town The town data structure.
+-- @return Core.Point#COORDINATE The closest rail coordinate.
+function TOWNS:GetCoordRail(town)
+  return town.coordRail
+end
+
+--- Get road or rail connection between two towns.
+-- @param #TOWNS self
+-- @param #TOWNS.Town townA The town data structure.
+-- @param #TOWNS.Town townB The town data structure.
+-- @param #boolean Railroad If `true`, find rail road connection
+-- @return Core.Pathline#PATHLINE Pathline connecting the two towns on road.
+function TOWNS:GetConnectionRoad(townA, townB, Railroad)
+
+  local path=townA.coordRoad:GetPathlineOnRoad(townB.coordRoad, false, Railroad)
+
+  return path
+end
+
+--- Find closest town to a given coordinate.
+-- @param #TOWNS self
+-- @param Core.Point#COORDINATE Coordinate The reference coordinate.
+-- @param #number DistMax (Optional) Max search distance in meters.
+-- @param #table ExcludeList (Optional) List of towns excluded from the search.
+-- @return #TOWNS.Town The closest town.
+function TOWNS:GetClosestTown(Coordinate, DistMax, ExcludeList)
+
+  local Town=nil --#TOWNS.Town
+  local distmin=math.huge
+  ExcludeList=ExcludeList or {}
+  
+  for _,_town in pairs(self.towns) do
+    local town=_town --#TOWNS.Town
+    
+    if (not UTILS.IsInTable(ExcludeList, town, "name")) then
+    
+      local dist=Coordinate:Get2DDistance(town.coordinate)
+      
+      if dist<distmin then
+        distmin=dist
+        Town=town
+      end
+    end    
+  end
+  
+  return Town
+end
+
+--- Find closest towns to a given coordinate.
+-- @param #TOWNS self
+-- @param Core.Point#COORDINATE Coordinate The reference coordinate.
+-- @param #number Nmax Max number of towns. Default 5.
+-- @param #number DistMax (Optional) Max search distance in meters.
+-- @return #table Table of #TOWNS.Town closest towns.
+function TOWNS:GetClosestTowns(Coordinate, Nmax, DistMax)
+
+    Nmax=Nmax or 5
+    
+    local closest={}
+    for i=1,Nmax do
+    
+      local town=self:GetClosestTown(Coordinate, DistMax, closest)
+      
+      if town then
+        table.insert(closest, town)
+      else
+        break
+      end
+      
+    end
+
+  return closest
+end
+
+
+--- Get table of all towns, optionally of a given type.
+-- @param #TOWNS self
+-- @return #table Table of towns. Each element is of type #TOWN.Town.
+function TOWNS:GetTowns()
+  return self.towns
+end
+
+--- Add markers for all towns on the F10 map.
+-- @param #TOWNS self
+-- @param #TOWNS.Town Town (Optional) Only this specifc town.
+-- @return #TOWNS self
+function TOWNS:MarkerShow(Town)
+
+  for _,_town in pairs(self.towns) do
+    local town=_town --#TOWNS.Town
+    if Town==nil or Town.name==town.name then
+      local text=self:_GetMarkerText(town)
+      local coord=town.coordinate
+      if town.markerID then
+        UTILS.RemoveMark(town.markerID)
+      end
+      town.markerID=coord:MarkToAll(text)
+    end
+  end
+
+  return self
+end
+
+--- Remove markers of all towns from the F10 map.
+-- @param #TOWNS self
+-- @param #TOWNS.Town Town (Optional) Only this specifc town.
+-- @return #TOWNS self
+function TOWNS:MarkerRemove(Town)
+
+  for _,_town in pairs(self.towns) do
+    local town=_town --#TOWNS.Town
+    if Town==nil or Town.name==town.name then    
+      if town.markerID then
+        UTILS.RemoveMark(town.markerID)
+        town.markerID=nil
+      end
+    end
+  end
+
+  return self
+end
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- Private Functions
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+--- Get text displayed in the F10 marker.
+-- @param #TOWNS self
+-- @param #TOWNS.Town town The town data structure.
+-- @return #string Marker text.
+function TOWNS:_GetMarkerText(town)
+
+  local text=string.format("Town %s", town.name)  
+  --text=text..string.format("\nCallsign: %s", tostring(beacon.callsign))
+  
+  return text
+end
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Moose Development/Moose/Ops/ATIS.lua

@@ -19,7 +19,7 @@
 --    * Option to present information in imperial or metric units
 --    * Runway length and airfield elevation (optional)
 --    * Frequencies/channels of nav aids (ILS, VOR, NDB, TACAN, PRMG, RSBN) (optional)
---    * SRS Simple-Text-To-Speech (STTS) integration (no sound files necessary)
+--    * SRS Simple-Text-To-Speech (MSRS) integration (no sound files necessary)
 --
 -- ===
 --
@@ -291,7 +291,7 @@
 -- ## Nevada: Nellis AFB
 --
 --     -- ATIS Nellis AFB on 270.10 MHz AM.
---     atisNellis=ATIS:New(AIRBASE.Nevada.Nellis_AFB, 270.1)
+--     atisNellis=ATIS:New(AIRBASE.Nevada.Nellis, 270.1)
 --     atisNellis:SetRadioRelayUnitName("Radio Relay Nellis")
 --     atisNellis:SetActiveRunway("21L")
 --     atisNellis:SetTowerFrequencies({327.000, 132.550})
@@ -302,7 +302,7 @@
 -- ## Persian Gulf: Abu Dhabi International Airport
 --
 --     -- ATIS Abu Dhabi International on 125.1 MHz AM.
---     atisAbuDhabi=ATIS:New(AIRBASE.PersianGulf.Abu_Dhabi_International_Airport, 125.1)
+--     atisAbuDhabi=ATIS:New(AIRBASE.PersianGulf.Abu_Dhabi_Intl, 125.1)
 --     atisAbuDhabi:SetRadioRelayUnitName("Radio Relay Abu Dhabi International Airport")
 --     atisAbuDhabi:SetMetricUnits()
 --     atisAbuDhabi:SetActiveRunway("L")
@@ -498,6 +498,10 @@ ATIS.Alphabet = {
 -- @field #number Syria +5° (East).
 -- @field #number MarianaIslands +2° (East).
 -- @field #number SinaiMap +5° (East).
+-- @field #number Kola +15° (East).
+-- @field #number Afghanistan +3° (East).
+-- @field #number Iraq +4.4° (East).
+-- @field #number GermanyCW +0.1° (East).
 ATIS.RunwayM2T = {
   Caucasus = 0,
   Nevada = 12,
@@ -508,6 +512,10 @@ ATIS.RunwayM2T = {
   MarianaIslands = 2,
   Falklands = 12,
   SinaiMap = 5,
+  Kola = 15,
+  Afghanistan = 3,
+  Iraq=4.4,
+  GermanyCW=0.1,
 }
 
 --- Whether ICAO phraseology is used for ATIS broadcasts.
@@ -521,6 +529,10 @@ ATIS.RunwayM2T = {
 -- @field #boolean MarianaIslands true.
 -- @field #boolean Falklands true.
 -- @field #boolean SinaiMap true.
+-- @field #boolean Kola true.
+-- @field #boolean Afghanistan true.
+-- @field #boolean Iraq true.
+-- @field #boolean GermanyCW true.
 ATIS.ICAOPhraseology = {
   Caucasus = true,
   Nevada = false,
@@ -531,6 +543,10 @@ ATIS.ICAOPhraseology = {
   MarianaIslands = true,
   Falklands = true,
   SinaiMap = true,
+  Kola = true,
+  Afghanistan = true,
+  Iraq = true,
+  GermanyCW = true,
 }
 
 --- Nav point data.
@@ -619,83 +635,83 @@ ATIS.ICAOPhraseology = {
 -- @field #ATIS.Soundfile TACANChannel
 -- @field #ATIS.Soundfile VORFrequency
 ATIS.Sound = {
-  ActiveRunway = { filename = "ActiveRunway.ogg", duration = 0.99 },
-  ActiveRunwayDeparture = { filename = "ActiveRunwayDeparture.ogg", duration = 0.99 },
-  ActiveRunwayArrival = { filename = "ActiveRunwayArrival.ogg", duration = 0.99 },
-  AdviceOnInitial = { filename = "AdviceOnInitial.ogg", duration = 3.00 },
-  Airport = { filename = "Airport.ogg", duration = 0.66 },
-  Altimeter = { filename = "Altimeter.ogg", duration = 0.68 },
-  At = { filename = "At.ogg", duration = 0.41 },
-  CloudBase = { filename = "CloudBase.ogg", duration = 0.82 },
-  CloudCeiling = { filename = "CloudCeiling.ogg", duration = 0.61 },
-  CloudsBroken = { filename = "CloudsBroken.ogg", duration = 1.07 },
-  CloudsFew = { filename = "CloudsFew.ogg", duration = 0.99 },
-  CloudsNo = { filename = "CloudsNo.ogg", duration = 1.01 },
-  CloudsNotAvailable = { filename = "CloudsNotAvailable.ogg", duration = 2.35 },
-  CloudsOvercast = { filename = "CloudsOvercast.ogg", duration = 0.83 },
-  CloudsScattered = { filename = "CloudsScattered.ogg", duration = 1.18 },
-  Decimal = { filename = "Decimal.ogg", duration = 0.54 },
-  DegreesCelsius = { filename = "DegreesCelsius.ogg", duration = 1.27 },
-  DegreesFahrenheit = { filename = "DegreesFahrenheit.ogg", duration = 1.23 },
-  DewPoint = { filename = "DewPoint.ogg", duration = 0.65 },
-  Dust = { filename = "Dust.ogg", duration = 0.54 },
-  Elevation = { filename = "Elevation.ogg", duration = 0.78 },
-  EndOfInformation = { filename = "EndOfInformation.ogg", duration = 1.15 },
-  Feet = { filename = "Feet.ogg", duration = 0.45 },
-  Fog = { filename = "Fog.ogg", duration = 0.47 },
-  Gusting = { filename = "Gusting.ogg", duration = 0.55 },
-  HectoPascal = { filename = "HectoPascal.ogg", duration = 1.15 },
-  Hundred = { filename = "Hundred.ogg", duration = 0.47 },
-  InchesOfMercury = { filename = "InchesOfMercury.ogg", duration = 1.16 },
-  Information = { filename = "Information.ogg", duration = 0.85 },
-  Kilometers = { filename = "Kilometers.ogg", duration = 0.78 },
-  Knots = { filename = "Knots.ogg", duration = 0.59 },
-  Left = { filename = "Left.ogg", duration = 0.54 },
-  MegaHertz = { filename = "MegaHertz.ogg", duration = 0.87 },
-  Meters = { filename = "Meters.ogg", duration = 0.59 },
-  MetersPerSecond = { filename = "MetersPerSecond.ogg", duration = 1.14 },
-  Miles = { filename = "Miles.ogg", duration = 0.60 },
-  MillimetersOfMercury = { filename = "MillimetersOfMercury.ogg", duration = 1.53 },
-  Minus = { filename = "Minus.ogg", duration = 0.64 },
-  N0 = { filename = "N-0.ogg", duration = 0.55 },
-  N1 = { filename = "N-1.ogg", duration = 0.41 },
-  N2 = { filename = "N-2.ogg", duration = 0.37 },
-  N3 = { filename = "N-3.ogg", duration = 0.41 },
-  N4 = { filename = "N-4.ogg", duration = 0.37 },
-  N5 = { filename = "N-5.ogg", duration = 0.43 },
-  N6 = { filename = "N-6.ogg", duration = 0.55 },
-  N7 = { filename = "N-7.ogg", duration = 0.43 },
-  N8 = { filename = "N-8.ogg", duration = 0.38 },
-  N9 = { filename = "N-9.ogg", duration = 0.55 },
-  NauticalMiles = { filename = "NauticalMiles.ogg", duration = 1.04 },
-  None = { filename = "None.ogg", duration = 0.43 },
-  QFE = { filename = "QFE.ogg", duration = 0.63 },
-  QNH = { filename = "QNH.ogg", duration = 0.71 },
-  Rain = { filename = "Rain.ogg", duration = 0.41 },
-  Right = { filename = "Right.ogg", duration = 0.44 },
-  Snow = { filename = "Snow.ogg", duration = 0.48 },
-  SnowStorm = { filename = "SnowStorm.ogg", duration = 0.82 },
-  StatuteMiles = { filename = "StatuteMiles.ogg", duration = 1.15 },
-  SunriseAt = { filename = "SunriseAt.ogg", duration = 0.92 },
-  SunsetAt = { filename = "SunsetAt.ogg", duration = 0.95 },
-  Temperature = { filename = "Temperature.ogg", duration = 0.64 },
-  Thousand = { filename = "Thousand.ogg", duration = 0.55 },
-  ThunderStorm = { filename = "ThunderStorm.ogg", duration = 0.81 },
-  TimeLocal = { filename = "TimeLocal.ogg", duration = 0.90 },
-  TimeZulu = { filename = "TimeZulu.ogg", duration = 0.86 },
-  TowerFrequency = { filename = "TowerFrequency.ogg", duration = 1.19 },
-  Visibilty = { filename = "Visibility.ogg", duration = 0.79 },
-  WeatherPhenomena = { filename = "WeatherPhenomena.ogg", duration = 1.07 },
-  WindFrom = { filename = "WindFrom.ogg", duration = 0.60 },
+  ActiveRunway = { filename = "ActiveRunway.ogg", duration = 0.85 },
+  ActiveRunwayDeparture = { filename = "ActiveRunwayDeparture.ogg", duration = 1.50 },
+  ActiveRunwayArrival = { filename = "ActiveRunwayArrival.ogg", duration = 1.38 },
+  AdviceOnInitial = { filename = "AdviceOnInitial.ogg", duration = 2.98 },
+  Airport = { filename = "Airport.ogg", duration = 0.55 },
+  Altimeter = { filename = "Altimeter.ogg", duration = 0.91 },
+  At = { filename = "At.ogg", duration = 0.32 },
+  CloudBase = { filename = "CloudBase.ogg", duration = 0.69 },
+  CloudCeiling = { filename = "CloudCeiling.ogg", duration = 0.53 },
+  CloudsBroken = { filename = "CloudsBroken.ogg", duration = 0.81 },
+  CloudsFew = { filename = "CloudsFew.ogg", duration = 0.74 },
+  CloudsNo = { filename = "CloudsNo.ogg", duration =  0.69},
+  CloudsNotAvailable = { filename = "CloudsNotAvailable.ogg", duration = 2.64 },
+  CloudsOvercast = { filename = "CloudsOvercast.ogg", duration = 0.82 },
+  CloudsScattered = { filename = "CloudsScattered.ogg", duration = 0.89 },
+  Decimal = { filename = "Decimal.ogg", duration = 0.71 },
+  DegreesCelsius = { filename = "DegreesCelsius.ogg", duration = 1.08 },
+  DegreesFahrenheit = { filename = "DegreesFahrenheit.ogg", duration = 1.07 },
+  DewPoint = { filename = "DewPoint.ogg", duration = 0.59 },
+  Dust = { filename = "Dust.ogg", duration = 0.37 },
+  Elevation = { filename = "Elevation.ogg", duration = 0.92 },
+  EndOfInformation = { filename = "EndOfInformation.ogg", duration = 1.24 },
+  Feet = { filename = "Feet.ogg", duration = 0.34 },
+  Fog = { filename = "Fog.ogg", duration = 0.41 },
+  Gusting = { filename = "Gusting.ogg", duration = 0.58 },
+  HectoPascal = { filename = "HectoPascal.ogg", duration = 0.92 },
+  Hundred = { filename = "Hundred.ogg", duration = 0.53 },
   ILSFrequency = { filename = "ILSFrequency.ogg", duration = 1.30 },
-  InnerNDBFrequency = { filename = "InnerNDBFrequency.ogg", duration = 1.56 },
-  OuterNDBFrequency = { filename = "OuterNDBFrequency.ogg", duration = 1.59 },
-  RunwayLength = { filename = "RunwayLength.ogg", duration = 0.91 },
-  VORFrequency = { filename = "VORFrequency.ogg", duration = 1.38 },
-  TACANChannel = { filename = "TACANChannel.ogg", duration = 0.88 },
-  PRMGChannel = { filename = "PRMGChannel.ogg", duration = 1.18 },
-  RSBNChannel = { filename = "RSBNChannel.ogg", duration = 1.14 },
-  Zulu = { filename = "Zulu.ogg", duration = 0.62 },
+  InchesOfMercury = { filename = "InchesOfMercury.ogg", duration = 1.26 },
+  Information = { filename = "Information.ogg", duration = 0.99 },  
+  InnerNDBFrequency = { filename = "InnerNDBFrequency.ogg", duration = 1.69 },
+  Kilometers = { filename = "Kilometers.ogg", duration = 0.93 },
+  Knots = { filename = "Knots.ogg", duration = 0.46 },
+  Left = { filename = "Left.ogg", duration = 0.41 },
+  MegaHertz = { filename = "MegaHertz.ogg", duration = 0.83 },
+  Meters = { filename = "Meters.ogg", duration = 0.55 },
+  MetersPerSecond = { filename = "MetersPerSecond.ogg", duration = 1.03 },
+  Miles = { filename = "Miles.ogg", duration = 0.44 },
+  MillimetersOfMercury = { filename = "MillimetersOfMercury.ogg", duration = 1.59 },
+  Minus = { filename = "Minus.ogg", duration = 0.55 },
+  N0 = { filename = "N-0.ogg", duration = 0.52 },
+  N1 = { filename = "N-1.ogg", duration = 0.35 },
+  N2 = { filename = "N-2.ogg", duration = 0.41 },
+  N3 = { filename = "N-3.ogg", duration = 0.34 },
+  N4 = { filename = "N-4.ogg", duration = 0.37 },
+  N5 = { filename = "N-5.ogg", duration = 0.40 },
+  N6 = { filename = "N-6.ogg", duration = 0.46 },
+  N7 = { filename = "N-7.ogg", duration = 0.52 },
+  N8 = { filename = "N-8.ogg", duration = 0.36 },
+  N9 = { filename = "N-9.ogg", duration = 0.51 },
+  NauticalMiles = { filename = "NauticalMiles.ogg", duration = 0.93 },
+  None = { filename = "None.ogg", duration = 0.33 },
+  OuterNDBFrequency = { filename = "OuterNDBFrequency.ogg", duration = 1.70 },
+  PRMGChannel = { filename = "PRMGChannel.ogg", duration = 1.27 },  
+  QFE = { filename = "QFE.ogg", duration = 0.90 },
+  QNH = { filename = "QNH.ogg", duration = 0.94 },
+  Rain = { filename = "Rain.ogg", duration = 0.35 },
+  Right = { filename = "Right.ogg", duration = 0.31 },
+  RSBNChannel = { filename = "RSBNChannel.ogg", duration = 1.26 },
+  RunwayLength = { filename = "RunwayLength.ogg", duration = 0.81 },    
+  Snow = { filename = "Snow.ogg", duration = 0.40 },
+  SnowStorm = { filename = "SnowStorm.ogg", duration = 0.73 },
+  StatuteMiles = { filename = "StatuteMiles.ogg", duration = 0.90 },
+  SunriseAt = { filename = "SunriseAt.ogg", duration = 0.82 },
+  SunsetAt = { filename = "SunsetAt.ogg", duration = 0.87 },
+  TACANChannel = { filename = "TACANChannel.ogg", duration = 0.81 },  
+  Temperature = { filename = "Temperature.ogg", duration = 0.70 },
+  Thousand = { filename = "Thousand.ogg", duration = 0.58 },
+  ThunderStorm = { filename = "ThunderStorm.ogg", duration = 0.79 },
+  TimeLocal = { filename = "TimeLocal.ogg", duration = 0.83 },
+  TimeZulu = { filename = "TimeZulu.ogg", duration = 0.83 },
+  TowerFrequency = { filename = "TowerFrequency.ogg", duration = 1.05 },
+  Visibilty = { filename = "Visibility.ogg", duration = 1.16 },
+  VORFrequency = { filename = "VORFrequency.ogg", duration = 1.28 },  
+  WeatherPhenomena = { filename = "WeatherPhenomena.ogg", duration = 1.09 },
+  WindFrom = { filename = "WindFrom.ogg", duration = 0.63 },
+  Zulu = { filename = "Zulu.ogg", duration = 0.51 },
 }
 
 ---
@@ -954,7 +970,7 @@ _ATIS = {}
 
 --- ATIS class version.
 -- @field #string version
-ATIS.version = "1.0.0"
+ATIS.version = "1.0.1"
 
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 -- TODO list
@@ -2037,12 +2053,14 @@ function ATIS:onafterBroadcast( From, Event, To )
   local sunrise = coord:GetSunrise()
   --self:I(sunrise)
   local SUNRISE = "no time"
+  local NorthPolar = true
   if tostring(sunrise) ~= "N/S" and tostring(sunrise) ~= "N/R" then
     sunrise = UTILS.Split( sunrise, ":" )
     SUNRISE = string.format( "%s%s", sunrise[1], sunrise[2] )
     if self.useSRS then
       SUNRISE = string.format( "%s %s %s", sunrise[1], sunrise[2], hours )
     end
+    NorthPolar = false
   end
   
   local sunset = coord:GetSunset()
@@ -2054,6 +2072,7 @@ function ATIS:onafterBroadcast( From, Event, To )
     if self.useSRS then
       SUNSET = string.format( "%s %s %s", sunset[1], sunset[2], hours )
     end
+    NorthPolar = false
   end
 
   ---------------------------------
@@ -2080,34 +2099,32 @@ function ATIS:onafterBroadcast( From, Event, To )
   ---------------
 
   -- Get mission weather info. Most of this is static.
-  local clouds, visibility, turbulence, fog, dust, static = self:GetMissionWeather()
-
-  -- Check that fog is actually "thick" enough to reach the airport. If an airport is in the mountains, fog might not affect it as it is measured from sea level.
-  if fog and fog.thickness < height + 25 then
-    fog = nil
-  end
-
-  -- Dust only up to 1500 ft = 457 m ASL.
-  if dust and height + 25 > UTILS.FeetToMeters( 1500 ) then
-    dust = nil
-  end
+  local clouds, visibility, turbulence, dustdens, static = self:GetMissionWeather()
+  
+  local dust=false
+  local fog=false
 
   ------------------
   --- Visibility ---
   ------------------
 
-  -- Get min visibility.
-  local visibilitymin = visibility
-
-  if fog then
-    if fog.visibility < visibilitymin then
-      visibilitymin = fog.visibility
+  if dustdens then
+  
+    -- Dust only up to 1500 ft = 457 m ASL.
+    if UTILS.FeetToMeters( 1500 )> height+25 then
+      dust=true
+      visibility=math.min(visibility, dustdens)
     end
-  end
-
-  if dust then
-    if dust < visibilitymin then
-      visibilitymin = dust
+    
+  else -- As of DCS 2.9.10.3948 (December 2024), fog and dust are mutually exclusive!
+  
+    -- Get current fog visibility and thickness
+    local fvis=world.weather.getFogVisibilityDistance()
+    local fheight=world.weather.getFogThickness()
+    
+    if fvis>0 and fheight>height+25 then
+      fog=true
+      visibility=math.min(visibility, fvis)
     end
   end
 
@@ -2115,7 +2132,7 @@ function ATIS:onafterBroadcast( From, Event, To )
 
   if self.metric then
     -- Visibility in km.
-    local reportedviz = UTILS.Round( visibilitymin / 1000 )
+    local reportedviz = UTILS.Round( visibility / 1000 )
     -- max reported visibility 9999 m
     if reportedviz > 10 then
       reportedviz = 10
@@ -2123,7 +2140,7 @@ function ATIS:onafterBroadcast( From, Event, To )
     VISIBILITY = string.format( "%d", reportedviz )
   else
     -- max reported visibility 10 NM
-    local reportedviz = UTILS.Round( UTILS.MetersToSM( visibilitymin ) )
+    local reportedviz = UTILS.Round( UTILS.MetersToSM( visibility ) )
     if reportedviz > 10 then
       reportedviz = 10
     end
@@ -2395,7 +2412,7 @@ function ATIS:onafterBroadcast( From, Event, To )
     local sunrise = self.gettext:GetEntry("SUNRISEAT",self.locale)
     --subtitle = string.format( "Sunrise at %s local time", SUNRISE )
     subtitle = string.format( sunrise, SUNRISE )
-    if not self.useSRS then
+    if not self.useSRS and NorthPolar == false then
       self:Transmission( self.Sound.SunriseAt, 0.5, subtitle )
       self.radioqueue:Number2Transmission( SUNRISE, nil, 0.2 )
       self:Transmission( self.Sound.TimeLocal, 0.2 )
@@ -2406,7 +2423,7 @@ function ATIS:onafterBroadcast( From, Event, To )
     local sunset = self.gettext:GetEntry("SUNSETAT",self.locale)
     --subtitle = string.format( "Sunset at %s local time", SUNSET )
     subtitle = string.format( sunset, SUNSET )
-    if not self.useSRS then
+    if not self.useSRS and NorthPolar == false then
       self:Transmission( self.Sound.SunsetAt, 0.5, subtitle )
       self.radioqueue:Number2Transmission( SUNSET, nil, 0.5 )
       self:Transmission( self.Sound.TimeLocal, 0.2 )
@@ -2781,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
@@ -3350,28 +3367,13 @@ function ATIS:GetMissionWeather()
     dust = weather.dust_density
   end
 
-  -- Fog
-  --[[
-  ["enable_fog"] = false,
-  ["fog"] =
-  {
-      ["thickness"] = 0,
-      ["visibility"] = 25,
-  }, -- end of ["fog"]
-  ]]
-  local fog = nil
-  if weather.enable_fog == true then
-    fog = weather.fog
-  end
-
   self:T( "FF weather:" )
   self:T( { clouds = clouds } )
   self:T( { visibility = visibility } )
   self:T( { turbulence = turbulence } )
-  self:T( { fog = fog } )
   self:T( { dust = dust } )
   self:T( { static = static } )
-  return clouds, visibility, turbulence, fog, dust, static
+  return clouds, visibility, turbulence, dust, static
 end
 
 --- Get thousands of a number.

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.5"
+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).
@@ -323,6 +326,42 @@ function AIRWING:AddSquadron(Squadron)
   if Squadron:IsStopped() then
     Squadron:Start()
   end
+  
+  -- if storage is limited, add the amount of aircraft needed
+  local airbasename = self:GetAirbaseName()
+  
+  if airbasename then
+    local group = Squadron.templategroup
+      if group then
+      local Nunits = 1
+      local units
+      if group then units = group:GetUnits() end
+      if units then Nunits = #units end
+      local typename = Squadron.aircrafttype or "none"
+      local NAssets = Squadron.Ngroups * Nunits
+      local storage = STORAGE:New(airbasename)
+      
+      self:T(self.lid.."Adding "..typename.." #"..NAssets)
+      if storage and storage.warehouse and storage:IsLimitedAircraft() and typename ~= "none" then
+        local NInStore = storage:GetItemAmount(typename) or 0
+        if NAssets > NInStore then
+          storage:AddItem(typename,NAssets)
+        end
+      end
+      
+      local unit = group:GetUnit(1)
+      -- if storage is limited, add the amount of liquids needed
+      if unit and storage and storage.warehouse and storage:IsLimitedLiquids() and typename ~= "none" then
+        local fuel = unit:GetFuelMassMax()
+        local neededfuel = (fuel*NAssets) -- kgs of fuel
+        local NInStore = storage:GetLiquidAmount(STORAGE.Liquid.JETFUEL) or 0
+        self:T(string.format(self.lid.."Fuel Needed: %dt | Fuel in store: %dt",neededfuel/1000,NInStore/1000))
+        if neededfuel > NInStore then
+          storage:AddLiquid(STORAGE.Liquid.JETFUEL,neededfuel)
+        end
+      end
+    end
+  end
 
   return self
 end
@@ -807,13 +846,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 +869,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 +878,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 and 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 +897,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 +905,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 +922,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 +939,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 +957,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 +1024,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 +1226,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 +1289,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 +1341,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 +1386,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 +1405,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 +1443,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)
 
@@ -1365,16 +1459,20 @@ function AIRWING:CheckRescuhelo()
 
   local N=self:CountMissionsInQueue({AUFTRAG.Type.RESCUEHELO})
 
-  local name=self.airbase:GetName()
-
-  local carrier=UNIT:FindByName(name)
-
-  for i=1,self.nflightsRescueHelo-N do
-
-    local mission=AUFTRAG:NewRESCUEHELO(carrier)
-
-    self:AddMission(mission)
-
+  if self.airbase then
+  
+    local name=self.airbase:GetName()
+  
+    local carrier=UNIT:FindByName(name)
+  
+    for i=1,self.nflightsRescueHelo-N do
+  
+      local mission=AUFTRAG:NewRESCUEHELO(carrier)
+  
+      self:AddMission(mission)
+  
+    end
+    
   end
 
   return self
@@ -1460,7 +1558,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/ArmyGroup.lua

@@ -68,7 +68,7 @@ ARMYGROUP = {
 
 --- Army Group version.
 -- @field #string version
-ARMYGROUP.version="1.0.1"
+ARMYGROUP.version="1.0.3"
 
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 -- TODO list
@@ -839,8 +839,8 @@ function ARMYGROUP:Status()
       local ammo=self:GetAmmoElement(element)
 
       -- Output text for element.
-      text=text..string.format("\n[%d] %s: status=%s, life=%.1f/%.1f, guns=%d, rockets=%d, bombs=%d, missiles=%d, cargo=%d/%d kg",
-      i, name, status, life, life0, ammo.Guns, ammo.Rockets, ammo.Bombs, ammo.Missiles, element.weightCargo, element.weightMaxCargo)
+      text=text..string.format("\n[%d] %s: status=%s, life=%.1f/%.1f, guns=%d, cannons=%d, rockets=%d, missiles=%d, cargo=%d/%d kg",
+      i, name, status, life, life0, ammo.Guns, ammo.Cannons, ammo.Rockets, ammo.Missiles, element.weightCargo, element.weightMaxCargo)
     end
     if #self.elements==0 then
       text=text.." none!"
@@ -1571,7 +1571,7 @@ end
 -- @param Core.Zone#ZONE Zone The zone to return to.
 -- @param #number Formation Formation of the group.
 function ARMYGROUP:onafterRTZ(From, Event, To, Zone, Formation)
-  self:T2(self.lid.."onafterRTZ")
+  self:T(self.lid.."onafterRTZ")
 
   -- Zone.
   local zone=Zone or self.homezone
@@ -1841,8 +1841,6 @@ function ARMYGROUP:_UpdateEngageTarget()
       -- Check if target moved more than 100 meters or we do not have line of sight.
       if dist>100 or los==false then
 
-        --env.info("FF Update Engage Target Moved "..self.engage.Target:GetName())
-
         -- Update new position.
         self.engage.Coordinate:UpdateFromVec3(vec3)
 
@@ -1852,13 +1850,14 @@ function ARMYGROUP:_UpdateEngageTarget()
         -- Remove current waypoint
         self:RemoveWaypointByID(self.engage.Waypoint.uid)
 
-        local intercoord=self:GetCoordinate():GetIntermediateCoordinate(self.engage.Coordinate, 0.9)
+        -- Get new coordinate where to go.
+        local intercoord=self:GetCoordinate():GetIntermediateCoordinate(self.engage.Coordinate, 0.95)
 
           -- Add waypoint after current.
         self.engage.Waypoint=self:AddWaypoint(intercoord, self.engage.Speed, uid, self.engage.Formation, true)
 
         -- Set if we want to resume route after reaching the detour waypoint.
-        self.engage.Waypoint.detour=0
+        self.engage.Waypoint.detour=1
 
       end
 
@@ -2049,114 +2048,70 @@ end
 --- Initialize group parameters. Also initializes waypoints if self.waypoints is nil.
 -- @param #ARMYGROUP self
 -- @param #table Template Template used to init the group. Default is `self.template`.
+-- @param #number Delay Delay in seconds before group is initialized. Default `nil`, *i.e.* instantaneous.
 -- @return #ARMYGROUP self
 function ARMYGROUP:_InitGroup(Template, Delay)
 
   if Delay and Delay>0 then
     self:ScheduleOnce(Delay, ARMYGROUP._InitGroup, self, Template, 0)
   else
-  -- First check if group was already initialized.
-  if self.groupinitialized then
-    self:T(self.lid.."WARNING: Group was already initialized! Will NOT do it again!")
-    return
-  end
-
-  -- Get template of group.
-  local template=Template or self:_GetTemplate()
-
-  -- Ground are always AI.
-  self.isAI=true
-
-  -- Is (template) group late activated.
-  self.isLateActivated=template.lateActivation
-
-  -- Ground groups cannot be uncontrolled.
-  self.isUncontrolled=false
-
-  -- Max speed in km/h.
-  self.speedMax=self.group:GetSpeedMax()
-
-  -- Is group mobile?
-  if self.speedMax and self.speedMax>3.6 then
-    self.isMobile=true
-  else
-    self.isMobile=false
-    self.speedMax = 0
-  end
-
-  -- Cruise speed in km/h
-  self.speedCruise=self.speedMax*0.7
-
-  -- Group ammo.
-  self.ammo=self:GetAmmoTot()
-
-  -- Radio parameters from template.
-  self.radio.On=false  -- Radio is always OFF for ground.
-  self.radio.Freq=133
-  self.radio.Modu=radio.modulation.AM
-
-  -- Set default radio.
-  self:SetDefaultRadio(self.radio.Freq, self.radio.Modu, self.radio.On)
-
-  -- Get current formation from first waypoint.
-  self.option.Formation=template.route.points[1].action
-
-  -- Set default formation to "on road".
-  self.optionDefault.Formation=ENUMS.Formation.Vehicle.OnRoad
-
+  
     -- First check if group was already initialized.
     if self.groupinitialized then
       self:T(self.lid.."WARNING: Group was already initialized! Will NOT do it again!")
       return
     end
-
-    self:T(self.lid.."FF Initializing Group")
-
+  
     -- Get template of group.
     local template=Template or self:_GetTemplate()
-
+  
     -- Ground are always AI.
     self.isAI=true
-
+  
     -- Is (template) group late activated.
     self.isLateActivated=template.lateActivation
-
+  
     -- Ground groups cannot be uncontrolled.
     self.isUncontrolled=false
-
+  
     -- Max speed in km/h.
     self.speedMax=self.group:GetSpeedMax()
-
+  
     -- Is group mobile?
-    if self.speedMax>3.6 then
+    if self.speedMax and self.speedMax>3.6 then
       self.isMobile=true
     else
       self.isMobile=false
+      self.speedMax = 0
     end
-
+  
     -- Cruise speed in km/h
     self.speedCruise=self.speedMax*0.7
-
+  
     -- Group ammo.
     self.ammo=self:GetAmmoTot()
-
+  
     -- Radio parameters from template.
     self.radio.On=false  -- Radio is always OFF for ground.
     self.radio.Freq=133
     self.radio.Modu=radio.modulation.AM
-
+  
     -- Set default radio.
     self:SetDefaultRadio(self.radio.Freq, self.radio.Modu, self.radio.On)
-
+  
     -- Get current formation from first waypoint.
     self.option.Formation=template.route.points[1].action
-
+  
     -- Set default formation to "on road".
     self.optionDefault.Formation=ENUMS.Formation.Vehicle.OnRoad
 
     -- Default TACAN off.
-    self:SetDefaultTACAN(nil, nil, nil, nil, true)
-    self.tacan=UTILS.DeepCopy(self.tacanDefault)
+    if not self.tacanDefault then
+      self:SetDefaultTACAN(nil, nil, nil, nil, true)
+    end
+    if not self.tacan then
+      self.tacan=UTILS.DeepCopy(self.tacanDefault)
+    end
 
     -- Units of the group.
     local units=self.group:GetUnits()
@@ -2177,7 +2132,6 @@ function ARMYGROUP:_InitGroup(Template, Delay)
       self:_AddElementByName(unitname)
     end
 
-
     -- Init done.
     self.groupinitialized=true
   end

Moose Development/Moose/Ops/Auftrag.lua

@@ -162,6 +162,7 @@
 -- @field #number missionRange Mission range in meters. Used by LEGION classes (AIRWING, BRIGADE, ...).
 -- @field Core.Point#COORDINATE missionWaypointCoord Mission waypoint coordinate.
 -- @field Core.Point#COORDINATE missionEgressCoord Mission egress waypoint coordinate.
+-- @field Core.Point#COORDINATE missionIngressCoord Mission Ingress waypoint coordinate.
 -- @field #number missionWaypointRadius Random radius in meters.
 -- @field #boolean legionReturn If `true`, assets return to their legion (default). If `false`, they will stay alive. 
 --
@@ -323,6 +324,10 @@
 --
 -- A ground attack mission can be created with the @{#AUFTRAG.NewGROUNDATTACK}() function.
 --
+-- ## NAVALENGAGEMENT
+--
+-- A naval engagement mission can be created with the @{#AUFTRAG.NewNAVALENGAGEMENT}() function.
+--
 -- # Assigning Missions
 --
 -- An AUFTRAG can be assigned to groups (FLIGHTGROUP, ARMYGROUP, NAVYGROUP), legions (AIRWING, BRIGADE, FLEET) or to a COMMANDER.
@@ -396,6 +401,7 @@ AUFTRAG = {
   conditionPush      =    {},
   conditionSuccessSet = false,
   conditionFailureSet = false,
+  repeatDelay = 1,
 }
 
 --- Global mission counter.
@@ -441,6 +447,7 @@ _AUFTRAGSNR=0
 -- @field #string HOVER Hover.
 -- @field #string LANDATCOORDINATE Land at coordinate.
 -- @field #string GROUNDATTACK Ground attack.
+-- @field #string NAVALENGAGEMENT Naval engagement (similar to GROUNDATTACK).
 -- @field #string CARGOTRANSPORT Cargo transport.
 -- @field #string RELOCATECOHORT Relocate a cohort from one legion to another.
 -- @field #string AIRDEFENSE Air defense.
@@ -489,6 +496,7 @@ AUFTRAG.Type={
   HOVER="Hover",
   LANDATCOORDINATE="Land at Coordinate",
   GROUNDATTACK="Ground Attack",
+  NAVALENGAGEMENT="Naval Engagement",
   CARGOTRANSPORT="Cargo Transport",
   RELOCATECOHORT="Relocate Cohort",
   AIRDEFENSE="Air Defence",
@@ -513,6 +521,7 @@ AUFTRAG.Type={
 -- @field #string BARRAGE Barrage.
 -- @field #string HOVER Hover.
 -- @field #string GROUNDATTACK Ground attack.
+-- @field #string NAVALENGAGEMENT Naval engagement.
 -- @field #string FERRY Ferry mission.
 -- @field #string RELOCATECOHORT Relocate cohort.
 -- @field #string AIRDEFENSE Air defense.
@@ -535,6 +544,7 @@ AUFTRAG.SpecialTask={
   ARMORATTACK="AmorAttack",
   HOVER="Hover",
   GROUNDATTACK="Ground Attack",
+  NAVALENGAGEMENT="Naval Engagement",
   FERRY="Ferry",
   RELOCATECOHORT="Relocate Cohort",
   AIRDEFENSE="Air Defense",
@@ -664,7 +674,7 @@ AUFTRAG.Category={
 
 --- AUFTRAG class version.
 -- @field #string version
-AUFTRAG.version="1.2.1"
+AUFTRAG.version="1.3.0"
 
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 -- TODO list
@@ -1319,13 +1329,19 @@ end
 -- @param #number Altitude Orbit altitude in feet. Default is y component of `Coordinate`.
 -- @param #number Speed Orbit indicated airspeed in knots at the set altitude ASL. Default 350 KIAS.
 -- @param #number Heading Heading of race-track pattern in degrees. Default 270 (East to West).
--- @param #number Leg Length of race-track in NM. Default 10 NM.
+-- @param #number Leg Length of race-track in NM. Default 10 NM. Set to 0 for a simple circular orbit.
 -- @param #number RefuelSystem Refueling system (0=boom, 1=probe). This info is *only* for AIRWINGs so they launch the right tanker type.
 -- @return #AUFTRAG self
 function AUFTRAG:NewTANKER(Coordinate, Altitude, Speed, Heading, Leg, RefuelSystem)
-
+  
+  local mission
+  if Leg == 0 then
+    mission=AUFTRAG:NewORBIT_CIRCLE(Coordinate,Altitude,Speed)
+  else
+    mission=AUFTRAG:NewORBIT_RACETRACK(Coordinate,Altitude,Speed,Heading,Leg)
+  end
   -- Create ORBIT first.
-  local mission=AUFTRAG:NewORBIT_RACETRACK(Coordinate, Altitude, Speed, Heading, Leg)
+  --local mission=AUFTRAG:NewORBIT_RACETRACK(Coordinate, Altitude, Speed, Heading, Leg)
 
   -- Mission type TANKER.
   mission.type=AUFTRAG.Type.TANKER
@@ -1427,7 +1443,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:
@@ -1714,19 +1730,56 @@ 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
-function AUFTRAG:NewSTRIKE(Target, Altitude)
+function AUFTRAG:NewSTRIKE(Target, Altitude, EngageWeaponType)
 
   local mission=AUFTRAG:New(AUFTRAG.Type.STRIKE)
 
   mission:_TargetFromObject(Target)
 
   -- DCS Task options:
-  mission.engageWeaponType=ENUMS.WeaponFlag.Auto
+  mission.engageWeaponType=EngageWeaponType or ENUMS.WeaponFlag.Auto
   mission.engageWeaponExpend=AI.Task.WeaponExpend.ALL
   mission.engageAltitude=UTILS.FeetToMeters(Altitude or 2000)
 
@@ -1747,17 +1800,19 @@ 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)
+function AUFTRAG:NewBOMBING(Target, Altitude, EngageWeaponType, Divebomb)
 
   local mission=AUFTRAG:New(AUFTRAG.Type.BOMBING)
 
   mission:_TargetFromObject(Target)
 
   -- DCS task options:
-  mission.engageWeaponType=ENUMS.WeaponFlag.Auto
+  mission.engageWeaponType=EngageWeaponType or ENUMS.WeaponFlag.Auto
   mission.engageWeaponExpend=AI.Task.WeaponExpend.ALL
   mission.engageAltitude=UTILS.FeetToMeters(Altitude or 25000)
 
@@ -1767,6 +1822,7 @@ function AUFTRAG:NewBOMBING(Target, Altitude)
   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
@@ -1819,7 +1875,7 @@ end
 
 --- **[AIR]** Create a BOMBRUNWAY mission.
 -- @param #AUFTRAG self
--- @param Wrapper.Airbase#AIRBASE Airdrome The airbase to bomb. This must be an airdrome (not a FARP or ship) as these to not have a runway.
+-- @param Wrapper.Airbase#AIRBASE Airdrome The airbase to bomb. This must be an airdrome (not a FARP or ship) as these do not have a runway.
 -- @param #number Altitude Engage altitude in feet. Default 25000 ft.
 -- @return #AUFTRAG self
 function AUFTRAG:NewBOMBRUNWAY(Airdrome, Altitude)
@@ -1981,7 +2037,7 @@ function AUFTRAG:NewRESCUEHELO(Carrier)
 
   -- Mission options:
   mission.missionTask=ENUMS.MissionTask.NOTHING
-  mission.missionFraction=0.5
+  mission.missionFraction=0.9
   mission.optionROE=ENUMS.ROE.WeaponHold
   mission.optionROT=ENUMS.ROT.NoReaction
 
@@ -2155,10 +2211,14 @@ end
 
 ]]
 
---- **[GROUND, NAVAL]** Create an ARTY mission.
+--- **[GROUND, NAVAL]** Create an ARTY mission ("Fire at point" task).
+-- 
+-- If the group has more than one weapon type supporting the "Fire at point" task, the employed weapon type can be set via the `AUFTRAG:SetWeaponType()` function.
+-- 
+-- **Note** that it is recommended to set the weapon range via the `OPSGROUP:AddWeaponRange()` function as this cannot be retrieved from the DCS API.
 -- @param #AUFTRAG self
 -- @param Core.Point#COORDINATE Target Center of the firing solution.
--- @param #number Nshots Number of shots to be fired. Default `#nil`.
+-- @param #number Nshots Number of shots to be fired. Default `#nil`. If value is in (0,1), it is interpreted as per cent of available ammo.
 -- @param #number Radius Radius of the shells in meters. Default 100 meters.
 -- @param #number Altitude Altitude in meters. Can be used to setup a Barrage. Default `#nil`.
 -- @return #AUFTRAG self
@@ -2178,6 +2238,7 @@ function AUFTRAG:NewARTY(Target, Nshots, Radius, Altitude)
   mission.optionAlarm=0
 
   mission.missionFraction=0.0
+  mission.missionWaypointRadius=0.0
 
   -- Evaluate after 8 min.
   mission.dTevaluate=8*60
@@ -2271,8 +2332,9 @@ end
 -- @param #number Speed Speed in knots.
 -- @param #number Altitude Altitude in feet. Only for airborne units. Default 2000 feet ASL.
 -- @param #string Formation Formation used by ground units during patrol. Default "Off Road".
+-- @param #number StayInZoneTime Stay this many seconds in the zone when done, only then drive back.
 -- @return #AUFTRAG self
-function AUFTRAG:NewCAPTUREZONE(OpsZone, Coalition, Speed, Altitude, Formation)
+function AUFTRAG:NewCAPTUREZONE(OpsZone, Coalition, Speed, Altitude, Formation, StayInZoneTime)
 
   local mission=AUFTRAG:New(AUFTRAG.Type.CAPTUREZONE)
 
@@ -2286,6 +2348,7 @@ function AUFTRAG:NewCAPTUREZONE(OpsZone, Coalition, Speed, Altitude, Formation)
   mission.optionROE=ENUMS.ROE.ReturnFire
   mission.optionROT=ENUMS.ROT.PassiveDefense
   mission.optionAlarm=ENUMS.AlarmState.Auto
+  mission.StayInZoneTime = StayInZoneTime
 
   mission.missionFraction=0.1
   mission.missionSpeed=Speed and UTILS.KnotsToKmph(Speed) or nil
@@ -2302,7 +2365,7 @@ function AUFTRAG:NewCAPTUREZONE(OpsZone, Coalition, Speed, Altitude, Formation)
   params.formation=Formation or "Off Road"  
   params.zone=mission:GetObjective()
   params.altitude=mission.missionAltitude
-  params.speed=mission.missionSpeed  
+  params.speed=mission.missionSpeed and UTILS.KmphToMps(mission.missionSpeed) or nil
 
   mission.DCStask.params=params
 
@@ -2327,11 +2390,13 @@ function AUFTRAG:NewARMORATTACK(Target, Speed, Formation)
   return mission
 end
 
---- **[GROUND]** Create a GROUNDATTACK mission. Ground group(s) will go to a target object and attack.
+--- **[GROUND]** Create a GROUNDATTACK mission. Ground group(s) will go to a target object and attack at their own discretion.
+-- Unfortunately, the "Attack Group" and "Attack Unit" tasks do not work for ground and naval groups (only for aircraft).
+-- Therefore, we resort to this workaround, which guides the attacking group to the vicinity of the target. Then they start shooting on their own, once they detect the target.
 -- @param #AUFTRAG self
 -- @param Wrapper.Positionable#POSITIONABLE Target The target to attack. Can be a GROUP, UNIT or STATIC object.
 -- @param #number Speed Speed in knots. Default max.
--- @param #string Formation The attack formation, e.g. "Wedge", "Vee" etc. Default `ENUMS.Formation.Vehicle.Vee`.
+-- @param #string Formation The attack formation, e.g. "Wedge", "Vee" etc. Default `ENUMS.Formation.Vehicle.Vee`. Only working for ground, not naval!
 -- @return #AUFTRAG self
 function AUFTRAG:NewGROUNDATTACK(Target, Speed, Formation)
 
@@ -2352,12 +2417,44 @@ function AUFTRAG:NewGROUNDATTACK(Target, Speed, Formation)
 
   mission.DCStask=mission:GetDCSMissionTask()
   
-  mission.DCStask.params.speed=Speed
+  mission.DCStask.params.speed=mission.missionSpeed and UTILS.KmphToMps(mission.missionSpeed) or nil
   mission.DCStask.params.formation=Formation or ENUMS.Formation.Vehicle.Vee
   
   return mission
 end
 
+--- **[NAVAL]** Create a NAVALENGAGEMENT mission. Naval group(s) will go to a target object and attack at their own discretion.
+-- Unfortunately, the "Attack Group" and "Attack Unit" tasks do not work for ground and naval groups (only for aircraft).
+-- Therefore, we resort to this workaround, which guides the attacking group to the vicinity of the target. Then they start shooting on their own, once they detect the target.
+-- @param #AUFTRAG self
+-- @param Wrapper.Positionable#POSITIONABLE Target The target to attack. Can be a GROUP, UNIT or STATIC object.
+-- @param #number Speed Speed in knots. Default max.
+-- @param #number Depth The attack depth in meters. Only for submarines!
+-- @return #AUFTRAG self
+function AUFTRAG:NewNAVALENGAGEMENT(Target, Speed, Depth)
+
+  local mission=AUFTRAG:New(AUFTRAG.Type.NAVALENGAGEMENT)
+
+  mission:_TargetFromObject(Target)
+
+  mission.missionTask=mission:GetMissionTaskforMissionType(AUFTRAG.Type.NAVALENGAGEMENT)
+
+  -- Defaults.
+  mission.optionROE=ENUMS.ROE.OpenFire
+  mission.optionAlarm=ENUMS.AlarmState.Auto
+  mission.missionFraction=0.70
+  mission.missionSpeed=Speed and UTILS.KnotsToKmph(Speed) or nil
+  mission.missionAltitude=Depth or 0
+
+  mission.categories={AUFTRAG.Category.NAVAL}
+
+  mission.DCStask=mission:GetDCSMissionTask()
+  
+  mission.DCStask.params.speed=mission.missionSpeed and UTILS.KmphToMps(mission.missionSpeed) or nil
+  
+  return mission
+end
+
 --- **[AIR, GROUND, NAVAL]** Create a RECON mission.
 -- @param #AUFTRAG self
 -- @param Core.Set#SET_ZONE ZoneSet The recon zones.
@@ -2650,33 +2747,35 @@ function AUFTRAG:NewFromTarget(Target, MissionType)
   local mission=nil --#AUFTRAG
 
   if MissionType==AUFTRAG.Type.ANTISHIP then
-    mission=self:NewANTISHIP(Target, Altitude)
+    mission=self:NewANTISHIP(Target)
   elseif MissionType==AUFTRAG.Type.ARTY then
-    mission=self:NewARTY(Target, Nshots, Radius)
+    mission=self:NewARTY(Target, 0.3) -- use 30% of the available ammo
   elseif MissionType==AUFTRAG.Type.BAI then
-    mission=self:NewBAI(Target, Altitude)
+    mission=self:NewBAI(Target)
   elseif MissionType==AUFTRAG.Type.BOMBCARPET then
-    mission=self:NewBOMBCARPET(Target, Altitude, CarpetLength)
+    mission=self:NewBOMBCARPET(Target)
   elseif MissionType==AUFTRAG.Type.BOMBING then
-    mission=self:NewBOMBING(Target, Altitude)
+    mission=self:NewBOMBING(Target)
   elseif MissionType==AUFTRAG.Type.BOMBRUNWAY then
-    mission=self:NewBOMBRUNWAY(Target, Altitude)
+    mission=self:NewBOMBRUNWAY(Target)
   elseif MissionType==AUFTRAG.Type.STRAFING then
-    mission=self:NewSTRAFING(Target, Altitude)    
+    mission=self:NewSTRAFING(Target)    
   elseif MissionType==AUFTRAG.Type.CAS then
-    mission=self:NewCAS(ZONE_RADIUS:New(Target:GetName(),Target:GetVec2(),1000), Altitude, Speed, Target:GetAverageCoordinate(), Heading, Leg, TargetTypes)
+    mission=self:NewCAS(ZONE_RADIUS:New(Target:GetName(),Target:GetVec2(),1000), nil, nil, Target:GetAverageCoordinate())
   elseif MissionType==AUFTRAG.Type.CASENHANCED then
-    mission=self:NewCASENHANCED(ZONE_RADIUS:New(Target:GetName(),Target:GetVec2(),1000), Altitude, Speed, RangeMax, NoEngageZoneSet, TargetTypes)
+    mission=self:NewCASENHANCED(ZONE_RADIUS:New(Target:GetName(),Target:GetVec2(),1000))
   elseif MissionType==AUFTRAG.Type.INTERCEPT then
     mission=self:NewINTERCEPT(Target)
   elseif MissionType==AUFTRAG.Type.SEAD then
-    mission=self:NewSEAD(Target, Altitude)
+    mission=self:NewSEAD(Target)
   elseif MissionType==AUFTRAG.Type.STRIKE then
-    mission=self:NewSTRIKE(Target, Altitude)
+    mission=self:NewSTRIKE(Target)
   elseif MissionType==AUFTRAG.Type.ARMORATTACK then
-    mission=self:NewARMORATTACK(Target, Speed)
+    mission=self:NewARMORATTACK(Target)
   elseif MissionType==AUFTRAG.Type.GROUNDATTACK then
-    mission=self:NewGROUNDATTACK(Target, Speed, Formation)
+    mission=self:NewGROUNDATTACK(Target)
+  elseif MissionType==AUFTRAG.Type.NAVALENGAGEMENT then
+    mission=self:NewNAVALENGAGEMENT(Target)
   else
     return nil
   end
@@ -2793,7 +2892,7 @@ function AUFTRAG:NewAUTO(EngageGroup)
   if auftrag==AUFTRAG.Type.ANTISHIP then
     mission=AUFTRAG:NewANTISHIP(Target)
   elseif auftrag==AUFTRAG.Type.ARTY then
-    mission=AUFTRAG:NewARTY(Target)
+    mission=AUFTRAG:NewARTY(Target, 0.2)
   elseif auftrag==AUFTRAG.Type.AWACS then
     mission=AUFTRAG:NewAWACS(Coordinate, Altitude,Speed,Heading,Leg)
   elseif auftrag==AUFTRAG.Type.BAI then
@@ -2958,6 +3057,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 RepeatDelay 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.
@@ -3481,7 +3590,7 @@ end
 
 --- Set Rules of Engagement (ROE) for this mission.
 -- @param #AUFTRAG self
--- @param #string roe Mission ROE.
+-- @param #number roe Mission ROE, e.g. `ENUMS.ROE.ReturnFire` (whiche equals 3)
 -- @return #AUFTRAG self
 function AUFTRAG:SetROE(roe)
 
@@ -3493,7 +3602,7 @@ end
 
 --- Set Reaction on Threat (ROT) for this mission.
 -- @param #AUFTRAG self
--- @param #string rot Mission ROT.
+-- @param #number rot Mission ROT, e.g. `ENUMS.ROT.NoReaction` (whiche equals 0)
 -- @return #AUFTRAG self
 function AUFTRAG:SetROT(rot)
 
@@ -3953,6 +4062,23 @@ function AUFTRAG:IsOver()
   return over
 end
 
+--- Check if mission is repeatable.
+-- @param #AUFTRAG self
+-- @return #boolean If true, mission is repeatable.
+function AUFTRAG:IsRepeatable()
+  local repeatmeS=self.repeatedSuccess<self.NrepeatSuccess or self.repeated<self.Nrepeat
+  local repeatmeF=self.repeatedFailure<self.NrepeatFailure or self.repeated<self.Nrepeat
+  if repeatmeS==true or repeatmeF==true then return true else return false end
+  return false
+end
+
+--- Check if mission is NOT repeatable.
+-- @param #AUFTRAG self
+-- @return #boolean If true, mission is NOT repeatable.
+function AUFTRAG:IsNotRepeatable()
+  return not self:IsRepeatable()
+end
+
 --- Check if mission is NOT over.
 -- @param #AUFTRAG self
 -- @return #boolean If true, mission is NOT over yet.
@@ -4317,7 +4443,7 @@ function AUFTRAG:onafterStatus(From, Event, To)
   -- Group info.
   if self.verbose>=3 then
     -- Data on assigned groups.
-    local text=string.format("Assets [N=%d,Nassigned=%s, Ndead=%s]:", self.Nassets or 0, self.Nassigned or 0, self.Ndead or 0)
+    local text=string.format("Assets [N=%d, Nassigned=%s, Ndead=%s]:", self.Nassets or 0, self.Nassigned or 0, self.Ndead or 0)
     for i,_asset in pairs(self.assets or {}) do
       local asset=_asset --Functional.Warehouse#WAREHOUSE.Assetitem
       text=text..string.format("\n[%d] %s: spawned=%s, requested=%s, reserved=%s", i, asset.spawngroupname, tostring(asset.spawned), tostring(asset.requested), tostring(asset.reserved))
@@ -4358,7 +4484,7 @@ function AUFTRAG:Evaluate()
   local owndamage=self.Ncasualties/self.Nelements*100
 
   -- Current number of mission targets.
-  local Ntargets=self:CountMissionTargets()
+  local Ntargets=self:CountMissionTargets(true)
   local Ntargets0=self:GetTargetInitialNumber()
 
   local Life=self:GetTargetLife()
@@ -4657,6 +4783,16 @@ function AUFTRAG:SetGroupWaypointCoordinate(opsgroup, coordinate)
   return self
 end
 
+--- [Air] Set mission (ingress) waypoint coordinate for FLIGHT group.
+-- @param #AUFTRAG self
+-- @param Core.Point#COORDINATE coordinate Waypoint Coordinate.
+-- @return #AUFTRAG self
+function AUFTRAG:SetIngressCoordinate(coordinate)
+  self.missionIngressCoord = coordinate
+  self.missionIngressCoordAlt = UTILS.MetersToFeet(coordinate.y) or 10000
+  return self
+end
+
 --- Get mission (ingress) waypoint coordinate of OPS group
 -- @param #AUFTRAG self
 -- @param Ops.OpsGroup#OPSGROUP opsgroup The OPS group.
@@ -4747,6 +4883,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
@@ -4797,13 +4935,27 @@ function AUFTRAG:CheckGroupsDone()
     self:T2(self.lid..string.format("CheckGroupsDone: Mission is still in state %s [FSM=%s] and reinfoce=%d. Mission NOT DONE!", self.status, self:GetState(), self.reinforce))
     return false  
   end
+  
+  local NopsgroupsAlive=self:CountOpsGroups()
+  local NopsgroupsDone=self:CountOpsGroupsInStatus(AUFTRAG.GroupStatus.DONE)+self:CountOpsGroupsInStatus(AUFTRAG.GroupStatus.CANCELLED)
 
   -- It could be that all groups were destroyed on the way to the mission execution waypoint.
   -- TODO: would be better to check if everybody is dead by now.
-  if self:IsStarted() and self:CountOpsGroups()==0 then
+  if self:IsStarted() and NopsgroupsAlive==0 then
     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
+  
+  -- Every group alive is done or cancelled
+  if NopsgroupsAlive==NopsgroupsDone then
+    self:T(self.lid..string.format("CheckGroupsDone: Mission is in state %s [FSM=%s] but all groups [=%d] are done or cancelled. Mission DONE!", self.status, self:GetState(), NopsgroupsAlive))
+    return true
+  end
+  
+  if (self:IsStarted() or self:IsExecuting()) and (fsmState == AUFTRAG.Status.STARTED or fsmState == AUFTRAG.Status.EXECUTING) and NopsgroupsAlive>0 then
+    self:T(self.lid..string.format("CheckGroupsDone: Mission is in state %s [FSM=%s] and count of alive OPSGROUP > zero. Mission NOT DONE!", self.status, self:GetState()))
+    return false
+  end
 
   return true
 end
@@ -5142,7 +5294,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
 
@@ -5184,7 +5336,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
 
@@ -5395,8 +5547,9 @@ end
 
 --- Count alive mission targets.
 -- @param #AUFTRAG self
+-- @param #boolean OnlyReallyAlive (Optional) If `true`, count only really alive targets (units, groups) but not coordinates or zones.
 -- @return #number Number of alive target units.
-function AUFTRAG:CountMissionTargets()
+function AUFTRAG:CountMissionTargets(OnlyReallyAlive)
 
   local N=0
 
@@ -5404,7 +5557,7 @@ function AUFTRAG:CountMissionTargets()
   local Coalitions=self.coalition and UTILS.GetCoalitionEnemy(self.coalition, true) or nil
 
   if self.engageTarget then
-    N=self.engageTarget:CountTargets(Coalitions)
+    N=self.engageTarget:CountTargets(Coalitions, OnlyReallyAlive)
   end
 
   return N
@@ -5712,7 +5865,7 @@ function AUFTRAG:GetMissionTypesText(MissionTypes)
   return text
 end
 
---- Set the mission waypoint coordinate where the mission is executed. Note that altitude is set via `:SetMissionAltitude`.
+--- [NON-AIR] Set the mission waypoint coordinate from where the mission is executed. Note that altitude is set via `:SetMissionAltitude`.
 -- @param #AUFTRAG self
 -- @param Core.Point#COORDINATE Coordinate Coordinate where the mission is executed.
 -- @return #AUFTRAG self
@@ -5740,8 +5893,9 @@ end
 -- @param #AUFTRAG self
 -- @param Core.Point#COORDINATE Coordinate Egrees coordinate.
 -- @param #number Altitude (Optional) Altitude in feet. Default is y component of coordinate.
+-- @param #number Speed (Optional) Speed in knots to reach this waypoint. Defaults to mission speed.
 -- @return #AUFTRAG self
-function AUFTRAG:SetMissionEgressCoord(Coordinate, Altitude)
+function AUFTRAG:SetMissionEgressCoord(Coordinate, Altitude, Speed)
 
   -- Obviously a zone was passed. We get the coordinate.
   if Coordinate:IsInstanceOf("ZONE_BASE") then
@@ -5752,7 +5906,64 @@ function AUFTRAG:SetMissionEgressCoord(Coordinate, Altitude)
 
   if Altitude then
     self.missionEgressCoord.y=UTILS.FeetToMeters(Altitude)
+    self.missionEgressCoordAlt = UTILS.FeetToMeters(Altitude)
   end
+  
+  self.missionEgressCoordSpeed=Speed and Speed or nil
+  
+  return self
+end
+
+--- [Air] Set the mission ingress coordinate. This is the coordinate where the assigned group will fly before the actual mission coordinate.
+-- @param #AUFTRAG self
+-- @param Core.Point#COORDINATE Coordinate Ingrees coordinate.
+-- @param #number Altitude (Optional) Altitude in feet. Default is y component of coordinate.
+-- @param #number Speed (Optional) Speed in knots to reach this waypoint. Defaults to mission speed.
+-- @return #AUFTRAG self
+function AUFTRAG:SetMissionIngressCoord(Coordinate, Altitude, Speed)
+
+  -- Obviously a zone was passed. We get the coordinate.
+  if Coordinate:IsInstanceOf("ZONE_BASE") then
+    Coordinate=Coordinate:GetCoordinate()
+  end
+
+  self.missionIngressCoord=Coordinate
+
+  if Altitude then
+    self.missionIngressCoord.y=UTILS.FeetToMeters(Altitude)
+    self.missionIngressCoordAlt = UTILS.FeetToMeters(Altitude or 10000)
+  end
+  
+  self.missionIngressCoordSpeed=Speed and Speed or nil
+  
+  return self
+end
+
+--- [Air] Set the mission holding coordinate. This is the coordinate where the assigned group will fly before the actual mission execution starts. Do not forget to add a push condition, too!
+-- @param #AUFTRAG self
+-- @param Core.Point#COORDINATE Coordinate Holding coordinate.
+-- @param #number Altitude (Optional) Altitude in feet. Default is y component of coordinate.
+-- @param #number Speed (Optional) Speed in knots to reach this waypoint and hold there. Defaults to mission speed.
+-- @param #number Duration (Optional) Duration in seconds on how long to hold, defaults to 15 minutes. Mission continues if either a push condition is met or the time is up.
+-- @return #AUFTRAG self
+function AUFTRAG:SetMissionHoldingCoord(Coordinate, Altitude, Speed, Duration)
+
+  -- Obviously a zone was passed. We get the coordinate.
+  if Coordinate:IsInstanceOf("ZONE_BASE") then
+    Coordinate=Coordinate:GetCoordinate()
+  end
+  
+  self.missionHoldingCoord=Coordinate
+  self.missionHoldingDuration=Duration or 900
+
+  if Altitude then
+    self.missionHoldingCoord.y=UTILS.FeetToMeters(Altitude)
+    self.missionHoldingCoordAlt = UTILS.FeetToMeters(Altitude or 10000)
+  end
+  
+  self.missionHoldingCoordSpeed=Speed and Speed or nil
+
+  return self
 end
 
 --- Get the mission egress coordinate if this was defined.
@@ -5762,6 +5973,20 @@ function AUFTRAG:GetMissionEgressCoord()
   return self.missionEgressCoord
 end
 
+--- Get the mission ingress coordinate if this was defined.
+-- @param #AUFTRAG self
+-- @return Core.Point#COORDINATE Coordinate Coordinate or nil.
+function AUFTRAG:GetMissionIngressCoord()
+  return self.missionIngressCoord
+end
+
+--- Get the mission holding coordinate if this was defined.
+-- @param #AUFTRAG self
+-- @return Core.Point#COORDINATE Coordinate Coordinate or nil.
+function AUFTRAG:GetMissionHoldingCoord()
+  return self.missionHoldingCoord
+end
+
 --- Get coordinate which was set as mission waypoint coordinate.
 -- @param #AUFTRAG self
 -- @return Core.Point#COORDINATE Coordinate where the mission is executed or `#nil`.
@@ -5796,10 +6021,27 @@ function AUFTRAG:GetMissionWaypointCoord(group, randomradius, surfacetypes)
     end
     return coord
   end
+  
+  local coord=group:GetCoordinate()
+  
+  -- Check if an ingress or holding coord has been explicitly set.
+  if self.missionHoldingCoord then
+    coord=self.missionHoldingCoord
+    if self.missionHoldingCoorddAlt then
+      coord:SetAltitude(self.missionHoldingCoordAlt, true)
+    end
+  end
+  
+  if self.missionIngressCoord then
+    coord=self.missionIngressCoord
+    if self.missionIngressCoordAlt then
+      coord:SetAltitude(self.missionIngressCoordAlt, true)
+    end
+  end
 
   -- Create waypoint coordinate half way between us and the target.
   local waypointcoord=COORDINATE:New(0,0,0)
-  local coord=group:GetCoordinate()
+  
   if coord then
     waypointcoord=coord:GetIntermediateCoordinate(self:GetTargetCoordinate(), self.missionFraction)
   else
@@ -6001,10 +6243,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
 
     ----------------------
@@ -6040,8 +6285,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)
 
@@ -6099,7 +6352,7 @@ function AUFTRAG:GetDCSMissionTask()
     local param={}
     param.zone=self:GetObjective()
     param.altitude=self.missionAltitude
-    param.speed=self.missionSpeed
+    param.speed=self.missionSpeed and UTILS.KmphToMps(self.missionSpeed) or nil
 
     DCStask.params=param
 
@@ -6179,7 +6432,7 @@ function AUFTRAG:GetDCSMissionTask()
     local param={}
     param.target=self.engageTarget
     param.altitude=self.missionAltitude
-    param.speed=self.missionSpeed
+    param.speed=self.missionSpeed and UTILS.KmphToMps(self.missionSpeed) or nil
     param.lastindex=nil
 
     DCStask.params=param
@@ -6195,18 +6448,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
 
@@ -6352,7 +6634,7 @@ function AUFTRAG:GetDCSMissionTask()
     local param={}
     param.zone=self:GetObjective()
     param.altitude=self.missionAltitude
-    param.speed=self.missionSpeed
+    param.speed=self.missionSpeed and UTILS.KmphToMps(self.missionSpeed) or nil
 
     DCStask.params=param
 
@@ -6388,7 +6670,7 @@ function AUFTRAG:GetDCSMissionTask()
     local param={}
     param.zone=self:GetObjective()
     param.altitude=self.missionAltitude
-    param.speed=self.missionSpeed
+    param.speed=self.missionSpeed and UTILS.KmphToMps(self.missionSpeed) or nil
 
     DCStask.params=param
 
@@ -6408,7 +6690,27 @@ function AUFTRAG:GetDCSMissionTask()
     local param={}
     param.target=self:GetTargetData()
     param.action="Wedge"
-    param.speed=self.missionSpeed
+    param.speed=self.missionSpeed and UTILS.KmphToMps(self.missionSpeed) or nil
+
+    DCStask.params=param
+
+    table.insert(DCStasks, DCStask)
+
+   elseif self.type==AUFTRAG.Type.NAVALENGAGEMENT then
+
+    ---------------------------
+    -- NAVAL ENGAGEMENT Mission --
+    ---------------------------
+
+    local DCStask={}
+
+    DCStask.id=AUFTRAG.SpecialTask.NAVALENGAGEMENT
+
+    -- We create a "fake" DCS task and pass the parameters to the NAVYGROUP.
+    local param={}
+    param.target=self:GetTargetData()
+    param.speed=self.missionSpeed and UTILS.KmphToMps(self.missionSpeed) or nil
+    param.altitude=self.missionAltitude or 0
 
     DCStask.params=param
 

Moose Development/Moose/Ops/Awacs.lua

@@ -17,7 +17,7 @@
 -- ===
 --
 -- ### Author: **applevangelist**
--- @date Last Update July 2024
+-- @date Last Update July 2025
 -- @module Ops.AWACS
 -- @image OPS_AWACS.jpg
 
@@ -122,6 +122,7 @@ do
 -- @field #number TacticalModulation
 -- @field #number TacticalInterval
 -- @field Core.Set#SET_GROUP DetectionSet
+-- @field #number MaxMissionRange
 -- @extends Core.Fsm#FSM
 
 
@@ -183,7 +184,7 @@ do
 --            
 -- Add Escorts Squad (recommended, optional)
 -- 
---            local Squad_Two = SQUADRON:New("Escorts",4,"Escorts North")
+--            local Squad_Two = SQUADRON:New("Escorts",4,"Escorts North") -- taking a template with 2 planes here, will result in a group of 2 escorts which can fly in formation escorting the AWACS.
 --            Squad_Two:AddMissionCapability({AUFTRAG.Type.ESCORT})
 --            Squad_Two:SetFuelLowRefuel(true)
 --            Squad_Two:SetFuelLowThreshold(0.3)
@@ -231,12 +232,12 @@ do
 --            -- set up in the mission editor with a late activated helo named "Rock#ZONE_POLYGON". Note this also sets the BullsEye to be referenced as "Rock".
 --            -- The CAP station zone is called "Fremont". We will be on 255 AM.
 --            local testawacs = AWACS:New("AWACS North",AwacsAW,"blue",AIRBASE.Caucasus.Kutaisi,"Awacs Orbit",ZONE:FindByName("Rock"),"Fremont",255,radio.modulation.AM )
---            -- set two escorts
---            testawacs:SetEscort(2)
+--            -- set one escort group; this example has two units in the template group, so they can fly a nice formation.
+--            testawacs:SetEscort(1,ENUMS.Formation.FixedWing.FingerFour.Group,{x=-500,y=50,z=500},45)
 --            -- 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.
@@ -254,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.
@@ -508,7 +509,7 @@ do
 -- @field #AWACS
 AWACS = {
   ClassName = "AWACS", -- #string
-  version = "0.2.65", -- #string
+  version = "0.2.74", -- #string
   lid = "", -- #string
   coalition = coalition.side.BLUE, -- #number
   coalitiontxt = "blue", -- #string
@@ -605,6 +606,7 @@ AWACS = {
   TacticalModulation = radio.modulation.AM,
   TacticalInterval = 120,
   DetectionSet = nil,
+  MaxMissionRange = 125,
 }
 
 ---
@@ -1121,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
@@ -1240,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.
   
   
@@ -1363,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
@@ -1572,6 +1596,25 @@ function AWACS:SetLocale(Locale)
   return self
 end
 
+--- [User] Set own coordinate for BullsEye.
+-- @param #AWACS self
+-- @param Core.Point#COORDINATE
+-- @return #AWACS self
+function AWACS:SetBullsCoordinate(Coordinate)
+  self:T(self.lid.."SetBullsCoordinate")
+  self.AOCoordinate = Coordinate
+  return self
+end
+
+--- [User] Set the max mission range flights can be away from their home base.
+-- @param #AWACS self
+-- @param #number NM Distance in nautical miles
+-- @return #AWACS self
+function AWACS:SetMaxMissionRange(NM)
+  self.MaxMissionRange = NM or 125
+  return self
+end
+
 --- [User] Add additional frequency and modulation for AWACS SRS output.
 -- @param #AWACS self
 -- @param #number Frequency The frequency to add, e.g. 132.5
@@ -1762,7 +1805,7 @@ function AWACS:_EventHandler(EventData)
     end
   end
   
-  if Event.id == EVENTS.PlayerLeaveUnit then --player left unit
+  if Event.id == EVENTS.PlayerLeaveUnit and Event.IniGroupName then --player left unit
     -- check known player?
     self:T("Player group left  unit: " .. Event.IniGroupName)
     self:T("Player name left: " .. Event.IniPlayerName)
@@ -1988,7 +2031,9 @@ function AWACS:SetAdditionalZone(Zone, Draw)
   self.BorderZone = Zone
   if self.debug then
     Zone:DrawZone(self.coalition,{1,0.64,0},1,{1,0.64,0},0.2,1,true)
-    MARKER:New(Zone:GetCoordinate(),"Defensive Zone"):ToCoalition(self.coalition)
+    if self.AllowMarkers then
+      MARKER:New(Zone:GetCoordinate(),"Defensive Zone"):ToCoalition(self.coalition)
+    end
   elseif Draw then
     Zone:DrawZone(self.coalition,{1,0.64,0},1,{1,0.64,0},0.2,1,true)
   end
@@ -2008,11 +2053,62 @@ function AWACS:SetRejectionZone(Zone,Draw)
     --MARKER:New(Zone:GetCoordinate(),"Rejection Zone"):ToAll()
   elseif self.debug then
     Zone:DrawZone(self.coalition,{1,0.64,0},1,{1,0.64,0},0.2,1,true)
-    MARKER:New(Zone:GetCoordinate(),"Rejection Zone"):ToCoalition(self.coalition)
+    if self.AllowMarkers then
+      MARKER:New(Zone:GetCoordinate(),"Rejection Zone"):ToCoalition(self.coalition)
+    end
   end
   return self
 end
 
+--- Function to set corridor zones.
+-- @param #AWACS self
+-- @param Core.Set#SET_ZONE CorridorZones Can be handed in as SET\_ZONE or single ZONE object.
+-- @return #AWACS self
+function AWACS:SetCorridorZones(CorridorZones)
+  self:T(self.lid .. "SetCorridorZones")
+  if CorridorZones and CorridorZones:IsInstanceOf("SET_ZONE") then
+    self.corridorzones = CorridorZones
+    self.usecorridors = true
+  elseif CorridorZones and CorridorZones:IsInstanceOf("ZONE_BASE") then
+    if not self.corridorzones then self.corridorzones = SET_ZONE:New() end
+    self.corridorzones:AddZone(CorridorZones)
+    self.usecorridors = true
+  end
+  return self
+end
+
+--- Function to add one corridor zone.
+-- @param #AWACS self
+-- @param Core.Zone#ZONE CorridorZone The ZONE object to be added.
+-- @return #AWACS self
+function AWACS:AddCorridorZone(CorridorZone)
+  self:T(self.lid .. "AddCorridorZone")
+  self:SetCorridorZones(CorridorZone)
+  return self
+end
+
+--- Function to set corridor zone floor and ceiling in FEET.
+-- @param #AWACS self
+-- @param #number Floor Floor altitude ASL in feet.
+-- @param #number Ceiling Ceiling altitude ASL in feet.
+-- @return #AWACS self
+function AWACS:SetCorridorZoneFloorAndCeiling(Floor,Ceiling)
+  self.corridorfloor = UTILS.FeetToMeters(Floor)
+  self.corridorceiling = UTILS.FeetToMeters(Ceiling)
+  return self
+end
+
+--- Function to set corridor zone floor and ceiling in METERS.
+-- @param #AWACS self
+-- @param #number Floor Floor altitude ASL in meters.
+-- @param #number Ceiling Ceiling altitude ASL in meters.
+-- @return #AWACS self
+function AWACS:SetCorridorZoneFloorAndCeilingMeters(Floor,Ceiling)
+  self.corridorfloor = Floor    
+  self.corridorceiling = Ceiling
+  return self
+end
+
 --- [User] Draw a line around the FEZ on the F10 map.
 -- @param #AWACS self
 -- @return #AWACS self
@@ -2080,7 +2176,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
@@ -2093,7 +2189,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
@@ -2158,9 +2254,12 @@ end
 
 --- [User] Set AWACS Escorts Template
 -- @param #AWACS self
--- @param #number EscortNumber Number of fighther planes to accompany this AWACS. 0 or nil means no escorts.
+-- @param #number EscortNumber Number of fighther plane GROUPs to accompany this AWACS. 0 or nil means no escorts. If you want >1 plane in an escort group, you can either set the respective squadron grouping to the desired number, or use a template for escorts with >1 unit.
+-- @param #number Formation Formation the escort should take (if more than one plane), e.g. `ENUMS.Formation.FixedWing.FingerFour.Group`. Formation is used on GROUP level, multiple groups of one unit will NOT conform to this formation.
+-- @param #table OffsetVector Offset the escorts should fly behind the AWACS, given as table, distance in meters, e.g. `{x=-500,y=0,z=500}` - 500m behind (negative value) and to the right (negative for left), no vertical separation (positive over, negative under the AWACS flight). For multiple groups, the vectors will be slightly changed to avoid collisions.
+-- @param #number EscortEngageMaxDistance Escorts engage air targets max this NM away, defaults to 45NM.
 -- @return #AWACS self
-function AWACS:SetEscort(EscortNumber)
+function AWACS:SetEscort(EscortNumber,Formation,OffsetVector,EscortEngageMaxDistance)
   self:T(self.lid.."SetEscort")
   if EscortNumber and EscortNumber > 0 then
     self.HasEscorts = true
@@ -2169,6 +2268,9 @@ function AWACS:SetEscort(EscortNumber)
     self.HasEscorts = false
     self.EscortNumber = 0
   end
+  self.EscortFormation = Formation
+  self.OffsetVec = OffsetVector or {x=500,y=100,z=500}
+  self.EscortEngageMaxDistance = EscortEngageMaxDistance or 45
   return self
 end
 
@@ -2223,11 +2325,26 @@ function AWACS:_StartEscorts(Shiftchange)
   local group = AwacsFG:GetGroup()
 
   local timeonstation = (self.EscortsTimeOnStation + self.ShiftChangeTime) * 3600 -- hours to seconds
+  local OffsetX = 500
+  local OffsetY = 500
+  local OffsetZ = 500
+  if self.OffsetVec then
+    OffsetX = self.OffsetVec.x or 500
+    OffsetY = self.OffsetVec.y or 500
+    OffsetZ = self.OffsetVec.z or 500
+  end
+  
   for i=1,self.EscortNumber do
-    -- every 
-    local escort = AUFTRAG:NewESCORT(group, {x= -100*((i + (i%2))/2), y=0, z=(100 + 100*((i + (i%2))/2))*(-1)^i},45,{"Air"})
-    escort:SetRequiredAssets(1)
+    -- every
+    local escort = AUFTRAG:NewESCORT(group, {x= OffsetX*((i + (i%2))/2), y=OffsetY*((i + (i%2))/2), z=(OffsetZ + OffsetZ*((i + (i%2))/2))*(-1)^i},self.EscortEngageMaxDistance,{"Air"})
+    --local escort = AUFTRAG:NewESCORT(group,self.OffsetVec,self.EscortEngageMaxDistance,{"Air"})
+    --escort:SetRequiredAssets(self.EscortNumber)
     escort:SetTime(nil,timeonstation)
+    if self.Escortformation then
+      escort:SetFormation(self.Escortformation)
+    end
+    escort:SetMissionRange(self.MaxMissionRange)
+    
     self.AirWing:AddMission(escort)
     self.CatchAllMissions[#self.CatchAllMissions+1] = escort
 
@@ -2434,7 +2551,7 @@ function AWACS:_GetCallSign(Group,GID, IsPlayer)
   
   local callsign = "Ghost 1"
   if Group and Group:IsAlive() then
-    callsign = Group:GetCustomCallSign(self.callsignshort,self.keepnumber,self.callsignTranslations)
+    callsign = Group:GetCustomCallSign(self.callsignshort,self.keepnumber,self.callsignTranslations,self.callsignCustomFunc,self.callsignCustomArgs)
   end  
   return callsign
 end
@@ -2443,10 +2560,12 @@ end
 -- @param #AWACS self
 -- @param #boolean ShortCallsign If true, only call out the major flight number
 -- @param #boolean Keepnumber If true, keep the **customized callsign** in the #GROUP name as-is, no amendments or numbers.
--- @param #table CallsignTranslations (optional) Table to translate between DCS standard callsigns and bespoke ones. Does not apply if using customized
+-- @param #table CallsignTranslations (Optional) Table to translate between DCS standard callsigns and bespoke ones. Does not apply if using customized.
 -- callsigns from playername or group name.
+-- @param #func CallsignCustomFunc (Optional) For player names only(!). If given, this function will return the callsign. Needs to take the groupname and the playername as first two arguments.
+-- @param #arg ... (Optional) Comma separated arguments to add to the custom function call after groupname and playername.
 -- @return #AWACS self
-function AWACS:SetCallSignOptions(ShortCallsign,Keepnumber,CallsignTranslations)
+function AWACS:SetCallSignOptions(ShortCallsign,Keepnumber,CallsignTranslations,CallsignCustomFunc,...)
   if not ShortCallsign or ShortCallsign == false then
    self.callsignshort = false
   else
@@ -2454,6 +2573,8 @@ function AWACS:SetCallSignOptions(ShortCallsign,Keepnumber,CallsignTranslations)
   end
   self.keepnumber = Keepnumber or false
   self.callsignTranslations = CallsignTranslations
+  self.callsignCustomFunc = CallsignCustomFunc
+  self.callsignCustomArgs = arg or {}
   return self  
 end
 
@@ -3227,12 +3348,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
@@ -3626,7 +3749,7 @@ function AWACS:_CheckIn(Group)
       managedgroup.LastTasking = timer.getTime()
       
       GID = managedgroup.GID
-    self.ManagedGrps[self.ManagedGrpID]=managedgroup
+      self.ManagedGrps[self.ManagedGrpID]=managedgroup
     
     local alphacheckbulls = self:_ToStringBULLS(Group:GetCoordinate())
     local alphacheckbullstts = self:_ToStringBULLS(Group:GetCoordinate(),false,true)
@@ -3893,6 +4016,12 @@ function AWACS:_SetClientMenus()
             checkin = checkin,
           }
           self.clientmenus:Push(menus,cgrpname)
+          -- catch errors - when this entry is built we should NOT have a managed entry
+          local GID,hasentry = self:_GetManagedGrpID(cgrp)
+          if hasentry then
+            -- this user is checked in but has the check in entry ... not good.
+            self:_CheckOut(cgrp,GID,true)
+          end
         end
       end
     else
@@ -4028,10 +4157,14 @@ function AWACS:_CreateAnchorStackFromMarker(Name,Coord)
   if self.debug then
     AnchorStackOne.StationZone:DrawZone(self.coalition,{0,0,1},1,{0,0,1},0.2,5,true)
     local stationtag = string.format("Station: %s\nCoordinate: %s",newname,self.StationZone:GetCoordinate():ToStringLLDDM())
-    AnchorStackOne.AnchorMarker=MARKER:New(AnchorStackOne.StationZone:GetCoordinate(),stationtag):ToCoalition(self.coalition)
+    if self.AllowMarkers then
+      AnchorStackOne.AnchorMarker=MARKER:New(AnchorStackOne.StationZone:GetCoordinate(),stationtag):ToCoalition(self.coalition)
+    end
   else
     local stationtag = string.format("Station: %s\nCoordinate: %s",newname,self.StationZone:GetCoordinate():ToStringLLDDM())
-    AnchorStackOne.AnchorMarker=MARKER:New(AnchorStackOne.StationZone:GetCoordinate(),stationtag):ToCoalition(self.coalition)
+    if self.AllowMarkers then
+      AnchorStackOne.AnchorMarker=MARKER:New(AnchorStackOne.StationZone:GetCoordinate(),stationtag):ToCoalition(self.coalition)
+    end
   end
   
   self.AnchorStacks:Push(AnchorStackOne,newname)
@@ -4074,10 +4207,14 @@ function AWACS:_CreateAnchorStack()
       --self.AnchorStacks:Flush()
       AnchorStackOne.StationZone:DrawZone(self.coalition,{0,0,1},1,{0,0,1},0.2,5,true)
       local stationtag = string.format("Station: %s\nCoordinate: %s",newname,self.StationZone:GetCoordinate():ToStringLLDDM())
-      AnchorStackOne.AnchorMarker=MARKER:New(AnchorStackOne.StationZone:GetCoordinate(),stationtag):ToCoalition(self.coalition)
+      if self.AllowMarkers then
+        AnchorStackOne.AnchorMarker=MARKER:New(AnchorStackOne.StationZone:GetCoordinate(),stationtag):ToCoalition(self.coalition)
+      end
     else
       local stationtag = string.format("Station: %s\nCoordinate: %s",newname,self.StationZone:GetCoordinate():ToStringLLDDM())
-      AnchorStackOne.AnchorMarker=MARKER:New(AnchorStackOne.StationZone:GetCoordinate(),stationtag):ToCoalition(self.coalition)
+      if self.AllowMarkers then
+        AnchorStackOne.AnchorMarker=MARKER:New(AnchorStackOne.StationZone:GetCoordinate(),stationtag):ToCoalition(self.coalition)
+      end
     end
     self.AnchorStacks:Push(AnchorStackOne,newname)
   else
@@ -4101,10 +4238,14 @@ function AWACS:_CreateAnchorStack()
     if self.debug then
       AnchorStackOne.StationZone:DrawZone(self.coalition,{0,0,1},1,{0,0,1},0.2,5,true)
       local stationtag = string.format("Station: %s\nCoordinate: %s",newname,self.StationZone:GetCoordinate():ToStringLLDDM())
-      AnchorStackOne.AnchorMarker=MARKER:New(AnchorStackOne.StationZone:GetCoordinate(),stationtag):ToCoalition(self.coalition)
+      if self.AllowMarkers then
+        AnchorStackOne.AnchorMarker=MARKER:New(AnchorStackOne.StationZone:GetCoordinate(),stationtag):ToCoalition(self.coalition)
+      end
     else
       local stationtag = string.format("Station: %s\nCoordinate: %s",newname,self.StationZone:GetCoordinate():ToStringLLDDM())
-      AnchorStackOne.AnchorMarker=MARKER:New(AnchorStackOne.StationZone:GetCoordinate(),stationtag):ToCoalition(self.coalition)
+      if self.AllowMarkers then
+        AnchorStackOne.AnchorMarker=MARKER:New(AnchorStackOne.StationZone:GetCoordinate(),stationtag):ToCoalition(self.coalition)
+      end
     end
     self.AnchorStacks:Push(AnchorStackOne,newname)
   end
@@ -4244,6 +4385,14 @@ function AWACS:_StartIntel(awacs)
     intel:SetFilterCategory({Unit.Category.AIRPLANE,Unit.Category.HELICOPTER})
   end
   
+  -- Corridors
+  if self.usecorridors == true then
+    intel:SetCorridorZones(self.corridorzones)
+    if self.corridorceiling or self.corridorfloor then
+      intel:SetCorridorLimits(self.corridorfloor,self.corridorceiling)
+    end
+  end
+  
   -- Callbacks
   local function NewCluster(Cluster)
     self:__NewCluster(5,Cluster)
@@ -5036,10 +5185,14 @@ function AWACS:AddCAPAirWing(AirWing,Zone)
           if self.debug then
             AnchorStackOne.StationZone:DrawZone(self.coalition,{0,0,1},1,{0,0,1},0.2,5,true)
             local stationtag = string.format("Station: %s\nCoordinate: %s",newname,self.StationZone:GetCoordinate():ToStringLLDDM())
-            AnchorStackOne.AnchorMarker=MARKER:New(AnchorStackOne.StationZone:GetCoordinate(),stationtag):ToCoalition(self.coalition)
+            if self.AllowMarkers then
+              AnchorStackOne.AnchorMarker=MARKER:New(AnchorStackOne.StationZone:GetCoordinate(),stationtag):ToCoalition(self.coalition)
+            end
           else
             local stationtag = string.format("Station: %s\nCoordinate: %s",newname,self.StationZone:GetCoordinate():ToStringLLDDM())
-            AnchorStackOne.AnchorMarker=MARKER:New(AnchorStackOne.StationZone:GetCoordinate(),stationtag):ToCoalition(self.coalition)
+            if self.AllowMarkers then
+              AnchorStackOne.AnchorMarker=MARKER:New(AnchorStackOne.StationZone:GetCoordinate(),stationtag):ToCoalition(self.coalition)
+            end
           end
           self.AnchorStacks:Push(AnchorStackOne,newname)
           AirWing.HasOwnStation = true
@@ -5739,7 +5892,7 @@ function AWACS:_AssignPilotToTarget(Pilots,Targets)
     local intercept = AUFTRAG:NewINTERCEPT(Target.Target)
     intercept:SetWeaponExpend(AI.Task.WeaponExpend.ALL)
     intercept:SetWeaponType(ENUMS.WeaponFlag.Auto)
-    
+    intercept:SetMissionRange(self.MaxMissionRange)
     -- TODO 
     -- now this is going to be interesting...
     -- Check if the target left the "hot" area or is dead already
@@ -5787,6 +5940,7 @@ function AWACS:_AssignPilotToTarget(Pilots,Targets)
     AnchorSpeed = UTILS.KnotsToAltKIAS(AnchorSpeed,Angels)
     local Anchor = self.AnchorStacks:ReadByPointer(Pilot.AnchorStackNo) -- #AWACS.AnchorData
     local capauftrag = AUFTRAG:NewCAP(Anchor.StationZone,Angels,AnchorSpeed,Anchor.StationZoneCoordinate,0,15,{})
+    capauftrag:SetMissionRange(self.MaxMissionRange)
     capauftrag:SetTime(nil,((self.CAPTimeOnStation*3600)+(15*60)))
     Pilot.FlightGroup:AddMission(capauftrag) 
     
@@ -5881,29 +6035,43 @@ function AWACS:onafterStart(From, Event, To)
     self.OpsZone:DrawZone(self.coalition,{1,0,0},1,{1,0,0},0.2,5,true)
     local AOCoordString = self.AOCoordinate:ToStringLLDDM()
     local Rocktag = string.format("FEZ: %s\nBulls Coordinate: %s",self.AOName,AOCoordString)
-    MARKER:New(self.AOCoordinate,Rocktag):ToCoalition(self.coalition)
+    if self.AllowMarkers then
+      MARKER:New(self.AOCoordinate,Rocktag):ToCoalition(self.coalition)
+    end
     self.StationZone:DrawZone(self.coalition,{0,0,1},1,{0,0,1},0.2,5,true)
     local stationtag = string.format("Station: %s\nCoordinate: %s",self.StationZoneName,self.StationZone:GetCoordinate():ToStringLLDDM())
     if not self.GCI then
-      MARKER:New(self.StationZone:GetCoordinate(),stationtag):ToCoalition(self.coalition)
+      if self.AllowMarkers then
+        MARKER:New(self.StationZone:GetCoordinate(),stationtag):ToCoalition(self.coalition)
+      end
       self.OrbitZone:DrawZone(self.coalition,{0,1,0},1,{0,1,0},0.2,5,true)
-      MARKER:New(self.OrbitZone:GetCoordinate(),"AIC Orbit Zone"):ToCoalition(self.coalition)
+      if self.AllowMarkers then
+        MARKER:New(self.OrbitZone:GetCoordinate(),"AIC Orbit Zone"):ToCoalition(self.coalition)
+      end
     end
   else
     local AOCoordString = self.AOCoordinate:ToStringLLDDM()
     local Rocktag = string.format("FEZ: %s\nBulls Coordinate: %s",self.AOName,AOCoordString)
-    MARKER:New(self.AOCoordinate,Rocktag):ToCoalition(self.coalition)
+    if self.AllowMarkers then
+      MARKER:New(self.AOCoordinate,Rocktag):ToCoalition(self.coalition)
+    end
     if not self.GCI then
-      MARKER:New(self.OrbitZone:GetCoordinate(),"AIC Orbit Zone"):ToCoalition(self.coalition)
+      if self.AllowMarkers then
+        MARKER:New(self.OrbitZone:GetCoordinate(),"AIC Orbit Zone"):ToCoalition(self.coalition)
+      end
     end
     local stationtag = string.format("Station: %s\nCoordinate: %s",self.StationZoneName,self.StationZone:GetCoordinate():ToStringLLDDM())
-    MARKER:New(self.StationZone:GetCoordinate(),stationtag):ToCoalition(self.coalition)
+    if self.AllowMarkers then
+      MARKER:New(self.StationZone:GetCoordinate(),stationtag):ToCoalition(self.coalition)
+    end
   end
   
   if not self.GCI then
     -- set up the AWACS and let it orbit
     local AwacsAW = self.AirWing -- Ops.Airwing#AIRWING
     local mission = AUFTRAG:NewORBIT_RACETRACK(self.OrbitZone:GetCoordinate(),self.AwacsAngels*1000,self.Speed,self.Heading,self.Leg)
+    mission:SetMissionRange(self.MaxMissionRange)
+    mission:SetRequiredAttribute({ GROUP.Attribute.AIR_AWACS }) -- prefered plane type, thanks to Heart8reaker
     local timeonstation = (self.AwacsTimeOnStation + self.ShiftChangeTime) * 3600
     mission:SetTime(nil,timeonstation)
     self.CatchAllMissions[#self.CatchAllMissions+1] = mission
@@ -6046,6 +6214,7 @@ function AWACS:_CheckAwacsStatus()
       end
     end 
   end
+  
   --------------------------------
   --     AWACS
   --------------------------------
@@ -6194,12 +6363,13 @@ function AWACS:_CheckAwacsStatus()
         
         report:Add("====================")
         
+        local RESMission
         -- Check for replacement mission - if any
         if self.ShiftChangeEscortsFlag and self.ShiftChangeEscortsRequested then -- Ops.Auftrag#AUFTRAG
-          ESmission = self.EscortMissionReplacement[i]
-          local esstatus = ESmission:GetState()
-          local ESmissiontime = (timer.getTime() - self.EscortsTimeStamp)
-          local ESTOSLeft = UTILS.Round((((self.EscortsTimeOnStation+self.ShiftChangeTime)*3600) - ESmissiontime),0) -- seconds
+          RESMission = self.EscortMissionReplacement[i]
+          local esstatus = RESMission:GetState()
+          local RESMissiontime = (timer.getTime() - self.EscortsTimeStamp)
+          local ESTOSLeft = UTILS.Round((((self.EscortsTimeOnStation+self.ShiftChangeTime)*3600) - RESMissiontime),0) -- seconds
           ESTOSLeft = UTILS.Round(ESTOSLeft/60,0) -- minutes
           local ChangeTime = UTILS.Round(((self.ShiftChangeTime * 3600)/60),0)
 
@@ -6207,7 +6377,7 @@ function AWACS:_CheckAwacsStatus()
           report:Add(string.format("Auftrag Status: %s",esstatus))
           report:Add(string.format("TOS Left: %d min",ESTOSLeft))
           
-          local OpsGroups = ESmission:GetOpsGroups()
+          local OpsGroups = RESMission:GetOpsGroups()
           local OpsGroup = self:_GetAliveOpsGroupFromTable(OpsGroups) -- Ops.OpsGroup#OPSGROUP
           if OpsGroup then
             local OpsName = OpsGroup:GetName() or "Unknown"
@@ -6219,13 +6389,13 @@ function AWACS:_CheckAwacsStatus()
             report:Add("***** Cannot obtain (yet) this missions OpsGroup!")
           end
           
-          if ESmission:IsExecuting() then
+          if RESMission and RESMission:IsExecuting() then
             -- make the actual change in the queue
             self.ShiftChangeEscortsFlag = false
             self.ShiftChangeEscortsRequested = false
             -- cancel old mission
             if ESmission and ESmission:IsNotOver() then
-              ESmission:Cancel()
+              ESmission:__Cancel(1)
             end
             self.EscortMission[i] = self.EscortMissionReplacement[i]
               self.EscortMissionReplacement[i] = nil
@@ -6477,6 +6647,7 @@ function AWACS:onafterAssignedAnchor(From, Event, To, GID, Anchor, AnchorStackNo
       if auftragtype == AUFTRAG.Type.ALERT5 then
         -- all correct
         local capauftrag = AUFTRAG:NewCAP(Anchor.StationZone,Angels*1000,AnchorSpeed,Anchor.StationZone:GetCoordinate(),0,15,{})
+        capauftrag:SetMissionRange(self.MaxMissionRange)
         capauftrag:SetTime(nil,((self.CAPTimeOnStation*3600)+(15*60)))
         capauftrag:AddAsset(managedgroup.FlightGroup)
         self.CatchAllMissions[#self.CatchAllMissions+1] = capauftrag
@@ -6840,7 +7011,8 @@ function AWACS:onafterAwacsShiftChange(From,Event,To)
     self.CatchAllMissions[#self.CatchAllMissions+1] = mission
     local timeonstation = (self.AwacsTimeOnStation + self.ShiftChangeTime) * 3600
     mission:SetTime(nil,timeonstation)
-  
+    mission:SetMissionRange(self.MaxMissionRange)
+    
     AwacsAW:AddMission(mission)
     
     self.AwacsMissionReplacement = mission

Moose Development/Moose/Ops/Brigade.lua

@@ -599,7 +599,80 @@ 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    
+  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