Static 2.2.6

Ff/release 2.2.5

.appveyor/appveyor.yml

@@ -1,85 +0,0 @@
-version: 2.4.a.{build}
-shallow_clone: true
-skip_branch_with_pr: false
-skip_commits:
-  message: /!nobuild/
-skip_tags: false
-
-environment:
-  access_token_documentation:
-    secure: JVBVVL8uJUcLXN+48eRdELEeCGOGCCaMzCqutsUqNuaZ/KblG5ZTt7+LV4UKv/0f
-  LUAROCKS_VER: 2.4.1
-  LUA_VER: 5.1.5
-  LUA: lua5.3
-  matrix:
-  - LUA_VER: 5.1.5
-
-platform:
-  - x64
-
-
-init:
-  - ps: if ($env:APPVEYOR_PULL_REQUEST_NUMBER -and $env:APPVEYOR_BUILD_NUMBER -ne ((Invoke-RestMethod `
-        https://ci.appveyor.com/api/projects/$env:APPVEYOR_ACCOUNT_NAME/$env:APPVEYOR_PROJECT_SLUG/history?recordsNumber=50).builds | `
-        Where-Object pullRequestId -eq $env:APPVEYOR_PULL_REQUEST_NUMBER)[0].buildNumber) { `
-        throw "There are newer queued builds for this pull request, failing early." }
-#  - ps: iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/appveyor/ci/master/scripts/enable-rdp.ps1'))
- 
-install:
-# Outcomment if lua environment invalidates and needs to be reinstalled, otherwise all will run from the cache.
-#  - call choco install 7zip.commandline
-#  - call choco install lua51
-#  - call choco install luarocks
-#  - call refreshenv
-#  - call "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat"
-#  - cmd: PATH = %PATH%;C:\ProgramData\chocolatey\lib\luarocks\luarocks-2.4.3-win32\systree\bin
-#  - cmd: set LUA_PATH = %LUA_PATH%;C:\ProgramData\chocolatey\lib\luarocks\luarocks-2.4.3-win32\systree\share\lua\5.1\?.lua;C:\ProgramData\chocolatey\lib\luarocks\luarocks-2.4.3-win32\systree\share\lua\5.1\?\init.lua
-#  - cmd: set LUA_CPATH = %LUA_CPATH%;C:\ProgramData\chocolatey\lib\luarocks\luarocks-2.4.3-win32\systree\lib\lua\5.1\?.dll 
-#  - call luarocks install luasrcdiet
-#  - call luarocks install checks
-#  - call luarocks install luadocumentor
-#  - call luarocks install luacheck
-
-
-#cache:
-#  - C:\ProgramData\chocolatey\lib
-#  - C:\ProgramData\chocolatey\bin
-  
-
-
-build_script:
-   - ps: | 
-       if( $env:appveyor_repo_branch -eq 'master' -or $env:appveyor_repo_branch -eq 'develop' )     
-       {
-         $apiUrl = 'https://ci.appveyor.com/api'
-         $token = 'qts80b5kpq0ooj4x6vvw'
-         $headers = @{
-           "Authorization" = "Bearer $token"
-           "Content-type" = "application/json"
-           }
-         $RequestBody = @{ accountName = 'FlightControl-Master'; projectSlug = 'moose-include'; branch = "$env:appveyor_repo_branch"; environmentVariables = @{} } | ConvertTo-Json
-         # Generate the new version ...
-         $project = Invoke-RestMethod -method Post -Uri "$apiUrl/builds" -Headers $headers -Body $RequestBody
-       }
-   - ps: | 
-       if( $env:appveyor_repo_branch -eq 'master' -or $env:appveyor_repo_branch -eq 'develop' )     
-       {
-         $apiUrl = 'https://ci.appveyor.com/api'
-         $token = 'qts80b5kpq0ooj4x6vvw'
-         $headers = @{
-           "Authorization" = "Bearer $token"
-           "Content-type" = "application/json"
-           }
-         $RequestBody = @{ accountName = 'FlightControl-Master'; projectSlug = 'moose-docs'; branch = "$env:appveyor_repo_branch"; environmentVariables = @{} } | ConvertTo-Json
-         # get project with last build details
-         $project = Invoke-RestMethod -method Post -Uri "$apiUrl/builds" -Headers $headers -Body $RequestBody
-       }
-
-
-test: off
-# test_script:
-#   - cmd: luacheck "Moose Development\Moose\moose.lua" "Moose Mission Setup\moose.lua"
-
-
-on_finish:
-#  - ps: $blockRdp = $true; iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/appveyor/ci/master/scripts/enable-rdp.ps1'))

.gitmodules

@@ -0,0 +1,4 @@
+[submodule "Moose Development/Moose/Dcs"]
+	path = Moose Development/Moose/Dcs
+	url = https://github.com/FlightControl-Master/DCS-API.git
+	branch = master

DCS_Folder_Sync.bat

@@ -0,0 +1,4 @@
+rem This script will pull the latest changes from the remote repository, and update the submodules accordingly.
+
+C:\Program Files (x86)\Git\bin\git pull
+C:\Program Files (x86)\Git\bin\git submodule update --init

Moose Development/Debugger/MissionScripting.lua

@@ -1,37 +0,0 @@
---Initialization script for the Mission lua Environment (SSE)
-
-dofile('Scripts/ScriptingSystem.lua')
-
--- Add LuaSocket to the LUAPATH, so that it can be found.
-package.path  = package.path..";.\\LuaSocket\\?.lua;"
-
--- Connect to the debugger, first require it.
-local initconnection = require("debugger")
-
--- Now make the connection..
--- "127.0.0.1" is the localhost.
--- 10000 is the port. If you wanna use another port in LDT, change this number too!
--- "dcsserver" is the name of the server. If you wanna use another name, change the name here too!
--- nil (is for transport protocol, but not using this)
--- "win" don't touch. But is important to indicate that we are in a windows environment to the debugger script. 
-initconnection( "127.0.0.1", 10000, "dcsserver", nil, "win", "" )
-
-
---Sanitize Mission Scripting environment
---This makes unavailable some unsecure functions. 
---Mission downloaded from server to client may contain potentialy harmful lua code that may use these functions.
---You can remove the code below and make availble these functions at your own risk.
-
-local function sanitizeModule(name)
-	_G[name] = nil
-	package.loaded[name] = nil
-end
-
-
-do
-	sanitizeModule('os')
-	--sanitizeModule('io')
-	sanitizeModule('lfs')
-	require = nil
-	loadlib = nil
-end

Moose Development/Debugger/READ.ME

@@ -1,56 +0,0 @@
-
--- If you want to use the debugger, add 3 lines of extra code into MissionScripting.lua of DCS world.
--- De-sanitize the io module. The debugger needs it.
-
-
----------------------------------------------------------------------------------------------------------------------------
--- MissionScripting.lua modifications
----------------------------------------------------------------------------------------------------------------------------
-
---    --Initialization script for the Mission lua Environment (SSE)
---
---    dofile('Scripts/ScriptingSystem.lua')
---
---    package.path  = package.path..";.\\LuaSocket\\?.lua;"
---    local initconnection = require("debugger")
---    initconnection( "127.0.0.1", 10000, "dcsserver", nil, "win", "" )
---    
---    --Sanitize Mission Scripting environment
---    --This makes unavailable some unsecure functions. 
---    --Mission downloaded from server to client may contain potentialy harmful lua code that may use these functions.
---    --You can remove the code below and make availble these functions at your own risk.
---    
---    local function sanitizeModule(name)
---      _G[name] = nil
---      package.loaded[name] = nil
---    end
---    
---    do
---      sanitizeModule('os')
---      --sanitizeModule('io')
---      sanitizeModule('lfs')
---      require = nil
---      loadlib = nil
---    end
-
----------------------------------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------------------------------------
-
-
-
--- So for clarity, these are the three lines of code that matter!
-
--- Add LuaSocket to the LUAPATH, so that it can be found.
-package.path  = package.path..";.\\LuaSocket\\?.lua;"
-
--- Connect to the debugger, first require it.
-local initconnection = require("debugger")
-
--- Now make the connection..
--- "127.0.0.1" is the localhost.
--- 10000 is the port. If you wanna use another port in LDT, change this number too!
--- "dcsserver" is the name of the server. Ensure the same name is used at the Debug Configuration panel!
--- nil (is for transport protocol, but not using this)
--- "win" don't touch. But is important to indicate that we are in a windows environment to the debugger script. 
-initconnection( "127.0.0.1", 10000, "dcsserver", nil, "win", "" )
-

Moose Development/LDT External Tools/Moose DOCUMENTATION Generate.launch

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<launchConfiguration type="org.eclipse.ui.externaltools.ProgramLaunchConfigurationType">
+<listAttribute key="org.eclipse.debug.ui.favoriteGroups">
+<listEntry value="org.eclipse.ui.externaltools.launchGroup"/>
+</listAttribute>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:/Moose_Framework/Utils/GenerateDocumentations.bat}"/>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_TOOL_ARGUMENTS" value="*.lua"/>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_WORKING_DIRECTORY" value="${workspace_loc:/Moose_Framework/Utils}"/>
+</launchConfiguration>

Moose Development/LDT External Tools/Moose LOADER Generate Dynamic Moose.lua.launch

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<launchConfiguration type="org.eclipse.ui.externaltools.ProgramLaunchConfigurationType">
+<listAttribute key="org.eclipse.debug.ui.favoriteGroups">
+<listEntry value="org.eclipse.ui.externaltools.launchGroup"/>
+</listAttribute>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:/Moose_Framework/Utils/Generate_Moose.bat}"/>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_TOOL_ARGUMENTS" value="&quot;Moose_Create.lua&quot; &#13;&#10;&quot;D&quot;&#13;&#10;&quot;${current_date}&quot; &#13;&#10;&quot;${workspace_loc:/Moose_Framework//Moose Development/Moose}&quot; &#13;&#10;&quot;${workspace_loc:/Moose_Framework/Moose Mission Setup}&quot;"/>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_WORKING_DIRECTORY" value="${workspace_loc:/Moose_Framework/Moose Mission Setup}"/>
+</launchConfiguration>

Moose Development/LDT External Tools/Moose LOADER Generate Static Moose.lua.launch

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<launchConfiguration type="org.eclipse.ui.externaltools.ProgramLaunchConfigurationType">
+<listAttribute key="org.eclipse.debug.ui.favoriteGroups">
+<listEntry value="org.eclipse.ui.externaltools.launchGroup"/>
+</listAttribute>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:/Moose_Framework/Utils/Generate_Moose.bat}"/>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_TOOL_ARGUMENTS" value="&quot;Moose_Create.lua&quot; &#13;&#10;&quot;S&quot;&#13;&#10;&quot;${current_date}&quot; &#13;&#10;&quot;${workspace_loc:/Moose_Framework//Moose Development/Moose}&quot; &#13;&#10;&quot;${workspace_loc:/Moose_Framework/Moose Mission Setup}&quot;"/>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_WORKING_DIRECTORY" value="${workspace_loc:/Moose_Framework/Moose Mission Setup}"/>
+</launchConfiguration>

Moose Development/LDT External Tools/Moose UPDATE ALL MOOSE Demonstration Missions.launch

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<launchConfiguration type="org.eclipse.ui.externaltools.ProgramLaunchConfigurationType">
+<listAttribute key="org.eclipse.debug.ui.favoriteGroups">
+<listEntry value="org.eclipse.ui.externaltools.launchGroup"/>
+</listAttribute>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:/Moose_Framework/Moose Mission Setup/Moose Mission Update/Moose_Update_Missions.bat}"/>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_WORKING_DIRECTORY" value="${workspace_loc:/Moose_Missions}"/>
+</launchConfiguration>

Moose Development/LDT External Tools/Moose UPDATE SELECTED Missions.launch

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<launchConfiguration type="org.eclipse.ui.externaltools.ProgramLaunchConfigurationType">
+<listAttribute key="org.eclipse.debug.ui.favoriteGroups">
+<listEntry value="org.eclipse.ui.externaltools.launchGroup"/>
+</listAttribute>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_LOCATION" value="${workspace_loc:/Moose_Framework/Moose Mission Setup/Moose Mission Update/Moose_Update_Missions.bat}"/>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_TOOL_ARGUMENTS" value="&quot;${selected_resource_loc}&quot;"/>
+<stringAttribute key="org.eclipse.ui.externaltools.ATTR_WORKING_DIRECTORY" value="${workspace_loc:/Moose_Framework/Moose Mission Setup/Moose Mission Update}"/>
+</launchConfiguration>

Moose Development/Moose/AI/AI_A2A.lua

@@ -1,13 +1,16 @@
---- **AI** -- (R2.2) - Models the process of air operations for airplanes.
+--- **AI** -- **AI A2A Air Patrolling or Staging.**
 -- 
--- ===
+-- ====
 -- 
--- ### Author: **FlightControl**
+-- ### Author: **Sven Van de Velde (FlightControl)**
+-- ### Contributions: 
 -- 
--- ===
+--   * **[Dutch_Baron](https://forums.eagle.ru/member.php?u=112075)**: 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](https://forums.eagle.ru/member.php?u=62835)**: Testing and API concept review.
 -- 
--- @module AI.AI_A2A
--- @image AI_Air_To_Air_Dispatching.JPG
+-- ====
+-- 
+-- @module AI_A2A
 
 --BASE:TraceClass("AI_A2A")
 
@@ -15,7 +18,9 @@
 --- @type AI_A2A
 -- @extends Core.Fsm#FSM_CONTROLLABLE
 
---- The AI_A2A class implements the core functions to operate an AI @{Wrapper.Group} A2A tasking.
+--- # AI_A2A class, extends @{Fsm#FSM_CONTROLLABLE}
+-- 
+-- The AI_A2A class implements the core functions to operate an AI @{Group} A2A tasking.
 -- 
 -- 
 -- ## AI_A2A constructor
@@ -292,8 +297,8 @@ end
 
 --- Sets (modifies) the minimum and maximum speed of the patrol.
 -- @param #AI_A2A 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.
+-- @param Dcs.DCSTypes#Speed  PatrolMinSpeed The minimum speed of the @{Controllable} in km/h.
+-- @param Dcs.DCSTypes#Speed  PatrolMaxSpeed The maximum speed of the @{Controllable} in km/h.
 -- @return #AI_A2A self
 function AI_A2A:SetSpeed( PatrolMinSpeed, PatrolMaxSpeed )
   self:F2( { PatrolMinSpeed, PatrolMaxSpeed } )
@@ -305,8 +310,8 @@ end
 
 --- Sets the floor and ceiling altitude of the patrol.
 -- @param #AI_A2A 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.
+-- @param Dcs.DCSTypes#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
+-- @param Dcs.DCSTypes#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
 -- @return #AI_A2A self
 function AI_A2A:SetAltitude( PatrolFloorAltitude, PatrolCeilingAltitude )
   self:F2( { PatrolFloorAltitude, PatrolCeilingAltitude } )
@@ -367,6 +372,7 @@ end
 -- @return #AI_A2A self
 function AI_A2A:SetFuelThreshold( PatrolFuelThresholdPercentage, PatrolOutOfFuelOrbitTime )
 
+  self.PatrolManageFuel = true
   self.PatrolFuelThresholdPercentage = PatrolFuelThresholdPercentage
   self.PatrolOutOfFuelOrbitTime = PatrolOutOfFuelOrbitTime
   
@@ -400,6 +406,7 @@ end
 -- @param #string Event The Event string.
 -- @param #string To The To State string.
 function AI_A2A:onafterStart( Controllable, From, Event, To )
+  self:F2()
 
   self:__Status( 10 ) -- Check status status every 30 seconds.
   
@@ -422,6 +429,8 @@ end
 --- @param #AI_A2A self
 function AI_A2A:onafterStatus()
 
+  self:F( " Checking Status" )
+
   if self.Controllable and self.Controllable:IsAlive() then
   
     local RTB = false
@@ -448,8 +457,8 @@ function AI_A2A:onafterStatus()
     
 
     if not self:Is( "Fuel" ) and not self:Is( "Home" ) then
-      local Fuel = self.Controllable:GetFuelMin()
-      self:F({Fuel=Fuel, PatrolFuelThresholdPercentage=self.PatrolFuelThresholdPercentage})
+      local Fuel = self.Controllable:GetFuel()
+      self:F({Fuel=Fuel})
       if Fuel < self.PatrolFuelThresholdPercentage then
         if self.TankerName then
           self:E( self.Controllable:GetName() .. " is out of fuel: " .. Fuel .. " ... Refuelling at Tanker!" )

Moose Development/Moose/AI/AI_A2A_Cap.lua

@@ -1,24 +1,45 @@
---- **AI** -- (R2.2) - Models the process of Combat Air Patrol (CAP) for airplanes.
+--- **AI** -- **Execute Combat Air Patrol (CAP).**
 --
+-- ![Banner Image](..\Presentations\AI_CAP\Dia1.JPG)
+-- 
 -- ===
 -- 
--- ### Author: **FlightControl**
+-- AI CAP classes makes AI Groups execute a Combat Air Patrol.
 -- 
--- ===       
+-- There are the following types of CAP classes defined:
+-- 
+--   * @{#AI_A2A_CAP}: Perform a CAP in a zone.
+--   
+-- ====
+-- 
+-- ### Author: **Sven Van de Velde (FlightControl)**
+-- 
+-- ### Contributions: 
 --
--- @module AI.AI_A2A_Cap
--- @image AI_Combat_Air_Patrol.JPG
+--   * **[Quax](https://forums.eagle.ru/member.php?u=90530)**: Concept, Advice & Testing.
+--   * **[Pikey](https://forums.eagle.ru/member.php?u=62835)**: Concept, Advice & Testing.
+--   * **[Gunterlund](http://forums.eagle.ru:8080/member.php?u=75036)**: Test case revision.
+--   * **[Whisper](http://forums.eagle.ru/member.php?u=3829): Testing.
+--   * **[Delta99](https://forums.eagle.ru/member.php?u=125166): Testing. 
+-- 
+-- ====       
+--
+-- @module AI_A2A_Cap
+
+--BASE:TraceClass("AI_A2A_CAP")
 
 --- @type AI_A2A_CAP
 -- @extends AI.AI_A2A_Patrol#AI_A2A_PATROL
 
 
---- The AI_A2A_CAP class implements the core functions to patrol a @{Zone} by an AI @{Wrapper.Group} or @{Wrapper.Group} 
+--- # AI_A2A_CAP class, extends @{AI_CAP#AI_PATROL_ZONE}
+-- 
+-- The AI_A2A_CAP class implements the core functions to patrol a @{Zone} by an AI @{Group} or @{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.
+-- The AI_A2A_CAP is assigned a @{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)
 -- 
@@ -61,15 +82,15 @@
 -- 
 -- ### 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_Patrol#AI_PATROL_ZONE.Start}**: Start the process.
+--   * **@{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.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.RTB}**: Route the AI to the home base.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.Detect}**: The AI is detecting targets.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.Detected}**: The AI has detected new targets.
+--   * **@{#AI_A2A_CAP.Destroy}**: The AI has destroyed a bogey @{Unit}.
+--   * **@{#AI_A2A_CAP.Destroyed}**: The AI has destroyed all bogeys @{Unit}s assigned in the CAS task.
 --   * **Status** ( Group ): The AI is checking status (fuel and damage). When the tresholds have been reached, the AI will RTB.
 --
 -- ## 3. Set the Range of Engagement
@@ -80,7 +101,7 @@
 -- that will define when the AI will engage with the detected airborne enemy targets.
 -- The range can be beyond or smaller than the range of the Patrol Zone.
 -- The range is applied at the position of the AI.
--- Use the method @{AI.AI_CAP#AI_A2A_CAP.SetEngageRange}() to define that range.
+-- Use the method @{AI_CAP#AI_A2A_CAP.SetEngageRange}() to define that range.
 --
 -- ## 4. Set the Zone of Engagement
 -- 
@@ -88,7 +109,7 @@
 -- 
 -- An optional @{Zone} can be set, 
 -- that will define when the AI will engage with the detected airborne enemy targets.
--- Use the method @{AI.AI_Cap#AI_A2A_CAP.SetEngageZone}() to define that Zone.
+-- Use the method @{AI_Cap#AI_A2A_CAP.SetEngageZone}() to define that Zone.
 --  
 -- ===
 -- 
@@ -101,13 +122,13 @@ AI_A2A_CAP = {
 -- @param #AI_A2A_CAP self
 -- @param Wrapper.Group#GROUP AICap
 -- @param Core.Zone#ZONE_BASE PatrolZone The @{Zone} where the patrol needs to be executed.
--- @param DCS#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
--- @param DCS#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
--- @param DCS#Speed  PatrolMinSpeed The minimum speed of the @{Wrapper.Group} in km/h.
--- @param DCS#Speed  PatrolMaxSpeed The maximum speed of the @{Wrapper.Group} in km/h.
--- @param DCS#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
+-- @param Dcs.DCSTypes#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
+-- @param Dcs.DCSTypes#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
+-- @param Dcs.DCSTypes#Speed  PatrolMinSpeed The minimum speed of the @{Group} in km/h.
+-- @param Dcs.DCSTypes#Speed  PatrolMaxSpeed The maximum speed of the @{Group} in km/h.
+-- @param Dcs.DCSTypes#Speed  EngageMinSpeed The minimum speed of the @{Group} in km/h when engaging a target.
+-- @param Dcs.DCSTypes#Speed  EngageMaxSpeed The maximum speed of the @{Group} in km/h when engaging a target.
+-- @param Dcs.DCSTypes#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 )
 
@@ -282,14 +303,13 @@ function AI_A2A_CAP:New( AICap, PatrolZone, PatrolFloorAltitude, PatrolCeilingAl
 end
 
 --- onafter State Transition for Event Patrol.
--- @param #AI_A2A_CAP self
+-- @param #AI_A2A_GCI 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 ).onafterStart( self, AICap, From, Event, To )
   AICap:HandleEvent( EVENTS.Takeoff, nil, self )
 
 end

Moose Development/Moose/AI/AI_A2A_Dispatcher.lua

@@ -1,24 +1,9 @@
---- **AI** - (R2.2) - Manages the process of an automatic A2A defense system based on an EWR network targets and coordinating CAP and GCI.
--- 
--- 
--- Features:
--- 
---    * Setup quickly an A2A defense system for a coalition.
---    * Setup (CAP) Control Air Patrols at defined zones to enhance your A2A defenses.
---    * Setup (GCI) Ground Control Intercept at defined airbases to enhance your A2A defenses.
---    * Define and use an EWR (Early Warning Radar) network.
---    * Define squadrons at airbases.
---    * Enable airbases for A2A defenses.
---    * Add different plane types to different squadrons.
---    * Add multiple squadrons to different airbases.
---    * Define different ranges to engage upon intruders.
---    * Establish an automatic in air refuel process for CAP using refuel tankers.
---    * Setup default settings for all squadrons and A2A defenses.
---    * Setup specific settings for specific squadrons.
---    * Quickly setup an A2A defense system using @{#AI_A2A_GCICAP}.
---    * Setup a more advanced defense system using @{#AI_A2A_DISPATCHER}.
+--- **AI** - The AI_A2A_DISPATCHER creates an automatic A2A defense system based on an EWR network targets and coordinating CAP and GCI.
 -- 
+-- ![Banner Image](..\Presentations\AI_A2A_DISPATCHER\Dia1.JPG)
 -- 
+-- ====
+--
 -- # QUICK START GUIDE
 -- 
 -- There are basically two classes available to model an A2A defense system.
@@ -165,11 +150,10 @@
 -- 
 -- ===
 -- 
--- ### Authors: **FlightControl** rework of GCICAP + introduction of new concepts (squadrons).
+-- ### Authors: **Sven Van de Velde (FlightControl)** rework of GCICAP + introduction of new concepts (squadrons).
 -- ### Authors: **Stonehouse**, **SNAFU** in terms of the advice, documentation, and the original GCICAP script.
 -- 
--- @module AI.AI_A2A_Dispatcher
--- @image AI_Air_To_Air_Dispatching.JPG
+-- @module AI_A2A_Dispatcher
 
 
 
@@ -179,15 +163,19 @@ do -- AI_A2A_DISPATCHER
   -- @type AI_A2A_DISPATCHER
   -- @extends Tasking.DetectionManager#DETECTION_MANAGER
 
-  --- Create an automatic air defence system for a coalition. 
+  --- # AI\_A2A\_DISPATCHER class, extends @{Tasking#DETECTION_MANAGER}
   -- 
-  -- ===
+  -- ![Banner Image](..\Presentations\AI_A2A_DISPATCHER\Dia1.JPG)
+  -- 
+  -- The @{#AI_A2A_DISPATCHER} class is designed to create an automatic air defence system for a coalition. 
+  -- 
+  -- ====
   -- 
   -- # Demo Missions
   -- 
   -- ### [AI\_A2A\_DISPATCHER Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/release-2-2-pre/AID%20-%20AI%20Dispatching)
   -- 
-  -- ===
+  -- ====
   -- 
   -- # YouTube Channel
   -- 
@@ -239,7 +227,7 @@ do -- AI_A2A_DISPATCHER
   -- therefore less CAP and GCI flights will spawn and this will tend to make just the border area active rather than a melee over the whole map. 
   -- It all depends on what the desired effect is. 
   -- 
-  -- EWR networks are **dynamically constructed**, that is, they form part of the @{Functional.Detection#DETECTION_BASE} object that is given as the input parameter of the AI\_A2A\_DISPATCHER class.
+  -- EWR networks are **dynamically constructed**, that is, they form part of the @{Functional#DETECTION_BASE} object that is given as the input parameter of the AI\_A2A\_DISPATCHER class.
   -- By defining in a **smart way the names or name prefixes of the groups** with EWR capable units, these groups will be **automatically added or deleted** from the EWR network, 
   -- increasing or decreasing the radar coverage of the Early Warning System.
   -- 
@@ -356,7 +344,7 @@ do -- AI_A2A_DISPATCHER
   -- 
   -- ![Banner Image](..\Presentations\AI_A2A_DISPATCHER\Dia9.JPG)
   -- 
-  -- If it's a cold war then the **borders of red and blue territory** need to be defined using a @{zone} object derived from @{Core.Zone#ZONE_BASE}.
+  -- If it’s a cold war then the **borders of red and blue territory** need to be defined using a @{zone} object derived from @{Zone#ZONE_BASE}.
   -- If a hot war is chosen then **no borders** actually need to be defined using the helicopter units other than 
   -- it makes it easier sometimes for the mission maker to envisage where the red and blue territories roughly are. 
   -- In a hot war the borders are effectively defined by the ground based radar coverage of a coalition.
@@ -554,18 +542,18 @@ do -- AI_A2A_DISPATCHER
   --   * As the CAP flights wander around within the zone waiting to be tasked, these zones need to be large enough that the aircraft are not constantly turning 
   --   but do not have to be big and numerous enough to completely cover a border.
   --   
-  --   * CAP zones can be of any type, and are derived from the @{Core.Zone#ZONE_BASE} class. Zones can be @{Core.Zone#ZONE}, @{Core.Zone#ZONE_POLYGON}, @{Core.Zone#ZONE_UNIT}, @{Core.Zone#ZONE_GROUP}, etc.
+  --   * CAP zones can be of any type, and are derived from the @{Zone#ZONE_BASE} class. Zones can be @{Zone#ZONE}, @{Zone#ZONE_POLYGON}, @{Zone#ZONE_UNIT}, @{Zone#ZONE_GROUP}, etc.
   --   This allows to setup **static, moving and/or complex zones** wherein aircraft will perform the CAP.
   --   
-  --   * Typically 20000-50000 metres width is used and they are spaced so that aircraft in the zone waiting for tasks don't have to far to travel to protect their coalitions important targets. 
+  --   * Typically 20000-50000 metres width is used and they are spaced so that aircraft in the zone waiting for tasks don’t have to far to travel to protect their coalitions important targets. 
   --   These targets are chosen as part of the mission design and might be an important airfield or town etc. 
   --   Zone size is also determined somewhat by territory size, plane types 
   --   (eg WW2 aircraft might mean smaller zones or more zones because they are slower and take longer to intercept enemy aircraft).
   --   
-  --   * In a **cold war** it is important to make sure a CAP zone doesn't intrude into enemy territory as otherwise CAP flights will likely cross borders 
+  --   * In a **cold war** it is important to make sure a CAP zone doesn’t intrude into enemy territory as otherwise CAP flights will likely cross borders 
   --   and spark a full scale conflict which will escalate rapidly.
   --   
-  --   * CAP flights do not need to be in the CAP zone before they are "on station" and ready for tasking. 
+  --   * CAP flights do not need to be in the CAP zone before they are “on station” and ready for tasking. 
   --   
   --   * Typically if a CAP flight is tasked and therefore leaves their zone empty while they go off and intercept their target another CAP flight will spawn to take their place.
   --  
@@ -750,7 +738,7 @@ do -- AI_A2A_DISPATCHER
   -- 
   -- In the mission editor, setup a group with task Refuelling. A tanker unit of the correct coalition will be automatically selected.
   -- Then, use the method @{#AI_A2A_DISPATCHER.SetDefaultTanker}() to set the tanker for the dispatcher.
-  -- Use the method @{#AI_A2A_DISPATCHER.SetDefaultFuelThreshold}() to set the %-tage left in the defender airplane tanks when a refuel action is needed.
+  -- Use the method @{#AI_A2A_DISPATCHER.SetDefaultFuelTreshold}() to set the %-tage left in the defender airplane tanks when a refuel action is needed.
   -- 
   -- When the tanker specified is alive and in the air, the tanker will be used for refuelling.
   -- 
@@ -805,11 +793,11 @@ do -- AI_A2A_DISPATCHER
   -- For example because the mission calls for a EWR radar on the blue side the Ukraine might be chosen as a blue country 
   -- so that the 55G6 EWR radar unit is available to blue.  
   -- Some countries assign different tasking to aircraft, for example Germany assigns the CAP task to F-4E Phantoms but the USA does not.  
-  -- Therefore if F4s are wanted as a coalition's CAP or GCI aircraft Germany will need to be assigned to that coalition. 
+  -- Therefore if F4s are wanted as a coalition’s CAP or GCI aircraft Germany will need to be assigned to that coalition. 
   -- 
   -- ### 11.2. Country, type, load out, skill and skins for CAP and GCI aircraft?
   -- 
-  --   * Note these can be from any countries within the coalition but must be an aircraft with one of the main tasks being "CAP".
+  --   * Note these can be from any countries within the coalition but must be an aircraft with one of the main tasks being “CAP”.
   --   * Obviously skins which are selected must be available to all players that join the mission otherwise they will see a default skin.
   --   * Load outs should be appropriate to a CAP mission eg perhaps drop tanks for CAP flights and extra missiles for GCI flights. 
   --   * These decisions will eventually lead to template aircraft units being placed as late activation units that the script will use as templates for spawning CAP and GCI flights. Up to 4 different aircraft configurations can be chosen for each coalition. The spawned aircraft will inherit the characteristics of the template aircraft.
@@ -840,7 +828,7 @@ do -- AI_A2A_DISPATCHER
   
   --- AI_A2A_DISPATCHER constructor.
   -- This is defining the A2A DISPATCHER for one coaliton.
-  -- The Dispatcher works with a @{Functional.Detection#DETECTION_BASE} object that is taking of the detection of targets using the EWR units.
+  -- The Dispatcher works with a @{Functional#Detection} object that is taking of the detection of targets using the EWR units.
   -- The Detection object is polymorphic, depending on the type of detection object choosen, the detection will work differently.
   -- @param #AI_A2A_DISPATCHER self
   -- @param Functional.Detection#DETECTION_BASE Detection The DETECTION object that will detects targets using the the Early Warning Radar network.
@@ -993,7 +981,6 @@ do -- AI_A2A_DISPATCHER
     
     self:HandleEvent( EVENTS.Crash, self.OnEventCrashOrDead )
     self:HandleEvent( EVENTS.Dead, self.OnEventCrashOrDead )
-    --self:HandleEvent( EVENTS.RemoveUnit, self.OnEventCrashOrDead )
     
     self:HandleEvent( EVENTS.Land )
     self:HandleEvent( EVENTS.EngineShutdown )
@@ -1014,7 +1001,7 @@ do -- AI_A2A_DISPATCHER
   --- @param #AI_A2A_DISPATCHER self
   -- @param Core.Event#EVENTDATA EventData
   function AI_A2A_DISPATCHER:OnEventLand( EventData )
-    self:F( "Landed" )
+    self:E( "Landed" )
     local DefenderUnit = EventData.IniUnit
     local Defender = EventData.IniGroup
     local Squadron = self:GetSquadronFromDefender( Defender )
@@ -1034,6 +1021,10 @@ do -- AI_A2A_DISPATCHER
         DefenderUnit:Destroy()
         return
       end
+      if DefenderUnit:GetFuel() <= self.DefenderDefault.FuelThreshold then
+        DefenderUnit:Destroy()
+        return
+      end
     end 
   end
   
@@ -1046,8 +1037,7 @@ do -- AI_A2A_DISPATCHER
     if Squadron then
       self:F( { SquadronName = Squadron.Name } )
       local LandingMethod = self:GetSquadronLanding( Squadron.Name )
-      if LandingMethod == AI_A2A_DISPATCHER.Landing.AtEngineShutdown and
-        not DefenderUnit:InAir() then
+      if LandingMethod == AI_A2A_DISPATCHER.Landing.AtEngineShutdown then
         local DefenderSize = Defender:GetSize()
         if DefenderSize == 1 then
           self:RemoveDefenderFromSquadron( Squadron, Defender )
@@ -1150,7 +1140,7 @@ do -- AI_A2A_DISPATCHER
   --- Define a border area to simulate a **cold war** scenario.
   -- A **cold war** is one where CAP aircraft patrol their territory but will not attack enemy aircraft or launch GCI aircraft unless enemy aircraft enter their territory. In other words the EWR may detect an enemy aircraft but will only send aircraft to attack it if it crosses the border.
   -- A **hot war** is one where CAP aircraft will intercept any detected enemy aircraft and GCI aircraft will launch against detected enemy aircraft without regard for territory. In other words if the ground radar can detect the enemy aircraft then it will send CAP and GCI aircraft to attack it.
-  -- If it's a cold war then the **borders of red and blue territory** need to be defined using a @{zone} object derived from @{Core.Zone#ZONE_BASE}. This method needs to be used for this.
+  -- If it’s a cold war then the **borders of red and blue territory** need to be defined using a @{zone} object derived from @{Zone#ZONE_BASE}. This method needs to be used for this.
   -- If a hot war is chosen then **no borders** actually need to be defined using the helicopter units other than it makes it easier sometimes for the mission maker to envisage where the red and blue territories roughly are. In a hot war the borders are effectively defined by the ground based radar coverage of a coalition. Set the noborders parameter to 1
   -- @param #AI_A2A_DISPATCHER self
   -- @param Core.Zone#ZONE_BASE BorderZone An object derived from ZONE_BASE, or a list of objects derived from ZONE_BASE.
@@ -1284,7 +1274,7 @@ do -- AI_A2A_DISPATCHER
   --- Calculates which AI friendlies are nearby the area
   -- @param #AI_A2A_DISPATCHER self
   -- @param DetectedItem
-  -- @return #table A list of the friendlies nearby.
+  -- @return #number, Core.CommandCenter#REPORT
   function AI_A2A_DISPATCHER:GetAIFriendliesNearBy( DetectedItem )
   
     local FriendliesNearBy = self.Detection:GetFriendliesDistance( DetectedItem )
@@ -1431,11 +1421,11 @@ do -- AI_A2A_DISPATCHER
   -- You need to specify here EXACTLY the name of the airbase as you see it in the mission editor. 
   -- Examples are `"Batumi"` or `"Tbilisi-Lochini"`. 
   -- EXACTLY the airbase name, between quotes `""`.
-  -- To ease the airbase naming when using the LDT editor and IntelliSense, the @{Wrapper.Airbase#AIRBASE} class contains enumerations of the airbases of each map.
+  -- To ease the airbase naming when using the LDT editor and IntelliSense, the @{Airbase#AIRBASE} class contains enumerations of the airbases of each map.
   --    
-  --    * Caucasus: @{Wrapper.Airbase#AIRBASE.Caucaus}
-  --    * Nevada or NTTR: @{Wrapper.Airbase#AIRBASE.Nevada}
-  --    * Normandy: @{Wrapper.Airbase#AIRBASE.Normandy}
+  --    * Caucasus: @{Airbase#AIRBASE.Caucaus}
+  --    * Nevada or NTTR: @{Airbase#AIRBASE.Nevada}
+  --    * Normandy: @{Airbase#AIRBASE.Normandy}
   -- 
   -- @param #string TemplatePrefixes A string or an array of strings specifying the **prefix names of the templates** (not going to explain what is templates here again). 
   -- Examples are `{ "104th", "105th" }` or `"104th"` or `"Template 1"` or `"BLUE PLANES"`. 
@@ -1498,7 +1488,7 @@ do -- AI_A2A_DISPATCHER
     DefenderSquadron.Resources = Resources
     DefenderSquadron.TemplatePrefixes = TemplatePrefixes
 
-    self:F( { Squadron = {SquadronName, AirbaseName, TemplatePrefixes, Resources } } )
+    self:E( { Squadron = {SquadronName, AirbaseName, TemplatePrefixes, Resources } } )
     
     return self
   end
@@ -1520,7 +1510,7 @@ do -- AI_A2A_DISPATCHER
   --- Set a CAP for a Squadron.
   -- @param #AI_A2A_DISPATCHER self
   -- @param #string SquadronName The squadron name.
-  -- @param Core.Zone#ZONE_BASE Zone The @{Zone} object derived from @{Core.Zone#ZONE_BASE} that defines the zone wherein the CAP will be executed.
+  -- @param Core.Zone#ZONE_BASE Zone The @{Zone} object derived from @{Zone#ZONE_BASE} that defines the zone wherein the CAP will be executed.
   -- @param #number FloorAltitude The minimum altitude at which the cap can be executed.
   -- @param #number CeilingAltitude the maximum altitude at which the cap can be executed.
   -- @param #number PatrolMinSpeed The minimum speed at which the cap can be executed.
@@ -1564,7 +1554,7 @@ do -- AI_A2A_DISPATCHER
 
     self:SetSquadronCapInterval( SquadronName, self.DefenderDefault.CapLimit, self.DefenderDefault.CapMinSeconds, self.DefenderDefault.CapMaxSeconds, 1 )
 
-    self:F( { CAP = { SquadronName, Zone, FloorAltitude, CeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, EngageMinSpeed, EngageMaxSpeed, AltType } } )
+    self:E( { CAP = { SquadronName, Zone, FloorAltitude, CeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, EngageMinSpeed, EngageMaxSpeed, AltType } } )
    
     -- Add the CAP to the EWR network.
     
@@ -1668,7 +1658,7 @@ do -- AI_A2A_DISPATCHER
       local Cap = DefenderSquadron.Cap
       if Cap then
         local CapCount = self:CountCapAirborne( SquadronName )
-        self:F( { CapCount = CapCount } )
+        self:E( { CapCount = CapCount } )
         if CapCount < Cap.CapLimit then
           local Probability = math.random()
           if Probability <= Cap.Probability then
@@ -1726,7 +1716,7 @@ do -- AI_A2A_DISPATCHER
     Intercept.EngageMinSpeed = EngageMinSpeed
     Intercept.EngageMaxSpeed = EngageMaxSpeed
     
-    self:F( { GCI = { SquadronName, EngageMinSpeed, EngageMaxSpeed } } )
+    self:E( { GCI = { SquadronName, EngageMinSpeed, EngageMaxSpeed } } )
   end
   
   --- Defines the default amount of extra planes that will take-off as part of the defense system.
@@ -2365,7 +2355,7 @@ do -- AI_A2A_DISPATCHER
   --   A2ADispatcher = AI_A2A_DISPATCHER:New( Detection )  
   --   
   --   -- Now Setup the default fuel treshold.
-  --   A2ADispatcher:SetDefaultFuelThreshold( 0.30 ) -- Go RTB when only 30% of fuel remaining in the tank.
+  --   A2ADispatcher:SetDefaultRefuelThreshold( 0.30 ) -- Go RTB when only 30% of fuel remaining in the tank.
   --   
   function AI_A2A_DISPATCHER:SetDefaultFuelThreshold( FuelThreshold )
     
@@ -2399,7 +2389,7 @@ do -- AI_A2A_DISPATCHER
 
   --- Set the default tanker where defenders will Refuel in the air.
   -- @param #AI_A2A_DISPATCHER self
-  -- @param #string TankerName A string defining the group name of the Tanker as defined within the Mission Editor.
+  -- @param #strig TankerName A string defining the group name of the Tanker as defined within the Mission Editor.
   -- @return #AI_A2A_DISPATCHER
   -- @usage
   -- 
@@ -2407,7 +2397,7 @@ do -- AI_A2A_DISPATCHER
   --   A2ADispatcher = AI_A2A_DISPATCHER:New( Detection )  
   --   
   --   -- Now Setup the default fuel treshold.
-  --   A2ADispatcher:SetDefaultFuelThreshold( 0.30 ) -- Go RTB when only 30% of fuel remaining in the tank.
+  --   A2ADispatcher:SetDefaultRefuelThreshold( 0.30 ) -- Go RTB when only 30% of fuel remaining in the tank.
   --   
   --   -- Now Setup the default tanker.
   --   A2ADispatcher:SetDefaultTanker( "Tanker" ) -- The group name of the tanker is "Tanker" in the Mission Editor.
@@ -2422,7 +2412,7 @@ do -- AI_A2A_DISPATCHER
   --- Set the squadron tanker where defenders will Refuel in the air.
   -- @param #AI_A2A_DISPATCHER self
   -- @param #string SquadronName The name of the squadron.
-  -- @param #string TankerName A string defining the group name of the Tanker as defined within the Mission Editor.
+  -- @param #strig TankerName A string defining the group name of the Tanker as defined within the Mission Editor.
   -- @return #AI_A2A_DISPATCHER
   -- @usage
   -- 
@@ -2453,7 +2443,7 @@ do -- AI_A2A_DISPATCHER
     if Squadron.Resources then
       Squadron.Resources = Squadron.Resources - Size
     end
-    self:F( { DefenderName = DefenderName, SquadronResources = Squadron.Resources } )
+    self:E( { DefenderName = DefenderName, SquadronResources = Squadron.Resources } )
   end
 
   --- @param #AI_A2A_DISPATCHER self
@@ -2478,7 +2468,7 @@ do -- AI_A2A_DISPATCHER
   --- Creates an SWEEP task when there are targets for it.
   -- @param #AI_A2A_DISPATCHER self
   -- @param Functional.Detection#DETECTION_BASE.DetectedItem DetectedItem
-  -- @return Core.Set#SET_UNIT TargetSetUnit: The target set of units.
+  -- @return Set#SET_UNIT TargetSetUnit: The target set of units.
   -- @return #nil If there are no targets to be set.
   function AI_A2A_DISPATCHER:EvaluateSWEEP( DetectedItem )
     self:F( { DetectedItem.ItemID } )
@@ -2514,8 +2504,7 @@ do -- AI_A2A_DISPATCHER
             if AIGroup:IsAlive() then
               -- Check if the CAP is patrolling or engaging. If not, this is not a valid CAP, even if it is alive!
               -- The CAP could be damaged, lost control, or out of fuel!
-              if DefenderTask.Fsm:Is( "Patrolling" ) or DefenderTask.Fsm:Is( "Engaging" ) or DefenderTask.Fsm:Is( "Refuelling" )
-                    or DefenderTask.Fsm:Is( "Started" ) then
+              if DefenderTask.Fsm:Is( "Patrolling" ) or DefenderTask.Fsm:Is( "Engaging" ) or DefenderTask.Fsm:Is( "Refuelling" )then
                 CapCount = CapCount + 1
               end
             end
@@ -2535,8 +2524,9 @@ do -- AI_A2A_DISPATCHER
     -- First, count the active AIGroups Units, targetting the DetectedSet
     local DefenderCount = 0
     
+    self:E( "Counting Defenders Engaged for Attacker:" )
     local DetectedSet = AttackerDetection.Set
-    --DetectedSet:Flush()
+    DetectedSet:Flush()
     
     local DefenderTasks = self:GetDefenderTasks()
     for DefenderGroup, DefenderTask in pairs( DefenderTasks ) do
@@ -2549,12 +2539,8 @@ do -- AI_A2A_DISPATCHER
         local SquadronOverhead = Squadron.Overhead or self.DefenderDefault.Overhead
         
         local DefenderSize = Defender:GetInitialSize()
-        if DefenderSize then
-          DefenderCount = DefenderCount + DefenderSize / SquadronOverhead
-          self:F( "Defender Group Name: " .. Defender:GetName() .. ", Size: " .. DefenderSize )
-        else
-          DefenderCount = 0
-        end
+        DefenderCount = DefenderCount + DefenderSize / SquadronOverhead
+        self:F( "Defender Group Name: " .. Defender:GetName() .. ", Size: " .. DefenderSize )
       end
     end
 
@@ -2624,7 +2610,7 @@ do -- AI_A2A_DISPATCHER
     
       if Cap then
     
-        local Spawn = DefenderSquadron.Spawn[ math.random( 1, #DefenderSquadron.Spawn ) ] -- Core.Spawn#SPAWN
+        local Spawn = DefenderSquadron.Spawn[ math.random( 1, #DefenderSquadron.Spawn ) ] -- Functional.Spawn#SPAWN
         local DefenderGrouping = DefenderSquadron.Grouping or self.DefenderDefault.Grouping
         Spawn:InitGrouping( DefenderGrouping )
 
@@ -2666,7 +2652,7 @@ do -- AI_A2A_DISPATCHER
   
           --- @param #AI_A2A_DISPATCHER self
           function Fsm:onafterHome( Defender, From, Event, To, Action )
-            self:F({"CAP Home", Defender:GetName()})
+            self:E({"CAP Home", Defender:GetName()})
             self:GetParent(self).onafterHome( self, Defender, From, Event, To )
             
             local Dispatcher = self:GetDispatcher() -- #AI_A2A_DISPATCHER
@@ -2797,7 +2783,7 @@ do -- AI_A2A_DISPATCHER
               
               while ( DefendersNeeded > 0 ) do
             
-                local Spawn = DefenderSquadron.Spawn[ math.random( 1, #DefenderSquadron.Spawn ) ] -- Core.Spawn#SPAWN
+                local Spawn = DefenderSquadron.Spawn[ math.random( 1, #DefenderSquadron.Spawn ) ] -- Functional.Spawn#SPAWN
                 local DefenderGrouping = ( DefenderGrouping < DefendersNeeded ) and DefenderGrouping or DefendersNeeded
                 if DefenderGrouping then
                   Spawn:InitGrouping( DefenderGrouping )
@@ -2807,7 +2793,7 @@ do -- AI_A2A_DISPATCHER
                 
                 local TakeoffMethod = self:GetSquadronTakeoff( ClosestDefenderSquadronName )
                 local DefenderGCI = Spawn:SpawnAtAirbase( DefenderSquadron.Airbase, TakeoffMethod, DefenderSquadron.TakeoffAltitude or self.DefenderDefault.TakeoffAltitude ) -- Wrapper.Group#GROUP
-                self:F( { GCIDefender = DefenderGCI:GetName() } )
+                self:E( { GCIDefender = DefenderGCI:GetName() } )
   
                 DefendersNeeded = DefendersNeeded - DefenderGrouping
         
@@ -2902,8 +2888,8 @@ do -- AI_A2A_DISPATCHER
 
   --- Creates an ENGAGE task when there are human friendlies airborne near the targets.
   -- @param #AI_A2A_DISPATCHER self
-  -- @param Functional.Detection#DETECTION_BASE.DetectedItem DetectedItem The detected item.
-  -- @return Core.Set#SET_UNIT TargetSetUnit: The target set of units.
+  -- @param Functional.Detection#DETECTION_BASE.DetectedItem DetectedItem
+  -- @return Set#SET_UNIT TargetSetUnit: The target set of units.
   -- @return #nil If there are no targets to be set.
   function AI_A2A_DISPATCHER:EvaluateENGAGE( DetectedItem )
     self:F( { DetectedItem.ItemID } )
@@ -2929,8 +2915,8 @@ do -- AI_A2A_DISPATCHER
   
   --- Creates an GCI task when there are targets for it.
   -- @param #AI_A2A_DISPATCHER self
-  -- @param Functional.Detection#DETECTION_BASE.DetectedItem DetectedItem The detected item.
-  -- @return Core.Set#SET_UNIT TargetSetUnit: The target set of units.
+  -- @param Functional.Detection#DETECTION_BASE.DetectedItem DetectedItem
+  -- @return Set#SET_UNIT TargetSetUnit: The target set of units.
   -- @return #nil If there are no targets to be set.
   function AI_A2A_DISPATCHER:EvaluateGCI( DetectedItem )
     self:F( { DetectedItem.ItemID } )
@@ -2956,7 +2942,7 @@ do -- AI_A2A_DISPATCHER
 
   --- Assigns A2A AI Tasks in relation to the detected items.
   -- @param #AI_A2A_DISPATCHER self
-  -- @param Functional.Detection#DETECTION_BASE Detection The detection created by the @{Functional.Detection#DETECTION_BASE} derived object.
+  -- @param Functional.Detection#DETECTION_BASE Detection The detection created by the @{Detection#DETECTION_BASE} derived object.
   -- @return #boolean Return true if you want the task assigning to continue... false will cancel the loop.
   function AI_A2A_DISPATCHER:ProcessDetected( Detection )
   
@@ -2971,13 +2957,13 @@ do -- AI_A2A_DISPATCHER
       local AIGroup = AIGroup -- Wrapper.Group#GROUP
       if not AIGroup:IsAlive() then
         local DefenderTaskFsm = self:GetDefenderTaskFsm( AIGroup )
-        self:F( { Defender = AIGroup:GetName(), DefenderState = DefenderTaskFsm:GetState() } )
+        self:E( { Defender = AIGroup:GetName(), DefenderState = DefenderTaskFsm:GetState() } )
         if not DefenderTaskFsm:Is( "Started" ) then
           self:ClearDefenderTask( AIGroup )
         end
       else
         if DefenderTask.Target then
-          local AttackerItem = Detection:GetDetectedItemByIndex( DefenderTask.Target.Index )
+          local AttackerItem = Detection:GetDetectedItem( DefenderTask.Target.Index )
           if not AttackerItem then
             self:F( { "Removing obsolete Target:", DefenderTask.Target.Index } )
             self:ClearDefenderTaskTarget( AIGroup )
@@ -2996,8 +2982,6 @@ do -- AI_A2A_DISPATCHER
 
     local Report = REPORT:New( "\nTactical Overview" )
 
-    local DefenderGroupCount = 0
-
     -- Now that all obsolete tasks are removed, loop through the detected targets.
     for DetectedItemID, DetectedItem in pairs( Detection:GetDetectedItems() ) do
     
@@ -3007,7 +2991,7 @@ do -- AI_A2A_DISPATCHER
       local DetectedZone = DetectedItem.Zone
 
       self:F( { "Target ID", DetectedItem.ItemID } )
-      DetectedSet:Flush( self )
+      DetectedSet:Flush()
 
       local DetectedID = DetectedItem.ID
       local DetectionIndex = DetectedItem.Index
@@ -3023,7 +3007,7 @@ do -- AI_A2A_DISPATCHER
 
       do
         local DefendersMissing, Friendlies = self:EvaluateGCI( DetectedItem )
-        if DefendersMissing and DefendersMissing > 0 then
+        if DefendersMissing then
           self:F( { DefendersMissing = DefendersMissing } )
           self:GCI( DetectedItem, DefendersMissing, Friendlies )
         end
@@ -3035,19 +3019,16 @@ do -- AI_A2A_DISPATCHER
         for Defender, DefenderTask in pairs( self:GetDefenderTasks() ) do
           local Defender = Defender -- Wrapper.Group#GROUP
            if DefenderTask.Target and DefenderTask.Target.Index == DetectedItem.Index then
-             if Defender:IsAlive() then
-               DefenderGroupCount = DefenderGroupCount + 1
-               local Fuel = Defender:GetFuelMin() * 100
-               local Damage = Defender:GetLife() / Defender:GetLife0() * 100
-               Report:Add( string.format( "   - %s ( %s - %s ): ( #%d ) F: %3d, D:%3d - %s", 
-                                          Defender:GetName(), 
-                                          DefenderTask.Type, 
-                                          DefenderTask.Fsm:GetState(), 
-                                          Defender:GetSize(), 
-                                          Fuel,
-                                          Damage, 
-                                          Defender:HasTask() == true and "Executing" or "Idle" ) )
-             end
+             local Fuel = Defender:GetFuel() * 100
+             local Damage = Defender:GetLife() / Defender:GetLife0() * 100
+             Report:Add( string.format( "   - %s ( %s - %s ): ( #%d ) F: %3d, D:%3d - %s", 
+                                        Defender:GetName(), 
+                                        DefenderTask.Type, 
+                                        DefenderTask.Fsm:GetState(), 
+                                        Defender:GetSize(), 
+                                        Fuel,
+                                        Damage, 
+                                        Defender:HasTask() == true and "Executing" or "Idle" ) )
            end
         end
       end
@@ -3060,25 +3041,22 @@ do -- AI_A2A_DISPATCHER
         TaskCount = TaskCount + 1
         local Defender = Defender -- Wrapper.Group#GROUP
         if not DefenderTask.Target then
-          if Defender:IsAlive() then
-            local DefenderHasTask = Defender:HasTask()
-            local Fuel = Defender:GetFuelMin() * 100
-            local Damage = Defender:GetLife() / Defender:GetLife0() * 100
-            DefenderGroupCount = DefenderGroupCount + 1
-            Report:Add( string.format( "   - %s ( %s - %s ): ( #%d ) F: %3d, D:%3d - %s", 
-                                       Defender:GetName(), 
-                                       DefenderTask.Type, 
-                                       DefenderTask.Fsm:GetState(), 
-                                       Defender:GetSize(),
-                                       Fuel,
-                                       Damage, 
-                                       Defender:HasTask() == true and "Executing" or "Idle" ) )
-          end
+          local DefenderHasTask = Defender:HasTask()
+          local Fuel = Defender:GetFuel() * 100
+          local Damage = Defender:GetLife() / Defender:GetLife0() * 100
+          Report:Add( string.format( "   - %s ( %s - %s ): ( #%d ) F: %3d, D:%3d - %s", 
+                                     Defender:GetName(), 
+                                     DefenderTask.Type, 
+                                     DefenderTask.Fsm:GetState(), 
+                                     Defender:GetSize(),
+                                     Fuel,
+                                     Damage, 
+                                     Defender:HasTask() == true and "Executing" or "Idle" ) )
         end
       end
-      Report:Add( string.format( "\n - %d Tasks - %d Defender Groups", TaskCount, DefenderGroupCount ) )
+      Report:Add( string.format( "\n - %d Tasks", TaskCount ) )
   
-      self:F( Report:Text( "\n" ) )
+      self:E( Report:Text( "\n" ) )
       trigger.action.outText( Report:Text( "\n" ), 25 )
     end
     
@@ -3089,10 +3067,10 @@ end
 
 do
 
-  --- Calculates which HUMAN friendlies are nearby the area.
+  --- Calculates which HUMAN friendlies are nearby the area
   -- @param #AI_A2A_DISPATCHER self
-  -- @param DetectedItem The detected item.
-  -- @return #number, Core.Report#REPORT The amount of friendlies and a text string explaining which friendlies of which type.
+  -- @param DetectedItem
+  -- @return #number, Core.CommandCenter#REPORT
   function AI_A2A_DISPATCHER:GetPlayerFriendliesNearBy( DetectedItem )
   
     local DetectedSet = DetectedItem.Set
@@ -3106,7 +3084,7 @@ do
       for PlayerUnitName, PlayerUnitData in pairs( PlayersNearBy ) do
         local PlayerUnit = PlayerUnitData -- Wrapper.Unit#UNIT
         local PlayerName = PlayerUnit:GetPlayerName()
-        --self:F( { PlayerName = PlayerName, PlayerUnit = PlayerUnit } )
+        --self:E( { PlayerName = PlayerName, PlayerUnit = PlayerUnit } )
         if PlayerUnit:IsAirPlane() and PlayerName ~= nil then
           local FriendlyUnitThreatLevel = PlayerUnit:GetThreatLevel()
           PlayersCount = PlayersCount + 1
@@ -3119,7 +3097,7 @@ do
       
     end
 
-    --self:F( { PlayersCount = PlayersCount } )
+    --self:E( { PlayersCount = PlayersCount } )
     
     local PlayerTypesReport = REPORT:New()
     
@@ -3135,14 +3113,14 @@ do
     return PlayersCount, PlayerTypesReport
   end
 
-  --- Calculates which friendlies are nearby the area.
+  --- Calculates which friendlies are nearby the area
   -- @param #AI_A2A_DISPATCHER self
-  -- @param DetectedItem The detected item.
-  -- @return #number, Core.Report#REPORT The amount of friendlies and a text string explaining which friendlies of which type.
-  function AI_A2A_DISPATCHER:GetFriendliesNearBy( DetectedItem )
+  -- @param DetectedItem
+  -- @return #number, Core.CommandCenter#REPORT
+  function AI_A2A_DISPATCHER:GetFriendliesNearBy( Target )
   
-    local DetectedSet = DetectedItem.Set
-    local FriendlyUnitsNearBy = self.Detection:GetFriendliesNearBy( DetectedItem )
+    local DetectedSet = Target.Set
+    local FriendlyUnitsNearBy = self.Detection:GetFriendliesNearBy( Target )
     
     local FriendlyTypes = {}
     local FriendliesCount = 0
@@ -3163,7 +3141,7 @@ do
       
     end
 
-    --self:F( { FriendliesCount = FriendliesCount } )
+    --self:E( { FriendliesCount = FriendliesCount } )
     
     local FriendlyTypesReport = REPORT:New()
     
@@ -3179,8 +3157,8 @@ do
     return FriendliesCount, FriendlyTypesReport
   end
 
-  --- Schedules a new CAP for the given SquadronName.
-  -- @param #AI_A2A_DISPATCHER self
+  ---
+  -- @param AI_A2A_DISPATCHER
   -- @param #string SquadronName The squadron name.
   function AI_A2A_DISPATCHER:SchedulerCAP( SquadronName )
     self:CAP( SquadronName )
@@ -3193,10 +3171,14 @@ do
   --- @type AI_A2A_GCICAP
   -- @extends #AI_A2A_DISPATCHER
 
-  --- Create an automatic air defence system for a coalition setting up GCI and CAP air defenses. 
-  -- The class derives from @{#AI_A2A_DISPATCHER} and thus, all the methods that are defined in the @{#AI_A2A_DISPATCHER} class, can be used also in AI\_A2A\_GCICAP.
+  --- # AI\_A2A\_GCICAP class, extends @{AI_A2A_Dispatcher#AI_A2A_DISPATCHER}
   -- 
-  -- ===
+  -- ![Banner Image](..\Presentations\AI_A2A_DISPATCHER\Dia1.JPG)
+  -- 
+  -- The AI_A2A_GCICAP class is designed to create an automatic air defence system for a coalition setting up GCI and CAP air defenses. 
+  -- The class derives from @{AI#AI_A2A_DISPATCHER} and thus, all the methods that are defined in the @{AI#AI_A2A_DISPATCHER} class, can be used also in AI\_A2A\_GCICAP.
+  -- 
+  -- ====
   -- 
   -- # Demo Missions
   -- 
@@ -3206,7 +3188,7 @@ do
   -- 
   -- ### [AI\_A2A\_GCICAP for beta testers](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AID%20-%20AI%20Dispatching)
   --
-  -- ===
+  -- ====
   -- 
   -- # YouTube Channel
   -- 
@@ -3236,7 +3218,7 @@ do
   -- 
   -- In short it is a plug in very flexible and configurable air defence module for DCS World.
   -- 
-  -- ===
+  -- ====
   -- 
   -- # The following actions need to be followed when using AI\_A2A\_GCICAP in your mission:
   -- 
@@ -3297,7 +3279,7 @@ do
   -- 
   -- **The place of the helicopter is important, as the airbase closest to the helicopter will be the airbase from where the CAP planes will take off for CAP.**
   -- 
-  -- ## 2) There are a lot of defaults set, which can be further modified using the methods in @{#AI_A2A_DISPATCHER}:
+  -- ## 2) There are a lot of defaults set, which can be further modified using the methods in @{AI#AI_A2A_DISPATCHER}:
   -- 
   -- ### 2.1) Planes are taking off in the air from the airbases.
   -- 
@@ -3569,23 +3551,22 @@ do
 
     -- Setup squadrons
     
-    self:I( { Airbases = AirbaseNames  } )
-
-    self:I( "Defining Templates for Airbases ..." )    
+    self:F( { Airbases = AirbaseNames  } )
+    self.Templates:Flush()
+    
     for AirbaseID, AirbaseName in pairs( AirbaseNames ) do
       local Airbase = _DATABASE:FindAirbase( AirbaseName ) -- Wrapper.Airbase#AIRBASE
       local AirbaseName = Airbase:GetName()
       local AirbaseCoord = Airbase:GetCoordinate()
       local AirbaseZone = ZONE_RADIUS:New( "Airbase", AirbaseCoord:GetVec2(), 3000 )
       local Templates = nil
-      self:I( { Airbase = AirbaseName } )    
       for TemplateID, Template in pairs( self.Templates:GetSet() ) do
         local Template = Template -- Wrapper.Group#GROUP
+        self:F( { Template = Template:GetName() } )
         local TemplateCoord = Template:GetCoordinate()
         if AirbaseZone:IsVec2InZone( TemplateCoord:GetVec2() ) then
           Templates = Templates or {}
           table.insert( Templates, Template:GetName() )
-          self:I( { Template = Template:GetName() } )
         end
       end
       if Templates then
@@ -3601,13 +3582,11 @@ do
     self.CAPTemplates:FilterPrefixes( CapPrefixes )
     self.CAPTemplates:FilterOnce()
     
-    self:I( "Setting up CAP ..." )    
     for CAPID, CAPTemplate in pairs( self.CAPTemplates:GetSet() ) do
       local CAPZone = ZONE_POLYGON:New( CAPTemplate:GetName(), CAPTemplate )
       -- Now find the closest airbase from the ZONE (start or center)
       local AirbaseDistance = 99999999
       local AirbaseClosest = nil -- Wrapper.Airbase#AIRBASE
-      self:I( { CAPZoneGroup = CAPID } )    
       for AirbaseID, AirbaseName in pairs( AirbaseNames ) do
         local Airbase = _DATABASE:FindAirbase( AirbaseName ) -- Wrapper.Airbase#AIRBASE
         local AirbaseName = Airbase:GetName()
@@ -3615,7 +3594,6 @@ do
         local Squadron = self.DefenderSquadrons[AirbaseName]
         if Squadron then
           local Distance = AirbaseCoord:Get2DDistance( CAPZone:GetCoordinate() )
-          self:I( { AirbaseDistance = Distance } )    
           if Distance < AirbaseDistance then
             AirbaseDistance = Distance
             AirbaseClosest = Airbase
@@ -3623,7 +3601,6 @@ do
         end
       end
       if AirbaseClosest then
-        self:I( { CAPAirbase = AirbaseClosest:GetName() } )    
         self:SetSquadronCap( AirbaseClosest:GetName(), CAPZone, 6000, 10000, 500, 800, 800, 1200, "RADIO" )
         self:SetSquadronCapInterval( AirbaseClosest:GetName(), CapLimit, 300, 600, 1 )
       end          
@@ -3631,14 +3608,11 @@ do
 
     -- Setup GCI.
     -- GCI is setup for all Squadrons.
-    self:I( "Setting up GCI ..." )    
     for AirbaseID, AirbaseName in pairs( AirbaseNames ) do
       local Airbase = _DATABASE:FindAirbase( AirbaseName ) -- Wrapper.Airbase#AIRBASE
       local AirbaseName = Airbase:GetName()
       local Squadron = self.DefenderSquadrons[AirbaseName]
-      self:F( { Airbase = AirbaseName } )    
       if Squadron then
-        self:I( { GCIAirbase = AirbaseName } )    
         self:SetSquadronGci( AirbaseName, 800, 1200 )
       end
     end
@@ -3647,7 +3621,6 @@ do
     
     self:HandleEvent( EVENTS.Crash, self.OnEventCrashOrDead )
     self:HandleEvent( EVENTS.Dead, self.OnEventCrashOrDead )
-    --self:HandleEvent( EVENTS.RemoveUnit, self.OnEventCrashOrDead )
     
     self:HandleEvent( EVENTS.Land )
     self:HandleEvent( EVENTS.EngineShutdown )

Moose Development/Moose/AI/AI_A2A_Gci.lua

@@ -1,27 +1,40 @@
---- **AI** -- (R2.2) - Models the process of Ground Controlled Interception (GCI) for airplanes.
+--- **AI** -- **Execute Ground Controlled Interception (GCI).**
 --
--- This is a class used in the @{AI_A2A_Dispatcher}.
+-- ![Banner Image](..\Presentations\AI_GCI\Dia1.JPG)
 -- 
 -- ===
 -- 
--- ### Author: **FlightControl**
+-- AI A2A_INTEREPT class makes AI Groups execute an Intercept.
 -- 
--- ===       
+-- There are the following types of GCI classes defined:
+-- 
+--   * @{#AI_A2A_GCI}: Perform a GCI in a zone.
+--   
+-- ====
+-- 
+-- ### Author: **Sven Van de Velde (FlightControl)**
+-- 
+-- ### Contributions: 
+-- 
+-- ====       
 --
--- @module AI.AI_A2A_GCI
--- @image AI_Ground_Control_Intercept.JPG
+-- @module AI_A2A_GCI
 
 
+--BASE:TraceClass("AI_A2A_GCI")
+
 
 --- @type AI_A2A_GCI
 -- @extends AI.AI_A2A#AI_A2A
 
 
---- Implements the core functions to intercept intruders. Use the Engage trigger to intercept intruders.
+--- # AI_A2A_GCI class, extends @{AI_A2A#AI_A2A}
+-- 
+-- The AI_A2A_GCI class implements the core functions to intercept intruders. The Engage function will intercept intruders.
 -- 
 -- ![Process](..\Presentations\AI_GCI\Dia3.JPG)
 -- 
--- 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_A2A_GCI is assigned a @{Group} and this must be done before the AI_A2A_GCI process can be started using the **Start** event.
 -- 
 -- ![Process](..\Presentations\AI_GCI\Dia4.JPG)
 -- 
@@ -64,15 +77,15 @@
 -- 
 -- ### 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_Patrol#AI_PATROL_ZONE.Start}**: Start the process.
+--   * **@{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.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.RTB}**: Route the AI to the home base.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.Detect}**: The AI is detecting targets.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.Detected}**: The AI has detected new targets.
+--   * **@{#AI_A2A_GCI.Destroy}**: The AI has destroyed a bogey @{Unit}.
+--   * **@{#AI_A2A_GCI.Destroyed}**: The AI has destroyed all bogeys @{Unit}s assigned in the CAS task.
 --   * **Status** ( Group ): The AI is checking status (fuel and damage). When the tresholds have been reached, the AI will RTB.
 --
 -- ## 3. Set the Range of Engagement
@@ -83,7 +96,7 @@
 -- that will define when the AI will engage with the detected airborne enemy targets.
 -- The range can be beyond or smaller than the range of the Patrol Zone.
 -- The range is applied at the position of the AI.
--- Use the method @{AI.AI_GCI#AI_A2A_GCI.SetEngageRange}() to define that range.
+-- Use the method @{AI_GCI#AI_A2A_GCI.SetEngageRange}() to define that range.
 --
 -- ## 4. Set the Zone of Engagement
 -- 
@@ -91,7 +104,7 @@
 -- 
 -- An optional @{Zone} can be set, 
 -- that will define when the AI will engage with the detected airborne enemy targets.
--- Use the method @{AI.AI_Cap#AI_A2A_GCI.SetEngageZone}() to define that Zone.
+-- Use the method @{AI_Cap#AI_A2A_GCI.SetEngageZone}() to define that Zone.
 --  
 -- ===
 -- 
@@ -290,7 +303,6 @@ end
 -- @param #string To The To State string.
 function AI_A2A_GCI:onafterStart( AIIntercept, From, Event, To )
 
-  self:GetParent( self ).onafterStart( self, AIIntercept, From, Event, To )
   AIIntercept:HandleEvent( EVENTS.Takeoff, nil, self )
 
 end

Moose Development/Moose/AI/AI_A2A_Patrol.lua

@@ -1,23 +1,54 @@
---- **AI** -- (R2.2) - Models the process of air patrol of airplanes.
+--- **AI** -- **Air Patrolling or Staging.**
+-- 
+-- ![Banner Image](..\Presentations\AI_PATROL\Dia1.JPG)
 -- 
 -- ===
 -- 
--- ### Author: **FlightControl**
+-- AI PATROL classes makes AI Groups execute an Patrol.
 -- 
--- ===
+-- There are the following types of PATROL classes defined:
 -- 
--- @module AI.AI_A2A_Patrol
--- @image AI_Air_Patrolling.JPG
+--   * @{#AI_A2A_PATROL}: Perform a PATROL in a zone.
+--   
+-- ====
+-- 
+-- # Demo Missions
+-- 
+-- ### [AI_PATROL Demo Missions source code](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/PAT%20-%20Patrolling)
+-- 
+-- ### [AI_PATROL Demo Missions, only for beta testers](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/PAT%20-%20Patrolling)
+--
+-- ### [ALL Demo Missions pack of the last release](https://github.com/FlightControl-Master/MOOSE_MISSIONS/releases)
+-- 
+-- ====
+-- 
+-- # YouTube Channel
+-- 
+-- ### [AI_PATROL YouTube Channel](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl35HvYZKA6G22WMt7iI3zky)
+-- 
+-- ====
+-- 
+-- ### Author: **Sven Van de Velde (FlightControl)**
+-- ### Contributions: 
+-- 
+--   * **[Dutch_Baron](https://forums.eagle.ru/member.php?u=112075)**: 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](https://forums.eagle.ru/member.php?u=62835)**: Testing and API concept review.
+-- 
+-- ====
+-- 
+-- @module AI_A2A_Patrol
 
 
 --- @type AI_A2A_PATROL
 -- @extends AI.AI_A2A#AI_A2A
 
---- Implements the core functions to patrol a @{Zone} by an AI @{Wrapper.Group} or @{Wrapper.Group}.
+--- # AI_A2A_PATROL class, extends @{Fsm#FSM_CONTROLLABLE}
+-- 
+-- The AI_A2A_PATROL class implements the core functions to patrol a @{Zone} by an AI @{Group} or @{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.
+-- The AI_A2A_PATROL is assigned a @{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)
 -- 
@@ -90,7 +121,7 @@
 --   * @{#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.
+-- Use the method @{#AI_A2A_PATROL.GetDetectedUnits}() to obtain a list of the @{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.
@@ -123,11 +154,11 @@ AI_A2A_PATROL = {
 -- @param #AI_A2A_PATROL self
 -- @param Wrapper.Group#GROUP AIPatrol
 -- @param Core.Zone#ZONE_BASE PatrolZone The @{Zone} where the patrol needs to be executed.
--- @param DCS#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
--- @param DCS#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
--- @param DCS#Speed  PatrolMinSpeed The minimum speed of the @{Wrapper.Group} in km/h.
--- @param DCS#Speed  PatrolMaxSpeed The maximum speed of the @{Wrapper.Group} in km/h.
--- @param DCS#AltitudeType PatrolAltType The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to RADIO
+-- @param Dcs.DCSTypes#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
+-- @param Dcs.DCSTypes#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
+-- @param Dcs.DCSTypes#Speed  PatrolMinSpeed The minimum speed of the @{Group} in km/h.
+-- @param Dcs.DCSTypes#Speed  PatrolMaxSpeed The maximum speed of the @{Group} in km/h.
+-- @param Dcs.DCSTypes#AltitudeType PatrolAltType The altitude type ("RADIO"=="AGL", "BARO"=="ASL"). Defaults to RADIO
 -- @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.
@@ -233,8 +264,8 @@ 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.
+-- @param Dcs.DCSTypes#Speed  PatrolMinSpeed The minimum speed of the @{Group} in km/h.
+-- @param Dcs.DCSTypes#Speed  PatrolMaxSpeed The maximum speed of the @{Group} in km/h.
 -- @return #AI_A2A_PATROL self
 function AI_A2A_PATROL:SetSpeed( PatrolMinSpeed, PatrolMaxSpeed )
   self:F2( { PatrolMinSpeed, PatrolMaxSpeed } )
@@ -247,8 +278,8 @@ 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.
+-- @param Dcs.DCSTypes#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
+-- @param Dcs.DCSTypes#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 } )
@@ -274,6 +305,7 @@ function AI_A2A_PATROL:onafterPatrol( AIPatrol, From, Event, To )
   
   AIPatrol:OnReSpawn(
     function( PatrolGroup )
+      self:E( "ReSpawn" )
       self:__Reset( 1 )
       self:__Route( 5 )
     end
@@ -355,7 +387,7 @@ function AI_A2A_PATROL.Resume( AIPatrol )
 
   AIPatrol:F( { "AI_A2A_PATROL.Resume:", AIPatrol:GetName() } )
   if AIPatrol:IsAlive() then
-    local _AI_A2A = AIPatrol:GetState( AIPatrol, "AI_A2A" ) -- AI.AI_A2A#AI_A2A
+    local _AI_A2A = AIPatrol:GetState( AIPatrol, "AI_A2A" ) -- #AI_A2A
       _AI_A2A:__Reset( 1 )
       _AI_A2A:__Route( 5 )
   end

Moose Development/Moose/AI/AI_BAI.lua

@@ -1,48 +1,60 @@
---- **AI** -- Peform Battlefield Area Interdiction (BAI) within an engagement zone.
+--- **AI** -- **Provide Battlefield Air Interdiction (bombing).**
 --
--- **Features:**
+-- ![Banner Image](..\Presentations\AI_BAI\Dia1.JPG)
 -- 
---   * 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.
+-- ===
+-- 
+-- AI_BAI classes makes AI Controllables execute bombing tasks.
+-- 
+-- There are the following types of BAI classes defined:
+-- 
+--   * @{#AI_BAI_ZONE}: Perform a BAI in a zone.
+--   
+-- ====
+-- 
+-- # Demo Missions
+-- 
+-- ### [AI_BAI Demo Missions source code](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/BOMB%20-%20Close%20Air%20Support)
+-- 
+-- ### [AI_BAI Demo Missions, only for beta testers](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/BOMB%20-%20Close%20Air%20Support)
 --
--- ===
+-- ### [ALL Demo Missions pack of the last release](https://github.com/FlightControl-Master/MOOSE_MISSIONS/releases)
 -- 
--- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/BAI%20-%20Battlefield%20Air%20Interdiction)
+-- ====
 -- 
--- ===
+-- # YouTube Channel
 -- 
--- ### [YouTube Playlist]()
+-- ### [AI_BAI YouTube Channel](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl3JBO1WDqqpyYRRmIkR2ir2)
 -- 
--- ===
+-- ====
+-- 
+-- ### Author: **Sven Van de Velde (FlightControl)**
 -- 
--- ### Author: **FlightControl**
 -- ### Contributions: 
 -- 
 --   * **[Gunterlund](http://forums.eagle.ru:8080/member.php?u=75036)**: Test case revision.
 -- 
--- ===
+-- ====
 --
--- @module AI.AI_Bai
--- @image AI_Battlefield_Air_Interdiction.JPG
+-- @module AI_Bai
 
 
 --- AI_BAI_ZONE class
 -- @type AI_BAI_ZONE
--- @field Wrapper.Controllable#CONTROLLABLE AIControllable The @{Wrapper.Controllable} patrolling.
+-- @field Wrapper.Controllable#CONTROLLABLE AIControllable The @{Controllable} patrolling.
 -- @field Core.Zone#ZONE_BASE TargetZone The @{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 @{Zone} by an AIR @{Wrapper.Controllable} or @{Wrapper.Group}.
+--- # AI_BAI_ZONE class, extends @{AI_Patrol#AI_PATROL_ZONE}
 -- 
+-- AI_BAI_ZONE derives from the @{AI_Patrol#AI_PATROL_ZONE}, inheriting its methods and behaviour.
+--  
+-- The AI_BAI_ZONE class implements the core functions to provide BattleGround Air Interdiction in an Engage @{Zone} by an AIR @{Controllable} or @{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.
+-- The AI_BAI_ZONE is assigned a @{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)
 -- 
@@ -108,15 +120,15 @@
 -- 
 -- ### 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_Patrol#AI_PATROL_ZONE.Start}**: Start the process.
+--   * **@{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.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.RTB}**: Route the AI to the home base.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.Detect}**: The AI is detecting targets.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.Detected}**: The AI has detected new targets.
+--   * **@{#AI_BAI_ZONE.Destroy}**: The AI has destroyed a target @{Unit}.
+--   * **@{#AI_BAI_ZONE.Destroyed}**: The AI has destroyed all target @{Unit}s assigned in the BOMB task.
 --   * **Status**: The AI is checking status (fuel and damage). When the tresholds have been reached, the AI will RTB.
 -- 
 -- ## 3. Modify the Engage Zone behaviour to pinpoint a **map object** or **scenery object**
@@ -143,12 +155,12 @@ AI_BAI_ZONE = {
 --- Creates a new AI_BAI_ZONE object
 -- @param #AI_BAI_ZONE self
 -- @param Core.Zone#ZONE_BASE PatrolZone The @{Zone} where the patrol needs to be executed.
--- @param DCS#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
--- @param DCS#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
--- @param DCS#Speed  PatrolMinSpeed The minimum speed of the @{Wrapper.Controllable} in km/h.
--- @param DCS#Speed  PatrolMaxSpeed The maximum speed of the @{Wrapper.Controllable} in km/h.
+-- @param Dcs.DCSTypes#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
+-- @param Dcs.DCSTypes#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
+-- @param Dcs.DCSTypes#Speed  PatrolMinSpeed The minimum speed of the @{Controllable} in km/h.
+-- @param Dcs.DCSTypes#Speed  PatrolMaxSpeed The maximum speed of the @{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
+-- @param Dcs.DCSTypes#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 )
 
@@ -185,24 +197,24 @@ function AI_BAI_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude
   -- @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. 
+  -- @param Dcs.DCSTypes#Distance EngageAltitude (optional) Desired altitude to perform the unit engagement.
+  -- @param Dcs.DCSTypes#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.
+  -- Use the structure @{DCSTypes#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.
+  -- @param Dcs.DCSTypes#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. 
+  -- @param Dcs.DCSTypes#Distance EngageAltitude (optional) Desired altitude to perform the unit engagement.
+  -- @param Dcs.DCSTypes#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.
+  -- Use the structure @{DCSTypes#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.
+  -- @param Dcs.DCSTypes#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
@@ -489,10 +501,10 @@ end
 -- @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 Dcs.DCSTypes#Distance EngageAltitude (optional) Desired altitude to perform the unit engagement.
+-- @param Dcs.DCSTypes#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.
+-- @param Dcs.DCSTypes#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, 

Moose Development/Moose/AI/AI_Balancer.lua

@@ -1,44 +1,50 @@
---- **AI** -- Balance player slots with AI to create an engaging simulation environment, independent of the amount of players. 
+--- **AI** -- **AI Balancing will replace in multi player missions 
+-- non-occupied human slots with AI groups, in order to provide an engaging simulation environment, 
+-- even when there are hardly any players in the mission.**
 -- 
--- **Features:**
+-- ![Banner Image](..\Presentations\AI_Balancer\Dia1.JPG)
+--  
+-- ====
 -- 
---   * 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
 -- 
--- ===
+-- ### [AI_BALANCER Demo Missions source code](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/AIB%20-%20AI%20Balancing)
 -- 
--- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/AIB%20-%20AI%20Balancing)
+-- ### [AI_BALANCER Demo Missions, only for beta testers](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AIB%20-%20AI%20Balancing)
+--
+-- ### [ALL Demo Missions pack of the last release](https://github.com/FlightControl-Master/MOOSE_MISSIONS/releases)
 -- 
--- ===
+-- ====
 -- 
--- ### [YouTube Playlist](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl2CJVIrL1TdAumuVS8n64B7)
+-- # YouTube Channel
 -- 
--- ===
+-- ### [AI_BALANCER YouTube Channel](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl2CJVIrL1TdAumuVS8n64B7)
 -- 
--- ### Author: **FlightControl**
+-- ====
+-- 
+-- ### Author: **Sven Van de Velde (FlightControl)**
 -- ### Contributions: 
 -- 
 --   * **[Dutch_Baron](https://forums.eagle.ru/member.php?u=112075)**: 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
+-- @module AI_Balancer
 
 --- @type AI_BALANCER
 -- @field Core.Set#SET_CLIENT SetClient
--- @field Core.Spawn#SPAWN SpawnAI
+-- @field Functional.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. 
+--- # AI_BALANCER class, extends @{Fsm#FSM_SET}
+-- 
+-- The AI_BALANCER class 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 parent class @{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 @{FSM} module documentation.
 -- 
@@ -80,8 +86,8 @@
 -- 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}.
+--    * @{#AI_BALANCER.ReturnToHomeAirbase}: Returns the AI to the **home** @{Airbase#AIRBASE}.
+--    * @{#AI_BALANCER.ReturnToNearestAirbases}: Returns the AI to the **nearest friendly** @{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.
@@ -100,7 +106,7 @@ AI_BALANCER = {
 --- 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.
+-- @param Functional.Spawn#SPAWN SpawnAI The default Spawn object to spawn new AI Groups when needed.
 -- @return #AI_BALANCER
 function AI_BALANCER:New( SetClient, SpawnAI )
   
@@ -143,10 +149,10 @@ function AI_BALANCER:InitSpawnInterval( Earliest, Latest )
   return self
 end
 
---- Returns the AI to the nearest friendly @{Wrapper.Airbase#AIRBASE}.
+--- Returns the AI to the nearest friendly @{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.
+-- @param Dcs.DCSTypes#Distance ReturnThresholdRange If there is an enemy @{Client#CLIENT} within the ReturnThresholdRange given in meters, the AI will not return to the nearest @{Airbase#AIRBASE}.
+-- @param Core.Set#SET_AIRBASE ReturnAirbaseSet The SET of @{Set#SET_AIRBASE}s to evaluate where to return to.
 function AI_BALANCER:ReturnToNearestAirbases( ReturnThresholdRange, ReturnAirbaseSet )
 
   self.ToNearestAirbase = true
@@ -154,9 +160,9 @@ function AI_BALANCER:ReturnToNearestAirbases( ReturnThresholdRange, ReturnAirbas
   self.ReturnAirbaseSet = ReturnAirbaseSet
 end
 
---- Returns the AI to the home @{Wrapper.Airbase#AIRBASE}.
+--- Returns the AI to the home @{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 Dcs.DCSTypes#Distance ReturnThresholdRange If there is an enemy @{Client#CLIENT} within the ReturnThresholdRange given in meters, the AI will not return to the nearest @{Airbase#AIRBASE}.
 function AI_BALANCER:ReturnToHomeAirbase( ReturnThresholdRange )
 
   self.ToHomeAirbase = true
@@ -172,10 +178,9 @@ 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 } )
+    AIGroup:E( "Spawning new AIGroup" )
     --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
     
@@ -191,9 +196,9 @@ end
 function AI_BALANCER:onenterDestroying( SetGroup, From, Event, To, ClientName, AIGroup )
 
   AIGroup:Destroy()
-  SetGroup:Flush( self )
+  SetGroup:Flush()
   SetGroup:Remove( ClientName )
-  SetGroup:Flush( self )
+  SetGroup:Flush()
 end
 
 --- @param #AI_BALANCER self
@@ -234,8 +239,7 @@ function AI_BALANCER:onenterMonitoring( SetGroup )
       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 Client:IsAlive() then
 
         if AIGroup and AIGroup:IsAlive() == true then
 
@@ -251,7 +255,7 @@ function AI_BALANCER:onenterMonitoring( SetGroup )
             
             self:T2( RangeZone )
             
-            _DATABASE:ForEachPlayerUnit(
+            _DATABASE:ForEachPlayer(
               --- @param Wrapper.Unit#UNIT RangeTestUnit
               function( RangeTestUnit, RangeZone, AIGroup, PlayerInRange )
                 self:T2( { PlayerInRange, RangeTestUnit.UnitName, RangeZone.ZoneName } )
@@ -280,12 +284,11 @@ function AI_BALANCER:onenterMonitoring( SetGroup )
       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 )
+            self:E( "New AI Spawned for Client " .. Client.UnitName )
           end
         end
       end

Moose Development/Moose/AI/AI_CAP.lua

@@ -1,24 +1,35 @@
---- **AI** -- Perform Combat Air Patrolling (CAP) for airplanes.
+--- **AI** -- **Execute Combat Air Patrol (CAP).**
 --
--- **Features:**
+-- ![Banner Image](..\Presentations\AI_CAP\Dia1.JPG)
 -- 
---   * Patrol AI airplanes within a given zone.
---   * Trigger detected events when enemy airplanes are detected.
---   * Manage a fuel treshold to RTB on time.
---   * Engage the enemy when detected.
+-- ===
 -- 
+-- AI CAP classes makes AI Controllables execute a Combat Air Patrol.
+-- 
+-- There are the following types of CAP classes defined:
+-- 
+--   * @{#AI_CAP_ZONE}: Perform a CAP in a zone.
+--   
+-- ====
+-- 
+-- # Demo Missions
+-- 
+-- ### [AI_CAP Demo Missions source code](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/CAP%20-%20Combat%20Air%20Patrol)
+-- 
+-- ### [AI_CAP Demo Missions, only for beta testers](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/CAP%20-%20Combat%20Air%20Patrol)
 --
--- ===
+-- ### [ALL Demo Missions pack of the last release](https://github.com/FlightControl-Master/MOOSE_MISSIONS/releases)
 -- 
--- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/CAP%20-%20Combat%20Air%20Patrol)
+-- ====
 -- 
--- ===
+-- # YouTube Channel
 -- 
--- ### [YouTube Playlist](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl1YCyPxJgoZn-CfhwyeW65L)
+-- ### [AI_CAP YouTube Channel](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl1YCyPxJgoZn-CfhwyeW65L)
 -- 
--- ===
+-- ====
+-- 
+-- ### Author: **Sven Van de Velde (FlightControl)**
 -- 
--- ### Author: **FlightControl**
 -- ### Contributions: 
 --
 --   * **[Quax](https://forums.eagle.ru/member.php?u=90530)**: Concept, Advice & Testing.
@@ -27,24 +38,25 @@
 --   * **[Whisper](http://forums.eagle.ru/member.php?u=3829): Testing.
 --   * **[Delta99](https://forums.eagle.ru/member.php?u=125166): Testing. 
 -- 
--- ===       
+-- ====       
 --
--- @module AI.AI_Cap
--- @image AI_Combat_Air_Patrol.JPG
+-- @module AI_Cap
 
 
 --- @type AI_CAP_ZONE
--- @field Wrapper.Controllable#CONTROLLABLE AIControllable The @{Wrapper.Controllable} patrolling.
+-- @field Wrapper.Controllable#CONTROLLABLE AIControllable The @{Controllable} patrolling.
 -- @field Core.Zone#ZONE_BASE TargetZone The @{Zone} where the patrol needs to be executed.
 -- @extends AI.AI_Patrol#AI_PATROL_ZONE
 
 
---- Implements the core functions to patrol a @{Zone} by an AI @{Wrapper.Controllable} or @{Wrapper.Group} 
+--- # AI_CAP_ZONE class, extends @{AI_CAP#AI_PATROL_ZONE}
+-- 
+-- The AI_CAP_ZONE class implements the core functions to patrol a @{Zone} by an AI @{Controllable} or @{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.
+-- The AI_CAP_ZONE is assigned a @{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)
 -- 
@@ -87,15 +99,15 @@
 -- 
 -- ### 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_Patrol#AI_PATROL_ZONE.Start}**: Start the process.
+--   * **@{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.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.RTB}**: Route the AI to the home base.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.Detect}**: The AI is detecting targets.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.Detected}**: The AI has detected new targets.
+--   * **@{#AI_CAP_ZONE.Destroy}**: The AI has destroyed a bogey @{Unit}.
+--   * **@{#AI_CAP_ZONE.Destroyed}**: The AI has destroyed all bogeys @{Unit}s assigned in the CAS task.
 --   * **Status** ( Group ): The AI is checking status (fuel and damage). When the tresholds have been reached, the AI will RTB.
 --
 -- ## 3. Set the Range of Engagement
@@ -106,7 +118,7 @@
 -- that will define when the AI will engage with the detected airborne enemy targets.
 -- The range can be beyond or smaller than the range of the Patrol Zone.
 -- The range is applied at the position of the AI.
--- Use the method @{AI.AI_CAP#AI_CAP_ZONE.SetEngageRange}() to define that range.
+-- Use the method @{AI_CAP#AI_CAP_ZONE.SetEngageRange}() to define that range.
 --
 -- ## 4. Set the Zone of Engagement
 -- 
@@ -114,7 +126,7 @@
 -- 
 -- An optional @{Zone} can be set, 
 -- that will define when the AI will engage with the detected airborne enemy targets.
--- Use the method @{AI.AI_Cap#AI_CAP_ZONE.SetEngageZone}() to define that Zone.
+-- Use the method @{AI_Cap#AI_CAP_ZONE.SetEngageZone}() to define that Zone.
 --  
 -- ===
 -- 
@@ -128,11 +140,11 @@ AI_CAP_ZONE = {
 --- Creates a new AI_CAP_ZONE object
 -- @param #AI_CAP_ZONE self
 -- @param Core.Zone#ZONE_BASE PatrolZone The @{Zone} where the patrol needs to be executed.
--- @param DCS#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
--- @param DCS#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
--- @param DCS#Speed  PatrolMinSpeed The minimum speed of the @{Wrapper.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
+-- @param Dcs.DCSTypes#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
+-- @param Dcs.DCSTypes#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
+-- @param Dcs.DCSTypes#Speed  PatrolMinSpeed The minimum speed of the @{Controllable} in km/h.
+-- @param Dcs.DCSTypes#Speed  PatrolMaxSpeed The maximum speed of the @{Controllable} in km/h.
+-- @param Dcs.DCSTypes#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 )
 

Moose Development/Moose/AI/AI_CAS.lua

@@ -1,48 +1,63 @@
---- **AI** -- Perform Close Air Support (CAS) near friendlies.
+--- **AI** -- **Provide Close Air Support to friendly ground troops.**
 --
--- **Features:**
+-- ![Banner Image](..\Presentations\AI_CAS\Dia1.JPG)
 -- 
---   * 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.
+-- ===
+-- 
+-- AI CAS classes makes AI Controllables execute a Close Air Support.
+-- 
+-- There are the following types of CAS classes defined:
+-- 
+--   * @{#AI_CAS_ZONE}: Perform a CAS in a zone.
+--   
+-- ====
+-- 
+-- # Demo Missions
+-- 
+-- ### [AI_CAS Demo Missions source code](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/CAS%20-%20Close%20Air%20Support)
+-- 
+-- ### [AI_CAS Demo Missions, only for beta testers](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/CAS%20-%20Close%20Air%20Support)
 --
--- ===
+-- ### [ALL Demo Missions pack of the last release](https://github.com/FlightControl-Master/MOOSE_MISSIONS/releases)
 -- 
--- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/CAS%20-%20Close%20Air%20Support)
+-- ====
 -- 
--- ===
+-- # YouTube Channel
 -- 
--- ### [YouTube Playlist](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl3JBO1WDqqpyYRRmIkR2ir2)
+-- ### [AI_CAS YouTube Channel](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl3JBO1WDqqpyYRRmIkR2ir2)
 -- 
--- ===
+-- ====
+--
+-- 
+-- ### Author: **Sven Van de Velde (FlightControl)**
 -- 
--- ### Author: **FlightControl**
 -- ### Contributions: 
 --
 --   * **[Quax](https://forums.eagle.ru/member.php?u=90530)**: Concept, Advice & Testing.
 --   * **[Pikey](https://forums.eagle.ru/member.php?u=62835)**: Concept, Advice & Testing.
 --   * **[Gunterlund](http://forums.eagle.ru:8080/member.php?u=75036)**: Test case revision.
 --
--- ===
+-- ====
 --
--- @module AI.AI_Cas
--- @image AI_Close_Air_Support.JPG
+-- @module AI_Cas
+
 
 --- AI_CAS_ZONE class
 -- @type AI_CAS_ZONE
--- @field Wrapper.Controllable#CONTROLLABLE AIControllable The @{Wrapper.Controllable} patrolling.
+-- @field Wrapper.Controllable#CONTROLLABLE AIControllable The @{Controllable} patrolling.
 -- @field Core.Zone#ZONE_BASE TargetZone The @{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 @{Zone} by an AIR @{Wrapper.Controllable} or @{Wrapper.Group}.
+--- # AI_CAS_ZONE class, extends @{AI_Patrol#AI_PATROL_ZONE}
+-- 
+-- AI_CAS_ZONE derives from the @{AI_Patrol#AI_PATROL_ZONE}, inheriting its methods and behaviour.
+--  
+-- The AI_CAS_ZONE class implements the core functions to provide Close Air Support in an Engage @{Zone} by an AIR @{Controllable} or @{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.
+-- The AI_CAS_ZONE is assigned a @{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)
 -- 
@@ -108,15 +123,15 @@
 -- 
 -- ### 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_Patrol#AI_PATROL_ZONE.Start}**: Start the process.
+--   * **@{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.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.RTB}**: Route the AI to the home base.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.Detect}**: The AI is detecting targets.
+--   * **@{AI_Patrol#AI_PATROL_ZONE.Detected}**: The AI has detected new targets.
+--   * **@{#AI_CAS_ZONE.Destroy}**: The AI has destroyed a target @{Unit}.
+--   * **@{#AI_CAS_ZONE.Destroyed}**: The AI has destroyed all target @{Unit}s assigned in the CAS task.
 --   * **Status**: The AI is checking status (fuel and damage). When the tresholds have been reached, the AI will RTB.
 -- 
 -- ===
@@ -131,12 +146,12 @@ AI_CAS_ZONE = {
 --- Creates a new AI_CAS_ZONE object
 -- @param #AI_CAS_ZONE self
 -- @param Core.Zone#ZONE_BASE PatrolZone The @{Zone} where the patrol needs to be executed.
--- @param DCS#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
--- @param DCS#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
--- @param DCS#Speed  PatrolMinSpeed The minimum speed of the @{Wrapper.Controllable} in km/h.
--- @param DCS#Speed  PatrolMaxSpeed The maximum speed of the @{Wrapper.Controllable} in km/h.
+-- @param Dcs.DCSTypes#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
+-- @param Dcs.DCSTypes#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
+-- @param Dcs.DCSTypes#Speed  PatrolMinSpeed The minimum speed of the @{Controllable} in km/h.
+-- @param Dcs.DCSTypes#Speed  PatrolMaxSpeed The maximum speed of the @{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
+-- @param Dcs.DCSTypes#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 )
 
@@ -172,24 +187,24 @@ function AI_CAS_ZONE:New( PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude
   -- @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. 
+  -- @param Dcs.DCSTypes#Distance EngageAltitude (optional) Desired altitude to perform the unit engagement.
+  -- @param Dcs.DCSTypes#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.
+  -- Use the structure @{DCSTypes#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.
+  -- @param Dcs.DCSTypes#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. 
+  -- @param Dcs.DCSTypes#Distance EngageAltitude (optional) Desired altitude to perform the unit engagement.
+  -- @param Dcs.DCSTypes#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.
+  -- Use the structure @{DCSTypes#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.
+  -- @param Dcs.DCSTypes#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
@@ -388,6 +403,7 @@ end
 -- @param #string Event The Event string.
 -- @param #string To The To State string.
 function AI_CAS_ZONE:onafterTarget( Controllable, From, Event, To )
+  self:E("onafterTarget")
 
   if Controllable:IsAlive() then
 
@@ -398,7 +414,7 @@ function AI_CAS_ZONE:onafterTarget( Controllable, From, Event, To )
       if DetectedUnit:IsAlive() then
         if DetectedUnit:IsInZone( self.EngageZone ) then
           if Detected == true then
-            self:F( {"Target: ", DetectedUnit } )
+            self:E( {"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 )
@@ -431,10 +447,10 @@ end
 -- @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 Dcs.DCSTypes#Distance EngageAltitude (optional) Desired altitude to perform the unit engagement.
+-- @param Dcs.DCSTypes#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.
+-- @param Dcs.DCSTypes#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, 
@@ -480,7 +496,7 @@ function AI_CAS_ZONE:onafterEngage( Controllable, From, Event, To,
       self:T( DetectedUnit )
       if DetectedUnit:IsAlive() then
         if DetectedUnit:IsInZone( self.EngageZone ) then
-          self:F( {"Engaging ", DetectedUnit } )
+          self:E( {"Engaging ", DetectedUnit } )
           AttackTasks[#AttackTasks+1] = Controllable:TaskAttackUnit( DetectedUnit, 
                                                                      true, 
                                                                      EngageWeaponExpend, 

Moose Development/Moose/AI/AI_Cargo.lua

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

Moose Development/Moose/AI/AI_Cargo_APC.lua

@@ -1,488 +0,0 @@
---- **AI** -- (R2.4) - Models the intelligent transportation of infantry and other cargo.
---
--- ===
--- 
--- ### 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.
--- 
--- 
--- 
--- @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( "*", "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 )
-  CargoCarrier:HandleEvent( EVENTS.Hit )
-  
-  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
-  
-  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
-
-
---- 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()
-          self.Zone:Scan( { Object.Category.UNIT } )
-          if self.Zone:IsAllInZoneOfCoalition( self.Coalition ) then
-            if self:Is( "Unloaded" ) or self:Is( "Following" ) then
-              -- There are no enemies within combat radius. Load the CargoCarrier.
-              self:Load()
-            end
-          else
-            if self:Is( "Loaded" ) then
-              -- There are enemies within combat radius. Unload the CargoCarrier.
-              self:__Unload( 1 )
-            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
-      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
-
-
---- @param #AI_CARGO_APC 
--- @param Wrapper.Group#GROUP APC
-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
-
-
-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
-      
-      local Waypoints = APC:TaskGroundOnRoad( Coordinate, _speed, "Line abreast", true )
-  
-      local TaskFunction = APC:TaskFunction( "AI_CARGO_APC._Pickup", self, Coordinate, Speed, PickupZone )
-      
-      self:F({Waypoints = Waypoints})
-      local Waypoint = Waypoints[#Waypoints]
-      APC:SetTaskWaypoint( Waypoint, TaskFunction ) -- Set for the given Route at Waypoint 2 the TaskRouteToZone.
-    
-      APC:Route( Waypoints, 1 ) -- Move after a random seconds to the Route. See the Route method for details.
-    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
-    
-    local _speed=Speed or APC:GetSpeedMax()*0.5
-     
-    local Waypoints = APC:TaskGroundOnRoad( Coordinate, _speed, "Line abreast", true )
-
-    local TaskFunction = APC:TaskFunction( "AI_CARGO_APC._Deploy", self, Coordinate, DeployZone )
-    
-    self:F({Waypoints = Waypoints})
-    local Waypoint = Waypoints[#Waypoints]
-    APC:SetTaskWaypoint( Waypoint, TaskFunction ) -- Set for the given Route at Waypoint 2 the TaskRouteToZone.
-  
-    APC:Route( Waypoints, 1 ) -- Move after a random seconds to the Route. See the Route method for details.
-
-    self:GetParent( self, AI_CARGO_APC ).onafterDeploy( self, APC, From, Event, To, Coordinate, Speed, Height, DeployZone )
-
-  end
-  
-end
-
---- On after 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 )
-  self:F( { APC, From, Event, To, DeployZone = DeployZone } )
-
-  self:__Guard( 0.1 )
-
-  self:GetParent( self, AI_CARGO_APC ).onafterDeployed( self, APC, From, Event, To, DeployZone )
-
-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,484 +0,0 @@
---- **AI** -- (R2.4) - Models the intelligent transportation of infantry (cargo).
---
--- ===
--- 
--- ### 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 ... 
--- 
--- 
--- @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 plane.
-  -- @param #string From
-  -- @param #string Event
-  -- @param #string To
-  -- @param Wrapper.Airbase#AIRBASE Airbase Airbase where troops are picked up.
-  -- @param #number Speed in km/h for travelling to pickup base.
-  
-  --- Pickup Trigger for AI_CARGO_AIRPLANE
-  -- @function [parent=#AI_CARGO_AIRPLANE] Pickup
-  -- @param #AI_CARGO_AIRPLANE self
-  -- @param Wrapper.Airbase#AIRBASE Airbase Airbase where troops are picked up.
-  -- @param #number Speed in km/h for travelling to pickup base.
-  
-  --- Pickup Asynchronous Trigger for AI_CARGO_AIRPLANE
-  -- @function [parent=#AI_CARGO_AIRPLANE] __Pickup
-  -- @param #AI_CARGO_AIRPLANE self
-  -- @param #number Delay Delay in seconds.
-  -- @param Wrapper.Airbase#AIRBASE Airbase Airbase where troops are picked up.
-  -- @param #number Speed in km/h for travelling to pickup base.
-  
-  --- Deploy Handler OnBefore for AI_CARGO_AIRPLANE
-  -- @function [parent=#AI_CARGO_AIRPLANE] OnBeforeDeploy
-  -- @param #AI_CARGO_AIRPLANE self
-  -- @param Wrapper.Group#GROUP Airplane Cargo plane.
-  -- @param #string From
-  -- @param #string Event
-  -- @param #string To
-  -- @param Wrapper.Airbase#AIRBASE Airbase Destination airbase where troops are deployed.
-  -- @param #number Speed Speed in km/h for travelling to deploy base.
-  -- @return #boolean
-  
-  --- Deploy Handler OnAfter for AI_CARGO_AIRPLANE
-  -- @function [parent=#AI_CARGO_AIRPLANE] OnAfterDeploy
-  -- @param #AI_CARGO_AIRPLANE self
-  -- @param Wrapper.Group#GROUP Airplane Cargo plane.
-  -- @param #string From
-  -- @param #string Event
-  -- @param #string To
-  -- @param Wrapper.Airbase#AIRBASE Airbase Destination airbase where troops are deployed.
-  -- @param #number Speed Speed in km/h for travelling to deploy base.
-  
-  --- Deploy Trigger for AI_CARGO_AIRPLANE
-  -- @function [parent=#AI_CARGO_AIRPLANE] Deploy
-  -- @param #AI_CARGO_AIRPLANE self
-  -- @param Wrapper.Airbase#AIRBASE Airbase Destination airbase where troops are deployed.
-  -- @param #number Speed Speed in km/h for travelling to deploy base.
-  
-  --- Deploy Asynchronous Trigger for AI_CARGO_AIRPLANE
-  -- @function [parent=#AI_CARGO_AIRPLANE] __Deploy
-  -- @param #AI_CARGO_AIRPLANE self
-  -- @param #number Delay Delay in seconds.
-  -- @param Wrapper.Airbase#AIRBASE Airbase Destination airbase where troops are deployed.
-  -- @param #number Speed Speed in km/h for travelling to deploy base.
-
-  --- On after Loaded event, i.e. triggered when the cargo is inside the carrier.
-  -- @function [parent=#AI_CARGO_AIRPLANE] OnAfterLoaded
-  -- @param #AI_CARGO_AIRPLANE self
-  -- @param Wrapper.Group#GROUP Airplane Cargo plane.
-  -- @param From
-  -- @param Event
-  -- @param To
-  
-  -- Set carrier. 
-  self:SetCarrier( Airplane )
-  
-  return self
-end
-
-
---- Set the Carrier (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
--- @param #number Speed in km/h for travelling to pickup base.
--- @param #number Height Height in meters to move to the pickup coordinate.
--- @param Core.Zone#ZONE_AIRBASE (optional) PickupZone The zone where the cargo will be picked up.
-function AI_CARGO_AIRPLANE:onafterPickup( Airplane, From, Event, To, Coordinate, Speed, Height, PickupZone )
-
-  if Airplane and Airplane:IsAlive() then
-    
-    self.PickupZone = PickupZone
-  
-    -- Get closest airbase of current position.
-    local ClosestAirbase, DistToAirbase=Airplane:GetCoordinate():GetClosestAirbase()
-  
-    -- Two cases. Aircraft spawned in air or at an airbase.
-    if Airplane:InAir() then
-      self.Airbase=nil  --> route will start in air
-    else      
-      self.Airbase=ClosestAirbase
-    end
-    
-    -- Set pickup airbase.
-    local Airbase = PickupZone:GetAirbase()
-    
-    -- Distance from closest to pickup airbase ==> we need to know if we are already at the pickup airbase. 
-    local Dist = Airbase:GetCoordinate():Get2DDistance(ClosestAirbase:GetCoordinate())
-    --env.info("Distance closest to pickup airbase = "..Dist)
-    
-    if Airplane:InAir() or Dist>500 then
-    
-      -- Route aircraft to pickup airbase.
-      self:Route( Airplane, Airbase, Speed, Height ) 
-          
-      -- Set airbase as starting point in the next Route() call.
-      self.Airbase = Airbase
-      
-      -- Aircraft is on a pickup mission.
-      self.RoutePickup = true
-      
-    else
-    
-      -- We are already at the right airbase ==> Landed ==> triggers loading of troops. Is usually called at engine shutdown event.
-      self.RoutePickup=true
-      self:Landed()
-      
-    end
-
-    self:GetParent( self, AI_CARGO_AIRPLANE ).onafterPickup( self, Airplane, From, Event, To, Coordinate, Speed, Height, PickupZone )
-    
-  end
-
-  
-end
-
---- On after Depoly event. Routes plane to the airbase where the troops are deployed.
--- @param #AI_CARGO_AIRPLANE self
--- @param Wrapper.Group#GROUP Airplane Cargo transport plane.
--- @param #string From From state.
--- @param #string Event Event.
--- @param #string To To state.
--- @param Core.Point#COORDINATE Coordinate
--- @param #number Speed in km/h for travelling to pickup base.
--- @param #number Height Height in meters to move to the home coordinate.
--- @param Core.Zone#ZONE_AIRBASE DeployZone The zone where the cargo will be deployed.
-function AI_CARGO_AIRPLANE:onafterDeploy( Airplane, From, Event, To, Coordinate, Speed, Height, DeployZone )
-
-  if Airplane and Airplane:IsAlive()~=nil then
-    
-    local Airbase = DeployZone:GetAirbase()
-    
-    -- Activate uncontrolled airplane.
-    if Airplane:IsAlive()==false then
-      Airplane:SetCommand({id = 'Start', params = {}})
-    end
-    
-    -- Route to destination airbase.
-    self:Route( Airplane, Airbase, Speed, Height )
-    
-    -- Aircraft is on a depoly mission.
-    self.RouteDeploy = true
-    
-    -- Set destination airbase for next :Route() command.
-    self.Airbase = Airbase
-    
-    self:GetParent( self, AI_CARGO_AIRPLANE ).onafterDeploy( self, Airplane, From, Event, To, Coordinate, Speed, Height, DeployZone )
-  end
-  
-end
-
-
---- On after Unload event. Cargo is beeing unloaded, i.e. the unboarding process is started.
--- @param #AI_CARGO_AIRPLANE self
--- @param Wrapper.Group#GROUP Airplane Cargo transport plane.
--- @param #string From From state.
--- @param #string Event Event.
--- @param #string To To state.
-function AI_CARGO_AIRPLANE:onafterUnload( Airplane, From, Event, To, DeployZone )
-
-  local UnboardInterval = 10
-  local UnboardDelay = 10
-
-  if Airplane and Airplane:IsAlive() then
-    for _, 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
-    )    
-    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,209 +0,0 @@
---- **AI** -- (2.4) - 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.   
--- 
--- ===
--- 
--- @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
-
-function AI_CARGO_DISPATCHER_APC:AICargo( APC, CargoSet )
-
-  return AI_CARGO_APC:New( APC, CargoSet, self.CombatRadius )
-end
-
---- Enable/Disable unboarding of cargo (infantry) when enemies are nearby (to help defend the carrier).
--- This is only valid for APCs and trucks etc, thus ground vehicles.
--- @param #AI_CARGO_DISPATCHER_APC self
--- @param #number CombatRadius Provide the combat radius to defend the carrier by unboarding the cargo when enemies are nearby. 
--- When the combat radius is 0, no defense will happen of the carrier. 
--- When the combat radius is not provided, no defense will happen!
--- @return #AI_CARGO_DISPATCHER_APC
--- @usage
--- 
--- -- Disembark the infantry when the carrier is under attack.
--- AICargoDispatcher:SetCombatRadius( true )
--- 
--- -- Keep the cargo in the carrier when the carrier is under attack.
--- AICargoDispatcher:SetCombatRadius( false )
-function AI_CARGO_DISPATCHER_APC:SetCombatRadius( CombatRadius )
-
-  self.CombatRadius = CombatRadius or 0
-
-  return self
-end
-

Moose Development/Moose/AI/AI_Cargo_Dispatcher_Airplane.lua

@@ -1,164 +0,0 @@
---- **AI** -- (R2.4) - Models the intelligent transportation of infantry and other cargo using Planes.
---
--- ## Features:
---
---   * The airplanes will fly towards the pickup airbases to pickup the cargo.
---   * The airplanes will fly towards the deploy airbases to deploy the cargo.
---   
--- ===
--- 
--- ## Test Missions:
--- 
--- Test missions can be located on the main GITHUB site.
--- 
--- [FlightControl-Master/MOOSE_MISSIONS/AID - AI Dispatching/AID-CGO - AI Cargo Dispatching/]  
--- (https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/AID%20-%20AI%20Dispatching/AID-CGO%20-%20AI%20Cargo%20Dispatching)
--- 
--- ===
--- 
--- ### Author: **FlightControl**
--- 
--- ===       
---
--- @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!**
--- 
--- 
--- 
--- @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,191 +0,0 @@
---- **AI** -- (2.4) - Models the intelligent transportation of infantry and other cargo using Helicopters.
---
--- ## Features:
--- 
---   * The helicopters will fly towards the pickup locations to pickup the cargo.
---   * The helicopters will fly towards the deploy zones to deploy the cargo.
---   * Precision deployment as well as randomized deployment within the deploy zones are possible.
---   * Helicopters will orbit the deploy zones when there is no space for landing until the deploy zone is free.
---   
--- ===
--- 
--- ## Test Missions:
--- 
--- Test missions can be located on the main GITHUB site.
--- 
--- [FlightControl-Master/MOOSE_MISSIONS/AID - AI Dispatching/AID-CGO - AI Cargo Dispatching/]  
--- (https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/AID%20-%20AI%20Dispatching/AID-CGO%20-%20AI%20Cargo%20Dispatching)
--- 
--- ===
--- 
--- ### Author: **FlightControl**
--- 
--- ===       
---
--- @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.   
--- 
--- ===
--- 
--- @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( 0, 0 )
-  self:SetDeployRadius( 0, 0 )
-  
-  self:SetPickupHeight( 500, 200 )
-  self:SetDeployHeight( 500, 200 )
-  
-  return self
-end
-
-
-function AI_CARGO_DISPATCHER_HELICOPTER:AICargo( Helicopter, CargoSet )
-
-  return AI_CARGO_HELICOPTER:New( Helicopter, CargoSet )
-end
-

Moose Development/Moose/AI/AI_Cargo_Helicopter.lua

@@ -1,625 +0,0 @@
---- **AI** -- (R2.4) - Models the intelligent transportation of infantry (cargo).
---
--- ===
--- 
--- ### 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 APCs, the infantry is actually respawned into the battlefield. 
--- As a result, the unboarding infantry is very _healthy_ every time it unboards.
--- This is due to the limitation of the DCS simulator, which is not able to specify the health of new spawned units as a parameter.
--- However, infantry that was destroyed when unboarded, won't be respawned again. Destroyed is destroyed.
--- As a result, there is some additional strength that is gained when an unboarding action happens, but in terms of simulation balance this has
--- marginal impact on the overall battlefield simulation. Fortunately, the firing strength of infantry is limited, and thus, respacing healthy infantry every
--- time is not so much of an issue ... 
--- 
--- 
--- ===
--- 
--- @field #AI_CARGO_HELICOPTER
-AI_CARGO_HELICOPTER = {
-  ClassName = "AI_CARGO_HELICOPTER",
-  Coordinate = nil, -- Core.Point#COORDINATE,
-}
-
-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" ) 
-  
-  self:AddTransition( "Unloaded", "Pickup", "*" )
-  self:AddTransition( "Loaded", "Deploy", "*" )
-  
-  self:AddTransition( { "Unloaded", "Loading" }, "Load", "Boarding" )
-  self:AddTransition( "Boarding", "Board", "Boarding" )
-  self:AddTransition( "Boarding", "Loaded", "Boarding" )
-  self:AddTransition( "Boarding", "PickedUp", "Loaded" )
-  self:AddTransition( "Loaded", "Unload", "Unboarding" )
-  self:AddTransition( "Unboarding", "Unboard", "Unboarding" )
-  self:AddTransition( "Unboarding", "Unloaded", "Unboarding" )
-  self:AddTransition( "Unboarding", "Deployed", "Unloaded" )
-
-  self:AddTransition( "*", "Landed", "*" )
-  self:AddTransition( "*", "Queue", "*" )
-  self:AddTransition( "*", "Orbit" , "*" ) 
-  self:AddTransition( "*", "Home" , "*" ) 
-  
-  self:AddTransition( "*", "Destroyed", "Destroyed" )
-
-  --- 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 drive to the pickup coordinate. Default is 50% of max possible speed the unit can go.
-  
-  --- Pickup Trigger for AI_CARGO_HELICOPTER
-  -- @function [parent=#AI_CARGO_HELICOPTER] Pickup
-  -- @param #AI_CARGO_HELICOPTER self
-  -- @param Core.Point#COORDINATE Coordinate
-  -- @param #number Speed Speed in km/h to drive to the pickup coordinate. Default is 50% of max possible speed the unit can go.
-  
-  --- Pickup Asynchronous Trigger for AI_CARGO_HELICOPTER
-  -- @function [parent=#AI_CARGO_HELICOPTER] __Pickup
-  -- @param #AI_CARGO_HELICOPTER self
-  -- @param #number Delay 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 drive to the pickup coordinate. Default is 50% of max possible speed the unit can go.
-  -- @return #boolean
-  
-  --- Deploy Handler OnAfter for AI_CARGO_HELICOPTER
-  -- @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 drive to the pickup coordinate. Default is 50% of max possible speed the unit can go.
-  
-  --- Deploy Trigger for AI_CARGO_HELICOPTER
-  -- @function [parent=#AI_CARGO_HELICOPTER] Deploy
-  -- @param #AI_CARGO_HELICOPTER self
-  -- @param Core.Point#COORDINATE Coordinate Place at which the cargo is deployed.
-  -- @param #number Speed Speed in km/h to drive to the pickup coordinate. Default is 50% of max possible speed the unit can go.
-  
-  --- Deploy Asynchronous Trigger for AI_CARGO_HELICOPTER
-  -- @function [parent=#AI_CARGO_HELICOPTER] __Deploy
-  -- @param #number Delay Delay in seconds.
-  -- @param #AI_CARGO_HELICOPTER self
-  -- @param Core.Point#COORDINATE Coordinate Place at which the cargo is deployed.
-  -- @param #number Speed Speed in km/h to drive to the pickup coordinate. Default is 50% of max possible speed the unit can go.
-  
-
-  -- We need to capture the Crash events for the helicopters.
-  -- The helicopter reference is used in the semaphore AI_CARGO_QUEUE.
-  -- 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 )
-  
-  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
-
-
---- @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 )
-
-  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< 5.
-    -- Only then the infantry can unload (and load too, for consistency)!
-
-    self:F( { Helicopter:GetName(), Height = Helicopter:GetHeight( true ), Velocity = Helicopter:GetVelocityKMH() } )
-
-    if self.RoutePickup == true then
-      if Helicopter:GetHeight( true ) <= 5 and Helicopter:GetVelocityKMH() < 10 then
-        --self:Load( Helicopter:GetPointVec2() )
-        self:Load( self.PickupZone )
-        self.RoutePickup = false
-      end
-    end
-    
-    if self.RouteDeploy == true then
-      if Helicopter:GetHeight( true ) <= 5 and Helicopter:GetVelocityKMH() < 10 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 )
-
-  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 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 )
-
-  if Helicopter and Helicopter:IsAlive() then
-    
-    local Route = {}
-    
---          local CoordinateFrom = Helicopter:GetCoordinate()
---          local WaypointFrom = CoordinateFrom:WaypointAir( 
---            "RADIO", 
---            POINT_VEC3.RoutePointType.TurningPoint, 
---            POINT_VEC3.RoutePointAction.TurningPoint, 
---            Speed, 
---            true 
---          )
---          Route[#Route+1] = WaypointFrom
-    local CoordinateTo   = Coordinate
-    local WaypointTo = CoordinateTo:WaypointAir( 
-      "RADIO", 
-      POINT_VEC3.RoutePointType.TurningPoint, 
-      POINT_VEC3.RoutePointAction.TurningPoint, 
-      50, 
-      true 
-    )
-    Route[#Route+1] = WaypointTo
-    
-    local Tasks = {}
-    Tasks[#Tasks+1] = Helicopter:TaskOrbitCircle( math.random( 30, 80 ), 150, CoordinateTo:GetRandomCoordinateInRadius( 800, 500 ) )
-    Route[#Route].task = Helicopter:TaskCombo( Tasks )
-
-    Route[#Route+1] = WaypointTo
-
-    -- Now route the helicopter
-    Helicopter:Route( Route, 0 )
-  end
-end
-
-
-
---- 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( { Helicopter, 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 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_HELICOPTER:onafterPickup( Helicopter, From, Event, To, 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()
-    local CoordinateTo   = Coordinate
-
-    --- 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 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 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 deploy coordinate.
-function AI_CARGO_HELICOPTER:onafterDeploy( Helicopter, 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 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 = {}
-    
-    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 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 HomeZone The zone wherein the carrier will return when all cargo has been transported. This can be any zone type, like a ZONE, ZONE_GROUP, ZONE_AIRBASE.
-function AI_CARGO_HELICOPTER:onafterHome( Helicopter, From, Event, To, Coordinate, Speed, Height, HomeZone )
-
-  if Helicopter and Helicopter:IsAlive() ~= nil then
-
-    self.RouteHome = true
-     
-    local Route = {}
-    
-    --- Calculate the target route point.
-
-    Coordinate.y = Height
-    
-    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 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_Formation.lua

@@ -1,34 +1,64 @@
---- **AI** -- Build large airborne formations of aircraft.
+--- **AI** -- Build large **formations** of AI @{Group}s flying together.
 -- 
--- **Features:**
+-- ![Banner Image](..\Presentations\AI_FORMATION\Dia1.JPG)
+-- 
+-- ===
+-- 
+-- AI_FORMATION makes AI @{GROUP}s fly in formation of various compositions.
+-- The AI_FORMATION class models formations in a different manner than the internal DCS formation logic!!!
+-- The purpose of the class is to:
+-- 
+--   * Make formation building a process that can be managed while in flight, rather than a task.
+--   * Human players can guide formations, consisting of larget planes.
+--   * Build large formations (like a large bomber field).
+--   * Form formations that DCS does not support off the shelve.
+-- 
+-- A few remarks:
+-- 
+--   * Depending on the type of plane, the change in direction by the leader may result in the formation getting disentangled while in flight and needs to be rebuild.
+--   * Formations are vulnerable to collissions, but is depending on the type of plane, the distance between the planes and the speed and angle executed by the leader.
+--   * Formations may take a while to build up.
+-- 
+-- As a result, the AI_FORMATION is not perfect, but is very useful to:
+-- 
+--   * Model large formations when flying straight line.
+--   * Make humans guide a large formation, when the planes are wide from each other.
+-- 
+-- There are the following types of classes defined:
+-- 
+--   * @{#AI_FORMATION}: Create a formation from several @{GROUP}s.
+--   
+-- ====
+-- 
+-- # Demo Missions
+-- 
+-- ### [AI_FORMATION Demo Missions source code]()
+-- 
+-- ### [AI_FORMATION Demo Missions, only for beta testers]()
 --
---   * Build in-air formations consisting of more than 40 aircraft as one group.
---   * Build different formation types.
---   * Assign a group leader that will guide the large formation path.
+-- ### [ALL Demo Missions pack of the last release]()
+-- 
+-- ====
+-- 
+-- # YouTube Channel
+-- 
+--- ### [AI_FORMATION YouTube Channel]()
 -- 
 -- ===
 -- 
--- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/FOR%20-%20Formation)
+-- ### Author: **Sven Van de Velde (FlightControl)**
 -- 
--- ===
--- 
--- ### [YouTube Playlist](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl0bFIJ9jIdYM22uaWmIN4oz)
--- 
--- ===
--- 
--- ### Author: **FlightControl**
 -- ### Contributions: 
 -- 
--- ===
+-- ====
 --   
--- @module AI.AI_Formation
--- @image AI_Large_Formations.JPG
+-- @module AI_Formation
 
 --- AI_FORMATION class
 -- @type AI_FORMATION
--- @extends Core.Fsm#FSM_SET
--- @field Wrapper.Unit#UNIT FollowUnit
--- @field Core.Set#SET_GROUP FollowGroupSet
+-- @extends Fsm#FSM_SET
+-- @field Unit#UNIT FollowUnit
+-- @field Set#SET_GROUP FollowGroupSet
 -- @field #string FollowName
 -- @field #AI_FORMATION.MODE FollowMode The mode the escort is in.
 -- @field Scheduler#SCHEDULER FollowScheduler The instance of the SCHEDULER class.
@@ -36,9 +66,12 @@
 -- @field #boolean ReportTargets If true, nearby targets are reported.
 -- @Field DCSTypes#AI.Option.Air.val.ROE OptionROE Which ROE is set to the FollowGroup.
 -- @field DCSTypes#AI.Option.Air.val.REACTION_ON_THREAT OptionReactionOnThreat Which REACTION_ON_THREAT is set to the FollowGroup.
+-- @field Menu#MENU_CLIENT FollowMenuResumeMission
 
 
---- Build large formations, make AI follow a @{Wrapper.Client#CLIENT} (player) leader or a @{Wrapper.Unit#UNIT} (AI) leader.
+--- # AI_FORMATION class, extends @{Fsm#FSM_SET}
+-- 
+-- The #AI_FORMATION class allows you to build large formations, make AI follow a @{Client#CLIENT} (player) leader or a @{Unit#UNIT} (AI) leader.
 --
 -- AI_FORMATION makes AI @{GROUP}s fly in formation of various compositions.
 -- The AI_FORMATION class models formations in a different manner than the internal DCS formation logic!!!
@@ -64,25 +97,25 @@
 -- 
 -- Create a new SPAWN object with the @{#AI_FORMATION.New} method:
 --
---   * @{#AI_FORMATION.New}(): Creates a new AI_FORMATION object from a @{Wrapper.Group#GROUP} for a @{Wrapper.Client#CLIENT} or a @{Wrapper.Unit#UNIT}, with an optional briefing text.
+--   * @{Follow#AI_FORMATION.New}(): Creates a new AI_FORMATION object from a @{Group#GROUP} for a @{Client#CLIENT} or a @{Unit#UNIT}, with an optional briefing text.
 --
 -- ## Formation methods
 -- 
 -- The following methods can be used to set or change the formation:
 -- 
---  * @{#AI_FORMATION.FormationLine}(): Form a line formation (core formation function).
---  * @{#AI_FORMATION.FormationTrail}(): Form a trail formation.
---  * @{#AI_FORMATION.FormationLeftLine}(): Form a left line formation.
---  * @{#AI_FORMATION.FormationRightLine}(): Form a right line formation.
---  * @{#AI_FORMATION.FormationRightWing}(): Form a right wing formation.
---  * @{#AI_FORMATION.FormationLeftWing}(): Form a left wing formation.
---  * @{#AI_FORMATION.FormationCenterWing}(): Form a center wing formation.
---  * @{#AI_FORMATION.FormationCenterVic}(): Form a Vic formation (same as CenterWing.
---  * @{#AI_FORMATION.FormationCenterBoxed}(): Form a center boxed formation.
+--  * @{AI_Formation#AI_FORMATION.FormationLine}(): Form a line formation (core formation function).
+--  * @{AI_Formation#AI_FORMATION.FormationTrail}(): Form a trail formation.
+--  * @{AI_Formation#AI_FORMATION.FormationLeftLine}(): Form a left line formation.
+--  * @{AI_Formation#AI_FORMATION.FormationRightLine}(): Form a right line formation.
+--  * @{AI_Formation#AI_FORMATION.FormationRightWing}(): Form a right wing formation.
+--  * @{AI_Formation#AI_FORMATION.FormationLeftWing}(): Form a left wing formation.
+--  * @{AI_Formation#AI_FORMATION.FormationCenterWing}(): Form a center wing formation.
+--  * @{AI_Formation#AI_FORMATION.FormationCenterVic}(): Form a Vic formation (same as CenterWing.
+--  * @{AI_Formation#AI_FORMATION.FormationCenterBoxed}(): Form a center boxed formation.
 --  
 -- ## Randomization
 -- 
--- Use the method @{AI.AI_Formation#AI_FORMATION.SetFlightRandomization}() to simulate the formation flying errors that pilots make while in formation. Is a range set in meters.
+-- Use the method @{AI_Formation#AI_FORMATION.SetFlightRandomization}() to simulate the formation flying errors that pilots make while in formation. Is a range set in meters.
 --
 -- @usage
 -- local FollowGroupSet = SET_GROUP:New():FilterCategories("plane"):FilterCoalitions("blue"):FilterPrefixes("Follow"):FilterStart()
@@ -122,7 +155,7 @@ AI_FORMATION = {
 
 --- AI_FORMATION class constructor for an AI group
 -- @param #AI_FORMATION self
--- @param Wrapper.Unit#UNIT FollowUnit The UNIT leading the FolllowGroupSet.
+-- @param Unit#UNIT FollowUnit The UNIT leading the FolllowGroupSet.
 -- @param Core.Set#SET_GROUP FollowGroupSet The group AI escorting the FollowUnit.
 -- @param #string FollowName Name of the escort.
 -- @return #AI_FORMATION self
@@ -130,8 +163,8 @@ function AI_FORMATION:New( FollowUnit, FollowGroupSet, FollowName, FollowBriefin
   local self = BASE:Inherit( self, FSM_SET:New( FollowGroupSet ) )
   self:F( { FollowUnit, FollowGroupSet, FollowName } )
 
-  self.FollowUnit = FollowUnit -- Wrapper.Unit#UNIT
-  self.FollowGroupSet = FollowGroupSet -- Core.Set#SET_GROUP
+  self.FollowUnit = FollowUnit -- Unit#UNIT
+  self.FollowGroupSet = FollowGroupSet -- Set#SET_GROUP
   
   self:SetFlightRandomization( 2 )
   
@@ -646,11 +679,11 @@ end
 function AI_FORMATION:onafterFormationLine( FollowGroupSet, From , Event , To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace ) --R2.1
   self:F( { FollowGroupSet, From , Event ,To, XStart, XSpace, YStart, YSpace, ZStart, ZSpace } )
 
-  FollowGroupSet:Flush( self )
+  FollowGroupSet:Flush()
   
   local FollowSet = FollowGroupSet:GetSet()
   
-  local i = 1  --FF i=0 caused first unit to have no XSpace! Probably needs further adjustments. This is just a quick work around.
+  local i = 0
   
   for FollowID, FollowGroup in pairs( FollowSet ) do
   
@@ -881,7 +914,7 @@ function AI_FORMATION:onafterFormationBox( FollowGroupSet, From , Event , To, XS
 end
 
 
---- Use the method @{AI.AI_Formation#AI_FORMATION.SetFlightRandomization}() to make the air units in your formation randomize their flight a bit while in formation.
+--- Use the method @{AI_Formation#AI_FORMATION.SetFlightRandomization}() to make the air units in your formation randomize their flight a bit while in formation.
 -- @param #AI_FORMATION self
 -- @param #number FlightRandomization The formation flying errors that pilots can make while in formation. Is a range set in meters.
 -- @return #AI_FORMATION
@@ -968,7 +1001,7 @@ function AI_FORMATION:onenterFollowing( FollowGroupSet ) --R2.1
             local Alpha_R = ( Alpha_T < 0 ) and Alpha_T + 2 * math.pi or Alpha_T
             local Position = math.cos( Alpha_R )
             local GD = ( ( GDv.x )^2 + ( GDv.z )^2 ) ^ 0.5
-            local Distance = GD * Position + - CS * 0.5
+            local Distance = GD * Position + - CS * 0,5
       
             -- Calculate the group direction vector
             local GV = { x = GV2.x - CV2.x, y = GV2.y - CV2.y, z = GV2.z - CV2.z  }

Moose Development/Moose/AI/AI_Patrol.lua

@@ -1,10 +1,6 @@
---- **AI** -- Perform Air Patrolling for airplanes.
+--- **AI** -- **Air Patrolling or Staging.**
 -- 
--- **Features:**
--- 
---   * Patrol AI airplanes within a given zone.
---   * Trigger detected events when enemy airplanes are detected.
---   * Manage a fuel treshold to RTB on time.
+-- ![Banner Image](..\Presentations\AI_PATROL\Dia1.JPG)
 -- 
 -- ===
 -- 
@@ -14,43 +10,53 @@
 -- 
 --   * @{#AI_PATROL_ZONE}: Perform a PATROL in a zone.
 --   
--- ===
+-- ====
 -- 
--- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/PAT%20-%20Patrolling)
+-- # Demo Missions
 -- 
--- ===
+-- ### [AI_PATROL Demo Missions source code](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/PAT%20-%20Patrolling)
 -- 
--- ### [YouTube Playlist](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl35HvYZKA6G22WMt7iI3zky)
+-- ### [AI_PATROL Demo Missions, only for beta testers](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/PAT%20-%20Patrolling)
+--
+-- ### [ALL Demo Missions pack of the last release](https://github.com/FlightControl-Master/MOOSE_MISSIONS/releases)
 -- 
--- ===
+-- ====
 -- 
--- ### Author: **FlightControl**
+-- # YouTube Channel
+-- 
+-- ### [AI_PATROL YouTube Channel](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl35HvYZKA6G22WMt7iI3zky)
+-- 
+-- ====
+-- 
+-- ### Author: **Sven Van de Velde (FlightControl)**
 -- ### Contributions: 
 -- 
 --   * **[Dutch_Baron](https://forums.eagle.ru/member.php?u=112075)**: 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](https://forums.eagle.ru/member.php?u=62835)**: Testing and API concept review.
 -- 
--- ===
+-- ====
 -- 
--- @module AI.AI_Patrol
--- @image AI_Air_Patrolling.JPG
+-- @module AI_Patrol
+
 
 --- AI_PATROL_ZONE class
 -- @type AI_PATROL_ZONE
--- @field Wrapper.Controllable#CONTROLLABLE AIControllable The @{Wrapper.Controllable} patrolling.
+-- @field Wrapper.Controllable#CONTROLLABLE AIControllable The @{Controllable} patrolling.
 -- @field Core.Zone#ZONE_BASE PatrolZone The @{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
+-- @field Dcs.DCSTypes#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
+-- @field Dcs.DCSTypes#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
+-- @field Dcs.DCSTypes#Speed  PatrolMinSpeed The minimum speed of the @{Controllable} in km/h.
+-- @field Dcs.DCSTypes#Speed  PatrolMaxSpeed The maximum speed of the @{Controllable} in km/h.
+-- @field Functional.Spawn#SPAWN CoordTest
 -- @extends Core.Fsm#FSM_CONTROLLABLE
 
---- Implements the core functions to patrol a @{Zone} by an AI @{Wrapper.Controllable} or @{Wrapper.Group}.
+--- # AI_PATROL_ZONE class, extends @{Fsm#FSM_CONTROLLABLE}
+-- 
+-- The AI_PATROL_ZONE class implements the core functions to patrol a @{Zone} by an AI @{Controllable} or @{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.
+-- The AI_PATROL_ZONE is assigned a @{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)
 -- 
@@ -123,7 +129,7 @@
 --   * @{#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.
+-- Use the method @{#AI_PATROL_ZONE.GetDetectedUnits}() to obtain a list of the @{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.
@@ -155,11 +161,11 @@ AI_PATROL_ZONE = {
 --- Creates a new AI_PATROL_ZONE object
 -- @param #AI_PATROL_ZONE self
 -- @param Core.Zone#ZONE_BASE PatrolZone The @{Zone} where the patrol needs to be executed.
--- @param DCS#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
--- @param DCS#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
--- @param DCS#Speed  PatrolMinSpeed The minimum speed of the @{Wrapper.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
+-- @param Dcs.DCSTypes#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
+-- @param Dcs.DCSTypes#Altitude PatrolCeilingAltitude The highest altitude in meters where to execute the patrol.
+-- @param Dcs.DCSTypes#Speed  PatrolMinSpeed The minimum speed of the @{Controllable} in km/h.
+-- @param Dcs.DCSTypes#Speed  PatrolMaxSpeed The maximum speed of the @{Controllable} in km/h.
+-- @param Dcs.DCSTypes#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.
@@ -454,8 +460,8 @@ 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.
+-- @param Dcs.DCSTypes#Speed  PatrolMinSpeed The minimum speed of the @{Controllable} in km/h.
+-- @param Dcs.DCSTypes#Speed  PatrolMaxSpeed The maximum speed of the @{Controllable} in km/h.
 -- @return #AI_PATROL_ZONE self
 function AI_PATROL_ZONE:SetSpeed( PatrolMinSpeed, PatrolMaxSpeed )
   self:F2( { PatrolMinSpeed, PatrolMaxSpeed } )
@@ -468,8 +474,8 @@ 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.
+-- @param Dcs.DCSTypes#Altitude PatrolFloorAltitude The lowest altitude in meters where to execute the patrol.
+-- @param Dcs.DCSTypes#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 } )
@@ -562,18 +568,18 @@ function AI_PATROL_ZONE:SetDetectionZone( DetectionZone )
   end
 end
 
---- Gets a list of @{Wrapper.Unit#UNIT}s that were detected by the AI.
+--- Gets a list of @{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.
+-- It is up to the mission designer to use the @{Unit} class and methods to filter the targets.
 -- @param #AI_PATROL_ZONE self
--- @return #table The list of @{Wrapper.Unit#UNIT}s
+-- @return #table The list of @{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.
+--- Clears the list of @{Unit#UNIT}s that were detected by the AI.
 -- @param #AI_PATROL_ZONE self
 function AI_PATROL_ZONE:ClearDetectedUnits()
   self:F2()
@@ -590,6 +596,7 @@ end
 -- @return #AI_PATROL_ZONE self
 function AI_PATROL_ZONE:ManageFuel( PatrolFuelThresholdPercentage, PatrolOutOfFuelOrbitTime )
 
+  self.PatrolManageFuel = true
   self.PatrolFuelThresholdPercentage = PatrolFuelThresholdPercentage
   self.PatrolOutOfFuelOrbitTime = PatrolOutOfFuelOrbitTime
   
@@ -823,7 +830,7 @@ function AI_PATROL_ZONE:onafterStatus()
   
     local RTB = false
     
-    local Fuel = self.Controllable:GetFuelMin()
+    local Fuel = self.Controllable:GetUnit(1):GetFuel()
     if Fuel < self.PatrolFuelThresholdPercentage then
       self:E( self.Controllable:GetName() .. " is out of fuel:" .. Fuel .. ", RTB!" )
       local OldAIControllable = self.Controllable

Moose Development/Moose/Actions/Act_Account.lua

@@ -1,15 +1,15 @@
---- **Actions** - ACT_ACCOUNT_ classes **account for** (detect, count & report) various DCS events occuring on @{Wrapper.Unit}s.
+--- **Actions** - ACT_ACCOUNT_ classes **account for** (detect, count & report) various DCS events occuring on @{Unit}s.
 -- 
 -- ![Banner Image](..\Presentations\ACT_ACCOUNT\Dia1.JPG)
 -- 
 -- === 
 -- 
--- @module Actions.Account
--- @image MOOSE.JPG
+-- @module Account
+
 
 do -- ACT_ACCOUNT
   
-  --- # @{#ACT_ACCOUNT} FSM class, extends @{Core.Fsm#FSM_PROCESS}
+  --- # @{#ACT_ACCOUNT} FSM class, extends @{Fsm#FSM_PROCESS}
   -- 
   -- ## ACT_ACCOUNT state machine:  
   -- 
@@ -55,7 +55,7 @@ do -- ACT_ACCOUNT
   --     These state transition methods need to provide a return value, which is specified at the function description.
   --     
   -- @type ACT_ACCOUNT
-  -- @field Core.Set#SET_UNIT TargetSetUnit
+  -- @field Set#SET_UNIT TargetSetUnit
   -- @extends Core.Fsm#FSM_PROCESS
   ACT_ACCOUNT = { 
     ClassName = "ACT_ACCOUNT",
@@ -138,7 +138,7 @@ end -- ACT_ACCOUNT
 
 do -- ACT_ACCOUNT_DEADS
 
-  --- # @{#ACT_ACCOUNT_DEADS} FSM class, extends @{Core.Fsm.Account#ACT_ACCOUNT}
+  --- # @{#ACT_ACCOUNT_DEADS} FSM class, extends @{Fsm.Account#ACT_ACCOUNT}
   -- 
   -- The ACT_ACCOUNT_DEADS class accounts (detects, counts and reports) successful kills of DCS units.
   -- The process is given a @{Set} of units that will be tracked upon successful destruction.
@@ -151,7 +151,7 @@ do -- ACT_ACCOUNT_DEADS
   --   * @{#ACT_ACCOUNT_DEADS.New}(): Creates a new ACT_ACCOUNT_DEADS object.
   --   
   -- @type ACT_ACCOUNT_DEADS
-  -- @field Core.Set#SET_UNIT TargetSetUnit
+  -- @field Set#SET_UNIT TargetSetUnit
   -- @extends #ACT_ACCOUNT
   ACT_ACCOUNT_DEADS = { 
     ClassName = "ACT_ACCOUNT_DEADS",
@@ -160,7 +160,7 @@ do -- ACT_ACCOUNT_DEADS
 
   --- Creates a new DESTROY process.
   -- @param #ACT_ACCOUNT_DEADS self
-  -- @param Core.Set#SET_UNIT TargetSetUnit
+  -- @param Set#SET_UNIT TargetSetUnit
   -- @param #string TaskName
   function ACT_ACCOUNT_DEADS:New()
     -- Inherits from BASE
@@ -190,6 +190,7 @@ do -- ACT_ACCOUNT_DEADS
   -- @param #string From
   -- @param #string To
   function ACT_ACCOUNT_DEADS:onenterReport( ProcessUnit, Task, From, Event, To )
+    self:E( { ProcessUnit, 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 )
@@ -285,7 +286,7 @@ do -- ACT_ACCOUNT_DEADS
   end  
   
   --- @param #ACT_ACCOUNT_DEADS self
-  -- @param Core.Event#EVENTDATA EventData
+  -- @param Event#EVENTDATA EventData
   function ACT_ACCOUNT_DEADS:onfuncEventDead( EventData )
     self:T( { "EventDead", EventData } )
 
@@ -297,7 +298,7 @@ do -- ACT_ACCOUNT_DEADS
   --- DCS Events
   
   --- @param #ACT_ACCOUNT_DEADS self
-  -- @param Core.Event#EVENTDATA EventData
+  -- @param Event#EVENTDATA EventData
   function ACT_ACCOUNT_DEADS:onfuncEventCrash( EventData )
     self:T( { "EventDead", EventData } )
 

Moose Development/Moose/Actions/Act_Assign.lua

@@ -2,7 +2,7 @@
 -- 
 -- ===
 -- 
--- # @{#ACT_ASSIGN} FSM template class, extends @{Core.Fsm#FSM_PROCESS}
+-- # @{#ACT_ASSIGN} FSM template class, extends @{Fsm#FSM_PROCESS}
 -- 
 -- ## ACT_ASSIGN state machine:
 -- 
@@ -54,7 +54,7 @@
 -- 
 -- ===
 -- 
--- # 1) @{#ACT_ASSIGN_ACCEPT} class, extends @{Core.Fsm.Assign#ACT_ASSIGN}
+-- # 1) @{#ACT_ASSIGN_ACCEPT} class, extends @{Fsm.Assign#ACT_ASSIGN}
 -- 
 -- The ACT_ASSIGN_ACCEPT class accepts by default a task for a player. No player intervention is allowed to reject the task.
 -- 
@@ -64,7 +64,7 @@
 -- 
 -- ===
 -- 
--- # 2) @{#ACT_ASSIGN_MENU_ACCEPT} class, extends @{Core.Fsm.Assign#ACT_ASSIGN}
+-- # 2) @{#ACT_ASSIGN_MENU_ACCEPT} class, extends @{Fsm.Assign#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.
@@ -77,8 +77,7 @@
 -- 
 -- ===
 -- 
--- @module Actions.Assign
--- @image MOOSE.JPG
+-- @module Assign
 
 
 do -- ACT_ASSIGN
@@ -156,7 +155,8 @@ do -- ACT_ASSIGN_ACCEPT
   -- @param #string Event
   -- @param #string From
   -- @param #string To
-  function ACT_ASSIGN_ACCEPT:onafterStart( ProcessUnit, Task, From, Event, To )
+  function ACT_ASSIGN_ACCEPT:onafterStart( ProcessUnit, From, Event, To )
+    self:E( { ProcessUnit, From, Event, To } )
   
     self:__Assign( 1 )   
   end
@@ -167,8 +167,12 @@ do -- ACT_ASSIGN_ACCEPT
   -- @param #string Event
   -- @param #string From
   -- @param #string To
-  function ACT_ASSIGN_ACCEPT:onenterAssigned( ProcessUnit, Task, From, Event, To )
+  function ACT_ASSIGN_ACCEPT:onenterAssigned( ProcessUnit, From, Event, To )
+    env.info( "in here" )
+    self:E( { ProcessUnit, From, Event, To } )
   
+    local ProcessGroup = ProcessUnit:GetGroup()
+
     self.Task:Assign( ProcessUnit, ProcessUnit:GetPlayerName() )
   end
   
@@ -189,26 +193,36 @@ do -- ACT_ASSIGN_MENU_ACCEPT
 
   --- Init.
   -- @param #ACT_ASSIGN_MENU_ACCEPT self
+  -- @param #string TaskName
   -- @param #string TaskBriefing
   -- @return #ACT_ASSIGN_MENU_ACCEPT self
-  function ACT_ASSIGN_MENU_ACCEPT:New( TaskBriefing )
+  function ACT_ASSIGN_MENU_ACCEPT:New( TaskName, TaskBriefing )
 
     -- Inherits from BASE
     local self = BASE:Inherit( self, ACT_ASSIGN:New() ) -- #ACT_ASSIGN_MENU_ACCEPT
 
+    self.TaskName = TaskName 
     self.TaskBriefing = TaskBriefing
     
     return self
   end
 
-
+  function ACT_ASSIGN_MENU_ACCEPT:Init( FsmAssign )
+  
+    self.TaskName = FsmAssign.TaskName 
+    self.TaskBriefing = FsmAssign.TaskBriefing  
+  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 TaskName
   -- @param #string TaskBriefing
   -- @return #ACT_ASSIGN_MENU_ACCEPT self
-  function ACT_ASSIGN_MENU_ACCEPT:Init( TaskBriefing )
+  function ACT_ASSIGN_MENU_ACCEPT:Init( TaskName, TaskBriefing )
   
     self.TaskBriefing = TaskBriefing
+    self.TaskName = TaskName
 
     return self
   end
@@ -219,31 +233,32 @@ do -- ACT_ASSIGN_MENU_ACCEPT
   -- @param #string Event
   -- @param #string From
   -- @param #string To
-  function ACT_ASSIGN_MENU_ACCEPT:onafterStart( ProcessUnit, Task, From, Event, To )
+  function ACT_ASSIGN_MENU_ACCEPT:onafterStart( ProcessUnit, From, Event, To )
+    self:E( { ProcessUnit, 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 )
+    self:GetCommandCenter():MessageTypeToGroup( "Access the radio menu to accept the task. You have 30 seconds or the assignment will be cancelled.", ProcessUnit:GetGroup(), MESSAGE.Type.Information )
    
-    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 )
+    local ProcessGroup = ProcessUnit:GetGroup() 
     
-    self:__Reject( 120, TaskGroup )
+    self.Menu = MENU_GROUP:New( ProcessGroup, "Task " .. self.TaskName .. " acceptance" )
+    self.MenuAcceptTask = MENU_GROUP_COMMAND:New( ProcessGroup, "Accept task " .. self.TaskName, self.Menu, self.MenuAssign, self )
+    self.MenuRejectTask = MENU_GROUP_COMMAND:New( ProcessGroup, "Reject task " .. self.TaskName, self.Menu, self.MenuReject, self )
   end
   
   --- Menu function.
   -- @param #ACT_ASSIGN_MENU_ACCEPT self
-  function ACT_ASSIGN_MENU_ACCEPT:MenuAssign( TaskGroup )
+  function ACT_ASSIGN_MENU_ACCEPT:MenuAssign()
+    self:E( )
   
-    self:__Assign( -1, TaskGroup )
+    self:__Assign( 1 )
   end
   
   --- Menu function.
   -- @param #ACT_ASSIGN_MENU_ACCEPT self
-  function ACT_ASSIGN_MENU_ACCEPT:MenuReject( TaskGroup )
+  function ACT_ASSIGN_MENU_ACCEPT:MenuReject()
+    self:E( )
   
-    self:__Reject( -1, TaskGroup )
+    self:__Reject( 1 )
   end
   
   --- StateMachine callback function
@@ -252,7 +267,8 @@ do -- ACT_ASSIGN_MENU_ACCEPT
   -- @param #string Event
   -- @param #string From
   -- @param #string To
-  function ACT_ASSIGN_MENU_ACCEPT:onafterAssign( ProcessUnit, Task, From, Event, To, TaskGroup  )
+  function ACT_ASSIGN_MENU_ACCEPT:onafterAssign( ProcessUnit, From, Event, To )
+    self:E( { ProcessUnit.UnitNameFrom, Event, To } )
   
     self.Menu:Remove()
   end
@@ -263,25 +279,13 @@ do -- ACT_ASSIGN_MENU_ACCEPT
   -- @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 } )
+  function ACT_ASSIGN_MENU_ACCEPT:onafterReject( ProcessUnit, From, Event, To )
+    self:E( { ProcessUnit.UnitName, From, Event, To } )
   
     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() )
+    ProcessUnit:Destroy()
   end
 
 end -- ACT_ASSIGN_MENU_ACCEPT

Moose Development/Moose/Actions/Act_Assist.lua

@@ -1,5 +1,9 @@
 --- (SP) (MP) (FSM) Route AI or players through waypoints or to zones.
 -- 
+-- ===
+-- 
+-- # @{#ACT_ASSIST} FSM class, extends @{Fsm#FSM_PROCESS}
+-- 
 -- ## ACT_ASSIST state machine:
 -- 
 -- This class is a state machine: it manages a process that is triggered by events causing state transitions to occur.
@@ -48,7 +52,7 @@
 -- 
 -- ===
 -- 
--- # 1) @{#ACT_ASSIST_SMOKE_TARGETS_ZONE} class, extends @{Core.Fsm.Route#ACT_ASSIST}
+-- # 1) @{#ACT_ASSIST_SMOKE_TARGETS_ZONE} class, extends @{Fsm.Route#ACT_ASSIST}
 -- 
 -- The ACT_ASSIST_SMOKE_TARGETS_ZONE class implements the core functions to smoke targets in a @{Zone}.
 -- The targets are smoked within a certain range around each target, simulating a realistic smoking behaviour. 
@@ -60,9 +64,7 @@
 -- 
 -- ===
 -- 
--- @module Actions.Assist
--- @image MOOSE.JPG
-
+-- @module Smoke
 
 do -- ACT_ASSIST
 
@@ -109,6 +111,7 @@ do -- ACT_ASSIST
     local MissionMenu = self:GetMission():GetMenu( ProcessGroup )
      
     local function MenuSmoke( MenuParam )
+      self:E( MenuParam )
       local self = MenuParam.self
       local SmokeColor = MenuParam.SmokeColor
       self.SmokeColor = SmokeColor
@@ -140,7 +143,7 @@ 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 Set#SET_UNIT TargetSetUnit
   -- @field Core.Zone#ZONE_BASE TargetZone
   -- @extends #ACT_ASSIST
   ACT_ASSIST_SMOKE_TARGETS_ZONE = { 
@@ -156,7 +159,7 @@ do -- ACT_ASSIST_SMOKE_TARGETS_ZONE
   
   --- 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 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
@@ -175,7 +178,7 @@ do -- ACT_ASSIST_SMOKE_TARGETS_ZONE
   
   --- 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 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 )

Moose Development/Moose/Actions/Act_JTAC.lua

@@ -0,0 +1,198 @@
+--- @module Process_JTAC
+
+--- PROCESS_JTAC class
+-- @type PROCESS_JTAC
+-- @field Wrapper.Unit#UNIT ProcessUnit
+-- @field Core.Set#SET_UNIT TargetSetUnit
+-- @extends Core.Fsm#FSM_PROCESS
+PROCESS_JTAC = { 
+  ClassName = "PROCESS_JTAC",
+  Fsm = {},
+  TargetSetUnit = nil,
+}
+
+
+--- Creates a new DESTROY process.
+-- @param #PROCESS_JTAC self
+-- @param Tasking.Task#TASK Task
+-- @param Wrapper.Unit#UNIT ProcessUnit
+-- @param Core.Set#SET_UNIT TargetSetUnit
+-- @param Wrapper.Unit#UNIT FACUnit
+-- @return #PROCESS_JTAC self
+function PROCESS_JTAC:New( Task, ProcessUnit, TargetSetUnit, FACUnit )
+
+  -- Inherits from BASE
+  local self = BASE:Inherit( self, PROCESS:New( "JTAC", Task, ProcessUnit ) ) -- #PROCESS_JTAC
+  
+  self.TargetSetUnit = TargetSetUnit
+  self.FACUnit = FACUnit
+
+  self.DisplayInterval = 60
+  self.DisplayCount = 30
+  self.DisplayMessage = true
+  self.DisplayTime = 10 -- 10 seconds is the default
+  self.DisplayCategory = "HQ" -- Targets is the default display category
+
+
+  self.Fsm = FSM_PROCESS:New( self, {
+    initial = 'Assigned',
+    events = {
+      { name = 'Start', from = 'Assigned', to = 'CreatedMenu'    },
+      { name = 'JTACMenuUpdate', from = 'CreatedMenu', to = 'AwaitingMenu'    },
+      { name = 'JTACMenuAwait', from = 'AwaitingMenu', to = 'AwaitingMenu'    },
+      { name = 'JTACMenuSpot', from = 'AwaitingMenu', to = 'AwaitingMenu'    },
+      { name = 'JTACMenuCancel', from = 'AwaitingMenu', to = 'AwaitingMenu'  },
+      { name = 'JTACStatus', from = 'AwaitingMenu', to = 'AwaitingMenu'  },
+      { name = 'Fail', from = 'AwaitingMenu', to = 'Failed' },
+      { name = 'Fail', from = 'CreatedMenu', to = 'Failed' },
+    },
+    callbacks = {
+      onStart =  self.OnStart,
+      onJTACMenuUpdate = self.OnJTACMenuUpdate,
+      onJTACMenuAwait =  self.OnJTACMenuAwait,
+      onJTACMenuSpot = self.OnJTACMenuSpot,
+      onJTACMenuCancel = self.OnJTACMenuCancel,
+    },
+    endstates = { 'Failed' }
+  } )
+
+  self:HandleEvent( EVENTS.Dead, self.EventDead )
+  
+  return self
+end
+
+--- Process Events
+
+--- StateMachine callback function for a PROCESS
+-- @param #PROCESS_JTAC self
+-- @param Core.Fsm#FSM_PROCESS Fsm
+-- @param #string Event
+-- @param #string From
+-- @param #string To
+function PROCESS_JTAC:OnStart( Fsm, From, Event, To )
+
+  self:NextEvent( Fsm.JTACMenuUpdate )
+end
+
+--- StateMachine callback function for a PROCESS
+-- @param #PROCESS_JTAC self
+-- @param Core.Fsm#FSM_PROCESS Fsm
+-- @param #string Event
+-- @param #string From
+-- @param #string To
+function PROCESS_JTAC:OnJTACMenuUpdate( Fsm, From, Event, To )
+
+  local function JTACMenuSpot( MenuParam )
+    self:E( MenuParam.TargetUnit.UnitName )
+    local self = MenuParam.self
+    local TargetUnit = MenuParam.TargetUnit
+
+    self:NextEvent( self.Fsm.JTACMenuSpot, TargetUnit )
+  end
+
+  local function JTACMenuCancel( MenuParam )
+    self:E( MenuParam )
+    local self = MenuParam.self
+    local TargetUnit = MenuParam.TargetUnit
+ 
+    self:NextEvent( self.Fsm.JTACMenuCancel, TargetUnit )
+  end
+
+
+  -- Loop each unit in the target set, and determine the threat levels map table.
+  local UnitThreatLevels = self.TargetSetUnit:GetUnitThreatLevels()
+  
+  self:E( {"UnitThreadLevels", UnitThreatLevels } )
+  
+  local JTACMenu = self.ProcessGroup:GetState( self.ProcessGroup, "JTACMenu" )
+  
+  if not JTACMenu then
+    JTACMenu = MENU_GROUP:New( self.ProcessGroup, "JTAC", self.MissionMenu )
+    for ThreatLevel, ThreatLevelTable in pairs( UnitThreatLevels ) do
+      local JTACMenuThreatLevel = MENU_GROUP:New( self.ProcessGroup, ThreatLevelTable.UnitThreatLevelText, JTACMenu )
+      for ThreatUnitName, ThreatUnit in pairs( ThreatLevelTable.Units ) do
+        local JTACMenuUnit = MENU_GROUP:New( self.ProcessGroup, ThreatUnit:GetTypeName(), JTACMenuThreatLevel )
+        MENU_GROUP_COMMAND:New( self.ProcessGroup, "Lase Target", JTACMenuUnit, JTACMenuSpot, { self = self, TargetUnit = ThreatUnit } )
+        MENU_GROUP_COMMAND:New( self.ProcessGroup, "Cancel Target", JTACMenuUnit, JTACMenuCancel, { self = self, TargetUnit = ThreatUnit } )
+      end
+    end
+  end  
+  
+end
+
+--- StateMachine callback function for a PROCESS
+-- @param #PROCESS_JTAC self
+-- @param Core.Fsm#FSM_PROCESS Fsm
+-- @param #string Event
+-- @param #string From
+-- @param #string To
+function PROCESS_JTAC:OnJTACMenuAwait( Fsm, From, Event, To )
+
+  if self.DisplayCount >= self.DisplayInterval then
+
+    local TaskJTAC = self.Task -- Tasking.Task#TASK_JTAC
+    TaskJTAC.Spots = TaskJTAC.Spots or {}
+    for TargetUnitName, SpotData in pairs( TaskJTAC.Spots) do
+      local TargetUnit = UNIT:FindByName( TargetUnitName )
+      self.FACUnit:MessageToGroup( "Lasing " .. TargetUnit:GetTypeName() .. " with laser code " .. SpotData:getCode(), 15, self.ProcessGroup )
+    end
+    self.DisplayCount = 1
+  else
+    self.DisplayCount = self.DisplayCount + 1
+  end
+  
+  self:NextEvent( Fsm.JTACMenuAwait )
+end
+
+--- StateMachine callback function for a PROCESS
+-- @param #PROCESS_JTAC self
+-- @param Core.Fsm#FSM_PROCESS Fsm
+-- @param #string Event
+-- @param #string From
+-- @param #string To
+-- @param Wrapper.Unit#UNIT TargetUnit
+function PROCESS_JTAC:OnJTACMenuSpot( Fsm, From, Event, To, TargetUnit )
+
+  local TargetUnitName = TargetUnit:GetName()
+  
+  local TaskJTAC = self.Task -- Tasking.Task#TASK_JTAC
+  
+  TaskJTAC.Spots = TaskJTAC.Spots or {}
+  TaskJTAC.Spots[TargetUnitName] = TaskJTAC.Spots[TargetUnitName] or {}
+
+  local DCSFACObject = self.FACUnit:GetDCSObject()
+  local TargetVec3 = TargetUnit:GetVec3()
+
+  TaskJTAC.Spots[TargetUnitName] = Spot.createInfraRed( self.FACUnit:GetDCSObject(), { x = 0, y = 1, z = 0 }, TargetUnit:GetVec3(), math.random( 1000, 9999 ) )
+  
+  local SpotData = TaskJTAC.Spots[TargetUnitName]
+  self.FACUnit:MessageToGroup( "Lasing " .. TargetUnit:GetTypeName() .. " with laser code " .. SpotData:getCode(), 15, self.ProcessGroup )
+
+  self:NextEvent( Fsm.JTACMenuAwait )
+end
+
+--- StateMachine callback function for a PROCESS
+-- @param #PROCESS_JTAC self
+-- @param Core.Fsm#FSM_PROCESS Fsm
+-- @param #string Event
+-- @param #string From
+-- @param #string To
+-- @param Wrapper.Unit#UNIT TargetUnit
+function PROCESS_JTAC:OnJTACMenuCancel( Fsm, From, Event, To, TargetUnit )
+
+  local TargetUnitName = TargetUnit:GetName()
+  
+  local TaskJTAC = self.Task -- Tasking.Task#TASK_JTAC
+  
+  TaskJTAC.Spots = TaskJTAC.Spots or {}
+  if TaskJTAC.Spots[TargetUnitName] then
+    TaskJTAC.Spots[TargetUnitName]:destroy() -- destroys the spot
+    TaskJTAC.Spots[TargetUnitName] = nil
+  end
+
+  self.FACUnit:MessageToGroup( "Stopped lasing " .. TargetUnit:GetTypeName(), 15, self.ProcessGroup )
+
+  self:NextEvent( Fsm.JTACMenuAwait )
+end
+
+

Moose Development/Moose/Actions/Act_Pickup.lua

@@ -0,0 +1,173 @@
+--- @module Process_Pickup
+
+--- PROCESS_PICKUP class
+-- @type PROCESS_PICKUP
+-- @field Wrapper.Unit#UNIT ProcessUnit
+-- @field Core.Set#SET_UNIT TargetSetUnit
+-- @extends Core.Fsm#FSM_PROCESS
+PROCESS_PICKUP = { 
+  ClassName = "PROCESS_PICKUP",
+  Fsm = {},
+  TargetSetUnit = nil,
+}
+
+
+--- Creates a new DESTROY process.
+-- @param #PROCESS_PICKUP self
+-- @param Tasking.Task#TASK Task
+-- @param Wrapper.Unit#UNIT ProcessUnit
+-- @param Core.Set#SET_UNIT TargetSetUnit
+-- @return #PROCESS_PICKUP self
+function PROCESS_PICKUP:New( Task, ProcessName, ProcessUnit )
+
+  -- Inherits from BASE
+  local self = BASE:Inherit( self, PROCESS:New( ProcessName, Task, ProcessUnit ) ) -- #PROCESS_PICKUP
+  
+  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
+
+  self.Fsm = FSM_PROCESS:New( self, {
+    initial = 'Assigned',
+    events = {
+      { name = 'Start',     from = 'Assigned',        to = 'Navigating'    },
+      { name = 'Start',     from = 'Navigating',      to = 'Navigating'    },
+      { name = 'Nearby',    from = 'Navigating',      to = 'Preparing' },
+      { name = 'Pickup',    from = 'Preparing',       to = 'Loading'  },
+      { name = 'Load',      from = 'Loading',         to = 'Success'  },
+      { name = 'Fail',      from = 'Assigned',        to = 'Failed' },
+      { name = 'Fail',      from = 'Navigating',      to = 'Failed' },
+      { name = 'Fail',      from = 'Preparing',       to = 'Failed' },
+    },
+    callbacks = {
+      onStart =  self.OnStart,
+      onNearby = self.OnNearby,
+      onPickup =  self.OnPickup,
+      onLoad = self.OnLoad,
+    },
+    endstates = { 'Success', 'Failed' }
+  } )
+
+  return self
+end
+
+--- Process Events
+
+--- StateMachine callback function for a PROCESS
+-- @param #PROCESS_PICKUP self
+-- @param Core.Fsm#FSM_PROCESS Fsm
+-- @param #string Event
+-- @param #string From
+-- @param #string To
+function PROCESS_PICKUP:OnStart( Fsm, From, Event, To )
+
+  self:NextEvent( Fsm.Start )
+end
+
+--- StateMachine callback function for a PROCESS
+-- @param #PROCESS_PICKUP self
+-- @param Core.Fsm#FSM_PROCESS Fsm
+-- @param #string Event
+-- @param #string From
+-- @param #string To
+function PROCESS_PICKUP:OnNavigating( Fsm, From, Event, To )
+
+  local TaskGroup = self.ProcessUnit:GetGroup()
+  if self.DisplayCount >= self.DisplayInterval then
+    MESSAGE:New( "Your group with assigned " .. self.Task:GetName() .. " task has " .. self.TargetSetUnit:GetUnitTypesText() .. " targets left to be destroyed.", 5, "HQ" ):ToGroup( TaskGroup )
+    self.DisplayCount = 1
+  else
+    self.DisplayCount = self.DisplayCount + 1
+  end
+  
+  return true -- Process always the event.
+  
+end
+
+
+--- StateMachine callback function for a PROCESS
+-- @param #PROCESS_PICKUP self
+-- @param Core.Fsm#FSM_PROCESS Fsm
+-- @param #string Event
+-- @param #string From
+-- @param #string To
+-- @param Core.Event#EVENTDATA Event
+function PROCESS_PICKUP:OnHitTarget( Fsm, From, Event, To, Event )
+
+
+  self.TargetSetUnit:Flush()
+  
+  if self.TargetSetUnit:FindUnit( Event.IniUnitName ) then
+    self.TargetSetUnit:RemoveUnitsByName( Event.IniUnitName )
+    local TaskGroup = self.ProcessUnit:GetGroup()
+    MESSAGE:New( "You hit a target. Your group with assigned " .. self.Task:GetName() .. " task has " .. self.TargetSetUnit:Count() .. " targets ( " .. self.TargetSetUnit:GetUnitTypesText() .. " ) left to be destroyed.", 15, "HQ" ):ToGroup( TaskGroup )
+  end
+
+  
+  if self.TargetSetUnit:Count() > 0 then
+    self:NextEvent( Fsm.MoreTargets )
+  else
+    self:NextEvent( Fsm.Destroyed )
+  end
+end
+
+--- StateMachine callback function for a PROCESS
+-- @param #PROCESS_PICKUP self
+-- @param Core.Fsm#FSM_PROCESS Fsm
+-- @param #string Event
+-- @param #string From
+-- @param #string To
+function PROCESS_PICKUP:OnMoreTargets( Fsm, From, Event, To )
+
+
+end
+
+--- StateMachine callback function for a PROCESS
+-- @param #PROCESS_PICKUP self
+-- @param Core.Fsm#FSM_PROCESS Fsm
+-- @param #string Event
+-- @param #string From
+-- @param #string To
+-- @param Core.Event#EVENTDATA DCSEvent
+function PROCESS_PICKUP:OnKilled( Fsm, From, Event, To )
+
+  self:NextEvent( Fsm.Restart )
+
+end
+
+--- StateMachine callback function for a PROCESS
+-- @param #PROCESS_PICKUP self
+-- @param Core.Fsm#FSM_PROCESS Fsm
+-- @param #string Event
+-- @param #string From
+-- @param #string To
+function PROCESS_PICKUP:OnRestart( Fsm, From, Event, To )
+
+  self:NextEvent( Fsm.Menu )
+
+end
+
+--- StateMachine callback function for a PROCESS
+-- @param #PROCESS_PICKUP self
+-- @param Core.Fsm#FSM_PROCESS Fsm
+-- @param #string Event
+-- @param #string From
+-- @param #string To
+function PROCESS_PICKUP:OnDestroyed( Fsm, From, Event, To )
+
+end
+
+--- DCS Events
+
+--- @param #PROCESS_PICKUP self
+-- @param Core.Event#EVENTDATA Event
+function PROCESS_PICKUP:EventDead( Event )
+
+  if Event.IniDCSUnit then
+    self:NextEvent( self.Fsm.HitTarget, Event )
+  end
+end
+
+

Moose Development/Moose/Actions/Act_Route.lua

@@ -2,7 +2,7 @@
 -- 
 -- ===
 -- 
--- # @{#ACT_ROUTE} FSM class, extends @{Core.Fsm#FSM_PROCESS}
+-- # @{#ACT_ROUTE} FSM class, extends @{Fsm#FSM_PROCESS}
 -- 
 -- ## ACT_ROUTE state machine:
 -- 
@@ -60,9 +60,9 @@
 -- 
 -- ===
 -- 
--- # 1) @{#ACT_ROUTE_ZONE} class, extends @{Core.Fsm.Route#ACT_ROUTE}
+-- # 1) @{#ACT_ROUTE_ZONE} class, extends @{Fsm.Route#ACT_ROUTE}
 -- 
--- The ACT_ROUTE_ZONE class implements the core functions to route an AIR @{Wrapper.Controllable} player @{Wrapper.Unit} to a @{Zone}.
+-- The ACT_ROUTE_ZONE class implements the core functions to route an AIR @{Controllable} player @{Unit} to a @{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.
 -- 
@@ -72,8 +72,7 @@
 -- 
 -- ===
 -- 
--- @module Actions.Route
--- @image MOOSE.JPG
+-- @module Route
 
 
 do -- ACT_ROUTE
@@ -124,20 +123,16 @@ do -- ACT_ROUTE
   --- Set a Cancel Menu item.
   -- @param #ACT_ROUTE self
   -- @return #ACT_ROUTE
-  function ACT_ROUTE:SetMenuCancel( MenuGroup, MenuText, ParentMenu, MenuTime, MenuTag )
+  function ACT_ROUTE:SetMenuCancel( MenuGroup, MenuText, ParentMenu, MenuTime )
     
-    self.CancelMenuGroupCommand = MENU_GROUP_COMMAND:New(
+    MENU_GROUP_COMMAND:New(
       MenuGroup,
       MenuText,
       ParentMenu,
       self.MenuCancel,
       self
-    ):SetTime( MenuTime ):SetTag( MenuTag )
-
-    ParentMenu:SetTime( MenuTime )
+    ):SetTime(MenuTime)
     
-    ParentMenu:Remove( MenuTime, MenuTag )
-
     return self
   end
   
@@ -163,6 +158,8 @@ do -- ACT_ROUTE
   -- @return #string
   function ACT_ROUTE:GetRouteText( Controllable )
     
+    self:E()
+    
     local RouteText = ""
 
     local Coordinate = nil -- Core.Point#COORDINATE
@@ -185,13 +182,13 @@ do -- ACT_ROUTE
         local ShortestDistance = 0
         local ShortestReferencePoint = nil
         local ShortestReferenceName = ""
-        self:F( { CC.ReferencePoints } )
+        self:E( { CC.ReferencePoints } )
         for ZoneName, Zone in pairs( CC.ReferencePoints ) do
-          self:F( { ZoneName = ZoneName } )
+          self:E( { ZoneName = ZoneName } )
           local Zone = Zone -- Core.Zone#ZONE
           local ZoneCoord = Zone:GetCoordinate()
           local ZoneDistance = ZoneCoord:Get2DDistance( self.Coordinate )
-          self:F( { ShortestDistance, ShortestReferenceName } )
+          self:E( { ShortestDistance, ShortestReferenceName } )
           if ShortestDistance == 0 or ZoneDistance < ShortestDistance then
             ShortestDistance = ZoneDistance
             ShortestReferencePoint = ZoneCoord
@@ -211,9 +208,7 @@ do -- ACT_ROUTE
 
   
   function ACT_ROUTE:MenuCancel()
-    self:F("Cancelled")
-    self.CancelMenuGroupCommand:Remove()
-    self:__Cancel( 1 )
+    self:Cancel()
   end
 
   --- Task Events
@@ -245,8 +240,10 @@ do -- ACT_ROUTE
   -- @param #string From
   -- @param #string To
   function ACT_ROUTE:onbeforeRoute( ProcessUnit, From, Event, To )
+    self:F( { "BeforeRoute 1", self.DisplayCount, self.DisplayInterval } )
   
     if ProcessUnit:IsAlive() then
+      self:F( "BeforeRoute 2" )
       local HasArrived = self:onfuncHasArrived( ProcessUnit ) -- Polymorphic
       if self.DisplayCount >= self.DisplayInterval then
         self:T( { HasArrived = HasArrived } )
@@ -258,6 +255,8 @@ do -- ACT_ROUTE
         self.DisplayCount = self.DisplayCount + 1
       end
       
+      self:T( { DisplayCount = self.DisplayCount } )
+      
       if HasArrived then
         self:__Arrive( 1 )
       else
@@ -340,7 +339,7 @@ do -- ACT_ROUTE_POINT
   -- @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:F2( { self.Range } )
     self.Range = Range or 10000
   end  
   
@@ -348,7 +347,6 @@ do -- ACT_ROUTE_POINT
   -- @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  
   
@@ -362,7 +360,7 @@ do -- ACT_ROUTE_POINT
       local Distance = self.Coordinate:Get2DDistance( ProcessUnit:GetCoordinate() )
       
       if Distance <= self.Range then
-        local RouteText = "Task \"" .. self:GetTask():GetName() .. "\", you have arrived."
+        local RouteText = "You have arrived."
         self:GetCommandCenter():MessageTypeToGroup( RouteText, ProcessUnit:GetGroup(), MESSAGE.Type.Information )
         return true
       end
@@ -381,7 +379,7 @@ do -- ACT_ROUTE_POINT
   -- @param #string To
   function ACT_ROUTE_POINT:onafterReport( ProcessUnit, From, Event, To )
   
-    local RouteText = "Task \"" .. self:GetTask():GetName() .. "\", " .. self:GetRouteText( ProcessUnit )
+    local RouteText = self:GetRouteText( ProcessUnit )
     
     self:GetCommandCenter():MessageTypeToGroup( RouteText, ProcessUnit:GetGroup(), MESSAGE.Type.Update )
   end
@@ -453,7 +451,7 @@ do -- ACT_ROUTE_ZONE
   function ACT_ROUTE_ZONE:onfuncHasArrived( ProcessUnit )
 
     if ProcessUnit:IsInZone( self.Zone ) then
-      local RouteText = "Task \"" .. self:GetTask():GetName() .. "\", you have arrived within the zone."
+      local RouteText = "You have arrived within the zone."
       self:GetCommandCenter():MessageTypeToGroup( RouteText, ProcessUnit:GetGroup(), MESSAGE.Type.Information )
     end
 
@@ -469,9 +467,9 @@ do -- ACT_ROUTE_ZONE
   -- @param #string From
   -- @param #string To
   function ACT_ROUTE_ZONE:onafterReport( ProcessUnit, From, Event, To )
-    self:F( { ProcessUnit = ProcessUnit } )
+    self:E( { ProcessUnit = ProcessUnit } )
   
-    local RouteText = "Task \"" .. self:GetTask():GetName() .. "\", " .. self:GetRouteText( ProcessUnit )
+    local RouteText = self:GetRouteText( ProcessUnit )
     self:GetCommandCenter():MessageTypeToGroup( RouteText, ProcessUnit:GetGroup(), MESSAGE.Type.Update )
   end
 

Moose Development/Moose/Cargo/CargoCrate.lua

@@ -1,332 +0,0 @@
---- **Cargo** -- Management of single cargo crates, which are based on a @{Static} object.
---
--- ===
--- 
--- ### [Demo Missions]()
--- 
--- ### [YouTube Playlist]()
--- 
--- ===
--- 
--- ### Author: **FlightControl**
--- ### Contributions: 
--- 
--- ===
--- 
--- @module Cargo.CargoCrate
--- @image Cargo_Crates.JPG
-
-do -- CARGO_CRATE
-
-  --- Models the behaviour of cargo crates, which can be slingloaded and boarded on helicopters. 
-  -- @type CARGO_CRATE
-  -- @extends Cargo.Cargo#CARGO_REPRESENTABLE
-  
-  --- Defines a cargo that is represented by a UNIT object within the simulator, and can be transported by a carrier.
-  -- Use the event functions as described above to Load, UnLoad, Board, UnBoard the CARGO\_CRATE objects to and from carriers.
-  -- 
-  -- The above cargo classes are used by the following AI_CARGO_ classes to allow AI groups to transport cargo:
-  -- 
-  --   * AI Armoured Personnel Carriers to transport cargo and engage in battles, using the @{AI.AI_Cargo_APC} module.
-  --   * AI Helicopters to transport cargo, using the @{AI.AI_Cargo_Helicopter} module.
-  --   * AI Planes to transport cargo, using the @{AI.AI_Cargo_Airplane} module.
-  --   * AI Ships is planned.
-  -- 
-  -- The above cargo classes are also used by the TASK_CARGO_ classes to allow human players to transport cargo as part of a tasking:
-  -- 
-  --   * @{Tasking.Task_Cargo_Transport#TASK_CARGO_TRANSPORT} to transport cargo by human players.
-  --   * @{Tasking.Task_Cargo_Transport#TASK_CARGO_CSAR} to transport downed pilots by human players.
-  -- 
-  -- ===
-  -- 
-  -- @field #CARGO_CRATE
-  CARGO_CRATE = {
-    ClassName = "CARGO_CRATE"
-  }
-  
-  --- CARGO_CRATE Constructor.
-  -- @param #CARGO_CRATE self
-  -- @param Wrapper.Static#STATIC CargoStatic
-  -- @param #string Type
-  -- @param #string Name
-  -- @param #number LoadRadius (optional)
-  -- @param #number NearRadius (optional)
-  -- @return #CARGO_CRATE
-  function CARGO_CRATE:New( CargoStatic, Type, Name, LoadRadius, NearRadius )
-    local self = BASE:Inherit( self, CARGO_REPRESENTABLE:New( CargoStatic, Type, Name, nil, LoadRadius, NearRadius ) ) -- #CARGO_CRATE
-    self:F( { Type, Name, NearRadius } )
-  
-    self.CargoObject = CargoStatic -- Wrapper.Static#STATIC
- 
-    -- Cargo objects are added to the _DATABASE and SET_CARGO objects.
-    _EVENTDISPATCHER:CreateEventNewCargo( self )
-    
-    self:HandleEvent( EVENTS.Dead, self.OnEventCargoDead )
-    self:HandleEvent( EVENTS.Crash, self.OnEventCargoDead )
-    --self:HandleEvent( EVENTS.RemoveUnit, self.OnEventCargoDead )
-    self:HandleEvent( EVENTS.PlayerLeaveUnit, self.OnEventCargoDead )
-    
-    self:SetEventPriority( 4 )
-    
-    self.NearRadius = NearRadius or 25
-  
-    return self
-  end
-  
-  --- @param #CARGO_CRATE self
-  -- @param Core.Event#EVENTDATA EventData 
-  function CARGO_CRATE:OnEventCargoDead( EventData )
-
-    local Destroyed = false
-  
-    if self:IsDestroyed() or self:IsUnLoaded() or self:IsBoarding() then
-      if self.CargoObject:GetName() == EventData.IniUnitName then
-        if not self.NoDestroy then 
-          Destroyed = true
-        end
-      end
-    else
-      if self:IsLoaded() then
-        local CarrierName = self.CargoCarrier:GetName()
-        if CarrierName == EventData.IniDCSUnitName then
-          MESSAGE:New( "Cargo is lost from carrier " .. CarrierName, 15 ):ToAll()
-          Destroyed = true
-          self.CargoCarrier:ClearCargo()
-        end
-      end
-    end
-    
-    if Destroyed then
-      self:I( { "Cargo crate destroyed: " .. self.CargoObject:GetName() } )
-      self:Destroyed()
-    end
-    
-  end
-  
-  
-  --- Enter UnLoaded State.
-  -- @param #CARGO_CRATE self
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  -- @param Core.Point#POINT_VEC2
-  function CARGO_CRATE:onenterUnLoaded( From, Event, To, ToPointVec2 )
-    --self:F( { ToPointVec2, From, Event, To } )
-  
-    local Angle = 180
-    local Speed = 10
-    local Distance = 10
-  
-    if From == "Loaded" then
-      local StartCoordinate = self.CargoCarrier:GetCoordinate()
-      local CargoCarrierHeading = self.CargoCarrier:GetHeading() -- Get Heading of object in degrees.
-      local CargoDeployHeading = ( ( CargoCarrierHeading + Angle ) >= 360 ) and ( CargoCarrierHeading + Angle - 360 ) or ( CargoCarrierHeading + Angle )
-      local CargoDeployCoord = StartCoordinate:Translate( Distance, CargoDeployHeading )
-  
-      ToPointVec2 = ToPointVec2 or COORDINATE:NewFromVec2( { x= CargoDeployCoord.x, y = CargoDeployCoord.z } )
-  
-      -- Respawn the group...
-      if self.CargoObject then
-        self.CargoObject:ReSpawnAt( ToPointVec2, 0 )
-        self.CargoCarrier = nil
-      end
-      
-    end
-  
-    if self.OnUnLoadedCallBack then
-      self.OnUnLoadedCallBack( self, unpack( self.OnUnLoadedParameters ) )
-      self.OnUnLoadedCallBack = nil
-    end
-  
-  end
-
-  
-  --- Loaded State.
-  -- @param #CARGO_CRATE self
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  -- @param Wrapper.Unit#UNIT CargoCarrier
-  function CARGO_CRATE:onenterLoaded( From, Event, To, CargoCarrier )
-    --self:F( { From, Event, To, CargoCarrier } )
-  
-    self.CargoCarrier = CargoCarrier
-    
-    -- Only destroy the CargoObject is if there is a CargoObject (packages don't have CargoObjects).
-    if self.CargoObject then
-      self:T("Destroying")
-      self.NoDestroy = true
-      self.CargoObject:Destroy( false ) -- Do not generate a remove unit event, because we want to keep the template for later respawn in the database.
-      --local Coordinate = self.CargoObject:GetCoordinate():GetRandomCoordinateInRadius( 50, 20 )
-      --self.CargoObject:ReSpawnAt( Coordinate, 0 )
-    end
-  end
-
-  --- Check if the cargo can be Boarded.
-  -- @param #CARGO_CRATE self
-  function CARGO_CRATE:CanBoard()
-    return false
-  end
-
-  --- Check if the cargo can be Unboarded.
-  -- @param #CARGO_CRATE self
-  function CARGO_CRATE:CanUnboard()
-    return false
-  end
-
-  --- Check if the cargo can be sling loaded.
-  -- @param #CARGO_CRATE self
-  function CARGO_CRATE:CanSlingload()
-    return false
-  end
-
-  --- Check if Cargo Crate is in the radius for the Cargo to be reported.
-  -- @param #CARGO_CRATE self
-  -- @param Core.Point#COORDINATE Coordinate
-  -- @return #boolean true if the Cargo Crate is within the report radius.
-  function CARGO_CRATE:IsInReportRadius( Coordinate )
-    --self:F( { Coordinate, LoadRadius = self.LoadRadius } )
-  
-    local Distance = 0
-    if self:IsUnLoaded() then
-      Distance = Coordinate:Get2DDistance( self.CargoObject:GetCoordinate() )
-      --self:T( Distance )
-      if Distance <= self.LoadRadius then
-        return true
-      end
-    end
-    
-    return false
-  end
-
-
-  --- Check if Cargo Crate is in the radius for the Cargo to be Boarded or Loaded.
-  -- @param #CARGO_CRATE self
-  -- @param Core.Point#Coordinate Coordinate
-  -- @return #boolean true if the Cargo Crate is within the loading radius.
-  function CARGO_CRATE:IsInLoadRadius( Coordinate )
-    --self:F( { Coordinate, LoadRadius = self.NearRadius } )
-  
-    local Distance = 0
-    if self:IsUnLoaded() then
-      Distance = Coordinate:Get2DDistance( self.CargoObject:GetCoordinate() )
-      --self:T( Distance )
-      if Distance <= self.NearRadius then
-        return true
-      end
-    end
-    
-    return false
-  end
-
-
-
-  --- Get the current Coordinate of the CargoGroup.
-  -- @param #CARGO_CRATE self
-  -- @return Core.Point#COORDINATE The current Coordinate of the first Cargo of the CargoGroup.
-  -- @return #nil There is no valid Cargo in the CargoGroup.
-  function CARGO_CRATE:GetCoordinate()
-    --self:F()
-    
-    return self.CargoObject:GetCoordinate()
-  end
-
-  --- Check if the CargoGroup is alive.
-  -- @param #CARGO_CRATE self
-  -- @return #boolean true if the CargoGroup is alive.
-  -- @return #boolean false if the CargoGroup is dead.
-  function CARGO_CRATE:IsAlive()
-
-    local Alive = true
-  
-    -- When the Cargo is Loaded, the Cargo is in the CargoCarrier, so we check if the CargoCarrier is alive.
-    -- When the Cargo is not Loaded, the Cargo is the CargoObject, so we check if the CargoObject is alive.
-    if self:IsLoaded() then
-      Alive = Alive == true and self.CargoCarrier:IsAlive()
-    else
-      Alive = Alive == true and self.CargoObject:IsAlive()
-    end 
-    
-    return Alive
-  
-  end
-
-  
-  --- Route Cargo to Coordinate and randomize locations.
-  -- @param #CARGO_CRATE self
-  -- @param Core.Point#COORDINATE Coordinate
-  function CARGO_CRATE:RouteTo( Coordinate )
-    self:F( {Coordinate = Coordinate } )
-    
-  end
-
-  
-  --- Check if Cargo is near to the Carrier.
-  -- The Cargo is near to the Carrier within NearRadius.
-  -- @param #CARGO_CRATE self
-  -- @param Wrapper.Group#GROUP CargoCarrier
-  -- @param #number NearRadius
-  -- @return #boolean The Cargo is near to the Carrier.
-  -- @return #nil The Cargo is not near to the Carrier.
-  function CARGO_CRATE:IsNear( CargoCarrier, NearRadius )
-    self:F( {NearRadius = NearRadius } )
-    
-    return self:IsNear( CargoCarrier:GetCoordinate(), NearRadius )
-  end
-
-  --- Respawn the CargoGroup.
-  -- @param #CARGO_CRATE self
-  function CARGO_CRATE:Respawn()
-
-    self:F( { "Respawning crate " .. self:GetName() } )
-
-
-    -- Respawn the group...
-    if self.CargoObject then
-      self.CargoObject:ReSpawn() -- A cargo destroy crates a DEAD event.
-      self:__Reset( -0.1 )
-    end
-
-    
-  end
-
-
-  --- Respawn the CargoGroup.
-  -- @param #CARGO_CRATE self
-  function CARGO_CRATE:onafterReset()
-
-    self:F( { "Reset crate " .. self:GetName() } )
-
-
-    -- Respawn the group...
-    if self.CargoObject then
-      self:SetDeployed( false )
-      self:SetStartState( "UnLoaded" )
-      self.CargoCarrier = nil
-      -- Cargo objects are added to the _DATABASE and SET_CARGO objects.
-      _EVENTDISPATCHER:CreateEventNewCargo( self )
-    end
-
-    
-  end
-
-  --- Get the transportation method of the Cargo.
-  -- @param #CARGO_CRATE self
-  -- @return #string The transportation method of the Cargo.
-  function CARGO_CRATE:GetTransportationMethod()
-    if self:IsLoaded() then
-      return "for unloading"
-    else
-      if self:IsUnLoaded() then
-        return "for loading"
-      else
-        if self:IsDeployed() then
-          return "delivered"
-        end
-      end
-    end
-    return ""
-  end
-  
-end
-

Moose Development/Moose/Cargo/CargoGroup.lua

@@ -1,775 +0,0 @@
---- **Cargo** -- Management of grouped cargo logistics, which are based on a @{Wrapper.Group} object.
---
--- ===
--- 
--- ### [Demo Missions]()
--- 
--- ### [YouTube Playlist]()
--- 
--- ===
--- 
--- ### Author: **FlightControl**
--- ### Contributions: 
--- 
--- ===
--- 
--- @module Cargo.CargoGroup
--- @image Cargo_Groups.JPG
-
-
-do -- CARGO_GROUP
-
-  --- @type CARGO_GROUP
-  -- @extends Cargo.Cargo#CARGO_REPORTABLE
-  -- @field Core.Set#SET_CARGO CargoSet The collection of derived CARGO objects.
-  -- @field #string GroupName The name of the CargoGroup.
-  
-  --- Defines a cargo that is represented by a @{Wrapper.Group} object within the simulator.
-  -- The cargo can be Loaded, UnLoaded, Boarded, UnBoarded to and from Carriers.
-  -- 
-  -- The above cargo classes are used by the following AI_CARGO_ classes to allow AI groups to transport cargo:
-  -- 
-  --   * AI Armoured Personnel Carriers to transport cargo and engage in battles, using the @{AI.AI_Cargo_APC} module.
-  --   * AI Helicopters to transport cargo, using the @{AI.AI_Cargo_Helicopter} module.
-  --   * AI Planes to transport cargo, using the @{AI.AI_Cargo_Airplane} module.
-  --   * AI Ships is planned.
-  -- 
-  -- The above cargo classes are also used by the TASK_CARGO_ classes to allow human players to transport cargo as part of a tasking:
-  -- 
-  --   * @{Tasking.Task_Cargo_Transport#TASK_CARGO_TRANSPORT} to transport cargo by human players.
-  --   * @{Tasking.Task_Cargo_Transport#TASK_CARGO_CSAR} to transport downed pilots by human players.
-  -- 
-  -- @field #CARGO_GROUP CARGO_GROUP
-  -- 
-  CARGO_GROUP = {
-    ClassName = "CARGO_GROUP",
-  }
-
-  --- CARGO_GROUP constructor.
-  -- This make a new CARGO_GROUP from a @{Wrapper.Group} object.
-  -- It will "ungroup" the group object within the sim, and will create a @{Set} of individual Unit objects.
-  -- @param #CARGO_GROUP self
-  -- @param Wrapper.Group#GROUP CargoGroup Group to be transported as cargo.
-  -- @param #string Type Cargo type, e.g. "Infantry". This is the type used in SET_CARGO:New():FilterTypes("Infantry") to define the valid cargo groups of the set.
-  -- @param #string Name A user defined name of the cargo group. This name CAN be the same as the group object but can also have a different name. This name MUST be unique!
-  -- @param #number LoadRadius (optional) Distance in meters until which a cargo is loaded into the carrier. Cargo outside this radius has to be routed by other means to within the radius to be loaded.
-  -- @param #number NearRadius (optional) Once the units are within this radius of the carrier, they are actually loaded, i.e. disappear from the scene.
-  -- @return #CARGO_GROUP Cargo group object.
-  function CARGO_GROUP:New( CargoGroup, Type, Name, LoadRadius, NearRadius )
-    local self = BASE:Inherit( self, CARGO_REPORTABLE:New( Type, Name, 0, LoadRadius, NearRadius ) ) -- #CARGO_GROUP
-    self:F( { Type, Name, LoadRadius } )
-  
-    self.CargoSet = SET_CARGO:New()
-    self.CargoGroup = CargoGroup
-    self.Grouped = true
-    self.CargoUnitTemplate = {}
-    
-    self.NearRadius = NearRadius
-    
-    self:SetDeployed( false )
-    
-    local WeightGroup = 0
-    local VolumeGroup = 0
-    
-    self.CargoGroup:Destroy() -- destroy and generate a unit removal event, so that the database gets cleaned, and the linked sets get properly cleaned.
-
-    local GroupName = CargoGroup:GetName()
-    self.CargoName = Name
-    self.CargoTemplate = UTILS.DeepCopy( _DATABASE:GetGroupTemplate( GroupName ) )
-
-    self.GroupTemplate = UTILS.DeepCopy( self.CargoTemplate )
-    self.GroupTemplate.name = self.CargoName .. "#CARGO"
-    self.GroupTemplate.groupId = nil
-    
-    self.GroupTemplate.units = {}
-    
-    for UnitID, UnitTemplate in pairs( self.CargoTemplate.units ) do
-      UnitTemplate.name = UnitTemplate.name .. "#CARGO"
-      local CargoUnitName = UnitTemplate.name
-      self.CargoUnitTemplate[CargoUnitName] = UnitTemplate      
-
-       self.GroupTemplate.units[#self.GroupTemplate.units+1] = self.CargoUnitTemplate[CargoUnitName]
-       self.GroupTemplate.units[#self.GroupTemplate.units].unitId = nil
-      
-      -- And we register the spawned unit as part of the CargoSet.
-      local Unit = UNIT:Register( CargoUnitName )
-      
-    end
-
-    -- Then we register the new group in the database
-    self.CargoGroup = GROUP:NewTemplate( self.GroupTemplate, self.GroupTemplate.CoalitionID, self.GroupTemplate.CategoryID, self.GroupTemplate.CountryID )
-    
-    -- Now we spawn the new group based on the template created.
-    self.CargoObject = _DATABASE:Spawn( self.GroupTemplate )
-    
-    for CargoUnitID, CargoUnit in pairs( self.CargoObject:GetUnits() ) do
-      
-
-      local CargoUnitName = CargoUnit:GetName()
-
-      local Cargo = CARGO_UNIT:New( CargoUnit, Type, CargoUnitName, LoadRadius, NearRadius )
-      self.CargoSet:Add( CargoUnitName, Cargo )
-
-      WeightGroup = WeightGroup + Cargo:GetWeight()
-
-    end
-  
-    self:SetWeight( WeightGroup )
-    
-    self:T( { "Weight Cargo", WeightGroup } )
-  
-    -- Cargo objects are added to the _DATABASE and SET_CARGO objects.
-    _EVENTDISPATCHER:CreateEventNewCargo( self )
-    
-    self:HandleEvent( EVENTS.Dead, self.OnEventCargoDead )
-    self:HandleEvent( EVENTS.Crash, self.OnEventCargoDead )
-    --self:HandleEvent( EVENTS.RemoveUnit, self.OnEventCargoDead )
-    self:HandleEvent( EVENTS.PlayerLeaveUnit, self.OnEventCargoDead )
-    
-    self:SetEventPriority( 4 )
-    
-    return self
-  end
-
-
-  --- Respawn the CargoGroup.
-  -- @param #CARGO_GROUP self
-  function CARGO_GROUP:Respawn()
-
-    self:F( { "Respawning" } )
-
-    for CargoID, CargoData in pairs( self.CargoSet:GetSet() ) do
-      local Cargo = CargoData -- Cargo.Cargo#CARGO
-      Cargo:Destroy() -- Destroy the cargo and generate a remove unit event to update the sets.
-      Cargo:SetStartState( "UnLoaded" )
-    end
-
-    -- Now we spawn the new group based on the template created.
-    _DATABASE:Spawn( self.GroupTemplate )
-      
-    for CargoUnitID, CargoUnit in pairs( self.CargoObject:GetUnits() ) do
-
-      local CargoUnitName = CargoUnit:GetName()
-
-      local Cargo = CARGO_UNIT:New( CargoUnit, self.Type, CargoUnitName, self.LoadRadius )
-      self.CargoSet:Add( CargoUnitName, Cargo )
-
-    end
-  
-    self:SetDeployed( false )
-    self:SetStartState( "UnLoaded" )
-    
-  end
-  
-  --- Ungroup the cargo group into individual groups with one unit.
-  -- This is required because by default a group will move in formation and this is really an issue for group control.
-  -- Therefore this method is made to be able to ungroup a group.
-  -- This works for ground only groups.
-  -- @param #CARGO_GROUP self
-  function CARGO_GROUP:Ungroup()
-
-    if self.Grouped == true then
-    
-      self.Grouped = false
-      
-      self.CargoGroup:Destroy()
-      
-      for CargoUnitName, CargoUnit in pairs( self.CargoSet:GetSet() ) do
-        local CargoUnit = CargoUnit -- Cargo.CargoUnit#CARGO_UNIT
-
-        if CargoUnit:IsUnLoaded() then
-          local GroupTemplate = UTILS.DeepCopy( self.CargoTemplate )
-          --local GroupName = env.getValueDictByKey( GroupTemplate.name )
-          
-          -- We create a new group object with one unit...
-          -- First we prepare the template...
-          GroupTemplate.name = self.CargoName .. "#CARGO#" .. CargoUnitName 
-          GroupTemplate.groupId = nil
-          
-          if CargoUnit:IsUnLoaded() then
-            GroupTemplate.units = {}
-            GroupTemplate.units[1] = self.CargoUnitTemplate[CargoUnitName]
-            GroupTemplate.units[#GroupTemplate.units].unitId = nil
-            GroupTemplate.units[#GroupTemplate.units].x = CargoUnit:GetX()
-            GroupTemplate.units[#GroupTemplate.units].y = CargoUnit:GetY()
-            GroupTemplate.units[#GroupTemplate.units].heading = CargoUnit:GetHeading()
-          end
-      
-      
-          -- Then we register the new group in the database
-          local CargoGroup = GROUP:NewTemplate( GroupTemplate, GroupTemplate.CoalitionID, GroupTemplate.CategoryID, GroupTemplate.CountryID)
-          
-          -- Now we spawn the new group based on the template created.
-          _DATABASE:Spawn( GroupTemplate )
-        end
-      end
-      
-      self.CargoObject = nil
-    end
-    
-  
-  end
-
-  --- Regroup the cargo group into one group with multiple unit.
-  -- This is required because by default a group will move in formation and this is really an issue for group control.
-  -- Therefore this method is made to be able to regroup a group.
-  -- This works for ground only groups.
-  -- @param #CARGO_GROUP self
-  function CARGO_GROUP:Regroup()
-  
-    self:F("Regroup")
-
-    if self.Grouped == false then
-    
-      self.Grouped = true
-      
-      local GroupTemplate = UTILS.DeepCopy( self.CargoTemplate )
-      GroupTemplate.name = self.CargoName .. "#CARGO"
-      GroupTemplate.groupId = nil
-      GroupTemplate.units = {}
-
-      for CargoUnitName, CargoUnit in pairs( self.CargoSet:GetSet() ) do
-        local CargoUnit = CargoUnit -- Cargo.CargoUnit#CARGO_UNIT
-
-        self:F( { CargoUnit:GetName(), UnLoaded = CargoUnit:IsUnLoaded() } )
-
-        if CargoUnit:IsUnLoaded() then
-    
-          CargoUnit.CargoObject:Destroy()
-
-          GroupTemplate.units[#GroupTemplate.units+1] = self.CargoUnitTemplate[CargoUnitName]
-          GroupTemplate.units[#GroupTemplate.units].unitId = nil
-          GroupTemplate.units[#GroupTemplate.units].x = CargoUnit:GetX()
-          GroupTemplate.units[#GroupTemplate.units].y = CargoUnit:GetY()
-          GroupTemplate.units[#GroupTemplate.units].heading = CargoUnit:GetHeading()
-        end
-      end
-
-      -- Then we register the new group in the database
-      self.CargoGroup = GROUP:NewTemplate( GroupTemplate, GroupTemplate.CoalitionID, GroupTemplate.CategoryID, GroupTemplate.CountryID )
-
-      self:F( { "Regroup", GroupTemplate } )
-        
-      -- Now we spawn the new group based on the template created.
-      self.CargoObject = _DATABASE:Spawn( GroupTemplate )
-    end
-  
-  end
-
-
-  --- @param #CARGO_GROUP self
-  -- @param Core.Event#EVENTDATA EventData 
-  function CARGO_GROUP:OnEventCargoDead( EventData )
-  
-    self:E(EventData)
-
-    local Destroyed = false
-  
-    if self:IsDestroyed() or self:IsUnLoaded() or self:IsBoarding() or self:IsUnboarding() then
-      Destroyed = true
-      for CargoID, CargoData in pairs( self.CargoSet:GetSet() ) do
-        local Cargo = CargoData -- Cargo.Cargo#CARGO
-        if Cargo:IsAlive() then
-          Destroyed = false
-        else
-          Cargo:Destroyed()
-        end
-      end
-    else
-      local CarrierName = self.CargoCarrier:GetName()
-      if CarrierName == EventData.IniDCSUnitName then
-        MESSAGE:New( "Cargo is lost from carrier " .. CarrierName, 15 ):ToAll()
-        Destroyed = true
-        self.CargoCarrier:ClearCargo()
-      end
-    end
-    
-    if Destroyed then
-      self:Destroyed()
-      self:E( { "Cargo group destroyed" } )
-    end
-  
-  end
-
-  --- Enter Boarding State.
-  -- @param #CARGO_GROUP self
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  -- @param Wrapper.Unit#UNIT CargoCarrier
-  -- @param #number NearRadius If distance is smaller than this number, cargo is loaded into the carrier.
-  function CARGO_GROUP:onenterBoarding( From, Event, To, CargoCarrier, NearRadius, ... )
-    self:F( { CargoCarrier.UnitName, From, Event, To, NearRadius = NearRadius } )
-    
-    NearRadius = NearRadius or self.NearRadius
-    
-    if From == "UnLoaded" then
-  
-      -- For each Cargo object within the CARGO_GROUPED, route each object to the CargoLoadPointVec2
-      self.CargoSet:ForEach(
-        function( Cargo, ... )
-          Cargo:__Board( 1, CargoCarrier, NearRadius, ... )
-        end, ...
-      )
-      
-      self:__Boarding( 1, CargoCarrier, NearRadius, ... )
-    end
-    
-  end
-
-  --- Enter Loaded State.
-  -- @param #CARGO_GROUP self
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  -- @param Wrapper.Unit#UNIT CargoCarrier
-  function CARGO_GROUP:onenterLoaded( From, Event, To, CargoCarrier, ... )
-    --self:F( { From, Event, To, CargoCarrier, ...} )
-    
-    if From == "UnLoaded" then
-      -- For each Cargo object within the CARGO_GROUP, load each cargo to the CargoCarrier.
-      for CargoID, Cargo in pairs( self.CargoSet:GetSet() ) do
-        Cargo:Load( CargoCarrier )
-      end
-    end
-    
-    --self.CargoObject:Destroy()
-    self.CargoCarrier = CargoCarrier
-    self.CargoCarrier:AddCargo( self )
-    
-  end
-
-  --- Leave Boarding State.
-  -- @param #CARGO_GROUP self  
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  -- @param Wrapper.Unit#UNIT CargoCarrier
-  -- @param #number NearRadius If distance is smaller than this number, cargo is loaded into the carrier.
-  function CARGO_GROUP:onafterBoarding( From, Event, To, CargoCarrier, NearRadius, ... )
-    --self:F( { CargoCarrier.UnitName, From, Event, To } )
-  
-    local Boarded = true
-    local Cancelled = false
-    local Dead = true
-  
-    self.CargoSet:Flush()
-  
-    -- For each Cargo object within the CARGO_GROUP, route each object to the CargoLoadPointVec2
-    for CargoID, Cargo in pairs( self.CargoSet:GetSet() ) do
-      --self:T( { Cargo:GetName(), Cargo.current } )
-      
-      
-      if not Cargo:is( "Loaded" ) 
-      and (not Cargo:is( "Destroyed" )) then -- If one or more units of a group defined as CARGO_GROUP died, the CARGO_GROUP:Board() command does not trigger the CARGO_GRUOP:OnEnterLoaded() function.
-        Boarded = false
-      end
-      
-      if Cargo:is( "UnLoaded" ) then
-        Cancelled = true
-      end
-  
-      if not Cargo:is( "Destroyed" ) then
-        Dead = false
-      end
-      
-    end
-  
-    if not Dead then
-  
-      if not Cancelled then
-        if not Boarded then
-          self:__Boarding( -5, CargoCarrier, NearRadius, ... )
-        else
-          self:F("Group Cargo is loaded")
-          self:__Load( 1, CargoCarrier, ... )
-        end
-      else
-          self:__CancelBoarding( 1, CargoCarrier, NearRadius, ... )
-      end
-    else
-      self:__Destroyed( 1, CargoCarrier, NearRadius, ... )
-    end
-    
-  end
-
-  --- Enter UnBoarding State.
-  -- @param #CARGO_GROUP self
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  -- @param Core.Point#POINT_VEC2 ToPointVec2
-  -- @param #number NearRadius If distance is smaller than this number, cargo is loaded into the carrier.
-  function CARGO_GROUP:onenterUnBoarding( From, Event, To, ToPointVec2, NearRadius, ... )
-    self:F( {From, Event, To, ToPointVec2, NearRadius } )
-  
-    NearRadius = NearRadius or 25
-  
-    local Timer = 1
-  
-    if From == "Loaded" then
-    
-      if self.CargoObject then
-        self.CargoObject:Destroy()
-      end
-  
-      -- For each Cargo object within the CARGO_GROUP, route each object to the CargoLoadPointVec2
-      self.CargoSet:ForEach(
-        --- @param Cargo.Cargo#CARGO Cargo
-        function( Cargo, NearRadius )
-          if not Cargo:IsDestroyed() then
-            local ToVec=nil
-            if ToPointVec2==nil then
-              ToVec=self.CargoCarrier:GetPointVec2():GetRandomPointVec2InRadius(2*NearRadius, NearRadius)
-            else
-              ToVec=ToPointVec2
-            end
-            Cargo:__UnBoard( Timer, ToVec, NearRadius )
-            Timer = Timer + 1
-          end
-        end, { NearRadius }
-      )
-      
-      
-      self:__UnBoarding( 1, ToPointVec2, NearRadius, ... )
-    end
-  
-  end
-
-  --- Leave UnBoarding State.
-  -- @param #CARGO_GROUP self
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  -- @param Core.Point#POINT_VEC2 ToPointVec2
-  -- @param #number NearRadius If distance is smaller than this number, cargo is loaded into the carrier.
-  function CARGO_GROUP:onleaveUnBoarding( From, Event, To, ToPointVec2, NearRadius, ... )
-    --self:F( { From, Event, To, ToPointVec2, NearRadius } )
-  
-    --local NearRadius = NearRadius or 25
-  
-    local Angle = 180
-    local Speed = 10
-    local Distance = 5
-  
-    if From == "UnBoarding" then
-      local UnBoarded = true
-  
-      -- For each Cargo object within the CARGO_GROUP, route each object to the CargoLoadPointVec2
-      for CargoID, Cargo in pairs( self.CargoSet:GetSet() ) do
-        self:T( { Cargo:GetName(), Cargo.current } )
-        if not Cargo:is( "UnLoaded" ) and not Cargo:IsDestroyed() then
-          UnBoarded = false
-        end
-      end
-    
-      if UnBoarded then
-        return true
-      else
-        self:__UnBoarding( 1, ToPointVec2, NearRadius, ... )
-      end
-      
-      return false
-    end
-    
-  end
-
-  --- UnBoard Event.
-  -- @param #CARGO_GROUP self
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  -- @param Core.Point#POINT_VEC2 ToPointVec2
-  -- @param #number NearRadius If distance is smaller than this number, cargo is loaded into the carrier.
-  function CARGO_GROUP:onafterUnBoarding( From, Event, To, ToPointVec2, NearRadius, ... )
-    --self:F( { From, Event, To, ToPointVec2, NearRadius } )
-  
-    --local NearRadius = NearRadius or 25
-  
-    self:__UnLoad( 1, ToPointVec2, ... )
-  end
-
-
-
-  --- Enter UnLoaded State.
-  -- @param #CARGO_GROUP self
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  -- @param Core.Point#POINT_VEC2
-  function CARGO_GROUP:onenterUnLoaded( From, Event, To, ToPointVec2, ... )
-    --self:F( { From, Event, To, ToPointVec2 } )
-  
-    if From == "Loaded" then
-      
-      -- For each Cargo object within the CARGO_GROUP, route each object to the CargoLoadPointVec2
-      self.CargoSet:ForEach(
-        function( Cargo )
-          --Cargo:UnLoad( ToPointVec2 )
-          local RandomVec2=ToPointVec2:GetRandomPointVec2InRadius(20, 10)
-          Cargo:UnLoad( RandomVec2 )
-        end
-      )
-  
-    end
-    
-    self.CargoCarrier:RemoveCargo( self )
-    self.CargoCarrier = nil
-    
-  end
-
-
-  --- Get the current Coordinate of the CargoGroup.
-  -- @param #CARGO_GROUP self
-  -- @return Core.Point#COORDINATE The current Coordinate of the first Cargo of the CargoGroup.
-  -- @return #nil There is no valid Cargo in the CargoGroup.
-  function CARGO_GROUP:GetCoordinate()
-    local Cargo = self:GetFirstAlive() -- Cargo.Cargo#CARGO
-    
-    if Cargo then
-      return Cargo.CargoObject:GetCoordinate()
-    end
-    
-    return nil
-  end
-
-  --- Get the x position of the cargo.
-  -- @param #CARGO_GROUP self
-  -- @return #number
-  function CARGO:GetX()
-
-    local Cargo = self:GetFirstAlive() -- Cargo.Cargo#CARGO
-
-    if Cargo then
-      return Cargo:GetCoordinate().x
-    end 
-    
-    return nil
-  end
-  
-  --- Get the y position of the cargo.
-  -- @param #CARGO_GROUP self
-  -- @return #number
-  function CARGO:GetY()
-
-    local Cargo = self:GetFirstAlive() -- Cargo.Cargo#CARGO
-
-    if Cargo then
-      return Cargo:GetCoordinate().z
-    end
-    
-    return nil 
-  end
-  
-
-
-  --- Check if the CargoGroup is alive.
-  -- @param #CARGO_GROUP self
-  -- @return #boolean true if the CargoGroup is alive.
-  -- @return #boolean false if the CargoGroup is dead.
-  function CARGO_GROUP:IsAlive()
-
-    local Cargo = self:GetFirstAlive() -- Cargo.Cargo#CARGO
-    return Cargo ~= nil
-  
-  end
-
-  
-  --- Get the first alive Cargo Unit of the Cargo Group.
-  -- @param #CARGO_GROUP self
-  -- @return #CARGO_GROUP
-  function CARGO_GROUP:GetFirstAlive()
-    
-    local CargoFirstAlive = nil
-    
-    for _, Cargo in pairs( self.CargoSet:GetSet() ) do
-      if not Cargo:IsDestroyed() then
-        CargoFirstAlive = Cargo
-        break
-      end
-    end
-    return CargoFirstAlive
-  end
-
-  
-  --- Get the amount of cargo units in the group.
-  -- @param #CARGO_GROUP self
-  -- @return #CARGO_GROUP
-  function CARGO_GROUP:GetCount()
-    return self.CargoSet:Count()
-  end
-
-
-  --- Get the amount of cargo units in the group.
-  -- @param #CARGO_GROUP self
-  -- @return #CARGO_GROUP
-  function CARGO_GROUP:GetGroup( Cargo )
-    local Cargo = Cargo or self:GetFirstAlive() -- Cargo.Cargo#CARGO
-    return Cargo.CargoObject:GetGroup()
-  end
-
-
-  --- Route Cargo to Coordinate and randomize locations.
-  -- @param #CARGO_GROUP self
-  -- @param Core.Point#COORDINATE Coordinate
-  function CARGO_GROUP:RouteTo( Coordinate )
-    --self:F( {Coordinate = Coordinate } )
-    
-    -- For each Cargo within the CargoSet, route each object to the Coordinate
-    self.CargoSet:ForEach(
-      function( Cargo )
-        Cargo.CargoObject:RouteGroundTo( Coordinate, 10, "vee", 0 )
-      end
-    )
-
-  end
-  
-  --- Check if Cargo is near to the Carrier.
-  -- The Cargo is near to the Carrier if the first unit of the Cargo Group is within NearRadius.
-  -- @param #CARGO_GROUP self
-  -- @param Wrapper.Group#GROUP CargoCarrier
-  -- @param #number NearRadius
-  -- @return #boolean The Cargo is near to the Carrier or #nil if the Cargo is not near to the Carrier.
-  function CARGO_GROUP:IsNear( CargoCarrier, NearRadius )
-    self:F( {NearRadius = NearRadius } )
-    
-    for _, Cargo in pairs( self.CargoSet:GetSet() ) do
-      local Cargo = Cargo -- Cargo.Cargo#CARGO
-      if Cargo:IsAlive() then
-        if Cargo:IsNear( CargoCarrier:GetCoordinate(), NearRadius ) then
-          self:F( "Near" )
-          return true
-        end
-      end
-    end
-    
-    return nil
-  end
-
-  --- Check if Cargo Group is in the radius for the Cargo to be Boarded.
-  -- @param #CARGO_GROUP self
-  -- @param Core.Point#COORDINATE Coordinate
-  -- @return #boolean true if the Cargo Group is within the load radius.
-  function CARGO_GROUP:IsInLoadRadius( Coordinate )
-    --self:F( { Coordinate } )
-  
-    local Cargo = self:GetFirstAlive() -- Cargo.Cargo#CARGO
-
-    if Cargo then
-      local Distance = 0
-      local CargoCoordinate
-      if Cargo:IsLoaded() then
-        CargoCoordinate = Cargo.CargoCarrier:GetCoordinate()
-      else
-        CargoCoordinate = Cargo.CargoObject:GetCoordinate()
-      end
-
-      -- FF check if coordinate could be obtained. This was commented out for some (unknown) reason. But the check seems valid!      
-      if CargoCoordinate then
-        Distance = Coordinate:Get2DDistance( CargoCoordinate )
-      else
-        return false
-      end
-      
-      self:F( { Distance = Distance, LoadRadius = self.LoadRadius } )
-      if Distance <= self.LoadRadius then
-        return true
-      else
-        return false
-      end
-    end
-    
-    return nil
-  
-  end
-
-
-  --- Check if Cargo Group is in the report radius.
-  -- @param #CARGO_GROUP self
-  -- @param Core.Point#Coordinate Coordinate
-  -- @return #boolean true if the Cargo Group is within the report radius.
-  function CARGO_GROUP:IsInReportRadius( Coordinate )
-    --self:F( { Coordinate } )
-  
-    local Cargo = self:GetFirstAlive() -- Cargo.Cargo#CARGO
-
-    if Cargo then
-      self:F( { Cargo } )
-      local Distance = 0
-      if Cargo:IsUnLoaded() then
-        Distance = Coordinate:Get2DDistance( Cargo.CargoObject:GetCoordinate() )
-        --self:T( Distance )
-        if Distance <= self.LoadRadius then
-          return true
-        end
-      end
-    end
-    
-    return nil
-  
-  end
-
-
-  --- Signal a flare at the position of the CargoGroup.
-  -- @param #CARGO_GROUP self
-  -- @param Utilities.Utils#FLARECOLOR FlareColor
-  function CARGO_GROUP:Flare( FlareColor )
-
-    local Cargo = self.CargoSet:GetFirst() -- Cargo.Cargo#CARGO
-    if Cargo then
-      Cargo:Flare( FlareColor )
-    end
-  end
-  
-  --- Smoke the CargoGroup.
-  -- @param #CARGO_GROUP self
-  -- @param Utilities.Utils#SMOKECOLOR SmokeColor The color of the smoke.
-  -- @param #number Radius The radius of randomization around the center of the first element of the CargoGroup.
-  function CARGO_GROUP:Smoke( SmokeColor, Radius )
-
-    local Cargo = self.CargoSet:GetFirst() -- Cargo.Cargo#CARGO
-
-    if Cargo then
-      Cargo:Smoke( SmokeColor, Radius )
-    end
-  end
-  
-  --- Check if the first element of the CargoGroup is the given @{Zone}.
-  -- @param #CARGO_GROUP self
-  -- @param Core.Zone#ZONE_BASE Zone
-  -- @return #boolean **true** if the first element of the CargoGroup is in the Zone
-  -- @return #boolean **false** if there is no element of the CargoGroup in the Zone.
-  function CARGO_GROUP:IsInZone( Zone )
-    --self:F( { Zone } )
-  
-    local Cargo = self.CargoSet:GetFirst() -- Cargo.Cargo#CARGO
-
-    if Cargo then
-      return Cargo:IsInZone( Zone )
-    end
-    
-    return nil
-  
-  end
-
-  --- Get the transportation method of the Cargo.
-  -- @param #CARGO_GROUP self
-  -- @return #string The transportation method of the Cargo.
-  function CARGO_GROUP:GetTransportationMethod()
-    if self:IsLoaded() then
-      return "for unboarding"
-    else
-      if self:IsUnLoaded() then
-        return "for boarding"
-      else
-        if self:IsDeployed() then
-          return "delivered"
-        end
-      end
-    end
-    return ""
-  end
-
-    
-
-end -- CARGO_GROUP

Moose Development/Moose/Cargo/CargoSlingload.lua

@@ -1,270 +0,0 @@
---- **Cargo** -- Management of single cargo crates, which are based on a @{Static} object. The cargo can only be slingloaded.
---
--- ===
--- 
--- ### [Demo Missions]()
--- 
--- ### [YouTube Playlist]()
--- 
--- ===
--- 
--- ### Author: **FlightControl**
--- ### Contributions: 
--- 
--- ===
--- 
--- @module Cargo.CargoSlingload
--- @image Cargo_Slingload.JPG
-
-
-do -- CARGO_SLINGLOAD
-
-  --- Models the behaviour of cargo crates, which can only be slingloaded. 
-  -- @type CARGO_SLINGLOAD
-  -- @extends Cargo.Cargo#CARGO_REPRESENTABLE
-  
-  --- Defines a cargo that is represented by a UNIT object within the simulator, and can be transported by a carrier.
-  -- 
-  -- The above cargo classes are also used by the TASK_CARGO_ classes to allow human players to transport cargo as part of a tasking:
-  -- 
-  --   * @{Tasking.Task_Cargo_Transport#TASK_CARGO_TRANSPORT} to transport cargo by human players.
-  --   * @{Tasking.Task_Cargo_Transport#TASK_CARGO_CSAR} to transport downed pilots by human players.
-  -- 
-  -- ===
-  -- 
-  -- @field #CARGO_SLINGLOAD
-  CARGO_SLINGLOAD = {
-    ClassName = "CARGO_SLINGLOAD"
-  }
-  
-  --- CARGO_SLINGLOAD Constructor.
-  -- @param #CARGO_SLINGLOAD self
-  -- @param Wrapper.Static#STATIC CargoStatic
-  -- @param #string Type
-  -- @param #string Name
-  -- @param #number LoadRadius (optional)
-  -- @param #number NearRadius (optional)
-  -- @return #CARGO_SLINGLOAD
-  function CARGO_SLINGLOAD:New( CargoStatic, Type, Name, LoadRadius, NearRadius )
-    local self = BASE:Inherit( self, CARGO_REPRESENTABLE:New( CargoStatic, Type, Name, nil, LoadRadius, NearRadius ) ) -- #CARGO_SLINGLOAD
-    self:F( { Type, Name, NearRadius } )
-  
-    self.CargoObject = CargoStatic
-  
-    -- Cargo objects are added to the _DATABASE and SET_CARGO objects.
-    _EVENTDISPATCHER:CreateEventNewCargo( self )
-    
-    self:HandleEvent( EVENTS.Dead, self.OnEventCargoDead )
-    self:HandleEvent( EVENTS.Crash, self.OnEventCargoDead )
-    --self:HandleEvent( EVENTS.RemoveUnit, self.OnEventCargoDead )
-    self:HandleEvent( EVENTS.PlayerLeaveUnit, self.OnEventCargoDead )
-    
-    self:SetEventPriority( 4 )
-    
-    self.NearRadius = NearRadius or 25
-  
-    return self
-  end
-
-
-  --- @param #CARGO_SLINGLOAD self
-  -- @param Core.Event#EVENTDATA EventData 
-  function CARGO_SLINGLOAD:OnEventCargoDead( EventData )
-
-    local Destroyed = false
-  
-    if self:IsDestroyed() or self:IsUnLoaded() then
-      if self.CargoObject:GetName() == EventData.IniUnitName then
-        if not self.NoDestroy then 
-          Destroyed = true
-        end
-      end
-    end
-    
-    if Destroyed then
-      self:I( { "Cargo crate destroyed: " .. self.CargoObject:GetName() } )
-      self:Destroyed()
-    end
-  
-  end
-  
-  
-  --- Check if the cargo can be Slingloaded.
-  -- @param #CARGO_SLINGLOAD self
-  function CARGO_SLINGLOAD:CanSlingload()
-    return true
-  end
-  
-  --- Check if the cargo can be Boarded.
-  -- @param #CARGO_SLINGLOAD self
-  function CARGO_SLINGLOAD:CanBoard()
-    return false
-  end
-
-  --- Check if the cargo can be Unboarded.
-  -- @param #CARGO_SLINGLOAD self
-  function CARGO_SLINGLOAD:CanUnboard()
-    return false
-  end
-
-  --- Check if the cargo can be Loaded.
-  -- @param #CARGO_SLINGLOAD self
-  function CARGO_SLINGLOAD:CanLoad()
-    return false
-  end
-
-  --- Check if the cargo can be Unloaded.
-  -- @param #CARGO_SLINGLOAD self
-  function CARGO_SLINGLOAD:CanUnload()
-    return false
-  end
-
-
-  --- Check if Cargo Crate is in the radius for the Cargo to be reported.
-  -- @param #CARGO_SLINGLOAD self
-  -- @param Core.Point#COORDINATE Coordinate
-  -- @return #boolean true if the Cargo Crate is within the report radius.
-  function CARGO_SLINGLOAD:IsInReportRadius( Coordinate )
-    --self:F( { Coordinate, LoadRadius = self.LoadRadius } )
-  
-    local Distance = 0
-    if self:IsUnLoaded() then
-      Distance = Coordinate:Get2DDistance( self.CargoObject:GetCoordinate() )
-      if Distance <= self.LoadRadius then
-        return true
-      end
-    end
-    
-    return false
-  end
-
-
-  --- Check if Cargo Slingload is in the radius for the Cargo to be Boarded or Loaded.
-  -- @param #CARGO_SLINGLOAD self
-  -- @param Core.Point#COORDINATE Coordinate
-  -- @return #boolean true if the Cargo Slingload is within the loading radius.
-  function CARGO_SLINGLOAD:IsInLoadRadius( Coordinate )
-    --self:F( { Coordinate } )
-  
-    local Distance = 0
-    if self:IsUnLoaded() then
-      Distance = Coordinate:Get2DDistance( self.CargoObject:GetCoordinate() )
-      if Distance <= self.NearRadius then
-        return true
-      end
-    end
-    
-    return false
-  end
-
-
-
-  --- Get the current Coordinate of the CargoGroup.
-  -- @param #CARGO_SLINGLOAD self
-  -- @return Core.Point#COORDINATE The current Coordinate of the first Cargo of the CargoGroup.
-  -- @return #nil There is no valid Cargo in the CargoGroup.
-  function CARGO_SLINGLOAD:GetCoordinate()
-    --self:F()
-    
-    return self.CargoObject:GetCoordinate()
-  end
-
-  --- Check if the CargoGroup is alive.
-  -- @param #CARGO_SLINGLOAD self
-  -- @return #boolean true if the CargoGroup is alive.
-  -- @return #boolean false if the CargoGroup is dead.
-  function CARGO_SLINGLOAD:IsAlive()
-
-    local Alive = true
-  
-    -- When the Cargo is Loaded, the Cargo is in the CargoCarrier, so we check if the CargoCarrier is alive.
-    -- When the Cargo is not Loaded, the Cargo is the CargoObject, so we check if the CargoObject is alive.
-    if self:IsLoaded() then
-      Alive = Alive == true and self.CargoCarrier:IsAlive()
-    else
-      Alive = Alive == true and self.CargoObject:IsAlive()
-    end 
-    
-    return Alive
-  
-  end
-
-  
-  --- Route Cargo to Coordinate and randomize locations.
-  -- @param #CARGO_SLINGLOAD self
-  -- @param Core.Point#COORDINATE Coordinate
-  function CARGO_SLINGLOAD:RouteTo( Coordinate )
-    --self:F( {Coordinate = Coordinate } )
-    
-  end
-
-  
-  --- Check if Cargo is near to the Carrier.
-  -- The Cargo is near to the Carrier within NearRadius.
-  -- @param #CARGO_SLINGLOAD self
-  -- @param Wrapper.Group#GROUP CargoCarrier
-  -- @param #number NearRadius
-  -- @return #boolean The Cargo is near to the Carrier.
-  -- @return #nil The Cargo is not near to the Carrier.
-  function CARGO_SLINGLOAD:IsNear( CargoCarrier, NearRadius )
-    --self:F( {NearRadius = NearRadius } )
-    
-    return self:IsNear( CargoCarrier:GetCoordinate(), NearRadius )
-  end
-
-
-  --- Respawn the CargoGroup.
-  -- @param #CARGO_SLINGLOAD self
-  function CARGO_SLINGLOAD:Respawn()
-
-    --self:F( { "Respawning slingload " .. self:GetName() } )
-
-
-    -- Respawn the group...
-    if self.CargoObject then
-      self.CargoObject:ReSpawn() -- A cargo destroy crates a DEAD event.
-      self:__Reset( -0.1 )
-    end
-
-    
-  end
-
-
-  --- Respawn the CargoGroup.
-  -- @param #CARGO_SLINGLOAD self
-  function CARGO_SLINGLOAD:onafterReset()
-
-    --self:F( { "Reset slingload " .. self:GetName() } )
-
-
-    -- Respawn the group...
-    if self.CargoObject then
-      self:SetDeployed( false )
-      self:SetStartState( "UnLoaded" )
-      self.CargoCarrier = nil
-      -- Cargo objects are added to the _DATABASE and SET_CARGO objects.
-      _EVENTDISPATCHER:CreateEventNewCargo( self )
-    end
-
-    
-  end
-
-  --- Get the transportation method of the Cargo.
-  -- @param #CARGO_SLINGLOAD self
-  -- @return #string The transportation method of the Cargo.
-  function CARGO_SLINGLOAD:GetTransportationMethod()
-    if self:IsLoaded() then
-      return "for sling loading"
-    else
-      if self:IsUnLoaded() then
-        return "for sling loading"
-      else
-        if self:IsDeployed() then
-          return "delivered"
-        end
-      end
-    end
-    return ""
-  end
-   
-end

Moose Development/Moose/Cargo/CargoUnit.lua

@@ -1,397 +0,0 @@
---- **Cargo** -- Management of single cargo logistics, which are based on a @{Wrapper.Unit} object.
---
--- ===
--- 
--- ### [Demo Missions]()
--- 
--- ### [YouTube Playlist]()
--- 
--- ===
--- 
--- ### Author: **FlightControl**
--- ### Contributions: 
--- 
--- ===
--- 
--- @module Cargo.CargoUnit
--- @image Cargo_Units.JPG
-
-do -- CARGO_UNIT
-
-  --- Models CARGO in the form of units, which can be boarded, unboarded, loaded, unloaded. 
-  -- @type CARGO_UNIT
-  -- @extends Cargo.Cargo#CARGO_REPRESENTABLE
-  
-  --- Defines a cargo that is represented by a UNIT object within the simulator, and can be transported by a carrier.
-  -- Use the event functions as described above to Load, UnLoad, Board, UnBoard the CARGO_UNIT objects to and from carriers.
-  -- Note that ground forces behave in a group, and thus, act in formation, regardless if one unit is commanded to move.
-  -- 
-  -- This class is used in CARGO_GROUP, and is not meant to be used by mission designers individually.
-  -- 
-  -- ===
-  -- 
-  -- @field #CARGO_UNIT CARGO_UNIT
-  --
-  CARGO_UNIT = {
-    ClassName = "CARGO_UNIT"
-  }
-
-  --- CARGO_UNIT Constructor.
-  -- @param #CARGO_UNIT self
-  -- @param Wrapper.Unit#UNIT CargoUnit
-  -- @param #string Type
-  -- @param #string Name
-  -- @param #number Weight
-  -- @param #number LoadRadius (optional)
-  -- @param #number NearRadius (optional)
-  -- @return #CARGO_UNIT
-  function CARGO_UNIT:New( CargoUnit, Type, Name, LoadRadius, NearRadius )
-    local self = BASE:Inherit( self, CARGO_REPRESENTABLE:New( CargoUnit, Type, Name, LoadRadius, NearRadius ) ) -- #CARGO_UNIT
-    self:I( { Type, Name, LoadRadius, NearRadius } )
-  
-    self:T( CargoUnit )
-    self.CargoObject = CargoUnit
-  
-    self:T( self.ClassName )
-  
-    self:SetEventPriority( 5 )
-  
-    return self
-  end
-  
-  --- Enter UnBoarding State.
-  -- @param #CARGO_UNIT self
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  -- @param Core.Point#POINT_VEC2 ToPointVec2
-  -- @param #number NearRadius (optional) Defaut 25 m.
-  function CARGO_UNIT:onenterUnBoarding( From, Event, To, ToPointVec2, NearRadius )
-    self:F( { From, Event, To, ToPointVec2, NearRadius } )
-  
-    local Angle = 180
-    local Speed = 60
-    local DeployDistance = 9
-    local RouteDistance = 60
-  
-    if From == "Loaded" then
-  
-      if not self:IsDestroyed() then
-  
-        local CargoCarrier = self.CargoCarrier -- Wrapper.Controllable#CONTROLLABLE
-        
-        if CargoCarrier:IsAlive() then
-    
-          local CargoCarrierPointVec2 = CargoCarrier:GetPointVec2()
-          local CargoCarrierHeading = self.CargoCarrier:GetHeading() -- Get Heading of object in degrees.
-          local CargoDeployHeading = ( ( CargoCarrierHeading + Angle ) >= 360 ) and ( CargoCarrierHeading + Angle - 360 ) or ( CargoCarrierHeading + Angle )
-      
-      
-          local CargoRoutePointVec2 = CargoCarrierPointVec2:Translate( RouteDistance, CargoDeployHeading )
-          
-          
-          -- if there is no ToPointVec2 given, then use the CargoRoutePointVec2
-          local FromDirectionVec3 = CargoCarrierPointVec2:GetDirectionVec3( ToPointVec2 or CargoRoutePointVec2 )
-          local FromAngle = CargoCarrierPointVec2:GetAngleDegrees(FromDirectionVec3)
-          local FromPointVec2 = CargoCarrierPointVec2:Translate( DeployDistance, FromAngle )
-        --local CargoDeployPointVec2 = CargoCarrierPointVec2:GetRandomCoordinateInRadius( 10, 5 )
-  
-          ToPointVec2 = ToPointVec2 or CargoCarrierPointVec2:GetRandomCoordinateInRadius( NearRadius, DeployDistance )
-          
-          -- Respawn the group...
-          if self.CargoObject then
-            self.CargoObject:ReSpawnAt( FromPointVec2, CargoDeployHeading )
-            self:F( { "CargoUnits:", self.CargoObject:GetGroup():GetName() } )
-            self.CargoCarrier = nil
-      
-            local Points = {}
-            
-            -- From
-            Points[#Points+1] = FromPointVec2:WaypointGround( Speed, "Vee" )
-            
-            -- To
-            Points[#Points+1] = ToPointVec2:WaypointGround( Speed, "Vee" )
-        
-            local TaskRoute = self.CargoObject:TaskRoute( Points )
-            self.CargoObject:SetTask( TaskRoute, 1 )
-      
-            
-            self:__UnBoarding( 1, ToPointVec2, NearRadius )
-          end
-        else
-          -- the Carrier is dead. This cargo is dead too!
-          self:Destroyed()
-        end
-      end
-    end
-  
-  end
-  
-  --- Leave UnBoarding State.
-  -- @param #CARGO_UNIT self
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  -- @param Core.Point#POINT_VEC2 ToPointVec2
-  -- @param #number NearRadius (optional) Defaut 100 m.
-  function CARGO_UNIT:onleaveUnBoarding( From, Event, To, ToPointVec2, NearRadius )
-    self:F( { From, Event, To, ToPointVec2, NearRadius } )
-  
-    local Angle = 180
-    local Speed = 10
-    local Distance = 5
-  
-    if From == "UnBoarding" then
-      --if self:IsNear( ToPointVec2, NearRadius ) then
-        return true
-      --else
-        
-        --self:__UnBoarding( 1, ToPointVec2, NearRadius )
-      --end
-      --return false
-    end
-  
-  end
-  
-  --- UnBoard Event.
-  -- @param #CARGO_UNIT self
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  -- @param Core.Point#POINT_VEC2 ToPointVec2
-  -- @param #number NearRadius (optional) Defaut 100 m.
-  function CARGO_UNIT:onafterUnBoarding( From, Event, To, ToPointVec2, NearRadius )
-    self:F( { From, Event, To, ToPointVec2, NearRadius } )
-  
-    self.CargoInAir = self.CargoObject:InAir()
-  
-    self:T( self.CargoInAir )
-  
-    -- Only unboard the cargo when the carrier is not in the air.
-    -- (eg. cargo can be on a oil derrick, moving the cargo on the oil derrick will drop the cargo on the sea).
-    if not self.CargoInAir then
-  
-    end
-  
-    self:__UnLoad( 1, ToPointVec2, NearRadius )
-  
-  end
-  
-  
-  
-  --- Enter UnLoaded State.
-  -- @param #CARGO_UNIT self
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  -- @param Core.Point#POINT_VEC2
-  function CARGO_UNIT:onenterUnLoaded( From, Event, To, ToPointVec2 )
-    self:F( { ToPointVec2, From, Event, To } )
-  
-    local Angle = 180
-    local Speed = 10
-    local Distance = 5
-  
-    if From == "Loaded" then
-      local StartPointVec2 = self.CargoCarrier:GetPointVec2()
-      local CargoCarrierHeading = self.CargoCarrier:GetHeading() -- Get Heading of object in degrees.
-      local CargoDeployHeading = ( ( CargoCarrierHeading + Angle ) >= 360 ) and ( CargoCarrierHeading + Angle - 360 ) or ( CargoCarrierHeading + Angle )
-      local CargoDeployCoord = StartPointVec2:Translate( Distance, CargoDeployHeading )
-  
-      ToPointVec2 = ToPointVec2 or COORDINATE:New( CargoDeployCoord.x, CargoDeployCoord.z )
-  
-      -- Respawn the group...
-      if self.CargoObject then
-        self.CargoObject:ReSpawnAt( ToPointVec2, 0 )
-        self.CargoCarrier = nil
-      end
-      
-    end
-  
-    if self.OnUnLoadedCallBack then
-      self.OnUnLoadedCallBack( self, unpack( self.OnUnLoadedParameters ) )
-      self.OnUnLoadedCallBack = nil
-    end
-  
-  end
-  
-  --- Board Event.
-  -- @param #CARGO_UNIT self
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  -- @param Wrapper.Group#GROUP CargoCarrier
-  -- @param #number NearRadius
-  function CARGO_UNIT:onafterBoard( From, Event, To, CargoCarrier, NearRadius, ... )
-    self:F( { From, Event, To, CargoCarrier, NearRadius = NearRadius } )
-  
-    self.CargoInAir = self.CargoObject:InAir()
-    
-    local Desc = self.CargoObject:GetDesc()
-    local MaxSpeed = Desc.speedMaxOffRoad
-    local TypeName = Desc.typeName
-    
-    self:T( self.CargoInAir )
-  
-    -- Only move the group to the carrier when the cargo is not in the air
-    -- (eg. cargo can be on a oil derrick, moving the cargo on the oil derrick will drop the cargo on the sea).
-    if not self.CargoInAir then
-      -- If NearRadius is given, then use the given NearRadius, otherwise calculate the NearRadius 
-      -- based upon the Carrier bounding radius, which is calculated from the bounding rectangle on the Y axis.
-      local NearRadius = NearRadius or CargoCarrier:GetBoundingRadius() + 5
-      if self:IsNear( CargoCarrier:GetPointVec2(), NearRadius ) then
-        self:Load( CargoCarrier, NearRadius, ... )
-      else
-        if MaxSpeed and MaxSpeed == 0 or TypeName and TypeName == "Stinger comm" then
-          self:Load( CargoCarrier, NearRadius, ... )
-        else
-          
-          local Speed = 90
-          local Angle = 180
-          local Distance = 0
-          
-          local CargoCarrierPointVec2 = CargoCarrier:GetPointVec2()
-          local CargoCarrierHeading = CargoCarrier:GetHeading() -- Get Heading of object in degrees.
-          local CargoDeployHeading = ( ( CargoCarrierHeading + Angle ) >= 360 ) and ( CargoCarrierHeading + Angle - 360 ) or ( CargoCarrierHeading + Angle )
-          local CargoDeployPointVec2 = CargoCarrierPointVec2:Translate( Distance, CargoDeployHeading )
-          
-          -- Set the CargoObject to state Green to ensure it is boarding!
-          self.CargoObject:OptionAlarmStateGreen()
-          
-          local Points = {}
-        
-          local PointStartVec2 = self.CargoObject:GetPointVec2()
-        
-          Points[#Points+1] = PointStartVec2:WaypointGround( Speed )
-          Points[#Points+1] = CargoDeployPointVec2:WaypointGround( Speed )
-          
-          local TaskRoute = self.CargoObject:TaskRoute( Points )
-          self.CargoObject:SetTask( TaskRoute, 2 )
-          self:__Boarding( -5, CargoCarrier, NearRadius, ... )
-          self.RunCount = 0
-        end
-      end
-    end
-    
-  end
-  
-  
-  --- Boarding Event.
-  -- @param #CARGO_UNIT self
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  -- @param Wrapper.Client#CLIENT CargoCarrier
-  -- @param #number NearRadius Default 25 m.
-  function CARGO_UNIT:onafterBoarding( From, Event, To, CargoCarrier, NearRadius, ... )
-    self:F( { From, Event, To, CargoCarrier:GetName(), NearRadius = NearRadius } )
-    
-    
-    if CargoCarrier and CargoCarrier:IsAlive() and self.CargoObject and self.CargoObject:IsAlive() then 
-      if (CargoCarrier:IsAir() and not CargoCarrier:InAir()) or true then
-        local NearRadius = NearRadius or CargoCarrier:GetBoundingRadius( NearRadius ) + 5
-        if self:IsNear( CargoCarrier:GetPointVec2(), NearRadius ) then
-          self:__Load( 1, CargoCarrier, ... )
-        else
-          if self:IsNear( CargoCarrier:GetPointVec2(), 20 ) then
-            self:__Boarding( -1, CargoCarrier, NearRadius, ... )
-            self.RunCount = self.RunCount + 1
-          else
-            self:__Boarding( -2, CargoCarrier, NearRadius, ... )
-            self.RunCount = self.RunCount + 2
-          end
-          if self.RunCount >= 40 then
-            self.RunCount = 0
-            local Speed = 90
-            local Angle = 180
-            local Distance = 0
-            
-            local CargoCarrierPointVec2 = CargoCarrier:GetPointVec2()
-            local CargoCarrierHeading = CargoCarrier:GetHeading() -- Get Heading of object in degrees.
-            local CargoDeployHeading = ( ( CargoCarrierHeading + Angle ) >= 360 ) and ( CargoCarrierHeading + Angle - 360 ) or ( CargoCarrierHeading + Angle )
-            local CargoDeployPointVec2 = CargoCarrierPointVec2:Translate( Distance, CargoDeployHeading )
-          
-            -- Set the CargoObject to state Green to ensure it is boarding!
-            self.CargoObject:OptionAlarmStateGreen()
-
-            local Points = {}
-          
-            local PointStartVec2 = self.CargoObject:GetPointVec2()
-          
-            Points[#Points+1] = PointStartVec2:WaypointGround( Speed, "Off road" )
-            Points[#Points+1] = CargoDeployPointVec2:WaypointGround( Speed, "Off road" )
-          
-            local TaskRoute = self.CargoObject:TaskRoute( Points )
-            self.CargoObject:SetTask( TaskRoute, 0.2 )
-          end
-        end
-      else
-        self.CargoObject:MessageToGroup( "Cancelling Boarding... Get back on the ground!", 5, CargoCarrier:GetGroup(), self:GetName() )
-        self:CancelBoarding( CargoCarrier, NearRadius, ... )
-        self.CargoObject:SetCommand( self.CargoObject:CommandStopRoute( true ) )
-      end
-    else
-      self:E("Something is wrong")
-    end
-    
-  end
-  
-  
-  --- Enter Boarding State.
-  -- @param #CARGO_UNIT self
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  -- @param Wrapper.Unit#UNIT CargoCarrier
-  -- @param #number NearRadius Default 25 m.
-  function CARGO_UNIT:onenterBoarding( From, Event, To, CargoCarrier, NearRadius, ... )
-    --self:F( { From, Event, To, CargoCarrier.UnitName, NearRadius } )
-    
-    local Speed = 90
-    local Angle = 180
-    local Distance = 5
-    
-    if From == "UnLoaded" or From == "Boarding" then
-    
-    end
-    
-  end
-  
-  --- Loaded State.
-  -- @param #CARGO_UNIT self
-  -- @param #string Event
-  -- @param #string From
-  -- @param #string To
-  -- @param Wrapper.Unit#UNIT CargoCarrier
-  function CARGO_UNIT:onenterLoaded( From, Event, To, CargoCarrier )
-    self:F( { From, Event, To, CargoCarrier } )
-  
-    self.CargoCarrier = CargoCarrier
-    
-    -- Only destroy the CargoObject is if there is a CargoObject (packages don't have CargoObjects).
-    if self.CargoObject then
-      self:T("Destroying")
-      self.CargoObject:Destroy()
-      --self.CargoObject:ReSpawnAt( COORDINATE:NewFromVec2( {x=0,y=0} ), 0 )
-    end
-  end
-
-  --- Get the transportation method of the Cargo.
-  -- @param #CARGO_UNIT self
-  -- @return #string The transportation method of the Cargo.
-  function CARGO_UNIT:GetTransportationMethod()
-    if self:IsLoaded() then
-      return "for unboarding"
-    else
-      if self:IsUnLoaded() then
-        return "for boarding"
-      else
-        if self:IsDeployed() then
-          return "delivered"
-        end
-      end
-    end
-    return ""
-  end
-
-end -- CARGO_UNIT

Moose Development/Moose/Core/Base.lua

@@ -1,30 +1,15 @@
---- **Core** - The base class within the framework.
+--- **Core** -- BASE forms **the basis of the MOOSE framework**. Each class within the MOOSE framework derives from BASE.
+-- 
+-- ![Banner Image](..\Presentations\BASE\Dia1.JPG)
 -- 
 -- ===
 -- 
--- ## Features:
--- 
---   * The construction and inheritance of MOOSE classes.
---   * The class naming and numbering system.
---   * The class hierarchy search system.
---   * The tracing of information or objects during mission execution for debuggin purposes.
---   * The subscription to DCS events for event handling in MOOSE objects.
---   * Object inspection.
--- 
--- ===
--- 
--- All classes within the MOOSE framework are derived from the BASE class.
--- Note: The BASE class is an abstract class and is not meant to be used directly.
--- 
--- ===
--- 
--- ### Author: **FlightControl**
+-- ### Author: **Sven Van de Velde (FlightControl)**
 -- ### Contributions: 
 -- 
--- ===
+-- ====
 -- 
--- @module Core.Base
--- @image Core_Base.JPG
+-- @module Base
 
 
 
@@ -41,14 +26,26 @@ local _ClassID = 0
 -- @field ClassID The ID number of the class.
 -- @field ClassNameAndID The name of the class concatenated with the ID number of the class.
 
---- BASE class
---
--- # 1. BASE constructor.
+--- # 1) #BASE class
 -- 
--- Any class derived from BASE, will use the @{Core.Base#BASE.New} constructor embedded in the @{Core.Base#BASE.Inherit} method. 
--- See an example at the @{Core.Base#BASE.New} method how this is done.
+-- All classes within the MOOSE framework are derived from the BASE class. 
+--  
+-- BASE provides facilities for :
 -- 
--- # 2. Trace information for debugging.
+--   * The construction and inheritance of MOOSE classes.
+--   * The class naming and numbering system.
+--   * The class hierarchy search system.
+--   * The tracing of information or objects during mission execution for debuggin purposes.
+--   * The subscription to DCS events for event handling in MOOSE objects.
+-- 
+-- Note: The BASE class is an abstract class and is not meant to be used directly.
+-- 
+-- ## 1.1) BASE constructor
+-- 
+-- Any class derived from BASE, will use the @{Base#BASE.New} constructor embedded in the @{Base#BASE.Inherit} method. 
+-- See an example at the @{Base#BASE.New} method how this is done.
+-- 
+-- ## 1.2) Trace information for debugging
 -- 
 -- The BASE class contains trace methods to trace progress within a mission execution of a certain object.
 -- These trace methods are inherited by each MOOSE class interiting BASE, soeach object created from derived class from BASE can use the tracing methods to trace its execution.
@@ -79,7 +76,7 @@ local _ClassID = 0
 -- 
 -- Below a more detailed explanation of the different method types for tracing.
 -- 
--- ## 2.1. Tracing methods categories.
+-- ### 1.2.1) Tracing methods categories
 --
 -- There are basically 3 types of tracing methods available:
 -- 
@@ -87,9 +84,9 @@ local _ClassID = 0
 --   * @{#BASE.T}: Used to trace further logic within a function giving optional variables or parameters. A T is indicated at column 44 in the DCS.log file.
 --   * @{#BASE.E}: Used to always trace information giving optional variables or parameters. An E is indicated at column 44 in the DCS.log file.
 -- 
--- ## 2.2 Tracing levels.
+-- ### 1.2.2) Tracing levels
 --
--- There are 3 tracing levels within MOOSE.    
+-- There are 3 tracing levels within MOOSE.  
 -- These tracing levels were defined to avoid bulks of tracing to be generated by lots of objects.
 -- 
 -- As such, the F and T methods have additional variants to trace level 2 and 3 respectively:
@@ -99,7 +96,7 @@ local _ClassID = 0
 --   * @{#BASE.T2}: Trace further logic within a function giving optional variables or parameters with tracing level 2.
 --   * @{#BASE.T3}: Trace further logic within a function giving optional variables or parameters with tracing level 3.
 -- 
--- ## 2.3. Trace activation.
+-- ### 1.2.3) Trace activation.
 -- 
 -- Tracing can be activated in several ways:
 -- 
@@ -109,17 +106,16 @@ local _ClassID = 0
 --   * Activate only the tracing of a certain method of a certain class through the @{#BASE.TraceClassMethod}() method.
 --   * Activate only the tracing of a certain level through the @{#BASE.TraceLevel}() method.
 -- 
--- ## 2.4. Check if tracing is on.
+-- ### 1.2.4) Check if tracing is on.
 -- 
 -- The method @{#BASE.IsTrace}() will validate if tracing is activated or not.
 -- 
--- 
--- # 3. DCS simulator Event Handling.
+-- ## 1.3 DCS simulator Event Handling
 -- 
 -- The BASE class provides methods to catch DCS Events. These are events that are triggered from within the DCS simulator, 
 -- and handled through lua scripting. MOOSE provides an encapsulation to handle these events more efficiently.
 -- 
--- ## 3.1. Subscribe / Unsubscribe to DCS Events.
+-- ### 1.3.1 Subscribe / Unsubscribe to DCS Events
 -- 
 -- At first, the mission designer will need to **Subscribe** to a specific DCS event for the class.
 -- So, when the DCS event occurs, the class will be notified of that event.
@@ -128,10 +124,10 @@ local _ClassID = 0
 --   * @{#BASE.HandleEvent}(): Subscribe to a DCS Event.
 --   * @{#BASE.UnHandleEvent}(): Unsubscribe from a DCS Event.
 -- 
--- ## 3.2. Event Handling of DCS Events.
+-- ### 1.3.2 Event Handling of DCS Events
 -- 
 -- Once the class is subscribed to the event, an **Event Handling** method on the object or class needs to be written that will be called
--- when the DCS event occurs. The Event Handling method receives an @{Core.Event#EVENTDATA} structure, which contains a lot of information
+-- when the DCS event occurs. The Event Handling method receives an @{Event#EVENTDATA} structure, which contains a lot of information
 -- about the event that occurred.
 -- 
 -- Find below an example of the prototype how to write an event handling function for two units: 
@@ -163,7 +159,7 @@ local _ClassID = 0
 -- 
 -- See the @{Event} module for more information about event handling.
 -- 
--- # 4. Class identification methods.
+-- ## 1.4) Class identification methods
 -- 
 -- BASE provides methods to get more information of each object:
 -- 
@@ -171,7 +167,7 @@ local _ClassID = 0
 --   * @{#BASE.GetClassName}(): Gets the name of the object, which is the name of the class the object was instantiated from.
 --   * @{#BASE.GetClassNameAndID}(): Gets the name and ID of the object.
 -- 
--- # 5. All objects derived from BASE can have "States".
+-- ## 1.5) All objects derived from BASE can have "States"
 -- 
 -- A mechanism is in place in MOOSE, that allows to let the objects administer **states**.  
 -- States are essentially properties of objects, which are identified by a **Key** and a **Value**.  
@@ -186,7 +182,7 @@ local _ClassID = 0
 -- Thus, if the state is to be set for the same object as the object for which the method is used, then provide the same
 -- object name to the method.
 -- 
--- # 6. Inheritance.
+-- ## 1.10) Inheritance
 -- 
 -- The following methods are available to implement inheritance
 -- 
@@ -195,14 +191,13 @@ local _ClassID = 0
 -- 
 -- ===
 -- 
--- @field #BASE
+-- @field #BASE BASE
+-- 
 BASE = {
   ClassName = "BASE",
   ClassID = 0,
   Events = {},
   States = {},
-  Debug = debug,
-  Scheduler = nil,
 }
 
 
@@ -274,23 +269,6 @@ function BASE:Inherit( Child, Parent )
 	return Child
 end
 
-
-local function getParent( Child )
-  local Parent = nil
-  
-  if Child.ClassName == 'BASE' then
-    Parent = nil
-  else
-    if rawget( Child, "__" ) then
-      Parent = getmetatable( Child.__ ).__index
-    else
-      Parent = getmetatable( Child ).__index
-    end 
-  end
-  return Parent
-end
-
-
 --- This is the worker method to retrieve the Parent class.  
 -- Note that the Parent class must be passed to call the parent class method.
 -- 
@@ -300,31 +278,17 @@ end
 -- @param #BASE self
 -- @param #BASE Child is the Child class from which the Parent class needs to be retrieved.
 -- @return #BASE
-function BASE:GetParent( Child, FromClass )
-
-
+function BASE:GetParent( Child )
   local Parent
   -- BASE class has no parent
   if Child.ClassName == 'BASE' then
     Parent = nil
-  else
-  
-    --self:E({FromClass = FromClass})
-    --self:E({Child = Child.ClassName})
-    if FromClass then
-      while( Child.ClassName ~= "BASE" and Child.ClassName ~= FromClass.ClassName ) do
-        Child = getParent( Child )
-        --self:E({Child.ClassName})
-      end
-    end  
-    if Child.ClassName == 'BASE' then
-      Parent = nil
-    else
-      Parent = getParent( Child )
-    end
-  end
-  --self:E({Parent.ClassName})
-  return Parent
+  elseif rawget( Child, "__" ) then
+	  Parent = getmetatable( Child.__ ).__index
+	else
+	  Parent = getmetatable( Child ).__index
+	end 
+	return Parent
 end
 
 --- This is the worker method to check if an object is an (sub)instance of a class.
@@ -370,7 +334,7 @@ function BASE:IsInstanceOf( ClassName )
     return true
   end
 
-  local Parent = getParent(self)
+  local Parent = self:GetParent(self)
 
   while Parent do
 
@@ -378,7 +342,7 @@ function BASE:IsInstanceOf( ClassName )
       return true
     end
 
-    Parent = getParent( Parent )
+    Parent = Parent:GetParent(Parent)
 
   end
 
@@ -612,8 +576,8 @@ end
 
 --- Creation of a Birth Event.
 -- @param #BASE self
--- @param DCS#Time EventTime The time stamp of the event.
--- @param DCS#Object Initiator The initiating object of the event.
+-- @param Dcs.DCSTypes#Time EventTime The time stamp of the event.
+-- @param Dcs.DCSWrapper.Object#Object Initiator The initiating object of the event.
 -- @param #string IniUnitName The initiating unit name.
 -- @param place
 -- @param subplace
@@ -634,8 +598,8 @@ end
 
 --- Creation of a Crash Event.
 -- @param #BASE self
--- @param DCS#Time EventTime The time stamp of the event.
--- @param DCS#Object Initiator The initiating object of the event.
+-- @param Dcs.DCSTypes#Time EventTime The time stamp of the event.
+-- @param Dcs.DCSWrapper.Object#Object Initiator The initiating object of the event.
 function BASE:CreateEventCrash( EventTime, Initiator )
 	self:F( { EventTime, Initiator } )
 
@@ -648,42 +612,10 @@ function BASE:CreateEventCrash( EventTime, Initiator )
 	world.onEvent( Event )
 end
 
---- Creation of a Dead Event.
--- @param #BASE self
--- @param DCS#Time EventTime The time stamp of the event.
--- @param DCS#Object Initiator The initiating object of the event.
-function BASE:CreateEventDead( EventTime, Initiator )
-  self:F( { EventTime, Initiator } )
-
-  local Event = {
-    id = world.event.S_EVENT_DEAD,
-    time = EventTime,
-    initiator = Initiator,
-    }
-
-  world.onEvent( Event )
-end
-
---- Creation of a Remove Unit Event.
--- @param #BASE self
--- @param DCS#Time EventTime The time stamp of the event.
--- @param DCS#Object Initiator The initiating object of the event.
-function BASE:CreateEventRemoveUnit( EventTime, Initiator )
-  self:F( { EventTime, Initiator } )
-
-  local Event = {
-    id = EVENTS.RemoveUnit,
-    time = EventTime,
-    initiator = Initiator,
-    }
-
-  world.onEvent( Event )
-end
-
 --- Creation of a Takeoff Event.
 -- @param #BASE self
--- @param DCS#Time EventTime The time stamp of the event.
--- @param DCS#Object Initiator The initiating object of the event.
+-- @param Dcs.DCSTypes#Time EventTime The time stamp of the event.
+-- @param Dcs.DCSWrapper.Object#Object Initiator The initiating object of the event.
 function BASE:CreateEventTakeoff( EventTime, Initiator )
   self:F( { EventTime, Initiator } )
 
@@ -696,10 +628,10 @@ function BASE:CreateEventTakeoff( EventTime, Initiator )
   world.onEvent( Event )
 end
 
--- TODO: Complete DCS#Event structure.                       
+-- TODO: Complete Dcs.DCSTypes#Event structure.                       
 --- The main event handling function... This function captures all events generated for the class.
 -- @param #BASE self
--- @param DCS#Event event
+-- @param Dcs.DCSTypes#Event event
 function BASE:onEvent(event)
   --self:F( { BaseEventCodes[event.id], event } )
 
@@ -742,12 +674,7 @@ do -- Scheduling
     ObjectName = self.ClassName .. self.ClassID
     
     self:F3( { "ScheduleOnce: ", ObjectName,  Start } )
-    
-    if not self.Scheduler then
-      self.Scheduler = SCHEDULER:New( self )
-    end
-    
-    self.Scheduler.SchedulerObject = self.Scheduler
+    self.SchedulerObject = self
     
     local ScheduleID = _SCHEDULEDISPATCHER:AddSchedule( 
       self, 
@@ -759,9 +686,9 @@ do -- Scheduling
       nil
     )
     
-    self._.Schedules[#self._.Schedules+1] = ScheduleID
+    self._.Schedules[#self.Schedules+1] = ScheduleID
   
-    return self._.Schedules[#self._.Schedules]
+    return self._.Schedules
   end
 
   --- Schedule a new time event. Note that the schedule will only take place if the scheduler is *started*. Even for a single schedule event, the scheduler needs to be started also.
@@ -781,12 +708,7 @@ do -- Scheduling
     ObjectName = self.ClassName .. self.ClassID
     
     self:F3( { "ScheduleRepeat: ", ObjectName, Start, Repeat, RandomizeFactor, Stop } )
-
-    if not self.Scheduler then
-      self.Scheduler = SCHEDULER:New( self )
-    end
-    
-    self.Scheduler.SchedulerObject = self.Scheduler
+    self.SchedulerObject = self
     
     local ScheduleID = _SCHEDULEDISPATCHER:AddSchedule( 
       self, 
@@ -798,9 +720,9 @@ do -- Scheduling
       Stop
     )
     
-    self._.Schedules[#self._.Schedules+1] = ScheduleID
+    self._.Schedules[SchedulerFunction] = ScheduleID
   
-    return self._.Schedules[#self._.Schedules]
+    return self._.Schedules
   end
 
   --- Stops the Schedule.
@@ -810,7 +732,7 @@ do -- Scheduling
   
     self:F3( { "ScheduleStop:" } )
     
-  _SCHEDULEDISPATCHER:Stop( self.Scheduler, self._.Schedules[SchedulerFunction] )
+  _SCHEDULEDISPATCHER:Stop( self, self._.Schedules[SchedulerFunction] )
   end
 
 end
@@ -822,7 +744,8 @@ end
 -- @param Object The object that will hold the Value set by the Key.
 -- @param Key The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!
 -- @param Value The value to is stored in the object.
--- @return The Value set. 
+-- @return The Value set.
+-- @return #nil The Key was not found and thus the Value could not be retrieved.
 function BASE:SetState( Object, Key, Value )
 
   local ClassNameAndID = Object:GetClassNameAndID()
@@ -839,7 +762,7 @@ end
 -- @param #BASE self
 -- @param Object The object that holds the Value set by the Key.
 -- @param Key The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!
--- @return The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.
+-- @return The Value retrieved.
 function BASE:GetState( Object, Key )
 
   local ClassNameAndID = Object:GetClassNameAndID()
@@ -852,10 +775,6 @@ function BASE:GetState( Object, Key )
   return nil
 end
 
---- Clear the state of an object.
--- @param #BASE self
--- @param Object The object that holds the Value set by the Key.
--- @param StateName The key that is should be cleared.
 function BASE:ClearState( Object, StateName )
 
   local ClassNameAndID = Object:GetClassNameAndID()
@@ -870,7 +789,7 @@ end
 -- TODO: Make trace function using variable parameters.
 
 --- Set trace on or off
--- Note that when trace is off, no BASE.Debug statement is performed, increasing performance!
+-- Note that when trace is off, no debug statement is performed, increasing performance!
 -- When Moose is loaded statically, (as one file), tracing is switched off by default.
 -- So tracing must be switched on manually in your mission if you are using Moose statically.
 -- When moose is loading dynamically (for moose class development), tracing is switched on by default.
@@ -892,7 +811,7 @@ end
 -- @return #boolean
 function BASE:IsTrace()
 
-  if BASE.Debug and ( _TraceAll == true ) or ( _TraceClass[self.ClassName] or _TraceClassMethod[self.ClassName] ) then
+  if debug and ( _TraceAll == true ) or ( _TraceClass[self.ClassName] or _TraceClassMethod[self.ClassName] ) then
     return true
   else
     return false
@@ -948,10 +867,10 @@ end
 -- @param Arguments A #table or any field.
 function BASE:_F( Arguments, DebugInfoCurrentParam, DebugInfoFromParam )
 
-  if BASE.Debug and ( _TraceAll == true ) or ( _TraceClass[self.ClassName] or _TraceClassMethod[self.ClassName] ) then
+  if debug and ( _TraceAll == true ) or ( _TraceClass[self.ClassName] or _TraceClassMethod[self.ClassName] ) then
 
-    local DebugInfoCurrent = DebugInfoCurrentParam and DebugInfoCurrentParam or BASE.Debug.getinfo( 2, "nl" )
-    local DebugInfoFrom = DebugInfoFromParam and DebugInfoFromParam or BASE.Debug.getinfo( 3, "l" )
+    local DebugInfoCurrent = DebugInfoCurrentParam and DebugInfoCurrentParam or debug.getinfo( 2, "nl" )
+    local DebugInfoFrom = DebugInfoFromParam and DebugInfoFromParam or debug.getinfo( 3, "l" )
     
     local Function = "function"
     if DebugInfoCurrent.name then
@@ -977,9 +896,9 @@ end
 -- @param Arguments A #table or any field.
 function BASE:F( Arguments )
 
-  if BASE.Debug and _TraceOnOff then
-    local DebugInfoCurrent = BASE.Debug.getinfo( 2, "nl" )
-    local DebugInfoFrom = BASE.Debug.getinfo( 3, "l" )
+  if debug and _TraceOnOff then
+    local DebugInfoCurrent = debug.getinfo( 2, "nl" )
+    local DebugInfoFrom = debug.getinfo( 3, "l" )
   
     if _TraceLevel >= 1 then
       self:_F( Arguments, DebugInfoCurrent, DebugInfoFrom )
@@ -993,9 +912,9 @@ end
 -- @param Arguments A #table or any field.
 function BASE:F2( Arguments )
 
-  if BASE.Debug and _TraceOnOff then
-    local DebugInfoCurrent = BASE.Debug.getinfo( 2, "nl" )
-    local DebugInfoFrom = BASE.Debug.getinfo( 3, "l" )
+  if debug and _TraceOnOff then
+    local DebugInfoCurrent = debug.getinfo( 2, "nl" )
+    local DebugInfoFrom = debug.getinfo( 3, "l" )
   
     if _TraceLevel >= 2 then
       self:_F( Arguments, DebugInfoCurrent, DebugInfoFrom )
@@ -1008,9 +927,9 @@ end
 -- @param Arguments A #table or any field.
 function BASE:F3( Arguments )
 
-  if BASE.Debug and _TraceOnOff then
-    local DebugInfoCurrent = BASE.Debug.getinfo( 2, "nl" )
-    local DebugInfoFrom = BASE.Debug.getinfo( 3, "l" )
+  if debug and _TraceOnOff then
+    local DebugInfoCurrent = debug.getinfo( 2, "nl" )
+    local DebugInfoFrom = debug.getinfo( 3, "l" )
   
     if _TraceLevel >= 3 then
       self:_F( Arguments, DebugInfoCurrent, DebugInfoFrom )
@@ -1023,10 +942,10 @@ end
 -- @param Arguments A #table or any field.
 function BASE:_T( Arguments, DebugInfoCurrentParam, DebugInfoFromParam )
 
-	if BASE.Debug and ( _TraceAll == true ) or ( _TraceClass[self.ClassName] or _TraceClassMethod[self.ClassName] ) then
+	if debug and ( _TraceAll == true ) or ( _TraceClass[self.ClassName] or _TraceClassMethod[self.ClassName] ) then
 
-    local DebugInfoCurrent = DebugInfoCurrentParam and DebugInfoCurrentParam or BASE.Debug.getinfo( 2, "nl" )
-    local DebugInfoFrom = DebugInfoFromParam and DebugInfoFromParam or BASE.Debug.getinfo( 3, "l" )
+    local DebugInfoCurrent = DebugInfoCurrentParam and DebugInfoCurrentParam or debug.getinfo( 2, "nl" )
+    local DebugInfoFrom = DebugInfoFromParam and DebugInfoFromParam or debug.getinfo( 3, "l" )
 		
 		local Function = "function"
 		if DebugInfoCurrent.name then
@@ -1052,9 +971,9 @@ end
 -- @param Arguments A #table or any field.
 function BASE:T( Arguments )
 
-  if BASE.Debug and _TraceOnOff then
-    local DebugInfoCurrent = BASE.Debug.getinfo( 2, "nl" )
-    local DebugInfoFrom = BASE.Debug.getinfo( 3, "l" )
+  if debug and _TraceOnOff then
+    local DebugInfoCurrent = debug.getinfo( 2, "nl" )
+    local DebugInfoFrom = debug.getinfo( 3, "l" )
   
     if _TraceLevel >= 1 then
       self:_T( Arguments, DebugInfoCurrent, DebugInfoFrom )
@@ -1068,9 +987,9 @@ end
 -- @param Arguments A #table or any field.
 function BASE:T2( Arguments )
 
-  if BASE.Debug and _TraceOnOff then
-    local DebugInfoCurrent = BASE.Debug.getinfo( 2, "nl" )
-    local DebugInfoFrom = BASE.Debug.getinfo( 3, "l" )
+  if debug and _TraceOnOff then
+    local DebugInfoCurrent = debug.getinfo( 2, "nl" )
+    local DebugInfoFrom = debug.getinfo( 3, "l" )
   
     if _TraceLevel >= 2 then
       self:_T( Arguments, DebugInfoCurrent, DebugInfoFrom )
@@ -1083,9 +1002,9 @@ end
 -- @param Arguments A #table or any field.
 function BASE:T3( Arguments )
 
-  if BASE.Debug and _TraceOnOff then
-    local DebugInfoCurrent = BASE.Debug.getinfo( 2, "nl" )
-    local DebugInfoFrom = BASE.Debug.getinfo( 3, "l" )
+  if debug and _TraceOnOff then
+    local DebugInfoCurrent = debug.getinfo( 2, "nl" )
+    local DebugInfoFrom = debug.getinfo( 3, "l" )
   
     if _TraceLevel >= 3 then
       self:_T( Arguments, DebugInfoCurrent, DebugInfoFrom )
@@ -1098,9 +1017,9 @@ end
 -- @param Arguments A #table or any field.
 function BASE:E( Arguments )
 
-  if BASE.Debug then
-  	local DebugInfoCurrent = BASE.Debug.getinfo( 2, "nl" )
-  	local DebugInfoFrom = BASE.Debug.getinfo( 3, "l" )
+  if debug then
+  	local DebugInfoCurrent = debug.getinfo( 2, "nl" )
+  	local DebugInfoFrom = debug.getinfo( 3, "l" )
   	
   	local Function = "function"
   	if DebugInfoCurrent.name then
@@ -1114,36 +1033,6 @@ function BASE:E( Arguments )
   	end
   
   	env.info( string.format( "%6d(%6d)/%1s:%20s%05d.%s(%s)" , LineCurrent, LineFrom, "E", self.ClassName, self.ClassID, Function, routines.utils.oneLineSerialize( Arguments ) ) )
-  else
-    env.info( string.format( "%1s:%20s%05d(%s)" , "E", self.ClassName, self.ClassID, routines.utils.oneLineSerialize( Arguments ) ) )
-  end
-  
-end
-
-
---- Log an information which will be traced always. Can be anywhere within the function logic.
--- @param #BASE self
--- @param Arguments A #table or any field.
-function BASE:I( Arguments )
-
-  if BASE.Debug then
-    local DebugInfoCurrent = BASE.Debug.getinfo( 2, "nl" )
-    local DebugInfoFrom = BASE.Debug.getinfo( 3, "l" )
-    
-    local Function = "function"
-    if DebugInfoCurrent.name then
-      Function = DebugInfoCurrent.name
-    end
-  
-    local LineCurrent = DebugInfoCurrent.currentline
-    local LineFrom = -1 
-    if DebugInfoFrom then
-      LineFrom = DebugInfoFrom.currentline
-    end
-  
-    env.info( string.format( "%6d(%6d)/%1s:%20s%05d.%s(%s)" , LineCurrent, LineFrom, "I", self.ClassName, self.ClassID, Function, routines.utils.oneLineSerialize( Arguments ) ) )
-  else
-    env.info( string.format( "%1s:%20s%05d(%s)" , "I", self.ClassName, self.ClassID, routines.utils.oneLineSerialize( Arguments ) ) )
   end
   
 end

Moose Development/Moose/Core/Database.lua

@@ -1,42 +1,9 @@
---- **Core** - Manages several databases containing templates, mission objects, and mission information. 
+--- **Core** -- DATABASE manages the database of mission objects. 
 -- 
--- ===
--- 
--- ## Features:
--- 
---   * During mission startup, scan the mission environment, and create / instantiate intelligently the different objects as defined within the mission.
---   * Manage database of DCS Group templates (as modelled using the mission editor).
---     - Group templates.
---     - Unit templates.
---     - Statics templates.
---   * Manage database of @{Wrapper.Group#GROUP} objects alive in the mission.
---   * Manage database of @{Wrapper.Unit#UNIT} objects alive in the mission.
---   * Manage database of @{Wrapper.Static#STATIC} objects alive in the mission.
---   * Manage database of players.
---   * Manage database of client slots defined using the mission editor.
---   * Manage database of airbases on the map, and from FARPs and ships as defined using the mission editor.
---   * Manage database of countries.
---   * Manage database of zone names.
---   * Manage database of hits to units and statics.
---   * Manage database of destroys of units and statics.
---   * Manage database of @{Core.Zone#ZONE_BASE} objects.
--- 
--- ===
--- 
--- ### Author: **FlightControl**
--- ### Contributions: 
--- 
--- ===
--- 
--- @module Core.Database
--- @image Core_Database.JPG
-
-
---- @type DATABASE
--- @extends Core.Base#BASE
-
---- Contains collections of wrapper objects defined within MOOSE that reflect objects within the simulator.
+-- ====
 -- 
+-- 1) @{#DATABASE} class, extends @{Base#BASE}
+-- ===================================================
 -- Mission designers can use the DATABASE class to refer to:
 -- 
 --  * STATICS
@@ -50,10 +17,35 @@
 --  
 -- On top, for internal MOOSE administration purposes, the DATBASE administers the Unit and Group TEMPLATES as defined within the Mission Editor.
 -- 
--- The singleton object **_DATABASE** is automatically created by MOOSE, that administers all objects within the mission.
--- Moose refers to **_DATABASE** within the framework extensively, but you can also refer to the _DATABASE object within your missions if required.
+-- Moose will automatically create one instance of the DATABASE class into the **global** object _DATABASE.
+-- Moose refers to _DATABASE within the framework extensively, but you can also refer to the _DATABASE object within your missions if required.
 -- 
--- @field #DATABASE
+-- 1.1) DATABASE iterators
+-- -----------------------
+-- You can iterate the database with the available iterator methods.
+-- The iterator methods will walk the DATABASE set, and call for each element within the set a function that you provide.
+-- The following iterator methods are currently available within the DATABASE:
+-- 
+--   * @{#DATABASE.ForEachUnit}: Calls a function for each @{UNIT} it finds within the DATABASE.
+--   * @{#DATABASE.ForEachGroup}: Calls a function for each @{GROUP} it finds within the DATABASE.
+--   * @{#DATABASE.ForEachPlayer}: Calls a function for each alive player it finds within the DATABASE.
+--   * @{#DATABASE.ForEachPlayerJoined}: Calls a function for each joined player it finds within the DATABASE.
+--   * @{#DATABASE.ForEachClient}: Calls a function for each @{CLIENT} it finds within the DATABASE.
+--   * @{#DATABASE.ForEachClientAlive}: Calls a function for each alive @{CLIENT} it finds within the DATABASE.
+-- 
+-- ===
+-- 
+-- 
+-- ### Author: **Sven Van de Velde (FlightControl)**
+-- ### Contributions: 
+-- 
+-- ====
+-- @module Database
+
+
+--- DATABASE class
+-- @type DATABASE
+-- @extends Core.Base#BASE
 DATABASE = {
   ClassName = "DATABASE",
   Templates = {
@@ -78,16 +70,12 @@ DATABASE = {
   NavPoints = {},
   PLAYERSETTINGS = {},
   ZONENAMES = {},
-  HITS = {},
-  DESTROYS = {},
-  ZONES = {},
 }
 
 local _DATABASECoalition =
   {
     [1] = "Red",
     [2] = "Blue",
-    [3] = "Neutral",
   }
 
 local _DATABASECategory =
@@ -116,15 +104,11 @@ function DATABASE:New()
   self:HandleEvent( EVENTS.Birth, self._EventOnBirth )
   self:HandleEvent( EVENTS.Dead, self._EventOnDeadOrCrash )
   self:HandleEvent( EVENTS.Crash, self._EventOnDeadOrCrash )
-  self:HandleEvent( EVENTS.RemoveUnit, self._EventOnDeadOrCrash )
-  self:HandleEvent( EVENTS.Hit, self.AccountHits )
   self:HandleEvent( EVENTS.NewCargo )
   self:HandleEvent( EVENTS.DeleteCargo )
-  self:HandleEvent( EVENTS.NewZone )
-  self:HandleEvent( EVENTS.DeleteZone )
   
   -- Follow alive players and clients
-  --self:HandleEvent( EVENTS.PlayerEnterUnit, self._EventOnPlayerEnterUnit ) -- This is not working anymore!, handling this through the birth event.
+  self:HandleEvent( EVENTS.PlayerEnterUnit, self._EventOnPlayerEnterUnit )
   self:HandleEvent( EVENTS.PlayerLeaveUnit, self._EventOnPlayerLeaveUnit )
   
   self:_RegisterTemplates()
@@ -139,7 +123,7 @@ function DATABASE:New()
   --- @param #DATABASE self
   local function CheckPlayers( self )
   
-    local CoalitionsData = { AlivePlayersRed = coalition.getPlayers( coalition.side.RED ), AlivePlayersBlue = coalition.getPlayers( coalition.side.BLUE ), AlivePlayersNeutral = coalition.getPlayers( coalition.side.NEUTRAL )}
+    local CoalitionsData = { AlivePlayersRed = coalition.getPlayers( coalition.side.RED ), AlivePlayersBlue = coalition.getPlayers( coalition.side.BLUE ) }
     for CoalitionId, CoalitionData in pairs( CoalitionsData ) do
       --self:E( { "CoalitionData:", CoalitionData } )
       for UnitId, UnitData in pairs( CoalitionData ) do
@@ -164,8 +148,8 @@ function DATABASE:New()
     end
   end
   
-  --self:E( "Scheduling" )
-  --PlayerCheckSchedule = SCHEDULER:New( nil, CheckPlayers, { self }, 1, 1 )
+  self:E( "Scheduling" )
+  PlayerCheckSchedule = SCHEDULER:New( nil, CheckPlayers, { self }, 1, 1 )
   
   return self
 end
@@ -209,10 +193,7 @@ function DATABASE:AddStatic( DCSStaticName )
 
   if not self.STATICS[DCSStaticName] then
     self.STATICS[DCSStaticName] = STATIC:Register( DCSStaticName )
-    return self.STATICS[DCSStaticName]
   end
-  
-  return nil
 end
 
 
@@ -272,179 +253,35 @@ function DATABASE:FindAirbase( AirbaseName )
   return AirbaseFound
 end
 
+--- Adds a Cargo based on the Cargo Name in the DATABASE.
+-- @param #DATABASE self
+-- @param #string CargoName The name of the airbase
+function DATABASE:AddCargo( Cargo )
 
-do -- Zones
-
-  --- Finds a @{Zone} based on the zone name.
-  -- @param #DATABASE self
-  -- @param #string ZoneName The name of the zone.
-  -- @return Core.Zone#ZONE_BASE The found ZONE.
-  function DATABASE:FindZone( ZoneName )
-  
-    local ZoneFound = self.ZONES[ZoneName]
-    return ZoneFound
-  end
-  
-  --- Adds a @{Zone} based on the zone name in the DATABASE.
-  -- @param #DATABASE self
-  -- @param #string ZoneName The name of the zone.
-  -- @param Core.Zone#ZONE_BASE Zone The zone.
-  function DATABASE:AddZone( ZoneName, Zone )
-  
-    if not self.ZONES[ZoneName] then
-      self.ZONES[ZoneName] = Zone
-    end
-  end
-  
-  
-  --- Deletes a @{Zone} from the DATABASE based on the zone name.
-  -- @param #DATABASE self
-  -- @param #string ZoneName The name of the zone.
-  function DATABASE:DeleteZone( ZoneName )
-  
-    self.ZONES[ZoneName] = nil 
-  end
-  
-  --- Finds an @{Zone} based on the zone name in the DATABASE.
-  -- @param #DATABASE self
-  -- @param #string ZoneName
-  -- @return Core.Zone#ZONE_BASE The found @{Zone}.
-  function DATABASE:FindZone( ZoneName )
-  
-    local ZoneFound = self.ZONES[ZoneName]
-    return ZoneFound
+  if not self.CARGOS[Cargo.Name] then
+    self.CARGOS[Cargo.Name] = Cargo
   end
+end
 
 
-  --- Private method that registers new ZONE_BASE derived objects within the DATABASE Object.
-  -- @param #DATABASE self
-  -- @return #DATABASE self
-  function DATABASE:_RegisterZones()
+--- Deletes a Cargo from the DATABASE based on the Cargo Name.
+-- @param #DATABASE self
+-- @param #string CargoName The name of the airbase
+function DATABASE:DeleteCargo( CargoName )
 
-    for ZoneID, ZoneData in pairs( env.mission.triggers.zones ) do
-      local ZoneName = ZoneData.name
+  self.CARGOS[CargoName] = nil 
+end
 
-      self:I( { "Register ZONE:", Name = ZoneName } )
-      local Zone = ZONE:New( ZoneName )
-      self.ZONENAMES[ZoneName] = ZoneName
-      self:AddZone( ZoneName, Zone )
-    end
-  
-    for ZoneGroupName, ZoneGroup in pairs( self.GROUPS ) do
-      if ZoneGroupName:match("#ZONE_POLYGON") then
-        local ZoneName1 = ZoneGroupName:match("(.*)#ZONE_POLYGON")
-        local ZoneName2 = ZoneGroupName:match(".*#ZONE_POLYGON(.*)")
-        local ZoneName = ZoneName1 .. ( ZoneName2 or "" )
-        
-        self:I( { "Register ZONE_POLYGON:", Name = ZoneName } )
-        local Zone_Polygon = ZONE_POLYGON:New( ZoneName, ZoneGroup )
-        self.ZONENAMES[ZoneName] = ZoneName
-        self:AddZone( ZoneName, Zone_Polygon )
-      end
-    end
-    
-  end
+--- Finds an CARGO based on the CargoName.
+-- @param #DATABASE self
+-- @param #string CargoName
+-- @return Wrapper.Cargo#CARGO The found CARGO.
+function DATABASE:FindCargo( CargoName )
 
+  local CargoFound = self.CARGOS[CargoName]
+  return CargoFound
+end
 
-end -- zone
-
-
-do -- cargo
-
-  --- Adds a Cargo based on the Cargo Name in the DATABASE.
-  -- @param #DATABASE self
-  -- @param #string CargoName The name of the airbase
-  function DATABASE:AddCargo( Cargo )
-  
-    if not self.CARGOS[Cargo.Name] then
-      self.CARGOS[Cargo.Name] = Cargo
-    end
-  end
-  
-  
-  --- Deletes a Cargo from the DATABASE based on the Cargo Name.
-  -- @param #DATABASE self
-  -- @param #string CargoName The name of the airbase
-  function DATABASE:DeleteCargo( CargoName )
-  
-    self.CARGOS[CargoName] = nil 
-  end
-  
-  --- Finds an CARGO based on the CargoName.
-  -- @param #DATABASE self
-  -- @param #string CargoName
-  -- @return Wrapper.Cargo#CARGO The found CARGO.
-  function DATABASE:FindCargo( CargoName )
-  
-    local CargoFound = self.CARGOS[CargoName]
-    return CargoFound
-  end
-  
-  --- Checks if the Template name has a #CARGO tag.
-  -- If yes, the group is a cargo.
-  -- @param #DATABASE self
-  -- @param #string TemplateName
-  -- @return #boolean
-  function DATABASE:IsCargo( TemplateName )
-
-    TemplateName = env.getValueDictByKey( TemplateName )
-  
-    local Cargo = TemplateName:match( "#(CARGO)" )
-
-    return Cargo and Cargo == "CARGO"    
-  end
-
-  --- Private method that registers new Static Templates within the DATABASE Object.
-  -- @param #DATABASE self
-  -- @return #DATABASE self
-  function DATABASE:_RegisterCargos()
-
-    local Groups = UTILS.DeepCopy( self.GROUPS ) -- This is a very important statement. CARGO_GROUP:New creates a new _DATABASE.GROUP entry, which will confuse the loop. I searched 4 hours on this to find the bug!
-  
-    for CargoGroupName, CargoGroup in pairs( Groups ) do
-      self:I( { Cargo = CargoGroupName } )
-      if self:IsCargo( CargoGroupName ) then
-        local CargoInfo = CargoGroupName:match("#CARGO(.*)")
-        local CargoParam = CargoInfo and CargoInfo:match( "%((.*)%)")
-        local CargoName1 = CargoGroupName:match("(.*)#CARGO%(.*%)")
-        local CargoName2 = CargoGroupName:match(".*#CARGO%(.*%)(.*)")
-        local CargoName = CargoName1 .. ( CargoName2 or "" )
-        local Type = CargoParam and CargoParam:match( "T=([%a%d ]+),?")
-        local Name = CargoParam and CargoParam:match( "N=([%a%d]+),?") or CargoName
-        local LoadRadius = CargoParam and tonumber( CargoParam:match( "RR=([%a%d]+),?") )
-        local NearRadius = CargoParam and tonumber( CargoParam:match( "NR=([%a%d]+),?") )
-        
-        self:I({"Register CargoGroup:",Type=Type,Name=Name,LoadRadius=LoadRadius,NearRadius=NearRadius})
-        CARGO_GROUP:New( CargoGroup, Type, Name, LoadRadius, NearRadius )
-      end
-    end
-    
-    for CargoStaticName, CargoStatic in pairs( self.STATICS ) do
-      if self:IsCargo( CargoStaticName ) then
-        local CargoInfo = CargoStaticName:match("#CARGO(.*)")
-        local CargoParam = CargoInfo and CargoInfo:match( "%((.*)%)")
-        local CargoName = CargoStaticName:match("(.*)#CARGO")
-        local Type = CargoParam and CargoParam:match( "T=([%a%d ]+),?")
-        local Category = CargoParam and CargoParam:match( "C=([%a%d ]+),?")
-        local Name = CargoParam and CargoParam:match( "N=([%a%d]+),?") or CargoName
-        local LoadRadius = CargoParam and tonumber( CargoParam:match( "RR=([%a%d]+),?") )
-        local NearRadius = CargoParam and tonumber( CargoParam:match( "NR=([%a%d]+),?") )
-        
-        if Category == "SLING" then
-          self:I({"Register CargoSlingload:",Type=Type,Name=Name,LoadRadius=LoadRadius,NearRadius=NearRadius})
-          CARGO_SLINGLOAD:New( CargoStatic, Type, Name, LoadRadius, NearRadius )
-        else
-          if Category == "CRATE" then
-            self:I({"Register CargoCrate:",Type=Type,Name=Name,LoadRadius=LoadRadius,NearRadius=NearRadius})
-            CARGO_CRATE:New( CargoStatic, Type, Name, LoadRadius, NearRadius )
-          end
-        end
-      end
-    end
-    
-  end
-
-end -- cargo
 
 --- Finds a CLIENT based on the ClientName.
 -- @param #DATABASE self
@@ -485,7 +322,7 @@ end
 function DATABASE:AddGroup( GroupName )
 
   if not self.GROUPS[GroupName] then
-    self:I( { "Add GROUP:", GroupName } )
+    self:E( { "Add GROUP:", GroupName } )
     self.GROUPS[GroupName] = GROUP:Register( GroupName )
   end  
   
@@ -497,9 +334,9 @@ end
 function DATABASE:AddPlayer( UnitName, PlayerName )
 
   if PlayerName then
-    self:I( { "Add player for unit:", UnitName, PlayerName } )
+    self:E( { "Add player for unit:", UnitName, PlayerName } )
     self.PLAYERS[PlayerName] = UnitName
-    self.PLAYERUNITS[PlayerName] = self:FindUnit( UnitName )
+    self.PLAYERUNITS[UnitName] = PlayerName
     self.PLAYERSJOINED[PlayerName] = PlayerName
   end
 end
@@ -509,58 +346,20 @@ end
 function DATABASE:DeletePlayer( UnitName, PlayerName )
 
   if PlayerName then
-    self:I( { "Clean player:", PlayerName } )
+    self:E( { "Clean player:", PlayerName } )
     self.PLAYERS[PlayerName] = nil
-    self.PLAYERUNITS[PlayerName] = nil
+    self.PLAYERUNITS[UnitName] = PlayerName
   end
 end
 
---- Get the player table from the DATABASE.
--- The player table contains all unit names with the key the name of the player (PlayerName).
--- @param #DATABASE self
--- @usage
---   local Players = _DATABASE:GetPlayers()
---   for PlayerName, UnitName in pairs( Players ) do
---     ..
---   end
-function DATABASE:GetPlayers()
-  return self.PLAYERS
-end
-
-
---- Get the player table from the DATABASE, which contains all UNIT objects.
--- The player table contains all UNIT objects of the player with the key the name of the player (PlayerName).
--- @param #DATABASE self
--- @usage
---   local PlayerUnits = _DATABASE:GetPlayerUnits()
---   for PlayerName, PlayerUnit in pairs( PlayerUnits ) do
---     ..
---   end
-function DATABASE:GetPlayerUnits()
-  return self.PLAYERUNITS
-end
-
-
---- Get the player table from the DATABASE which have joined in the mission historically.
--- The player table contains all UNIT objects with the key the name of the player (PlayerName).
--- @param #DATABASE self
--- @usage
---   local PlayersJoined = _DATABASE:GetPlayersJoined()
---   for PlayerName, PlayerUnit in pairs( PlayersJoined ) do
---     ..
---   end
-function DATABASE:GetPlayersJoined()
-  return self.PLAYERSJOINED
-end
-
 
 --- Instantiate new Groups within the DCSRTE.
 -- This method expects EXACTLY the same structure as a structure within the ME, and needs 2 additional fields defined:
 -- SpawnCountryID, SpawnCategoryID
 -- This method is used by the SPAWN class.
 -- @param #DATABASE self
--- @param #table SpawnTemplate Template of the group to spawn.
--- @return Wrapper.Group#GROUP Spawned group.
+-- @param #table SpawnTemplate
+-- @return #DATABASE self
 function DATABASE:Spawn( SpawnTemplate )
   self:F( SpawnTemplate.name )
 
@@ -616,14 +415,13 @@ end
 --- Private method that registers new Group Templates within the DATABASE Object.
 -- @param #DATABASE self
 -- @param #table GroupTemplate
--- @param DCS#coalition.side CoalitionSide The coalition.side of the object.
--- @param DCS#Object.Category CategoryID The Object.category of the object.
--- @param DCS#country.id CountryID the country.id of the object
 -- @return #DATABASE self
-function DATABASE:_RegisterGroupTemplate( GroupTemplate, CoalitionSide, CategoryID, CountryID, GroupName )
+function DATABASE:_RegisterGroupTemplate( GroupTemplate, CoalitionID, CategoryID, CountryID )
 
-  local GroupTemplateName = GroupName or env.getValueDictByKey( GroupTemplate.name )
+  local GroupTemplateName = env.getValueDictByKey(GroupTemplate.name)
   
+  local TraceTable = {}
+
   if not self.Templates.Groups[GroupTemplateName] then
     self.Templates.Groups[GroupTemplateName] = {}
     self.Templates.Groups[GroupTemplateName].Status = nil
@@ -635,7 +433,7 @@ function DATABASE:_RegisterGroupTemplate( GroupTemplate, CoalitionSide, Category
   end
   
   GroupTemplate.CategoryID = CategoryID
-  GroupTemplate.CoalitionID = CoalitionSide
+  GroupTemplate.CoalitionID = CoalitionID
   GroupTemplate.CountryID = CountryID
   
   self.Templates.Groups[GroupTemplateName].GroupName = GroupTemplateName
@@ -644,10 +442,21 @@ function DATABASE:_RegisterGroupTemplate( GroupTemplate, CoalitionSide, Category
   self.Templates.Groups[GroupTemplateName].UnitCount = #GroupTemplate.units
   self.Templates.Groups[GroupTemplateName].Units = GroupTemplate.units
   self.Templates.Groups[GroupTemplateName].CategoryID = CategoryID
-  self.Templates.Groups[GroupTemplateName].CoalitionID = CoalitionSide
+  self.Templates.Groups[GroupTemplateName].CoalitionID = CoalitionID
   self.Templates.Groups[GroupTemplateName].CountryID = CountryID
 
-  local UnitNames = {}
+  
+  TraceTable[#TraceTable+1] = "Group"
+  TraceTable[#TraceTable+1] = self.Templates.Groups[GroupTemplateName].GroupName
+
+  TraceTable[#TraceTable+1] = "Coalition"
+  TraceTable[#TraceTable+1] = self.Templates.Groups[GroupTemplateName].CoalitionID
+  TraceTable[#TraceTable+1] = "Category"
+  TraceTable[#TraceTable+1] = self.Templates.Groups[GroupTemplateName].CategoryID
+  TraceTable[#TraceTable+1] = "Country"
+  TraceTable[#TraceTable+1] = self.Templates.Groups[GroupTemplateName].CountryID
+
+  TraceTable[#TraceTable+1] = "Units"
 
   for unit_num, UnitTemplate in pairs( GroupTemplate.units ) do
 
@@ -660,27 +469,21 @@ function DATABASE:_RegisterGroupTemplate( GroupTemplate, CoalitionSide, Category
     self.Templates.Units[UnitTemplate.name].GroupTemplate = GroupTemplate
     self.Templates.Units[UnitTemplate.name].GroupId = GroupTemplate.groupId
     self.Templates.Units[UnitTemplate.name].CategoryID = CategoryID
-    self.Templates.Units[UnitTemplate.name].CoalitionID = CoalitionSide
+    self.Templates.Units[UnitTemplate.name].CoalitionID = CoalitionID
     self.Templates.Units[UnitTemplate.name].CountryID = CountryID
 
     if UnitTemplate.skill and (UnitTemplate.skill == "Client" or UnitTemplate.skill == "Player") then
       self.Templates.ClientsByName[UnitTemplate.name] = UnitTemplate
       self.Templates.ClientsByName[UnitTemplate.name].CategoryID = CategoryID
-      self.Templates.ClientsByName[UnitTemplate.name].CoalitionID = CoalitionSide
+      self.Templates.ClientsByName[UnitTemplate.name].CoalitionID = CoalitionID
       self.Templates.ClientsByName[UnitTemplate.name].CountryID = CountryID
       self.Templates.ClientsByID[UnitTemplate.unitId] = UnitTemplate
     end
     
-    UnitNames[#UnitNames+1] = self.Templates.Units[UnitTemplate.name].UnitName 
+    TraceTable[#TraceTable+1] = self.Templates.Units[UnitTemplate.name].UnitName 
   end
 
-  self:I( { Group = self.Templates.Groups[GroupTemplateName].GroupName,
-            Coalition = self.Templates.Groups[GroupTemplateName].CoalitionID,
-            Category = self.Templates.Groups[GroupTemplateName].CategoryID,
-            Country = self.Templates.Groups[GroupTemplateName].CountryID,
-            Units = UnitNames
-          }
-        )
+  self:E( TraceTable )
 end
 
 function DATABASE:GetGroupTemplate( GroupName )
@@ -693,11 +496,11 @@ end
 
 --- Private method that registers new Static Templates within the DATABASE Object.
 -- @param #DATABASE self
--- @param #table StaticTemplate
+-- @param #table GroupTemplate
 -- @return #DATABASE self
 function DATABASE:_RegisterStaticTemplate( StaticTemplate, CoalitionID, CategoryID, CountryID )
 
-  local StaticTemplate = UTILS.DeepCopy( StaticTemplate )
+  local TraceTable = {}
 
   local StaticTemplateName = env.getValueDictByKey(StaticTemplate.name)
   
@@ -714,28 +517,28 @@ function DATABASE:_RegisterStaticTemplate( StaticTemplate, CoalitionID, Category
   self.Templates.Statics[StaticTemplateName].CoalitionID = CoalitionID
   self.Templates.Statics[StaticTemplateName].CountryID = CountryID
 
-  self:I( { Static = self.Templates.Statics[StaticTemplateName].StaticName,
-            Coalition = self.Templates.Statics[StaticTemplateName].CoalitionID,
-            Category = self.Templates.Statics[StaticTemplateName].CategoryID,
-            Country = self.Templates.Statics[StaticTemplateName].CountryID 
-          }
-        )
-        
-  self:AddStatic( StaticTemplateName )
   
+  TraceTable[#TraceTable+1] = "Static"
+  TraceTable[#TraceTable+1] = self.Templates.Statics[StaticTemplateName].GroupName
+
+  TraceTable[#TraceTable+1] = "Coalition"
+  TraceTable[#TraceTable+1] = self.Templates.Statics[StaticTemplateName].CoalitionID
+  TraceTable[#TraceTable+1] = "Category"
+  TraceTable[#TraceTable+1] = self.Templates.Statics[StaticTemplateName].CategoryID
+  TraceTable[#TraceTable+1] = "Country"
+  TraceTable[#TraceTable+1] = self.Templates.Statics[StaticTemplateName].CountryID
+
+  self:E( TraceTable )
 end
 
 
---- @param #DATABASE self
-function DATABASE:GetStaticGroupTemplate( StaticName )
-  local StaticTemplate = self.Templates.Statics[StaticName].GroupTemplate
-  return StaticTemplate, self.Templates.Statics[StaticName].CoalitionID, self.Templates.Statics[StaticName].CategoryID, self.Templates.Statics[StaticName].CountryID
-end
-
 --- @param #DATABASE self
 function DATABASE:GetStaticUnitTemplate( StaticName )
-  local UnitTemplate = self.Templates.Statics[StaticName].UnitTemplate
-  return UnitTemplate, self.Templates.Statics[StaticName].CoalitionID, self.Templates.Statics[StaticName].CategoryID, self.Templates.Statics[StaticName].CountryID
+  local StaticTemplate = self.Templates.Statics[StaticName].UnitTemplate
+  StaticTemplate.SpawnCoalitionID = self.Templates.Statics[StaticName].CoalitionID
+  StaticTemplate.SpawnCategoryID = self.Templates.Statics[StaticName].CategoryID
+  StaticTemplate.SpawnCountryID = self.Templates.Statics[StaticName].CountryID
+  return StaticTemplate
 end
 
 
@@ -776,7 +579,7 @@ end
 -- @return #DATABASE self
 function DATABASE:_RegisterPlayers()
 
-  local CoalitionsData = { AlivePlayersRed = coalition.getPlayers( coalition.side.RED ), AlivePlayersBlue = coalition.getPlayers( coalition.side.BLUE ), AlivePlayersNeutral = coalition.getPlayers( coalition.side.NEUTRAL ) }
+  local CoalitionsData = { AlivePlayersRed = coalition.getPlayers( coalition.side.RED ), AlivePlayersBlue = coalition.getPlayers( coalition.side.BLUE ) }
   for CoalitionId, CoalitionData in pairs( CoalitionsData ) do
     for UnitId, UnitData in pairs( CoalitionData ) do
       self:T3( { "UnitData:", UnitData } )
@@ -784,7 +587,7 @@ function DATABASE:_RegisterPlayers()
         local UnitName = UnitData:getName()
         local PlayerName = UnitData:getPlayerName()
         if not self.PLAYERS[PlayerName] then
-          self:I( { "Add player for unit:", UnitName, PlayerName } )
+          self:E( { "Add player for unit:", UnitName, PlayerName } )
           self:AddPlayer( UnitName, PlayerName )
         end
       end
@@ -800,20 +603,20 @@ end
 -- @return #DATABASE self
 function DATABASE:_RegisterGroupsAndUnits()
 
-  local CoalitionsData = { GroupsRed = coalition.getGroups( coalition.side.RED ), GroupsBlue = coalition.getGroups( coalition.side.BLUE ),  GroupsNeutral = coalition.getGroups( coalition.side.NEUTRAL ) }
+  local CoalitionsData = { GroupsRed = coalition.getGroups( coalition.side.RED ), GroupsBlue = coalition.getGroups( coalition.side.BLUE ) }
   for CoalitionId, CoalitionData in pairs( CoalitionsData ) do
     for DCSGroupId, DCSGroup in pairs( CoalitionData ) do
 
       if DCSGroup:isExist() then
         local DCSGroupName = DCSGroup:getName()
   
-        self:I( { "Register Group:", DCSGroupName } )
+        self:E( { "Register Group:", DCSGroupName } )
         self:AddGroup( DCSGroupName )
 
         for DCSUnitId, DCSUnit in pairs( DCSGroup:getUnits() ) do
   
           local DCSUnitName = DCSUnit:getName()
-          self:I( { "Register Unit:", DCSUnitName } )
+          self:E( { "Register Unit:", DCSUnitName } )
           self:AddUnit( DCSUnitName )
         end
       else
@@ -822,11 +625,6 @@ function DATABASE:_RegisterGroupsAndUnits()
       
     end
   end
-  
-  self:I("Groups:")
-  for GroupName, Group in pairs( self.GROUPS ) do
-    self:I( { "Group:", GroupName } )
-  end
 
   return self
 end
@@ -837,7 +635,7 @@ end
 function DATABASE:_RegisterClients()
 
   for ClientName, ClientTemplate in pairs( self.Templates.ClientsByName ) do
-    self:I( { "Register Client:", ClientName } )
+    self:E( { "Register Client:", ClientName } )
     self:AddClient( ClientName )
   end
   
@@ -848,14 +646,13 @@ end
 function DATABASE:_RegisterStatics()
 
   local CoalitionsData = { GroupsRed = coalition.getStaticObjects( coalition.side.RED ), GroupsBlue = coalition.getStaticObjects( coalition.side.BLUE ) }
-  self:I( { Statics = CoalitionsData } )
   for CoalitionId, CoalitionData in pairs( CoalitionsData ) do
     for DCSStaticId, DCSStatic in pairs( CoalitionData ) do
 
       if DCSStatic:isExist() then
         local DCSStaticName = DCSStatic:getName()
   
-        self:I( { "Register Static:", DCSStaticName } )
+        self:E( { "Register Static:", DCSStaticName } )
         self:AddStatic( DCSStaticName )
       else
         self:E( { "Static does not exist: ",  DCSStatic } )
@@ -875,7 +672,7 @@ function DATABASE:_RegisterAirbases()
 
       local DCSAirbaseName = DCSAirbase:getName()
 
-      self:I( { "Register Airbase:", DCSAirbaseName, DCSAirbase:getID() } )
+      self:E( { "Register Airbase:", DCSAirbaseName } )
       self:AddAirbase( DCSAirbaseName )
     end
   end
@@ -901,20 +698,7 @@ function DATABASE:_EventOnBirth( Event )
         self:AddGroup( Event.IniDCSGroupName )
       end
     end
-    if Event.IniObjectCategory == 1 then
-      Event.IniUnit = self:FindUnit( Event.IniDCSUnitName )
-      Event.IniGroup = self:FindGroup( Event.IniDCSGroupName )
-      local PlayerName = Event.IniUnit:GetPlayerName()
-      if PlayerName then
-        self:I( { "Player Joined:", PlayerName } )
-        if not self.PLAYERS[PlayerName] then
-          self:AddPlayer( Event.IniUnitName, PlayerName )
-        end
-        local Settings = SETTINGS:Set( PlayerName )
-        Settings:SetPlayerMenu( Event.IniUnit )
-        --MENU_INDEX:Refresh( Event.IniGroup )
-      end
-    end
+    --self:_EventOnPlayerEnterUnit( Event )
   end
 end
 
@@ -938,8 +722,6 @@ function DATABASE:_EventOnDeadOrCrash( Event )
       end
     end
   end
-  
-  self:AccountDestroys( Event )
 end
 
 
@@ -949,14 +731,13 @@ end
 function DATABASE:_EventOnPlayerEnterUnit( Event )
   self:F2( { Event } )
 
-  if Event.IniDCSUnit then
+  if Event.IniUnit then
     if Event.IniObjectCategory == 1 then
       self:AddUnit( Event.IniDCSUnitName )
-      Event.IniUnit = self:FindUnit( Event.IniDCSUnitName )
       self:AddGroup( Event.IniDCSGroupName )
-      local PlayerName = Event.IniDCSUnit:getPlayerName()
+      local PlayerName = Event.IniUnit:GetPlayerName()
       if not self.PLAYERS[PlayerName] then
-        self:AddPlayer( Event.IniDCSUnitName, PlayerName )
+        self:AddPlayer( Event.IniUnitName, PlayerName )
       end
       local Settings = SETTINGS:Set( PlayerName )
       Settings:SetPlayerMenu( Event.IniUnit )
@@ -974,8 +755,7 @@ function DATABASE:_EventOnPlayerLeaveUnit( Event )
   if Event.IniUnit then
     if Event.IniObjectCategory == 1 then
       local PlayerName = Event.IniUnit:GetPlayerName()
-      if PlayerName and self.PLAYERS[PlayerName] then
-        self:I( { "Player Left:", PlayerName } )
+      if self.PLAYERS[PlayerName] then
         local Settings = SETTINGS:Set( PlayerName )
         Settings:RemovePlayerMenu( Event.IniUnit )
         self:DeletePlayer( Event.IniUnit, PlayerName )
@@ -1159,31 +939,6 @@ function DATABASE:OnEventDeleteCargo( EventData )
 end
 
 
---- Handles the OnEventNewZone event.
--- @param #DATABASE self
--- @param Core.Event#EVENTDATA EventData
-function DATABASE:OnEventNewZone( EventData )
-  self:F2( { EventData } )
-
-  if EventData.Zone then
-    self:AddZone( EventData.Zone )
-  end
-end
-
-
---- Handles the OnEventDeleteZone.
--- @param #DATABASE self
--- @param Core.Event#EVENTDATA EventData
-function DATABASE:OnEventDeleteZone( EventData )
-  self:F2( { EventData } )
-
-  if EventData.Zone then
-    self:DeleteZone( EventData.Zone.ZoneName )
-  end
-end
-
-
-
 --- Gets the player settings
 -- @param #DATABASE self
 -- @param #string PlayerName
@@ -1215,20 +970,13 @@ function DATABASE:_RegisterTemplates()
   self.UNITS = {}
   --Build routines.db.units and self.Navpoints
   for CoalitionName, coa_data in pairs(env.mission.coalition) do
-    self:T({CoalitionName=CoalitionName})
 
-    if (CoalitionName == 'red' or CoalitionName == 'blue' or CoalitionName == 'neutrals') and type(coa_data) == 'table' then
+    if (CoalitionName == 'red' or CoalitionName == 'blue') and type(coa_data) == 'table' then
       --self.Units[coa_name] = {}
       
       local CoalitionSide = coalition.side[string.upper(CoalitionName)]
-      if CoalitionName=="red" then
-        CoalitionSide=coalition.side.NEUTRAL
-      elseif CoalitionName=="blue" then
-        CoalitionSide=coalition.side.BLUE
-      else
-        CoalitionSide=coalition.side.NEUTRAL
-      end
 
+      ----------------------------------------------
       -- build nav points DB
       self.Navpoints[CoalitionName] = {}
       if coa_data.nav_points then --navpoints
@@ -1243,9 +991,8 @@ function DATABASE:_RegisterTemplates()
             self.Navpoints[CoalitionName][nav_ind]['point']['y'] = 0
             self.Navpoints[CoalitionName][nav_ind]['point']['z'] = nav_data.y
           end
-        end
       end
-
+      end
       -------------------------------------------------
       if coa_data.country then --there is a country table
         for cntry_id, cntry_data in pairs(coa_data.country) do
@@ -1298,98 +1045,14 @@ function DATABASE:_RegisterTemplates()
     end --if coa_name == 'red' or coa_name == 'blue' and type(coa_data) == 'table' then
   end --for coa_name, coa_data in pairs(mission.coalition) do
 
+  for ZoneID, ZoneData in pairs( env.mission.triggers.zones ) do
+    local ZoneName = ZoneData.name
+    self.ZONENAMES[ZoneName] = ZoneName
+  end
+
   return self
 end
 
-  --- Account the Hits of the Players.
-  -- @param #DATABASE self
-  -- @param Core.Event#EVENTDATA Event
-  function DATABASE:AccountHits( Event )
-    self:F( { Event } )
-  
-    if Event.IniPlayerName ~= nil then -- It is a player that is hitting something
-      self:T( "Hitting Something" )
-      
-      -- What is he hitting?
-      if Event.TgtCategory then
-  
-        -- A target got hit
-        self.HITS[Event.TgtUnitName] = self.HITS[Event.TgtUnitName] or {}
-        local Hit = self.HITS[Event.TgtUnitName]
-        
-        Hit.Players = Hit.Players or {}
-        Hit.Players[Event.IniPlayerName] = true
-      end
-    end
-    
-    -- 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:T( "Hitting Scenery" )
-      
-      -- What is he hitting?
-      if Event.TgtCategory then
-  
-        if Event.IniCoalition then -- A coalition object was hit, probably a static.
-          -- A target got hit
-          self.HITS[Event.TgtUnitName] = self.HITS[Event.TgtUnitName] or {}
-          local Hit = self.HITS[Event.TgtUnitName]
-          
-          Hit.Players = Hit.Players or {}
-          Hit.Players[Event.WeaponPlayerName] = true
-        else -- A scenery object was hit.
-        end
-      end
-    end
-  end
-  
-  --- Account the destroys.
-  -- @param #DATABASE self
-  -- @param Core.Event#EVENTDATA Event
-  function DATABASE:AccountDestroys( Event )
-    self:F( { Event } )
-  
-    local TargetUnit = nil
-    local TargetGroup = nil
-    local TargetUnitName = ""
-    local TargetGroupName = ""
-    local TargetPlayerName = ""
-    local TargetCoalition = nil
-    local TargetCategory = nil
-    local TargetType = nil
-    local TargetUnitCoalition = nil
-    local TargetUnitCategory = nil
-    local TargetUnitType = nil
-  
-    if Event.IniDCSUnit then
-  
-      TargetUnit = Event.IniUnit
-      TargetUnitName = Event.IniDCSUnitName
-      TargetGroup = Event.IniDCSGroup
-      TargetGroupName = Event.IniDCSGroupName
-      TargetPlayerName = Event.IniPlayerName
-  
-      TargetCoalition = Event.IniCoalition
-      --TargetCategory = TargetUnit:getCategory()
-      --TargetCategory = TargetUnit:getDesc().category  -- Workaround
-      TargetCategory = Event.IniCategory
-      TargetType = Event.IniTypeName
-  
-      TargetUnitType = TargetType
-  
-      self:T( { TargetUnitName, TargetGroupName, TargetPlayerName, TargetCoalition, TargetCategory, TargetType } )
-    end
-  
-    local Destroyed = false
-
-    -- What is the player destroying?
-    if self.HITS[Event.IniUnitName] then -- Was there a hit for this unit for this player before registered???
-      self.DESTROYS[Event.IniUnitName] = self.DESTROYS[Event.IniUnitName] or {}
-      self.DESTROYS[Event.IniUnitName] = true
-    end
-  end
-
-
 
 
 

Moose Development/Moose/Core/Event.lua

@@ -1,15 +1,10 @@
---- **Core** - Models DCS event dispatching using a publish-subscribe model.
+--- **Core** -- EVENT models DCS **event dispatching** using a **publish-subscribe** model.
+-- 
+-- ![Banner Image](..\Presentations\EVENT\Dia1.JPG)
 -- 
 -- ===
 -- 
--- ## Features:
--- 
---   * Capture DCS events and dispatch them to the subscribed objects.
---   * Generate DCS events to the subscribed objects from within the code.
--- 
--- ===
--- 
--- # Event Handling Overview
+-- # 1) Event Handling Overview
 -- 
 -- ![Objects](..\Presentations\EVENT\Dia2.JPG)
 -- 
@@ -21,7 +16,7 @@
 -- Objects can subscribe to different events. The Event dispatcher will publish the received DCS events to the subscribed MOOSE objects, in a specified order.
 -- In this way, the subscribed MOOSE objects are kept in sync with your evolving running mission.
 -- 
--- ## 1. Event Dispatching
+-- ## 1.1) Event Dispatching
 -- 
 -- ![Objects](..\Presentations\EVENT\Dia4.JPG)
 -- 
@@ -48,7 +43,7 @@
 -- 
 -- But for some DCS events, the publishing order is reversed. This is due to the fact that objects need to be **erased** instead of added.
 -- 
--- # 2. Event Handling
+-- ## 1.2) Event Handling
 -- 
 -- ![Objects](..\Presentations\EVENT\Dia8.JPG)
 -- 
@@ -60,14 +55,14 @@
 -- The BASE class provides methods to catch DCS Events. These are events that are triggered from within the DCS simulator, 
 -- and handled through lua scripting. MOOSE provides an encapsulation to handle these events more efficiently.
 -- 
--- ## 2.1. Subscribe to / Unsubscribe from DCS Events.
+-- ### 1.2.1 Subscribe / Unsubscribe to DCS Events
 -- 
 -- At first, the mission designer will need to **Subscribe** to a specific DCS event for the class.
 -- So, when the DCS event occurs, the class will be notified of that event.
 -- There are two functions which you use to subscribe to or unsubscribe from an event.
 -- 
---   * @{Core.Base#BASE.HandleEvent}(): Subscribe to a DCS Event.
---   * @{Core.Base#BASE.UnHandleEvent}(): Unsubscribe from a DCS Event.
+--   * @{Base#BASE.HandleEvent}(): Subscribe to a DCS Event.
+--   * @{Base#BASE.UnHandleEvent}(): Unsubscribe from a DCS Event.
 --   
 -- Note that for a UNIT, the event will be handled **for that UNIT only**!
 -- Note that for a GROUP, the event will be handled **for all the UNITs in that GROUP only**!
@@ -76,10 +71,10 @@
 -- So if a UNIT within the mission has the subscribed event for that object, 
 -- then the object event handler will receive the event for that UNIT!
 -- 
--- ## 2.2 Event Handling of DCS Events
+-- ### 1.3.2 Event Handling of DCS Events
 -- 
 -- Once the class is subscribed to the event, an **Event Handling** method on the object or class needs to be written that will be called
--- when the DCS event occurs. The Event Handling method receives an @{Core.Event#EVENTDATA} structure, which contains a lot of information
+-- when the DCS event occurs. The Event Handling method receives an @{Event#EVENTDATA} structure, which contains a lot of information
 -- about the event that occurred.
 -- 
 -- Find below an example of the prototype how to write an event handling function for two units: 
@@ -107,21 +102,21 @@
 --        self:SmokeBlue()
 --      end
 -- 
--- ## 2.3 Event Handling methods that are automatically called upon subscribed DCS events.
+-- ### 1.3.3 Event Handling methods that are automatically called upon subscribed DCS events
 -- 
 -- ![Objects](..\Presentations\EVENT\Dia10.JPG)
 -- 
 -- The following list outlines which EVENTS item in the structure corresponds to which Event Handling method.
 -- Always ensure that your event handling methods align with the events being subscribed to, or nothing will be executed.
 -- 
--- # 3. EVENTS type
+-- # 2) EVENTS type
 -- 
 -- The EVENTS structure contains names for all the different DCS events that objects can subscribe to using the 
--- @{Core.Base#BASE.HandleEvent}() method.
+-- @{Base#BASE.HandleEvent}() method.
 -- 
--- # 4. EVENTDATA type
+-- # 3) EVENTDATA type
 -- 
--- The @{Core.Event#EVENTDATA} structure contains all the fields that are populated with event information before 
+-- The @{Event#EVENTDATA} structure contains all the fields that are populated with event information before 
 -- an Event Handler method is being called by the event dispatcher.
 -- The Event Handler received the EVENTDATA object as a parameter, and can be used to investigate further the different events.
 -- There are basically 4 main categories of information stored in the EVENTDATA structure:
@@ -164,36 +159,28 @@
 -- 
 -- ===
 -- 
--- ### Author: **FlightControl**
+-- ### Author: **Sven Van de Velde (FlightControl)**
 -- ### Contributions: 
 -- 
--- ===
+-- ====
 --
--- @module Core.Event
--- @image Core_Event.JPG
+-- @module Event
 
 
---- @type EVENT
+--- The EVENT structure
+-- @type EVENT
 -- @field #EVENT.Events Events
 -- @extends Core.Base#BASE
-
---- The EVENT class
--- @field #EVENT
 EVENT = {
   ClassName = "EVENT",
   ClassID = 0,
-  MissionEnd = false,
 }
 
 world.event.S_EVENT_NEW_CARGO = world.event.S_EVENT_MAX + 1000
 world.event.S_EVENT_DELETE_CARGO = world.event.S_EVENT_MAX + 1001
-world.event.S_EVENT_NEW_ZONE = world.event.S_EVENT_MAX + 1002
-world.event.S_EVENT_DELETE_ZONE = world.event.S_EVENT_MAX + 1003
-world.event.S_EVENT_REMOVE_UNIT = world.event.S_EVENT_MAX + 1004
-
 
 --- The different types of events supported by MOOSE.
--- Use this structure to subscribe to events using the @{Core.Base#BASE.HandleEvent}() method.
+-- Use this structure to subscribe to events using the @{Base#BASE.HandleEvent}() method.
 -- @type EVENTS
 EVENTS = {
   Shot =              world.event.S_EVENT_SHOT,
@@ -219,14 +206,8 @@ EVENTS = {
   PlayerComment =     world.event.S_EVENT_PLAYER_COMMENT,
   ShootingStart =     world.event.S_EVENT_SHOOTING_START,
   ShootingEnd =       world.event.S_EVENT_SHOOTING_END,
-  MarkAdded =         world.event.S_EVENT_MARK_ADDED,
-  MarkChange =        world.event.S_EVENT_MARK_CHANGE,
-  MarkRemoved =       world.event.S_EVENT_MARK_REMOVED,
   NewCargo =          world.event.S_EVENT_NEW_CARGO,
   DeleteCargo =       world.event.S_EVENT_DELETE_CARGO,
-  NewZone =           world.event.S_EVENT_NEW_ZONE,
-  DeleteZone =        world.event.S_EVENT_DELETE_ZONE,
-  RemoveUnit =        world.event.S_EVENT_REMOVE_UNIT,
 }
 
 --- The Event structure
@@ -238,40 +219,36 @@ EVENTS = {
 -- @type EVENTDATA
 -- @field #number id The identifier of the event.
 -- 
--- @field DCS#Unit initiator (UNIT/STATIC/SCENERY) The initiating @{DCS#Unit} or @{DCS#StaticObject}.
--- @field DCS#Object.Category IniObjectCategory (UNIT/STATIC/SCENERY) The initiator object category ( Object.Category.UNIT or Object.Category.STATIC ).
--- @field DCS#Unit IniDCSUnit (UNIT/STATIC) The initiating @{DCS#Unit} or @{DCS#StaticObject}.
+-- @field Dcs.DCSUnit#Unit initiator (UNIT/STATIC/SCENERY) The initiating @{Dcs.DCSUnit#Unit} or @{Dcs.DCSStaticObject#StaticObject}.
+-- @field Dcs.DCSObject#Object.Category IniObjectCategory (UNIT/STATIC/SCENERY) The initiator object category ( Object.Category.UNIT or Object.Category.STATIC ).
+-- @field Dcs.DCSUnit#Unit IniDCSUnit (UNIT/STATIC) The initiating @{DCSUnit#Unit} or @{DCSStaticObject#StaticObject}.
 -- @field #string IniDCSUnitName (UNIT/STATIC) The initiating Unit name.
--- @field Wrapper.Unit#UNIT IniUnit (UNIT/STATIC) The initiating MOOSE wrapper @{Wrapper.Unit#UNIT} of the initiator Unit object.
+-- @field Wrapper.Unit#UNIT IniUnit (UNIT/STATIC) The initiating MOOSE wrapper @{Unit#UNIT} of the initiator Unit object.
 -- @field #string IniUnitName (UNIT/STATIC) The initiating UNIT name (same as IniDCSUnitName).
--- @field DCS#Group IniDCSGroup (UNIT) The initiating {DCSGroup#Group}.
+-- @field Dcs.DCSGroup#Group IniDCSGroup (UNIT) The initiating {DCSGroup#Group}.
 -- @field #string IniDCSGroupName (UNIT) The initiating Group name.
--- @field Wrapper.Group#GROUP IniGroup (UNIT) The initiating MOOSE wrapper @{Wrapper.Group#GROUP} of the initiator Group object.
+-- @field Wrapper.Group#GROUP IniGroup (UNIT) The initiating MOOSE wrapper @{Group#GROUP} of the initiator Group object.
 -- @field #string IniGroupName UNIT) The initiating GROUP name (same as IniDCSGroupName).
 -- @field #string IniPlayerName (UNIT) The name of the initiating player in case the Unit is a client or player slot.
--- @field DCS#coalition.side IniCoalition (UNIT) The coalition of the initiator.
--- @field DCS#Unit.Category IniCategory (UNIT) The category of the initiator.
+-- @field Dcs.DCScoalition#coalition.side IniCoalition (UNIT) The coalition of the initiator.
+-- @field Dcs.DCSUnit#Unit.Category IniCategory (UNIT) The category of the initiator.
 -- @field #string IniTypeName (UNIT) The type name of the initiator.
 -- 
--- @field DCS#Unit target (UNIT/STATIC) The target @{DCS#Unit} or @{DCS#StaticObject}.
--- @field DCS#Object.Category TgtObjectCategory (UNIT/STATIC) The target object category ( Object.Category.UNIT or Object.Category.STATIC ).
--- @field DCS#Unit TgtDCSUnit (UNIT/STATIC) The target @{DCS#Unit} or @{DCS#StaticObject}.
+-- @field Dcs.DCSUnit#Unit target (UNIT/STATIC) The target @{Dcs.DCSUnit#Unit} or @{DCSStaticObject#StaticObject}.
+-- @field Dcs.DCSObject#Object.Category TgtObjectCategory (UNIT/STATIC) The target object category ( Object.Category.UNIT or Object.Category.STATIC ).
+-- @field Dcs.DCSUnit#Unit TgtDCSUnit (UNIT/STATIC) The target @{DCSUnit#Unit} or @{DCSStaticObject#StaticObject}.
 -- @field #string TgtDCSUnitName (UNIT/STATIC) The target Unit name.
--- @field Wrapper.Unit#UNIT TgtUnit (UNIT/STATIC) The target MOOSE wrapper @{Wrapper.Unit#UNIT} of the target Unit object.
+-- @field Wrapper.Unit#UNIT TgtUnit (UNIT/STATIC) The target MOOSE wrapper @{Unit#UNIT} of the target Unit object.
 -- @field #string TgtUnitName (UNIT/STATIC) The target UNIT name (same as TgtDCSUnitName).
--- @field DCS#Group TgtDCSGroup (UNIT) The target {DCSGroup#Group}.
+-- @field Dcs.DCSGroup#Group TgtDCSGroup (UNIT) The target {DCSGroup#Group}.
 -- @field #string TgtDCSGroupName (UNIT) The target Group name.
--- @field Wrapper.Group#GROUP TgtGroup (UNIT) The target MOOSE wrapper @{Wrapper.Group#GROUP} of the target Group object.
+-- @field Wrapper.Group#GROUP TgtGroup (UNIT) The target MOOSE wrapper @{Group#GROUP} of the target Group object.
 -- @field #string TgtGroupName (UNIT) The target GROUP name (same as TgtDCSGroupName).
 -- @field #string TgtPlayerName (UNIT) The name of the target player in case the Unit is a client or player slot.
--- @field DCS#coalition.side TgtCoalition (UNIT) The coalition of the target.
--- @field DCS#Unit.Category TgtCategory (UNIT) The category of the target.
+-- @field Dcs.DCScoalition#coalition.side TgtCoalition (UNIT) The coalition of the target.
+-- @field Dcs.DCSUnit#Unit.Category TgtCategory (UNIT) The category of the target.
 -- @field #string TgtTypeName (UNIT) The type name of the target.
 -- 
--- @field DCS#Airbase place The @{DCS#Airbase}
--- @field Wrapper.Airbase#AIRBASE Place The MOOSE airbase object.
--- @field #string PlaceName The name of the airbase.
--- 
 -- @field weapon The weapon used during the event.
 -- @field Weapon
 -- @field WeaponName
@@ -418,24 +395,6 @@ local _EVENTMETA = {
      Event = "OnEventShootingEnd",
      Text = "S_EVENT_SHOOTING_END" 
    },
-   [world.event.S_EVENT_MARK_ADDED] = {
-     Order = 1,
-     Side = "I",
-     Event = "OnEventMarkAdded",
-     Text = "S_EVENT_MARK_ADDED" 
-   },
-   [world.event.S_EVENT_MARK_CHANGE] = {
-     Order = 1,
-     Side = "I",
-     Event = "OnEventMarkChange",
-     Text = "S_EVENT_MARK_CHANGE" 
-   },
-   [world.event.S_EVENT_MARK_REMOVED] = {
-     Order = 1,
-     Side = "I",
-     Event = "OnEventMarkRemoved",
-     Text = "S_EVENT_MARK_REMOVED" 
-   },
    [EVENTS.NewCargo] = {
      Order = 1,
      Event = "OnEventNewCargo",
@@ -446,21 +405,6 @@ local _EVENTMETA = {
      Event = "OnEventDeleteCargo",
      Text = "S_EVENT_DELETE_CARGO" 
    },
-   [EVENTS.NewZone] = {
-     Order = 1,
-     Event = "OnEventNewZone",
-     Text = "S_EVENT_NEW_ZONE" 
-   },
-   [EVENTS.DeleteZone] = {
-     Order = 1,
-     Event = "OnEventDeleteZone",
-     Text = "S_EVENT_DELETE_ZONE" 
-   },
-   [EVENTS.RemoveUnit] = {
-     Order = -1,
-     Event = "OnEventRemoveUnit",
-     Text = "S_EVENT_REMOVE_UNIT" 
-   },
 }
 
 
@@ -478,7 +422,7 @@ end
 
 --- Initializes the Events structure for the event
 -- @param #EVENT self
--- @param DCS#world.event EventID
+-- @param Dcs.DCSWorld#world.event EventID
 -- @param Core.Base#BASE EventClass
 -- @return #EVENT.Events
 function EVENT:Init( EventID, EventClass )
@@ -504,7 +448,7 @@ end
 --- Removes a subscription
 -- @param #EVENT self
 -- @param Core.Base#BASE EventClass The self instance of the class for which the event is.
--- @param DCS#world.event EventID
+-- @param Dcs.DCSWorld#world.event EventID
 -- @return #EVENT.Events
 function EVENT:RemoveEvent( EventClass, EventID  )
 
@@ -515,6 +459,7 @@ function EVENT:RemoveEvent( EventClass, EventID  )
   self.Events = self.Events or {}
   self.Events[EventID] = self.Events[EventID] or {}
   self.Events[EventID][EventPriority] = self.Events[EventID][EventPriority] or {}  
+  self.Events[EventID][EventPriority][EventClass] = self.Events[EventID][EventPriority][EventClass]
     
   self.Events[EventID][EventPriority][EventClass] = nil
   
@@ -523,11 +468,11 @@ end
 --- Resets subscriptions
 -- @param #EVENT self
 -- @param Core.Base#BASE EventClass The self instance of the class for which the event is.
--- @param DCS#world.event EventID
+-- @param Dcs.DCSWorld#world.event EventID
 -- @return #EVENT.Events
 function EVENT:Reset( EventObject ) --R2.1
 
-  self:F( { "Resetting subscriptions for class: ", EventObject:GetClassNameAndID() } )
+  self:E( { "Resetting subscriptions for class: ", EventObject:GetClassNameAndID() } )
 
   local EventPriority = EventObject:GetEventPriority()
   for EventID, EventData in pairs( self.Events ) do
@@ -546,7 +491,7 @@ end
 
 
 
---- Clears all event subscriptions for a @{Core.Base#BASE} derived object.
+--- Clears all event subscriptions for a @{Base#BASE} derived object.
 -- @param #EVENT self
 -- @param Core.Base#BASE EventObject
 function EVENT:RemoveAll( EventObject  )
@@ -617,6 +562,7 @@ end
 -- @param EventID
 -- @return #EVENT
 function EVENT:OnEventForGroup( GroupName, EventFunction, EventClass, EventID, ... )
+  self:E( GroupName )
 
   local Event = self:Init( EventID, EventClass )
   Event.EventGroup = true
@@ -738,7 +684,7 @@ do -- Event Creation
   -- @param #EVENT self
   -- @param AI.AI_Cargo#AI_CARGO Cargo The Cargo created.
   function EVENT:CreateEventNewCargo( Cargo )
-    self:I( { Cargo } )
+    self:F( { Cargo } )
   
     local Event = {
       id = EVENTS.NewCargo,
@@ -764,36 +710,6 @@ do -- Event Creation
     world.onEvent( Event )
   end
 
-  --- Creation of a New Zone Event.
-  -- @param #EVENT self
-  -- @param Core.Zone#ZONE_BASE Zone The Zone created.
-  function EVENT:CreateEventNewZone( Zone )
-    self:F( { Zone } )
-  
-    local Event = {
-      id = EVENTS.NewZone,
-      time = timer.getTime(),
-      zone = Zone,
-      }
-  
-    world.onEvent( Event )
-  end
-
-  --- Creation of a Zone Deletion Event.
-  -- @param #EVENT self
-  -- @param Core.Zone#ZONE_BASE Zone The Zone created.
-  function EVENT:CreateEventDeleteZone( Zone )
-    self:F( { Zone } )
-  
-    local Event = {
-      id = EVENTS.DeleteZone,
-      time = timer.getTime(),
-      zone = Zone,
-      }
-  
-    world.onEvent( Event )
-  end
-
   --- Creation of a S_EVENT_PLAYER_ENTER_UNIT Event.
   -- @param #EVENT self
   -- @param Wrapper.Unit#UNIT PlayerUnit.
@@ -818,7 +734,7 @@ function EVENT:onEvent( Event )
   local ErrorHandler = function( errmsg )
 
     env.info( "Error in SCHEDULER function:" .. errmsg )
-    if BASE.Debug ~= nil then
+    if debug ~= nil then
       env.info( debug.traceback() )
     end
     
@@ -828,20 +744,13 @@ function EVENT:onEvent( Event )
 
   local EventMeta = _EVENTMETA[Event.id]
 
-  --self:E( { EventMeta.Text, Event } )  -- Activate the see all incoming events ...
-
   if self and 
      self.Events and 
      self.Events[Event.id] and
-     self.MissionEnd == false and
      ( Event.initiator ~= nil or ( Event.initiator == nil and Event.id ~= EVENTS.PlayerLeaveUnit ) ) then
 
-    if Event.id and Event.id == EVENTS.MissionEnd then
-      self.MissionEnd = true
-    end
-    
     if Event.initiator then    
-      
+
       Event.IniObjectCategory = Event.initiator:getCategory()
 
       if Event.IniObjectCategory == Object.Category.UNIT then
@@ -878,16 +787,6 @@ function EVENT:onEvent( Event )
         Event.IniTypeName = Event.IniDCSUnit:getTypeName()
       end
 
-      if Event.IniObjectCategory == Object.Category.CARGO then
-        Event.IniDCSUnit = Event.initiator
-        Event.IniDCSUnitName = Event.IniDCSUnit:getName()
-        Event.IniUnitName = Event.IniDCSUnitName
-        Event.IniUnit = CARGO:FindByName( Event.IniDCSUnitName )
-        Event.IniCoalition = Event.IniDCSUnit:getCoalition()
-        Event.IniCategory = Event.IniDCSUnit:getDesc().category
-        Event.IniTypeName = Event.IniDCSUnit:getTypeName()
-      end
-
       if Event.IniObjectCategory == Object.Category.SCENERY then
         Event.IniDCSUnit = Event.initiator
         Event.IniDCSUnitName = Event.IniDCSUnit:getName()
@@ -926,7 +825,7 @@ function EVENT:onEvent( Event )
         Event.TgtDCSUnit = Event.target
         Event.TgtDCSUnitName = Event.TgtDCSUnit:getName()
         Event.TgtUnitName = Event.TgtDCSUnitName
-        Event.TgtUnit = STATIC:FindByName( Event.TgtDCSUnitName, false )
+        Event.TgtUnit = STATIC:FindByName( Event.TgtDCSUnitName )
         Event.TgtCoalition = Event.TgtDCSUnit:getCoalition()
         Event.TgtCategory = Event.TgtDCSUnit:getDesc().category
         Event.TgtTypeName = Event.TgtDCSUnit:getTypeName()
@@ -953,40 +852,17 @@ function EVENT:onEvent( Event )
       --Event.WeaponTgtDCSUnit = Event.Weapon:getTarget()
     end
     
-    -- Place should be given for takeoff and landing events as well as base captured. It should be a DCS airbase. 
-    if Event.place then      
-      Event.Place=AIRBASE:Find(Event.place)
-      Event.PlaceName=Event.Place:GetName()
-    end
-
---  @FC: something like this should be added.
---[[    
-    if Event.idx then
-      Event.MarkID=Event.idx
-      Event.MarkVec3=Event.pos
-      Event.MarkCoordinate=COORDINATE:NewFromVec3(Event.pos)
-      Event.MarkText=Event.text
-      Event.MarkCoalition=Event.coalition
-      Event.MarkGroupID = Event.groupID
-    end
-]]
-    
     if Event.cargo then
       Event.Cargo = Event.cargo
       Event.CargoName = Event.cargo.Name
     end
-
-    if Event.zone then
-      Event.Zone = Event.zone
-      Event.ZoneName = Event.zone.ZoneName
-    end
     
     local PriorityOrder = EventMeta.Order
     local PriorityBegin = PriorityOrder == -1 and 5 or 1
     local PriorityEnd = PriorityOrder == -1 and 1 or 5
 
     if Event.IniObjectCategory ~= Object.Category.STATIC then
-      self:T( { EventMeta.Text, Event, Event.IniDCSUnitName, Event.TgtDCSUnitName, PriorityOrder } )
+      self:E( { EventMeta.Text, Event, Event.IniDCSUnitName, Event.TgtDCSUnitName, PriorityOrder } )
     end
     
     for EventPriority = PriorityBegin, PriorityEnd, PriorityOrder do
@@ -995,7 +871,7 @@ function EVENT:onEvent( Event )
       
         -- Okay, we got the event from DCS. Now loop the SORTED self.EventSorted[] table for the received Event.id, and for each EventData registered, check if a function needs to be called.
         for EventClass, EventData in pairs( self.Events[Event.id][EventPriority] ) do
-        
+
           --if Event.IniObjectCategory ~= Object.Category.STATIC then
           --  self:E( { "Evaluating: ", EventClass:GetClassNameAndID() } )
           --end
@@ -1008,10 +884,8 @@ function EVENT:onEvent( Event )
 
             -- So now the EventClass must be a UNIT class!!! We check if it is still "Alive".
             if EventClass:IsAlive() or
-               Event.id == EVENTS.PlayerEnterUnit or 
                Event.id == EVENTS.Crash or 
-               Event.id == EVENTS.Dead or 
-               Event.id == EVENTS.RemoveUnit then
+               Event.id == EVENTS.Dead then
             
               local UnitName = EventClass:GetName()
 
@@ -1022,7 +896,7 @@ function EVENT:onEvent( Event )
                 if EventData.EventFunction then
               
                   if Event.IniObjectCategory ~= 3 then
-                    self:F( { "Calling EventFunction for UNIT ", EventClass:GetClassNameAndID(), ", Unit ", Event.IniUnitName, EventPriority } )
+                    self:E( { "Calling EventFunction for UNIT ", EventClass:GetClassNameAndID(), ", Unit ", Event.IniUnitName, EventPriority } )
                   end
                                   
                   local Result, Value = xpcall( 
@@ -1038,7 +912,7 @@ function EVENT:onEvent( Event )
                     
                     -- Now call the default event function.
                     if Event.IniObjectCategory ~= 3 then
-                      self:F( { "Calling " .. EventMeta.Event .. " for Class ", EventClass:GetClassNameAndID(), EventPriority } )
+                      self:E( { "Calling " .. EventMeta.Event .. " for Class ", EventClass:GetClassNameAndID(), EventPriority } )
                     end
                                   
                     local Result, Value = xpcall( 
@@ -1059,10 +933,8 @@ function EVENT:onEvent( Event )
 
               -- So now the EventClass must be a GROUP class!!! We check if it is still "Alive".
               if EventClass:IsAlive() or
-                 Event.id == EVENTS.PlayerEnterUnit or
                  Event.id == EVENTS.Crash or
-                 Event.id == EVENTS.Dead or
-                 Event.id == EVENTS.RemoveUnit then
+                 Event.id == EVENTS.Dead then
 
                 -- We can get the name of the EventClass, which is now always a GROUP object.
                 local GroupName = EventClass:GetName()
@@ -1074,7 +946,7 @@ function EVENT:onEvent( Event )
                   if EventData.EventFunction then
     
                     if Event.IniObjectCategory ~= 3 then
-                      self:F( { "Calling EventFunction for GROUP ", EventClass:GetClassNameAndID(), ", Unit ", Event.IniUnitName, EventPriority } )
+                      self:E( { "Calling EventFunction for GROUP ", EventClass:GetClassNameAndID(), ", Unit ", Event.IniUnitName, EventPriority } )
                     end
                                       
                     local Result, Value = xpcall( 
@@ -1090,7 +962,7 @@ function EVENT:onEvent( Event )
                       
                       -- Now call the default event function.
                       if Event.IniObjectCategory ~= 3 then
-                        self:F( { "Calling " .. EventMeta.Event .. " for GROUP ", EventClass:GetClassNameAndID(), EventPriority } )
+                        self:E( { "Calling " .. EventMeta.Event .. " for GROUP ", EventClass:GetClassNameAndID(), EventPriority } )
                       end
                                           
                       local Result, Value = xpcall( 
@@ -1146,18 +1018,8 @@ function EVENT:onEvent( Event )
         end
       end
     end
-    
-    -- When cargo was deleted, it may probably be because of an S_EVENT_DEAD.
-    -- However, in the loading logic, an S_EVENT_DEAD is also generated after a Destroy() call.
-    -- And this is a problem because it will remove all entries from the SET_CARGOs.
-    -- To prevent this from happening, the Cargo object has a flag NoDestroy.
-    -- When true, the SET_CARGO won't Remove the Cargo object from the set.
-    -- But we need to switch that flag off after the event handlers have been called.
-    if Event.id == EVENTS.DeleteCargo then
-      Event.Cargo.NoDestroy = nil
-    end
   else
-    self:T( { EventMeta.Text, Event } )    
+    self:E( { EventMeta.Text, Event } )    
   end
   
   Event = nil

Moose Development/Moose/Core/Fsm.lua

@@ -1,18 +1,7 @@
---- **Core** - FSM (Finite State Machine) are objects that model and control long lasting business processes and workflow.
+--- **Core** -- The **FSM** (**F**inite **S**tate **M**achine) class and derived **FSM\_** classes 
+-- are design patterns allowing efficient (long-lasting) processes and workflows.
 -- 
--- ===
--- 
--- ## Features:
--- 
---   * Provide a base class to model your own state machines.
---   * Trigger events synchronously.
---   * Trigger events asynchronously.
---   * Handle events before or after the event was triggered.
---   * Handle state transitions as a result of event before and after the state change.
---   * For internal moose purposes, further state machines have been designed:
---     - to handle controllables (groups and units).
---     - to handle tasks.
---     - to handle processes.
+-- ![Banner Image](..\Presentations\FSM\Dia1.JPG)
 -- 
 -- ===
 -- 
@@ -63,20 +52,19 @@
 -- 
 --   * @{#FSM_TASK}: Models Finite State Machines for @{Task}s.
 --   * @{#FSM_PROCESS}: Models Finite State Machines for @{Task} actions, which control @{Client}s.
---   * @{#FSM_CONTROLLABLE}: Models Finite State Machines for @{Wrapper.Controllable}s, which are @{Wrapper.Group}s, @{Wrapper.Unit}s, @{Client}s.
+--   * @{#FSM_CONTROLLABLE}: Models Finite State Machines for @{Controllable}s, which are @{Group}s, @{Unit}s, @{Client}s.
 --   * @{#FSM_SET}: Models Finite State Machines for @{Set}s. Note that these FSMs control multiple objects!!! So State concerns here
 --     for multiple objects or the position of the state machine in the process.
 -- 
--- ===
+-- ====
 -- 
 -- 
--- ### Author: **FlightControl**
+-- ### Author: **Sven Van de Velde (FlightControl)**
 -- ### Contributions: 
 -- 
--- ===
+-- ====
 --
--- @module Core.Fsm
--- @image Core_Finite_State_Machine.JPG
+-- @module Fsm
 
 do -- FSM
 
@@ -84,7 +72,9 @@ do -- FSM
   -- @extends Core.Base#BASE
   
   
-  --- A Finite State Machine (FSM) models a process flow that transitions between various **States** through triggered **Events**.
+  --- # FSM class, extends @{Base#BASE}
+  --
+  -- A Finite State Machine (FSM) models a process flow that transitions between various **States** through triggered **Events**.
   -- 
   -- A FSM can only be in one of a finite number of states. 
   -- The machine is in only one state at a time; the state it is in at any given time is called the **current state**. 
@@ -338,7 +328,7 @@ do -- FSM
   --
   -- ===
   -- 
-  -- @field #FSM
+  -- @field #FSM FSM
   -- 
   FSM = {
     ClassName = "FSM",
@@ -347,7 +337,7 @@ do -- FSM
   --- Creates a new FSM object.
   -- @param #FSM self
   -- @return #FSM
-  function FSM:New()
+  function FSM:New( FsmT )
   
     -- Inherits from BASE
     self = BASE:Inherit( self, BASE:New() )
@@ -420,7 +410,7 @@ do -- FSM
     return self._Transitions or {}
   end
   
-  --- Set the default @{Process} template with key ProcessName providing the ProcessClass and the process object when it is assigned to a @{Wrapper.Controllable} by the task.
+  --- Set the default @{Process} template with key ProcessName providing the ProcessClass and the process object when it is assigned to a @{Controllable} by the task.
   -- @param #FSM self
   -- @param #table From Can contain a string indicating the From state or a table of strings containing multiple From states.
   -- @param #string Event The Event name.
@@ -451,8 +441,6 @@ do -- FSM
   -- @return #table
   function FSM:GetProcesses()
   
-    self:F( { Processes = self._Processes } )
-  
     return self._Processes or {}
   end
   
@@ -467,18 +455,6 @@ do -- FSM
     error( "Sub-Process from state " .. From .. " with event " .. Event .. " not found!" )
   end
   
-  function FSM:SetProcess( From, Event, Fsm )
-  
-    for ProcessID, Process in pairs( self:GetProcesses() ) do
-      if Process.From == From and Process.Event == Event then
-        Process.fsm = Fsm
-        return true
-      end
-    end
-    
-    error( "Sub-Process from state " .. From .. " with event " .. Event .. " not found!" )
-  end
-  
   --- Adds an End state.
   function FSM:AddEndState( State )
   
@@ -581,130 +557,95 @@ do -- FSM
   end
   
   
-  function FSM:_call_handler( step, trigger, params, EventName )
+  function FSM:_call_handler( handler, params, EventName )
 
-    local handler = step .. trigger
     local ErrorHandler = function( errmsg )
   
       env.info( "Error in SCHEDULER function:" .. errmsg )
-      if BASE.Debug ~= nil then
-        env.info( BASE.Debug.traceback() )
+      if debug ~= nil then
+        env.info( debug.traceback() )
       end
       
       return errmsg
     end
     if self[handler] then
-      self:T( "*** FSM ***    " .. step .. " *** " .. params[1] .. " --> " .. params[2] .. " --> " .. params[3] )
+      self:T2( "Calling " .. handler )
       self._EventSchedules[EventName] = nil
       local Result, Value = xpcall( function() return self[handler]( self, unpack( params ) ) end, ErrorHandler )
       return Value
     end
   end
   
-  --- @param #FSM self
   function FSM._handler( self, EventName, ... )
   
-    local Can, To = self:can( EventName )
+    local Can, to = self:can( EventName )
   
-    if To == "*" then
-      To = self.current
+    if to == "*" then
+      to = self.current
     end
   
     if Can then
-      local From = self.current
-      local Params = { From, EventName, To, ...  }
+      local from = self.current
+      local params = { from, EventName, to, ...  }
 
-
-      if self["onleave".. From] or
-         self["OnLeave".. From] or
-         self["onbefore".. EventName] or
-         self["OnBefore".. EventName] or
-         self["onafter".. EventName] or
-         self["OnAfter".. EventName] or
-         self["onenter".. To] or
-         self["OnEnter".. To] 
-      then
-        if self:_call_handler( "onbefore", EventName, Params, EventName ) == false then
-          self:T( "*** FSM ***    Cancel" .. " *** " .. self.current .. " --> " .. EventName .. " --> " .. To .. " *** onbefore" .. EventName )
-          return false
-        else
-          if self:_call_handler( "OnBefore", EventName, Params, EventName ) == false then
-            self:T( "*** FSM ***    Cancel" .. " *** " .. self.current .. " --> " .. EventName .. " --> " .. To .. " *** OnBefore" .. EventName )
-            return false
-          else
-            if self:_call_handler( "onleave", From, Params, EventName ) == false then  
-              self:T( "*** FSM ***    Cancel" .. " *** " .. self.current .. " --> " .. EventName .. " --> " .. To .. " *** onleave" .. From )
-              return false
-            else
-              if self:_call_handler( "OnLeave", From, Params, EventName ) == false then
-                self:T( "*** FSM ***    Cancel" .. " *** " .. self.current .. " --> " .. EventName .. " --> " .. To .. " *** OnLeave" .. From )
-                return false
-              end
-            end  
-          end
-        end
+      if self.Controllable then
+        self:T( "FSM Transition for " .. self.Controllable.ControllableName .. " :" .. self.current .. " --> " .. EventName .. " --> " .. to )
       else
-        local ClassName = self:GetClassName()
-        if ClassName == "FSM" then
-          self:T( "*** FSM ***    Transit *** " .. self.current .. " --> " .. EventName .. " --> " .. To )
-        end
+        self:T( "FSM Transition:" .. self.current .. " --> " .. EventName .. " --> " .. to )
+      end        
   
-        if ClassName == "FSM_TASK" then
-          self:T( "*** FSM ***    Transit *** " .. self.current .. " --> " .. EventName .. " --> " .. To .. " *** Task: " .. self.TaskName )
-        end
-  
-        if ClassName == "FSM_CONTROLLABLE" then
-          self:T( "*** FSM ***    Transit *** " .. self.current .. " --> " .. EventName .. " --> " .. To .. " *** TaskUnit: " .. self.Controllable.ControllableName .. " *** "  )
-        end        
-    
-        if ClassName == "FSM_PROCESS" then
-          self:T( "*** FSM ***    Transit *** " .. self.current .. " --> " .. EventName .. " --> " .. To .. " *** Task: " .. self.Task:GetName() .. ", TaskUnit: " .. self.Controllable.ControllableName .. " *** "  )
-        end        
+      if ( self:_call_handler("onbefore" .. EventName, params, EventName ) == false )
+      or ( self:_call_handler("OnBefore" .. EventName, params, EventName ) == false )
+      or ( self:_call_handler("onleave" .. from, params, EventName ) == false )
+      or ( self:_call_handler("OnLeave" .. from, params, EventName ) == false ) then
+        self:T( "Cancel Transition" )
+        return false
       end
   
-      self.current = To
+      self.current = to
   
       local execute = true
   
-      local subtable = self:_gosub( From, EventName )
+      local subtable = self:_gosub( from, EventName )
       for _, sub in pairs( subtable ) do
         --if sub.nextevent then
         --  self:F2( "nextevent = " .. sub.nextevent )
         --  self[sub.nextevent]( self )
         --end
-        self:T( "*** FSM ***    Sub *** " .. sub.StartEvent )
+        self:T( "calling sub start event: " .. sub.StartEvent )
         sub.fsm.fsmparent = self
         sub.fsm.ReturnEvents = sub.ReturnEvents
         sub.fsm[sub.StartEvent]( sub.fsm )
         execute = false
       end
   
-      local fsmparent, Event = self:_isendstate( To )
+      local fsmparent, Event = self:_isendstate( to )
       if fsmparent and Event then
-        self:T( "*** FSM ***    End *** " .. Event )
-        self:_call_handler("onenter", To, Params, EventName )
-        self:_call_handler("OnEnter", To, Params, EventName )
-        self:_call_handler("onafter", EventName, Params, EventName )
-        self:_call_handler("OnAfter", EventName, Params, EventName )
-        self:_call_handler("onstate", "change", Params, EventName )
+        self:F2( { "end state: ", fsmparent, Event } )
+        self:_call_handler("onenter" .. to, params, EventName )
+        self:_call_handler("OnEnter" .. to, params, EventName )
+        self:_call_handler("onafter" .. EventName, params, EventName )
+        self:_call_handler("OnAfter" .. EventName, params, EventName )
+        self:_call_handler("onstatechange", params, EventName )
         fsmparent[Event]( fsmparent )
         execute = false
       end
   
       if execute then
-          self:_call_handler("onafter", EventName, Params, EventName )
-          self:_call_handler("OnAfter", EventName, Params, EventName )
-      
         -- only execute the call if the From state is not equal to the To state! Otherwise this function should never execute!
         --if from ~= to then
-          self:_call_handler("onenter", To, Params, EventName )
-          self:_call_handler("OnEnter", To, Params, EventName )
+          self:_call_handler("onenter" .. to, params, EventName )
+          self:_call_handler("OnEnter" .. to, params, EventName )
         --end
-    
-        self:_call_handler("onstate", "change", Params, EventName )
+  
+        self:_call_handler("onafter" .. EventName, params, EventName )
+        self:_call_handler("OnAfter" .. EventName, params, EventName )
+  
+        self:_call_handler("onstatechange", params, EventName )
       end
     else
-      self:T( "*** FSM *** NO Transition *** " .. self.current .. " --> " .. EventName .. " -->  ? " )
+      self:T( "Cannot execute transition." )
+      self:T( { From = self.current, Event = EventName, To = to, Can = Can } )
     end
   
     return nil
@@ -750,16 +691,17 @@ do -- FSM
   function FSM:_isendstate( Current )
     local FSMParent = self.fsmparent
     if FSMParent and self.endstates[Current] then
-      --self:T( { state = Current, endstates = self.endstates, endstate = self.endstates[Current] } )
+      self:T( { state = Current, endstates = self.endstates, endstate = self.endstates[Current] } )
       FSMParent.current = Current
       local ParentFrom = FSMParent.current
-      --self:T( { ParentFrom, self.ReturnEvents } )
+      self:T( ParentFrom )
+      self:T( self.ReturnEvents )
       local Event = self.ReturnEvents[Current]
-      --self:T( { Event } )
+      self:T( { ParentFrom, Event, self.ReturnEvents } )
       if Event then
         return FSMParent, Event
       else
-        --self:T( { "Could not find parent event name for state ", ParentFrom } )
+        self:T( { "Could not find parent event name for state ", ParentFrom } )
       end
     end
   
@@ -782,10 +724,6 @@ do -- FSM
     return self.current
   end
   
-  function FSM:GetCurrentState()
-    return self.current
-  end
-  
   
   function FSM:Is( State )
     return self.current == State
@@ -814,11 +752,14 @@ do -- FSM_CONTROLLABLE
   -- @field Wrapper.Controllable#CONTROLLABLE Controllable
   -- @extends Core.Fsm#FSM
   
-  --- Models Finite State Machines for @{Wrapper.Controllable}s, which are @{Wrapper.Group}s, @{Wrapper.Unit}s, @{Client}s.
+  --- # FSM_CONTROLLABLE, extends @{#FSM}
+  --
+  -- FSM_CONTROLLABLE class models Finite State Machines for @{Controllable}s, which are @{Group}s, @{Unit}s, @{Client}s.
   -- 
   -- ===
   -- 
-  -- @field #FSM_CONTROLLABLE
+  -- @field #FSM_CONTROLLABLE FSM_CONTROLLABLE
+  -- 
   FSM_CONTROLLABLE = {
     ClassName = "FSM_CONTROLLABLE",
   }
@@ -828,10 +769,10 @@ do -- FSM_CONTROLLABLE
   -- @param #table FSMT Finite State Machine Table
   -- @param Wrapper.Controllable#CONTROLLABLE Controllable (optional) The CONTROLLABLE object that the FSM_CONTROLLABLE governs.
   -- @return #FSM_CONTROLLABLE
-  function FSM_CONTROLLABLE:New( Controllable )
+  function FSM_CONTROLLABLE:New( FSMT, Controllable )
   
     -- Inherits from BASE
-    local self = BASE:Inherit( self, FSM:New() ) -- Core.Fsm#FSM_CONTROLLABLE
+    local self = BASE:Inherit( self, FSM:New( FSMT ) ) -- Core.Fsm#FSM_CONTROLLABLE
   
     if Controllable then
       self:SetControllable( Controllable )
@@ -914,22 +855,20 @@ do -- FSM_CONTROLLABLE
     return self.Controllable
   end
   
-  function FSM_CONTROLLABLE:_call_handler( step, trigger, params, EventName )
-  
-    local handler = step .. trigger
+  function FSM_CONTROLLABLE:_call_handler( handler, params, EventName )
   
     local ErrorHandler = function( errmsg )
   
       env.info( "Error in SCHEDULER function:" .. errmsg )
-      if BASE.Debug ~= nil then
-        env.info( BASE.Debug.traceback() )
+      if debug ~= nil then
+        env.info( debug.traceback() )
       end
       
       return errmsg
     end
   
     if self[handler] then
-      self:T( "*** FSM ***    " .. step .. " *** " .. params[1] .. " --> " .. params[2] .. " --> " .. params[3] .. " *** TaskUnit: " .. self.Controllable:GetName() )
+      self:F3( "Calling " .. handler )
       self._EventSchedules[EventName] = nil
       local Result, Value = xpcall( function() return self[handler]( self, self.Controllable, unpack( params ) ) end, ErrorHandler )
       return Value
@@ -946,7 +885,9 @@ do -- FSM_PROCESS
   -- @extends Core.Fsm#FSM_CONTROLLABLE
   
   
-  --- FSM_PROCESS class models Finite State Machines for @{Task} actions, which control @{Client}s.
+  --- # FSM_PROCESS, extends @{#FSM}
+  --
+  -- FSM_PROCESS class models Finite State Machines for @{Task} actions, which control @{Client}s.
   -- 
   -- ===
   -- 
@@ -964,9 +905,9 @@ do -- FSM_PROCESS
     local self = BASE:Inherit( self, FSM_CONTROLLABLE:New() ) -- Core.Fsm#FSM_PROCESS
 
     --self:F( Controllable )
-    
+  
     self:Assign( Controllable, Task )
-    
+  
     return self
   end
   
@@ -974,29 +915,22 @@ do -- FSM_PROCESS
     self:T( "No Initialisation" )
   end  
 
-  function FSM_PROCESS:_call_handler( step, trigger, params, EventName )
-  
-    local handler = step .. trigger
+  function FSM_PROCESS:_call_handler( handler, params, EventName )
   
     local ErrorHandler = function( errmsg )
   
       env.info( "Error in FSM_PROCESS call handler:" .. errmsg )
-      if BASE.Debug ~= nil then
-        env.info( BASE.Debug.traceback() )
+      if debug ~= nil then
+        env.info( debug.traceback() )
       end
       
       return errmsg
     end
   
     if self[handler] then
-      if handler ~= "onstatechange" then
-        self:T( "*** FSM ***    " .. step .. " *** " .. params[1] .. " --> " .. params[2] .. " --> " .. params[3] .. " *** Task: " .. self.Task:GetName() .. ", TaskUnit: " .. self.Controllable:GetName() )
-      end
+      self:F3( "Calling " .. handler )
       self._EventSchedules[EventName] = nil
-      local Result, Value
-      if self.Controllable and self.Controllable:IsAlive() == true then
-        Result, Value = xpcall( function() return self[handler]( self, self.Controllable, self.Task, unpack( params ) ) end, ErrorHandler )
-      end
+      local Result, Value = xpcall( function() return self[handler]( self, self.Controllable, self.Task, unpack( params ) ) end, ErrorHandler )
       return Value
       --return self[handler]( self, self.Controllable, unpack( params ) )
     end
@@ -1012,7 +946,7 @@ do -- FSM_PROCESS
     local NewFsm = self:New( Controllable, Task ) -- Core.Fsm#FSM_PROCESS
   
     NewFsm:Assign( Controllable, Task )
-
+  
     -- Polymorphic call to initialize the new FSM_PROCESS based on self FSM_PROCESS
     NewFsm:Init( self )
     
@@ -1103,26 +1037,26 @@ do -- FSM_PROCESS
 -- TODO: Need to check and fix that an FSM_PROCESS is only for a UNIT. Not for a GROUP.  
   
   --- Send a message of the @{Task} to the Group of the Unit.
-  -- @param #FSM_PROCESS self
-  function FSM_PROCESS:Message( Message )
-    self:F( { Message = Message } )
+-- @param #FSM_PROCESS self
+function FSM_PROCESS:Message( Message )
+  self:F( { Message = Message } )
+
+  local CC = self:GetCommandCenter()
+  local TaskGroup = self.Controllable:GetGroup()
   
-    local CC = self:GetCommandCenter()
-    local TaskGroup = self.Controllable:GetGroup()
-    
-    local PlayerName = self.Controllable:GetPlayerName() -- Only for a unit
-    PlayerName = PlayerName and " (" .. PlayerName .. ")" or "" -- If PlayerName is nil, then keep it nil, otherwise add brackets.
-    local Callsign = self.Controllable:GetCallsign()
-    local Prefix = Callsign and " @ " .. Callsign .. PlayerName or ""
-    
-    Message = Prefix .. ": " .. Message
-    CC:MessageToGroup( Message, TaskGroup )
-  end
+  local PlayerName = self.Controllable:GetPlayerName() -- Only for a unit
+  PlayerName = PlayerName and " (" .. PlayerName .. ")" or "" -- If PlayerName is nil, then keep it nil, otherwise add brackets.
+  local Callsign = self.Controllable:GetCallsign()
+  local Prefix = Callsign and " @ " .. Callsign .. PlayerName or ""
+  
+  Message = Prefix .. ": " .. Message
+  CC:MessageToGroup( Message, TaskGroup )
+end
 
   
   
   
-  --- Assign the process to a @{Wrapper.Unit} and activate the process.
+  --- Assign the process to a @{Unit} and activate the process.
   -- @param #FSM_PROCESS self
   -- @param Task.Tasking#TASK Task
   -- @param Wrapper.Unit#UNIT ProcessUnit
@@ -1138,16 +1072,14 @@ do -- FSM_PROCESS
     return self
   end
     
---  function FSM_PROCESS:onenterAssigned( ProcessUnit, Task, From, Event, To )
---  
---    if From( "Planned" ) then
---      self:T( "*** FSM ***    Assign *** " .. Task:GetName() .. "/" .. ProcessUnit:GetName() .. " *** " .. From .. " --> " .. Event .. " --> " .. To )
---      self.Task:Assign()
---    end
---  end
+  function FSM_PROCESS:onenterAssigned( ProcessUnit )
+    self:T( "Assign" )
   
-  function FSM_PROCESS:onenterFailed( ProcessUnit, Task, From, Event, To )
-    self:T( "*** FSM ***    Failed *** " .. Task:GetName() .. "/" .. ProcessUnit:GetName() .. " *** " .. From .. " --> " .. Event .. " --> " .. To )
+    self.Task:Assign()
+  end
+  
+  function FSM_PROCESS:onenterFailed( ProcessUnit )
+    self:T( "Failed" )
   
     self.Task:Fail()
   end
@@ -1159,17 +1091,14 @@ do -- FSM_PROCESS
   -- @param #string Event
   -- @param #string From
   -- @param #string To
-  function FSM_PROCESS:onstatechange( ProcessUnit, Task, From, Event, To )
+  function FSM_PROCESS:onstatechange( ProcessUnit, Task, From, Event, To, Dummy )
+    self:T( { ProcessUnit:GetName(), From, Event, To, Dummy, self:IsTrace() } )
   
-    if From ~= To then
-      self:T( "*** FSM ***    Change *** " .. Task:GetName() .. "/" .. ProcessUnit:GetName() .. " *** " .. From .. " --> " .. Event .. " --> " .. To )
+    if self:IsTrace() then
+      --MESSAGE:New( "@ Process " .. self:GetClassNameAndID() .. " : " .. Event .. " changed to state " .. To, 2 ):ToAll()
     end
   
---    if self:IsTrace() then
---      MESSAGE:New( "@ Process " .. self:GetClassNameAndID() .. " : " .. Event .. " changed to state " .. To, 2 ):ToAll()
---      self:F2( { Scores = self._Scores, To = To } )
---    end
-  
+    self:T( { Scores = self._Scores, To = To } )
     -- TODO: This needs to be reworked with a callback functions allocated within Task, and set within the mission script from the Task Objects...
     if self._Scores[To] then
     
@@ -1190,7 +1119,9 @@ do -- FSM_TASK
   -- @field Tasking.Task#TASK Task
   -- @extends #FSM
    
-  --- Models Finite State Machines for @{Tasking.Task}s.
+  --- # FSM_TASK, extends @{#FSM}
+  --
+  -- FSM_TASK class models Finite State Machines for @{Task}s.
   -- 
   -- ===
   -- 
@@ -1202,37 +1133,24 @@ do -- FSM_TASK
   
   --- Creates a new FSM_TASK object.
   -- @param #FSM_TASK self
-  -- @param #string TaskName The name of the task.
+  -- @param #table FSMT
+  -- @param Tasking.Task#TASK Task
+  -- @param Wrapper.Unit#UNIT TaskUnit
   -- @return #FSM_TASK
-  function FSM_TASK:New( TaskName )
+  function FSM_TASK:New( FSMT )
   
-    local self = BASE:Inherit( self, FSM_CONTROLLABLE:New() ) -- Core.Fsm#FSM_TASK
+    local self = BASE:Inherit( self, FSM_CONTROLLABLE:New( FSMT ) ) -- Core.Fsm#FSM_TASK
   
     self["onstatechange"] = self.OnStateChange
-    self.TaskName = TaskName
   
     return self
   end
   
-  function FSM_TASK:_call_handler( step, trigger, params, EventName )
-    local handler = step .. trigger
-    
-    local ErrorHandler = function( errmsg )
-  
-      env.info( "Error in SCHEDULER function:" .. errmsg )
-      if BASE.Debug ~= nil then
-        env.info( BASE.Debug.traceback() )
-      end
-      
-      return errmsg
-    end
-
+  function FSM_TASK:_call_handler( handler, params, EventName )
     if self[handler] then
-      self:T( "*** FSM ***    " .. step .. " *** " .. params[1] .. " --> " .. params[2] .. " --> " .. params[3] .. " *** Task: " .. self.TaskName )
+      self:T( "Calling " .. handler )
       self._EventSchedules[EventName] = nil
-      --return self[handler]( self, unpack( params ) )
-      local Result, Value = xpcall( function() return self[handler]( self, unpack( params ) ) end, ErrorHandler )
-      return Value
+      return self[handler]( self, unpack( params ) )
     end
   end
 
@@ -1246,7 +1164,9 @@ do -- FSM_SET
   -- @extends Core.Fsm#FSM
 
 
-  --- FSM_SET class models Finite State Machines for @{Set}s. Note that these FSMs control multiple objects!!! So State concerns here
+  --- # FSM_SET, extends @{#FSM}
+  --
+  -- FSM_SET class models Finite State Machines for @{Set}s. Note that these FSMs control multiple objects!!! So State concerns here
   -- for multiple objects or the position of the state machine in the process.
   -- 
   -- ===
@@ -1290,10 +1210,9 @@ do -- FSM_SET
     return self.Controllable
   end
   
-  function FSM_SET:_call_handler( step, trigger, params, EventName  )
-  local handler = step .. trigger
+  function FSM_SET:_call_handler( handler, params, EventName  )
     if self[handler] then
-      self:T( "*** FSM ***    " .. step .. " *** " .. params[1] .. " --> " .. params[2] .. " --> " .. params[3] )
+      self:T( "Calling " .. handler )
       self._EventSchedules[EventName] = nil
       return self[handler]( self, self.Set, unpack( params ) )
     end

Moose Development/Moose/Core/Goal.lua

@@ -1,184 +0,0 @@
---- **Core** - Models the process to achieve goal(s).
---
--- ===
--- 
--- ## Features:
--- 
---   * Define the goal.
---   * Monitor the goal achievement.
---   * Manage goal contribution by players.
--- 
--- ===
--- 
--- Classes that implement a goal achievement, will derive from GOAL to implement the ways how the achievements can be realized.
--- 
--- ===
--- 
--- ### Author: **FlightControl**
--- 
--- ===
--- 
--- @module Core.Goal
--- @image Core_Goal.JPG
-
-
-do -- Goal
-
-  --- @type GOAL
-  -- @extends Core.Fsm#FSM
-
-
-  --- Models processes that have an objective with a defined achievement. Derived classes implement the ways how the achievements can be realized.
-  -- 
-  -- # 1. GOAL constructor
-  --   
-  --   * @{#GOAL.New}(): Creates a new GOAL object.
-  -- 
-  -- # 2. GOAL is a finite state machine (FSM).
-  -- 
-  -- ## 2.1. GOAL States
-  -- 
-  --   * **Pending**: The goal object is in progress.
-  --   * **Achieved**: The goal objective is Achieved.
-  -- 
-  -- ## 2.2. GOAL Events
-  -- 
-  --   * **Achieved**: Set the goal objective to Achieved.
-  -- 
-  -- # 3. Player contributions.
-  -- 
-  -- Goals are most of the time achieved by players. These player achievements can be registered as part of the goal achievement.
-  -- Use @{#GOAL.AddPlayerContribution}() to add a player contribution to the goal.
-  -- The player contributions are based on a points system, an internal counter per player.
-  -- So once the goal has been achieved, the player contributions can be queried using @{#GOAL.GetPlayerContributions}(), 
-  -- that retrieves all contributions done by the players. For one player, the contribution can be queried using @{#GOAL.GetPlayerContribution}().
-  -- The total amount of player contributions can be queried using @{#GOAL.GetTotalContributions}().
-  -- 
-  -- # 4. Goal achievement.
-  -- 
-  -- Once the goal is achieved, the mission designer will need to trigger the goal achievement using the **Achieved** event.
-  -- The underlying 2 examples will achieve the goals for the `Goal` object:
-  -- 
-  --       Goal:Achieved() -- Achieve the goal immediately.
-  --       Goal:__Achieved( 30 ) -- Achieve the goal within 30 seconds.
-  -- 
-  -- # 5. Check goal achievement.
-  -- 
-  -- The method @{#GOAL.IsAchieved}() will return true if the goal is achieved (the trigger **Achieved** was executed).
-  -- You can use this method to check asynchronously if a goal has been achieved, for example using a scheduler.
-  -- 
-  -- @field #GOAL
-  GOAL = {
-    ClassName = "GOAL",
-  }
-  
-  --- @field #table GOAL.Players
-  GOAL.Players = {}
-
-  --- @field #number GOAL.TotalContributions
-  GOAL.TotalContributions = 0
-  
-  --- GOAL Constructor.
-  -- @param #GOAL self
-  -- @return #GOAL
-  function GOAL:New()
-  
-    local self = BASE:Inherit( self, FSM:New() ) -- #GOAL
-    self:F( {} )
-
-    --- Achieved State for GOAL
-    -- @field GOAL.Achieved
-
-    --- Achieved State Handler OnLeave for GOAL
-    -- @function [parent=#GOAL] OnLeaveAchieved
-    -- @param #GOAL self
-    -- @param #string From
-    -- @param #string Event
-    -- @param #string To
-    -- @return #boolean
-
-    --- Achieved State Handler OnEnter for GOAL
-    -- @function [parent=#GOAL] OnEnterAchieved
-    -- @param #GOAL self
-    -- @param #string From
-    -- @param #string Event
-    -- @param #string To
-    
-    
-    self:SetStartState( "Pending" )
-    self:AddTransition( "*",  "Achieved", "Achieved" )
-    
-    --- Achieved Handler OnBefore for GOAL
-    -- @function [parent=#GOAL] OnBeforeAchieved
-    -- @param #GOAL self
-    -- @param #string From
-    -- @param #string Event
-    -- @param #string To
-    -- @return #boolean
-    
-    --- Achieved Handler OnAfter for GOAL
-    -- @function [parent=#GOAL] OnAfterAchieved
-    -- @param #GOAL self
-    -- @param #string From
-    -- @param #string Event
-    -- @param #string To
-    
-    --- Achieved Trigger for GOAL
-    -- @function [parent=#GOAL] Achieved
-    -- @param #GOAL self
-    
-    --- Achieved Asynchronous Trigger for GOAL
-    -- @function [parent=#GOAL] __Achieved
-    -- @param #GOAL self
-    -- @param #number Delay
-    
-    self:SetEventPriority( 5 )
-
-    return self
-  end
-  
-  
-  --- Add a new contribution by a player.
-  -- @param #GOAL self
-  -- @param #string PlayerName The name of the player.
-  function GOAL:AddPlayerContribution( PlayerName )
-    self.Players[PlayerName] = self.Players[PlayerName] or 0
-    self.Players[PlayerName] = self.Players[PlayerName] + 1
-    self.TotalContributions = self.TotalContributions + 1
-  end
-  
-  
-  --- @param #GOAL self
-  -- @param #number Player contribution.
-  function GOAL:GetPlayerContribution( PlayerName )
-    return self.Players[PlayerName] or 0 
-  end
-
-  
-  --- Get the players who contributed to achieve the goal.
-  -- The result is a list of players, sorted by the name of the players.
-  -- @param #GOAL self
-  -- @return #list The list of players, indexed by the player name.
-  function GOAL:GetPlayerContributions()
-    return self.Players or {}
-  end
-
-  
-  --- Gets the total contributions that happened to achieve the goal.
-  -- The result is a number.
-  -- @param #GOAL self
-  -- @return #number The total number of contributions. 0 is returned if there were no contributions (yet).
-  function GOAL:GetTotalContributions()
-    return self.TotalContributions or 0
-  end
-  
-  
-  
-  --- Validates if the goal is achieved.
-  -- @param #GOAL self
-  -- @return #boolean true if the goal is achieved.
-  function GOAL:IsAchieved()
-    return self:Is( "Achieved" )
-  end
-
-end

Moose Development/Moose/Core/Message.lua

@@ -1,58 +1,50 @@
---- **Core** - Informs the players using messages during a simulation.
+--- **Core** -- MESSAGE class takes are of the **real-time notifications** and **messages to players** during a simulation.
+-- 
+-- ![Banner Image](..\Presentations\MESSAGE\Dia1.JPG)
 -- 
 -- ===
 -- 
--- ## Features:
--- 
---   * A more advanced messaging system using the DCS message system.
---   * Time messages.
---   * Send messages based on a message type, which has a pre-defined duration that can be tweaked in SETTINGS.
---   * Send message to all players.
---   * Send messages to a coalition.
---   * Send messages to a specific group.
--- 
--- ===
--- 
--- @module Core.Message
--- @image Core_Message.JPG
+-- @module Message
 
 --- The MESSAGE class
 -- @type MESSAGE
 -- @extends Core.Base#BASE
 
---- Message System to display Messages to Clients, Coalitions or All.
+--- # MESSAGE class, extends @{Base#BASE}
+-- 
+-- Message System to display Messages to Clients, Coalitions or All.
 -- Messages are shown on the display panel for an amount of seconds, and will then disappear.
 -- Messages can contain a category which is indicating the category of the message.
 -- 
 -- ## MESSAGE construction
 -- 
--- Messages are created with @{#MESSAGE.New}. Note that when the MESSAGE object is created, no message is sent yet.
+-- Messages are created with @{Message#MESSAGE.New}. Note that when the MESSAGE object is created, no message is sent yet.
 -- To send messages, you need to use the To functions.
 -- 
 -- ## Send messages to an audience
 -- 
 -- Messages are sent:
 --
---   * To a @{Client} using @{#MESSAGE.ToClient}().
---   * To a @{Wrapper.Group} using @{#MESSAGE.ToGroup}()
---   * To a coalition using @{#MESSAGE.ToCoalition}().
---   * To the red coalition using @{#MESSAGE.ToRed}().
---   * To the blue coalition using @{#MESSAGE.ToBlue}().
---   * To all Players using @{#MESSAGE.ToAll}().
+--   * To a @{Client} using @{Message#MESSAGE.ToClient}().
+--   * To a @{Group} using @{Message#MESSAGE.ToGroup}()
+--   * To a coalition using @{Message#MESSAGE.ToCoalition}().
+--   * To the red coalition using @{Message#MESSAGE.ToRed}().
+--   * To the blue coalition using @{Message#MESSAGE.ToBlue}().
+--   * To all Players using @{Message#MESSAGE.ToAll}().
 -- 
 -- ## Send conditionally to an audience
 -- 
 -- Messages can be sent conditionally to an audience (when a condition is true):
 --   
---   * To all players using @{#MESSAGE.ToAllIf}().
---   * To a coalition using @{#MESSAGE.ToCoalitionIf}().
+--   * To all players using @{Message#MESSAGE.ToAllIf}().
+--   * To a coalition using @{Message#MESSAGE.ToCoalitionIf}().
 -- 
--- ===
+-- ====
 --  
--- ### Author: **FlightControl**
+-- ### Author: **Sven Van de Velde (FlightControl)**
 -- ### Contributions: 
 -- 
--- ===
+-- ====
 -- 
 -- @field #MESSAGE
 MESSAGE = {
@@ -77,7 +69,6 @@ MESSAGE.Type = {
 -- @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 #boolean ClearScreen (optional) Clear all previous messages if true.
 -- @return #MESSAGE
 -- @usage
 -- -- Create a series of new Messages.
@@ -89,7 +80,7 @@ MESSAGE.Type = {
 -- 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( MessageText, MessageDuration, MessageCategory )
 	local self = BASE:Inherit( self, BASE:New() )
 	self:F( { MessageText, MessageDuration, MessageCategory } )
 
@@ -106,11 +97,6 @@ function MESSAGE:New( MessageText, MessageDuration, MessageCategory, ClearScreen
   else
     self.MessageCategory = ""
   end
-  
-  self.ClearScreen=false
-  if ClearScreen~=nil then
-    self.ClearScreen=ClearScreen
-  end
 
 	self.MessageDuration = MessageDuration or 5
 	self.MessageTime = timer.getTime()
@@ -131,24 +117,18 @@ end
 -- @param self
 -- @param #string MessageText is the text of the Message.
 -- @param #MESSAGE.Type MessageType The type of the message.
--- @param #boolean ClearScreen (optional) Clear all previous messages.
 -- @return #MESSAGE
 -- @usage
 --   MessageAll = MESSAGE:NewType( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", MESSAGE.Type.Information )
 --   MessageRED = MESSAGE:NewType( "To the RED Players: You receive a penalty because you've killed one of your own units", MESSAGE.Type.Information )
 --   MessageClient1 = MESSAGE:NewType( "Congratulations, you've just hit a target", MESSAGE.Type.Update )
 --   MessageClient2 = MESSAGE:NewType( "Congratulations, you've just killed a target", MESSAGE.Type.Update )
-function MESSAGE:NewType( MessageText, MessageType, ClearScreen )
+function MESSAGE:NewType( MessageText, MessageType )
 
   local self = BASE:Inherit( self, BASE:New() )
   self:F( { MessageText } )
   
   self.MessageType = MessageType
-  
-  self.ClearScreen=false
-  if ClearScreen~=nil then
-    self.ClearScreen=ClearScreen
-  end
 
   self.MessageTime = timer.getTime()
   self.MessageText = MessageText:gsub("^\n","",1):gsub("\n$","",1)
@@ -158,21 +138,11 @@ end
 
 
 
---- Clears all previous messages from the screen before the new message is displayed. Not that this must come before all functions starting with ToX(), e.g. ToAll(), ToGroup() etc. 
--- @param #MESSAGE self
--- @return #MESSAGE
-function MESSAGE:Clear()
-  self:F()
-  self.ClearScreen=true
-  return self
-end
-
 
 
 --- Sends a MESSAGE to a Client Group. Note that the Group needs to be defined within the ME with the skillset "Client" or "Player".
 -- @param #MESSAGE self
 -- @param Wrapper.Client#CLIENT Client is the Group of the Client.
--- @param Core.Settings#SETTINGS Settings Settings used to display the message.
 -- @return #MESSAGE
 -- @usage
 -- -- Send the 2 messages created with the @{New} method to the Client Group.
@@ -197,13 +167,13 @@ function MESSAGE:ToClient( Client, Settings )
     if self.MessageType then
       local Settings = Settings or ( Client and _DATABASE:GetPlayerSettings( Client:GetPlayerName() ) ) or _SETTINGS -- Core.Settings#SETTINGS
       self.MessageDuration = Settings:GetMessageTime( self.MessageType )
-      self.MessageCategory = "" -- self.MessageType .. ": "
+      self.MessageCategory = self.MessageType .. ": "
     end
 
     if self.MessageDuration ~= 0 then
   		local ClientGroupID = Client:GetClientGroupID()
   		self:T( self.MessageCategory .. self.MessageText:gsub("\n$",""):gsub("\n$","") .. " / " .. self.MessageDuration )
-  		trigger.action.outTextForGroup( ClientGroupID, self.MessageCategory .. self.MessageText:gsub("\n$",""):gsub("\n$",""), self.MessageDuration , self.ClearScreen)
+  		trigger.action.outTextForGroup( ClientGroupID, self.MessageCategory .. self.MessageText:gsub("\n$",""):gsub("\n$",""), self.MessageDuration )
 		end
 	end
 	
@@ -212,8 +182,8 @@ end
 
 --- Sends a MESSAGE to a Group. 
 -- @param #MESSAGE self
--- @param Wrapper.Group#GROUP Group to which the message is displayed.
--- @return #MESSAGE Message object.
+-- @param Wrapper.Group#GROUP Group is the Group.
+-- @return #MESSAGE
 function MESSAGE:ToGroup( Group, Settings )
   self:F( Group.GroupName )
 
@@ -222,12 +192,12 @@ function MESSAGE:ToGroup( Group, Settings )
     if self.MessageType then
       local Settings = Settings or ( Group and _DATABASE:GetPlayerSettings( Group:GetPlayerName() ) ) or _SETTINGS -- Core.Settings#SETTINGS
       self.MessageDuration = Settings:GetMessageTime( self.MessageType )
-      self.MessageCategory = "" -- self.MessageType .. ": "
+      self.MessageCategory = self.MessageType .. ": "
     end
 
     if self.MessageDuration ~= 0 then
       self:T( self.MessageCategory .. self.MessageText:gsub("\n$",""):gsub("\n$","") .. " / " .. self.MessageDuration )
-      trigger.action.outTextForGroup( Group:GetID(), self.MessageCategory .. self.MessageText:gsub("\n$",""):gsub("\n$",""), self.MessageDuration, self.ClearScreen )
+      trigger.action.outTextForGroup( Group:GetID(), self.MessageCategory .. self.MessageText:gsub("\n$",""):gsub("\n$",""), self.MessageDuration )
     end
   end
   
@@ -273,9 +243,8 @@ end
 
 --- Sends a MESSAGE to a Coalition. 
 -- @param #MESSAGE self
--- @param #DCS.coalition.side CoalitionSide @{#DCS.coalition.side} to which the message is displayed.
--- @param Core.Settings#SETTINGS Settings (Optional) Settings for message display.
--- @return #MESSAGE Message object.
+-- @param CoalitionSide needs to be filled out by the defined structure of the standard scripting engine @{coalition.side}. 
+-- @return #MESSAGE
 -- @usage
 -- -- Send a message created with the @{New} method to the RED coalition.
 -- MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToCoalition( coalition.side.RED )
@@ -290,13 +259,13 @@ function MESSAGE:ToCoalition( CoalitionSide, Settings )
   if self.MessageType then
     local Settings = Settings or _SETTINGS -- Core.Settings#SETTINGS
     self.MessageDuration = Settings:GetMessageTime( self.MessageType )
-    self.MessageCategory = "" -- self.MessageType .. ": "
+    self.MessageCategory = self.MessageType .. ": "
   end
 
 	if CoalitionSide then
     if self.MessageDuration ~= 0 then
   		self:T( self.MessageCategory .. self.MessageText:gsub("\n$",""):gsub("\n$","") .. " / " .. self.MessageDuration )
-  		trigger.action.outTextForCoalition( CoalitionSide, self.MessageText:gsub("\n$",""):gsub("\n$",""), self.MessageDuration, self.ClearScreen )
+  		trigger.action.outTextForCoalition( CoalitionSide, self.MessageCategory .. self.MessageText:gsub("\n$",""):gsub("\n$",""), self.MessageDuration )
     end
 	end
 	
@@ -305,9 +274,8 @@ end
 
 --- Sends a MESSAGE to a Coalition if the given Condition is true. 
 -- @param #MESSAGE self
--- @param CoalitionSide needs to be filled out by the defined structure of the standard scripting engine @{coalition.side}.
--- @param #boolean Condition Sends the message only if the condition is true. 
--- @return #MESSAGE self
+-- @param CoalitionSide needs to be filled out by the defined structure of the standard scripting engine @{coalition.side}. 
+-- @return #MESSAGE
 function MESSAGE:ToCoalitionIf( CoalitionSide, Condition )
   self:F( CoalitionSide )
 
@@ -320,7 +288,6 @@ end
 
 --- Sends a MESSAGE to all players. 
 -- @param #MESSAGE self
--- @param Core.Settings#Settings Settings (Optional) Settings for message display.
 -- @return #MESSAGE
 -- @usage
 -- -- Send a message created to all players.
@@ -330,18 +297,18 @@ end
 -- or
 -- MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", "End of Mission", 25, "Win" )
 -- MessageAll:ToAll()
-function MESSAGE:ToAll(Settings)
+function MESSAGE:ToAll()
   self:F()
 
   if self.MessageType then
     local Settings = Settings or _SETTINGS -- Core.Settings#SETTINGS
     self.MessageDuration = Settings:GetMessageTime( self.MessageType )
-    self.MessageCategory = "" -- self.MessageType .. ": "
+    self.MessageCategory = self.MessageType .. ": "
   end
 
   if self.MessageDuration ~= 0 then
     self:T( self.MessageCategory .. self.MessageText:gsub("\n$",""):gsub("\n$","") .. " / " .. self.MessageDuration )
-    trigger.action.outText( self.MessageCategory .. self.MessageText:gsub("\n$",""):gsub("\n$",""), self.MessageDuration, self.ClearScreen )
+    trigger.action.outText( self.MessageCategory .. self.MessageText:gsub("\n$",""):gsub("\n$",""), self.MessageDuration )
   end
 
   return self

Moose Development/Moose/Core/Radio.lua

@@ -1,11 +1,8 @@
---- **Core** - Is responsible for everything that is related to radio transmission and you can hear in DCS, be it TACAN beacons, Radio transmissions.
+--- **Core** -- The RADIO Module is responsible for everything that is related to radio transmission and you can hear in DCS, be it TACAN beacons, Radio transmissions...
+-- 
+-- ![Banner Image](..\Presentations\RADIO\Dia1.JPG)
 -- 
 -- ===
--- 
--- ## Features:
--- 
---   * Provide radio functionality to broadcast radio transmissions.
---   * Provide beacon functionality to assist pilots.
 --
 -- The Radio contains 2 classes : RADIO and BEACON
 --  
@@ -21,10 +18,10 @@
 --   * They need to be added in .\l10n\DEFAULT\ in you .miz file (wich can be decompressed like a .zip file),
 --   * For simplicty sake, you can **let DCS' Mission Editor add the file** itself, by creating a new Trigger with the action "Sound to Country", and choosing your sound file and a country you don't use in your mission.
 --   
--- Due to weird DCS quirks, **radio communications behave differently** if sent by a @{Wrapper.Unit#UNIT} or a @{Wrapper.Group#GROUP} or by any other @{Wrapper.Positionable#POSITIONABLE}
+-- Due to weird DCS quirks, **radio communications behave differently** if sent by a @{Unit#UNIT} or a @{Group#GROUP} or by any other @{Positionable#POSITIONABLE}
 -- 
---   * If the transmitter is a @{Wrapper.Unit#UNIT} or a @{Wrapper.Group#GROUP}, DCS will set the power of the transmission  automatically,
---   * If the transmitter is any other @{Wrapper.Positionable#POSITIONABLE}, the transmisison can't be subtitled or looped.
+--   * If the transmitter is a @{Unit#UNIT} or a @{Group#GROUP}, DCS will set the power of the transmission  automatically,
+--   * If the transmitter is any other @{Positionable#POSITIONABLE}, the transmisison can't be subtitled or looped.
 --   
 -- Note that obviously, the **frequency** and the **modulation** of the transmission are important only if the players are piloting an **Advanced System Modelling** enabled aircraft,
 -- like the A10C or the Mirage 2000C. They will **hear the transmission** if they are tuned on the **right frequency and modulation** (and if they are close enough - more on that below).
@@ -35,40 +32,39 @@
 --
 -- ### Author: Hugues "Grey_Echo" Bousquet
 --
--- @module Core.Radio
--- @image Core_Radio.JPG
+-- @module Radio
 
 
---- Models the radio capabilty.
+--- # RADIO class, extends @{Base#BASE}
 -- 
 -- ## RADIO usage
 -- 
 -- There are 3 steps to a successful radio transmission.
 -- 
---   * First, you need to **"add a @{#RADIO} object** to your @{Wrapper.Positionable#POSITIONABLE}. This is done using the @{Wrapper.Positionable#POSITIONABLE.GetRadio}() function,
+--   * First, you need to **"add a @{#RADIO} object** to your @{Positionable#POSITIONABLE}. This is done using the @{Positionable#POSITIONABLE.GetRadio}() function,
 --   * Then, you will **set the relevant parameters** to the transmission (see below),
 --   * When done, you can actually **broadcast the transmission** (i.e. play the sound) with the @{RADIO.Broadcast}() function.
 --   
--- Methods to set relevant parameters for both a @{Wrapper.Unit#UNIT} or a @{Wrapper.Group#GROUP} or any other @{Wrapper.Positionable#POSITIONABLE}
+-- Methods to set relevant parameters for both a @{Unit#UNIT} or a @{Group#GROUP} or any other @{Positionable#POSITIONABLE}
 -- 
 --   * @{#RADIO.SetFileName}() : Sets the file name of your sound file (e.g. "Noise.ogg"),
 --   * @{#RADIO.SetFrequency}() : Sets the frequency of your transmission.
 --   * @{#RADIO.SetModulation}() : Sets the modulation of your transmission.
 --   * @{#RADIO.SetLoop}() : Choose if you want the transmission to be looped. If you need your transmission to be looped, you might need a @{#BEACON} instead...
 -- 
--- Additional Methods to set relevant parameters if the transmiter is a @{Wrapper.Unit#UNIT} or a @{Wrapper.Group#GROUP}
+-- Additional Methods to set relevant parameters if the transmiter is a @{Unit#UNIT} or a @{Group#GROUP}
 -- 
 --   * @{#RADIO.SetSubtitle}() : Set both the subtitle and its duration,
 --   * @{#RADIO.NewUnitTransmission}() : Shortcut to set all the relevant parameters in one method call
 -- 
--- Additional Methods to set relevant parameters if the transmiter is any other @{Wrapper.Positionable#POSITIONABLE}
+-- Additional Methods to set relevant parameters if the transmiter is any other @{Positionable#POSITIONABLE}
 -- 
 --   * @{#RADIO.SetPower}() : Sets the power of the antenna in Watts
 --   * @{#RADIO.NewGenericTransmission}() : Shortcut to set all the relevant parameters in one method call
 -- 
 -- What is this power thing ?
 -- 
---   * If your transmission is sent by a @{Wrapper.Positionable#POSITIONABLE} other than a @{Wrapper.Unit#UNIT} or a @{Wrapper.Group#GROUP}, you can set the power of the antenna,
+--   * If your transmission is sent by a @{Positionable#POSITIONABLE} other than a @{Unit#UNIT} or a @{Group#GROUP}, you can set the power of the antenna,
 --   * Otherwise, DCS sets it automatically, depending on what's available on your Unit,
 --   * If the player gets **too far** from the transmiter, or if the antenna is **too weak**, the transmission will **fade** and **become noisyer**,
 --   * This an automated DCS calculation you have no say on,
@@ -97,7 +93,7 @@ RADIO = {
 }
 
 --- Create a new RADIO Object. This doesn't broadcast a transmission, though, use @{#RADIO.Broadcast} to actually broadcast
--- If you want to create a RADIO, you probably should use @{Wrapper.Positionable#POSITIONABLE.GetRadio}() instead
+-- If you want to create a RADIO, you probably should use @{Positionable#POSITIONABLE.GetRadio}() instead
 -- @param #RADIO self
 -- @param Wrapper.Positionable#POSITIONABLE Positionable The @{Positionable} that will receive radio capabilities.
 -- @return #RADIO Radio
@@ -266,7 +262,7 @@ end
 
 --- Create a new transmission, that is to say, populate the RADIO with relevant data
 -- In this function the data is especially relevant if the broadcaster is a UNIT or a GROUP,
--- but it will work for any @{Wrapper.Positionable#POSITIONABLE}. 
+-- but it will work for any @{Positionable#POSITIONABLE}. 
 -- Only the RADIO and the Filename are mandatory.
 -- @param #RADIO self
 -- @param #string FileName
@@ -280,12 +276,8 @@ function RADIO:NewUnitTransmission(FileName, Subtitle, SubtitleDuration, Frequen
   self:F({FileName, Subtitle, SubtitleDuration, Frequency, Modulation, Loop})
 
   self:SetFileName(FileName)
-  local Duration = 5
-  if SubtitleDuration then Duration = SubtitleDuration end
-  -- SubtitleDuration argument was missing, adding it
-  if Subtitle then self:SetSubtitle(Subtitle, Duration) end
-  -- self:SetSubtitleDuration is non existent, removing faulty line
-  -- if SubtitleDuration then self:SetSubtitleDuration(SubtitleDuration) end
+  if Subtitle then self:SetSubtitle(Subtitle) end
+  if SubtitleDuration then self:SetSubtitleDuration(SubtitleDuration) end
   if Frequency then self:SetFrequency(Frequency) end
   if Modulation then self:SetModulation(Modulation) end
   if Loop then self:SetLoop(Loop) end
@@ -295,7 +287,7 @@ end
 
 --- Actually Broadcast the transmission
 -- * The Radio has to be populated with the new transmission before broadcasting.
--- * Please use RADIO setters or either @{#RADIO.NewGenericTransmission} or @{#RADIO.NewUnitTransmission}
+-- * Please use RADIO setters or either @{Radio#RADIO.NewGenericTransmission} or @{Radio#RADIO.NewUnitTransmission}
 -- * This class is in fact pretty smart, it determines the right DCS function to use depending on the type of POSITIONABLE
 -- * If the POSITIONABLE is not a UNIT or a GROUP, we use the generic (but limited) trigger.action.radioTransmission()
 -- * If the POSITIONABLE is a UNIT or a GROUP, we use the "TransmitMessage" Command
@@ -347,20 +339,22 @@ function RADIO:StopBroadcast()
 end
 
 
---- After attaching a @{#BEACON} to your @{Wrapper.Positionable#POSITIONABLE}, you need to select the right function to activate the kind of beacon you want. 
+--- # BEACON class, extends @{Base#BASE}
+-- 
+-- After attaching a @{#BEACON} to your @{Positionable#POSITIONABLE}, you need to select the right function to activate the kind of beacon you want. 
 -- There are two types of BEACONs available : the AA TACAN Beacon and the general purpose Radio Beacon.
 -- Note that in both case, you can set an optional parameter : the `BeaconDuration`. This can be very usefull to simulate the battery time if your BEACON is
 -- attach to a cargo crate, for exemple. 
 -- 
 -- ## AA TACAN Beacon usage
 -- 
--- This beacon only works with airborne @{Wrapper.Unit#UNIT} or a @{Wrapper.Group#GROUP}. Use @{#BEACON:AATACAN}() to set the beacon parameters and start the beacon.
+-- This beacon only works with airborne @{Unit#UNIT} or a @{Group#GROUP}. Use @{#BEACON:AATACAN}() to set the beacon parameters and start the beacon.
 -- Use @#BEACON:StopAATACAN}() to stop it.
 -- 
 -- ## General Purpose Radio Beacon usage
 -- 
--- This beacon will work with any @{Wrapper.Positionable#POSITIONABLE}, but **it won't follow the @{Wrapper.Positionable#POSITIONABLE}** ! This means that you should only use it with
--- @{Wrapper.Positionable#POSITIONABLE} that don't move, or move very slowly. Use @{#BEACON:RadioBeacon}() to set the beacon parameters and start the beacon.
+-- This beacon will work with any @{Positionable#POSITIONABLE}, but **it won't follow the @{Positionable#POSITIONABLE}** ! This means that you should only use it with
+-- @{Positionable#POSITIONABLE} that don't move, or move very slowly. Use @{#BEACON:RadioBeacon}() to set the beacon parameters and start the beacon.
 -- Use @{#BEACON:StopRadioBeacon}() to stop it.
 -- 
 -- @type BEACON
@@ -370,7 +364,7 @@ BEACON = {
 }
 
 --- Create a new BEACON Object. This doesn't activate the beacon, though, use @{#BEACON.AATACAN} or @{#BEACON.Generic}
--- If you want to create a BEACON, you probably should use @{Wrapper.Positionable#POSITIONABLE.GetBeacon}() instead.
+-- If you want to create a BEACON, you probably should use @{Positionable#POSITIONABLE.GetBeacon}() instead.
 -- @param #BEACON self
 -- @param Wrapper.Positionable#POSITIONABLE Positionable The @{Positionable} that will receive radio capabilities.
 -- @return #BEACON Beacon

Moose Development/Moose/Core/Report.lua

@@ -1,26 +1,6 @@
---- **Core** - Provides a handy means to create messages and reports.
---
--- ===
--- 
--- ## Features:
--- 
---   * Create text blocks that are formatted.
---   * Create automatic indents.
---   * Variate the delimiters between reporting lines.
--- 
--- ===
---
--- ### Authors: FlightControl : Design & Programming
---
--- @module Core.Report
--- @image Core_Report.JPG
-
-
---- @type REPORT
+--- The REPORT class
+-- @type REPORT
 -- @extends Core.Base#BASE
-
---- Provides a handy means to create messages and reports.
--- @field #REPORT
 REPORT = {
   ClassName = "REPORT",
   Title = "",
@@ -74,8 +54,8 @@ end
 -- @param #REPORT self
 -- @param #string Text
 -- @return #REPORT
-function REPORT:AddIndent( Text, Separator ) --R2.1
-  self.Report[#self.Report+1] = ( ( Separator and Separator .. string.rep( " ", self.Indent - 1 ) ) or string.rep(" ", self.Indent ) ) .. Text:gsub("\n","\n"..string.rep( " ", self.Indent ) )
+function REPORT:AddIndent( Text ) --R2.1
+  self.Report[#self.Report+1] = string.rep(" ", self.Indent ) .. Text:gsub("\n","\n"..string.rep( " ", self.Indent ) )
   return self
 end
 

Moose Development/Moose/Core/ScheduleDispatcher.lua

@@ -22,7 +22,7 @@
 -- 
 -- The SCHEDULEDISPATCHER allows multiple scheduled functions to be planned and executed for one SCHEDULER object.
 -- The SCHEDULER object therefore keeps a table of "CallID's", which are returned after each planning of a new scheduled function by the SCHEDULEDISPATCHER.
--- The SCHEDULER object plans new scheduled functions through the @{Core.Scheduler#SCHEDULER.Schedule}() method. 
+-- The SCHEDULER object plans new scheduled functions through the @{Scheduler#SCHEDULER.Schedule}() method. 
 -- The Schedule() method returns the CallID that is the reference ID for each planned schedule.
 -- 
 -- ===
@@ -30,8 +30,7 @@
 -- ### Contributions: -
 -- ### Authors: FlightControl : Design & Programming
 -- 
--- @module Core.ScheduleDispatcher
--- @image Core_Schedule_Dispatcher.JPG
+-- @module ScheduleDispatcher
 
 --- The SCHEDULEDISPATCHER structure
 -- @type SCHEDULEDISPATCHER
@@ -88,12 +87,12 @@ function SCHEDULEDISPATCHER:AddSchedule( Scheduler, ScheduleFunction, ScheduleAr
   self:T3( self.Schedule[Scheduler][CallID] )
 
   self.Schedule[Scheduler][CallID].CallHandler = function( CallID )
-    --self:E( CallID )
+    self:F2( CallID )
 
     local ErrorHandler = function( errmsg )
       env.info( "Error in timer function: " .. errmsg )
-      if BASE.Debug ~= nil then
-        env.info( BASE.Debug.traceback() )
+      if debug ~= nil then
+        env.info( debug.traceback() )
       end
       return errmsg
     end
@@ -112,7 +111,7 @@ function SCHEDULEDISPATCHER:AddSchedule( Scheduler, ScheduleFunction, ScheduleAr
       
       --self:T3( { Schedule = Schedule } )
 
-      local SchedulerObject = Scheduler.SchedulerObject
+      local ScheduleObject = Scheduler.SchedulerObject
       --local ScheduleObjectName = Scheduler.SchedulerObject:GetNameAndClassID()
       local ScheduleFunction = Schedule.Function
       local ScheduleArguments = Schedule.Arguments
@@ -123,10 +122,9 @@ function SCHEDULEDISPATCHER:AddSchedule( Scheduler, ScheduleFunction, ScheduleAr
       local ScheduleID = Schedule.ScheduleID
       
       local Status, Result
-      --self:E( { SchedulerObject = SchedulerObject } )
-      if SchedulerObject then
+      if ScheduleObject then
         local function Timer()
-          return ScheduleFunction( SchedulerObject, unpack( ScheduleArguments ) ) 
+          return ScheduleFunction( ScheduleObject, unpack( ScheduleArguments ) ) 
         end
         Status, Result = xpcall( Timer, ErrorHandler )
       else

Moose Development/Moose/Core/Scheduler.lua

@@ -1,14 +1,15 @@
---- **Core** - Prepares and handles the execution of functions over scheduled time (intervals).
+--- **Core** -- SCHEDULER prepares and handles the **execution of functions over scheduled time (intervals)**.
 --
+-- ![Banner Image](..\Presentations\SCHEDULER\Dia1.JPG)
+-- 
 -- ===
 -- 
--- ## Features:
+-- SCHEDULER manages the **scheduling of functions**:
 -- 
---   * Schedule functions over time,
---   * optionally in an optional specified time interval, 
---   * optionally **repeating** with a specified time repeat interval, 
---   * optionally **randomizing** with a specified time interval randomization factor, 
---   * optionally **stop** the repeating after a specified time interval. 
+--    * optionally in an optional specified time interval, 
+--    * optionally **repeating** with a specified time repeat interval, 
+--    * optionally **randomizing** with a specified time interval randomization factor, 
+--    * optionally **stop** the repeating after a specified time interval. 
 --
 -- ===
 -- 
@@ -20,13 +21,13 @@
 --
 -- ### [ALL Demo Missions pack of the last release](https://github.com/FlightControl-Master/MOOSE_MISSIONS/releases)
 -- 
--- ===
+-- ====
 -- 
 -- # YouTube Channel
 -- 
 -- ### [SCHEDULER YouTube Channel (none)]()
 -- 
--- ===
+-- ====
 --
 -- ### Contributions: 
 -- 
@@ -38,8 +39,8 @@
 -- 
 -- ===
 --
--- @module Core.Scheduler
--- @image Core_Scheduler.JPG
+-- @module Scheduler
+
 
 --- The SCHEDULER class
 -- @type SCHEDULER
@@ -47,7 +48,9 @@
 -- @extends Core.Base#BASE
 
 
---- Creates and handles schedules over time, which allow to execute code at specific time intervals with randomization.
+--- # SCHEDULER class, extends @{Base#BASE}
+-- 
+-- The SCHEDULER class creates schedule.
 -- 
 -- A SCHEDULER can manage **multiple** (repeating) schedules. Each planned or executing schedule has a unique **ScheduleID**.
 -- The ScheduleID is returned when the method @{#SCHEDULER.Schedule}() is called.

Moose Development/Moose/Core/Settings.lua

@@ -1,205 +1,46 @@
---- **Core** - Manages various settings for running missions, consumed by moose classes and provides a menu system for players to tweak settings in running missions.
+--- **Core** -- **SETTINGS** classe defines the format settings management for measurement.
+--
+-- ![Banner Image](..\Presentations\SETTINGS\Dia1.JPG)
+--
+-- ====
+--
+-- # Demo Missions
+--
+-- ### [SETTINGS Demo Missions source code]()
+--
+-- ### [SETTINGS Demo Missions, only for beta testers]()
+--
+-- ### [ALL Demo Missions pack of the last release](https://github.com/FlightControl-Master/MOOSE_MISSIONS/releases)
+--
+-- ====
+--
+-- # YouTube Channel
+--
+-- ### [SETTINGS YouTube Channel]()
 --
 -- ===
 -- 
--- ## Features:
--- 
---   * Provide a settings menu system to the players.
---   * Provide a player settings menu and an overall mission settings menu.
---   * Mission settings provide default settings, while player settings override mission settings.
---   * Provide a menu to select between different coordinate formats for A2G coordinates.
---   * Provide a menu to select between different coordinate formats for A2A coordinates.
---   * Provide a menu to select between different message time duration options.
---   * Provide a menu to select between different metric systems.
--- 
--- ===
--- 
--- The documentation of the SETTINGS class can be found further in this document.
--- 
--- ===
--- 
--- # **AUTHORS and CONTRIBUTIONS**
--- 
+-- ### Author: **Sven Van de Velde (FlightControl)**
 -- ### Contributions: 
 -- 
--- ### Authors: 
--- 
---   * **FlightControl**: Design & Programming
+-- ====
 --
--- @module Core.Settings
--- @image Core_Settings.JPG
+-- @module Settings
 
 
 --- @type SETTINGS
+-- @field #number LL_Accuracy
+-- @field #boolean LL_DMS
+-- @field #number MGRS_Accuracy
+-- @field #string A2GSystem
+-- @field #string A2ASystem
 -- @extends Core.Base#BASE
 
---- Takes care of various settings that influence the behaviour of certain functionalities and classes within the MOOSE framework.
--- 
--- ===
--- 
--- The SETTINGS class takes care of various settings that influence the behaviour of certain functionalities and classes within the MOOSE framework.
--- SETTINGS can work on 2 levels:
--- 
---   - **Default settings**: A running mission has **Default settings**. 
---   - **Player settings**: For each player its own **Player settings** can be defined, overriding the **Default settings**.
--- 
--- So, when there isn't any **Player setting** defined for a player for a specific setting, or, the player cannot be identified, the **Default setting** will be used instead.
--- 
--- # 1) \_SETTINGS object
--- 
--- MOOSE defines by default a singleton object called **\_SETTINGS**. Use this object to modify all the **Default settings** for a running mission.
--- For each player, MOOSE will automatically allocate also a **player settings** object, and will expose a radio menu to allow the player to adapt the settings to his own preferences.
--- 
--- # 2) SETTINGS Menu
--- 
--- Settings can be adapted by the Players and by the Mission Administrator through **radio menus, which are automatically available in the mission**.
--- These menus can be found **on level F10 under "Settings"**. There are two kinds of menus generated by the system.
--- 
--- ## 2.1) Default settings menu
--- 
--- A menu is created automatically per Command Center that allows to modify the **Default** settings.
--- So, when joining a CC unit, a menu will be available that allows to change the settings parameters **FOR ALL THE PLAYERS**!
--- Note that the **Default settings** will only be used when a player has not choosen its own settings.
--- 
--- ## 2.2) Player settings menu
--- 
--- A menu is created automatically per Player Slot (group) that allows to modify the **Player** settings.
--- So, when joining a slot, a menu wil be available that allows to change the settings parameters **FOR THE PLAYER ONLY**!
--- Note that when a player has not chosen a specific setting, the **Default settings** will be used.
--- 
--- ## 2.3) Show or Hide the Player Setting menus
--- 
--- Of course, it may be requried not to show any setting menus. In this case, a method is available on the **\_SETTINGS object**.
--- Use @{#SETTINGS.SetPlayerMenuOff}() to hide the player menus, and use @{#SETTINGS.SetPlayerMenuOn}() show the player menus.
--- Note that when this method is used, any player already in a slot will not have its menus visibility changed.
--- The option will only have effect when a player enters a new slot or changes a slot. 
--- 
--- Example:
--- 
---      _SETTINGS:SetPlayerMenuOff() -- will disable the player menus.
---      _SETTINGS:SetPlayerMenuOn() -- will enable the player menus.
---      -- But only when a player exits and reenters the slot these settings will have effect!
--- 
--- 
--- # 3) Settings
--- 
--- There are different settings that are managed and applied within the MOOSE framework.
--- See below a comprehensive description of each.
--- 
--- ## 3.1) **A2G coordinates** display formatting
--- 
--- ### 3.1.1) A2G coordinates setting **types**
--- 
--- Will customize which display format is used to indicate A2G coordinates in text as part of the Command Center communications.
--- 
---   - A2G BR: [Bearing Range](https://en.wikipedia.org/wiki/Bearing_(navigation)).
---   - A2G MGRS: The [Military Grid Reference System](https://en.wikipedia.org/wiki/Military_Grid_Reference_System). The accuracy can also be adapted.
---   - A2G LL DMS: Lattitude Longitude [Degrees Minutes Seconds](https://en.wikipedia.org/wiki/Geographic_coordinate_conversion). The accuracy can also be adapted.
---   - A2G LL DDM: Lattitude Longitude [Decimal Degrees Minutes](https://en.wikipedia.org/wiki/Decimal_degrees). The accuracy can also be adapted.
--- 
--- ### 3.1.2) A2G coordinates setting **menu**
--- 
--- The settings can be changed by using the **Default settings menu** on the Command Center or the **Player settings menu** on the Player Slot.
--- 
--- ### 3.1.3) A2G coordinates setting **methods**
---   
--- There are different methods that can be used to change the **System settings** using the \_SETTINGS object.
--- 
---   - @{#SETTINGS.SetA2G_BR}(): Enable the BR display formatting by default.
---   - @{#SETTINGS.SetA2G_MGRS}(): Enable the MGRS display formatting by default. Use @{SETTINGS.SetMGRS_Accuracy}() to adapt the accuracy of the MGRS formatting.
---   - @{#SETTINGS.SetA2G_LL_DMS}(): Enable the LL DMS display formatting by default. Use @{SETTINGS.SetLL_Accuracy}() to adapt the accuracy of the Seconds formatting. 
---   - @{#SETTINGS.SetA2G_LL_DDM}(): Enable the LL DDM display formatting by default. Use @{SETTINGS.SetLL_Accuracy}() to adapt the accuracy of the Seconds formatting.
--- 
--- ### 3.1.4) A2G coordinates setting - additional notes
--- 
--- One additional note on BR. In a situation when a BR coordinate should be given, 
--- but there isn't any player context (no player unit to reference from), the MGRS formatting will be applied!
--- 
--- ## 3.2) **A2A coordinates** formatting
---   
--- ### 3.2.1) A2A coordinates setting **types**
--- 
--- Will customize which display format is used to indicate A2A coordinates in text as part of the Command Center communications.
--- 
---   - A2A BRAA: [Bearing Range Altitude Aspect](https://en.wikipedia.org/wiki/Bearing_(navigation)).
---   - A2A MGRS: The [Military Grid Reference System](https://en.wikipedia.org/wiki/Military_Grid_Reference_System). The accuracy can also be adapted.
---   - A2A LL DMS: Lattitude Longitude [Degrees Minutes Seconds](https://en.wikipedia.org/wiki/Geographic_coordinate_conversion). The accuracy can also be adapted.
---   - A2A LL DDM: Lattitude Longitude [Decimal Degrees and Minutes](https://en.wikipedia.org/wiki/Decimal_degrees). The accuracy can also be adapted.
---   - A2A BULLS: [Bullseye](http://falcon4.wikidot.com/concepts:bullseye).
---   
--- ### 3.2.2) A2A coordinates setting **menu**
--- 
--- The settings can be changed by using the **Default settings menu** on the Command Center or the **Player settings menu** on the Player Slot.
--- 
--- ### 3.2.3) A2A coordinates setting **methods**
---   
--- There are different methods that can be used to change the **System settings** using the \_SETTINGS object.
--- 
---   - @{#SETTINGS.SetA2A_BRAA}(): Enable the BR display formatting by default.
---   - @{#SETTINGS.SetA2A_MGRS}(): Enable the MGRS display formatting by default. Use @{SETTINGS.SetMGRS_Accuracy}() to adapt the accuracy of the MGRS formatting.
---   - @{#SETTINGS.SetA2A_LL_DMS}(): Enable the LL DMS display formatting by default. Use @{SETTINGS.SetLL_Accuracy}() to adapt the accuracy of the Seconds formatting. 
---   - @{#SETTINGS.SetA2A_LL_DDM}(): Enable the LL DDM display formatting by default. Use @{SETTINGS.SetLL_Accuracy}() to adapt the accuracy of the Seconds formatting.
---   - @{#SETTINGS.SetA2A_BULLS}(): Enable the BULLSeye display formatting by default.
--- 
--- ### 3.2.4) A2A coordinates settings - additional notes
--- 
--- One additional note on BRAA. In a situation when a BRAA coordinate should be given, 
--- but there isn't any player context (no player unit to reference from), the MGRS formatting will be applied!
--- 
--- ## 3.3) **Measurements** formatting
--- 
--- ### 3.3.1) Measurements setting **types**
--- 
--- Will customize the measurements system being used as part as part of the Command Center communications.
--- 
---   - **Metrics** system: Applies the [Metrics system](https://en.wikipedia.org/wiki/Metric_system) ...
---   - **Imperial** system: Applies the [Imperial system](https://en.wikipedia.org/wiki/Imperial_units) ...  
--- 
--- ### 3.3.2) Measurements setting **menu**
--- 
--- The settings can be changed by using the **Default settings menu** on the Command Center or the **Player settings menu** on the Player Slot.
--- 
--- ### 3.3.3) Measurements setting **methods**
---   
--- There are different methods that can be used to change the **Default settings** using the \_SETTINGS object.
--- 
---   - @{#SETTINGS.SetMetric}(): Enable the Metric system.
---   - @{#SETTINGS.SetImperial}(): Enable the Imperial system.
---   
--- ## 3.4) **Message** display times
--- 
--- ### 3.4.1) Message setting **types**
--- 
--- There are various **Message Types** that will influence the duration how long a message will appear as part of the Command Center communications.
--- 
---   - **Update** message: A short update message.
---   - **Information** message: Provides new information **while** executing a mission.
---   - **Briefing** message: Provides a complete briefing **before** executing a mission.
---   - **Overview report**: Provides a short report overview, the summary of the report.
---   - **Detailed report**: Provides a complete report.
---   
--- ### 3.4.2) Message setting **menu**
--- 
--- The settings can be changed by using the **Default settings menu** on the Command Center or the **Player settings menu** on the Player Slot.
--- 
--- Each Message Type has specific timings that will be applied when the message is displayed.
--- The Settings Menu will provide for each Message Type a selection of proposed durations from which can be choosen.
--- So the player can choose its own amount of seconds how long a message should be displayed of a certain type.
--- Note that **Update** messages can be chosen not to be displayed at all!
--- 
--- ### 3.4.3) Message setting **methods**
---   
--- There are different methods that can be used to change the **System settings** using the \_SETTINGS object.
--- 
---   - @{#SETTINGS.SetMessageTime}(): Define for a specific @{Message.MESSAGE.MessageType} the duration to be displayed in seconds. 
---   - @{#SETTINGS.GetMessageTime}(): Retrieves for a specific @{Message.MESSAGE.MessageType} the duration to be displayed in seconds. 
---   
--- ===
--- 
+--- # SETTINGS class, extends @{Base#BASE}
+--
 -- @field #SETTINGS
 SETTINGS = {
   ClassName = "SETTINGS",
-  ShowPlayerMenu = true,
 }
 
 
@@ -376,6 +217,7 @@ do -- SETTINGS
   -- @param #SETTINGS self
   -- @return #boolean true if BRA
   function SETTINGS:IsA2A_BRAA()
+    self:E( { BRA = ( self.A2ASystem and self.A2ASystem == "BRAA" ) or ( not self.A2ASystem and _SETTINGS:IsA2A_BRAA() ) } )
     return ( self.A2ASystem and self.A2ASystem == "BRAA" ) or ( not self.A2ASystem and _SETTINGS:IsA2A_BRAA() )
   end
 
@@ -569,179 +411,152 @@ do -- SETTINGS
     return self
   end
 
-  --- Sets the player menus on, so that the **Player setting menus** show up for the players.
-  -- But only when a player exits and reenters the slot these settings will have effect!
-  -- It is advised to use this method at the start of the mission.
-  -- @param #SETTINGS self
-  -- @return #SETTINGS
-  -- @usage
-  --   _SETTINGS:SetPlayerMenuOn() -- will enable the player menus.
-  function SETTINGS:SetPlayerMenuOn()
-    self.ShowPlayerMenu = true
-  end
-
-  --- Sets the player menus off, so that the **Player setting menus** won't show up for the players.
-  -- But only when a player exits and reenters the slot these settings will have effect!
-  -- It is advised to use this method at the start of the mission.
-  -- @param #SETTINGS self
-  -- @return #SETTINGS self
-  -- @usage
-  --   _SETTINGS:SetPlayerMenuOff() -- will disable the player menus.
-  function SETTINGS:SetPlayerMenuOff()
-    self.ShowPlayerMenu = false
-  end
-
-
-
-  --- Updates the menu of the player seated in the PlayerUnit.
-  -- @param #SETTINGS self
+  --- @param #SETTINGS self
+  -- @param RootMenu
   -- @param Wrapper.Client#CLIENT PlayerUnit
-  -- @return #SETTINGS self
+  -- @param #string MenuText
+  -- @return #SETTINGS
   function SETTINGS:SetPlayerMenu( PlayerUnit )
 
-    if _SETTINGS.ShowPlayerMenu == true then
+    local PlayerGroup = PlayerUnit:GetGroup()
+    local PlayerName = PlayerUnit:GetPlayerName()
+    local PlayerNames = PlayerGroup:GetPlayerNames()
+
+    local PlayerMenu = MENU_GROUP:New( PlayerGroup, 'Settings "' .. PlayerName .. '"' )
     
-      local PlayerGroup = PlayerUnit:GetGroup()
-      local PlayerName = PlayerUnit:GetPlayerName()
-      local PlayerNames = PlayerGroup:GetPlayerNames()
+    self.PlayerMenu = PlayerMenu
+
+    local A2GCoordinateMenu = MENU_GROUP:New( PlayerGroup, "A2G Coordinate System", PlayerMenu )
   
-      local PlayerMenu = MENU_GROUP:New( PlayerGroup, 'Settings "' .. PlayerName .. '"' )
-      
-      self.PlayerMenu = PlayerMenu
+    if not self:IsA2G_LL_DMS() then
+      MENU_GROUP_COMMAND:New( PlayerGroup, "Lat/Lon Degree Min Sec (LL DMS)", A2GCoordinateMenu, self.MenuGroupA2GSystem, self, PlayerUnit, PlayerGroup, PlayerName, "LL DMS" )
+    end
   
-      local A2GCoordinateMenu = MENU_GROUP:New( PlayerGroup, "A2G Coordinate System", PlayerMenu )
+    if not self:IsA2G_LL_DDM() then
+      MENU_GROUP_COMMAND:New( PlayerGroup, "Lat/Lon Degree Dec Min (LL DDM)", A2GCoordinateMenu, self.MenuGroupA2GSystem, self, PlayerUnit, PlayerGroup, PlayerName, "LL DDM" )
+    end
+  
+    if self:IsA2G_LL_DDM() then
+      MENU_GROUP_COMMAND:New( PlayerGroup, "LL DDM Accuracy 1", A2GCoordinateMenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 1 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "LL DDM Accuracy 2", A2GCoordinateMenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 2 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "LL DDM Accuracy 3", A2GCoordinateMenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 3 )
+    end
     
-      if not self:IsA2G_LL_DMS() then
-        MENU_GROUP_COMMAND:New( PlayerGroup, "Lat/Lon Degree Min Sec (LL DMS)", A2GCoordinateMenu, self.MenuGroupA2GSystem, self, PlayerUnit, PlayerGroup, PlayerName, "LL DMS" )
-      end
+    if not self:IsA2G_BR() then
+      MENU_GROUP_COMMAND:New( PlayerGroup, "Bearing, Range (BR)", A2GCoordinateMenu, self.MenuGroupA2GSystem, self, PlayerUnit, PlayerGroup, PlayerName, "BR" )
+    end
     
-      if not self:IsA2G_LL_DDM() then
-        MENU_GROUP_COMMAND:New( PlayerGroup, "Lat/Lon Degree Dec Min (LL DDM)", A2GCoordinateMenu, self.MenuGroupA2GSystem, self, PlayerUnit, PlayerGroup, PlayerName, "LL DDM" )
-      end
+    if not self:IsA2G_MGRS() then
+      MENU_GROUP_COMMAND:New( PlayerGroup, "Military Grid (MGRS)", A2GCoordinateMenu, self.MenuGroupA2GSystem, self, PlayerUnit, PlayerGroup, PlayerName, "MGRS" )
+    end    
+
+    if self:IsA2G_MGRS() then
+      MENU_GROUP_COMMAND:New( PlayerGroup, "MGRS Accuracy 1", A2GCoordinateMenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 1 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "MGRS Accuracy 2", A2GCoordinateMenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 2 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "MGRS Accuracy 3", A2GCoordinateMenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 3 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "MGRS Accuracy 4", A2GCoordinateMenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 4 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "MGRS Accuracy 5", A2GCoordinateMenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 5 )
+    end
+
+    local A2ACoordinateMenu = MENU_GROUP:New( PlayerGroup, "A2A Coordinate System", PlayerMenu )
+
+
+    if not self:IsA2A_LL_DMS() then
+      MENU_GROUP_COMMAND:New( PlayerGroup, "Lat/Lon Degree Min Sec (LL DMS)", A2GCoordinateMenu, self.MenuGroupA2GSystem, self, PlayerUnit, PlayerGroup, PlayerName, "LL DMS" )
+    end
+  
+    if not self:IsA2A_LL_DDM() then
+      MENU_GROUP_COMMAND:New( PlayerGroup, "Lat/Lon Degree Dec Min (LL DDM)", A2GCoordinateMenu, self.MenuGroupA2GSystem, self, PlayerUnit, PlayerGroup, PlayerName, "LL DDM" )
+    end
+  
+    if self:IsA2A_LL_DDM() then
+      MENU_GROUP_COMMAND:New( PlayerGroup, "LL DDM Accuracy 1", A2GCoordinateMenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 1 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "LL DDM Accuracy 2", A2GCoordinateMenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 2 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "LL DDM Accuracy 3", A2GCoordinateMenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 3 )
+    end
+
+    if not self:IsA2A_BULLS() then
+      MENU_GROUP_COMMAND:New( PlayerGroup, "Bullseye (BULLS)", A2ACoordinateMenu, self.MenuGroupA2ASystem, self, PlayerUnit, PlayerGroup, PlayerName, "BULLS" )
+    end
     
-      if self:IsA2G_LL_DDM() then
-        MENU_GROUP_COMMAND:New( PlayerGroup, "LL DDM Accuracy 1", A2GCoordinateMenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 1 )
-        MENU_GROUP_COMMAND:New( PlayerGroup, "LL DDM Accuracy 2", A2GCoordinateMenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 2 )
-        MENU_GROUP_COMMAND:New( PlayerGroup, "LL DDM Accuracy 3", A2GCoordinateMenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 3 )
-      end
-      
-      if not self:IsA2G_BR() then
-        MENU_GROUP_COMMAND:New( PlayerGroup, "Bearing, Range (BR)", A2GCoordinateMenu, self.MenuGroupA2GSystem, self, PlayerUnit, PlayerGroup, PlayerName, "BR" )
-      end
-      
-      if not self:IsA2G_MGRS() then
-        MENU_GROUP_COMMAND:New( PlayerGroup, "Military Grid (MGRS)", A2GCoordinateMenu, self.MenuGroupA2GSystem, self, PlayerUnit, PlayerGroup, PlayerName, "MGRS" )
-      end    
-  
-      if self:IsA2G_MGRS() then
-        MENU_GROUP_COMMAND:New( PlayerGroup, "MGRS Accuracy 1", A2GCoordinateMenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 1 )
-        MENU_GROUP_COMMAND:New( PlayerGroup, "MGRS Accuracy 2", A2GCoordinateMenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 2 )
-        MENU_GROUP_COMMAND:New( PlayerGroup, "MGRS Accuracy 3", A2GCoordinateMenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 3 )
-        MENU_GROUP_COMMAND:New( PlayerGroup, "MGRS Accuracy 4", A2GCoordinateMenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 4 )
-        MENU_GROUP_COMMAND:New( PlayerGroup, "MGRS Accuracy 5", A2GCoordinateMenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 5 )
-      end
-  
-      local A2ACoordinateMenu = MENU_GROUP:New( PlayerGroup, "A2A Coordinate System", PlayerMenu )
-  
-  
-      if not self:IsA2A_LL_DMS() then
-        MENU_GROUP_COMMAND:New( PlayerGroup, "Lat/Lon Degree Min Sec (LL DMS)", A2GCoordinateMenu, self.MenuGroupA2GSystem, self, PlayerUnit, PlayerGroup, PlayerName, "LL DMS" )
-      end
+    if not self:IsA2A_BRAA() then
+      MENU_GROUP_COMMAND:New( PlayerGroup, "Bearing Range Altitude Aspect (BRAA)", A2ACoordinateMenu, self.MenuGroupA2ASystem, self, PlayerUnit, PlayerGroup, PlayerName, "BRAA" )
+    end
     
-      if not self:IsA2A_LL_DDM() then
-        MENU_GROUP_COMMAND:New( PlayerGroup, "Lat/Lon Degree Dec Min (LL DDM)", A2GCoordinateMenu, self.MenuGroupA2GSystem, self, PlayerUnit, PlayerGroup, PlayerName, "LL DDM" )
-      end
+    if not self:IsA2A_MGRS() then
+      MENU_GROUP_COMMAND:New( PlayerGroup, "Military Grid (MGRS)", A2ACoordinateMenu, self.MenuGroupA2ASystem, self, PlayerUnit, PlayerGroup, PlayerName, "MGRS" )
+    end
     
-      if self:IsA2A_LL_DDM() then
-        MENU_GROUP_COMMAND:New( PlayerGroup, "LL DDM Accuracy 1", A2GCoordinateMenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 1 )
-        MENU_GROUP_COMMAND:New( PlayerGroup, "LL DDM Accuracy 2", A2GCoordinateMenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 2 )
-        MENU_GROUP_COMMAND:New( PlayerGroup, "LL DDM Accuracy 3", A2GCoordinateMenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 3 )
-      end
-  
-      if not self:IsA2A_BULLS() then
-        MENU_GROUP_COMMAND:New( PlayerGroup, "Bullseye (BULLS)", A2ACoordinateMenu, self.MenuGroupA2ASystem, self, PlayerUnit, PlayerGroup, PlayerName, "BULLS" )
-      end
-      
-      if not self:IsA2A_BRAA() then
-        MENU_GROUP_COMMAND:New( PlayerGroup, "Bearing Range Altitude Aspect (BRAA)", A2ACoordinateMenu, self.MenuGroupA2ASystem, self, PlayerUnit, PlayerGroup, PlayerName, "BRAA" )
-      end
-      
-      if not self:IsA2A_MGRS() then
-        MENU_GROUP_COMMAND:New( PlayerGroup, "Military Grid (MGRS)", A2ACoordinateMenu, self.MenuGroupA2ASystem, self, PlayerUnit, PlayerGroup, PlayerName, "MGRS" )
-      end
-      
-      if self:IsA2A_MGRS() then
-        MENU_GROUP_COMMAND:New( PlayerGroup, "Military Grid (MGRS) Accuracy 1", A2ACoordinateMenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 1 )
-        MENU_GROUP_COMMAND:New( PlayerGroup, "Military Grid (MGRS) Accuracy 2", A2ACoordinateMenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 2 )
-        MENU_GROUP_COMMAND:New( PlayerGroup, "Military Grid (MGRS) Accuracy 3", A2ACoordinateMenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 3 )
-        MENU_GROUP_COMMAND:New( PlayerGroup, "Military Grid (MGRS) Accuracy 4", A2ACoordinateMenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 4 )
-        MENU_GROUP_COMMAND:New( PlayerGroup, "Military Grid (MGRS) Accuracy 5", A2ACoordinateMenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 5 )
-      end    
-  
-      local MetricsMenu = MENU_GROUP:New( PlayerGroup, "Measures and Weights System", PlayerMenu )
-      
-      if self:IsMetric() then
-        MENU_GROUP_COMMAND:New( PlayerGroup, "Imperial (Miles,Feet)", MetricsMenu, self.MenuGroupMWSystem, self, PlayerUnit, PlayerGroup, PlayerName, false )
-      end
-      
-      if self:IsImperial() then
-        MENU_GROUP_COMMAND:New( PlayerGroup, "Metric (Kilometers,Meters)", MetricsMenu, self.MenuGroupMWSystem, self, PlayerUnit, PlayerGroup, PlayerName, true )
-      end    
-  
-  
-      local MessagesMenu = MENU_GROUP:New( PlayerGroup, "Messages and Reports", PlayerMenu )
-  
-      local UpdateMessagesMenu = MENU_GROUP:New( PlayerGroup, "Update Messages", MessagesMenu )
-      MENU_GROUP_COMMAND:New( PlayerGroup, "Off", UpdateMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Update, 0 )
-      MENU_GROUP_COMMAND:New( PlayerGroup, "5 seconds", UpdateMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Update, 5 )
-      MENU_GROUP_COMMAND:New( PlayerGroup, "10 seconds", UpdateMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Update, 10 )
-      MENU_GROUP_COMMAND:New( PlayerGroup, "15 seconds", UpdateMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Update, 15 )
-      MENU_GROUP_COMMAND:New( PlayerGroup, "30 seconds", UpdateMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Update, 30 )
-      MENU_GROUP_COMMAND:New( PlayerGroup, "1 minute", UpdateMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Update, 60 )
-  
-      local InformationMessagesMenu = MENU_GROUP:New( PlayerGroup, "Information Messages", MessagesMenu )
-      MENU_GROUP_COMMAND:New( PlayerGroup, "5 seconds", InformationMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Information, 5 )
-      MENU_GROUP_COMMAND:New( PlayerGroup, "10 seconds", InformationMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Information, 10 )
-      MENU_GROUP_COMMAND:New( PlayerGroup, "15 seconds", InformationMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Information, 15 )
-      MENU_GROUP_COMMAND:New( PlayerGroup, "30 seconds", InformationMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Information, 30 )
-      MENU_GROUP_COMMAND:New( PlayerGroup, "1 minute", InformationMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Information, 60 )
-      MENU_GROUP_COMMAND:New( PlayerGroup, "2 minutes", InformationMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Information, 120 )
-  
-      local BriefingReportsMenu = MENU_GROUP:New( PlayerGroup, "Briefing Reports", MessagesMenu )
-      MENU_GROUP_COMMAND:New( PlayerGroup, "15 seconds", BriefingReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Briefing, 15 )
-      MENU_GROUP_COMMAND:New( PlayerGroup, "30 seconds", BriefingReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Briefing, 30 )
-      MENU_GROUP_COMMAND:New( PlayerGroup, "1 minute", BriefingReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Briefing, 60 )
-      MENU_GROUP_COMMAND:New( PlayerGroup, "2 minutes", BriefingReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Briefing, 120 )
-      MENU_GROUP_COMMAND:New( PlayerGroup, "3 minutes", BriefingReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Briefing, 180 )
-  
-      local OverviewReportsMenu = MENU_GROUP:New( PlayerGroup, "Overview Reports", MessagesMenu )
-      MENU_GROUP_COMMAND:New( PlayerGroup, "15 seconds", OverviewReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Overview, 15 )
-      MENU_GROUP_COMMAND:New( PlayerGroup, "30 seconds", OverviewReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Overview, 30 )
-      MENU_GROUP_COMMAND:New( PlayerGroup, "1 minute", OverviewReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Overview, 60 )
-      MENU_GROUP_COMMAND:New( PlayerGroup, "2 minutes", OverviewReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Overview, 120 )
-      MENU_GROUP_COMMAND:New( PlayerGroup, "3 minutes", OverviewReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Overview, 180 )
-  
-      local DetailedReportsMenu = MENU_GROUP:New( PlayerGroup, "Detailed Reports", MessagesMenu )
-      MENU_GROUP_COMMAND:New( PlayerGroup, "15 seconds", DetailedReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.DetailedReportsMenu, 15 )
-      MENU_GROUP_COMMAND:New( PlayerGroup, "30 seconds", DetailedReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.DetailedReportsMenu, 30 )
-      MENU_GROUP_COMMAND:New( PlayerGroup, "1 minute", DetailedReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.DetailedReportsMenu, 60 )
-      MENU_GROUP_COMMAND:New( PlayerGroup, "2 minutes", DetailedReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.DetailedReportsMenu, 120 )
-      MENU_GROUP_COMMAND:New( PlayerGroup, "3 minutes", DetailedReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.DetailedReportsMenu, 180 )
+    if self:IsA2A_MGRS() then
+      MENU_GROUP_COMMAND:New( PlayerGroup, "Military Grid (MGRS) Accuracy 1", A2ACoordinateMenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 1 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "Military Grid (MGRS) Accuracy 2", A2ACoordinateMenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 2 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "Military Grid (MGRS) Accuracy 3", A2ACoordinateMenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 3 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "Military Grid (MGRS) Accuracy 4", A2ACoordinateMenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 4 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "Military Grid (MGRS) Accuracy 5", A2ACoordinateMenu, self.MenuGroupMGRS_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 5 )
+    end    
+
+    local MetricsMenu = MENU_GROUP:New( PlayerGroup, "Measures and Weights System", PlayerMenu )
     
-    end  
+    if self:IsMetric() then
+      MENU_GROUP_COMMAND:New( PlayerGroup, "Imperial (Miles,Feet)", MetricsMenu, self.MenuGroupMWSystem, self, PlayerUnit, PlayerGroup, PlayerName, false )
+    end
+    
+    if self:IsImperial() then
+      MENU_GROUP_COMMAND:New( PlayerGroup, "Metric (Kilometers,Meters)", MetricsMenu, self.MenuGroupMWSystem, self, PlayerUnit, PlayerGroup, PlayerName, true )
+    end    
+
+
+    local MessagesMenu = MENU_GROUP:New( PlayerGroup, "Messages and Reports", PlayerMenu )
+
+    local UpdateMessagesMenu = MENU_GROUP:New( PlayerGroup, "Update Messages", MessagesMenu )
+    MENU_GROUP_COMMAND:New( PlayerGroup, "Off", UpdateMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Update, 0 )
+    MENU_GROUP_COMMAND:New( PlayerGroup, "5 seconds", UpdateMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Update, 5 )
+    MENU_GROUP_COMMAND:New( PlayerGroup, "10 seconds", UpdateMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Update, 10 )
+    MENU_GROUP_COMMAND:New( PlayerGroup, "15 seconds", UpdateMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Update, 15 )
+    MENU_GROUP_COMMAND:New( PlayerGroup, "30 seconds", UpdateMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Update, 30 )
+    MENU_GROUP_COMMAND:New( PlayerGroup, "1 minute", UpdateMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Update, 60 )
+
+    local InformationMessagesMenu = MENU_GROUP:New( PlayerGroup, "Information Messages", MessagesMenu )
+    MENU_GROUP_COMMAND:New( PlayerGroup, "5 seconds", InformationMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Information, 5 )
+    MENU_GROUP_COMMAND:New( PlayerGroup, "10 seconds", InformationMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Information, 10 )
+    MENU_GROUP_COMMAND:New( PlayerGroup, "15 seconds", InformationMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Information, 15 )
+    MENU_GROUP_COMMAND:New( PlayerGroup, "30 seconds", InformationMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Information, 30 )
+    MENU_GROUP_COMMAND:New( PlayerGroup, "1 minute", InformationMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Information, 60 )
+    MENU_GROUP_COMMAND:New( PlayerGroup, "2 minutes", InformationMessagesMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Information, 120 )
+
+    local BriefingReportsMenu = MENU_GROUP:New( PlayerGroup, "Briefing Reports", MessagesMenu )
+    MENU_GROUP_COMMAND:New( PlayerGroup, "15 seconds", BriefingReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Briefing, 15 )
+    MENU_GROUP_COMMAND:New( PlayerGroup, "30 seconds", BriefingReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Briefing, 30 )
+    MENU_GROUP_COMMAND:New( PlayerGroup, "1 minute", BriefingReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Briefing, 60 )
+    MENU_GROUP_COMMAND:New( PlayerGroup, "2 minutes", BriefingReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Briefing, 120 )
+    MENU_GROUP_COMMAND:New( PlayerGroup, "3 minutes", BriefingReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Briefing, 180 )
+
+    local OverviewReportsMenu = MENU_GROUP:New( PlayerGroup, "Overview Reports", MessagesMenu )
+    MENU_GROUP_COMMAND:New( PlayerGroup, "15 seconds", OverviewReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Overview, 15 )
+    MENU_GROUP_COMMAND:New( PlayerGroup, "30 seconds", OverviewReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Overview, 30 )
+    MENU_GROUP_COMMAND:New( PlayerGroup, "1 minute", OverviewReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Overview, 60 )
+    MENU_GROUP_COMMAND:New( PlayerGroup, "2 minutes", OverviewReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Overview, 120 )
+    MENU_GROUP_COMMAND:New( PlayerGroup, "3 minutes", OverviewReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.Overview, 180 )
+
+    local DetailedReportsMenu = MENU_GROUP:New( PlayerGroup, "Detailed Reports", MessagesMenu )
+    MENU_GROUP_COMMAND:New( PlayerGroup, "15 seconds", DetailedReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.DetailedReportsMenu, 15 )
+    MENU_GROUP_COMMAND:New( PlayerGroup, "30 seconds", DetailedReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.DetailedReportsMenu, 30 )
+    MENU_GROUP_COMMAND:New( PlayerGroup, "1 minute", DetailedReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.DetailedReportsMenu, 60 )
+    MENU_GROUP_COMMAND:New( PlayerGroup, "2 minutes", DetailedReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.DetailedReportsMenu, 120 )
+    MENU_GROUP_COMMAND:New( PlayerGroup, "3 minutes", DetailedReportsMenu, self.MenuGroupMessageTimingsSystem, self, PlayerUnit, PlayerGroup, PlayerName, MESSAGE.Type.DetailedReportsMenu, 180 )
+
     
     return self
   end
 
-  --- Removes the player menu from the PlayerUnit.
-  -- @param #SETTINGS self
+  --- @param #SETTINGS self
+  -- @param RootMenu
   -- @param Wrapper.Client#CLIENT PlayerUnit
-  -- @return #SETTINGS self
+  -- @return #SETTINGS
   function SETTINGS:RemovePlayerMenu( PlayerUnit )
 
     if self.PlayerMenu then
       self.PlayerMenu:Remove()
-      self.PlayerMenu = nil
     end
     
     return self

Moose Development/Moose/Core/SpawnStatic.lua

@@ -1,16 +1,12 @@
---- **Core** - Spawn new statics in your running missions.
+--- **Core** -- Spawn dynamically new STATICs in your missions.
 --  
--- ===
+-- ![Banner Image](..\Presentations\SPAWNSTATIC\Dia1.JPG)
 -- 
--- ## Features:
+-- ====
 -- 
---   * Spawn new statics from a static already defined using the mission editor.
---   * Spawn new statics from a given template.
---   * Spawn new statics from a given type.
---   * Spawn with a custom heading and location.
---   * Spawn within a zone.
+-- SPAWNSTATIC spawns static structures in your missions dynamically. See below the SPAWNSTATIC class documentation.
 -- 
--- ===
+-- ====
 -- 
 -- # Demo Missions
 -- 
@@ -20,21 +16,20 @@
 --
 -- ### [ALL Demo Missions pack of the last release](https://github.com/FlightControl-Master/MOOSE_MISSIONS/releases)
 -- 
--- ===
+-- ====
 -- 
 -- # YouTube Channel
 -- 
 -- ### [SPAWNSTATIC YouTube Channel]()
 -- 
--- ===
+-- ====
 -- 
--- ### Author: **FlightControl**
+-- ### Author: **Sven Van de Velde (FlightControl)**
 -- ### Contributions: 
 -- 
--- ===
+-- ====
 -- 
--- @module Core.SpawnStatic
--- @image Core_Spawnstatic.JPG
+-- @module SpawnStatic
 
 
 
@@ -42,7 +37,9 @@
 -- @extends Core.Base#BASE
 
 
---- Allows to spawn dynamically new @{Static}s.
+--- # SPAWNSTATIC class, extends @{Base#BASE}
+-- 
+-- The SPAWNSTATIC class allows to spawn dynamically new @{Static}s.
 -- Through creating a copy of an existing static object template as defined in the Mission Editor (ME),
 -- SPAWNSTATIC can retireve the properties of the defined static object template (like type, category etc), and "copy"
 -- these properties to create a new static object and place it at the desired coordinate.
@@ -83,22 +80,18 @@ SPAWNSTATIC = {
 --- Creates the main object to spawn a @{Static} defined in the ME.
 -- @param #SPAWNSTATIC self
 -- @param #string SpawnTemplatePrefix is the name of the Group in the ME that defines the Template.  Each new group will have the name starting with SpawnTemplatePrefix.
--- @param DCS#country.id SpawnCountryID The ID of the country.
--- @param DCS#coalition.side SpawnCoalitionID The ID of the coalition.
 -- @return #SPAWNSTATIC
-function SPAWNSTATIC:NewFromStatic( SpawnTemplatePrefix, SpawnCountryID, SpawnCoalitionID )
+function SPAWNSTATIC:NewFromStatic( SpawnTemplatePrefix, CountryID ) --R2.1
 	local self = BASE:Inherit( self, BASE:New() ) -- #SPAWNSTATIC
 	self:F( { SpawnTemplatePrefix } )
   
-	local TemplateStatic, CoalitionID, CategoryID, CountryID = _DATABASE:GetStaticGroupTemplate( SpawnTemplatePrefix )
+	local TemplateStatic = StaticObject.getByName( SpawnTemplatePrefix )
 	if TemplateStatic then
 		self.SpawnTemplatePrefix = SpawnTemplatePrefix
-		self.CountryID = SpawnCountryID or CountryID
-		self.CategoryID = CategoryID
-		self.CoalitionID = SpawnCoalitionID or CoalitionID
+    self.CountryID = CountryID
 		self.SpawnIndex = 0
 	else
-		error( "SPAWNSTATIC:New: There is no static declared in the mission editor with SpawnTemplatePrefix = '" .. SpawnTemplatePrefix .. "'" )
+		error( "SPAWNSTATIC:New: There is no group declared in the mission editor with SpawnTemplatePrefix = '" .. SpawnTemplatePrefix .. "'" )
 	end
 
   self:SetEventPriority( 5 )
@@ -110,13 +103,12 @@ end
 -- @param #SPAWNSTATIC self
 -- @param #string SpawnTypeName is the name of the type.
 -- @return #SPAWNSTATIC
-function SPAWNSTATIC:NewFromType( SpawnTypeName, SpawnShapeName, SpawnCategory, SpawnCountryID, SpawnCoalitionID ) 
+function SPAWNSTATIC:NewFromType( SpawnTypeName, SpawnShapeName, SpawnCategory, CountryID ) --R2.1
   local self = BASE:Inherit( self, BASE:New() ) -- #SPAWNSTATIC
   self:F( { SpawnTypeName } )
   
   self.SpawnTypeName = SpawnTypeName
-  self.CountryID = SpawnCountryID
-  self.CoalitionID = SpawnCoalitionID
+  self.CountryID = CountryID
   self.SpawnIndex = 0
 
   self:SetEventPriority( 5 )
@@ -125,36 +117,6 @@ function SPAWNSTATIC:NewFromType( SpawnTypeName, SpawnShapeName, SpawnCategory,
 end
 
 
---- Creates a new @{Static} at the original position.
--- @param #SPAWNSTATIC self
--- @param #number Heading The heading of the static, which is a number in degrees from 0 to 360.
--- @param #string (optional) The name of the new static.
--- @return #SPAWNSTATIC
-function SPAWNSTATIC:Spawn( Heading, NewName ) --R2.3
-  self:F( { Heading, NewName  } )
-  
-  local StaticTemplate, CoalitionID, CategoryID, CountryID = _DATABASE:GetStaticGroupTemplate( self.SpawnTemplatePrefix )
-  
-  if StaticTemplate then
-  
-    local StaticUnitTemplate = StaticTemplate.units[1]
-  
-    StaticTemplate.name = NewName or string.format("%s#%05d", self.SpawnTemplatePrefix, self.SpawnIndex )
-    StaticTemplate.heading = ( Heading / 180 ) * math.pi
-    
-    _DATABASE:_RegisterStaticTemplate( StaticTemplate, CoalitionID, CategoryID, CountryID )
-
-    local Static = coalition.addStaticObject( self.CountryID or CountryID, StaticTemplate.units[1] )
-    
-    self.SpawnIndex = self.SpawnIndex + 1
-  
-    return _DATABASE:FindStatic(Static:getName())
-  end
-  
-  return nil
-end
-
-
 --- Creates a new @{Static} from a POINT_VEC2.
 -- @param #SPAWNSTATIC self
 -- @param Core.Point#POINT_VEC2 PointVec2 The 2D coordinate where to spawn the static.
@@ -164,86 +126,27 @@ end
 function SPAWNSTATIC:SpawnFromPointVec2( PointVec2, Heading, NewName ) --R2.1
   self:F( { PointVec2, Heading, NewName  } )
   
-  local StaticTemplate, CoalitionID, CategoryID, CountryID = _DATABASE:GetStaticGroupTemplate( self.SpawnTemplatePrefix )
+  local CountryName = _DATABASE.COUNTRY_NAME[self.CountryID]
   
-  if StaticTemplate then
+  local StaticTemplate = _DATABASE:GetStaticUnitTemplate( self.SpawnTemplatePrefix )
   
-    local StaticUnitTemplate = StaticTemplate.units[1]
+  StaticTemplate.x = PointVec2:GetLat()
+  StaticTemplate.y = PointVec2:GetLon()
   
-    StaticUnitTemplate.x = PointVec2.x
-    StaticUnitTemplate.y = PointVec2.z
+  StaticTemplate.name = NewName or string.format("%s#%05d", self.SpawnTemplatePrefix, self.SpawnIndex )
+  StaticTemplate.heading = ( Heading / 180 ) * math.pi
   
-    StaticTemplate.route = nil
-    StaticTemplate.groupId = nil
-    
-    StaticTemplate.name = NewName or string.format("%s#%05d", self.SpawnTemplatePrefix, self.SpawnIndex )
-    StaticUnitTemplate.name = StaticTemplate.name
-    StaticUnitTemplate.heading = ( Heading / 180 ) * math.pi
-    
-    _DATABASE:_RegisterStaticTemplate( StaticTemplate, CoalitionID, CategoryID, CountryID)
-    
-    self:F({StaticTemplate = StaticTemplate})
+  StaticTemplate.CountryID = nil
+  StaticTemplate.CoalitionID = nil
+  StaticTemplate.CategoryID = nil
+  
+  local Static = coalition.addStaticObject( self.CountryID, StaticTemplate )
+  
+  self.SpawnIndex = self.SpawnIndex + 1
 
-    local Static = coalition.addStaticObject( self.CountryID or CountryID, StaticTemplate.units[1] )
-    
-    self.SpawnIndex = self.SpawnIndex + 1
-    
-    return _DATABASE:FindStatic(Static:getName())
-  end
-  
-  return nil
+  return Static
 end
 
-
---- Respawns the original @{Static}.
--- @param #SPAWNSTATIC self
--- @return #SPAWNSTATIC
-function SPAWNSTATIC:ReSpawn()
-  
-  local StaticTemplate, CoalitionID, CategoryID, CountryID = _DATABASE:GetStaticGroupTemplate( self.SpawnTemplatePrefix )
-  
-  if StaticTemplate then
-
-    local StaticUnitTemplate = StaticTemplate.units[1]
-    StaticTemplate.route = nil
-    StaticTemplate.groupId = nil
-    
-    local Static = coalition.addStaticObject( self.CountryID or CountryID, StaticTemplate.units[1] )
-    
-    return _DATABASE:FindStatic(Static:getName())
-  end
-  
-  return nil
-end
-
-
---- Creates the original @{Static} at a POINT_VEC2.
--- @param #SPAWNSTATIC self
--- @param Core.Point#COORDINATE Coordinate 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.
--- @return #SPAWNSTATIC
-function SPAWNSTATIC:ReSpawnAt( Coordinate, Heading )
-  
-  local StaticTemplate, CoalitionID, CategoryID, CountryID = _DATABASE:GetStaticGroupTemplate( self.SpawnTemplatePrefix )
-  
-  if StaticTemplate then
-
-    local StaticUnitTemplate = StaticTemplate.units[1]
-  
-    StaticUnitTemplate.x = Coordinate.x
-    StaticUnitTemplate.y = Coordinate.z
-
-    StaticUnitTemplate.heading = Heading and ( ( Heading / 180 ) * math.pi ) or StaticTemplate.heading
-    
-    local Static = coalition.addStaticObject( self.CountryID or CountryID, StaticTemplate.units[1] )
-    
-    return _DATABASE:FindStatic(Static:getName())
-  end
-  
-  return nil
-end
-
-
 --- Creates a new @{Static} from a @{Zone}.
 -- @param #SPAWNSTATIC self
 -- @param Core.Zone#ZONE_BASE Zone The Zone where to spawn the static.

Moose Development/Moose/Core/Spot.lua

@@ -1,16 +1,17 @@
---- **Core** - Management of spotting logistics, that can be activated and deactivated upon command.
+--- **Core** -- Management of SPOT logistics, that can be transported from and to transportation carriers.
 --
--- ===
+-- ![Banner Image](..\Presentations\SPOT\Dia1.JPG)
+--
+-- ====
 -- 
 -- SPOT implements the DCS Spot class functionality, but adds additional luxury to be able to:
 -- 
 --   * Spot for a defined duration.
---   * Updates of laer spot position every 0.2 seconds for moving targets.
---   * Wiggle the spot at the target.
---   * Provide a @{Wrapper.Unit} as a target, instead of a point.
+--   * wiggle the spot at the target.
+--   * Provide a @{Unit} as a target, instead of a point.
 --   * Implement a status machine, LaseOn, LaseOff.
 --
--- ===
+-- ====
 -- 
 -- # Demo Missions
 -- 
@@ -20,25 +21,24 @@
 --
 -- ### [ALL Demo Missions pack of the last release](https://github.com/FlightControl-Master/MOOSE_MISSIONS/releases)
 -- 
--- ===
+-- ====
 -- 
 -- # YouTube Channel
 -- 
 -- ### [SPOT YouTube Channel]()
 -- 
--- ===
+-- ====
 -- 
--- ### Author: **FlightControl**
+-- ### Author: **Sven Van de Velde (FlightControl)**
 -- ### Contributions: 
 -- 
 --   * [**Ciribob**](https://forums.eagle.ru/member.php?u=112175): Showing the way how to lase targets + how laser codes work!!! Explained the autolase script.
 --   * [**EasyEB**](https://forums.eagle.ru/member.php?u=112055): Ideas and Beta Testing
 --   * [**Wingthor**](https://forums.eagle.ru/member.php?u=123698): Beta Testing
 -- 
--- ===
+-- ====
 -- 
--- @module Core.Spot
--- @image Core_Spot.JPG
+-- @module Spot
 
 
 do
@@ -47,12 +47,13 @@ do
   -- @extends Core.Fsm#FSM
 
 
-  --- Implements the target spotting or marking functionality, but adds additional luxury to be able to:
+  --- # SPOT class, extends @{Fsm#FSM}
+  -- 
+  -- SPOT implements the DCS Spot class functionality, but adds additional luxury to be able to:
   -- 
   --   * Mark targets for a defined duration.
-  --   * Updates of laer spot position every 0.2 seconds for moving targets.
-  --   * Wiggle the spot at the target.
-  --   * Provide a @{Wrapper.Unit} as a target, instead of a point.
+  --   * wiggle the spot at the target.
+  --   * Provide a @{Unit} as a target, instead of a point.
   --   * Implement a status machine, LaseOn, LaseOff.
   -- 
   -- ## 1. SPOT constructor
@@ -87,7 +88,9 @@ do
   
   --- SPOT Constructor.
   -- @param #SPOT self
-  -- @param Wrapper.Unit#UNIT Recce Unit that is lasing
+  -- @param Wrapper.Unit#UNIT Recce
+  -- @param #number LaserCode
+  -- @param #number Duration
   -- @return #SPOT
   function SPOT:New( Recce )
   
@@ -115,17 +118,12 @@ do
     --- LaseOn Trigger for SPOT
     -- @function [parent=#SPOT] LaseOn
     -- @param #SPOT self
-    -- @param Wrapper.Positionable#POSITIONABLE Target
-    -- @param #number LaserCode Laser code.
-    -- @param #number Duration Duration of lasing in seconds.
     
     --- LaseOn Asynchronous Trigger for SPOT
     -- @function [parent=#SPOT] __LaseOn
     -- @param #SPOT self
     -- @param #number Delay
-    -- @param Wrapper.Positionable#POSITIONABLE Target
-    -- @param #number LaserCode Laser code.
-    -- @param #number Duration Duration of lasing in seconds.
+    
     
     
     self:AddTransition( "On",  "Lasing", "On" )
@@ -198,11 +196,11 @@ do
   -- @param From
   -- @param Event
   -- @param To
-  -- @param Wrapper.Positionable#POSITIONABLE Target Unit that is being lased.
-  -- @param #number LaserCode Laser code.
-  -- @param #number Duration Duration of lasing in seconds.
+  -- @param Wrapper.Positionable#POSITIONABLE Target
+  -- @param #number LaserCode
+  -- @param #number Duration
   function SPOT:onafterLaseOn( From, Event, To, Target, LaserCode, Duration )
-    self:F( { "LaseOn", Target, LaserCode, Duration } )
+    self:E( { "LaseOn", Target, LaserCode, Duration } )
 
     local function StopLase( self )
       self:LaseOff()
@@ -230,10 +228,10 @@ do
   --- @param #SPOT self
   -- @param Core.Event#EVENTDATA EventData
   function SPOT:OnEventDead(EventData)
-    self:F( { Dead = EventData.IniDCSUnitName, Target = self.Target } )
+    self:E( { Dead = EventData.IniDCSUnitName, Target = self.Target } )
     if self.Target then
       if EventData.IniDCSUnitName == self.Target:GetName() then
-        self:F( {"Target dead ", self.Target:GetName() } )
+        self:E( {"Target dead ", self.Target:GetName() } )
         self:Destroyed()
         self:LaseOff()
       end
@@ -251,7 +249,7 @@ do
       self.SpotLaser:setPoint( self.Target:GetPointVec3():AddY(1):GetVec3() )
       self:__Lasing( -0.2 )
     else
-      self:F( { "Target is not alive", self.Target:IsAlive() } )
+      self:E( { "Target is not alive", self.Target:IsAlive() } )
     end
   
   end
@@ -263,7 +261,7 @@ do
   -- @return #SPOT
   function SPOT:onafterLaseOff( From, Event, To )
   
-    self:F( {"Stopped lasing for ", self.Target:GetName() , SpotIR = self.SportIR, SpotLaser = self.SpotLaser } )
+    self:E( {"Stopped lasing for ", self.Target:GetName() , SpotIR = self.SportIR, SpotLaser = self.SpotLaser } )
     
     self.Lasing = false
     

Moose Development/Moose/Core/UserFlag.lua

@@ -1,97 +0,0 @@
---- **Core** - Manage user flags to interact with the mission editor trigger system and server side scripts.
---
--- ===
--- 
--- ## Features:
--- 
---   * Set or get DCS user flags within running missions.
--- 
--- ===
--- 
--- ### Author: **FlightControl**
--- 
--- ===
--- 
--- @module Core.UserFlag
--- @image Core_Userflag.JPG
--- 
-
-do -- UserFlag
-
-  --- @type USERFLAG
-  -- @extends Core.Base#BASE
-
-
-  --- Management of DCS User Flags.
-  -- 
-  -- # 1. USERFLAG constructor
-  --   
-  --   * @{#USERFLAG.New}(): Creates a new USERFLAG object.
-  -- 
-  -- @field #USERFLAG
-  USERFLAG = {
-    ClassName = "USERFLAG",
-  }
-  
-  --- USERFLAG Constructor.
-  -- @param #USERFLAG self
-  -- @param #string UserFlagName The name of the userflag, which is a free text string.
-  -- @return #USERFLAG
-  function USERFLAG:New( UserFlagName ) --R2.3
-  
-    local self = BASE:Inherit( self, BASE:New() ) -- #USERFLAG
-
-    self.UserFlagName = UserFlagName
-
-    return self
-  end
-
-
-  --- Set the userflag to a given Number.
-  -- @param #USERFLAG self
-  -- @param #number Number The number value to be checked if it is the same as the userflag.
-  -- @return #USERFLAG The userflag instance.
-  -- @usage
-  --   local BlueVictory = USERFLAG:New( "VictoryBlue" )
-  --   BlueVictory:Set( 100 ) -- Set the UserFlag VictoryBlue to 100.
-  --   
-  function USERFLAG:Set( Number ) --R2.3
-  
-    self:F( { Number = Number } )
-    
-    trigger.action.setUserFlag( self.UserFlagName, Number )
-    
-    return self
-  end  
-
-  
-  --- Get the userflag Number.
-  -- @param #USERFLAG self
-  -- @return #number Number The number value to be checked if it is the same as the userflag.
-  -- @usage
-  --   local BlueVictory = USERFLAG:New( "VictoryBlue" )
-  --   local BlueVictoryValue = BlueVictory:Get() -- Get the UserFlag VictoryBlue value.
-  --   
-  function USERFLAG:Get( Number ) --R2.3
-    
-    return trigger.misc.getUserFlag( self.UserFlagName )
-  end  
-
-  
-  
-  --- Check if the userflag has a value of Number.
-  -- @param #USERFLAG self
-  -- @param #number Number The number value to be checked if it is the same as the userflag.
-  -- @return #boolean true if the Number is the value of the userflag.
-  -- @usage
-  --   local BlueVictory = USERFLAG:New( "VictoryBlue" )
-  --   if BlueVictory:Is( 1 ) then
-  --     return "Blue has won"
-  --   end
-  function USERFLAG:Is( Number ) --R2.3
-    
-    return trigger.misc.getUserFlag( self.UserFlagName ) == Number
-    
-  end  
-
-end

Moose Development/Moose/Core/UserSound.lua

@@ -1,134 +0,0 @@
---- **Core** - Manage user sound.
---
--- ===
--- 
--- ## Features:
--- 
---   * Play sounds wihtin running missions.
--- 
--- ===
--- 
--- Management of DCS User Sound.
--- 
--- ===
--- 
--- ### Author: **FlightControl**
--- 
--- ===
--- 
--- @module Core.UserSound
--- @image Core_Usersound.JPG
-
-do -- UserSound
-
-  --- @type USERSOUND
-  -- @extends Core.Base#BASE
-
-
-  --- Management of DCS User Sound.
-  -- 
-  -- ## USERSOUND constructor
-  --   
-  --   * @{#USERSOUND.New}(): Creates a new USERSOUND object.
-  -- 
-  -- @field #USERSOUND
-  USERSOUND = {
-    ClassName = "USERSOUND",
-  }
-  
-  --- USERSOUND Constructor.
-  -- @param #USERSOUND self
-  -- @param #string UserSoundFileName The filename of the usersound.
-  -- @return #USERSOUND
-  function USERSOUND:New( UserSoundFileName ) --R2.3
-  
-    local self = BASE:Inherit( self, BASE:New() ) -- #USERSOUND
-
-    self.UserSoundFileName = UserSoundFileName
-
-    return self
-  end
-
-
-  --- Set usersound filename.
-  -- @param #USERSOUND self
-  -- @param #string UserSoundFileName The filename of the usersound.
-  -- @return #USERSOUND The usersound instance.
-  -- @usage
-  --   local BlueVictory = USERSOUND:New( "BlueVictory.ogg" )
-  --   BlueVictory:SetFileName( "BlueVictoryLoud.ogg" ) -- Set the BlueVictory to change the file name to play a louder sound.
-  --   
-  function USERSOUND:SetFileName( UserSoundFileName ) --R2.3
-    
-    self.UserSoundFileName = UserSoundFileName
-
-    return self
-  end  
-
-  
-
-
-  --- Play the usersound to all players.
-  -- @param #USERSOUND self
-  -- @return #USERSOUND The usersound instance.
-  -- @usage
-  --   local BlueVictory = USERSOUND:New( "BlueVictory.ogg" )
-  --   BlueVictory:ToAll() -- Play the sound that Blue has won.
-  --   
-  function USERSOUND:ToAll() --R2.3
-    
-    trigger.action.outSound( self.UserSoundFileName )
-    
-    return self
-  end  
-
-  
-  --- Play the usersound to the given coalition.
-  -- @param #USERSOUND self
-  -- @param DCS#coalition Coalition The coalition to play the usersound to.
-  -- @return #USERSOUND The usersound instance.
-  -- @usage
-  --   local BlueVictory = USERSOUND:New( "BlueVictory.ogg" )
-  --   BlueVictory:ToCoalition( coalition.side.BLUE ) -- Play the sound that Blue has won to the blue coalition.
-  --   
-  function USERSOUND:ToCoalition( Coalition ) --R2.3
-    
-    trigger.action.outSoundForCoalition(Coalition, self.UserSoundFileName )
-    
-    return self
-  end  
-
-
-  --- Play the usersound to the given country.
-  -- @param #USERSOUND self
-  -- @param DCS#country Country The country to play the usersound to.
-  -- @return #USERSOUND The usersound instance.
-  -- @usage
-  --   local BlueVictory = USERSOUND:New( "BlueVictory.ogg" )
-  --   BlueVictory:ToCountry( country.id.USA ) -- Play the sound that Blue has won to the USA country.
-  --   
-  function USERSOUND:ToCountry( Country ) --R2.3
-    
-    trigger.action.outSoundForCountry( Country, self.UserSoundFileName )
-    
-    return self
-  end  
-
-
-  --- Play the usersound to the given @{Wrapper.Group}.
-  -- @param #USERSOUND self
-  -- @param Wrapper.Group#GROUP Group The @{Wrapper.Group} to play the usersound to.
-  -- @return #USERSOUND The usersound instance.
-  -- @usage
-  --   local BlueVictory = USERSOUND:New( "BlueVictory.ogg" )
-  --   local PlayerGroup = GROUP:FindByName( "PlayerGroup" ) -- Search for the active group named "PlayerGroup", that contains a human player.
-  --   BlueVictory:ToGroup( PlayerGroup ) -- Play the sound that Blue has won to the player group.
-  --   
-  function USERSOUND:ToGroup( Group ) --R2.3
-    
-    trigger.action.outSoundForGroup( Group:GetID(), self.UserSoundFileName )
-    
-    return self
-  end  
-
-end

Moose Development/Moose/Core/Velocity.lua

@@ -1,191 +0,0 @@
---- **Core** - Models a velocity or speed, which can be expressed in various formats according the settings.
--- 
--- ===
--- 
--- ## Features:
--- 
---   * Convert velocity in various metric systems.
---   * Set the velocity.
---   * Create a text in a specific format of a velocity.
---   
--- ===
--- 
--- ### Author: **FlightControl**
--- ### Contributions: 
--- 
--- ===
--- 
--- @module Core.Velocity
--- @image MOOSE.JPG
-
-do -- Velocity
-
-  --- @type VELOCITY
-  -- @extends Core.Base#BASE
-
-
-  --- VELOCITY models a speed, which can be expressed in various formats according the Settings.
-  -- 
-  -- ## VELOCITY constructor
-  --   
-  --   * @{#VELOCITY.New}(): Creates a new VELOCITY object.
-  -- 
-  -- @field #VELOCITY
-  VELOCITY = {
-    ClassName = "VELOCITY",
-  }
-
-  --- VELOCITY Constructor.
-  -- @param #VELOCITY self
-  -- @param #number VelocityMps The velocity in meters per second. 
-  -- @return #VELOCITY
-  function VELOCITY:New( VelocityMps )
-    local self = BASE:Inherit( self, BASE:New() ) -- #VELOCITY
-    self:F( {} )
-    self.Velocity = VelocityMps
-    return self
-  end
-
-  --- Set the velocity in Mps (meters per second).
-  -- @param #VELOCITY self
-  -- @param #number VelocityMps The velocity in meters per second. 
-  -- @return #VELOCITY
-  function VELOCITY:Set( VelocityMps )
-    self.Velocity = VelocityMps
-    return self
-  end
-  
-  --- Get the velocity in Mps (meters per second).
-  -- @param #VELOCITY self
-  -- @return #number The velocity in meters per second. 
-  function VELOCITY:Get()
-    return self.Velocity
-  end
-
-  --- Set the velocity in Kmph (kilometers per hour).
-  -- @param #VELOCITY self
-  -- @param #number VelocityKmph The velocity in kilometers per hour. 
-  -- @return #VELOCITY
-  function VELOCITY:SetKmph( VelocityKmph )
-    self.Velocity = UTILS.KmphToMps( VelocityKmph )
-    return self
-  end
-  
-  --- Get the velocity in Kmph (kilometers per hour).
-  -- @param #VELOCITY self
-  -- @return #number The velocity in kilometers per hour. 
-  function VELOCITY:GetKmph()
-  
-    return UTILS.MpsToKmph( self.Velocity )
-  end
-
-  --- Set the velocity in Miph (miles per hour).
-  -- @param #VELOCITY self
-  -- @param #number VelocityMiph The velocity in miles per hour. 
-  -- @return #VELOCITY
-  function VELOCITY:SetMiph( VelocityMiph )
-    self.Velocity = UTILS.MiphToMps( VelocityMiph )
-    return self
-  end
-  
-  --- Get the velocity in Miph (miles per hour).
-  -- @param #VELOCITY self
-  -- @return #number The velocity in miles per hour. 
-  function VELOCITY:GetMiph()
-    return UTILS.MpsToMiph( self.Velocity )
-  end
-
-  
-  --- Get the velocity in text, according the player @{Settings}.
-  -- @param #VELOCITY self
-  -- @param Core.Settings#SETTINGS Settings
-  -- @return #string The velocity in text. 
-  function VELOCITY:GetText( Settings )
-    local Settings = Settings or _SETTINGS
-    if self.Velocity ~= 0 then
-      if Settings:IsMetric() then
-        return string.format( "%d km/h", UTILS.MpsToKmph( self.Velocity ) )
-      else
-        return string.format( "%d mi/h", UTILS.MpsToMiph( self.Velocity ) )
-      end
-    else
-      return "stationary"
-    end
-  end
-
-  --- Get the velocity in text, according the player or default @{Settings}.
-  -- @param #VELOCITY self
-  -- @param Wrapper.Controllable#CONTROLLABLE Controllable
-  -- @param Core.Settings#SETTINGS Settings
-  -- @return #string The velocity in text according the player or default @{Settings}
-  function VELOCITY:ToString( VelocityGroup, Settings ) -- R2.3
-    self:F( { Group = VelocityGroup and VelocityGroup:GetName() } )
-    local Settings = Settings or ( VelocityGroup and _DATABASE:GetPlayerSettings( VelocityGroup:GetPlayerName() ) ) or _SETTINGS
-    return self:GetText( Settings )
-  end
-
-end
-
-do -- VELOCITY_POSITIONABLE
-
-  --- @type VELOCITY_POSITIONABLE
-  -- @extends Core.Base#BASE
-
-
-  --- # VELOCITY_POSITIONABLE class, extends @{Core.Base#BASE}
-  -- 
-  -- VELOCITY_POSITIONABLE monitors the speed of an @{Positionable} in the simulation, which can be expressed in various formats according the Settings.
-  -- 
-  -- ## 1. VELOCITY_POSITIONABLE constructor
-  --   
-  --   * @{#VELOCITY_POSITIONABLE.New}(): Creates a new VELOCITY_POSITIONABLE object.
-  -- 
-  -- @field #VELOCITY_POSITIONABLE
-  VELOCITY_POSITIONABLE = {
-    ClassName = "VELOCITY_POSITIONABLE",
-  }
-
-  --- VELOCITY_POSITIONABLE Constructor.
-  -- @param #VELOCITY_POSITIONABLE self
-  -- @param Wrapper.Positionable#POSITIONABLE Positionable The Positionable to monitor the speed. 
-  -- @return #VELOCITY_POSITIONABLE
-  function VELOCITY_POSITIONABLE:New( Positionable )
-    local self = BASE:Inherit( self, VELOCITY:New() ) -- #VELOCITY_POSITIONABLE
-    self:F( {} )
-    self.Positionable = Positionable
-    return self
-  end
-
-  --- Get the velocity in Mps (meters per second).
-  -- @param #VELOCITY_POSITIONABLE self
-  -- @return #number The velocity in meters per second. 
-  function VELOCITY_POSITIONABLE:Get()
-    return self.Positionable:GetVelocityMPS() or 0
-  end
-
-  --- Get the velocity in Kmph (kilometers per hour).
-  -- @param #VELOCITY_POSITIONABLE self
-  -- @return #number The velocity in kilometers per hour. 
-  function VELOCITY_POSITIONABLE:GetKmph()
-  
-    return UTILS.MpsToKmph( self.Positionable:GetVelocityMPS() or 0)
-  end
-
-  --- Get the velocity in Miph (miles per hour).
-  -- @param #VELOCITY_POSITIONABLE self
-  -- @return #number The velocity in miles per hour. 
-  function VELOCITY_POSITIONABLE:GetMiph()
-    return UTILS.MpsToMiph( self.Positionable:GetVelocityMPS() or 0 )
-  end
-
-  --- Get the velocity in text, according the player or default @{Settings}.
-  -- @param #VELOCITY_POSITIONABLE self
-  -- @return #string The velocity in text according the player or default @{Settings}
-  function VELOCITY_POSITIONABLE:ToString() -- R2.3
-    self:F( { Group = self.Positionable and self.Positionable:GetName() } )
-    local Settings = Settings or ( self.Positionable and _DATABASE:GetPlayerSettings( self.Positionable:GetPlayerName() ) ) or _SETTINGS
-    self.Velocity = self.Positionable:GetVelocityMPS()
-    return self:GetText( Settings )
-  end
-
-end

Moose Development/Moose/Functional/CleanUp.lua

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

Moose Development/Moose/Functional/Escort.lua

@@ -1,82 +1,62 @@
 --- **Functional** -- Taking the lead of AI escorting your flight.
 -- 
--- ===
--- 
--- ## Features:
--- 
---   * Escort navigation commands.
---   * Escort hold at position commands.
---   * Escorts reporting detected targets.
---   * Escorts scanning targets in advance.
---   * Escorts attacking specific targets.
---   * Request assistance from other groups for attack.
---   * Manage rule of engagement of escorts.
---   * Manage the allowed evasion techniques of escorts.
---   * Make escort to execute a defined mission or path.
---   * Escort tactical situation reporting.
--- 
--- ===
--- 
--- ## Missions:
--- 
--- [ESC - Escorting](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/ESC%20-%20Escorting)
--- 
--- ===
--- 
--- Allows you to interact with escorting AI on your flight and take the lead.
+-- ====
 -- 
+-- @{#ESCORT} class
+-- ================
+-- The @{#ESCORT} class allows you to interact with escorting AI on your flight and take the lead.
 -- Each escorting group can be commanded with a whole set of radio commands (radio menu in your flight, and then F10).
 --
 -- 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.
 --
--- # RADIO MENUs that can be created:
--- 
+-- RADIO MENUs that can be created:
+-- ================================
 -- Find a summary below of the current available commands:
 --
--- ## Navigation ...:
--- 
+-- Navigation ...:
+-- ---------------
 -- Escort group navigation functions:
 --
 --   * **"Join-Up and Follow at x meters":** The escort group fill follow you at about x meters, and they will follow you.
 --   * **"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 ...:
--- 
+-- Hold position ...:
+-- ------------------
 -- Escort group navigation functions:
 --
 --   * **"At current location":** Stops the escort group and they will hover 30 meters above the ground at the position they stopped.
 --   * **"At client location":** Stops the escort group and they will hover 30 meters above the ground at the position they stopped.
 --
--- ## Report targets ...:
--- 
+-- Report targets ...:
+-- -------------------
 -- Report targets will make the escort group to report any target that it identifies within a 8km range. Any detected target can be attacked using the 4. Attack nearby targets function. (see below).
 --
 --   * **"Report now":** Will report the current detected targets.
 --   * **"Report targets on":** Will make the escort group to report detected targets and will fill the "Attack nearby targets" menu list.
 --   * **"Report targets off":** Will stop detecting targets.
 --
--- ## Scan targets ...:
--- 
+-- Scan targets ...:
+-- -----------------
 -- Menu items to pop-up the escort group for target scanning. After scanning, the escort group will resume with the mission or defined task.
 --
 --   * **"Scan targets 30 seconds":** Scan 30 seconds for targets.
 --   * **"Scan targets 60 seconds":** Scan 60 seconds for targets.
 --
--- ## Attack 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.
 --
--- ## Request assistance from ...:
--- 
+-- Request assistance from ...:
+-- ----------------------------
 -- This menu item will list all detected targets within a 15km range, as with the menu item **Attack Targets**.
 -- This menu item allows to request attack support from other escorts supporting the current client group.
 -- 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 ...:
--- 
+-- ROE ...:
+-- -------- 
 -- Sets the Rules of Engagement (ROE) of the escort group when in flight.
 --
 --   * **"Hold Fire":** The escort group will hold fire.
@@ -84,8 +64,8 @@
 --   * **"Open Fire":** The escort group will open fire on designated targets.
 --   * **"Weapon Free":** The escort group will engage with any target.
 --
--- ## Evasion ...:
--- 
+-- 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.
@@ -93,43 +73,35 @@
 --   * **"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 ...:
--- 
+-- Resume Mission ...:
+-- -------------------
 -- Escort groups can have their own mission. This menu item will allow the escort group to resume their Mission from a given waypoint.
 -- Note that this is really fantastic, as you now have the dynamic of taking control of the escort groups, and allowing them to resume their path or mission.
 --
--- ===
--- 
--- ### Authors: **FlightControl** 
--- 
--- ===
---
--- @module Functional.Escort
--- @image Escorting.JPG
-
-
-
---- @type ESCORT
--- @extends Core.Base#BASE
--- @field Wrapper.Client#CLIENT EscortClient
--- @field Wrapper.Group#GROUP EscortGroup
--- @field #string EscortName
--- @field #ESCORT.MODE EscortMode The mode the escort is in.
--- @field Core.Scheduler#SCHEDULER FollowScheduler The instance of the SCHEDULER class.
--- @field #number FollowDistance The current follow distance.
--- @field #boolean ReportTargets If true, nearby targets are reported.
--- @Field DCS#AI.Option.Air.val.ROE OptionROE Which ROE is set to the EscortGroup.
--- @field DCS#AI.Option.Air.val.REACTION_ON_THREAT OptionReactionOnThreat Which REACTION_ON_THREAT is set to the EscortGroup.
--- @field FunctionalMENU_GROUPDETECTION_BASE Detection
-
---- ESCORT class
--- 
--- # ESCORT construction methods.
--- 
+-- ESCORT construction methods.
+-- ============================
 -- Create a new SPAWN object with the @{#ESCORT.New} method:
 --
---  * @{#ESCORT.New}: Creates a new ESCORT object from a @{Wrapper.Group#GROUP} for a @{Wrapper.Client#CLIENT}, with an optional briefing text.
+--  * @{#ESCORT.New}: Creates a new ESCORT object from a @{Group#GROUP} for a @{Client#CLIENT}, with an optional briefing text.
 --
+-- ESCORT initialization methods.
+-- ==============================
+-- The following menus are created within the RADIO MENU (F10) of an active unit hosted by a player:
+--
+-- * @{#ESCORT.MenuFollowAt}: Creates a menu to make the escort follow the client.
+-- * @{#ESCORT.MenuHoldAtEscortPosition}: Creates a menu to hold the escort at its current position.
+-- * @{#ESCORT.MenuHoldAtLeaderPosition}: Creates a menu to hold the escort at the client position.
+-- * @{#ESCORT.MenuScanForTargets}: Creates a menu so that the escort scans targets.
+-- * @{#ESCORT.MenuFlare}: Creates a menu to disperse flares.
+-- * @{#ESCORT.MenuSmoke}: Creates a menu to disparse smoke.
+-- * @{#ESCORT.MenuReportTargets}: Creates a menu so that the escort reports targets.
+-- * @{#ESCORT.MenuReportPosition}: Creates a menu so that the escort reports its current position from bullseye.
+-- * @{#ESCORT.MenuAssistedAttack: Creates a menu so that the escort supportes assisted attack from other escorts with the client.
+-- * @{#ESCORT.MenuROE: Creates a menu structure to set the rules of engagement of the escort.
+-- * @{#ESCORT.MenuEvasion: Creates a menu structure to set the evasion techniques when the escort is under threat.
+-- * @{#ESCORT.MenuResumeMission}: Creates a menu structure so that the escort can resume from a waypoint.
+-- 
+-- 
 -- @usage
 -- -- Declare a new EscortPlanes object as follows:
 -- 
@@ -139,8 +111,26 @@
 -- 
 -- -- Now use these 2 objects to construct the new EscortPlanes object.
 -- EscortPlanes = ESCORT:New( EscortClient, EscortGroup, "Desert", "Welcome to the mission. You are escorted by a plane with code name 'Desert', which can be instructed through the F10 radio menu." )
+-- 
 --
--- @field #ESCORT
+--
+-- @module Escort
+-- @author FlightControl
+
+--- ESCORT class
+-- @type ESCORT
+-- @extends Core.Base#BASE
+-- @field Wrapper.Client#CLIENT EscortClient
+-- @field Wrapper.Group#GROUP EscortGroup
+-- @field #string EscortName
+-- @field #ESCORT.MODE EscortMode The mode the escort is in.
+-- @field Core.Scheduler#SCHEDULER FollowScheduler The instance of the SCHEDULER class.
+-- @field #number FollowDistance The current follow distance.
+-- @field #boolean ReportTargets If true, nearby targets are reported.
+-- @Field Dcs.DCSTypes#AI.Option.Air.val.ROE OptionROE Which ROE is set to the EscortGroup.
+-- @field Dcs.DCSTypes#AI.Option.Air.val.REACTION_ON_THREAT OptionReactionOnThreat Which REACTION_ON_THREAT is set to the EscortGroup.
+-- @field Core.Menu#MENU_CLIENT EscortMenuResumeMission
+-- @field Functional.Detection#DETECTION_BASE Detection
 ESCORT = {
   ClassName = "ESCORT",
   EscortName = nil, -- The Escort Name
@@ -217,7 +207,7 @@ function ESCORT:New( EscortClient, EscortGroup, EscortName, EscortBriefing )
     self.EscortClient._EscortGroups[EscortGroup:GetName()].Detection = self.EscortGroup.Detection
   end
 
-  self.EscortMenu = MENU_GROUP:New( self.EscortClient:GetGroup(), self.EscortName )
+  self.EscortMenu = MENU_CLIENT:New( self.EscortClient, self.EscortName )
 
   self.EscortGroup:WayPointInitialize(1)
 
@@ -306,21 +296,21 @@ end
 --- Defines a menu slot to let the escort Join and Follow you at a certain distance.
 -- This menu will appear under **Navigation**.
 -- @param #ESCORT self
--- @param DCS#Distance Distance The distance in meters that the escort needs to follow the client.
+-- @param Dcs.DCSTypes#Distance Distance The distance in meters that the escort needs to follow the client.
 -- @return #ESCORT
 function ESCORT:MenuFollowAt( Distance )
   self:F(Distance)
 
   if self.EscortGroup:IsAir() then
     if not self.EscortMenuReportNavigation then
-      self.EscortMenuReportNavigation = MENU_GROUP:New( self.EscortClient:GetGroup(), "Navigation", self.EscortMenu )
+      self.EscortMenuReportNavigation = MENU_CLIENT:New( self.EscortClient, "Navigation", self.EscortMenu )
     end
 
     if not self.EscortMenuJoinUpAndFollow then
       self.EscortMenuJoinUpAndFollow = {}
     end
 
-    self.EscortMenuJoinUpAndFollow[#self.EscortMenuJoinUpAndFollow+1] = MENU_GROUP_COMMAND:New( self.EscortClient:GetGroup(), "Join-Up and Follow at " .. Distance, self.EscortMenuReportNavigation, ESCORT._JoinUpAndFollow, self, Distance )
+    self.EscortMenuJoinUpAndFollow[#self.EscortMenuJoinUpAndFollow+1] = MENU_CLIENT_COMMAND:New( self.EscortClient, "Join-Up and Follow at " .. Distance, self.EscortMenuReportNavigation, ESCORT._JoinUpAndFollow, self, Distance )
 
     self.EscortMode = ESCORT.MODE.FOLLOW
   end
@@ -331,8 +321,8 @@ end
 --- Defines a menu slot to let the escort hold at their current position and stay low with a specified height during a specified time in seconds.
 -- This menu will appear under **Hold position**.
 -- @param #ESCORT self
--- @param DCS#Distance Height Optional parameter that sets the height in meters to let the escort orbit at the current location. The default value is 30 meters.
--- @param DCS#Time Seconds Optional parameter that lets the escort orbit at the current position for a specified time. (not implemented yet). The default value is 0 seconds, meaning, that the escort will orbit forever until a sequent command is given.
+-- @param Dcs.DCSTypes#Distance Height Optional parameter that sets the height in meters to let the escort orbit at the current location. The default value is 30 meters.
+-- @param Dcs.DCSTypes#Time Seconds Optional parameter that lets the escort orbit at the current position for a specified time. (not implemented yet). The default value is 0 seconds, meaning, that the escort will orbit forever until a sequent command is given.
 -- @param #string MenuTextFormat Optional parameter that shows the menu option text. The text string is formatted, and should contain two %d tokens in the string. The first for the Height, the second for the Time (if given). If no text is given, the default text will be displayed.
 -- @return #ESCORT
 -- TODO: Implement Seconds parameter. Challenge is to first develop the "continue from last activity" function.
@@ -342,7 +332,7 @@ function ESCORT:MenuHoldAtEscortPosition( Height, Seconds, MenuTextFormat )
   if self.EscortGroup:IsAir() then
 
     if not self.EscortMenuHold then
-      self.EscortMenuHold = MENU_GROUP:New( self.EscortClient:GetGroup(), "Hold position", self.EscortMenu )
+      self.EscortMenuHold = MENU_CLIENT:New( self.EscortClient, "Hold position", self.EscortMenu )
     end
 
     if not Height then
@@ -372,9 +362,9 @@ function ESCORT:MenuHoldAtEscortPosition( Height, Seconds, MenuTextFormat )
       self.EscortMenuHoldPosition = {}
     end
 
-    self.EscortMenuHoldPosition[#self.EscortMenuHoldPosition+1] = MENU_GROUP_COMMAND
+    self.EscortMenuHoldPosition[#self.EscortMenuHoldPosition+1] = MENU_CLIENT_COMMAND
       :New(
-        self.EscortClient:GetGroup(),
+        self.EscortClient,
         MenuText,
         self.EscortMenuHold,
         ESCORT._HoldPosition,
@@ -392,8 +382,8 @@ end
 --- Defines a menu slot to let the escort hold at the client position and stay low with a specified height during a specified time in seconds.
 -- This menu will appear under **Navigation**.
 -- @param #ESCORT self
--- @param DCS#Distance Height Optional parameter that sets the height in meters to let the escort orbit at the current location. The default value is 30 meters.
--- @param DCS#Time Seconds Optional parameter that lets the escort orbit at the current position for a specified time. (not implemented yet). The default value is 0 seconds, meaning, that the escort will orbit forever until a sequent command is given.
+-- @param Dcs.DCSTypes#Distance Height Optional parameter that sets the height in meters to let the escort orbit at the current location. The default value is 30 meters.
+-- @param Dcs.DCSTypes#Time Seconds Optional parameter that lets the escort orbit at the current position for a specified time. (not implemented yet). The default value is 0 seconds, meaning, that the escort will orbit forever until a sequent command is given.
 -- @param #string MenuTextFormat Optional parameter that shows the menu option text. The text string is formatted, and should contain one or two %d tokens in the string. The first for the Height, the second for the Time (if given). If no text is given, the default text will be displayed.
 -- @return #ESCORT
 -- TODO: Implement Seconds parameter. Challenge is to first develop the "continue from last activity" function.
@@ -403,7 +393,7 @@ function ESCORT:MenuHoldAtLeaderPosition( Height, Seconds, MenuTextFormat )
   if self.EscortGroup:IsAir() then
 
     if not self.EscortMenuHold then
-      self.EscortMenuHold = MENU_GROUP:New( self.EscortClient:GetGroup(), "Hold position", self.EscortMenu )
+      self.EscortMenuHold = MENU_CLIENT:New( self.EscortClient, "Hold position", self.EscortMenu )
     end
 
     if not Height then
@@ -433,9 +423,9 @@ function ESCORT:MenuHoldAtLeaderPosition( Height, Seconds, MenuTextFormat )
       self.EscortMenuHoldAtLeaderPosition = {}
     end
 
-    self.EscortMenuHoldAtLeaderPosition[#self.EscortMenuHoldAtLeaderPosition+1] = MENU_GROUP_COMMAND
+    self.EscortMenuHoldAtLeaderPosition[#self.EscortMenuHoldAtLeaderPosition+1] = MENU_CLIENT_COMMAND
       :New(
-        self.EscortClient:GetGroup(),
+        self.EscortClient,
         MenuText,
         self.EscortMenuHold,
         ESCORT._HoldPosition,
@@ -453,8 +443,8 @@ end
 --- Defines a menu slot to let the escort scan for targets at a certain height for a certain time in seconds.
 -- This menu will appear under **Scan targets**.
 -- @param #ESCORT self
--- @param DCS#Distance Height Optional parameter that sets the height in meters to let the escort orbit at the current location. The default value is 30 meters.
--- @param DCS#Time Seconds Optional parameter that lets the escort orbit at the current position for a specified time. (not implemented yet). The default value is 0 seconds, meaning, that the escort will orbit forever until a sequent command is given.
+-- @param Dcs.DCSTypes#Distance Height Optional parameter that sets the height in meters to let the escort orbit at the current location. The default value is 30 meters.
+-- @param Dcs.DCSTypes#Time Seconds Optional parameter that lets the escort orbit at the current position for a specified time. (not implemented yet). The default value is 0 seconds, meaning, that the escort will orbit forever until a sequent command is given.
 -- @param #string MenuTextFormat Optional parameter that shows the menu option text. The text string is formatted, and should contain one or two %d tokens in the string. The first for the Height, the second for the Time (if given). If no text is given, the default text will be displayed.
 -- @return #ESCORT
 function ESCORT:MenuScanForTargets( Height, Seconds, MenuTextFormat )
@@ -462,7 +452,7 @@ function ESCORT:MenuScanForTargets( Height, Seconds, MenuTextFormat )
 
   if self.EscortGroup:IsAir() then
     if not self.EscortMenuScan then
-      self.EscortMenuScan = MENU_GROUP:New( self.EscortClient:GetGroup(), "Scan for targets", self.EscortMenu )
+      self.EscortMenuScan = MENU_CLIENT:New( self.EscortClient, "Scan for targets", self.EscortMenu )
     end
 
     if not Height then
@@ -492,9 +482,9 @@ function ESCORT:MenuScanForTargets( Height, Seconds, MenuTextFormat )
       self.EscortMenuScanForTargets = {}
     end
 
-    self.EscortMenuScanForTargets[#self.EscortMenuScanForTargets+1] = MENU_GROUP_COMMAND
+    self.EscortMenuScanForTargets[#self.EscortMenuScanForTargets+1] = MENU_CLIENT_COMMAND
       :New(
-        self.EscortClient:GetGroup(),
+        self.EscortClient,
         MenuText,
         self.EscortMenuScan,
         ESCORT._ScanTargets,
@@ -518,7 +508,7 @@ function ESCORT:MenuFlare( MenuTextFormat )
   self:F()
 
   if not self.EscortMenuReportNavigation then
-    self.EscortMenuReportNavigation = MENU_GROUP:New( self.EscortClient:GetGroup(), "Navigation", self.EscortMenu )
+    self.EscortMenuReportNavigation = MENU_CLIENT:New( self.EscortClient, "Navigation", self.EscortMenu )
   end
 
   local MenuText = ""
@@ -529,11 +519,11 @@ function ESCORT:MenuFlare( MenuTextFormat )
   end
 
   if not self.EscortMenuFlare then
-    self.EscortMenuFlare = MENU_GROUP:New( self.EscortClient:GetGroup(), MenuText, self.EscortMenuReportNavigation, ESCORT._Flare, self )
-    self.EscortMenuFlareGreen  = MENU_GROUP_COMMAND:New( self.EscortClient:GetGroup(), "Release green flare",  self.EscortMenuFlare, ESCORT._Flare, self, FLARECOLOR.Green,  "Released a green flare!"   )
-    self.EscortMenuFlareRed    = MENU_GROUP_COMMAND:New( self.EscortClient:GetGroup(), "Release red flare",    self.EscortMenuFlare, ESCORT._Flare, self, FLARECOLOR.Red,    "Released a red flare!"     )
-    self.EscortMenuFlareWhite  = MENU_GROUP_COMMAND:New( self.EscortClient:GetGroup(), "Release white flare",  self.EscortMenuFlare, ESCORT._Flare, self, FLARECOLOR.White,  "Released a white flare!"   )
-    self.EscortMenuFlareYellow = MENU_GROUP_COMMAND:New( self.EscortClient:GetGroup(), "Release yellow flare", self.EscortMenuFlare, ESCORT._Flare, self, FLARECOLOR.Yellow, "Released a yellow flare!"  )
+    self.EscortMenuFlare = MENU_CLIENT:New( self.EscortClient, MenuText, self.EscortMenuReportNavigation, ESCORT._Flare, self )
+    self.EscortMenuFlareGreen  = MENU_CLIENT_COMMAND:New( self.EscortClient, "Release green flare",  self.EscortMenuFlare, ESCORT._Flare, self, FLARECOLOR.Green,  "Released a green flare!"   )
+    self.EscortMenuFlareRed    = MENU_CLIENT_COMMAND:New( self.EscortClient, "Release red flare",    self.EscortMenuFlare, ESCORT._Flare, self, FLARECOLOR.Red,    "Released a red flare!"     )
+    self.EscortMenuFlareWhite  = MENU_CLIENT_COMMAND:New( self.EscortClient, "Release white flare",  self.EscortMenuFlare, ESCORT._Flare, self, FLARECOLOR.White,  "Released a white flare!"   )
+    self.EscortMenuFlareYellow = MENU_CLIENT_COMMAND:New( self.EscortClient, "Release yellow flare", self.EscortMenuFlare, ESCORT._Flare, self, FLARECOLOR.Yellow, "Released a yellow flare!"  )
   end
 
   return self
@@ -551,7 +541,7 @@ function ESCORT:MenuSmoke( MenuTextFormat )
 
   if not self.EscortGroup:IsAir() then
     if not self.EscortMenuReportNavigation then
-      self.EscortMenuReportNavigation = MENU_GROUP:New( self.EscortClient:GetGroup(), "Navigation", self.EscortMenu )
+      self.EscortMenuReportNavigation = MENU_CLIENT:New( self.EscortClient, "Navigation", self.EscortMenu )
     end
 
     local MenuText = ""
@@ -562,12 +552,12 @@ function ESCORT:MenuSmoke( MenuTextFormat )
     end
 
     if not self.EscortMenuSmoke then
-      self.EscortMenuSmoke = MENU_GROUP:New( self.EscortClient:GetGroup(), "Smoke", self.EscortMenuReportNavigation, ESCORT._Smoke, self )
-      self.EscortMenuSmokeGreen  = MENU_GROUP_COMMAND:New( self.EscortClient:GetGroup(), "Release green smoke",  self.EscortMenuSmoke, ESCORT._Smoke, self, SMOKECOLOR.Green,  "Releasing green smoke!"   )
-      self.EscortMenuSmokeRed    = MENU_GROUP_COMMAND:New( self.EscortClient:GetGroup(), "Release red smoke",    self.EscortMenuSmoke, ESCORT._Smoke, self, SMOKECOLOR.Red,    "Releasing red smoke!"     )
-      self.EscortMenuSmokeWhite  = MENU_GROUP_COMMAND:New( self.EscortClient:GetGroup(), "Release white smoke",  self.EscortMenuSmoke, ESCORT._Smoke, self, SMOKECOLOR.White,  "Releasing white smoke!"   )
-      self.EscortMenuSmokeOrange = MENU_GROUP_COMMAND:New( self.EscortClient:GetGroup(), "Release orange smoke", self.EscortMenuSmoke, ESCORT._Smoke, self, SMOKECOLOR.Orange, "Releasing orange smoke!"  )
-      self.EscortMenuSmokeBlue   = MENU_GROUP_COMMAND:New( self.EscortClient:GetGroup(), "Release blue smoke",   self.EscortMenuSmoke, ESCORT._Smoke, self, SMOKECOLOR.Blue,   "Releasing blue smoke!"    )
+      self.EscortMenuSmoke = MENU_CLIENT:New( self.EscortClient, "Smoke", self.EscortMenuReportNavigation, ESCORT._Smoke, self )
+      self.EscortMenuSmokeGreen  = MENU_CLIENT_COMMAND:New( self.EscortClient, "Release green smoke",  self.EscortMenuSmoke, ESCORT._Smoke, self, SMOKECOLOR.Green,  "Releasing green smoke!"   )
+      self.EscortMenuSmokeRed    = MENU_CLIENT_COMMAND:New( self.EscortClient, "Release red smoke",    self.EscortMenuSmoke, ESCORT._Smoke, self, SMOKECOLOR.Red,    "Releasing red smoke!"     )
+      self.EscortMenuSmokeWhite  = MENU_CLIENT_COMMAND:New( self.EscortClient, "Release white smoke",  self.EscortMenuSmoke, ESCORT._Smoke, self, SMOKECOLOR.White,  "Releasing white smoke!"   )
+      self.EscortMenuSmokeOrange = MENU_CLIENT_COMMAND:New( self.EscortClient, "Release orange smoke", self.EscortMenuSmoke, ESCORT._Smoke, self, SMOKECOLOR.Orange, "Releasing orange smoke!"  )
+      self.EscortMenuSmokeBlue   = MENU_CLIENT_COMMAND:New( self.EscortClient, "Release blue smoke",   self.EscortMenuSmoke, ESCORT._Smoke, self, SMOKECOLOR.Blue,   "Releasing blue smoke!"    )
     end
   end
 
@@ -578,13 +568,13 @@ end
 -- This menu will appear under **Report targets**.
 -- Note that if a report targets menu is not specified, no targets will be detected by the escort, and the attack and assisted attack menus will not be displayed.
 -- @param #ESCORT self
--- @param DCS#Time Seconds Optional parameter that lets the escort report their current detected targets after specified time interval in seconds. The default time is 30 seconds.
+-- @param Dcs.DCSTypes#Time Seconds Optional parameter that lets the escort report their current detected targets after specified time interval in seconds. The default time is 30 seconds.
 -- @return #ESCORT
 function ESCORT:MenuReportTargets( Seconds )
   self:F( { Seconds } )
 
   if not self.EscortMenuReportNearbyTargets then
-    self.EscortMenuReportNearbyTargets = MENU_GROUP:New( self.EscortClient:GetGroup(), "Report targets", self.EscortMenu )
+    self.EscortMenuReportNearbyTargets = MENU_CLIENT:New( self.EscortClient, "Report targets", self.EscortMenu )
   end
 
   if not Seconds then
@@ -592,12 +582,12 @@ function ESCORT:MenuReportTargets( Seconds )
   end
 
   -- Report Targets
-  self.EscortMenuReportNearbyTargetsNow = MENU_GROUP_COMMAND:New( self.EscortClient:GetGroup(), "Report targets now!", self.EscortMenuReportNearbyTargets, ESCORT._ReportNearbyTargetsNow, self )
-  self.EscortMenuReportNearbyTargetsOn = MENU_GROUP_COMMAND:New( self.EscortClient:GetGroup(), "Report targets on", self.EscortMenuReportNearbyTargets, ESCORT._SwitchReportNearbyTargets, self, true )
-  self.EscortMenuReportNearbyTargetsOff = MENU_GROUP_COMMAND:New( self.EscortClient:GetGroup(), "Report targets off", self.EscortMenuReportNearbyTargets, ESCORT._SwitchReportNearbyTargets, self, false )
+  self.EscortMenuReportNearbyTargetsNow = MENU_CLIENT_COMMAND:New( self.EscortClient, "Report targets now!", self.EscortMenuReportNearbyTargets, ESCORT._ReportNearbyTargetsNow, self )
+  self.EscortMenuReportNearbyTargetsOn = MENU_CLIENT_COMMAND:New( self.EscortClient, "Report targets on", self.EscortMenuReportNearbyTargets, ESCORT._SwitchReportNearbyTargets, self, true )
+  self.EscortMenuReportNearbyTargetsOff = MENU_CLIENT_COMMAND:New( self.EscortClient, "Report targets off", self.EscortMenuReportNearbyTargets, ESCORT._SwitchReportNearbyTargets, self, false )
 
   -- Attack Targets
-  self.EscortMenuAttackNearbyTargets = MENU_GROUP:New( self.EscortClient:GetGroup(), "Attack targets", self.EscortMenu )
+  self.EscortMenuAttackNearbyTargets = MENU_CLIENT:New( self.EscortClient, "Attack targets", self.EscortMenu )
 
 
   self.ReportTargetsScheduler = SCHEDULER:New( self, self._ReportTargetsScheduler, {}, 1, Seconds )
@@ -615,7 +605,7 @@ function ESCORT:MenuAssistedAttack()
 
   -- Request assistance from other escorts.
   -- This is very useful to let f.e. an escorting ship attack a target detected by an escorting plane...
-  self.EscortMenuTargetAssistance = MENU_GROUP:New( self.EscortClient:GetGroup(), "Request assistance from", self.EscortMenu )
+  self.EscortMenuTargetAssistance = MENU_CLIENT:New( self.EscortClient, "Request assistance from", self.EscortMenu )
 
   return self
 end
@@ -629,18 +619,18 @@ function ESCORT:MenuROE( MenuTextFormat )
 
   if not self.EscortMenuROE then
     -- Rules of Engagement
-    self.EscortMenuROE = MENU_GROUP:New( self.EscortClient:GetGroup(), "ROE", self.EscortMenu )
+    self.EscortMenuROE = MENU_CLIENT:New( self.EscortClient, "ROE", self.EscortMenu )
     if self.EscortGroup:OptionROEHoldFirePossible() then
-      self.EscortMenuROEHoldFire = MENU_GROUP_COMMAND:New( self.EscortClient:GetGroup(), "Hold Fire", self.EscortMenuROE, ESCORT._ROE, self, self.EscortGroup:OptionROEHoldFire(), "Holding weapons!" )
+      self.EscortMenuROEHoldFire = MENU_CLIENT_COMMAND:New( self.EscortClient, "Hold Fire", self.EscortMenuROE, ESCORT._ROE, self, self.EscortGroup:OptionROEHoldFire(), "Holding weapons!" )
     end
     if self.EscortGroup:OptionROEReturnFirePossible() then
-      self.EscortMenuROEReturnFire = MENU_GROUP_COMMAND:New( self.EscortClient:GetGroup(), "Return Fire", self.EscortMenuROE, ESCORT._ROE, self, self.EscortGroup:OptionROEReturnFire(), "Returning fire!" )
+      self.EscortMenuROEReturnFire = MENU_CLIENT_COMMAND:New( self.EscortClient, "Return Fire", self.EscortMenuROE, ESCORT._ROE, self, self.EscortGroup:OptionROEReturnFire(), "Returning fire!" )
     end
     if self.EscortGroup:OptionROEOpenFirePossible() then
-      self.EscortMenuROEOpenFire = MENU_GROUP_COMMAND:New( self.EscortClient:GetGroup(), "Open Fire", self.EscortMenuROE, ESCORT._ROE, self, self.EscortGroup:OptionROEOpenFire(), "Opening fire on designated targets!!" )
+      self.EscortMenuROEOpenFire = MENU_CLIENT_COMMAND:New( self.EscortClient, "Open Fire", self.EscortMenuROE, ESCORT._ROE, self, self.EscortGroup:OptionROEOpenFire(), "Opening fire on designated targets!!" )
     end
     if self.EscortGroup:OptionROEWeaponFreePossible() then
-      self.EscortMenuROEWeaponFree = MENU_GROUP_COMMAND:New( self.EscortClient:GetGroup(), "Weapon Free", self.EscortMenuROE, ESCORT._ROE, self, self.EscortGroup:OptionROEWeaponFree(), "Opening fire on targets of opportunity!" )
+      self.EscortMenuROEWeaponFree = MENU_CLIENT_COMMAND:New( self.EscortClient, "Weapon Free", self.EscortMenuROE, ESCORT._ROE, self, self.EscortGroup:OptionROEWeaponFree(), "Opening fire on targets of opportunity!" )
     end
   end
 
@@ -658,18 +648,18 @@ function ESCORT:MenuEvasion( MenuTextFormat )
   if self.EscortGroup:IsAir() then
     if not self.EscortMenuEvasion then
       -- Reaction to Threats
-      self.EscortMenuEvasion = MENU_GROUP:New( self.EscortClient:GetGroup(), "Evasion", self.EscortMenu )
+      self.EscortMenuEvasion = MENU_CLIENT:New( self.EscortClient, "Evasion", self.EscortMenu )
       if self.EscortGroup:OptionROTNoReactionPossible() then
-        self.EscortMenuEvasionNoReaction = MENU_GROUP_COMMAND:New( self.EscortClient:GetGroup(), "Fight until death", self.EscortMenuEvasion, ESCORT._ROT, self, self.EscortGroup:OptionROTNoReaction(), "Fighting until death!" )
+        self.EscortMenuEvasionNoReaction = MENU_CLIENT_COMMAND:New( self.EscortClient, "Fight until death", self.EscortMenuEvasion, ESCORT._ROT, self, self.EscortGroup:OptionROTNoReaction(), "Fighting until death!" )
       end
       if self.EscortGroup:OptionROTPassiveDefensePossible() then
-        self.EscortMenuEvasionPassiveDefense = MENU_GROUP_COMMAND:New( self.EscortClient:GetGroup(), "Use flares, chaff and jammers", self.EscortMenuEvasion, ESCORT._ROT, self, self.EscortGroup:OptionROTPassiveDefense(), "Defending using jammers, chaff and flares!" )
+        self.EscortMenuEvasionPassiveDefense = MENU_CLIENT_COMMAND:New( self.EscortClient, "Use flares, chaff and jammers", self.EscortMenuEvasion, ESCORT._ROT, self, self.EscortGroup:OptionROTPassiveDefense(), "Defending using jammers, chaff and flares!" )
       end
       if self.EscortGroup:OptionROTEvadeFirePossible() then
-        self.EscortMenuEvasionEvadeFire = MENU_GROUP_COMMAND:New( self.EscortClient:GetGroup(), "Evade enemy fire", self.EscortMenuEvasion, ESCORT._ROT, self, self.EscortGroup:OptionROTEvadeFire(), "Evading on enemy fire!" )
+        self.EscortMenuEvasionEvadeFire = MENU_CLIENT_COMMAND:New( self.EscortClient, "Evade enemy fire", self.EscortMenuEvasion, ESCORT._ROT, self, self.EscortGroup:OptionROTEvadeFire(), "Evading on enemy fire!" )
       end
       if self.EscortGroup:OptionROTVerticalPossible() then
-        self.EscortMenuOptionEvasionVertical = MENU_GROUP_COMMAND:New( self.EscortClient:GetGroup(), "Go below radar and evade fire", self.EscortMenuEvasion, ESCORT._ROT, self, self.EscortGroup:OptionROTVertical(), "Evading on enemy fire with vertical manoeuvres!" )
+        self.EscortMenuOptionEvasionVertical = MENU_CLIENT_COMMAND:New( self.EscortClient, "Go below radar and evade fire", self.EscortMenuEvasion, ESCORT._ROT, self, self.EscortGroup:OptionROTVertical(), "Evading on enemy fire with vertical manoeuvres!" )
       end
     end
   end
@@ -686,7 +676,7 @@ function ESCORT:MenuResumeMission()
 
   if not self.EscortMenuResumeMission then
     -- Mission Resume Menu Root
-    self.EscortMenuResumeMission = MENU_GROUP:New( self.EscortClient:GetGroup(), "Resume mission from", self.EscortMenu )
+    self.EscortMenuResumeMission = MENU_CLIENT:New( self.EscortClient, "Resume mission from", self.EscortMenu )
   end
 
   return self
@@ -748,7 +738,7 @@ end
 -- @param Functional.Escort#ESCORT self
 -- @param Wrapper.Group#GROUP EscortGroup
 -- @param Wrapper.Client#CLIENT EscortClient
--- @param DCS#Distance Distance
+-- @param Dcs.DCSTypes#Distance Distance
 function ESCORT:JoinUpAndFollow( EscortGroup, EscortClient, Distance )
   self:F( { EscortGroup, EscortClient, Distance } )
 
@@ -857,11 +847,11 @@ function _Resume( EscortGroup )
 end
 
 --- @param #ESCORT self
--- @param Functional.Detection#DETECTION_BASE.DetectedItem DetectedItem
-function ESCORT:_AttackTarget( DetectedItem )
+-- @param #number DetectedItemID
+function ESCORT:_AttackTarget( DetectedItemID )
 
   local EscortGroup = self.EscortGroup -- Wrapper.Group#GROUP
-  self:F( EscortGroup )
+  self:E( EscortGroup )
   
   local EscortClient = self.EscortClient
 
@@ -872,7 +862,7 @@ function ESCORT:_AttackTarget( DetectedItem )
     EscortGroup:OptionROTPassiveDefense()
     EscortGroup:SetState( EscortGroup, "Escort", self )
 
-    local DetectedSet = self.Detection:GetDetectedSet( DetectedItem )
+    local DetectedSet = self.Detection:GetDetectedSet( DetectedItemID )
     
     local Tasks = {}
 
@@ -895,7 +885,7 @@ function ESCORT:_AttackTarget( DetectedItem )
     
   else
   
-    local DetectedSet = self.Detection:GetDetectedSet( DetectedItem )
+    local DetectedSet = self.Detection:GetDetectedSet( DetectedItemID )
     
     local Tasks = {}
 
@@ -921,9 +911,8 @@ function ESCORT:_AttackTarget( DetectedItem )
 end
 
 --- 
---- @param #ESCORT self
--- @param Functional.Detection#DETECTION_BASE.DetectedItem DetectedItem
-function ESCORT:_AssistTarget( EscortGroupAttack, DetectedItem )
+-- @param #number DetectedItemID
+function ESCORT:_AssistTarget( EscortGroupAttack, DetectedItemID )
 
   local EscortGroup = self.EscortGroup
   local EscortClient = self.EscortClient
@@ -934,7 +923,7 @@ function ESCORT:_AssistTarget( EscortGroupAttack, DetectedItem )
     EscortGroupAttack:OptionROEOpenFire()
     EscortGroupAttack:OptionROTVertical()
     
-    local DetectedSet = self.Detection:GetDetectedSet( DetectedItem )
+    local DetectedSet = self.Detection:GetDetectedSet( DetectedItemID )
     
     local Tasks = {}
 
@@ -956,7 +945,7 @@ function ESCORT:_AssistTarget( EscortGroupAttack, DetectedItem )
     )
 
   else
-    local DetectedSet = self.Detection:GetDetectedSet( DetectedItem )
+    local DetectedSet = self.Detection:GetDetectedSet( DetectedItemID )
     
     local Tasks = {}
 
@@ -1163,7 +1152,7 @@ function ESCORT:_ReportTargetsScheduler()
       end
 
       local DetectedItems = self.Detection:GetDetectedItems()
-      self:F( DetectedItems )
+      self:E( DetectedItems )
 
       local DetectedTargets = false
   
@@ -1174,11 +1163,11 @@ function ESCORT:_ReportTargetsScheduler()
         local ClientEscortTargets = EscortGroupData.Detection
         --local EscortUnit = EscortGroupData:GetUnit( 1 )
 
-        for DetectedItemIndex, DetectedItem in pairs( DetectedItems ) do
-          self:F( { DetectedItemIndex, DetectedItem } )
+        for DetectedItemID, DetectedItem in pairs( DetectedItems ) do
+          self:E( { DetectedItemID, DetectedItem } )
           -- Remove the sub menus of the Attack menu of the Escort for the EscortGroup.
   
-          local DetectedItemReportSummary = self.Detection:DetectedItemReportSummary( DetectedItem, EscortGroupData.EscortGroup, _DATABASE:GetPlayerSettings( self.EscortClient:GetPlayerName() ) )
+          local DetectedItemReportSummary = self.Detection:DetectedItemReportSummary( DetectedItemID, EscortGroupData.EscortGroup, _DATABASE:GetPlayerSettings( self.EscortClient:GetPlayerName() ) )
 
           if ClientEscortGroupName == EscortGroupName then
           
@@ -1187,12 +1176,12 @@ function ESCORT:_ReportTargetsScheduler()
 
             self:T( DetectedMsg )
   
-            MENU_GROUP_COMMAND:New( self.EscortClient:GetGroup(),
+            MENU_CLIENT_COMMAND:New( self.EscortClient,
               DetectedMsg,
               self.EscortMenuAttackNearbyTargets,
               ESCORT._AttackTarget,
               self,
-              DetectedItem
+              DetectedItemID
             )
           else
             if self.EscortMenuTargetAssistance then
@@ -1200,14 +1189,14 @@ function ESCORT:_ReportTargetsScheduler()
               local DetectedMsg = DetectedItemReportSummary:Text("\n")
               self:T( DetectedMsg )
 
-              local MenuTargetAssistance = MENU_GROUP:New( self.EscortClient:GetGroup(), EscortGroupData.EscortName, self.EscortMenuTargetAssistance )
-              MENU_GROUP_COMMAND:New( self.EscortClient:GetGroup(),
+              local MenuTargetAssistance = MENU_CLIENT:New( self.EscortClient, EscortGroupData.EscortName, self.EscortMenuTargetAssistance )
+              MENU_CLIENT_COMMAND:New( self.EscortClient,
                 DetectedMsg,
                 MenuTargetAssistance,
                 ESCORT._AssistTarget,
                 self,
                 EscortGroupData.EscortGroup,
-                DetectedItem
+                DetectedItemID
               )
             end
           end
@@ -1216,7 +1205,7 @@ function ESCORT:_ReportTargetsScheduler()
                   
         end
       end
-      self:F( DetectedMsgs )
+      self:E( DetectedMsgs )
       if DetectedTargets then
         self.EscortGroup:MessageToClient( "Reporting detected targets:\n" .. table.concat( DetectedMsgs, "\n" ), 20, self.EscortClient )
       else
@@ -1338,7 +1327,7 @@ function ESCORT:_ReportTargetsScheduler()
 --  
 --              if ClientEscortGroupName == EscortGroupName then
 --  
---                MENU_GROUP_COMMAND:New( self.EscortClient,
+--                MENU_CLIENT_COMMAND:New( self.EscortClient,
 --                  EscortTargetMessage,
 --                  self.EscortMenuAttackNearbyTargets,
 --                  ESCORT._AttackTarget,
@@ -1349,8 +1338,8 @@ function ESCORT:_ReportTargetsScheduler()
 --                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,
+--                  local MenuTargetAssistance = MENU_CLIENT:New( self.EscortClient, EscortGroupData.EscortName, self.EscortMenuTargetAssistance )
+--                  MENU_CLIENT_COMMAND:New( self.EscortClient,
 --                    EscortTargetMessage,
 --                    MenuTargetAssistance,
 --                    ESCORT._AssistTarget,
@@ -1389,7 +1378,7 @@ function ESCORT:_ReportTargetsScheduler()
 --          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 } )
+--          MENU_CLIENT_COMMAND:New( self.EscortClient, "Waypoint " .. WayPointID .. " at " .. string.format( "%.2f", Distance ).. "km", self.EscortMenuResumeMission, ESCORT._ResumeMission, { ParamSelf = self, ParamWayPoint = WayPointID } )
 --        end
 --      end
 --  

Moose Development/Moose/Functional/MissileTrainer.lua

@@ -1,27 +1,20 @@
---- **Functional** -- Train missile defence and deflection.
+--- **Functional** -- MISSILETRAINER helps you to train missile avoidance.
 -- 
 -- ===
 --
--- ## Features:
--- 
---   * Track the missiles fired at you and other players, providing bearing and range information of the missiles towards the airplanes.
---   * Provide alerts of missile launches, including detailed information of the units launching, including bearing, range <20>
---   * Provide alerts when a missile would have killed your aircraft.
---   * Provide alerts when the missile self destructs.
---   * Enable / Disable and Configure the Missile Trainer using the various menu options.
--- 
--- ===
--- 
--- ## Missions:
--- 
--- [MIT - Missile Trainer](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/MIT%20-%20Missile%20Trainer)
--- 
--- ===
--- 
--- Uses the MOOSE messaging system to be alerted of any missiles fired, and when a missile would hit your aircraft,
+-- 1) @{MissileTrainer#MISSILETRAINER} class, extends @{Base#BASE}
+-- ===============================================================
+-- The @{#MISSILETRAINER} class uses the DCS world messaging system to be alerted of any missiles fired, and when a missile would hit your aircraft,
 -- the class will destroy the missile within a certain range, to avoid damage to your aircraft.
+-- It suports the following functionality:
+--
+--  * Track the missiles fired at you and other players, providing bearing and range information of the missiles towards the airplanes.
+--  * Provide alerts of missile launches, including detailed information of the units launching, including bearing, range <20>
+--  * Provide alerts when a missile would have killed your aircraft.
+--  * Provide alerts when the missile self destructs.
+--  * Enable / Disable and Configure the Missile Trainer using the various menu options.
 --  
--- When running a mission where the missile trainer is used, the following radio menu structure ( 'Radio Menu' -> 'Other (F10)' -> 'MissileTrainer' ) options are available for the players:
+--  When running a mission where MISSILETRAINER 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.
@@ -51,40 +44,17 @@
 --     * **150 meter**: Destroys the missile when the distance to the aircraft is below or equal to 150 meter.
 --     * **200 meter**: Destroys the missile when the distance to the aircraft is below or equal to 200 meter.
 --   
--- ===
--- 
--- ### Authors: **FlightControl**
--- 
--- ### Contributions:
--- 
---    * **Stuka (Danny)**: Who you can search on the Eagle Dynamics Forums. Working together with Danny has resulted in the MISSILETRAINER class.  
---      Danny has shared his ideas and together we made a design. 
---      Together with the **476 virtual team**, we tested the MISSILETRAINER class, and got much positive feedback!
---    * **132nd Squadron**: Testing and optimizing the logic.
--- 
--- ===
 --
--- @module Functional.MissileTrainer
--- @image Missile_Trainer.JPG
-
-
---- @type MISSILETRAINER
--- @field Core.Set#SET_CLIENT DBClients
--- @extends Core.Base#BASE
-
-
----
---
--- # Constructor:
--- 
+-- 1.1) MISSILETRAINER construction methods:
+-- -----------------------------------------
 -- 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:
--- 
+-- 1.2) MISSILETRAINER initialization methods:
+-- -------------------------------------------
 -- 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.
@@ -97,8 +67,24 @@
 --  * @{#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.
+--
+-- ===
 -- 
--- @field #MISSILETRAINER 
+-- CREDITS
+-- =======
+-- **Stuka (Danny)** Who you can search on the Eagle Dynamics Forums.
+-- Working together with Danny has resulted in the MISSILETRAINER class. 
+-- Danny has shared his ideas and together we made a design. 
+-- Together with the **476 virtual team**, we tested the MISSILETRAINER class, and got much positive feedback!
+-- 
+-- @module MissileTrainer
+-- @author FlightControl
+
+
+--- The MISSILETRAINER class
+-- @type MISSILETRAINER
+-- @field Core.Set#SET_CLIENT DBClients
+-- @extends Core.Base#BASE
 MISSILETRAINER = {
   ClassName = "MISSILETRAINER",
   TrackingMissiles = {},
@@ -113,39 +99,39 @@ function MISSILETRAINER._Alive( Client, self )
   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.MainMenu = MENU_CLIENT:New( Client, "Missile Trainer", nil ) -- Menu#MENU_CLIENT
 
-    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.MenuMessages = MENU_CLIENT:New( Client, "Messages", Client.MainMenu )
+    Client.MenuOn = MENU_CLIENT_COMMAND:New( Client, "Messages On", Client.MenuMessages, self._MenuMessages, { MenuSelf = self, MessagesOnOff = true } )
+    Client.MenuOff = MENU_CLIENT_COMMAND:New( Client, "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.MenuTracking = MENU_CLIENT:New( Client, "Tracking", Client.MainMenu )
+    Client.MenuTrackingToAll = MENU_CLIENT_COMMAND:New( Client, "To All", Client.MenuTracking, self._MenuMessages, { MenuSelf = self, TrackingToAll = true } )
+    Client.MenuTrackingToTarget = MENU_CLIENT_COMMAND:New( Client, "To Target", Client.MenuTracking, self._MenuMessages, { MenuSelf = self, TrackingToAll = false } )
+    Client.MenuTrackOn = MENU_CLIENT_COMMAND:New( Client, "Tracking On", Client.MenuTracking, self._MenuMessages, { MenuSelf = self, TrackingOnOff = true } )
+    Client.MenuTrackOff = MENU_CLIENT_COMMAND:New( Client, "Tracking Off", Client.MenuTracking, self._MenuMessages, { MenuSelf = self, TrackingOnOff = false } )
+    Client.MenuTrackIncrease = MENU_CLIENT_COMMAND:New( Client, "Frequency Increase", Client.MenuTracking, self._MenuMessages, { MenuSelf = self, TrackingFrequency = -1 } )
+    Client.MenuTrackDecrease = MENU_CLIENT_COMMAND:New( Client, "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.MenuAlerts = MENU_CLIENT:New( Client, "Alerts", Client.MainMenu )
+    Client.MenuAlertsToAll = MENU_CLIENT_COMMAND:New( Client, "To All", Client.MenuAlerts, self._MenuMessages, { MenuSelf = self, AlertsToAll = true } )
+    Client.MenuAlertsToTarget = MENU_CLIENT_COMMAND:New( Client, "To Target", Client.MenuAlerts, self._MenuMessages, { MenuSelf = self, AlertsToAll = false } )
+    Client.MenuHitsOn = MENU_CLIENT_COMMAND:New( Client, "Hits On", Client.MenuAlerts, self._MenuMessages, { MenuSelf = self, AlertsHitsOnOff = true } )
+    Client.MenuHitsOff = MENU_CLIENT_COMMAND:New( Client, "Hits Off", Client.MenuAlerts, self._MenuMessages, { MenuSelf = self, AlertsHitsOnOff = false } )
+    Client.MenuLaunchesOn = MENU_CLIENT_COMMAND:New( Client, "Launches On", Client.MenuAlerts, self._MenuMessages, { MenuSelf = self, AlertsLaunchesOnOff = true } )
+    Client.MenuLaunchesOff = MENU_CLIENT_COMMAND:New( Client, "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.MenuDetails = MENU_CLIENT:New( Client, "Details", Client.MainMenu )
+    Client.MenuDetailsDistanceOn = MENU_CLIENT_COMMAND:New( Client, "Range On", Client.MenuDetails, self._MenuMessages, { MenuSelf = self, DetailsRangeOnOff = true } )
+    Client.MenuDetailsDistanceOff = MENU_CLIENT_COMMAND:New( Client, "Range Off", Client.MenuDetails, self._MenuMessages, { MenuSelf = self, DetailsRangeOnOff = false } )
+    Client.MenuDetailsBearingOn = MENU_CLIENT_COMMAND:New( Client, "Bearing On", Client.MenuDetails, self._MenuMessages, { MenuSelf = self, DetailsBearingOnOff = true } )
+    Client.MenuDetailsBearingOff = MENU_CLIENT_COMMAND:New( Client, "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 } )
+    Client.MenuDistance = MENU_CLIENT:New( Client, "Set distance to plane", Client.MainMenu )
+    Client.MenuDistance50 = MENU_CLIENT_COMMAND:New( Client, "50 meter", Client.MenuDistance, self._MenuMessages, { MenuSelf = self, Distance = 50 / 1000 } )
+    Client.MenuDistance100 = MENU_CLIENT_COMMAND:New( Client, "100 meter", Client.MenuDistance, self._MenuMessages, { MenuSelf = self, Distance = 100 / 1000 } )
+    Client.MenuDistance150 = MENU_CLIENT_COMMAND:New( Client, "150 meter", Client.MenuDistance, self._MenuMessages, { MenuSelf = self, Distance = 150 / 1000 } )
+    Client.MenuDistance200 = MENU_CLIENT_COMMAND:New( Client, "200 meter", Client.MenuDistance, self._MenuMessages, { MenuSelf = self, Distance = 200 / 1000 } )
   else
     if Client.MainMenu then
       Client.MainMenu:Remove()
@@ -191,13 +177,13 @@ function MISSILETRAINER:New( Distance, Briefing )
 
 
 --  for ClientID, Client in pairs( self.DBClients.Database ) do
---      self:F( "ForEach:" .. Client.UnitName )
+--      self:E( "ForEach:" .. Client.UnitName )
 --      Client:Alive( self._Alive, self )
 --  end
 --  
   self.DBClients:ForEachClient( 
     function( Client )
-      self:F( "ForEach:" .. Client.UnitName )
+      self:E( "ForEach:" .. Client.UnitName )
       Client:Alive( self._Alive, self )
     end
   )

Moose Development/Moose/Functional/Movement.lua

@@ -1,20 +1,17 @@
---- **Functional** -- Limit the movement of simulaneous moving ground vehicles.
+--- **Functional** -- Limit the MOVEMENT of simulaneous moving ground vehicles.
 -- 
--- ===
+-- ====
 --  
 -- Limit the simultaneous movement of Groups within a running Mission.
 -- This module is defined to improve the performance in missions, and to bring additional realism for GROUND vehicles.
 -- Performance: If in a DCSRTE there are a lot of moving GROUND units, then in a multi player mission, this WILL create lag if
 -- the main DCS execution core of your CPU is fully utilized. So, this class will limit the amount of simultaneous moving GROUND units
 -- on defined intervals (currently every minute).
--- @module Functional.Movement
--- @image MOOSE.JPG
+-- @module Movement
 
---- @type MOVEMENT
+--- the MOVEMENT class
+-- @type MOVEMENT
 -- @extends Core.Base#BASE
-
----
---@field #MOVEMENT
 MOVEMENT = {
 	ClassName = "MOVEMENT",
 }

Moose Development/Moose/Functional/PseudoATC.lua

@@ -1,994 +0,0 @@
---- **Functional** - Rudimentary ATC.
---  
--- ![Banner Image](..\Presentations\PSEUDOATC\PSEUDOATC_Main.jpg)
--- 
--- ====
--- 
--- The pseudo ATC enhances the standard DCS ATC functions.
--- 
--- In particular, a menu entry "Pseudo ATC" is created in the "F10 Other..." radiomenu.
--- 
--- ## Features:
--- 
--- * Weather report at nearby airbases and mission waypoints.
--- * Report absolute bearing and range to nearest airports and mission waypoints.
--- * Report current altitude AGL of own aircraft.
--- * Upon request, ATC reports altitude until touchdown.
--- * Works with static and dynamic weather.
--- * Player can select the unit system (metric or imperial) in which information is reported.
--- * All maps supported (Caucasus, NTTR, Normandy, Persian Gulf and all future maps).
---  
--- ====
--- 
--- # YouTube Channel
--- 
--- ### [MOOSE YouTube Channel](https://www.youtube.com/channel/UCjrA9j5LQoWsG4SpS8i79Qg)
--- 
--- ===
--- 
--- ### Author: **[funkyfranky](https://forums.eagle.ru/member.php?u=115026)**
--- 
--- ### Contributions: [FlightControl](https://forums.eagle.ru/member.php?u=89536)
--- 
--- ====
--- @module Functional.PseudoATC
--- @image Pseudo_ATC.JPG
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
---- PSEUDOATC class
--- @type PSEUDOATC
--- @field #string ClassName Name of the Class.
--- @field #table player Table comprising each player info.
--- @field #boolean Debug If true, print debug info to dcs.log file.
--- @field #number mdur Duration in seconds how low messages to the player are displayed.
--- @field #number mrefresh Interval in seconds after which the F10 menu is refreshed. E.g. by the closest airports. Default is 120 sec.
--- @field #number talt Interval in seconds between reporting altitude until touchdown. Default 3 sec.
--- @field #boolean chatty Display some messages on events like take-off and touchdown.
--- @field #boolean eventsmoose If true, events are handled by MOOSE. If false, events are handled directly by DCS eventhandler.
--- @extends Core.Base#BASE
-
---- Adds some rudimentary ATC functionality via the radio menu.
--- 
--- Local weather reports can be requested for nearby airports and player's mission waypoints.
--- The weather report includes
--- 
--- * QFE and QNH pressures,
--- * Temperature,
--- * Wind direction and strength.
--- 
--- The list of airports is updated every 60 seconds. This interval can be adjusted by the function @{#PSEUDOATC.SetMenuRefresh}(*interval*).
--- 
--- Likewise, absolute bearing and range to the close by airports and mission waypoints can be requested.
--- 
--- The player can switch the unit system in which all information is displayed during the mission with the MOOSE settings radio menu.
--- The unit system can be set to either imperial or metric. Altitudes are reported in feet or meter, distances in kilometers or nautical miles,
--- temperatures in degrees Fahrenheit or Celsius and QFE/QNH pressues in inHg or mmHg.
--- Note that the pressures are also reported in hPa independent of the unit system setting.
--- 
--- In bad weather conditions, the ATC can "talk you down", i.e. will continuously report your altitude on the final approach.
--- Default reporting time interval is 3 seconds. This can be adjusted via the @{#PSEUDOATC.SetReportAltInterval}(*interval*) function.
--- The reporting stops automatically when the player lands or can be stopped manually by clicking on the radio menu item again.
--- So the radio menu item acts as a toggle to switch the reporting on and off.
--- 
--- ## Scripting
--- 
--- Scripting is almost trivial. Just add the following two lines to your script:
--- 
---     pseudoATC=PSEUDOATC:New()
---     pseudoATC:Start()
--- 
--- 
--- @field #PSEUDOATC
-PSEUDOATC={
-  ClassName = "PSEUDOATC",
-  player={},
-  Debug=false,
-  mdur=30,
-  mrefresh=120,
-  talt=3,
-  chatty=true,
-  eventsmoose=true,
-}
-
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- Some ID to identify who we are in output of the DCS.log file.
--- @field #string id
-PSEUDOATC.id="PseudoATC | "
-
---- PSEUDOATC version.
--- @field #number version
-PSEUDOATC.version="0.9.0"
-
------------------------------------------------------------------------------------------------------------------------------------------
-
--- TODO list
--- DONE: Add takeoff event.
--- DONE: Add user functions.
-
------------------------------------------------------------------------------------------------------------------------------------------
-
---- PSEUDOATC contructor.
--- @param #PSEUDOATC self
--- @return #PSEUDOATC Returns a PSEUDOATC object.
-function PSEUDOATC:New()
-
-  -- Inherit BASE.
-  local self=BASE:Inherit(self, BASE:New()) -- #PSEUDOATC
-  
-  -- Debug info
-  self:E(PSEUDOATC.id..string.format("PseudoATC version %s", PSEUDOATC.version))
-
-  -- Return object.
-  return self
-end
-
---- Starts the PseudoATC event handlers.
--- @param #PSEUDOATC self
-function PSEUDOATC:Start()
-  self:F()
-  
-  -- Debug info
-  self:E(PSEUDOATC.id.."Starting PseudoATC")
-  
-  -- Handle events.
-  if self.eventsmoose then
-    self:T(PSEUDOATC.id.."Events are handled by MOOSE.")
-    self:HandleEvent(EVENTS.Birth,           self._OnBirth)
-    self:HandleEvent(EVENTS.Land,            self._PlayerLanded)
-    self:HandleEvent(EVENTS.Takeoff,         self._PlayerTakeOff)
-    self:HandleEvent(EVENTS.PlayerLeaveUnit, self._PlayerLeft)
-    self:HandleEvent(EVENTS.Crash,           self._PlayerLeft)
-    --self:HandleEvent(EVENTS.Ejection,        self._PlayerLeft)
-    --self:HandleEvent(EVENTS.PilotDead,       self._PlayerLeft)
-  else
-    self:T(PSEUDOATC.id.."Events are handled by DCS.")
-    -- Events are handled directly by DCS.
-    world.addEventHandler(self)
-  end
-  
-end
-
------------------------------------------------------------------------------------------------------------------------------------------
--- User Functions
-
---- Debug mode on. Send messages to everone.
--- @param #PSEUDOATC self
-function PSEUDOATC:DebugOn()
-  self.Debug=true
-end
-
---- Debug mode off. This is the default setting.
--- @param #PSEUDOATC self
-function PSEUDOATC:DebugOff()
-  self.Debug=false
-end
-
---- Chatty mode on. Display some messages on take-off and touchdown.
--- @param #PSEUDOATC self
-function PSEUDOATC:ChattyOn()
-  self.chatty=true
-end
-
---- Chatty mode off. Don't display some messages on take-off and touchdown.
--- @param #PSEUDOATC self
-function PSEUDOATC:ChattyOff()
-  self.chatty=false
-end
-
---- Set duration how long messages are displayed.
--- @param #PSEUDOATC self
--- @param #number duration Time in seconds. Default is 30 sec.
-function PSEUDOATC:SetMessageDuration(duration)
-  self.mdur=duration or 30
-end
-
---- Set time interval after which the F10 radio menu is refreshed.
--- @param #PSEUDOATC self
--- @param #number interval Interval in seconds. Default is every 120 sec.
-function PSEUDOATC:SetMenuRefresh(interval)
-  self.mrefresh=interval or 120
-end
-
---- Enable/disable event handling by MOOSE or DCS.
--- @param #PSEUDOATC self
--- @param #boolean switch If true, events are handled by MOOSE (default). If false, events are handled directly by DCS.
-function PSEUDOATC:SetEventsMoose(switch)
-  self.eventsmoose=switch
-end
-
---- Set time interval for reporting altitude until touchdown.
--- @param #PSEUDOATC self
--- @param #number interval Interval in seconds. Default is every 3 sec.
-function PSEUDOATC:SetReportAltInterval(interval)
-  self.talt=interval or 3
-end
-
------------------------------------------------------------------------------------------------------------------------------------------
--- Event Handling
-
---- Event handler for suppressed groups.
---@param #PSEUDOATC self
---@param #table Event Event data table. Holds event.id, event.initiator and event.target etc.
-function PSEUDOATC:onEvent(Event)
-  if Event == nil or Event.initiator == nil or Unit.getByName(Event.initiator:getName()) == nil then
-    return true
-  end
-
-  local DCSiniunit  = Event.initiator
-  local DCSplace    = Event.place
-  local DCSsubplace = Event.subplace
-
-  local EventData={}
-  local _playerunit=nil
-  local _playername=nil
-  
-  if Event.initiator then
-    EventData.IniUnitName  = Event.initiator:getName()
-    EventData.IniDCSGroup  = Event.initiator:getGroup()
-    EventData.IniGroupName = Event.initiator:getGroup():getName()  
-    -- Get player unit and name. This returns nil,nil if the event was not fired by a player unit. And these are the only events we are interested in. 
-    _playerunit, _playername = self:_GetPlayerUnitAndName(EventData.IniUnitName)  
-  end
-
-  if Event.place then
-    EventData.Place=Event.place
-    EventData.PlaceName=Event.place:getName()
-  end
-  if Event.subplace then
-    EventData.SubPlace=Event.subplace
-    EventData.SubPlaceName=Event.subplace:getName()
-  end
-  
-  -- Event info.
-  self:T3(PSEUDOATC.id..string.format("EVENT: Event in onEvent with ID = %s", tostring(Event.id)))
-  self:T3(PSEUDOATC.id..string.format("EVENT: Ini unit   = %s" , tostring(EventData.IniUnitName)))
-  self:T3(PSEUDOATC.id..string.format("EVENT: Ini group  = %s" , tostring(EventData.IniGroupName)))
-  self:T3(PSEUDOATC.id..string.format("EVENT: Ini player = %s" , tostring(_playername)))
-  self:T3(PSEUDOATC.id..string.format("EVENT: Place      = %s" , tostring(EventData.PlaceName)))
-  self:T3(PSEUDOATC.id..string.format("EVENT: SubPlace   = %s" , tostring(EventData.SubPlaceName)))
-  
-  -- Event birth.
-  if Event.id == world.event.S_EVENT_BIRTH and _playername then
-    self:_OnBirth(EventData)
-  end
-  
-  -- Event takeoff.
-  if Event.id == world.event.S_EVENT_TAKEOFF and _playername and EventData.Place then
-    self:_PlayerTakeOff(EventData)
-  end
-  
-  -- Event land.
-  if Event.id == world.event.S_EVENT_LAND and _playername and EventData.Place then
-    self:_PlayerLanded(EventData)
-  end
-  
-  -- Event player left unit
-  if Event.id == world.event.S_EVENT_PLAYER_LEAVE_UNIT and _playername then
-    self:_PlayerLeft(EventData)
-  end
-
-  -- Event crash ==> player left unit
-  if Event.id == world.event.S_EVENT_CRASH and _playername then
-    self:_PlayerLeft(EventData)
-  end
-
---[[
-  -- Event eject ==> player left unit
-  if Event.id == world.event.S_EVENT_EJECTION and _playername then
-    self:_PlayerLeft(EventData)
-  end
-
-  -- Event pilot dead ==> player left unit
-  if Event.id == world.event.S_EVENT_PILOT_DEAD and _playername then
-    self:_PlayerLeft(EventData)
-  end
-]]    
-end
-
---- Function called my MOOSE event handler when a player enters a unit.
--- @param #PSEUDOATC self
--- @param Core.Event#EVENTDATA EventData
-function PSEUDOATC:_OnBirth(EventData)
-  self:F({EventData=EventData})
-  
-  -- Get unit and player.
-  local _unitName=EventData.IniUnitName  
-  local _unit, _playername=self:_GetPlayerUnitAndName(_unitName)
-  
-  -- Check if a player entered.
-  if _unit and _playername then
-    self:PlayerEntered(_unit)
-  end               
- 
-end
-
---- Function called by MOOSE event handler when a player leaves a unit or dies. 
--- @param #PSEUDOATC self
--- @param Core.Event#EVENTDATA EventData
-function PSEUDOATC:_PlayerLeft(EventData)
-  self:F({EventData=EventData})
-
-  -- Get unit and player.
-  local _unitName=EventData.IniUnitName  
-  local _unit, _playername=self:_GetPlayerUnitAndName(_unitName)
-  
-  -- Check if a player left.
-  if _unit and _playername then
-    self:PlayerLeft(_unit)
-  end
-end
-
---- Function called by MOOSE event handler when a player landed. 
--- @param #PSEUDOATC self
--- @param Core.Event#EVENTDATA EventData
-function PSEUDOATC:_PlayerLanded(EventData)
-  self:F({EventData=EventData})
-
-  -- Get unit, player and place.
-  local _unitName=EventData.IniUnitName  
-  local _unit, _playername=self:_GetPlayerUnitAndName(_unitName)
-  local _base=nil
-  local _baseName=nil
-  if EventData.place then
-    _base=EventData.place
-    _baseName=EventData.place:getName()
-  end
---  if EventData.subplace then
---    local _subPlace=EventData.subplace
---    local _subPlaceName=EventData.subplace:getName()
---  end
-  
-  -- Call landed function.
-  if _unit and _playername and _base then
-    self:PlayerLanded(_unit, _baseName)
-  end
-end
-
---- Function called by MOOSE/DCS event handler when a player took off. 
--- @param #PSEUDOATC self
--- @param Core.Event#EVENTDATA EventData
-function PSEUDOATC:_PlayerTakeOff(EventData)
-  self:F({EventData=EventData})
-
-  -- Get unit, player and place.
-  local _unitName=EventData.IniUnitName  
-  local _unit,_playername=self:_GetPlayerUnitAndName(_unitName)
-  local _base=nil
-  local _baseName=nil
-  if EventData.place then
-    _base=EventData.place
-    _baseName=EventData.place:getName()
-  end
-  
-  -- Call take-off function.
-  if _unit and _playername and _base then
-    self:PlayerTakeOff(_unit, _baseName)
-  end
-end
-
------------------------------------------------------------------------------------------------------------------------------------------
--- Event Functions
-
---- Function called when a player enters a unit.
--- @param #PSEUDOATC self
--- @param Wrapper.Unit#UNIT unit Unit the player entered.
-function PSEUDOATC:PlayerEntered(unit)
-  self:F2({unit=unit})
-
-  -- Get player info.
-  local group=unit:GetGroup() --Wrapper.Group#GROUP
-  local GID=group:GetID()
-  local GroupName=group:GetName()
-  local PlayerName=unit:GetPlayerName()
-  local UnitName=unit:GetName()
-  local CallSign=unit:GetCallsign()
-  
-  -- Init player table.  
-  self.player[GID]={}
-  self.player[GID].group=group
-  self.player[GID].unit=unit
-  self.player[GID].groupname=GroupName
-  self.player[GID].unitname=UnitName
-  self.player[GID].playername=PlayerName
-  self.player[GID].callsign=CallSign
-  self.player[GID].waypoints=group:GetTaskRoute()
-  
-  -- Info message.
-  local text=string.format("Player %s entered unit %s of group %s (id=%d).", PlayerName, UnitName, GroupName, GID)
-  self:T(PSEUDOATC.id..text)
-  MESSAGE:New(text, 30):ToAllIf(self.Debug)
-  
-  -- Create main F10 menu, i.e. "F10/Pseudo ATC"
-  self.player[GID].menu_main=missionCommands.addSubMenuForGroup(GID, "Pseudo ATC")
-    
-  -- Create/update list of nearby airports.
-  self:LocalAirports(GID)
-  
-  -- Create submenu of local airports.
-  self:MenuAirports(GID)
-  
-  -- Create submenu Waypoints.
-  self:MenuWaypoints(GID)
-  
-  -- Start scheduler to refresh the F10 menues.
-  self.player[GID].scheduler, self.player[GID].schedulerid=SCHEDULER:New(nil, self.MenuRefresh, {self, GID}, self.mrefresh, self.mrefresh)
- 
-end
-
---- Function called when a player has landed.
--- @param #PSEUDOATC self
--- @param Wrapper.Unit#UNIT unit Unit of player which has landed.
--- @param #string place Name of the place the player landed at.
-function PSEUDOATC:PlayerLanded(unit, place)
-  self:F2({unit=unit, place=place})
-  
-  -- Gather some information.
-  local group=unit:GetGroup()
-  local id=group:GetID()
-  local PlayerName=self.player[id].playername
-  local Callsign=self.player[id].callsign
-  local UnitName=self.player[id].unitname
-  local GroupName=self.player[id].groupname
-  local CallSign=self.player[id].callsign
-  
-  -- Debug message.
-  local text=string.format("Player %s in unit %s of group %s (id=%d) landed at %s.", PlayerName, UnitName, GroupName, id, place)
-  self:T(PSEUDOATC.id..text)
-  MESSAGE:New(text, 30):ToAllIf(self.Debug)
-  
-  -- Stop altitude reporting timer if its activated.
-  self:AltitudeTimerStop(id)
-  
-  -- Welcome message.
-  if place and self.chatty then
-    local text=string.format("Touchdown! Welcome to %s. Have a nice day!", place)
-    MESSAGE:New(text, self.mdur):ToGroup(group)
-  end
-
-end
-
---- Function called when a player took off.
--- @param #PSEUDOATC self
--- @param Wrapper.Unit#UNIT unit Unit of player which has landed.
--- @param #string place Name of the place the player landed at.
-function PSEUDOATC:PlayerTakeOff(unit, place)
-  self:F2({unit=unit, place=place})
-  
-  -- Gather some information.
-  local group=unit:GetGroup()
-  local id=group:GetID()
-  local PlayerName=self.player[id].playername
-  local Callsign=self.player[id].callsign
-  local UnitName=self.player[id].unitname
-  local GroupName=self.player[id].groupname
-  local CallSign=self.player[id].callsign
-  
-  -- Debug message.
-  local text=string.format("Player %s in unit %s of group %s (id=%d) took off at %s.", PlayerName, UnitName, GroupName, id, place)
-  self:T(PSEUDOATC.id..text)
-  MESSAGE:New(text, 30):ToAllIf(self.Debug)
-    
-  -- Bye-Bye message.
-  if place and self.chatty then
-    local text=string.format("%s, %s, you are airborne. Have a safe trip!", place, CallSign)
-    MESSAGE:New(text, self.mdur):ToGroup(group)
-  end
-
-end
-
---- Function called when a player leaves a unit or dies. 
--- @param #PSEUDOATC self
--- @param Wrapper.Unit#UNIT unit Player unit which was left.
-function PSEUDOATC:PlayerLeft(unit)
-  self:F({unit=unit})
- 
-  -- Get id.
-  local group=unit:GetGroup()
-  local id=group:GetID()
-  
-  if self.player[id] then
-  
-    -- Debug message.
-    local text=string.format("Player %s (callsign %s) of group %s just left unit %s.", self.player[id].playername, self.player[id].callsign, self.player[id].groupname, self.player[id].unitname)
-    self:T(PSEUDOATC.id..text)
-    MESSAGE:New(text, 30):ToAllIf(self.Debug)
-    
-    -- Stop scheduler for menu updates
-    if self.player[id].schedulerid then
-      self.player[id].scheduler:Stop(self.player[id].schedulerid)
-    end
-    
-    -- Stop scheduler for reporting alt if it runs.
-    self:AltitudeTimerStop(id)
-    
-    -- Remove main menu.
-    if self.player[id].menu_main then
-      missionCommands.removeItem(self.player[id].menu_main)
-    end
-  
-    -- Remove player array.
-    self.player[id]=nil
-    
-  end
-end
-
------------------------------------------------------------------------------------------------------------------------------------------
--- Menu Functions
-
---- Refreshes all player menues.
--- @param #PSEUDOATC self.
--- @param #number id Group id of player unit. 
-function PSEUDOATC:MenuRefresh(id)
-  self:F({id=id})
-
-  -- Debug message.
-  local text=string.format("Refreshing menues for player %s in group %s.", self.player[id].playername, self.player[id].groupname)
-  self:T(PSEUDOATC.id..text)
-  MESSAGE:New(text,30):ToAllIf(self.Debug)
-
-  -- Clear menu.
-  self:MenuClear(id)
-  
-  -- Create list of nearby airports.
-  self:LocalAirports(id)
-      
-  -- Create submenu Local Airports.
-  self:MenuAirports(id)
-  
-  -- Create submenu Waypoints etc.
-  self:MenuWaypoints(id)
-  
-end
-
-
---- Clear player menus.
--- @param #PSEUDOATC self.
--- @param #number id Group id of player unit. 
-function PSEUDOATC:MenuClear(id)
-  self:F(id)
-
-  -- Debug message.
-  local text=string.format("Clearing menus for player %s in group %s.", self.player[id].playername, self.player[id].groupname)
-  self:T(PSEUDOATC.id..text)
-  MESSAGE:New(text,30):ToAllIf(self.Debug)
-  
-  -- Delete Airports menu.
-  if self.player[id].menu_airports then
-    missionCommands.removeItemForGroup(id, self.player[id].menu_airports)
-    self.player[id].menu_airports=nil
-  else
-    self:T2(PSEUDOATC.id.."No airports to clear menus.")
-  end
- 
-  -- Delete waypoints menu.
-  if self.player[id].menu_waypoints then
-    missionCommands.removeItemForGroup(id, self.player[id].menu_waypoints)
-    self.player[id].menu_waypoints=nil
-  end
-  
-  -- Delete report alt until touchdown menu command.
-  if self.player[id].menu_reportalt then
-    missionCommands.removeItemForGroup(id, self.player[id].menu_reportalt)
-    self.player[id].menu_reportalt=nil
-  end
-
-  -- Delete request current alt menu command.
-  if self.player[id].menu_requestalt then
-    missionCommands.removeItemForGroup(id, self.player[id].menu_requestalt)
-    self.player[id].menu_requestalt=nil
-  end
-
-end
-
---- Create "F10/Pseudo ATC/Local Airports/Airport Name/" menu items each containing weather report and BR request.
--- @param #PSEUDOATC self
--- @param #number id Group id of player unit for which menues are created. 
-function PSEUDOATC:MenuAirports(id)
-  self:F(id)
-
-  -- Table for menu entries.
-  self.player[id].menu_airports=missionCommands.addSubMenuForGroup(id, "Local Airports", self.player[id].menu_main)
-   
-  local i=0
-  for _,airport in pairs(self.player[id].airports) do
-  
-    i=i+1
-    if i > 10 then
-      break -- Max 10 airports due to 10 menu items restriction.
-    end 
-    
-    local name=airport.name
-    local d=airport.distance
-    local pos=AIRBASE:FindByName(name):GetCoordinate()
-    
-    --F10menu_ATC_airports[ID][name] = missionCommands.addSubMenuForGroup(ID, name, F10menu_ATC)
-    local submenu=missionCommands.addSubMenuForGroup(id, name, self.player[id].menu_airports)
-    
-    -- Create menu reporting commands
-    missionCommands.addCommandForGroup(id, "Weather Report", submenu, self.ReportWeather, self, id, pos, name)
-    missionCommands.addCommandForGroup(id, "Request BR", submenu, self.ReportBR, self, id, pos, name)
-    
-    -- Debug message.
-    self:T(string.format(PSEUDOATC.id.."Creating airport menu item %s for ID %d", name, id))
-  end
-end
-
---- Create "F10/Pseudo ATC/Waypoints/<Waypoint i>  menu items.
--- @param #PSEUDOATC self
--- @param #number id Group id of player unit for which menues are created. 
-function PSEUDOATC:MenuWaypoints(id)
-  self:F(id)
-
-  -- Player unit and callsign.
-  local unit=self.player[id].unit --Wrapper.Unit#UNIT
-  local callsign=self.player[id].callsign
-  
-  -- Debug info.
-  self:T(PSEUDOATC.id..string.format("Creating waypoint menu for %s (ID %d).", callsign, id))
-     
-  if #self.player[id].waypoints>0 then
-  
-    -- F10/PseudoATC/Waypoints
-    self.player[id].menu_waypoints=missionCommands.addSubMenuForGroup(id, "Waypoints", self.player[id].menu_main)
-
-    local j=0    
-    for i, wp in pairs(self.player[id].waypoints) do
-    
-      -- Increase counter
-      j=j+1
-      
-      if j>10 then
-        break -- max ten menu entries
-      end
-      
-      -- Position of Waypoint
-      local pos=COORDINATE:New(wp.x, wp.alt, wp.y)
-      local name=string.format("Waypoint %d", i-1)
-      
-      -- "F10/PseudoATC/Waypoints/Waypoint X"
-      local submenu=missionCommands.addSubMenuForGroup(id, name, self.player[id].menu_waypoints)
-      
-      -- Menu commands for each waypoint "F10/PseudoATC/My Aircraft (callsign)/Waypoints/Waypoint X/<Commands>"
-      missionCommands.addCommandForGroup(id, "Weather Report", submenu, self.ReportWeather, self, id, pos, name)
-      missionCommands.addCommandForGroup(id, "Request BR", submenu, self.ReportBR, self, id, pos, name)
-    end
-  end
-  
-  self.player[id].menu_reportalt  = missionCommands.addCommandForGroup(id, "Talk me down",     self.player[id].menu_main, self.AltidudeTimerToggle, self, id)
-  self.player[id].menu_requestalt = missionCommands.addCommandForGroup(id, "Request altitude", self.player[id].menu_main, self.ReportHeight, self, id)
-end
-
------------------------------------------------------------------------------------------------------------------------------------------
--- Reporting Functions
-
---- Weather Report. Report pressure QFE/QNH, temperature, wind at certain location.
--- @param #PSEUDOATC self
--- @param #number id Group id to which the report is delivered.
--- @param Core.Point#COORDINATE position Coordinates at which the pressure is measured.
--- @param #string location Name of the location at which the pressure is measured.
-function PSEUDOATC:ReportWeather(id, position, location)
-  self:F({id=id, position=position, location=location})
-  
-  -- Player unit system settings.
-  local settings=_DATABASE:GetPlayerSettings(self.player[id].playername) or _SETTINGS --Core.Settings#SETTINGS
-  
-  local text=string.format("Local weather at %s:\n", location)
-   
-  -- Get pressure in hPa.  
-  local Pqnh=position:GetPressure(0)  -- Get pressure at sea level.
-  local Pqfe=position:GetPressure()   -- Get pressure at (land) height of position.
-  
-  -- Pressure conversion
-  local hPa2inHg=0.0295299830714
-  local hPa2mmHg=0.7500615613030
-  
-  -- Unit conversion.
-  local _Pqnh=string.format("%.2f inHg", Pqnh * hPa2inHg)
-  local _Pqfe=string.format("%.2f inHg", Pqfe * hPa2inHg)
-  if settings:IsMetric() then
-    _Pqnh=string.format("%.1f mmHg", Pqnh * hPa2mmHg)
-    _Pqfe=string.format("%.1f mmHg", Pqfe * hPa2mmHg)
-  end  
- 
-  -- Message text. 
-  text=text..string.format("QFE %.1f hPa = %s.\n", Pqfe, _Pqfe)
-  text=text..string.format("QNH %.1f hPa = %s.\n", Pqnh, _Pqnh)
-  
-  -- Get temperature at position in degrees Celsius. 
-  local T=position:GetTemperature()
-    
-  -- Correct unit system.
-  local _T=string.format('%d°F', UTILS.CelciusToFarenheit(T))
-  if settings:IsMetric() then
-    _T=string.format('%d°C', T)
-  end
-  
-  -- Message text.  
-  local text=text..string.format("Temperature %s\n", _T)
-  
-  -- Get wind direction and speed.
-  local Dir,Vel=position:GetWind()
-  
-  -- Get Beaufort wind scale.
-  local Bn,Bd=UTILS.BeaufortScale(Vel)
-  
-  -- Formatted wind direction.
-  local Ds = string.format('%03d°', Dir)
-    
-  -- Velocity in player units.
-  local Vs=string.format("%.1f knots", UTILS.MpsToKnots(Vel))
-  if settings:IsMetric() then
-    Vs=string.format('%.1f m/s', Vel)  
-  end  
-  
-  -- Message text.
-  local text=text..string.format("Wind from %s at %s (%s).", Ds, Vs, Bd)
-  
-  -- Send message
-  self:_DisplayMessageToGroup(self.player[id].unit, text, self.mdur, true)
-  
-end
-
---- Report absolute bearing and range form player unit to airport.
--- @param #PSEUDOATC self
--- @param #number id Group id to the report is delivered.
--- @param Core.Point#COORDINATE position Coordinates at which the pressure is measured.
--- @param #string location Name of the location at which the pressure is measured.
-function PSEUDOATC:ReportBR(id, position, location)
-  self:F({id=id, position=position, location=location})
-
-  -- Current coordinates.
-  local unit=self.player[id].unit --Wrapper.Unit#UNIT
-  local coord=unit:GetCoordinate()
-  
-  -- Direction vector from current position (coord) to target (position).
-  local pos=coord:Translate(30,90)
-  local vec3=coord:GetDirectionVec3(pos)
-  local angle=coord:GetAngleDegrees(vec3)
-  local range=coord:Get2DDistance(position)
-  
-  -- Bearing string.
-  local Bs=string.format('%03d°', angle)
-  
-  -- Settings.
-  local settings=_DATABASE:GetPlayerSettings(self.player[id].playername) or _SETTINGS --Core.Settings#SETTINGS
-  
-  
-  local Rs=string.format("%.1f NM", UTILS.MetersToNM(range))
-  if settings:IsMetric() then
-    Rs=string.format("%.1f km", range/1000)  
-  end
-
-  -- Message text.
-  local text=string.format("%s: Bearing %s, Range %s.", location, Bs, Rs)
-
-  -- Send message to player group.  
-  MESSAGE:New(text, self.mdur):ToGroup(self.player[id].group)      
-end
-
---- Report altitude above ground level of player unit.
--- @param #PSEUDOATC self
--- @param #number id Group id to the report is delivered.
--- @param #number dt (Optional) Duration the message is displayed.
--- @param #boolean _clear (Optional) Clear previouse messages. 
--- @return #number Altitude above ground.
-function PSEUDOATC:ReportHeight(id, dt, _clear)
-  self:F({id=id, dt=dt})
-
-  local dt = dt or self.mdur
-  if _clear==nil then
-    _clear=false
-  end
-
-  -- Return height [m] above ground level.
-  local function get_AGL(p)
-    local agl=0
-    local vec2={x=p.x,y=p.z}
-    local ground=land.getHeight(vec2)
-    local agl=p.y-ground
-    return agl
-  end
-
-  -- Get height AGL.
-  local unit=self.player[id].unit --Wrapper.Unit#UNIT
-  
-  if unit and unit:IsAlive() then
-  
-    local position=unit:GetCoordinate()
-    local height=get_AGL(position)
-    local callsign=unit:GetCallsign()
-    
-    -- Settings.
-    local settings=_DATABASE:GetPlayerSettings(self.player[id].playername) or _SETTINGS --Core.Settings#SETTINGS
-    
-    -- Height string.
-    local Hs=string.format("%d ft", UTILS.MetersToFeet(height))
-    if settings:IsMetric() then
-      Hs=string.format("%d m", height)
-    end
-    
-    -- Message text.
-    local _text=string.format("%s, your altitude is %s AGL.", callsign, Hs)
-    
-    -- Append flight level.
-    if _clear==false then
-      _text=_text..string.format(" FL%03d.", position.y/30.48)
-    end
-    
-    -- Send message to player group.  
-    self:_DisplayMessageToGroup(self.player[id].unit,_text, dt,_clear)
-    
-    -- Return height
-    return height
-  end
-  
-  return 0        
-end
-
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
---- Toggle report altitude reporting on/off.
--- @param #PSEUDOATC self.
--- @param #number id Group id of player unit. 
-function PSEUDOATC:AltidudeTimerToggle(id)
-  self:F(id)
-  
-  if self.player[id].altimerid then
-    -- If the timer is on, we turn it off.
-    self:AltitudeTimerStop(id)
-  else
-    -- If the timer is off, we turn it on.
-    self:AltitudeTimeStart(id)
-  end
-end
-
---- Start altitude reporting scheduler.
--- @param #PSEUDOATC self.
--- @param #number id Group id of player unit. 
-function PSEUDOATC:AltitudeTimeStart(id)
-  self:F(id)
-  
-  -- Debug info.
-  self:T(PSEUDOATC.id..string.format("Starting altitude report timer for player ID %d.", id))
-  
-  -- Start timer. Altitude is reported every ~3 seconds.
-  self.player[id].altimer, self.player[id].altimerid=SCHEDULER:New(nil, self.ReportHeight, {self, id, 0.1, true}, 1, 3)
-end
-
---- Stop/destroy DCS scheduler function for reporting altitude.
--- @param #PSEUDOATC self.
--- @param #number id Group id of player unit. 
-function PSEUDOATC:AltitudeTimerStop(id)
-
-  -- Debug info.
-  self:T(PSEUDOATC.id..string.format("Stopping altitude report timer for player ID %d.", id))
-  
-  -- Stop timer.
-  if self.player[id].altimerid then
-    self.player[id].altimer:Stop(self.player[id].altimerid)
-  end
-  
-  self.player[id].altimer=nil
-  self.player[id].altimerid=nil
-end
-
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- Misc
-
---- Create list of nearby airports sorted by distance to player unit.
--- @param #PSEUDOATC self
--- @param #number id Group id of player unit.
-function PSEUDOATC:LocalAirports(id)
-  self:F(id)
-
-  -- Airports table.  
-  self.player[id].airports=nil
-  self.player[id].airports={}
-  
-  -- Current player position.
-  local pos=self.player[id].unit:GetCoordinate()
-  
-  -- Loop over coalitions.
-  for i=0,2 do
-    
-    -- Get all airbases of coalition.
-    local airports=coalition.getAirbases(i)
-    
-    -- Loop over airbases
-    for _,airbase in pairs(airports) do
-    
-      local name=airbase:getName()
-      local q=AIRBASE:FindByName(name):GetCoordinate()
-      local d=q:Get2DDistance(pos)
-      
-      -- Add to table.
-      table.insert(self.player[id].airports, {distance=d, name=name})
-      
-    end
-  end
-  
-  --- compare distance (for sorting airports)
-  local function compare(a,b)
-    return a.distance < b.distance
-  end
-  
-  -- Sort airports table w.r.t. distance to player.
-  table.sort(self.player[id].airports, compare)
-  
-end
-
---- Returns the unit of a player and the player name. If the unit does not belong to a player, nil is returned. 
--- @param #PSEUDOATC self
--- @param #string _unitName Name of the player unit.
--- @return Wrapper.Unit#UNIT Unit of player.
--- @return #string Name of the player.
--- @return nil If player does not exist.
-function PSEUDOATC:_GetPlayerUnitAndName(_unitName)
-  self:F(_unitName)
-
-  if _unitName ~= nil then
-  
-    -- Get DCS unit from its name.
-    local DCSunit=Unit.getByName(_unitName)
-    if DCSunit then
-    
-      -- Get the player name to make sure a player entered.  
-      local playername=DCSunit:getPlayerName()
-      local unit=UNIT:Find(DCSunit)
-      
-      -- Debug output.
-      self:T2({DCSunit=DCSunit, unit=unit, playername=playername})
-      
-      if unit and playername then        
-        -- Return MOOSE unit and player name
-        return unit, playername
-      end
-      
-    end    
-  end
-    
-  return nil,nil
-end
-
-
---- Display message to group.
--- @param #PSEUDOATC self
--- @param Wrapper.Unit#UNIT _unit Player unit.
--- @param #string _text Message text.
--- @param #number _time Duration how long the message is displayed.
--- @param #boolean _clear Clear up old messages.
-function PSEUDOATC:_DisplayMessageToGroup(_unit, _text, _time, _clear)
-  self:F({unit=_unit, text=_text, time=_time, clear=_clear})
-  
-  _time=_time or self.Tmsg
-  if _clear==nil then
-    _clear=false
-  end
-  
-  -- Group ID.
-  local _gid=_unit:GetGroup():GetID()
-  
-  if _gid then
-    if _clear == true then
-      trigger.action.outTextForGroup(_gid, _text, _time, _clear)
-    else
-      trigger.action.outTextForGroup(_gid, _text, _time)
-    end
-  end
-  
-end
-
---- Returns a string which consits of this callsign and the player name.  
--- @param #PSEUDOATC self
--- @param #string unitname Name of the player unit.
-function PSEUDOATC:_myname(unitname)
-  self:F2(unitname)
-  
-  local unit=UNIT:FindByName(unitname)
-  local pname=unit:GetPlayerName()
-  local csign=unit:GetCallsign()
-  
-  return string.format("%s (%s)", csign, pname)
-end
-

Moose Development/Moose/Functional/Scoring.lua

@@ -1,33 +1,15 @@
---- **Functional** - Administer the scoring of player achievements, and create a CSV file logging the scoring events for use at team or squadron websites.
+--- **Functional** -- **Administer the SCORING of player achievements, 
+-- and create a CSV file logging the scoring events for use at team or squadron websites.**
 -- 
+-- ![Banner Image](..\Presentations\SCORING\Dia1.JPG)
+--  
 -- ===
 -- 
--- ## Features:
--- 
---   * Set the scoring scales based on threat level.
---   * Positive scores and negative scores.
---   * A contribution model to score achievements.
---   * Score goals.
---   * Score specific achievements.
---   * Score the hits and destroys of units.
---   * Score the hits and destroys of statics.
---   * Score the hits and destroys of scenery.
---   * Log scores into a CSV file.
---   * Connect to a remote server using JSON and IP.
---   
--- ===
--- 
--- ## Missions:
--- 
--- [SCO - Scoring](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/SCO%20-%20Scoring)
--- 
--- ===
--- 
--- Administers the scoring of player achievements, 
+-- The @{#SCORING} class administers the scoring of player achievements, 
 -- and creates a CSV file logging the scoring events and results for use at team or squadron websites.
 -- 
 -- SCORING automatically calculates the threat level of the objects hit and destroyed by players, 
--- which can be @{Wrapper.Unit}, @{Static) and @{Scenery} objects.
+-- which can be @{Unit}, @{Static) and @{Scenery} objects.
 -- 
 -- Positive score points are granted when enemy or neutral targets are destroyed. 
 -- Negative score points or penalties are given when a friendly target is hit or destroyed. 
@@ -73,34 +55,9 @@
 -- Use the radio menu F10 to consult the scores while running the mission. 
 -- Scores can be reported for your user, or an overall score can be reported of all players currently active in the mission.
 -- 
--- ===
+-- # 1) @{Scoring#SCORING} class, extends @{Base#BASE}
 -- 
--- ### Authors: **FlightControl**
--- 
--- ### Contributions:
--- 
---   * **Wingthor (TAW)**: Testing & Advice.
---   * **Dutch-Baron (TAW)**: Testing & Advice.
---   * **[Whisper](http://forums.eagle.ru/member.php?u=3829): Testing and Advice.
--- 
--- ===       
--- 
--- @module Functional.Scoring
--- @image Scoring.JPG
-
-
---- @type SCORING
--- @field Players A collection of the current players that have joined the game.
--- @extends Core.Base#BASE
-
---- SCORING class
--- 
--- # Constructor:
--- 
---      local Scoring = SCORING:New( "Scoring File" )
---       
--- 
--- # Set the destroy score or penalty scale:
+-- ## 1.1) Set the destroy score or penalty scale
 -- 
 -- Score scales can be set for scores granted when enemies or friendlies are destroyed.
 -- Use the method @{#SCORING.SetScaleDestroyScore}() to set the scale of enemy destroys (positive destroys). 
@@ -113,12 +70,12 @@
 -- The above sets the scale for valid scores to 10. So scores will be given in a scale from 0 to 10.
 -- The penalties will be given in a scale from 0 to 40.
 -- 
--- # Define special targets that will give extra scores:
+-- ## 1.2) Define special targets that will give extra scores.
 -- 
 -- Special targets can be set that will give extra scores to the players when these are destroyed.
--- Use the methods @{#SCORING.AddUnitScore}() and @{#SCORING.RemoveUnitScore}() to specify a special additional score for a specific @{Wrapper.Unit}s.  
+-- Use the methods @{#SCORING.AddUnitScore}() and @{#SCORING.RemoveUnitScore}() to specify a special additional score for a specific @{Unit}s.  
 -- Use the methods @{#SCORING.AddStaticScore}() and @{#SCORING.RemoveStaticScore}() to specify a special additional score for a specific @{Static}s.  
--- Use the method @{#SCORING.SetGroupGroup}() to specify a special additional score for a specific @{Wrapper.Group}s.  
+-- Use the method @{#SCORING.SetGroupGroup}() to specify a special additional score for a specific @{Group}s.  
 -- 
 --      local Scoring = SCORING:New( "Scoring File" )
 --      Scoring:AddUnitScore( UNIT:FindByName( "Unit #001" ), 200 )
@@ -130,22 +87,22 @@
 -- 
 --      Scoring:RemoveUnitScore( UNIT:FindByName( "Unit #001" ) )
 -- 
--- # Define destruction zones that will give extra scores:
+-- ## 1.3) Define destruction zones that will give extra scores.
 -- 
 -- Define zones of destruction. Any object destroyed within the zone of the given category will give extra points.
 -- Use the method @{#SCORING.AddZoneScore}() to add a @{Zone} for additional scoring.  
 -- Use the method @{#SCORING.RemoveZoneScore}() to remove a @{Zone} for additional scoring.  
--- There are interesting variations that can be achieved with this functionality. For example, if the @{Zone} is a @{Core.Zone#ZONE_UNIT}, 
+-- There are interesting variations that can be achieved with this functionality. For example, if the @{Zone} is a @{Zone#ZONE_UNIT}, 
 -- then the zone is a moving zone, and anything destroyed within that @{Zone} will generate points.
 -- The other implementation could be to designate a scenery target (a building) in the mission editor surrounded by a @{Zone}, 
 -- just large enough around that building.
 -- 
--- # Add extra Goal scores upon an event or a condition:
+-- ## 1.4) Add extra Goal scores upon an event or a condition.
 -- 
 -- A mission has goals and achievements. The scoring system provides an API to set additional scores when a goal or achievement event happens.
 -- Use the method @{#SCORING.AddGoalScore}() to add a score for a Player at any time in your mission.
 -- 
--- # (Decommissioned) Configure fratricide level.
+-- ## 1.5) (Decommissioned) Configure fratricide level.
 -- 
 -- **This functionality is decomissioned until the DCS bug concerning Unit:destroy() not being functional in multi player for player units has been fixed by ED**.
 -- 
@@ -153,13 +110,13 @@
 -- Use the method @{#SCORING.SetFratricide}() to define the level when a player gets kicked.  
 -- By default, the fratricide level is the default penalty mutiplier * 2 for the penalty score.
 -- 
--- # Penalty score when a player changes the coalition.
+-- ## 1.6) Penalty score when a player changes the coalition.
 -- 
 -- When a player changes the coalition, he can receive a penalty score.
 -- Use the method @{#SCORING.SetCoalitionChangePenalty}() to define the penalty when a player changes coalition.
 -- By default, the penalty for changing coalition is the default penalty scale.  
 -- 
--- # Define output CSV files.
+-- ## 1.8) Define output CSV files.
 -- 
 -- The CSV file is given the name of the string given in the @{#SCORING.New}{} constructor, followed by the .csv extension.
 -- The file is incrementally saved in the **<User>\\Saved Games\\DCS\\Logs** folder, and has a time stamp indicating each mission run.
@@ -196,7 +153,7 @@
 -- The MOOSE designer cannot take any responsibility of any damage inflicted as a result of the de-sanitization.
 -- That being said, I hope that the SCORING class provides you with a great add-on to score your squad mates achievements.
 -- 
--- # Configure messages.
+-- ## 1.9) Configure messages.
 -- 
 -- When players hit or destroy targets, messages are sent.
 -- Various methods exist to configure:
@@ -204,7 +161,7 @@
 --   * Which messages are sent upon the event.
 --   * Which audience receives the message.
 -- 
--- ## Configure the messages sent upon the event.
+-- ### 1.9.1) Configure the messages sent upon the event.
 -- 
 -- Use the following methods to configure when to send messages. By default, all messages are sent.
 -- 
@@ -213,16 +170,48 @@
 --   * @{#SCORING.SetMessagesAddon}(): Configure to send messages for additional score, after a target has been destroyed.
 --   * @{#SCORING.SetMessagesZone}(): Configure to send messages for additional score, after a target has been destroyed within a given zone.
 --   
--- ## Configure the audience of the messages.
+-- ### 1.9.2) Configure the audience of the messages.
 -- 
 -- Use the following methods to configure the audience of the messages. By default, the messages are sent to all players in the mission.
 -- 
 --   * @{#SCORING.SetMessagesToAll}(): Configure to send messages to all players.
 --   * @{#SCORING.SetMessagesToCoalition}(): Configure to send messages to only those players within the same coalition as the player.
+-- 
+--   
+-- ====
+--
+-- # **API CHANGE HISTORY**
+--
+-- The underlying change log documents the API changes. Please read this carefully. The following notation is used:
+--
+--   * **Added** parts are expressed in bold type face.
+--   * _Removed_ parts are expressed in italic type face.
+--
+-- Hereby the change log:
+--
+-- 2017-02-26: Initial class and API.
 --
 -- ===
+--
+-- # **AUTHORS and CONTRIBUTIONS**
+--
+-- ### Contributions:
+--
+--   * **Wingthor (TAW)**: Testing & Advice.
+--   * **Dutch-Baron (TAW)**: Testing & Advice.
+--   * **[Whisper](http://forums.eagle.ru/member.php?u=3829): Testing and Advice.
+--        
+-- ### Authors:
+--
+--   * **FlightControl**: Concept, Design & Programming.
 -- 
--- @field #SCORING
+-- @module Scoring
+
+
+--- The Scoring class
+-- @type SCORING
+-- @field Players A collection of the current players that have joined the game.
+-- @extends Core.Base#BASE
 SCORING = {
   ClassName = "SCORING",
   ClassID = 0,
@@ -249,10 +238,8 @@ local _SCORINGCategory =
 -- @param #string GameName The name of the game. This name is also logged in the CSV score file.
 -- @return #SCORING self
 -- @usage
--- 
 -- -- Define a new scoring object for the mission Gori Valley.
 -- ScoringObject = SCORING:New( "Gori Valley" )
--- 
 function SCORING:New( GameName )
 
   -- Inherits from BASE
@@ -294,22 +281,8 @@ function SCORING:New( GameName )
   self:HandleEvent( EVENTS.Dead, self._EventOnDeadOrCrash )
   self:HandleEvent( EVENTS.Crash, self._EventOnDeadOrCrash )
   self:HandleEvent( EVENTS.Hit, self._EventOnHit )
-  self:HandleEvent( EVENTS.Birth )
-  --self:HandleEvent( EVENTS.PlayerEnterUnit )
+  self:HandleEvent( EVENTS.PlayerEnterUnit )
   self:HandleEvent( EVENTS.PlayerLeaveUnit )
-  
-  -- During mission startup, especially for single player, 
-  -- iterate the database for the player that has joined, and add him to the scoring, and set the menu.
-  -- But this can only be started one second after the mission has started, so i need to schedule this ...
-  self.ScoringPlayerScan = BASE:ScheduleOnce( 1, 
-    function()
-      for PlayerName, PlayerUnit in pairs( _DATABASE:GetPlayerUnits() ) do 
-        self:_AddPlayerFromUnit( PlayerUnit )
-        self:SetScoringMenu( PlayerUnit:GetGroup() )
-      end
-    end
-  )
-  
 
   -- Create the CSV file.
   self:OpenCSV( GameName )
@@ -351,11 +324,11 @@ function SCORING:SetScaleDestroyPenalty( Scale )
   return self
 end
 
---- Add a @{Wrapper.Unit} for additional scoring when the @{Wrapper.Unit} is destroyed.
--- Note that if there was already a @{Wrapper.Unit} declared within the scoring with the same name, 
--- then the old @{Wrapper.Unit}  will be replaced with the new @{Wrapper.Unit}.
+--- Add a @{Unit} for additional scoring when the @{Unit} is destroyed.
+-- Note that if there was already a @{Unit} declared within the scoring with the same name, 
+-- then the old @{Unit}  will be replaced with the new @{Unit}.
 -- @param #SCORING self
--- @param Wrapper.Unit#UNIT ScoreUnit The @{Wrapper.Unit} for which the Score needs to be given.
+-- @param Wrapper.Unit#UNIT ScoreUnit The @{Unit} for which the Score needs to be given.
 -- @param #number Score The Score value.
 -- @return #SCORING
 function SCORING:AddUnitScore( ScoreUnit, Score )
@@ -367,9 +340,9 @@ function SCORING:AddUnitScore( ScoreUnit, Score )
   return self
 end
 
---- Removes a @{Wrapper.Unit} for additional scoring when the @{Wrapper.Unit} is destroyed.
+--- Removes a @{Unit} for additional scoring when the @{Unit} is destroyed.
 -- @param #SCORING self
--- @param Wrapper.Unit#UNIT ScoreUnit The @{Wrapper.Unit} for which the Score needs to be given.
+-- @param Wrapper.Unit#UNIT ScoreUnit The @{Unit} for which the Score needs to be given.
 -- @return #SCORING
 function SCORING:RemoveUnitScore( ScoreUnit )
 
@@ -410,9 +383,9 @@ function SCORING:RemoveStaticScore( ScoreStatic )
 end
 
 
---- Specify a special additional score for a @{Wrapper.Group}.
+--- Specify a special additional score for a @{Group}.
 -- @param #SCORING self
--- @param Wrapper.Group#GROUP ScoreGroup The @{Wrapper.Group} for which each @{Wrapper.Unit} a Score is given.
+-- @param Wrapper.Group#GROUP ScoreGroup The @{Group} for which each @{Unit} a Score is given.
 -- @param #number Score The Score value.
 -- @return #SCORING
 function SCORING:AddScoreGroup( ScoreGroup, Score )
@@ -596,19 +569,6 @@ function SCORING:SetCoalitionChangePenalty( CoalitionChangePenalty )
 end
 
 
---- Sets the scoring menu.
--- @param #SCORING self
--- @return #SCORING
-function SCORING:SetScoringMenu( ScoringGroup )
-    local Menu = MENU_GROUP:New( ScoringGroup, 'Scoring and Statistics' )
-    local ReportGroupSummary = MENU_GROUP_COMMAND:New( ScoringGroup, 'Summary report players in group', Menu, SCORING.ReportScoreGroupSummary, self, ScoringGroup )
-    local ReportGroupDetailed = MENU_GROUP_COMMAND:New( ScoringGroup, 'Detailed report players in group', Menu, SCORING.ReportScoreGroupDetailed, self, ScoringGroup )
-    local ReportToAllSummary = MENU_GROUP_COMMAND:New( ScoringGroup, 'Summary report all players', Menu, SCORING.ReportScoreAllSummary, self, ScoringGroup )
-    self:SetState( ScoringGroup, "ScoringMenu", Menu )
-  return self
-end
-
-
 --- Add a new player entering a Unit.
 -- @param #SCORING self
 -- @param Wrapper.Unit#UNIT UnitData
@@ -690,43 +650,13 @@ function SCORING:_AddPlayerFromUnit( UnitData )
 end
 
 
---- Add a goal score for a player.
--- The method takes the Player name for which the Goal score needs to be set.
--- The GoalTag is a string or identifier that is taken into the CSV file scoring log to identify the goal.
--- A free text can be given that is shown to the players.
--- The Score can be both positive and negative.
--- @param #SCORING self
--- @param #string PlayerName The name of the Player.
--- @param #string GoalTag The string or identifier that is used in the CSV file to identify the goal (sort or group later in Excel).
--- @param #string Text A free text that is shown to the players.
--- @param #number Score The score can be both positive or negative ( Penalty ).
-function SCORING:AddGoalScorePlayer( PlayerName, GoalTag, Text, Score )
-
-  self:F( { PlayerName, 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]
-
-    PlayerData.Goals[GoalTag] = PlayerData.Goals[GoalTag] or { Score = 0 }
-    PlayerData.Goals[GoalTag].Score = PlayerData.Goals[GoalTag].Score + Score  
-    PlayerData.Score = PlayerData.Score + Score
-  
-    MESSAGE:NewType( self.DisplayMessagePrefix .. Text, MESSAGE.Type.Information ):ToAll()
-  
-    self:ScoreCSV( PlayerName, "", "GOAL_" .. string.upper( GoalTag ), 1, Score, nil )
-  end
-end
-
-
-
 --- Add a goal score for a player.
 -- The method takes the PlayerUnit for which the Goal score needs to be set.
 -- The GoalTag is a string or identifier that is taken into the CSV file scoring log to identify the goal.
 -- A free text can be given that is shown to the players.
 -- The Score can be both positive and negative.
 -- @param #SCORING self
--- @param Wrapper.Unit#UNIT PlayerUnit The @{Wrapper.Unit} of the Player. Other Properties for the scoring are taken from this PlayerUnit, like coalition, type etc. 
+-- @param Wrapper.Unit#UNIT PlayerUnit The @{Unit} of the Player. Other Properties for the scoring are taken from this PlayerUnit, like coalition, type etc. 
 -- @param #string GoalTag The string or identifier that is used in the CSV file to identify the goal (sort or group later in Excel).
 -- @param #string Text A free text that is shown to the players.
 -- @param #number Score The score can be both positive or negative ( Penalty ).
@@ -734,7 +664,7 @@ function SCORING:AddGoalScore( PlayerUnit, GoalTag, Text, Score )
 
   local PlayerName = PlayerUnit:GetPlayerName()
 
-  self:F( { PlayerUnit.UnitName, PlayerName, GoalTag, Text, Score } )
+  self:E( { PlayerUnit.UnitName, PlayerName, GoalTag, Text, Score } )
 
   -- PlayerName can be nil, if the Unit with the player crashed or due to another reason.
   if PlayerName then 
@@ -762,7 +692,7 @@ function SCORING:_AddMissionTaskScore( Mission, PlayerUnit, Text, Score )
   local PlayerName = PlayerUnit:GetPlayerName()
   local MissionName = Mission:GetName()
 
-  self:F( { Mission:GetName(), PlayerUnit.UnitName, PlayerName, Text, Score } )
+  self:E( { Mission:GetName(), PlayerUnit.UnitName, PlayerName, Text, Score } )
 
   -- PlayerName can be nil, if the Unit with the player crashed or due to another reason.
   if PlayerName then 
@@ -780,45 +710,12 @@ function SCORING:_AddMissionTaskScore( Mission, PlayerUnit, Text, Score )
     PlayerData.Score = self.Players[PlayerName].Score + Score
     PlayerData.Mission[MissionName].ScoreTask = self.Players[PlayerName].Mission[MissionName].ScoreTask + Score
   
-    MESSAGE:NewType( self.DisplayMessagePrefix .. Mission:GetText() .. " : " .. Text .. " Score: " .. Score, MESSAGE.Type.Information ):ToAll()
+    MESSAGE:NewType( self.DisplayMessagePrefix .. MissionName .. " : " .. Text .. " Score: " .. Score, MESSAGE.Type.Information ):ToAll()
   
     self:ScoreCSV( PlayerName, "", "TASK_" .. MissionName:gsub( ' ', '_' ), 1, Score, PlayerUnit:GetName() )
   end
 end
 
---- Registers Scores the players completing a Mission Task.
--- @param #SCORING self
--- @param Tasking.Mission#MISSION Mission
--- @param #string PlayerName
--- @param #string Text
--- @param #number Score
-function SCORING:_AddMissionGoalScore( Mission, PlayerName, Text, Score )
-
-  local MissionName = Mission:GetName()
-
-  self:F( { Mission:GetName(), PlayerName, 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.Mission[MissionName] then
-      PlayerData.Mission[MissionName] = {}
-      PlayerData.Mission[MissionName].ScoreTask = 0
-      PlayerData.Mission[MissionName].ScoreMission = 0
-    end
-  
-    self:T( PlayerName )
-    self:T( PlayerData.Mission[MissionName] )
-  
-    PlayerData.Score = self.Players[PlayerName].Score + Score
-    PlayerData.Mission[MissionName].ScoreTask = self.Players[PlayerName].Mission[MissionName].ScoreTask + Score
-  
-    MESSAGE:NewType( string.format( "%s%s: %s! Player %s receives %d score!", self.DisplayMessagePrefix, Mission:GetText(), Text, PlayerName, Score ), MESSAGE.Type.Information ):ToAll()
-
-    self:ScoreCSV( PlayerName, "", "TASK_" .. MissionName:gsub( ' ', '_' ), 1, Score )
-  end
-end
 
 --- Registers Mission Scores for possible multiple players that contributed in the Mission.
 -- @param #SCORING self
@@ -830,18 +727,18 @@ function SCORING:_AddMissionScore( Mission, Text, Score )
   
   local MissionName = Mission:GetName()
 
-  self:F( { Mission, Text, Score } )
-  self:F( self.Players )
+  self:E( { Mission, Text, Score } )
+  self:E( self.Players )
 
   for PlayerName, PlayerData in pairs( self.Players ) do
 
-    self:F( PlayerData )
+    self:E( PlayerData )
     if PlayerData.Mission[MissionName] then
 
       PlayerData.Score = PlayerData.Score + Score
       PlayerData.Mission[MissionName].ScoreMission = PlayerData.Mission[MissionName].ScoreMission + Score
 
-      MESSAGE:NewType( self.DisplayMessagePrefix .. "Player '" .. PlayerName .. "' has " .. Text .. " in " .. Mission:GetText() .. ". " ..
+      MESSAGE:NewType( self.DisplayMessagePrefix .. "Player '" .. PlayerName .. "' has " .. Text .. " in Mission '" .. MissionName .. "'. " ..
         Score .. " mission score!",
         MESSAGE.Type.Information ):ToAll()
 
@@ -851,30 +748,17 @@ function SCORING:_AddMissionScore( Mission, Text, Score )
 end
 
 
-
 --- Handles the OnPlayerEnterUnit event for the scoring.
 -- @param #SCORING self
 -- @param Core.Event#EVENTDATA Event
---function SCORING:OnEventPlayerEnterUnit( Event )
---  if Event.IniUnit then
---    self:_AddPlayerFromUnit( Event.IniUnit )
---    self:SetScoringMenu( Event.IniGroup )
---  end
---end
-
---- Handles the OnBirth event for the scoring.
--- @param #SCORING self
--- @param Core.Event#EVENTDATA Event
-function SCORING:OnEventBirth( Event )
-  
+function SCORING:OnEventPlayerEnterUnit( Event )
   if Event.IniUnit then
-    if Event.IniObjectCategory == 1 then
-      local PlayerName = Event.IniUnit:GetPlayerName()
-      if PlayerName then
-        self:_AddPlayerFromUnit( Event.IniUnit )
-        self:SetScoringMenu( Event.IniGroup )
-      end
-    end
+    self:_AddPlayerFromUnit( Event.IniUnit )
+    local Menu = MENU_GROUP:New( Event.IniGroup, 'Scoring' )
+    local ReportGroupSummary = MENU_GROUP_COMMAND:New( Event.IniGroup, 'Summary report players in group', Menu, SCORING.ReportScoreGroupSummary, self, Event.IniGroup )
+    local ReportGroupDetailed = MENU_GROUP_COMMAND:New( Event.IniGroup, 'Detailed report players in group', Menu, SCORING.ReportScoreGroupDetailed, self, Event.IniGroup )
+    local ReportToAllSummary = MENU_GROUP_COMMAND:New( Event.IniGroup, 'Summary report all players', Menu, SCORING.ReportScoreAllSummary, self, Event.IniGroup )
+    self:SetState( Event.IniUnit, "ScoringMenu", Menu )
   end
 end
 
@@ -883,7 +767,7 @@ end
 -- @param Core.Event#EVENTDATA Event
 function SCORING:OnEventPlayerLeaveUnit( Event )
   if Event.IniUnit then
-    local Menu = self:GetState( Event.IniUnit:GetGroup(), "ScoringMenu" ) -- Core.Menu#MENU_GROUP
+    local Menu = self:GetState( Event.IniUnit, "ScoringMenu" ) -- Core.Menu#MENU_GROUP
     if Menu then
       -- TODO: Check if this fixes #281.
       --Menu:Remove()
@@ -1245,7 +1129,7 @@ function SCORING:_EventOnDeadOrCrash( Event )
             local ThreatTypeTarget = TargetThreatType
             local ThreatLevelPlayer = Player.ThreatLevel / 10 + 1
             local ThreatPenalty = math.ceil( ( ThreatLevelTarget / ThreatLevelPlayer ) * self.ScaleDestroyPenalty / 10 )
-            self:F( { ThreatLevel = ThreatPenalty, ThreatLevelTarget = ThreatLevelTarget, ThreatTypeTarget = ThreatTypeTarget, ThreatLevelPlayer = ThreatLevelPlayer  } )
+            self:E( { ThreatLevel = ThreatPenalty, ThreatLevelTarget = ThreatLevelTarget, ThreatTypeTarget = ThreatTypeTarget, ThreatLevelPlayer = ThreatLevelPlayer  } )
             
             Player.Penalty = Player.Penalty + ThreatPenalty
             TargetDestroy.Penalty = TargetDestroy.Penalty + ThreatPenalty
@@ -1280,7 +1164,7 @@ function SCORING:_EventOnDeadOrCrash( Event )
             local ThreatLevelPlayer = Player.ThreatLevel / 10 + 1
             local ThreatScore = math.ceil( ( ThreatLevelTarget / ThreatLevelPlayer )  * self.ScaleDestroyScore / 10 )
             
-            self:F( { ThreatLevel = ThreatScore, ThreatLevelTarget = ThreatLevelTarget, ThreatTypeTarget = ThreatTypeTarget, ThreatLevelPlayer = ThreatLevelPlayer  } )
+            self:E( { ThreatLevel = ThreatScore, ThreatLevelTarget = ThreatLevelTarget, ThreatTypeTarget = ThreatTypeTarget, ThreatLevelPlayer = ThreatLevelPlayer  } )
   
             Player.Score = Player.Score + ThreatScore
             TargetDestroy.Score = TargetDestroy.Score + ThreatScore
@@ -1325,7 +1209,7 @@ function SCORING:_EventOnDeadOrCrash( Event )
             
             -- Check if there are Zones where the destruction happened.
             for ZoneName, ScoreZoneData in pairs( self.ScoringZones ) do
-              self:F( { ScoringZone = ScoreZoneData } )
+              self:E( { ScoringZone = ScoreZoneData } )
               local ScoreZone = ScoreZoneData.ScoreZone -- Core.Zone#ZONE_BASE
               local Score = ScoreZoneData.Score
               if ScoreZone:IsVec2InZone( TargetUnit:GetVec2() ) then
@@ -1347,7 +1231,7 @@ function SCORING:_EventOnDeadOrCrash( Event )
         else
           -- Check if there are Zones where the destruction happened.
           for ZoneName, ScoreZoneData in pairs( self.ScoringZones ) do
-              self:F( { ScoringZone = ScoreZoneData } )
+              self:E( { ScoringZone = ScoreZoneData } )
             local ScoreZone = ScoreZoneData.ScoreZone -- Core.Zone#ZONE_BASE
             local Score = ScoreZoneData.Score
             if ScoreZone:IsVec2InZone( TargetUnit:GetVec2() ) then
@@ -1462,7 +1346,7 @@ function SCORING:ReportDetailedPlayerDestroys( PlayerName )
         local PenaltyDestroy = 0
 
         for UnitName, UnitData in pairs( PlayerData.Destroy[CategoryID] ) do
-          self:F( { UnitData = UnitData } )
+          self:E( { UnitData = UnitData } )
           if UnitData ~= {} then
             Score = Score + UnitData.Score
             ScoreDestroy = ScoreDestroy + UnitData.ScoreDestroy
@@ -1616,23 +1500,23 @@ function SCORING:ReportScoreGroupSummary( PlayerGroup )
     
       local ReportHits, ScoreHits, PenaltyHits = self:ReportDetailedPlayerHits( PlayerName )
       ReportHits = ReportHits ~= "" and "\n- " .. ReportHits or ReportHits 
-      self:F( { ReportHits, ScoreHits, PenaltyHits } )
+      self:E( { ReportHits, ScoreHits, PenaltyHits } )
 
       local ReportDestroys, ScoreDestroys, PenaltyDestroys = self:ReportDetailedPlayerDestroys( PlayerName )
       ReportDestroys = ReportDestroys ~= "" and "\n- " .. ReportDestroys or ReportDestroys
-      self:F( { ReportDestroys, ScoreDestroys, PenaltyDestroys } )
+      self:E( { ReportDestroys, ScoreDestroys, PenaltyDestroys } )
 
       local ReportCoalitionChanges, ScoreCoalitionChanges, PenaltyCoalitionChanges = self:ReportDetailedPlayerCoalitionChanges( PlayerName )
       ReportCoalitionChanges = ReportCoalitionChanges ~= "" and "\n- " .. ReportCoalitionChanges or ReportCoalitionChanges
-      self:F( { ReportCoalitionChanges, ScoreCoalitionChanges, PenaltyCoalitionChanges } )
+      self:E( { ReportCoalitionChanges, ScoreCoalitionChanges, PenaltyCoalitionChanges } )
 
       local ReportGoals, ScoreGoals, PenaltyGoals = self:ReportDetailedPlayerGoals( PlayerName )
       ReportGoals = ReportGoals ~= "" and "\n- " .. ReportGoals or ReportGoals
-      self:F( { ReportGoals, ScoreGoals, PenaltyGoals } )
+      self:E( { ReportGoals, ScoreGoals, PenaltyGoals } )
 
       local ReportMissions, ScoreMissions, PenaltyMissions = self:ReportDetailedPlayerMissions( PlayerName )
       ReportMissions = ReportMissions ~= "" and "\n- " .. ReportMissions or ReportMissions
-      self:F( { ReportMissions, ScoreMissions, PenaltyMissions } )
+      self:E( { ReportMissions, ScoreMissions, PenaltyMissions } )
       
       local PlayerScore = ScoreHits + ScoreDestroys + ScoreCoalitionChanges + ScoreGoals + ScoreMissions
       local PlayerPenalty = PenaltyHits + PenaltyDestroys + PenaltyCoalitionChanges + ScoreGoals + PenaltyMissions
@@ -1668,23 +1552,23 @@ function SCORING:ReportScoreGroupDetailed( PlayerGroup )
     
       local ReportHits, ScoreHits, PenaltyHits = self:ReportDetailedPlayerHits( PlayerName )
       ReportHits = ReportHits ~= "" and "\n- " .. ReportHits or ReportHits 
-      self:F( { ReportHits, ScoreHits, PenaltyHits } )
+      self:E( { ReportHits, ScoreHits, PenaltyHits } )
 
       local ReportDestroys, ScoreDestroys, PenaltyDestroys = self:ReportDetailedPlayerDestroys( PlayerName )
       ReportDestroys = ReportDestroys ~= "" and "\n- " .. ReportDestroys or ReportDestroys
-      self:F( { ReportDestroys, ScoreDestroys, PenaltyDestroys } )
+      self:E( { ReportDestroys, ScoreDestroys, PenaltyDestroys } )
 
       local ReportCoalitionChanges, ScoreCoalitionChanges, PenaltyCoalitionChanges = self:ReportDetailedPlayerCoalitionChanges( PlayerName )
       ReportCoalitionChanges = ReportCoalitionChanges ~= "" and "\n- " .. ReportCoalitionChanges or ReportCoalitionChanges
-      self:F( { ReportCoalitionChanges, ScoreCoalitionChanges, PenaltyCoalitionChanges } )
+      self:E( { ReportCoalitionChanges, ScoreCoalitionChanges, PenaltyCoalitionChanges } )
       
       local ReportGoals, ScoreGoals, PenaltyGoals = self:ReportDetailedPlayerGoals( PlayerName )
       ReportGoals = ReportGoals ~= "" and "\n- " .. ReportGoals or ReportGoals
-      self:F( { ReportGoals, ScoreGoals, PenaltyGoals } )
+      self:E( { ReportGoals, ScoreGoals, PenaltyGoals } )
 
       local ReportMissions, ScoreMissions, PenaltyMissions = self:ReportDetailedPlayerMissions( PlayerName )
       ReportMissions = ReportMissions ~= "" and "\n- " .. ReportMissions or ReportMissions
-      self:F( { ReportMissions, ScoreMissions, PenaltyMissions } )
+      self:E( { ReportMissions, ScoreMissions, PenaltyMissions } )
       
       local PlayerScore = ScoreHits + ScoreDestroys + ScoreCoalitionChanges + ScoreGoals + ScoreMissions
       local PlayerPenalty = PenaltyHits + PenaltyDestroys + PenaltyCoalitionChanges + ScoreGoals + PenaltyMissions
@@ -1714,33 +1598,31 @@ function SCORING:ReportScoreAllSummary( PlayerGroup )
 
   local PlayerMessage = ""
 
-  self:T( { "Summary Score Report of All Players", Players = self.Players } )
+  self:T( "Report Score All Players" )
 
   for PlayerName, PlayerData in pairs( self.Players ) do
-  
-    self:T( { PlayerName = PlayerName, PlayerGroup = PlayerGroup } )
     
     if PlayerName then
     
       local ReportHits, ScoreHits, PenaltyHits = self:ReportDetailedPlayerHits( PlayerName )
       ReportHits = ReportHits ~= "" and "\n- " .. ReportHits or ReportHits 
-      self:F( { ReportHits, ScoreHits, PenaltyHits } )
+      self:E( { ReportHits, ScoreHits, PenaltyHits } )
 
       local ReportDestroys, ScoreDestroys, PenaltyDestroys = self:ReportDetailedPlayerDestroys( PlayerName )
       ReportDestroys = ReportDestroys ~= "" and "\n- " .. ReportDestroys or ReportDestroys
-      self:F( { ReportDestroys, ScoreDestroys, PenaltyDestroys } )
+      self:E( { ReportDestroys, ScoreDestroys, PenaltyDestroys } )
 
       local ReportCoalitionChanges, ScoreCoalitionChanges, PenaltyCoalitionChanges = self:ReportDetailedPlayerCoalitionChanges( PlayerName )
       ReportCoalitionChanges = ReportCoalitionChanges ~= "" and "\n- " .. ReportCoalitionChanges or ReportCoalitionChanges
-      self:F( { ReportCoalitionChanges, ScoreCoalitionChanges, PenaltyCoalitionChanges } )
+      self:E( { ReportCoalitionChanges, ScoreCoalitionChanges, PenaltyCoalitionChanges } )
 
       local ReportGoals, ScoreGoals, PenaltyGoals = self:ReportDetailedPlayerGoals( PlayerName )
       ReportGoals = ReportGoals ~= "" and "\n- " .. ReportGoals or ReportGoals
-      self:F( { ReportGoals, ScoreGoals, PenaltyGoals } )
+      self:E( { ReportGoals, ScoreGoals, PenaltyGoals } )
 
       local ReportMissions, ScoreMissions, PenaltyMissions = self:ReportDetailedPlayerMissions( PlayerName )
       ReportMissions = ReportMissions ~= "" and "\n- " .. ReportMissions or ReportMissions
-      self:F( { ReportMissions, ScoreMissions, PenaltyMissions } )
+      self:E( { ReportMissions, ScoreMissions, PenaltyMissions } )
       
       local PlayerScore = ScoreHits + ScoreDestroys + ScoreCoalitionChanges + ScoreGoals + ScoreMissions
       local PlayerPenalty = PenaltyHits + PenaltyDestroys + PenaltyCoalitionChanges + ScoreGoals + PenaltyMissions
@@ -1800,7 +1682,7 @@ function SCORING:OpenCSV( ScoringCSV )
       error( "A string containing the CSV file name must be given." )
     end
   else
-    self:F( "The MissionScripting.lua file has not been changed to allow lfs, io and os modules to be used..." )
+    self:E( "The MissionScripting.lua file has not been changed to allow lfs, io and os modules to be used..." )
   end
   return self
 end

Moose Development/Moose/Functional/Sead.lua

@@ -1,41 +1,12 @@
---- **Functional** -- Make SAM sites execute evasive and defensive behaviour when being fired upon.
+--- **Functional** -- Provides defensive behaviour to a set of SAM sites within a running Mission.
 -- 
--- ===
+-- ====
 -- 
--- ## Features:
--- 
---   * When SAM sites are being fired upon, the SAMs will take evasive action will reposition themselves when possible.
---   * When SAM sites are being fired upon, the SAMs will take defensive action by shutting down their radars.
--- 
--- ===
--- 
--- ## Missions:
--- 
--- [SEV - SEAD Evasion](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/SEV%20-%20SEAD%20Evasion)
--- 
--- ===
--- 
--- ### Authors: **FlightControl**
--- 
--- ===
--- 
--- @module Functional.Sead
--- @image SEAD.JPG
+-- @module Sead
 
---- @type SEAD
+--- The SEAD class
+-- @type SEAD
 -- @extends Core.Base#BASE
-
---- Make SAM sites execute evasive and defensive behaviour when being fired upon.
--- 
--- This class is very easy to use. Just setup a SEAD object by using @{#SEAD.New}() and SAMs will evade and take defensive action when being fired upon.
--- 
--- # Constructor:
--- 
--- Use the @{#SEAD.New}() constructor to create a new SEAD object.
--- 
---       SEAD_RU_SAM_Defenses = SEAD:New( { 'RU SA-6 Kub', 'RU SA-6 Defenses', 'RU MI-26 Troops', 'RU Attack Gori' } )
--- 
--- @field #SEAD
 SEAD = {
 	ClassName = "SEAD", 
 	TargetSkill = {

Moose Development/Moose/Functional/ZoneCaptureCoalition.lua

@@ -1,793 +0,0 @@
---- **Functional** -- Models the process to zone guarding and capturing.
---
--- ===
--- 
--- ## Features:
--- 
---   * Models the possible state transitions between the Guarded, Attacked, Empty and Captured states.
---   * A zone has an owning coalition, that means that at a specific point in time, a zone can be owned by the red or blue coalition.
---   * Provide event handlers to tailor the actions when a zone changes coalition or state.
--- 
--- ===
--- 
--- ## Missions:
--- 
--- [CAZ - Capture Zones](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/CAZ%20-%20Capture%20Zones)
--- 
--- ===
--- 
--- # Player Experience
--- 
--- ![States](..\Presentations\ZONE_CAPTURE_COALITION\Dia3.JPG)
---  
--- The above models the possible state transitions between the **Guarded**, **Attacked**, **Empty** and **Captured** states.  
--- A zone has an __owning coalition__, that means that at a specific point in time, a zone can be owned by the red or blue coalition.
---
--- The Zone can be in the state **Guarded** by the __owning coalition__, which is the coalition that initially occupies the zone with units of its coalition.  
--- Once units of an other coalition are entering the Zone, the state will change to **Attacked**. As long as these units remain in the zone, the state keeps set to Attacked.  
--- When all units are destroyed in the Zone, the state will change to **Empty**, which expresses that the Zone is empty, and can be captured.  
--- When units of the other coalition are in the Zone, and no other units of the owning coalition is in the Zone, the Zone is captured, and its state will change to **Captured**.  
--- 
--- The zone needs to be monitored regularly for the presence of units to interprete the correct state transition required.  
--- This monitoring process MUST be started using the @{#ZONE_CAPTURE_COALITION.Start}() method.  
--- Otherwise no monitoring will be active and the zone will stay in the current state forever.  
--- 
--- ===
--- 
--- ## [YouTube Playlist](https://www.youtube.com/watch?v=0m6K6Yxa-os&list=PL7ZUrU4zZUl0qqJsfa8DPvZWDY-OyDumE)
--- 
--- ===
--- 
--- ### Author: **FlightControl**
--- ### Contributions: **Millertime** - Concept
--- 
--- ===
--- 
--- @module Functional.ZoneCaptureCoalition
--- @image Capture_Zones.JPG
-
-do -- ZONE_CAPTURE_COALITION
-
-  --- @type ZONE_CAPTURE_COALITION
-  -- @extends Functional.ZoneGoalCoalition#ZONE_GOAL_COALITION
-
-
-  --- Models the process to capture a Zone for a Coalition, which is guarded by another Coalition.
-  -- This is a powerful concept that allows to create very dynamic missions based on the different state transitions of various zones.
-  -- 
-  -- ===
-  -- 
-  -- In order to use ZONE_CAPTURE_COALITION, you need to:
-  -- 
-  --   * Create a @{Zone} object from one of the ZONE_ classes.  
-  --     Note that ZONE_POLYGON_ classes are not yet functional.  
-  --     The only functional ZONE_ classses are those derived from a ZONE_RADIUS.
-  --   * Set the state of the zone. Most of the time, Guarded would be the initial state.
-  --   * Start the zone capturing **monitoring process**.  
-  --     This will check the presence of friendly and/or enemy units within the zone and will transition the state of the zone when the tactical situation changed.
-  --     The frequency of the monitoring must not be real-time, a 30 second interval to execute the checks is sufficient. 
-  -- 
-  -- ![New](..\Presentations\ZONE_CAPTURE_COALITION\Dia5.JPG)
-  -- 
-  -- ### Important:
-  -- 
-  -- You must start the monitoring process within your code, or there won't be any state transition checks executed.  
-  -- See further the start/stop monitoring process.
-  -- 
-  -- ### Important:
-  -- 
-  -- Ensure that the object containing the ZONE_CAPTURE_COALITION object is persistent.
-  -- Otherwise the garbage collector of lua will remove the object and the monitoring process will stop.
-  -- This will result in your object to be destroyed (removed) from internal memory and there won't be any zone state transitions anymore detected!
-  -- So use the `local` keyword in lua with thought! Most of the time, you can declare your object gobally.
-  -- 
-  -- 
-  -- 
-  -- # Example:
-  -- 
-  --       -- Define a new ZONE object, which is based on the trigger zone `CaptureZone`, which is defined within the mission editor.
-  --       CaptureZone = ZONE:New( "CaptureZone" )
-  --       
-  --       -- Here we create a new ZONE_CAPTURE_COALITION object, using the :New constructor.
-  --       ZoneCaptureCoalition = ZONE_CAPTURE_COALITION:New( CaptureZone, coalition.side.RED )
-  --       
-  --       -- Set the zone to Guarding state.
-  --       ZoneCaptureCoalition:__Guard( 1 )
-  --       
-  --       -- Start the zone monitoring process in 30 seconds and check every 30 seconds.
-  --       ZoneCaptureCoalition:Start( 30, 30 ) 
-  --   
-  -- 
-  -- # Constructor:
-  --   
-  -- Use the @{#ZONE_CAPTURE_COALITION.New}() constructor to create a new ZONE_CAPTURE_COALITION object.
-  -- 
-  -- # ZONE_CAPTURE_COALITION is a finite state machine (FSM).
-  -- 
-  -- ![States](..\Presentations\ZONE_CAPTURE_COALITION\Dia4.JPG)
-  -- 
-  -- ## ZONE_CAPTURE_COALITION States
-  -- 
-  --   * **Captured**: The Zone has been captured by an other coalition.
-  --   * **Attacked**: The Zone is currently intruded by an other coalition. There are units of the owning coalition and an other coalition in the Zone.
-  --   * **Guarded**: The Zone is guarded by the owning coalition. There is no other unit of an other coalition in the Zone.
-  --   * **Empty**: The Zone is empty. There is not valid unit in the Zone.
-  --   
-  -- ## 2.2 ZONE_CAPTURE_COALITION Events
-  -- 
-  --   * **Capture**: The Zone has been captured by an other coalition.
-  --   * **Attack**: The Zone is currently intruded by an other coalition. There are units of the owning coalition and an other coalition in the Zone.
-  --   * **Guard**: The Zone is guarded by the owning coalition. There is no other unit of an other coalition in the Zone.
-  --   * **Empty**: The Zone is empty. There is not valid unit in the Zone.
-  -- 
-  -- # "Script It"
-  -- 
-  -- ZONE_CAPTURE_COALITION allows to take action on the various state transitions and add your custom code and logic.
-  -- 
-  -- ## Take action using state- and event handlers.
-  -- 
-  -- ![States](..\Presentations\ZONE_CAPTURE_COALITION\Dia6.JPG)
-  -- 
-  -- The most important to understand is how states and events can be tailored.
-  -- Carefully study the diagram and the explanations.
-  -- 
-  -- **State Handlers** capture the moment:
-  -- 
-  --   - On Leave from the old state. Return false to cancel the transition.
-  --   - On Enter to the new state.
-  -- 
-  -- **Event Handlers** capture the moment:
-  -- 
-  --   - On Before the event is triggered. Return false to cancel the transition.
-  --   - On After the event is triggered.
-  -- 
-  -- ![States](..\Presentations\ZONE_CAPTURE_COALITION\Dia7.JPG)
-  -- 
-  -- Each handler can receive optionally 3 parameters:
-  -- 
-  --   - **From**: A string containing the From State.
-  --   - **Event**: A string containing the Event.
-  --   - **To**: A string containing the To State.
-  --   
-  -- The mission designer can use these values to alter the logic.
-  -- For example:
-  -- 
-  --     --- @param Functional.ZoneCaptureCoalition#ZONE_CAPTURE_COALITION self
-  --     function ZoneCaptureCoalition:OnEnterGuarded( From, Event, To )
-  --       if From ~= "Empty" then
-  --         -- Display a message
-  --       end
-  --     end
-  -- 
-  -- This code checks that when the __Guarded__ state has been reached, that if the **From** state was __Empty__, then display a message.
-  -- 
-  -- ## Example Event Handler.
-  -- 
-  --     --- @param Functional.ZoneCaptureCoalition#ZONE_CAPTURE_COALITION self
-  --     function ZoneCaptureCoalition:OnEnterGuarded( From, Event, To )
-  --       if From ~= To then
-  --         local Coalition = self:GetCoalition()
-  --         self:E( { Coalition = Coalition } )
-  --         if Coalition == coalition.side.BLUE then
-  --           ZoneCaptureCoalition:Smoke( SMOKECOLOR.Blue )
-  --           US_CC:MessageTypeToCoalition( string.format( "%s is under protection of the USA", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
-  --           RU_CC:MessageTypeToCoalition( string.format( "%s is under protection of the USA", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
-  --         else
-  --           ZoneCaptureCoalition:Smoke( SMOKECOLOR.Red )
-  --           RU_CC:MessageTypeToCoalition( string.format( "%s is under protection of Russia", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
-  --           US_CC:MessageTypeToCoalition( string.format( "%s is under protection of Russia", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
-  --         end
-  --       end
-  --     end
-  --     
-  -- ## Stop and Start the zone monitoring process.
-  -- 
-  -- At regular intervals, the state of the zone needs to be monitored.
-  -- The zone needs to be scanned for the presence of units within the zone boundaries.
-  -- Depending on the owning coalition of the zone and the presence of units (of the owning and/or other coalition(s)), the zone will transition to another state.
-  -- 
-  -- However, ... this scanning process is rather CPU intensive. Imagine you have 10 of these capture zone objects setup within your mission.
-  -- That would mean that your mission would check 10 capture zones simultaneously, each checking for the presence of units.
-  -- It would be highly **CPU inefficient**, as some of these zones are not required to be monitored (yet).
-  -- 
-  -- Therefore, the mission designer is given 2 methods that allow to take control of the CPU utilization efficiency:
-  -- 
-  --   * @{#ZONE_CAPTURE_COALITION.Start}(): This starts the monitoring process.
-  --   * @{#ZONE_CAPTURE_COALITION.Stop}(): This stops the monitoring process.
-  --   
-  -- ### IMPORTANT
-  -- 
-  -- **Each capture zone object must have the monitoring process started specifically.
-  -- The monitoring process is NOT started by default!!!**
-  --   
-  -- 
-  -- # Full Example
-  -- 
-  -- The following annotated code shows a real example of how ZONE_CAPTURE_COALITION can be applied.
-  -- 
-  -- The concept is simple.
-  -- 
-  -- The USA (US), blue coalition, needs to capture the Russian (RU), red coalition, zone, which is near groom lake.
-  -- 
-  -- A capture zone has been setup that guards the presence of the troops.
-  -- Troops are guarded by red forces. Blue is required to destroy the red forces and capture the zones.
-  -- 
-  -- At first, we setup the Command Centers
-  -- 
-  --      do
-  --        
-  --        RU_CC = COMMANDCENTER:New( GROUP:FindByName( "REDHQ" ), "Russia HQ" )
-  --        US_CC = COMMANDCENTER:New( GROUP:FindByName( "BLUEHQ" ), "USA HQ" )
-  --      
-  --      end
-  --      
-  -- Next, we define the mission, and add some scoring to it.
-  --      
-  --      do -- Missions
-  --        
-  --        US_Mission_EchoBay = MISSION:New( US_CC, "Echo Bay", "Primary",
-  --          "Welcome trainee. The airport Groom Lake in Echo Bay needs to be captured.\n" ..
-  --          "There are five random capture zones located at the airbase.\n" ..
-  --          "Move to one of the capture zones, destroy the fuel tanks in the capture zone, " ..
-  --          "and occupy each capture zone with a platoon.\n " .. 
-  --          "Your orders are to hold position until all capture zones are taken.\n" ..
-  --          "Use the map (F10) for a clear indication of the location of each capture zone.\n" ..
-  --          "Note that heavy resistance can be expected at the airbase!\n" ..
-  --          "Mission 'Echo Bay' is complete when all five capture zones are taken, and held for at least 5 minutes!"
-  --          , coalition.side.RED )
-  --          
-  --        US_Mission_EchoBay:Start()
-  --      
-  --      end
-  --      
-  --      
-  -- Now the real work starts.
-  -- We define a **CaptureZone** object, which is a ZONE object.
-  -- Within the mission, a trigger zone is created with the name __CaptureZone__, with the defined radius within the mission editor.
-  -- 
-  --      CaptureZone = ZONE:New( "CaptureZone" )
-  -- 
-  -- Next, we define the **ZoneCaptureCoalition** object, as explained above.
-  --      
-  --      ZoneCaptureCoalition = ZONE_CAPTURE_COALITION:New( CaptureZone, coalition.side.RED ) 
-  --      
-  -- Of course, we want to let the **ZoneCaptureCoalition** object do something when the state transitions.
-  -- Do accomodate this, it is very simple, as explained above.
-  -- We use **Event Handlers** to tailor the logic.
-  -- 
-  -- Here we place an Event Handler at the Guarded event. So when the **Guarded** event is triggered, then this method is called!
-  -- With the variables **From**, **Event**, **To**. Each of these variables containing a string.
-  -- 
-  -- We check if the previous state wasn't Guarded also.
-  -- If not, we retrieve the owning Coalition of the **ZoneCaptureCoalition**, using `self:GetCoalition()`.
-  -- So **Coalition** will contain the current owning coalition of the zone.
-  -- 
-  -- Depending on the zone ownership, different messages are sent.
-  -- Note the methods `ZoneCaptureCoalition:GetZoneName()`.
-  --      
-  --      --- @param Functional.ZoneCaptureCoalition#ZONE_CAPTURE_COALITION self
-  --      function ZoneCaptureCoalition:OnEnterGuarded( From, Event, To )
-  --        if From ~= To then
-  --          local Coalition = self:GetCoalition()
-  --          self:E( { Coalition = Coalition } )
-  --          if Coalition == coalition.side.BLUE then
-  --            ZoneCaptureCoalition:Smoke( SMOKECOLOR.Blue )
-  --            US_CC:MessageTypeToCoalition( string.format( "%s is under protection of the USA", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
-  --            RU_CC:MessageTypeToCoalition( string.format( "%s is under protection of the USA", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
-  --          else
-  --            ZoneCaptureCoalition:Smoke( SMOKECOLOR.Red )
-  --            RU_CC:MessageTypeToCoalition( string.format( "%s is under protection of Russia", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
-  --            US_CC:MessageTypeToCoalition( string.format( "%s is under protection of Russia", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
-  --          end
-  --        end
-  --      end
-  -- 
-  -- As you can see, not a rocket science.
-  -- Next is the Event Handler when the **Empty** state transition is triggered.
-  -- Now we smoke the ZoneCaptureCoalition with a green color, using `self:Smoke( SMOKECOLOR.Green )`.
-  --      
-  --      --- @param Functional.Protect#ZONE_CAPTURE_COALITION self
-  --      function ZoneCaptureCoalition:OnEnterEmpty()
-  --        self:Smoke( SMOKECOLOR.Green )
-  --        US_CC:MessageTypeToCoalition( string.format( "%s is unprotected, and can be captured!", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
-  --        RU_CC:MessageTypeToCoalition( string.format( "%s is unprotected, and can be captured!", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
-  --      end
-  -- 
-  -- The next Event Handlers speak for itself.
-  -- When the zone is Attacked, we smoke the zone white and send some messages to each coalition.     
-  --      
-  --      --- @param Functional.Protect#ZONE_CAPTURE_COALITION self
-  --      function ZoneCaptureCoalition:OnEnterAttacked()
-  --        ZoneCaptureCoalition:Smoke( SMOKECOLOR.White )
-  --        local Coalition = self:GetCoalition()
-  --        self:E({Coalition = Coalition})
-  --        if Coalition == coalition.side.BLUE then
-  --          US_CC:MessageTypeToCoalition( string.format( "%s is under attack by Russia", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
-  --          RU_CC:MessageTypeToCoalition( string.format( "We are attacking %s", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
-  --        else
-  --          RU_CC:MessageTypeToCoalition( string.format( "%s is under attack by the USA", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
-  --          US_CC:MessageTypeToCoalition( string.format( "We are attacking %s", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
-  --        end
-  --      end
-  -- 
-  -- When the zone is Captured, we send some victory or loss messages to the correct coalition.
-  -- And we add some score.
-  -- 
-  --      --- @param Functional.Protect#ZONE_CAPTURE_COALITION self
-  --      function ZoneCaptureCoalition:OnEnterCaptured()
-  --        local Coalition = self:GetCoalition()
-  --        self:E({Coalition = Coalition})
-  --        if Coalition == coalition.side.BLUE then
-  --          RU_CC:MessageTypeToCoalition( string.format( "%s is captured by the USA, we lost it!", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
-  --          US_CC:MessageTypeToCoalition( string.format( "We captured %s, Excellent job!", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
-  --        else
-  --          US_CC:MessageTypeToCoalition( string.format( "%s is captured by Russia, we lost it!", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
-  --          RU_CC:MessageTypeToCoalition( string.format( "We captured %s, Excellent job!", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
-  --        end
-  --        
-  --        self:__Guard( 30 )
-  --      end
-  -- 
-  -- And this call is the most important of all!
-  -- In the context of the mission, we need to start the zone capture monitoring process.
-  -- Or nothing will be monitored and the zone won't change states.
-  -- We start the monitoring after 5 seconds, and will repeat every 30 seconds a check.
-  --        
-  --      ZoneCaptureCoalition:Start( 5, 30 )
-  --      
-  -- 
-  -- @field #ZONE_CAPTURE_COALITION
-  ZONE_CAPTURE_COALITION = {
-    ClassName = "ZONE_CAPTURE_COALITION",
-  }
-  
-  --- @field #table ZONE_CAPTURE_COALITION.States
-  ZONE_CAPTURE_COALITION.States = {}
-  
-  --- ZONE_CAPTURE_COALITION Constructor.
-  -- @param #ZONE_CAPTURE_COALITION self
-  -- @param Core.Zone#ZONE Zone A @{Zone} object with the goal to be achieved.
-  -- @param DCSCoalition.DCSCoalition#coalition Coalition The initial coalition owning the zone.
-  -- @return #ZONE_CAPTURE_COALITION
-  -- @usage
-  -- 
-  --  AttackZone = ZONE:New( "AttackZone" )
-  --
-  --  ZoneCaptureCoalition = ZONE_CAPTURE_COALITION:New( AttackZone, coalition.side.RED ) -- Create a new ZONE_CAPTURE_COALITION object of zone AttackZone with ownership RED coalition.
-  --  ZoneCaptureCoalition:__Guard( 1 ) -- Start the Guarding of the AttackZone.
-  --  
-  function ZONE_CAPTURE_COALITION:New( Zone, Coalition )
-  
-    local self = BASE:Inherit( self, ZONE_GOAL_COALITION:New( Zone, Coalition ) ) -- #ZONE_CAPTURE_COALITION
-
-    self:F( { Zone = Zone, Coalition  = Coalition } )
-
-    do 
-    
-      --- Captured State Handler OnLeave for ZONE_CAPTURE_COALITION
-      -- @function [parent=#ZONE_CAPTURE_COALITION] OnLeaveCaptured
-      -- @param #ZONE_CAPTURE_COALITION self
-      -- @param #string From
-      -- @param #string Event
-      -- @param #string To
-      -- @return #boolean
-  
-      --- Captured State Handler OnEnter for ZONE_CAPTURE_COALITION
-      -- @function [parent=#ZONE_CAPTURE_COALITION] OnEnterCaptured
-      -- @param #ZONE_CAPTURE_COALITION self
-      -- @param #string From
-      -- @param #string Event
-      -- @param #string To
-  
-    end
-  
-  
-    do 
-    
-      --- Attacked State Handler OnLeave for ZONE_CAPTURE_COALITION
-      -- @function [parent=#ZONE_CAPTURE_COALITION] OnLeaveAttacked
-      -- @param #ZONE_CAPTURE_COALITION self
-      -- @param #string From
-      -- @param #string Event
-      -- @param #string To
-      -- @return #boolean
-  
-      --- Attacked State Handler OnEnter for ZONE_CAPTURE_COALITION
-      -- @function [parent=#ZONE_CAPTURE_COALITION] OnEnterAttacked
-      -- @param #ZONE_CAPTURE_COALITION self
-      -- @param #string From
-      -- @param #string Event
-      -- @param #string To
-  
-    end
-
-    do 
-    
-      --- Guarded State Handler OnLeave for ZONE_CAPTURE_COALITION
-      -- @function [parent=#ZONE_CAPTURE_COALITION] OnLeaveGuarded
-      -- @param #ZONE_CAPTURE_COALITION self
-      -- @param #string From
-      -- @param #string Event
-      -- @param #string To
-      -- @return #boolean
-  
-      --- Guarded State Handler OnEnter for ZONE_CAPTURE_COALITION
-      -- @function [parent=#ZONE_CAPTURE_COALITION] OnEnterGuarded
-      -- @param #ZONE_CAPTURE_COALITION self
-      -- @param #string From
-      -- @param #string Event
-      -- @param #string To
-  
-    end
-  
-
-    do 
-    
-      --- Empty State Handler OnLeave for ZONE_CAPTURE_COALITION
-      -- @function [parent=#ZONE_CAPTURE_COALITION] OnLeaveEmpty
-      -- @param #ZONE_CAPTURE_COALITION self
-      -- @param #string From
-      -- @param #string Event
-      -- @param #string To
-      -- @return #boolean
-  
-      --- Empty State Handler OnEnter for ZONE_CAPTURE_COALITION
-      -- @function [parent=#ZONE_CAPTURE_COALITION] OnEnterEmpty
-      -- @param #ZONE_CAPTURE_COALITION self
-      -- @param #string From
-      -- @param #string Event
-      -- @param #string To
-  
-    end
-  
-    self:AddTransition( "*", "Guard", "Guarded" )
-    
-    --- Guard Handler OnBefore for ZONE_CAPTURE_COALITION
-    -- @function [parent=#ZONE_CAPTURE_COALITION] OnBeforeGuard
-    -- @param #ZONE_CAPTURE_COALITION self
-    -- @param #string From
-    -- @param #string Event
-    -- @param #string To
-    -- @return #boolean
-    
-    --- Guard Handler OnAfter for ZONE_CAPTURE_COALITION
-    -- @function [parent=#ZONE_CAPTURE_COALITION] OnAfterGuard
-    -- @param #ZONE_CAPTURE_COALITION self
-    -- @param #string From
-    -- @param #string Event
-    -- @param #string To
-    
-    --- Guard Trigger for ZONE_CAPTURE_COALITION
-    -- @function [parent=#ZONE_CAPTURE_COALITION] Guard
-    -- @param #ZONE_CAPTURE_COALITION self
-    
-    --- Guard Asynchronous Trigger for ZONE_CAPTURE_COALITION
-    -- @function [parent=#ZONE_CAPTURE_COALITION] __Guard
-    -- @param #ZONE_CAPTURE_COALITION self
-    -- @param #number Delay
-    
-    self:AddTransition( "*", "Empty", "Empty" )
-    
-    --- Empty Handler OnBefore for ZONE_CAPTURE_COALITION
-    -- @function [parent=#ZONE_CAPTURE_COALITION] OnBeforeEmpty
-    -- @param #ZONE_CAPTURE_COALITION self
-    -- @param #string From
-    -- @param #string Event
-    -- @param #string To
-    -- @return #boolean
-    
-    --- Empty Handler OnAfter for ZONE_CAPTURE_COALITION
-    -- @function [parent=#ZONE_CAPTURE_COALITION] OnAfterEmpty
-    -- @param #ZONE_CAPTURE_COALITION self
-    -- @param #string From
-    -- @param #string Event
-    -- @param #string To
-    
-    --- Empty Trigger for ZONE_CAPTURE_COALITION
-    -- @function [parent=#ZONE_CAPTURE_COALITION] Empty
-    -- @param #ZONE_CAPTURE_COALITION self
-    
-    --- Empty Asynchronous Trigger for ZONE_CAPTURE_COALITION
-    -- @function [parent=#ZONE_CAPTURE_COALITION] __Empty
-    -- @param #ZONE_CAPTURE_COALITION self
-    -- @param #number Delay
-    
-    
-    self:AddTransition( {  "Guarded", "Empty" }, "Attack", "Attacked" )
-  
-    --- Attack Handler OnBefore for ZONE_CAPTURE_COALITION
-    -- @function [parent=#ZONE_CAPTURE_COALITION] OnBeforeAttack
-    -- @param #ZONE_CAPTURE_COALITION self
-    -- @param #string From
-    -- @param #string Event
-    -- @param #string To
-    -- @return #boolean
-    
-    --- Attack Handler OnAfter for ZONE_CAPTURE_COALITION
-    -- @function [parent=#ZONE_CAPTURE_COALITION] OnAfterAttack
-    -- @param #ZONE_CAPTURE_COALITION self
-    -- @param #string From
-    -- @param #string Event
-    -- @param #string To
-    
-    --- Attack Trigger for ZONE_CAPTURE_COALITION
-    -- @function [parent=#ZONE_CAPTURE_COALITION] Attack
-    -- @param #ZONE_CAPTURE_COALITION self
-    
-    --- Attack Asynchronous Trigger for ZONE_CAPTURE_COALITION
-    -- @function [parent=#ZONE_CAPTURE_COALITION] __Attack
-    -- @param #ZONE_CAPTURE_COALITION self
-    -- @param #number Delay
-    
-    self:AddTransition( { "Guarded", "Attacked", "Empty" }, "Capture", "Captured" )
-   
-    --- Capture Handler OnBefore for ZONE_CAPTURE_COALITION
-    -- @function [parent=#ZONE_CAPTURE_COALITION] OnBeforeCapture
-    -- @param #ZONE_CAPTURE_COALITION self
-    -- @param #string From
-    -- @param #string Event
-    -- @param #string To
-    -- @return #boolean
-    
-    --- Capture Handler OnAfter for ZONE_CAPTURE_COALITION
-    -- @function [parent=#ZONE_CAPTURE_COALITION] OnAfterCapture
-    -- @param #ZONE_CAPTURE_COALITION self
-    -- @param #string From
-    -- @param #string Event
-    -- @param #string To
-    
-    --- Capture Trigger for ZONE_CAPTURE_COALITION
-    -- @function [parent=#ZONE_CAPTURE_COALITION] Capture
-    -- @param #ZONE_CAPTURE_COALITION self
-    
-    --- Capture Asynchronous Trigger for ZONE_CAPTURE_COALITION
-    -- @function [parent=#ZONE_CAPTURE_COALITION] __Capture
-    -- @param #ZONE_CAPTURE_COALITION self
-    -- @param #number Delay
-
-    return self
-  end
-  
-
-  --- @param #ZONE_CAPTURE_COALITION self
-  function ZONE_CAPTURE_COALITION:onenterCaptured()
-  
-    self:GetParent( self, ZONE_CAPTURE_COALITION ).onenterCaptured( self )
-    
-    self.Goal:Achieved()
-  end
-
-
-  function ZONE_CAPTURE_COALITION:IsGuarded()
-  
-    local IsGuarded = self.Zone:IsAllInZoneOfCoalition( self.Coalition )
-    self:F( { IsGuarded = IsGuarded } )
-    return IsGuarded
-  end
-
-
-  function ZONE_CAPTURE_COALITION:IsEmpty()
-  
-    local IsEmpty = self.Zone:IsNoneInZone()
-    self:F( { IsEmpty = IsEmpty } )
-    return IsEmpty
-  end
-
-
-  function ZONE_CAPTURE_COALITION:IsCaptured()
-  
-    local IsCaptured = self.Zone:IsAllInZoneOfOtherCoalition( self.Coalition )
-    self:F( { IsCaptured = IsCaptured } )
-    return IsCaptured
-  end
-  
-  
-  function ZONE_CAPTURE_COALITION:IsAttacked()
-  
-    local IsAttacked = self.Zone:IsSomeInZoneOfCoalition( self.Coalition )
-    self:F( { IsAttacked = IsAttacked } )
-    return IsAttacked
-  end
-  
-  
-
-  --- Mark.
-  -- @param #ZONE_CAPTURE_COALITION self
-  function ZONE_CAPTURE_COALITION:Mark()
-  
-    local Coord = self.Zone:GetCoordinate()
-    local ZoneName = self:GetZoneName()
-    local State = self:GetState()
-    
-    if self.MarkRed and self.MarkBlue then
-      self:F( { MarkRed = self.MarkRed, MarkBlue = self.MarkBlue } )
-      Coord:RemoveMark( self.MarkRed )
-      Coord:RemoveMark( self.MarkBlue )
-    end
-    
-    if self.Coalition == coalition.side.BLUE then
-      self.MarkBlue = Coord:MarkToCoalitionBlue( "Coalition: Blue\nGuard Zone: " .. ZoneName .. "\nStatus: " .. State )  
-      self.MarkRed = Coord:MarkToCoalitionRed( "Coalition: Blue\nCapture Zone: " .. ZoneName .. "\nStatus: " .. State )
-    else
-      self.MarkRed = Coord:MarkToCoalitionRed( "Coalition: Red\nGuard Zone: " .. ZoneName .. "\nStatus: " .. State )  
-      self.MarkBlue = Coord:MarkToCoalitionBlue( "Coalition: Red\nCapture Zone: " .. ZoneName .. "\nStatus: " .. State )  
-    end
-  end
-
-  --- Bound.
-  -- @param #ZONE_CAPTURE_COALITION self
-  function ZONE_CAPTURE_COALITION:onenterGuarded()
-  
-    --self:GetParent( self ):onenterGuarded()
-  
-    if self.Coalition == coalition.side.BLUE then
-      --elf.ProtectZone:BoundZone( 12, country.id.USA )
-    else
-      --self.ProtectZone:BoundZone( 12, country.id.RUSSIA )
-    end
-    
-    self:Mark()
-    
-  end
-  
-  function ZONE_CAPTURE_COALITION:onenterCaptured()
-  
-    --self:GetParent( self ):onenterCaptured()
-
-    local NewCoalition = self.Zone:GetScannedCoalition()
-    self:F( { NewCoalition = NewCoalition } )
-    self:SetCoalition( NewCoalition )
-  
-    self:Mark()
-  end
-  
-  
-  function ZONE_CAPTURE_COALITION:onenterEmpty()
-
-    --self:GetParent( self ):onenterEmpty()
-  
-    self:Mark()
-  end
-  
-  
-  function ZONE_CAPTURE_COALITION:onenterAttacked()
-  
-    --self:GetParent( self ):onenterAttacked()
-  
-    self:Mark()
-  end
-
-
-  --- When started, check the Coalition status.
-  -- @param #ZONE_CAPTURE_COALITION self
-  function ZONE_CAPTURE_COALITION:onafterGuard()
-  
-    --self:F({BASE:GetParent( self )})
-    --BASE:GetParent( self ).onafterGuard( self )
-  
-    if not self.SmokeScheduler then
-      self.SmokeScheduler = self:ScheduleRepeat( 1, 1, 0.1, nil, self.StatusSmoke, self )
-    end
-  end
-
-
-  function ZONE_CAPTURE_COALITION:IsCaptured()
-  
-    local IsCaptured = self.Zone:IsAllInZoneOfOtherCoalition( self.Coalition )
-    self:F( { IsCaptured = IsCaptured } )
-    return IsCaptured
-  end
-  
-  
-  function ZONE_CAPTURE_COALITION:IsAttacked()
-  
-    local IsAttacked = self.Zone:IsSomeInZoneOfCoalition( self.Coalition )
-    self:F( { IsAttacked = IsAttacked } )
-    return IsAttacked
-  end
-  
-
-  --- Check status Coalition ownership.
-  -- @param #ZONE_CAPTURE_COALITION self
-  function ZONE_CAPTURE_COALITION:StatusZone()
-  
-    local State = self:GetState()
-    self:F( { State = self:GetState() } )
-  
-    self:GetParent( self, ZONE_CAPTURE_COALITION ).StatusZone( self )
-    
-    if State ~= "Guarded" and self:IsGuarded() then
-      self:Guard()
-    end
-    
-    if State ~= "Empty" and self:IsEmpty() then  
-      self:Empty()
-    end
-
-    if State ~= "Attacked" and self:IsAttacked() then
-      self:Attack()
-    end
-    
-    if State ~= "Captured" and self:IsCaptured() then  
-      self:Capture()
-    end
-    
-  end
-
-  --- Starts the zone capturing monitoring process.
-  -- This process can be CPU intensive, ensure that you specify reasonable time intervals for the monitoring process.
-  -- Note that the monitoring process is NOT started automatically during the `:New()` constructor.
-  -- It is advised that the zone monitoring process is only started when the monitoring is of relevance in context of the current mission goals.
-  -- When the zone is of no relevance, it is advised NOT to start the monitoring process, or to stop the monitoring process to save CPU resources.
-  -- Therefore, the mission designer will need to use the `:Start()` method within his script to start the monitoring process specifically.  
-  -- @param #ZONE_CAPTURE_COALITION self
-  -- @param #number StartInterval (optional) Specifies the start time interval in seconds when the zone state will be checked for the first time.
-  -- @param #number RepeatInterval (optional) Specifies the repeat time interval in seconds when the zone state will be checked repeatedly.
-  -- @usage
-  -- 
-  -- -- Setup the zone.
-  -- CaptureZone = ZONE:New( "CaptureZone" )
-  -- ZoneCaptureCoalition = ZONE_CAPTURE_COALITION:New( CaptureZone, coalition.side.RED )
-  --
-  -- -- This starts the monitoring process within 15 seconds, repeating every 15 seconds.
-  -- ZoneCaptureCoalition:Start() 
-  --      
-  -- -- This starts the monitoring process immediately, but repeats every 30 seconds.
-  -- ZoneCaptureCoalition:Start( 0, 30 ) 
-  -- 
-  function ZONE_CAPTURE_COALITION:Start( StartInterval, RepeatInterval )
-  
-    StartInterval = StartInterval or 15
-    RepeatInterval = RepeatInterval or 15
-  
-    if self.ScheduleStatusZone then
-      self:ScheduleStop( self.ScheduleStatusZone )
-    end
-    self.ScheduleStatusZone = self:ScheduleRepeat( StartInterval, RepeatInterval, 0.1, nil, self.StatusZone, self )
-  end
-  
-
-  --- Stops the zone capturing monitoring process.
-  -- When the zone capturing monitor process is stopped, there won't be any changes anymore in the state and the owning coalition of the zone.
-  -- This method becomes really useful when the zone is of no relevance anymore within a long lasting mission.
-  -- In this case, it is advised to stop the monitoring process, not to consume unnecessary the CPU intensive scanning of units presence within the zone.
-  -- @param #ZONE_CAPTURE_COALITION self
-  -- @usage 
-  -- -- Setup the zone.
-  -- CaptureZone = ZONE:New( "CaptureZone" )
-  -- ZoneCaptureCoalition = ZONE_CAPTURE_COALITION:New( CaptureZone, coalition.side.RED )
-  --
-  -- -- This starts the monitoring process within 15 seconds, repeating every 15 seconds.
-  -- ZoneCaptureCoalition:Start() 
-  -- 
-  -- -- When the zone capturing is of no relevance anymore, stop the monitoring!
-  -- ZoneCaptureCoalition:Stop()
-  -- 
-  -- @usage
-  -- -- For example, one could stop the monitoring when the zone was captured!
-  -- --- @param Functional.Protect#ZONE_CAPTURE_COALITION self
-  -- function ZoneCaptureCoalition:OnEnterCaptured()
-  --   local Coalition = self:GetCoalition()
-  --   self:E({Coalition = Coalition})
-  --   if Coalition == coalition.side.BLUE then
-  --     RU_CC:MessageTypeToCoalition( string.format( "%s is captured by the USA, we lost it!", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
-  --     US_CC:MessageTypeToCoalition( string.format( "We captured %s, Excellent job!", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
-  --   else
-  --     US_CC:MessageTypeToCoalition( string.format( "%s is captured by Russia, we lost it!", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
-  --     RU_CC:MessageTypeToCoalition( string.format( "We captured %s, Excellent job!", ZoneCaptureCoalition:GetZoneName() ), MESSAGE.Type.Information )
-  --   end
-  --  
-  --   self:AddScore( "Captured", "Zone captured: Extra points granted.", 200 )    
-  --  
-  --   self:Stop()
-  -- end
-  -- 
-  function ZONE_CAPTURE_COALITION:Stop()
-  
-    if self.ScheduleStatusZone then
-      self:ScheduleStop( self.ScheduleStatusZone )
-    end
-  end
-  
-end
-

Moose Development/Moose/Functional/ZoneGoal.lua

@@ -1,176 +0,0 @@
---- **Functional (WIP)** -- Base class that models processes to achieve goals involving a Zone.
---
--- ===
--- 
--- ZONE_GOAL models processes that have a Goal with a defined achievement involving a Zone. 
--- Derived classes implement the ways how the achievements can be realized.
--- 
--- ===
--- 
--- ### Author: **FlightControl**
--- 
--- ===
--- 
--- @module Functional.ZoneGoal
--- @image MOOSE.JPG
-
-do -- Zone
-
-  --- @type ZONE_GOAL
-  -- @extends Core.Fsm#FSM
-
-
-  -- Models processes that have a Goal with a defined achievement involving a Zone. 
-  -- Derived classes implement the ways how the achievements can be realized.
-  -- 
-  -- ## 1. ZONE_GOAL constructor
-  --   
-  --   * @{#ZONE_GOAL.New}(): Creates a new ZONE_GOAL object.
-  -- 
-  -- ## 2. ZONE_GOAL is a finite state machine (FSM).
-  -- 
-  -- ### 2.1 ZONE_GOAL States
-  -- 
-  --  * None: Initial State
-  -- 
-  -- ### 2.2 ZONE_GOAL Events
-  -- 
-  --   * DestroyedUnit: A @{Wrapper.Unit} is destroyed in the Zone. The event will only get triggered if the method @{#ZONE_GOAL.MonitorDestroyedUnits}() is used.
-  -- 
-  -- @field #ZONE_GOAL
-  ZONE_GOAL = {
-    ClassName = "ZONE_GOAL",
-  }
-  
-  --- ZONE_GOAL Constructor.
-  -- @param #ZONE_GOAL self
-  -- @param Core.Zone#ZONE_BASE Zone A @{Zone} object with the goal to be achieved.
-  -- @return #ZONE_GOAL
-  function ZONE_GOAL:New( Zone )
-  
-    local self = BASE:Inherit( self, FSM:New() ) -- #ZONE_GOAL
-    self:F( { Zone = Zone } )
-
-    self.Zone = Zone -- Core.Zone#ZONE_BASE
-    self.Goal = GOAL:New()
-
-    self.SmokeTime = nil
-
-    self:AddTransition( "*", "DestroyedUnit", "*" )
-  
-    --- DestroyedUnit Handler OnAfter for ZONE_GOAL
-    -- @function [parent=#ZONE_GOAL] OnAfterDestroyedUnit
-    -- @param #ZONE_GOAL self
-    -- @param #string From
-    -- @param #string Event
-    -- @param #string To
-    -- @param Wrapper.Unit#UNIT DestroyedUnit The destroyed unit.
-    -- @param #string PlayerName The name of the player.
-
-    return self
-  end
-  
-  --- Get the Zone
-  -- @param #ZONE_GOAL self
-  -- @return Core.Zone#ZONE_BASE
-  function ZONE_GOAL:GetZone()
-    return self.Zone
-  end
-  
-  
-  --- Get the name of the ProtectZone
-  -- @param #ZONE_GOAL self
-  -- @return #string
-  function ZONE_GOAL:GetZoneName()
-    return self.Zone:GetName()
-  end
-
-
-  --- Smoke the center of theh zone.
-  -- @param #ZONE_GOAL self
-  -- @param #SMOKECOLOR.Color SmokeColor
-  function ZONE_GOAL:Smoke( SmokeColor )
-  
-    self:F( { SmokeColor = SmokeColor} )
-  
-    self.SmokeColor = SmokeColor
-  end
-    
-  
-  --- Flare the center of the zone.
-  -- @param #ZONE_GOAL self
-  -- @param #SMOKECOLOR.Color FlareColor
-  function ZONE_GOAL:Flare( FlareColor )
-    self.Zone:FlareZone( FlareColor, math.random( 1, 360 ) )
-  end
-
-
-  --- When started, check the Smoke and the Zone status.
-  -- @param #ZONE_GOAL self
-  function ZONE_GOAL:onafterGuard()
-  
-    --self:GetParent( self ):onafterStart()
-    
-    self:F("Guard")
-  
-    --self:ScheduleRepeat( 15, 15, 0.1, nil, self.StatusZone, self )
-    if not self.SmokeScheduler then
-      self.SmokeScheduler = self:ScheduleRepeat( 1, 1, 0.1, nil, self.StatusSmoke, self )
-    end
-  end
-
-
-  --- Check status Smoke.
-  -- @param #ZONE_GOAL self
-  function ZONE_GOAL:StatusSmoke()
-  
-    self:F({self.SmokeTime, self.SmokeColor})
-    
-    local CurrentTime = timer.getTime()
-  
-    if self.SmokeTime == nil or self.SmokeTime + 300 <= CurrentTime then
-      if self.SmokeColor then
-        self.Zone:GetCoordinate():Smoke( self.SmokeColor )
-        --self.SmokeColor = nil
-        self.SmokeTime = CurrentTime
-      end
-    end
-  end
-
-
-  --- @param #ZONE_GOAL self
-  -- @param Core.Event#EVENTDATA EventData
-  function ZONE_GOAL:__Destroyed( EventData )
-    self:F( { "EventDead", EventData } )
-
-    self:F( { EventData.IniUnit } )
-    
-    local Vec3 = EventData.IniDCSUnit:getPosition().p
-    self:F( { Vec3 = Vec3 } )
-    local ZoneGoal = self:GetZone()
-    self:F({ZoneGoal})
-
-    if EventData.IniDCSUnit then
-      if ZoneGoal:IsVec3InZone(Vec3)  then
-        local PlayerHits = _DATABASE.HITS[EventData.IniUnitName]
-        if PlayerHits then
-          for PlayerName, PlayerHit in pairs( PlayerHits.Players or {} ) do
-            self.Goal:AddPlayerContribution( PlayerName )
-            self:DestroyedUnit( EventData.IniUnitName, PlayerName )
-          end
-        end
-      end
-    end
-  end
-  
-  
-  --- Activate the event UnitDestroyed to be fired when a unit is destroyed in the zone.
-  -- @param #ZONE_GOAL self
-  function ZONE_GOAL:MonitorDestroyedUnits()
-
-    self:HandleEvent( EVENTS.Dead,  self.__Destroyed )
-    self:HandleEvent( EVENTS.Crash, self.__Destroyed )
-  
-  end
-  
-end

Moose Development/Moose/Functional/ZoneGoalCargo.lua

@@ -1,451 +0,0 @@
---- **Functional (WIP)** -- Base class that models processes to achieve goals involving a Zone and Cargo.
---
--- ===
--- 
--- ZONE_GOAL_CARGO models processes that have a Goal with a defined achievement involving a Zone and Cargo.  
--- Derived classes implement the ways how the achievements can be realized.
--- 
--- ===
--- 
--- ### Author: **FlightControl**
--- 
--- ===
--- 
--- @module Functional.ZoneGoalCargo
--- @image MOOSE.JPG
-
-do -- ZoneGoal
-
-  --- @type ZONE_GOAL_CARGO
-  -- @extends Functional.ZoneGoal#ZONE_GOAL
-
-
-  --- Models processes that have a Goal with a defined achievement involving a Zone and Cargo.  
-  -- Derived classes implement the ways how the achievements can be realized.
-  -- 
-  -- ## 1. ZONE_GOAL_CARGO constructor
-  --   
-  --   * @{#ZONE_GOAL_CARGO.New}(): Creates a new ZONE_GOAL_CARGO object.
-  -- 
-  -- ## 2. ZONE_GOAL_CARGO is a finite state machine (FSM).
-  -- 
-  -- ### 2.1 ZONE_GOAL_CARGO States
-  --  
-  --   * **Deployed**: The Zone has been captured by an other coalition.
-  --   * **Airborne**: The Zone is currently intruded by an other coalition. There are units of the owning coalition and an other coalition in the Zone.
-  --   * **Loaded**: The Zone is guarded by the owning coalition. There is no other unit of an other coalition in the Zone.
-  --   * **Empty**: The Zone is empty. There is not valid unit in the Zone.
-  -- 
-  -- ### 2.2 ZONE_GOAL_CARGO Events
-  -- 
-  --   * **Capture**: The Zone has been captured by an other coalition.
-  --   * **Attack**: The Zone is currently intruded by an other coalition. There are units of the owning coalition and an other coalition in the Zone.
-  --   * **Guard**: The Zone is guarded by the owning coalition. There is no other unit of an other coalition in the Zone.
-  --   * **Empty**: The Zone is empty. There is not valid unit in the Zone.
-  --   
-  -- ### 2.3 ZONE_GOAL_CARGO State Machine
-  -- 
-  -- @field #ZONE_GOAL_CARGO
-  ZONE_GOAL_CARGO = {
-    ClassName = "ZONE_GOAL_CARGO",
-  }
-  
-  --- @field #table ZONE_GOAL_CARGO.States
-  ZONE_GOAL_CARGO.States = {}
-  
-  --- ZONE_GOAL_CARGO Constructor.
-  -- @param #ZONE_GOAL_CARGO self
-  -- @param Core.Zone#ZONE Zone A @{Zone} object with the goal to be achieved.
-  -- @param DCSCoalition.DCSCoalition#coalition Coalition The initial coalition owning the zone.
-  -- @return #ZONE_GOAL_CARGO
-  function ZONE_GOAL_CARGO:New( Zone, Coalition )
-  
-    local self = BASE:Inherit( self, ZONE_GOAL:New( Zone ) ) -- #ZONE_GOAL_CARGO
-    self:F( { Zone = Zone, Coalition  = Coalition  } )
-
-    self:SetCoalition( Coalition )
-
-    do 
-    
-      --- Captured State Handler OnLeave for ZONE_GOAL_CARGO
-      -- @function [parent=#ZONE_GOAL_CARGO] OnLeaveCaptured
-      -- @param #ZONE_GOAL_CARGO self
-      -- @param #string From
-      -- @param #string Event
-      -- @param #string To
-      -- @return #boolean
-  
-      --- Captured State Handler OnEnter for ZONE_GOAL_CARGO
-      -- @function [parent=#ZONE_GOAL_CARGO] OnEnterCaptured
-      -- @param #ZONE_GOAL_CARGO self
-      -- @param #string From
-      -- @param #string Event
-      -- @param #string To
-  
-    end
-  
-  
-    do 
-    
-      --- Attacked State Handler OnLeave for ZONE_GOAL_CARGO
-      -- @function [parent=#ZONE_GOAL_CARGO] OnLeaveAttacked
-      -- @param #ZONE_GOAL_CARGO self
-      -- @param #string From
-      -- @param #string Event
-      -- @param #string To
-      -- @return #boolean
-  
-      --- Attacked State Handler OnEnter for ZONE_GOAL_CARGO
-      -- @function [parent=#ZONE_GOAL_CARGO] OnEnterAttacked
-      -- @param #ZONE_GOAL_CARGO self
-      -- @param #string From
-      -- @param #string Event
-      -- @param #string To
-  
-    end
-
-    do 
-    
-      --- Guarded State Handler OnLeave for ZONE_GOAL_CARGO
-      -- @function [parent=#ZONE_GOAL_CARGO] OnLeaveGuarded
-      -- @param #ZONE_GOAL_CARGO self
-      -- @param #string From
-      -- @param #string Event
-      -- @param #string To
-      -- @return #boolean
-  
-      --- Guarded State Handler OnEnter for ZONE_GOAL_CARGO
-      -- @function [parent=#ZONE_GOAL_CARGO] OnEnterGuarded
-      -- @param #ZONE_GOAL_CARGO self
-      -- @param #string From
-      -- @param #string Event
-      -- @param #string To
-  
-    end
-  
-
-    do 
-    
-      --- Empty State Handler OnLeave for ZONE_GOAL_CARGO
-      -- @function [parent=#ZONE_GOAL_CARGO] OnLeaveEmpty
-      -- @param #ZONE_GOAL_CARGO self
-      -- @param #string From
-      -- @param #string Event
-      -- @param #string To
-      -- @return #boolean
-  
-      --- Empty State Handler OnEnter for ZONE_GOAL_CARGO
-      -- @function [parent=#ZONE_GOAL_CARGO] OnEnterEmpty
-      -- @param #ZONE_GOAL_CARGO self
-      -- @param #string From
-      -- @param #string Event
-      -- @param #string To
-  
-    end
-  
-    self:AddTransition( "*", "Guard", "Guarded" )
-    
-    --- Guard Handler OnBefore for ZONE_GOAL_CARGO
-    -- @function [parent=#ZONE_GOAL_CARGO] OnBeforeGuard
-    -- @param #ZONE_GOAL_CARGO self
-    -- @param #string From
-    -- @param #string Event
-    -- @param #string To
-    -- @return #boolean
-    
-    --- Guard Handler OnAfter for ZONE_GOAL_CARGO
-    -- @function [parent=#ZONE_GOAL_CARGO] OnAfterGuard
-    -- @param #ZONE_GOAL_CARGO self
-    -- @param #string From
-    -- @param #string Event
-    -- @param #string To
-    
-    --- Guard Trigger for ZONE_GOAL_CARGO
-    -- @function [parent=#ZONE_GOAL_CARGO] Guard
-    -- @param #ZONE_GOAL_CARGO self
-    
-    --- Guard Asynchronous Trigger for ZONE_GOAL_CARGO
-    -- @function [parent=#ZONE_GOAL_CARGO] __Guard
-    -- @param #ZONE_GOAL_CARGO self
-    -- @param #number Delay
-    
-    self:AddTransition( "*", "Empty", "Empty" )
-    
-    --- Empty Handler OnBefore for ZONE_GOAL_CARGO
-    -- @function [parent=#ZONE_GOAL_CARGO] OnBeforeEmpty
-    -- @param #ZONE_GOAL_CARGO self
-    -- @param #string From
-    -- @param #string Event
-    -- @param #string To
-    -- @return #boolean
-    
-    --- Empty Handler OnAfter for ZONE_GOAL_CARGO
-    -- @function [parent=#ZONE_GOAL_CARGO] OnAfterEmpty
-    -- @param #ZONE_GOAL_CARGO self
-    -- @param #string From
-    -- @param #string Event
-    -- @param #string To
-    
-    --- Empty Trigger for ZONE_GOAL_CARGO
-    -- @function [parent=#ZONE_GOAL_CARGO] Empty
-    -- @param #ZONE_GOAL_CARGO self
-    
-    --- Empty Asynchronous Trigger for ZONE_GOAL_CARGO
-    -- @function [parent=#ZONE_GOAL_CARGO] __Empty
-    -- @param #ZONE_GOAL_CARGO self
-    -- @param #number Delay
-    
-    
-    self:AddTransition( {  "Guarded", "Empty" }, "Attack", "Attacked" )
-  
-    --- Attack Handler OnBefore for ZONE_GOAL_CARGO
-    -- @function [parent=#ZONE_GOAL_CARGO] OnBeforeAttack
-    -- @param #ZONE_GOAL_CARGO self
-    -- @param #string From
-    -- @param #string Event
-    -- @param #string To
-    -- @return #boolean
-    
-    --- Attack Handler OnAfter for ZONE_GOAL_CARGO
-    -- @function [parent=#ZONE_GOAL_CARGO] OnAfterAttack
-    -- @param #ZONE_GOAL_CARGO self
-    -- @param #string From
-    -- @param #string Event
-    -- @param #string To
-    
-    --- Attack Trigger for ZONE_GOAL_CARGO
-    -- @function [parent=#ZONE_GOAL_CARGO] Attack
-    -- @param #ZONE_GOAL_CARGO self
-    
-    --- Attack Asynchronous Trigger for ZONE_GOAL_CARGO
-    -- @function [parent=#ZONE_GOAL_CARGO] __Attack
-    -- @param #ZONE_GOAL_CARGO self
-    -- @param #number Delay
-    
-    self:AddTransition( { "Guarded", "Attacked", "Empty" }, "Capture", "Captured" )
-   
-    --- Capture Handler OnBefore for ZONE_GOAL_CARGO
-    -- @function [parent=#ZONE_GOAL_CARGO] OnBeforeCapture
-    -- @param #ZONE_GOAL_CARGO self
-    -- @param #string From
-    -- @param #string Event
-    -- @param #string To
-    -- @return #boolean
-    
-    --- Capture Handler OnAfter for ZONE_GOAL_CARGO
-    -- @function [parent=#ZONE_GOAL_CARGO] OnAfterCapture
-    -- @param #ZONE_GOAL_CARGO self
-    -- @param #string From
-    -- @param #string Event
-    -- @param #string To
-    
-    --- Capture Trigger for ZONE_GOAL_CARGO
-    -- @function [parent=#ZONE_GOAL_CARGO] Capture
-    -- @param #ZONE_GOAL_CARGO self
-    
-    --- Capture Asynchronous Trigger for ZONE_GOAL_CARGO
-    -- @function [parent=#ZONE_GOAL_CARGO] __Capture
-    -- @param #ZONE_GOAL_CARGO self
-    -- @param #number Delay
-
-    return self
-  end
-  
-
-  --- Set the owning coalition of the zone.
-  -- @param #ZONE_GOAL_CARGO self
-  -- @param DCSCoalition.DCSCoalition#coalition Coalition
-  function ZONE_GOAL_CARGO:SetCoalition( Coalition )
-    self.Coalition = Coalition
-  end
-  
-  
-  --- Get the owning coalition of the zone.
-  -- @param #ZONE_GOAL_CARGO self
-  -- @return DCSCoalition.DCSCoalition#coalition Coalition.
-  function ZONE_GOAL_CARGO:GetCoalition()
-    return self.Coalition
-  end
-
-  
-  --- Get the owning coalition name of the zone.
-  -- @param #ZONE_GOAL_CARGO self
-  -- @return #string Coalition name.
-  function ZONE_GOAL_CARGO:GetCoalitionName()
-  
-    if self.Coalition == coalition.side.BLUE then
-      return "Blue"
-    end
-    
-    if self.Coalition == coalition.side.RED then
-      return "Red"
-    end
-    
-    if self.Coalition == coalition.side.NEUTRAL then
-      return "Neutral"
-    end
-    
-    return ""
-  end
-
-
-  function ZONE_GOAL_CARGO:IsGuarded()
-  
-    local IsGuarded = self.Zone:IsAllInZoneOfCoalition( self.Coalition )
-    self:F( { IsGuarded = IsGuarded } )
-    return IsGuarded
-  end
-
-
-  function ZONE_GOAL_CARGO:IsEmpty()
-  
-    local IsEmpty = self.Zone:IsNoneInZone()
-    self:F( { IsEmpty = IsEmpty } )
-    return IsEmpty
-  end
-
-
-  function ZONE_GOAL_CARGO:IsCaptured()
-  
-    local IsCaptured = self.Zone:IsAllInZoneOfOtherCoalition( self.Coalition )
-    self:F( { IsCaptured = IsCaptured } )
-    return IsCaptured
-  end
-  
-  
-  function ZONE_GOAL_CARGO:IsAttacked()
-  
-    local IsAttacked = self.Zone:IsSomeInZoneOfCoalition( self.Coalition )
-    self:F( { IsAttacked = IsAttacked } )
-    return IsAttacked
-  end
-  
-  
-
-  --- Mark.
-  -- @param #ZONE_GOAL_CARGO self
-  function ZONE_GOAL_CARGO:Mark()
-  
-    local Coord = self.Zone:GetCoordinate()
-    local ZoneName = self:GetZoneName()
-    local State = self:GetState()
-    
-    if self.MarkRed and self.MarkBlue then
-      self:F( { MarkRed = self.MarkRed, MarkBlue = self.MarkBlue } )
-      Coord:RemoveMark( self.MarkRed )
-      Coord:RemoveMark( self.MarkBlue )
-    end
-    
-    if self.Coalition == coalition.side.BLUE then
-      self.MarkBlue = Coord:MarkToCoalitionBlue( "Guard Zone: " .. ZoneName .. "\nStatus: " .. State )  
-      self.MarkRed = Coord:MarkToCoalitionRed( "Capture Zone: " .. ZoneName .. "\nStatus: " .. State )  
-    else
-      self.MarkRed = Coord:MarkToCoalitionRed( "Guard Zone: " .. ZoneName .. "\nStatus: " .. State )  
-      self.MarkBlue = Coord:MarkToCoalitionBlue( "Capture Zone: " .. ZoneName .. "\nStatus: " .. State )  
-    end
-  end
-
-  --- Bound.
-  -- @param #ZONE_GOAL_CARGO self
-  function ZONE_GOAL_CARGO:onenterGuarded()
-  
-    --self:GetParent( self ):onenterGuarded()
-  
-    if self.Coalition == coalition.side.BLUE then
-      --elf.ProtectZone:BoundZone( 12, country.id.USA )
-    else
-      --self.ProtectZone:BoundZone( 12, country.id.RUSSIA )
-    end
-    
-    self:Mark()
-    
-  end
-  
-  function ZONE_GOAL_CARGO:onenterCaptured()
-  
-    --self:GetParent( self ):onenterCaptured()
-
-    local NewCoalition = self.Zone:GetCoalition()
-    self:F( { NewCoalition = NewCoalition } )
-    self:SetCoalition( NewCoalition )
-  
-    self:Mark()
-  end
-  
-  
-  function ZONE_GOAL_CARGO:onenterEmpty()
-
-    --self:GetParent( self ):onenterEmpty()
-  
-    self:Mark()
-  end
-  
-  
-  function ZONE_GOAL_CARGO:onenterAttacked()
-  
-    --self:GetParent( self ):onenterAttacked()
-  
-    self:Mark()
-  end
-
-
-  --- When started, check the Coalition status.
-  -- @param #ZONE_GOAL_CARGO self
-  function ZONE_GOAL_CARGO:onafterGuard()
-  
-    --self:F({BASE:GetParent( self )})
-    --BASE:GetParent( self ).onafterGuard( self )
-  
-    if not self.SmokeScheduler then
-      self.SmokeScheduler = self:ScheduleRepeat( 1, 1, 0.1, nil, self.StatusSmoke, self )
-    end
-    if not self.ScheduleStatusZone then
-      self.ScheduleStatusZone = self:ScheduleRepeat( 15, 15, 0.1, nil, self.StatusZone, self )
-    end
-  end
-
-
-  function ZONE_GOAL_CARGO:IsCaptured()
-  
-    local IsCaptured = self.Zone:IsAllInZoneOfOtherCoalition( self.Coalition )
-    self:F( { IsCaptured = IsCaptured } )
-    return IsCaptured
-  end
-  
-  
-  function ZONE_GOAL_CARGO:IsAttacked()
-  
-    local IsAttacked = self.Zone:IsSomeInZoneOfCoalition( self.Coalition )
-    self:F( { IsAttacked = IsAttacked } )
-    return IsAttacked
-  end
-  
-  --- Check status Coalition ownership.
-  -- @param #ZONE_GOAL_CARGO self
-  function ZONE_GOAL_CARGO:StatusZone()
-  
-    local State = self:GetState()
-    self:F( { State = self:GetState() } )
-  
-    self.Zone:Scan()
-  
-    if State ~= "Guarded" and self:IsGuarded() then
-      self:Guard()
-    end
-    
-    if State ~= "Empty" and self:IsEmpty() then  
-      self:Empty()
-    end
-
-    if State ~= "Attacked" and self:IsAttacked() then
-      self:Attack()
-    end
-    
-    if State ~= "Captured" and self:IsCaptured() then  
-      self:Capture()
-    end
-    
-  end
-  
-end
-

Moose Development/Moose/Functional/ZoneGoalCoalition.lua

@@ -1,112 +0,0 @@
---- **Functional (WIP)** -- Base class that models processes to achieve goals involving a Zone for a Coalition.
---
--- ===
--- 
--- ZONE_GOAL_COALITION models processes that have a Goal with a defined achievement involving a Zone for a Coalition.  
--- Derived classes implement the ways how the achievements can be realized.
--- 
--- ===
--- 
--- ### Author: **FlightControl**
--- 
--- ===
--- 
--- @module Functional.ZoneGoalCoalition
--- @image MOOSE.JPG
-
-do -- ZoneGoal
-
-  --- @type ZONE_GOAL_COALITION
-  -- @extends Functional.ZoneGoal#ZONE_GOAL
-
-
-  --- ZONE_GOAL_COALITION models processes that have a Goal with a defined achievement involving a Zone for a Coalition.  
-  -- Derived classes implement the ways how the achievements can be realized.
-  -- 
-  -- ## 1. ZONE_GOAL_COALITION constructor
-  --   
-  --   * @{#ZONE_GOAL_COALITION.New}(): Creates a new ZONE_GOAL_COALITION object.
-  -- 
-  -- ## 2. ZONE_GOAL_COALITION is a finite state machine (FSM).
-  -- 
-  -- ### 2.1 ZONE_GOAL_COALITION States
-  -- 
-  -- ### 2.2 ZONE_GOAL_COALITION Events
-  -- 
-  -- ### 2.3 ZONE_GOAL_COALITION State Machine
-  -- 
-  -- @field #ZONE_GOAL_COALITION
-  ZONE_GOAL_COALITION = {
-    ClassName = "ZONE_GOAL_COALITION",
-  }
-  
-  --- @field #table ZONE_GOAL_COALITION.States
-  ZONE_GOAL_COALITION.States = {}
-  
-  --- ZONE_GOAL_COALITION Constructor.
-  -- @param #ZONE_GOAL_COALITION self
-  -- @param Core.Zone#ZONE Zone A @{Zone} object with the goal to be achieved.
-  -- @param DCSCoalition.DCSCoalition#coalition Coalition The initial coalition owning the zone.
-  -- @return #ZONE_GOAL_COALITION
-  function ZONE_GOAL_COALITION:New( Zone, Coalition )
-  
-    local self = BASE:Inherit( self, ZONE_GOAL:New( Zone ) ) -- #ZONE_GOAL_COALITION
-    self:F( { Zone = Zone, Coalition  = Coalition  } )
-
-    self:SetCoalition( Coalition )
-
-
-    return self
-  end
-  
-
-  --- Set the owning coalition of the zone.
-  -- @param #ZONE_GOAL_COALITION self
-  -- @param DCSCoalition.DCSCoalition#coalition Coalition
-  function ZONE_GOAL_COALITION:SetCoalition( Coalition )
-    self.Coalition = Coalition
-  end
-  
-  
-  --- Get the owning coalition of the zone.
-  -- @param #ZONE_GOAL_COALITION self
-  -- @return DCSCoalition.DCSCoalition#coalition Coalition.
-  function ZONE_GOAL_COALITION:GetCoalition()
-    return self.Coalition
-  end
-
-  
-  --- Get the owning coalition name of the zone.
-  -- @param #ZONE_GOAL_COALITION self
-  -- @return #string Coalition name.
-  function ZONE_GOAL_COALITION:GetCoalitionName()
-  
-    if self.Coalition == coalition.side.BLUE then
-      return "Blue"
-    end
-    
-    if self.Coalition == coalition.side.RED then
-      return "Red"
-    end
-    
-    if self.Coalition == coalition.side.NEUTRAL then
-      return "Neutral"
-    end
-    
-    return ""
-  end
-
-
-  --- Check status Coalition ownership.
-  -- @param #ZONE_GOAL_COALITION self
-  function ZONE_GOAL_COALITION:StatusZone()
-  
-    local State = self:GetState()
-    self:F( { State = self:GetState() } )
-  
-    self.Zone:Scan( { Object.Category.UNIT, Object.Category.STATIC } )
-  
-  end
-  
-end
-

Moose Development/Moose/Moose.lua

@@ -1,6 +1,5 @@
 -- The order of the declarations is important here. Don't touch it.
 
-
 --- Declare the event dispatcher based on the EVENT class
 _EVENTDISPATCHER = EVENT:New() -- Core.Event#EVENT
 
@@ -11,8 +10,4 @@ _SCHEDULEDISPATCHER = SCHEDULEDISPATCHER:New() -- Core.Timer#SCHEDULEDISPATCHER
 _DATABASE = DATABASE:New() -- Core.Database#DATABASE
 
 _SETTINGS = SETTINGS:Set()
-_SETTINGS:SetPlayerMenuOn()
-
-_DATABASE:_RegisterCargos()
-_DATABASE:_RegisterZones()
 

Moose Development/Moose/Tasking/CommandCenter.lua

@@ -1,122 +1,45 @@
---- **Tasking** -- A command center governs multiple missions, and takes care of the reporting and communications.
--- 
--- **Features:**
--- 
---   * Govern multiple missions.
---   * Communicate to coalitions, groups.
---   * Assign tasks.
---   * Manage the menus.
---   * Manage reference zones.
+--- **Tasking** -- A COMMANDCENTER is the owner of multiple missions within MOOSE. 
+-- A COMMANDCENTER governs multiple missions, the tasking and the reporting.
 -- 
 -- ===
 --  
--- ### Author: **FlightControl**
+-- ### Author: **Sven Van de Velde (FlightControl)**
 -- 
 -- ### Contributions: 
 -- 
--- ===
+-- ====
 -- 
--- @module Tasking.CommandCenter
--- @image Task_Command_Center.JPG
+-- @module CommandCenter
+
+
+
 
 
 --- The COMMANDCENTER class
 -- @type COMMANDCENTER
 -- @field Wrapper.Group#GROUP HQ
--- @field DCS#coalition CommandCenterCoalition
+-- @field Dcs.DCSCoalitionWrapper.Object#coalition CommandCenterCoalition
 -- @list<Tasking.Mission#MISSION> Missions
 -- @extends Core.Base#BASE
 
 
---- Governs multiple missions, the tasking and the reporting.
+--- # COMMANDCENTER class, extends @{Base#BASE}
+-- 
+--  The COMMANDCENTER class governs multiple missions, the tasking and the reporting.
 --  
--- Command centers govern missions, communicates the task assignments between human players of the coalition, and manages the menu flow.
--- It can assign a random task to a player when requested.
--- The commandcenter provides the facilitites to communicate between human players online, executing a task.
+--  The commandcenter communicates important messages between the various groups of human players executing tasks in missions.
 --  
--- ## 1. Create a command center object.
+-- ## COMMANDCENTER constructor
 --
 --   * @{#COMMANDCENTER.New}(): Creates a new COMMANDCENTER object.
 -- 
--- ## 2. Command center mission management.
--- 
--- Command centers manage missions. These can be added, removed and provides means to retrieve missions.
--- These methods are heavily used by the task dispatcher classes.
+-- ## Mission Management
 -- 
 --   * @{#COMMANDCENTER.AddMission}(): Adds a mission to the commandcenter control.
 --   * @{#COMMANDCENTER.RemoveMission}(): Removes a mission to the commandcenter control.
 --   * @{#COMMANDCENTER.GetMissions}(): Retrieves the missions table controlled by the commandcenter.
 -- 
--- ## 3. Communication management between players. 
--- 
--- Command center provide means of communication between players. 
--- Because a command center is a central object governing multiple missions,  
--- there are several levels at which communication needs to be done.
--- Within MOOSE, communication is facilitated using the message system within the DCS simulator.
--- 
--- Messages can be sent between players at various levels:
--- 
---   - On a global level, to all players.
---   - On a coalition level, only to the players belonging to the same coalition.
---   - On a group level, to the players belonging to the same group.
---   
--- Messages can be sent to **all players** by the command center using the method @{Tasking.CommandCenter#COMMANDCENTER.MessageToAll}().
--- 
--- To send messages to **the coalition of the command center**, there are two methods available:
---  
---   - Use the method @{Tasking.CommandCenter#COMMANDCENTER.MessageToCoalition}() to send a specific message to the coalition, with a given message display duration.
---   - You can send a specific type of message using the method @{Tasking.CommandCenter#COMMANDCENTER.MessageTypeToCoalition}().
---     This will send a message of a specific type to the coalition, and as a result its display duration will be flexible according the message display time selection by the human player.
---     
--- To send messages **to the group** of human players, there are also two methods available:
--- 
---   - Use the method @{Tasking.CommandCenter#COMMANDCENTER.MessageToGroup}() to send a specific message to a group, with a given message display duration.
---   - You can send a specific type of message using the method @{Tasking.CommandCenter#COMMANDCENTER.MessageTypeToGroup}().
---     This will send a message of a specific type to the group, and as a result its display duration will be flexible according the message display time selection by the human player .
---     
--- Messages are considered to be sometimes disturbing for human players, therefore, the settings menu provides the means to activate or deactivate messages.
--- For more information on the message types and display timings that can be selected and configured using the menu, refer to the @{Core.Settings} menu description.
---     
--- ## 4. Command center detailed methods.
--- 
--- Various methods are added to manage command centers.
--- 
--- ### 4.1. Naming and description.
--- 
--- There are 3 methods that can be used to retrieve the description of a command center:
--- 
---   - Use the method @{Tasking.CommandCenter#COMMANDCENTER.GetName}() to retrieve the name of the command center. 
---     This is the name given as part of the @{Tasking.CommandCenter#COMMANDCENTER.New}() constructor.
---     The returned name using this method, is not to be used for message communication.
--- 
--- A textual description can be retrieved that provides the command center name to be used within message communication:
--- 
---   - @{Tasking.CommandCenter#COMMANDCENTER.GetShortText}() returns the command center name as `CC [CommandCenterName]`.
---   - @{Tasking.CommandCenter#COMMANDCENTER.GetText}() returns the command center name as `Command Center [CommandCenterName]`.
--- 
--- ### 4.2. The coalition of the command center.
--- 
--- The method @{Tasking.CommandCenter#COMMANDCENTER.GetCoalition}() returns the coalition of the command center.
--- The return value is an enumeration of the type @{DCS#coalition.side}, which contains the RED, BLUE and NEUTRAL coalition. 
--- 
--- ### 4.3. The command center is a real object.
--- 
--- The command center must be represented by a live object within the DCS simulator. As a result, the command center   
--- can be a @{Wrapper.Unit}, a @{Wrapper.Group}, an @{Wrapper.Airbase} or a @{Wrapper.Static} object.
--- 
--- Using the method @{Tasking.CommandCenter#COMMANDCENTER.GetPositionable}() you retrieve the polymorphic positionable object representing
--- the command center, but just be aware that you should be able to use the representable object derivation methods.
--- 
--- ### 5. Command center reports.
--- 
--- Because a command center giverns multiple missions, there are several reports available that are generated by command centers.
--- These reports are generated using the following methods:
--- 
---   - @{Tasking.CommandCenter#COMMANDCENTER.ReportSummary}(): Creates a summary report of all missions governed by the command center.
---   - @{Tasking.CommandCenter#COMMANDCENTER.ReportDetails}(): Creates a detailed report of all missions governed by the command center.
---   - @{Tasking.CommandCenter#COMMANDCENTER.ReportMissionPlayers}(): Creates a report listing the players active at the missions governed by the command center.
---   
--- ## 6. Reference Zones.
+-- ## Reference Zones
 -- 
 -- Command Centers may be aware of certain Reference Zones within the battleground. These Reference Zones can refer to
 -- known areas, recognizable buildings or sites, or any other point of interest.
@@ -163,13 +86,11 @@ COMMANDCENTER = {
 -- @return #COMMANDCENTER
 function COMMANDCENTER:New( CommandCenterPositionable, CommandCenterName )
 
-  local self = BASE:Inherit( self, BASE:New() ) -- #COMMANDCENTER
+  local self = BASE:Inherit( self, BASE:New() )
 
   self.CommandCenterPositionable = CommandCenterPositionable  
   self.CommandCenterName = CommandCenterName or CommandCenterPositionable:GetName()
   self.CommandCenterCoalition = CommandCenterPositionable:GetCoalition()
-  
-  self.AutoAssignTasks = false
 	
 	self.Missions = {}
 
@@ -179,10 +100,8 @@ function COMMANDCENTER:New( CommandCenterPositionable, CommandCenterName )
     function( self, EventData )
       if EventData.IniObjectCategory == 1 then
         local EventGroup = GROUP:Find( EventData.IniDCSGroup )
-        self:E( { CommandCenter = self:GetName(), EventGroup = EventGroup:GetName(), HasGroup = self:HasGroup( EventGroup ), EventData = EventData } )
         if EventGroup and self:HasGroup( EventGroup ) then
-          local CommandCenterMenu = MENU_GROUP:New( EventGroup, self:GetText() )
-          local MenuReporting = MENU_GROUP:New( EventGroup, "Missions Reports", CommandCenterMenu )
+          local MenuReporting = MENU_GROUP:New( EventGroup, "Missions Reports", self.CommandCenterMenu )
           local MenuMissionsSummary = MENU_GROUP_COMMAND:New( EventGroup, "Missions Status Report", MenuReporting, self.ReportMissionsStatus, self, EventGroup )
           local MenuMissionsDetails = MENU_GROUP_COMMAND:New( EventGroup, "Missions Players Report", MenuReporting, self.ReportMissionsPlayers, self, EventGroup )
           self:ReportSummary( EventGroup )
@@ -193,30 +112,31 @@ function COMMANDCENTER:New( CommandCenterPositionable, CommandCenterName )
             Mission:JoinUnit( PlayerUnit, PlayerGroup )
           end
           self:SetMenu()
+         _DATABASE:PlayerSettingsMenu( PlayerUnit ) 
         end
       end
       
     end
     )
   
---  -- When a player enters a client or a unit, the CommandCenter will check for each Mission and each Task in the Mission if the player has things to do.
---  -- For these elements, it will=
---  -- - Set the correct menu.
---  -- - Assign the PlayerUnit to the Task if required.
---  -- - Send a message to the other players in the group that this player has joined.
---  self:HandleEvent( EVENTS.PlayerEnterUnit,
---    --- @param #COMMANDCENTER self
---    -- @param Core.Event#EVENTDATA EventData
---    function( self, EventData )
---      local PlayerUnit = EventData.IniUnit
---      for MissionID, Mission in pairs( self:GetMissions() ) do
---        local Mission = Mission -- Tasking.Mission#MISSION
---        local PlayerGroup = EventData.IniGroup -- The GROUP object should be filled!
---        Mission:JoinUnit( PlayerUnit, PlayerGroup )
---      end
---      self:SetMenu()
---    end
---  )
+  -- When a player enters a client or a unit, the CommandCenter will check for each Mission and each Task in the Mission if the player has things to do.
+  -- For these elements, it will=
+  -- - Set the correct menu.
+  -- - Assign the PlayerUnit to the Task if required.
+  -- - Send a message to the other players in the group that this player has joined.
+  self:HandleEvent( EVENTS.PlayerEnterUnit,
+    --- @param #COMMANDCENTER self
+    -- @param Core.Event#EVENTDATA EventData
+    function( self, EventData )
+      local PlayerUnit = EventData.IniUnit
+      for MissionID, Mission in pairs( self:GetMissions() ) do
+        local Mission = Mission -- Tasking.Mission#MISSION
+        local PlayerGroup = EventData.IniGroup -- The GROUP object should be filled!
+        Mission:JoinUnit( PlayerUnit, PlayerGroup )
+      end
+      self:SetMenu()
+    end
+  )
 
   -- Handle when a player leaves a slot and goes back to spectators ... 
   -- The PlayerUnit will be UnAssigned from the Task.
@@ -250,7 +170,7 @@ function COMMANDCENTER:New( CommandCenterPositionable, CommandCenterName )
     end
   )
 
-  -- Handle when a player crashes ... 
+  -- Handle when a player leaves a slot and goes back to spectators ... 
   -- The PlayerUnit will be UnAssigned from the Task.
   -- When there is no Unit left running the Task, the Task goes into Abort...
   self:HandleEvent( EVENTS.Crash,
@@ -270,8 +190,6 @@ function COMMANDCENTER:New( CommandCenterPositionable, CommandCenterName )
   self:SetMenu()
   
   _SETTINGS:SetSystemMenu( CommandCenterPositionable )
-  
-  self:SetCommandMenu()
 	
 	return self
 end
@@ -284,32 +202,6 @@ function COMMANDCENTER:GetName()
   return self.CommandCenterName
 end
 
---- Gets the text string of the HQ command center.
--- @param #COMMANDCENTER self
--- @return #string
-function COMMANDCENTER:GetText()
-
-  return "Command Center [" .. self.CommandCenterName .. "]"
-end
-
---- Gets the short text string of the HQ command center.
--- @param #COMMANDCENTER self
--- @return #string
-function COMMANDCENTER:GetShortText()
-
-  return "CC [" .. self.CommandCenterName .. "]"
-end
-
-
---- Gets the coalition of the command center.
--- @param #COMMANDCENTER self
--- @return DCScoalition#coalition
-function COMMANDCENTER:GetCoalition()
-
-  return self.CommandCenterCoalition
-end
-
-
 --- Gets the POSITIONABLE of the HQ command center.
 -- @param #COMMANDCENTER self
 -- @return Wrapper.Positionable#POSITIONABLE
@@ -322,7 +214,7 @@ end
 -- @return #list<Tasking.Mission#MISSION>
 function COMMANDCENTER:GetMissions()
 
-  return self.Missions or {}
+  return self.Missions
 end
 
 --- Add a MISSION to be governed by the HQ command center.
@@ -411,7 +303,9 @@ end
 --- Sets the menu structure of the Missions governed by the HQ command center.
 -- @param #COMMANDCENTER self
 function COMMANDCENTER:SetMenu()
-  self:F2()
+  self:F()
+
+  self.CommandCenterMenu = self.CommandCenterMenu or MENU_COALITION:New( self.CommandCenterCoalition, "Command Center (" .. self:GetName() .. ")" )
 
   local MenuTime = timer.getTime()
   for MissionID, Mission in pairs( self:GetMissions() or {} ) do
@@ -420,7 +314,7 @@ function COMMANDCENTER:SetMenu()
   end
 
   for MissionID, Mission in pairs( self:GetMissions() or {} ) do
-    Mission = Mission -- Tasking.Mission#MISSION
+    local Mission = Mission -- Tasking.Mission#MISSION
     Mission:RemoveMenu( MenuTime )
   end
   
@@ -428,160 +322,14 @@ end
 
 --- Gets the commandcenter menu structure governed by the HQ command center.
 -- @param #COMMANDCENTER self
--- @param Wrapper.Group#Group TaskGroup Task Group.
 -- @return Core.Menu#MENU_COALITION
-function COMMANDCENTER:GetMenu( TaskGroup )
-
-  local MenuTime = timer.getTime()
-
-  self.CommandCenterMenus = self.CommandCenterMenus or {}
-  local CommandCenterMenu
-  
-  local CommandCenterText = self:GetText()
-  CommandCenterMenu = MENU_GROUP:New( TaskGroup, CommandCenterText ):SetTime(MenuTime)
-  self.CommandCenterMenus[TaskGroup] = CommandCenterMenu
-
-  if self.AutoAssignTasks == false then
-    local AssignTaskMenu = MENU_GROUP_COMMAND:New( TaskGroup, "Assign Task", CommandCenterMenu, self.AssignRandomTask, self, TaskGroup ):SetTime(MenuTime):SetTag("AutoTask")
-  end
-  CommandCenterMenu:Remove( MenuTime, "AutoTask" )
-    
-  return self.CommandCenterMenus[TaskGroup]
+function COMMANDCENTER:GetMenu()
+  return self.CommandCenterMenu
 end
 
-
---- Assigns a random task to a TaskGroup.
+--- Checks of the COMMANDCENTER has a GROUP.
 -- @param #COMMANDCENTER self
--- @return #COMMANDCENTER
-function COMMANDCENTER:AssignRandomTask( TaskGroup )
-
-  local Tasks = {}
-
-  for MissionID, Mission in pairs( self:GetMissions() ) do
-    local Mission = Mission -- Tasking.Mission#MISSION
-    local MissionTasks = Mission:GetGroupTasks( TaskGroup )
-    for MissionTaskName, MissionTask in pairs( MissionTasks or {} ) do
-      Tasks[#Tasks+1] = MissionTask
-    end
-  end
-  
-  local Task = Tasks[ math.random( 1, #Tasks ) ] -- Tasking.Task#TASK
-  
-  Task:SetAssignMethod( ACT_ASSIGN_MENU_ACCEPT:New( Task.TaskBriefing ) )
-  
-  Task:AssignToGroup( TaskGroup )
-
-end
-
-
---- Sets the menu of the command center.
--- This command is called within the :New() method.
--- @param #COMMANDCENTER self
-function COMMANDCENTER:SetCommandMenu()
-
-  local MenuTime = timer.getTime()
-  
-  if self.CommandCenterPositionable and self.CommandCenterPositionable:IsInstanceOf(GROUP) then
-    local CommandCenterText = self:GetText()
-    local CommandCenterMenu = MENU_GROUP:New( self.CommandCenterPositionable, CommandCenterText ):SetTime(MenuTime)
-  
-    if self.AutoAssignTasks == false then
-      local AutoAssignTaskMenu = MENU_GROUP_COMMAND:New( self.CommandCenterPositionable, "Assign Task On", CommandCenterMenu, self.SetAutoAssignTasks, self, true ):SetTime(MenuTime):SetTag("AutoTask")
-    else
-      local AutoAssignTaskMenu = MENU_GROUP_COMMAND:New( self.CommandCenterPositionable, "Assign Task Off", CommandCenterMenu, self.SetAutoAssignTasks, self, false ):SetTime(MenuTime):SetTag("AutoTask")
-    end
-    CommandCenterMenu:Remove( MenuTime, "AutoTask" )
-  end
-
-end
-
-
-
---- Automatically assigns tasks to all TaskGroups.
--- @param #COMMANDCENTER self
--- @param #boolean AutoAssign true for ON and false or nil for OFF.
-function COMMANDCENTER:SetAutoAssignTasks( AutoAssign )
-
-  self.AutoAssignTasks = AutoAssign or false
-  
-  local GroupSet = self:AddGroups()
-
-  for GroupID, TaskGroup in pairs( GroupSet:GetSet() ) do
-    local TaskGroup = TaskGroup -- Wrapper.Group#GROUP
-    self:GetMenu( TaskGroup )
-  end
-
-  if self.AutoAssignTasks == true then
-    self:ScheduleRepeat( 10, 30, 0, nil, self.AssignTasks, self )
-  else
-    self:ScheduleStop( self.AssignTasks )
-  end
-  
-  self:SetCommandCenterMenu()
-
-end
-
-
---- Automatically assigns tasks to all TaskGroups.
--- @param #COMMANDCENTER self
-function COMMANDCENTER:AssignTasks()
-
-  local GroupSet = self:AddGroups()
-
-  for GroupID, TaskGroup in pairs( GroupSet:GetSet() ) do
-    local TaskGroup = TaskGroup -- Wrapper.Group#GROUP
-    
-    if self:IsGroupAssigned( TaskGroup ) then
-    else
-      -- Only groups with planes or helicopters will receive automatic tasks.
-      -- TODO Workaround DCS-BUG-3 - https://github.com/FlightControl-Master/MOOSE/issues/696
-      if TaskGroup:IsAir() then
-        self:AssignRandomTask( TaskGroup )
-      end
-    end
-  end
-
-end
-
-
---- Get all the Groups active within the command center.
--- @param #COMMANDCENTER self
--- @return Core.Set#SET_GROUP The set of groups active within the command center.
-function COMMANDCENTER:AddGroups()
-
-  local GroupSet = SET_GROUP:New()
-  
-  for MissionID, Mission in pairs( self.Missions ) do
-    local Mission = Mission -- Tasking.Mission#MISSION
-    GroupSet = Mission:AddGroups( GroupSet )
-  end
-  
-  return GroupSet
-end
-
-
---- Checks of the TaskGroup has a Task.
--- @param #COMMANDCENTER self
--- @return #boolean When true, the TaskGroup has a Task, otherwise the returned value will be false.
-function COMMANDCENTER:IsGroupAssigned( TaskGroup )
-
-  local Assigned = false
-  
-  for MissionID, Mission in pairs( self.Missions ) do
-    local Mission = Mission -- Tasking.Mission#MISSION
-    if Mission:IsGroupAssigned( TaskGroup ) then
-      Assigned = true
-      break
-    end
-  end
-  
-  return Assigned
-end
-
-
---- Checks of the command center has the given MissionGroup.
--- @param #COMMANDCENTER self
--- @param Wrapper.Group#GROUP MissionGroup The group active within one of the missions governed by the command center.
+-- @param Wrapper.Group#GROUP
 -- @return #boolean
 function COMMANDCENTER:HasGroup( MissionGroup )
 
@@ -598,90 +346,84 @@ function COMMANDCENTER:HasGroup( MissionGroup )
   return Has
 end
 
---- Let the command center send a Message to all players.
+--- Send a CC message to the coalition of the CC.
 -- @param #COMMANDCENTER self
--- @param #string Message The message text.
 function COMMANDCENTER:MessageToAll( Message )
 
     self:GetPositionable():MessageToAll( Message, 20, self:GetName() )
 
 end
 
---- Let the command center send a message to the MessageGroup.
+--- Send a CC message to a GROUP.
 -- @param #COMMANDCENTER self
--- @param #string Message The message text.
--- @param Wrapper.Group#GROUP MessageGroup The group to receive the message.
-function COMMANDCENTER:MessageToGroup( Message, MessageGroup )
+-- @param #string Message
+-- @param Wrapper.Group#GROUP TaskGroup
+function COMMANDCENTER:MessageToGroup( Message, TaskGroup )
 
-  self:GetPositionable():MessageToGroup( Message, 15, MessageGroup, self:GetShortText() )
+  self:GetPositionable():MessageToGroup( Message, 15, TaskGroup, self:GetName() )
 
 end
 
---- Let the command center send a message to the MessageGroup.
+--- Send a CC message of a specified type to a GROUP.
 -- @param #COMMANDCENTER self
--- @param #string Message The message text.
--- @param Wrapper.Group#GROUP MessageGroup The group to receive the message.
+-- @param #string Message
+-- @param Wrapper.Group#GROUP TaskGroup
 -- @param Core.Message#MESSAGE.MessageType MessageType The type of the message, resulting in automatic time duration and prefix of the message.
-function COMMANDCENTER:MessageTypeToGroup( Message, MessageGroup, MessageType )
+function COMMANDCENTER:MessageTypeToGroup( Message, TaskGroup, MessageType )
 
-  self:GetPositionable():MessageTypeToGroup( Message, MessageType, MessageGroup, self:GetShortText() )
+  self:GetPositionable():MessageTypeToGroup( Message, MessageType, TaskGroup, self:GetName() )
 
 end
 
---- Let the command center send a message to the coalition of the command center.
+--- Send a CC message to the coalition of the CC.
 -- @param #COMMANDCENTER self
--- @param #string Message The message text.
 function COMMANDCENTER:MessageToCoalition( Message )
 
   local CCCoalition = self:GetPositionable():GetCoalition()
     --TODO: Fix coalition bug!
     
-    self:GetPositionable():MessageToCoalition( Message, 15, CCCoalition, self:GetShortText() )
+    self:GetPositionable():MessageToCoalition( Message, 15, CCCoalition )
 
 end
 
 
---- Let the command center send a message of a specified type to the coalition of the command center.
+--- Send a CC message of a specified type to the coalition of the CC.
 -- @param #COMMANDCENTER self
--- @param #string Message The message text.
+-- @param #string Message The message.
 -- @param Core.Message#MESSAGE.MessageType MessageType The type of the message, resulting in automatic time duration and prefix of the message.
 function COMMANDCENTER:MessageTypeToCoalition( Message, MessageType )
 
   local CCCoalition = self:GetPositionable():GetCoalition()
     --TODO: Fix coalition bug!
     
-    self:GetPositionable():MessageTypeToCoalition( Message, MessageType, CCCoalition, self:GetShortText() )
+    self:GetPositionable():MessageTypeToCoalition( Message, MessageType, CCCoalition )
 
 end
 
 
---- Let the command center send a report of the status of all missions to a group.
+--- Report the status of all MISSIONs to a GROUP.
 -- Each Mission is listed, with an indication how many Tasks are still to be completed.
 -- @param #COMMANDCENTER self
--- @param Wrapper.Group#GROUP ReportGroup The group to receive the report.
-function COMMANDCENTER:ReportSummary( ReportGroup )
-  self:F( ReportGroup )
+function COMMANDCENTER:ReportMissionsStatus( ReportGroup )
+  self:E( ReportGroup )
 
   local Report = REPORT:New()
 
-  -- List the name of the mission.
-  local Name = self:GetName()
-  Report:Add( string.format( '%s - Report Summary Missions', Name ) )
+  Report:Add( "Status report of all missions." )
   
   for MissionID, Mission in pairs( self.Missions ) do
     local Mission = Mission -- Tasking.Mission#MISSION
-    Report:Add( " - " .. Mission:ReportSummary( ReportGroup ) )
+    Report:Add( " - " .. Mission:ReportStatus() )
   end
   
   self:MessageToGroup( Report:Text(), ReportGroup )
 end
 
---- Let the command center send a report of the players of all missions to a group.
+--- Report the players of all MISSIONs to a GROUP.
 -- Each Mission is listed, with an indication how many Tasks are still to be completed.
 -- @param #COMMANDCENTER self
--- @param Wrapper.Group#GROUP ReportGroup The group to receive the report.
 function COMMANDCENTER:ReportMissionsPlayers( ReportGroup )
-  self:F( ReportGroup )
+  self:E( ReportGroup )
 
   local Report = REPORT:New()
   
@@ -695,13 +437,11 @@ function COMMANDCENTER:ReportMissionsPlayers( ReportGroup )
   self:MessageToGroup( Report:Text(), ReportGroup )
 end
 
---- Let the command center send a report of the status of a task to a group.
+--- Report the status of a Task to a Group.
 -- Report the details of a Mission, listing the Mission, and all the Task details.
 -- @param #COMMANDCENTER self
--- @param Wrapper.Group#GROUP ReportGroup The group to receive the report.
--- @param Tasking.Task#TASK Task The task to be reported.
 function COMMANDCENTER:ReportDetails( ReportGroup, Task )
-  self:F( ReportGroup )
+  self:E( ReportGroup )
 
   local Report = REPORT:New()
   

Moose Development/Moose/Tasking/DetectionManager.lua

@@ -1,36 +1,38 @@
---- **Tasking** - This module contains the DETECTION_MANAGER class and derived classes.
+--- This module contains the DETECTION_MANAGER class and derived classes.
 -- 
 -- ===
 -- 
--- The @{#DETECTION_MANAGER} class defines the core functions to report detected objects to groups.
+-- 1) @{DetectionManager#DETECTION_MANAGER} class, extends @{Fsm#FSM}
+-- ====================================================================
+-- The @{DetectionManager#DETECTION_MANAGER} class defines the core functions to report detected objects to groups.
 -- Reportings can be done in several manners, and it is up to the derived classes if DETECTION_MANAGER to model the reporting behaviour.
 -- 
 -- 1.1) DETECTION_MANAGER constructor:
 -- -----------------------------------
---   * @{#DETECTION_MANAGER.New}(): Create a new DETECTION_MANAGER instance.
+--   * @{DetectionManager#DETECTION_MANAGER.New}(): Create a new DETECTION_MANAGER instance.
 -- 
 -- 1.2) DETECTION_MANAGER reporting:
 -- ---------------------------------
--- Derived DETECTION_MANAGER classes will reports detected units using the method @{#DETECTION_MANAGER.ReportDetected}(). This method implements polymorphic behaviour.
+-- Derived DETECTION_MANAGER classes will reports detected units using the method @{DetectionManager#DETECTION_MANAGER.ReportDetected}(). This method implements polymorphic behaviour.
 -- 
--- The time interval in seconds of the reporting can be changed using the methods @{#DETECTION_MANAGER.SetRefreshTimeInterval}(). 
--- To control how long a reporting message is displayed, use @{#DETECTION_MANAGER.SetReportDisplayTime}().
--- Derived classes need to implement the method @{#DETECTION_MANAGER.GetReportDisplayTime}() to use the correct display time for displayed messages during a report.
+-- The time interval in seconds of the reporting can be changed using the methods @{DetectionManager#DETECTION_MANAGER.SetRefreshTimeInterval}(). 
+-- To control how long a reporting message is displayed, use @{DetectionManager#DETECTION_MANAGER.SetReportDisplayTime}().
+-- Derived classes need to implement the method @{DetectionManager#DETECTION_MANAGER.GetReportDisplayTime}() to use the correct display time for displayed messages during a report.
 -- 
--- Reporting can be started and stopped using the methods @{#DETECTION_MANAGER.StartReporting}() and @{#DETECTION_MANAGER.StopReporting}() respectively.
--- If an ad-hoc report is requested, use the method @{#DETECTION_MANAGER#ReportNow}().
+-- Reporting can be started and stopped using the methods @{DetectionManager#DETECTION_MANAGER.StartReporting}() and @{DetectionManager#DETECTION_MANAGER.StopReporting}() respectively.
+-- If an ad-hoc report is requested, use the method @{DetectionManager#DETECTION_MANAGER#ReportNow}().
 -- 
 -- The default reporting interval is every 60 seconds. The reporting messages are displayed 15 seconds.
 -- 
 -- ===
 -- 
--- 2) @{#DETECTION_REPORTING} class, extends @{#DETECTION_MANAGER}
--- ===
--- The @{#DETECTION_REPORTING} class implements detected units reporting. Reporting can be controlled using the reporting methods available in the @{Tasking.DetectionManager#DETECTION_MANAGER} class.
+-- 2) @{DetectionManager#DETECTION_REPORTING} class, extends @{DetectionManager#DETECTION_MANAGER}
+-- =========================================================================================
+-- The @{DetectionManager#DETECTION_REPORTING} class implements detected units reporting. Reporting can be controlled using the reporting methods available in the @{DetectionManager#DETECTION_MANAGER} class.
 -- 
 -- 2.1) DETECTION_REPORTING constructor:
 -- -------------------------------
--- The @{#DETECTION_REPORTING.New}() method creates a new DETECTION_REPORTING instance.
+-- The @{DetectionManager#DETECTION_REPORTING.New}() method creates a new DETECTION_REPORTING instance.
 --    
 --    
 -- ===
@@ -38,18 +40,15 @@
 -- ### Contributions: Mechanist, Prof_Hilactic, FlightControl - Concept & Testing
 -- ### Author: FlightControl - Framework Design &  Programming
 -- 
--- @module Tasking.DetectionManager
--- @image Task_Detection_Manager.JPG
+-- @module DetectionManager
 
 do -- DETECTION MANAGER
   
-  --- @type DETECTION_MANAGER
-  -- @field Core.Set#SET_GROUP SetGroup The groups to which the FAC will report to.
+  --- DETECTION_MANAGER class.
+  -- @type DETECTION_MANAGER
+  -- @field Set#SET_GROUP SetGroup The groups to which the FAC will report to.
   -- @field Functional.Detection#DETECTION_BASE Detection The DETECTION_BASE object that is used to report the detected objects.
   -- @extends Core.Fsm#FSM
-
-  --- DETECTION_MANAGER class.
-  -- @field #DETECTION_MANAGER
   DETECTION_MANAGER = {
     ClassName = "DETECTION_MANAGER",
     SetGroup = nil,
@@ -58,7 +57,7 @@ do -- DETECTION MANAGER
   
   --- FAC constructor.
   -- @param #DETECTION_MANAGER self
-  -- @param Core.Set#SET_GROUP SetGroup
+  -- @param Set#SET_GROUP SetGroup
   -- @param Functional.Detection#DETECTION_BASE Detection
   -- @return #DETECTION_MANAGER self
   function DETECTION_MANAGER:New( SetGroup, Detection )
@@ -123,48 +122,6 @@ do -- DETECTION MANAGER
     -- @function [parent=#DETECTION_MANAGER] __Stop
     -- @param #DETECTION_MANAGER self
     -- @param #number Delay
-
-    self:AddTransition( "Started", "Success", "Started" )
-    
-    --- Success Handler OnAfter for DETECTION_MANAGER
-    -- @function [parent=#DETECTION_MANAGER] OnAfterSuccess
-    -- @param #DETECTION_MANAGER self
-    -- @param #string From
-    -- @param #string Event
-    -- @param #string To
-    -- @param Tasking.Task#TASK Task
-    
-    
-    self:AddTransition( "Started", "Failed", "Started" )
-    
-    --- Failed Handler OnAfter for DETECTION_MANAGER
-    -- @function [parent=#DETECTION_MANAGER] OnAfterFailed
-    -- @param #DETECTION_MANAGER self
-    -- @param #string From
-    -- @param #string Event
-    -- @param #string To
-    -- @param Tasking.Task#TASK Task
-    
-    
-    self:AddTransition( "Started", "Aborted", "Started" )
-    
-    --- Aborted Handler OnAfter for DETECTION_MANAGER
-    -- @function [parent=#DETECTION_MANAGER] OnAfterAborted
-    -- @param #DETECTION_MANAGER self
-    -- @param #string From
-    -- @param #string Event
-    -- @param #string To
-    -- @param Tasking.Task#TASK Task
-    
-    self:AddTransition( "Started", "Cancelled", "Started" )
-    
-    --- Cancelled Handler OnAfter for DETECTION_MANAGER
-    -- @function [parent=#DETECTION_MANAGER] OnAfterCancelled
-    -- @param #DETECTION_MANAGER self
-    -- @param #string From
-    -- @param #string Event
-    -- @param #string To
-    -- @param Tasking.Task#TASK Task
     
 
     self:AddTransition( "Started", "Report", "Started" )
@@ -172,6 +129,7 @@ do -- DETECTION MANAGER
     self:SetRefreshTimeInterval( 30 )
     self:SetReportDisplayTime( 25 )
   
+    self:E( { Detection = Detection } )
     Detection:__Start( 3 )
 
     return self
@@ -183,6 +141,8 @@ do -- DETECTION MANAGER
   
   function DETECTION_MANAGER:onafterReport( From, Event, To )
 
+    self:E( "onafterReport" )
+
     self:__Report( -self._RefreshTimeInterval )
     
     self:ProcessDetected( self.Detection )
@@ -218,7 +178,7 @@ do -- DETECTION MANAGER
     return self._ReportDisplayTime
   end
   
-  --- Reports the detected items to the @{Core.Set#SET_GROUP}.
+  --- Reports the detected items to the @{Set#SET_GROUP}.
   -- @param #DETECTION_MANAGER self
   -- @param Functional.Detection#DETECTION_BASE Detection
   -- @return #DETECTION_MANAGER self
@@ -234,7 +194,7 @@ do -- DETECTION_REPORTING
 
   --- DETECTION_REPORTING class.
   -- @type DETECTION_REPORTING
-  -- @field Core.Set#SET_GROUP SetGroup The groups to which the FAC will report to.
+  -- @field Set#SET_GROUP SetGroup The groups to which the FAC will report to.
   -- @field Functional.Detection#DETECTION_BASE Detection The DETECTION_BASE object that is used to report the detected objects.
   -- @extends #DETECTION_MANAGER
   DETECTION_REPORTING = {
@@ -244,7 +204,7 @@ do -- DETECTION_REPORTING
   
   --- DETECTION_REPORTING constructor.
   -- @param #DETECTION_REPORTING self
-  -- @param Core.Set#SET_GROUP SetGroup
+  -- @param Set#SET_GROUP SetGroup
   -- @param Functional.Detection#DETECTION_AREAS Detection
   -- @return #DETECTION_REPORTING self
   function DETECTION_REPORTING:New( SetGroup, Detection )
@@ -258,7 +218,7 @@ do -- DETECTION_REPORTING
   
   --- Creates a string of the detected items in a @{Detection}.
   -- @param #DETECTION_MANAGER self
-  -- @param Core.Set#SET_UNIT DetectedSet The detected Set created by the @{Functional.Detection#DETECTION_BASE} object.
+  -- @param Set#SET_UNIT DetectedSet The detected Set created by the @{Detection#DETECTION_BASE} object.
   -- @return #DETECTION_MANAGER self
   function DETECTION_REPORTING:GetDetectedItemsText( DetectedSet )
     self:F2()
@@ -288,14 +248,15 @@ do -- DETECTION_REPORTING
   
   
   
-  --- Reports the detected items to the @{Core.Set#SET_GROUP}.
+  --- Reports the detected items to the @{Set#SET_GROUP}.
   -- @param #DETECTION_REPORTING self
-  -- @param Wrapper.Group#GROUP Group The @{Wrapper.Group} object to where the report needs to go.
-  -- @param Functional.Detection#DETECTION_AREAS Detection The detection created by the @{Functional.Detection#DETECTION_BASE} object.
+  -- @param Wrapper.Group#GROUP Group The @{Group} object to where the report needs to go.
+  -- @param Functional.Detection#DETECTION_AREAS Detection The detection created by the @{Detection#DETECTION_BASE} object.
   -- @return #boolean Return true if you want the reporting to continue... false will cancel the reporting loop.
   function DETECTION_REPORTING:ProcessDetected( Group, Detection )
     self:F2( Group )
   
+    self:E( Group )
     local DetectedMsg = {}
     for DetectedAreaID, DetectedAreaData in pairs( Detection:GetDetectedAreas() ) do
       local DetectedArea = DetectedAreaData -- Functional.Detection#DETECTION_AREAS.DetectedArea

Moose Development/Moose/Tasking/Mission.lua

@@ -1,124 +1,21 @@
---- **Tasking** -- A mission models a goal to be achieved through the execution and completion of tasks by human players.
+--- **Tasking** -- A MISSION is the main owner of a Mission orchestration within MOOSE.
 -- 
--- **Features:**
+-- ====
 -- 
---   * A mission has a goal to be achieved, through the execution and completion of tasks of different categories by human players.
---   * A mission manages these tasks.
---   * A mission has a state, that indicates the fase of the mission.
---   * A mission has a menu structure, that facilitates mission reports and tasking menus.
---   * A mission can assign a task to a player.
--- 
--- ===
--- 
--- ### Author: **FlightControl**
+-- ### Author: **Sven Van de Velde (FlightControl)**
 -- 
 -- ### Contributions: 
 -- 
 -- ===
 -- 
--- @module Tasking.Mission
--- @image Task_Mission.JPG
+-- @module Mission
 
---- @type MISSION
+--- The MISSION class
+-- @type MISSION
 -- @field #MISSION.Clients _Clients
 -- @field Core.Menu#MENU_COALITION MissionMenu
 -- @field #string MissionBriefing
 -- @extends Core.Fsm#FSM
-
---- Models goals to be achieved and can contain multiple tasks to be executed to achieve the goals.
--- 
--- A mission contains multiple tasks and can be of different task types.
--- These tasks need to be assigned to human players to be executed.
--- 
--- A mission can have multiple states, which will evolve as the mission progresses during the DCS simulation.
--- 
---   - **IDLE**: The mission is defined, but not started yet. No task has yet been joined by a human player as part of the mission.
---   - **ENGAGED**: The mission is ongoing, players have joined tasks to be executed.
---   - **COMPLETED**: The goals of the mission has been successfully reached, and the mission is flagged as completed.
---   - **FAILED**: For a certain reason, the goals of the mission has not been reached, and the mission is flagged as failed.
---   - **HOLD**: The mission was enaged, but for some reason it has been put on hold.
---   
--- Note that a mission goals need to be checked by a goal check trigger: @{#MISSION.OnBeforeMissionGoals}(), which may return false if the goal has not been reached.
--- This goal is checked automatically by the mission object every x seconds.
--- 
---   - @{#MISSION.Start}() or @{#MISSION.__Start}() will start the mission, and will bring it from **IDLE** state to **ENGAGED** state.
---   - @{#MISSION.Stop}() or @{#MISSION.__Stop}() will stop the mission, and will bring it from **ENGAGED** state to **IDLE** state.
---   - @{#MISSION.Complete}() or @{#MISSION.__Complete}() will complete the mission, and will bring the mission state to **COMPLETED**.
---     Note that the mission must be in state **ENGAGED** to be able to complete the mission.
---   - @{#MISSION.Fail}() or @{#MISSION.__Fail}() will fail the mission, and will bring the mission state to **FAILED**.
---     Note that the mission must be in state **ENGAGED** to be able to fail the mission.
---   - @{#MISSION.Hold}() or @{#MISSION.__Hold}() will hold the mission, and will bring the mission state to **HOLD**.
---     Note that the mission must be in state **ENGAGED** to be able to hold the mission.
---     Re-engage the mission using the engage trigger.
--- 
--- The following sections provide an overview of the most important methods that can be used as part of a mission object.
--- Note that the @{Tasking.CommandCenter} system is using most of these methods to manage the missions in its system.
--- 
--- ## 1. Create a mission object.
---
---   - @{#MISSION.New}(): Creates a new MISSION object.
--- 
--- ## 2. Mission task management.
--- 
--- Missions maintain tasks, which can be added or removed, or enquired.
--- 
---   - @{#MISSION.AddTask}(): Adds a task to the mission.
---   - @{#MISSION.RemoveTask}(): Removes a task from the mission.
--- 
--- ## 3. Mission detailed methods.
--- 
--- Various methods are added to manage missions.
--- 
--- ### 3.1. Naming and description.
--- 
--- There are several methods that can be used to retrieve the properties of a mission:
--- 
---   - Use the method @{#MISSION.GetName}() to retrieve the name of the mission. 
---     This is the name given as part of the @{#MISSION.New}() constructor.
--- 
--- A textual description can be retrieved that provides the mission name to be used within message communication:
--- 
---   - @{#MISSION.GetShortText}() returns the mission name as `Mission "MissionName"`.
---   - @{#MISSION.GetText}() returns the mission  name as `Mission "MissionName (MissionPriority)"`. A longer version including the priority text of the mission.
--- 
--- ### 3.2. Get task information.
--- 
---   - @{#MISSION.GetTasks}(): Retrieves a list of the tasks controlled by the mission.
---   - @{#MISSION.GetTask}(): Retrieves a specific task controlled by the mission.
---   - @{#MISSION.GetTasksRemaining}(): Retrieve a list of the tasks that aren't finished or failed, and are governed by the mission.
---   - @{#MISSION.GetGroupTasks}(): Retrieve a list of the tasks that can be asigned to a @{Wrapper.Group}.
---   - @{#MISSION.GetTaskTypes}(): Retrieve a list of the different task types governed by the mission.
--- 
--- ### 3.3. Get the command center.
--- 
---   - @{#MISSION.GetCommandCenter}(): Retrieves the @{Tasking.CommandCenter} governing the mission.
--- 
--- ### 3.4. Get the groups active in the mission as a @{Core.Set}.
--- 
---   - @{#MISSION.GetGroups}(): Retrieves a @{Core.Set#SET_GROUP} of all the groups active in the mission (as part of the tasks).
---   
--- ### 3.5. Get the names of the players.
--- 
---   - @{#MISSION.GetPlayerNames}(): Retrieves the list of the players that were active within th mission..
--- 
--- ## 4. Menu management.
--- 
--- A mission object is able to manage its own menu structure. Use the @{#MISSION.GetMenu}() and @{#MISSION.SetMenu}() to manage the underlying submenu
--- structure managing the tasks of the mission.
--- 
--- ## 5. Reporting management.
---  
--- Several reports can be generated for a mission, and will return a text string that can be used to display using the @{Core.Message} system.
--- 
---   - @{#MISSION.ReportBriefing}(): Generates the briefing for the mission.
---   - @{#MISSION.ReportOverview}(): Generates an overview of the tasks and status of the mission.
---   - @{#MISSION.ReportDetails}(): Generates a detailed report of the tasks of the mission.
---   - @{#MISSION.ReportSummary}(): Generates a summary report of the tasks of the mission.
---   - @{#MISSION.ReportPlayersPerTask}(): Generates a report showing the active players per task.
---   - @{#MISSION.ReportPlayersProgress}(): Generates a report showing the task progress per player.
--- 
--- 
--- @field #MISSION 
 MISSION = {
 	ClassName = "MISSION",
 	Name = "",
@@ -129,10 +26,10 @@ MISSION = {
 --- This is the main MISSION declaration method. Each Mission is like the master or a Mission orchestration between, Clients, Tasks, Stages etc.
 -- @param #MISSION self
 -- @param Tasking.CommandCenter#COMMANDCENTER CommandCenter
--- @param #string MissionName Name of the mission. This name will be used to reference the status of each mission by the players.
--- @param #string MissionPriority String indicating the "priority" of the Mission. e.g. "Primary", "Secondary". It is free format and up to the Mission designer to choose. There are no rules behind this field.
--- @param #string MissionBriefing String indicating the mission briefing to be shown when a player joins a @{CLIENT}.
--- @param DCS#coaliton.side MissionCoalition Side of the coalition, i.e. and enumerator @{#DCS.coalition.side} corresponding to RED, BLUE or NEUTRAL.
+-- @param #string MissionName is the name of the mission. This name will be used to reference the status of each mission by the players.
+-- @param #string MissionPriority is a string indicating the "priority" of the Mission. f.e. "Primary", "Secondary" or "First", "Second". It is free format and up to the Mission designer to choose. There are no rules behind this field.
+-- @param #string MissionBriefing is a string indicating the mission briefing to be shown when a player joins a @{CLIENT}.
+-- @param Dcs.DCSCoalitionWrapper.Object#coalition MissionCoalition is a string indicating the coalition or party to which this mission belongs to. It is free format and can be chosen freely by the mission designer. Note that this field is not to be confused with the coalition concept of the ME. Examples of a Mission Coalition could be "NATO", "CCCP", "Intruders", "Terrorists"...
 -- @return #MISSION self
 function MISSION:New( CommandCenter, MissionName, MissionPriority, MissionBriefing, MissionCoalition )
 
@@ -149,7 +46,6 @@ function MISSION:New( CommandCenter, MissionName, MissionPriority, MissionBriefi
   self.MissionCoalition = MissionCoalition
   
   self.Tasks = {}
-  self.TaskNumber = 0
   self.PlayerNames = {} -- These are the players that achieved progress in the mission.
 
   self:SetStartState( "IDLE" )
@@ -368,8 +264,6 @@ function MISSION:New( CommandCenter, MissionName, MissionPriority, MissionBriefi
 end
 
 
-
-
 --- FSM function for a MISSION
 -- @param #MISSION self
 -- @param #string From
@@ -377,33 +271,16 @@ end
 -- @param #string To
 function MISSION:onenterCOMPLETED( From, Event, To )
 
-  self:GetCommandCenter():MessageTypeToCoalition( self:GetText() .. " has been completed! Good job guys!", MESSAGE.Type.Information )
+  self:GetCommandCenter():MessageTypeToCoalition( self:GetName() .. " has been completed! Good job guys!", MESSAGE.Type.Information )
 end
 
 --- Gets the mission name.
 -- @param #MISSION self
 -- @return #MISSION self
 function MISSION:GetName()
-  return self.Name
-end
-
-
---- Gets the mission text.
--- @param #MISSION self
--- @return #MISSION self
-function MISSION:GetText()
   return string.format( 'Mission "%s (%s)"', self.Name, self.MissionPriority )
 end
 
-
---- Gets the short mission text.
--- @param #MISSION self
--- @return #MISSION self
-function MISSION:GetShortText()
-  return string.format( 'Mission "%s"', self.Name )
-end
-
-
 --- Add a Unit to join the Mission.
 -- For each Task within the Mission, the Unit is joined with the Task.
 -- If the Unit was not part of a Task in the Mission, false is returned.
@@ -413,7 +290,7 @@ end
 -- @param Wrapper.Group#GROUP PlayerGroup The GROUP of the player joining the Mission.
 -- @return #boolean true if Unit is part of a Task in the Mission.
 function MISSION:JoinUnit( PlayerUnit, PlayerGroup )
-  self:I( { Mission = self:GetName(), PlayerUnit = PlayerUnit, PlayerGroup = PlayerGroup } )
+  self:F( { PlayerUnit = PlayerUnit, PlayerGroup = PlayerGroup } )
   
   local PlayerUnitAdded = false
   
@@ -480,30 +357,24 @@ function MISSION:GetScoring()
   return self.Scoring
 end
 
---- Gets the groups for which TASKS are given in the mission
+--- Get the groups for which TASKS are given in the mission
 -- @param #MISSION self
--- @param Core.Set#SET_GROUP GroupSet
 -- @return Core.Set#SET_GROUP
 function MISSION:GetGroups()
   
-  return self:AddGroups()
-  
-end
-
---- Adds the groups for which TASKS are given in the mission
--- @param #MISSION self
--- @param Core.Set#SET_GROUP GroupSet
--- @return Core.Set#SET_GROUP
-function MISSION:AddGroups( GroupSet )
-  
-  GroupSet = GroupSet or SET_GROUP:New()
+  local SetGroup = SET_GROUP:New()
   
   for TaskID, Task in pairs( self:GetTasks() ) do
     local Task = Task -- Tasking.Task#TASK
-    GroupSet = Task:AddGroups( GroupSet )
+    local GroupSet = Task:GetGroups()
+    GroupSet:ForEachGroup(
+      function( TaskGroup )
+        SetGroup:Add( TaskGroup, TaskGroup )
+      end
+    )
   end
   
-  return GroupSet
+  return SetGroup
   
 end
 
@@ -514,16 +385,9 @@ end
 function MISSION:SetMenu( MenuTime )
   self:F( { self:GetName(), MenuTime } )
   
-  local MenuCount = {}
-  --for TaskID, Task in UTILS.spairs( self:GetTasks(), function( t, a, b ) return t[a]:ReportOrder( ReportGroup ) <  t[b]:ReportOrder( ReportGroup ) end  ) do
-  for TaskID, Task in pairs( self:GetTasks() ) do
-    local Task = Task -- Tasking.Task#TASK
-    local TaskType = Task:GetType()
-    MenuCount[TaskType] = MenuCount[TaskType] or 1
-    if MenuCount[TaskType] <= 10 then
-      Task:SetMenu( MenuTime )
-      MenuCount[TaskType] = MenuCount[TaskType] + 1
-    end
+  for _, TaskData in pairs( self:GetTasks() ) do
+    local Task = TaskData -- Tasking.Task#TASK
+    Task:SetMenu( MenuTime )  
   end
 end
 
@@ -552,16 +416,16 @@ do -- Group Assignment
     local MissionGroupName = MissionGroup:GetName()
     
     if self.AssignedGroups[MissionGroupName] == MissionGroup then
-      self:T2( { "Mission is assigned to:", MissionGroup:GetName() } )
+      self:T( { "Mission is assigned to:", MissionGroup:GetName() } )
       return true
     end
     
-    self:T2( { "Mission is not assigned to:", MissionGroup:GetName() } )
+    self:T( { "Mission is not assigned to:", MissionGroup:GetName() } )
     return false
   end
   
   
-  --- Set @{Wrapper.Group} assigned to the @{Mission}.
+  --- Set @{Group} assigned to the @{Mission}.
   -- @param #MISSION self
   -- @param Wrapper.Group#GROUP MissionGroup
   -- @return #MISSION
@@ -571,12 +435,12 @@ do -- Group Assignment
     local MissionGroupName = MissionGroup:GetName()
   
     self.AssignedGroups[MissionGroupName] = MissionGroup
-    self:I( string.format( "Mission %s is assigned to %s", MissionName, MissionGroupName ) )
+    self:E( string.format( "Mission %s is assigned to %s", MissionName, MissionGroupName ) )
     
     return self
   end
   
-  --- Clear the @{Wrapper.Group} assignment from the @{Mission}.
+  --- Clear the @{Group} assignment from the @{Mission}.
   -- @param #MISSION self
   -- @param Wrapper.Group#GROUP MissionGroup
   -- @return #MISSION
@@ -611,54 +475,53 @@ function MISSION:RemoveTaskMenu( Task )
 end
 
 
---- Gets the root mission menu for the TaskGroup. Obsolete?! Originally no reference to TaskGroup parameter!
+--- Gets the root mission menu for the TaskGroup.
 -- @param #MISSION self
--- @param Wrapper.Group#GROUP TaskGroup Task group.
 -- @return Core.Menu#MENU_COALITION self
 function MISSION:GetRootMenu( TaskGroup ) -- R2.2
 
   local CommandCenter = self:GetCommandCenter()
-  local CommandCenterMenu = CommandCenter:GetMenu( TaskGroup )
+  local CommandCenterMenu = CommandCenter:GetMenu()
 
-  local MissionName = self:GetText()
+  local MissionName = self:GetName()
   --local MissionMenu = CommandCenterMenu:GetMenu( MissionName )
   
-  self.MissionMenu = MENU_COALITION:New( self.MissionCoalition, MissionName, CommandCenterMenu )
+  self.MissionMenu = self.MissionMenu or MENU_COALITION:New( self.MissionCoalition, self:GetName(), CommandCenterMenu )
 
   return self.MissionMenu
 end
 
 --- Gets the mission menu for the TaskGroup.
 -- @param #MISSION self
--- @param Wrapper.Group#GROUP TaskGroup Task group.
 -- @return Core.Menu#MENU_COALITION self
 function MISSION:GetMenu( TaskGroup ) -- R2.1 -- Changed Menu Structure
 
   local CommandCenter = self:GetCommandCenter()
-  local CommandCenterMenu = CommandCenter:GetMenu( TaskGroup )
+  local CommandCenterMenu = CommandCenter:GetMenu()
 
+  local MissionName = self:GetName()
+  --local MissionMenu = CommandCenterMenu:GetMenu( MissionName )
+  
   self.MissionGroupMenu = self.MissionGroupMenu or {}
   self.MissionGroupMenu[TaskGroup] = self.MissionGroupMenu[TaskGroup] or {}
   
   local GroupMenu = self.MissionGroupMenu[TaskGroup]
   
-  local MissionText = self:GetText()
-  self.MissionMenu = MENU_GROUP:New( TaskGroup, MissionText, CommandCenterMenu )
+  self.MissionMenu = self.MissionMenu or MENU_COALITION:New( self.MissionCoalition, self:GetName(), CommandCenterMenu )
   
-  GroupMenu.BriefingMenu = MENU_GROUP_COMMAND:New( TaskGroup, "Mission Briefing", self.MissionMenu, self.MenuReportBriefing, self, TaskGroup )
+  GroupMenu.BriefingMenu = GroupMenu.BriefingMenu or MENU_GROUP_COMMAND:New( TaskGroup, "Mission Briefing", self.MissionMenu, self.MenuReportBriefing, self, TaskGroup )
 
-  GroupMenu.MarkTasks = MENU_GROUP_COMMAND:New( TaskGroup, "Mark Task Locations on Map", self.MissionMenu, self.MarkTargetLocations, self, TaskGroup )
-  GroupMenu.TaskReportsMenu = MENU_GROUP:New( TaskGroup, "Task Reports", self.MissionMenu )
-  GroupMenu.ReportTasksMenu = MENU_GROUP_COMMAND:New( TaskGroup, "Report Tasks Summary", GroupMenu.TaskReportsMenu, self.MenuReportTasksSummary, self, TaskGroup )
-  GroupMenu.ReportPlannedTasksMenu = MENU_GROUP_COMMAND:New( TaskGroup, "Report Planned Tasks", GroupMenu.TaskReportsMenu, self.MenuReportTasksPerStatus, self, TaskGroup, "Planned" )
-  GroupMenu.ReportAssignedTasksMenu = MENU_GROUP_COMMAND:New( TaskGroup, "Report Assigned Tasks", GroupMenu.TaskReportsMenu, self.MenuReportTasksPerStatus, self, TaskGroup, "Assigned" )
-  GroupMenu.ReportSuccessTasksMenu = MENU_GROUP_COMMAND:New( TaskGroup, "Report Successful Tasks", GroupMenu.TaskReportsMenu, self.MenuReportTasksPerStatus, self, TaskGroup, "Success" )
-  GroupMenu.ReportFailedTasksMenu = MENU_GROUP_COMMAND:New( TaskGroup, "Report Failed Tasks", GroupMenu.TaskReportsMenu, self.MenuReportTasksPerStatus, self, TaskGroup, "Failed" )
-  GroupMenu.ReportHeldTasksMenu = MENU_GROUP_COMMAND:New( TaskGroup, "Report Held Tasks", GroupMenu.TaskReportsMenu, self.MenuReportTasksPerStatus, self, TaskGroup, "Hold" )
+  GroupMenu.TaskReportsMenu = GroupMenu.TaskReportsMenu or                      MENU_GROUP:New( TaskGroup, "Task Reports", self.MissionMenu )
+  GroupMenu.ReportTasksMenu = GroupMenu.ReportTasksMenu or                      MENU_GROUP_COMMAND:New( TaskGroup, "Report Tasks", GroupMenu.TaskReportsMenu, self.MenuReportTasksSummary, self, TaskGroup )
+  GroupMenu.ReportPlannedTasksMenu = GroupMenu.ReportPlannedTasksMenu or        MENU_GROUP_COMMAND:New( TaskGroup, "Report Planned Tasks", GroupMenu.TaskReportsMenu, self.MenuReportTasksPerStatus, self, TaskGroup, "Planned" )
+  GroupMenu.ReportAssignedTasksMenu = GroupMenu.ReportAssignedTasksMenu or      MENU_GROUP_COMMAND:New( TaskGroup, "Report Assigned Tasks", GroupMenu.TaskReportsMenu, self.MenuReportTasksPerStatus, self, TaskGroup, "Assigned" )
+  GroupMenu.ReportSuccessTasksMenu = GroupMenu.ReportSuccessTasksMenu or        MENU_GROUP_COMMAND:New( TaskGroup, "Report Successful Tasks", GroupMenu.TaskReportsMenu, self.MenuReportTasksPerStatus, self, TaskGroup, "Success" )
+  GroupMenu.ReportFailedTasksMenu = GroupMenu.ReportFailedTasksMenu or          MENU_GROUP_COMMAND:New( TaskGroup, "Report Failed Tasks", GroupMenu.TaskReportsMenu, self.MenuReportTasksPerStatus, self, TaskGroup, "Failed" )
+  GroupMenu.ReportHeldTasksMenu = GroupMenu.ReportHeldTasksMenu or              MENU_GROUP_COMMAND:New( TaskGroup, "Report Held Tasks", GroupMenu.TaskReportsMenu, self.MenuReportTasksPerStatus, self, TaskGroup, "Hold" )
   
-  GroupMenu.PlayerReportsMenu = MENU_GROUP:New( TaskGroup, "Statistics Reports", self.MissionMenu )
-  GroupMenu.ReportMissionHistory = MENU_GROUP_COMMAND:New( TaskGroup, "Report Mission Progress", GroupMenu.PlayerReportsMenu, self.MenuReportPlayersProgress, self, TaskGroup )
-  GroupMenu.ReportPlayersPerTaskMenu = MENU_GROUP_COMMAND:New( TaskGroup, "Report Players per Task", GroupMenu.PlayerReportsMenu, self.MenuReportPlayersPerTask, self, TaskGroup )
+  GroupMenu.PlayerReportsMenu = GroupMenu.PlayerReportsMenu or                  MENU_GROUP:New( TaskGroup, "Statistics Reports", self.MissionMenu )
+  GroupMenu.ReportMissionHistory = GroupMenu.ReportPlayersHistory or            MENU_GROUP_COMMAND:New( TaskGroup, "Report Mission Progress", GroupMenu.PlayerReportsMenu, self.MenuReportPlayersProgress, self, TaskGroup )
+  GroupMenu.ReportPlayersPerTaskMenu = GroupMenu.ReportPlayersPerTaskMenu or    MENU_GROUP_COMMAND:New( TaskGroup, "Report Players per Task", GroupMenu.PlayerReportsMenu, self.MenuReportPlayersPerTask, self, TaskGroup )
   
   return self.MissionMenu
 end
@@ -670,25 +533,13 @@ end
 -- @param #string TaskName The Name of the @{Task} within the @{Mission}.
 -- @return Tasking.Task#TASK The Task
 -- @return #nil Returns nil if no task was found.
-function MISSION:GetTask( TaskName )
+function MISSION:GetTask( TaskName  )
   self:F( { TaskName } )
 
   return self.Tasks[TaskName]
 end
 
 
---- Return the next @{Task} ID to be completed within the @{Mission}. 
--- @param #MISSION self
--- @param Tasking.Task#TASK Task is the @{Task} object.
--- @return Tasking.Task#TASK The task added.
-function MISSION:GetNextTaskID( Task )
-
-  self.TaskNumber = self.TaskNumber + 1
-
-  return self.TaskNumber
-end
-
-
 --- Register a @{Task} to be completed within the @{Mission}. 
 -- Note that there can be multiple @{Task}s registered to be completed. 
 -- Each Task can be set a certain Goals. The Mission will not be completed until all Goals are reached.
@@ -698,7 +549,9 @@ end
 function MISSION:AddTask( Task )
 
   local TaskName = Task:GetTaskName()
-  self:I( { "==> Adding TASK ", MissionName = self:GetName(), TaskName = TaskName } )
+  self:F( TaskName )
+
+  self.Tasks[TaskName] = self.Tasks[TaskName] or { n = 0 }
 
   self.Tasks[TaskName] = Task
   
@@ -707,7 +560,6 @@ function MISSION:AddTask( Task )
   return Task
 end
 
-
 --- Removes a @{Task} to be completed within the @{Mission}. 
 -- Note that there can be multiple @{Task}s registered to be completed. 
 -- Each Task can be set a certain Goals. The Mission will not be completed until all Goals are reached.
@@ -717,7 +569,6 @@ end
 function MISSION:RemoveTask( Task )
 
   local TaskName = Task:GetTaskName()
-  self:I( { "<== Removing TASK ", MissionName = self:GetName(), TaskName = TaskName } )
 
   self:F( TaskName )
   self.Tasks[TaskName] = self.Tasks[TaskName] or { n = 0 }
@@ -733,6 +584,21 @@ function MISSION:RemoveTask( Task )
   return nil
 end
 
+--- Return the next @{Task} ID to be completed within the @{Mission}. 
+-- @param #MISSION self
+-- @param Tasking.Task#TASK Task is the @{Task} object.
+-- @return Tasking.Task#TASK The task added.
+function MISSION:GetNextTaskID( Task )
+
+  local TaskName = Task:GetTaskName()
+  self:F( TaskName )
+  self.Tasks[TaskName] = self.Tasks[TaskName] or { n = 0 }
+  
+  self.Tasks[TaskName].n = self.Tasks[TaskName].n + 1
+
+  return self.Tasks[TaskName].n
+end
+
 --- Is the @{Mission} **COMPLETED**.
 -- @param #MISSION self
 -- @return #boolean
@@ -834,7 +700,7 @@ function MISSION:ReportBriefing()
   local Report = REPORT:New()
 
   -- List the name of the mission.
-  local Name = self:GetText()
+  local Name = self:GetName()
   
   -- Determine the status of the mission.
   local Status = "<" .. self:GetState() .. ">"
@@ -847,57 +713,57 @@ function MISSION:ReportBriefing()
 end
 
 
------ Create a status report of the Mission.
----- This reports provides a one liner of the mission status. It indicates how many players and how many Tasks.
----- 
-----     Mission "<MissionName>" - Status "<MissionStatus>"
-----      - Task Types: <TaskType>, <TaskType>
-----      - <xx> Planned Tasks (xp)
-----      - <xx> Assigned Tasks(xp)
-----      - <xx> Success Tasks (xp)
-----      - <xx> Hold Tasks (xp)
-----      - <xx> Cancelled Tasks (xp)
-----      - <xx> Aborted Tasks (xp)
-----      - <xx> Failed Tasks (xp)
----- 
----- @param #MISSION self
----- @return #string
---function MISSION:ReportSummary()
---
---  local Report = REPORT:New()
---
---  -- List the name of the mission.
---  local Name = self:GetText()
---  
---  -- Determine the status of the mission.
---  local Status = "<" .. self:GetState() .. ">"
---
---  Report:Add( string.format( '%s - Status "%s"', Name, Status ) )
---  
---  local TaskTypes = self:GetTaskTypes()
---  
---  Report:Add( string.format( " - Task Types: %s", table.concat(TaskTypes, ", " ) ) )
---  
---  local TaskStatusList = { "Planned", "Assigned", "Success", "Hold", "Cancelled", "Aborted", "Failed" }
---  
---  for TaskStatusID, TaskStatus in pairs( TaskStatusList ) do
---    local TaskCount = 0
---    local TaskPlayerCount = 0 
---    -- Determine how many tasks are remaining.
---    for TaskID, Task in pairs( self:GetTasks() ) do
---      local Task = Task -- Tasking.Task#TASK
---      if Task:Is( TaskStatus ) then
---        TaskCount = TaskCount + 1
---        TaskPlayerCount = TaskPlayerCount + Task:GetPlayerCount()
---      end
---    end
---    if TaskCount > 0 then
---      Report:Add( string.format( " - %02d %s Tasks (%dp)", TaskCount, TaskStatus, TaskPlayerCount ) )
---    end
---  end
---
---  return Report:Text()
---end
+--- Create a status report of the Mission.
+-- This reports provides a one liner of the mission status. It indicates how many players and how many Tasks.
+-- 
+--     Mission "<MissionName>" - Status "<MissionStatus>"
+--      - Task Types: <TaskType>, <TaskType>
+--      - <xx> Planned Tasks (xp)
+--      - <xx> Assigned Tasks(xp)
+--      - <xx> Success Tasks (xp)
+--      - <xx> Hold Tasks (xp)
+--      - <xx> Cancelled Tasks (xp)
+--      - <xx> Aborted Tasks (xp)
+--      - <xx> Failed Tasks (xp)
+-- 
+-- @param #MISSION self
+-- @return #string
+function MISSION:ReportStatus()
+
+  local Report = REPORT:New()
+
+  -- List the name of the mission.
+  local Name = self:GetName()
+  
+  -- Determine the status of the mission.
+  local Status = "<" .. self:GetState() .. ">"
+
+  Report:Add( string.format( '%s - Status "%s"', Name, Status ) )
+  
+  local TaskTypes = self:GetTaskTypes()
+  
+  Report:Add( string.format( " - Task Types: %s", table.concat(TaskTypes, ", " ) ) )
+  
+  local TaskStatusList = { "Planned", "Assigned", "Success", "Hold", "Cancelled", "Aborted", "Failed" }
+  
+  for TaskStatusID, TaskStatus in pairs( TaskStatusList ) do
+    local TaskCount = 0
+    local TaskPlayerCount = 0 
+    -- Determine how many tasks are remaining.
+    for TaskID, Task in pairs( self:GetTasks() ) do
+      local Task = Task -- Tasking.Task#TASK
+      if Task:Is( TaskStatus ) then
+        TaskCount = TaskCount + 1
+        TaskPlayerCount = TaskPlayerCount + Task:GetPlayerCount()
+      end
+    end
+    if TaskCount > 0 then
+      Report:Add( string.format( " - %02d %s Tasks (%dp)", TaskCount, TaskStatus, TaskPlayerCount ) )
+    end
+  end
+
+  return Report:Text()
+end
 
 
 --- Create an active player report of the Mission.
@@ -915,7 +781,7 @@ function MISSION:ReportPlayersPerTask( ReportGroup )
   local Report = REPORT:New()
 
   -- List the name of the mission.
-  local Name = self:GetText()
+  local Name = self:GetName()
   
   -- Determine the status of the mission.
   local Status = "<" .. self:GetState() .. ">"
@@ -956,7 +822,7 @@ function MISSION:ReportPlayersProgress( ReportGroup )
   local Report = REPORT:New()
 
   -- List the name of the mission.
-  local Name = self:GetText()
+  local Name = self:GetName()
   
   -- Determine the status of the mission.
   local Status = "<" .. self:GetState() .. ">"
@@ -992,32 +858,6 @@ function MISSION:ReportPlayersProgress( ReportGroup )
 end
 
 
---- Mark all the target locations on the Map.
--- @param #MISSION self
--- @param Wrapper.Group#GROUP ReportGroup
--- @return #string
-function MISSION:MarkTargetLocations( ReportGroup )
-
-  local Report = REPORT:New()
-
-  -- List the name of the mission.
-  local Name = self:GetText()
-  
-  -- Determine the status of the mission.
-  local Status = "<" .. self:GetState() .. ">"
-  
-  Report:Add( string.format( '%s - %s - All Tasks are marked on the map. Select a Task from the Mission Menu and Join the Task!!!', Name, Status ) )
-
-  -- Determine how many tasks are remaining.
-  for TaskID, Task in UTILS.spairs( self:GetTasks(), function( t, a, b ) return t[a]:ReportOrder( ReportGroup ) <  t[b]:ReportOrder( ReportGroup ) end  ) do
-    local Task = Task -- Tasking.Task#TASK
-    Task:MenuMarkToGroup( ReportGroup )
-  end
-  
-  return Report:Text()
-end
-
-
 --- Create a summary report of the Mission (one line).
 -- @param #MISSION self
 -- @param Wrapper.Group#GROUP ReportGroup
@@ -1027,7 +867,7 @@ function MISSION:ReportSummary( ReportGroup )
   local Report = REPORT:New()
 
   -- List the name of the mission.
-  local Name = self:GetText()
+  local Name = self:GetName()
   
   -- Determine the status of the mission.
   local Status = "<" .. self:GetState() .. ">"
@@ -1053,7 +893,7 @@ function MISSION:ReportOverview( ReportGroup, TaskStatus )
   local Report = REPORT:New()
 
   -- List the name of the mission.
-  local Name = self:GetText()
+  local Name = self:GetName()
   
   -- Determine the status of the mission.
   local Status = "<" .. self:GetState() .. ">"
@@ -1066,7 +906,7 @@ function MISSION:ReportOverview( ReportGroup, TaskStatus )
     local Task = Task -- Tasking.Task#TASK
     if Task:Is( TaskStatus ) then
       Report:Add( string.rep( "-", 140 ) )
-      Report:Add( Task:ReportOverview( ReportGroup ) )
+      Report:Add( " - " .. Task:ReportOverview( ReportGroup ) )
     end
     Tasks = Tasks + 1
     if Tasks >= 8 then
@@ -1085,7 +925,7 @@ function MISSION:ReportDetails( ReportGroup )
   local Report = REPORT:New()
   
   -- List the name of the mission.
-  local Name = self:GetText()
+  local Name = self:GetName()
   
   -- Determine the status of the mission.
   local Status = "<" .. self:GetState() .. ">"
@@ -1096,7 +936,6 @@ function MISSION:ReportDetails( ReportGroup )
   local TasksRemaining = 0
   for TaskID, Task in pairs( self:GetTasks() ) do
     local Task = Task -- Tasking.Task#TASK
-    Report:Add( string.rep( "-", 140 ) )
     Report:Add( Task:ReportDetails( ReportGroup ) )
   end
 
@@ -1111,28 +950,9 @@ end
 -- env.info( "Task 2 Completion = " .. Tasks[2]:GetGoalPercentage() .. "%" )
 function MISSION:GetTasks()
 
-	return self.Tasks or {}
+	return self.Tasks
 end
 
---- Get the relevant tasks of a TaskGroup.
--- @param #MISSION
--- @param Wrapper.Group#GROUP TaskGroup
--- @return #list<Tasking.Task#TASK>
-function MISSION:GetGroupTasks( TaskGroup )
-
-  local Tasks = {}
-  
-  for TaskID, Task in pairs( self:GetTasks() ) do
-    local Task = Task -- Tasking.Task#TASK
-    if Task:HasGroup( TaskGroup ) then
-      Tasks[#Tasks+1] = Task
-    end
-  end
-  
-  return Tasks
-end
-
-
 --- Reports the briefing.
 -- @param #MISSION self
 -- @param Wrapper.Group#GROUP ReportGroup The group to which the report needs to be sent.
@@ -1144,17 +964,6 @@ function MISSION:MenuReportBriefing( ReportGroup )
 end
 
 
---- Mark all the targets of the Mission on the Map.
--- @param #MISSION self
--- @param Wrapper.Group#GROUP ReportGroup
-function MISSION:MenuMarkTargetLocations( ReportGroup )
-
-  local Report = self:MarkTargetLocations( ReportGroup )
-  
-  self:GetCommandCenter():MessageTypeToGroup( Report, ReportGroup, MESSAGE.Type.Overview )
-end
-
-
 
 --- Report the task summary.
 -- @param #MISSION self

Moose Development/Moose/Tasking/TaskInfo.lua

@@ -1,371 +0,0 @@
---- **Tasking** -- Controls the information of a Task.
--- 
--- ===
--- 
--- ### Author: **FlightControl**
--- 
--- ### Contributions: 
--- 
--- ===
--- 
--- @module Tasking.TaskInfo
--- @image MOOSE.JPG
-
---- @type TASKINFO
--- @extends Core.Base#BASE
-
---- 
--- # TASKINFO class, extends @{Core.Base#BASE}
--- 
--- ## The TASKINFO class implements the methods to contain information and display information of a task. 
--- 
--- @field #TASKINFO
-TASKINFO = {
-  ClassName = "TASKINFO",
-}
-
---- @type #TASKINFO.Detail #string A string that flags to document which level of detail needs to be shown in the report.
--- 
---   - "M" for Markings on the Map (F10).
---   - "S" for Summary Reports.
---   - "O" for Overview Reports.
---   - "D" for Detailed Reports.
-TASKINFO.Detail = ""
-
---- Instantiates a new TASKINFO. 
--- @param #TASKINFO self
--- @param Tasking.Task#TASK Task The task owning the information.
--- @return #TASKINFO self
-function TASKINFO:New( Task )
-
-  local self = BASE:Inherit( self, BASE:New() ) -- Core.Base#BASE
-  
-  self.Task = Task
-  self.VolatileInfo = SET_BASE:New()
-  self.PersistentInfo = SET_BASE:New()
-  
-  self.Info = self.VolatileInfo
-  
-  return self
-end
-
-
---- Add taskinfo. 
--- @param #TASKINFO self
--- @param #string The info key.
--- @param Data The data of the info.
--- @param #number Order The display order, which is a number from 0 to 100.
--- @param #TASKINFO.Detail Detail The detail Level.
--- @param #boolean Keep (optional) If true, this would indicate that the planned taskinfo would be persistent when the task is completed, so that the original planned task info is used at the completed reports.
--- @return #TASKINFO self
-function TASKINFO:AddInfo( Key, Data, Order, Detail, Keep )
-  self.VolatileInfo:Add( Key, { Data = Data, Order = Order, Detail = Detail } )
-  if Keep == true then
-    self.PersistentInfo:Add( Key, { Data = Data, Order = Order, Detail = Detail } )
-  end
-  return self
-end
-
-
---- Get taskinfo. 
--- @param #TASKINFO self
--- @param #string The info key.
--- @return Data The data of the info.
--- @return #number Order The display order, which is a number from 0 to 100.
--- @return #TASKINFO.Detail Detail The detail Level.
-function TASKINFO:GetInfo( Key )
-  local Object = self:Get( Key )
-  return Object.Data, Object.Order, Object.Detail
-end
-
-
---- Get data. 
--- @param #TASKINFO self
--- @param #string The info key.
--- @return Data The data of the info.
-function TASKINFO:GetData( Key )
-  local Object = self.Info:Get( Key )
-  return Object and Object.Data
-end
-
-
---- Add Text. 
--- @param #TASKINFO self
--- @param #string Key The key.
--- @param #string Text The text.
--- @param #number Order The display order, which is a number from 0 to 100.
--- @param #TASKINFO.Detail Detail The detail Level.
--- @param #boolean Keep (optional) If true, this would indicate that the planned taskinfo would be persistent when the task is completed, so that the original planned task info is used at the completed reports.
--- @return #TASKINFO self
-function TASKINFO:AddText( Key, Text, Order, Detail, Keep )
-  self:AddInfo( Key, Text, Order, Detail, Keep )
-  return self
-end
-
-
---- Add the task name. 
--- @param #TASKINFO self
--- @param #number Order The display order, which is a number from 0 to 100.
--- @param #TASKINFO.Detail Detail The detail Level.
--- @param #boolean Keep (optional) If true, this would indicate that the planned taskinfo would be persistent when the task is completed, so that the original planned task info is used at the completed reports.
--- @return #TASKINFO self
-function TASKINFO:AddTaskName( Order, Detail, Keep )
-  self:AddInfo( "TaskName", self.Task:GetName(), Order, Detail, Keep )
-  return self
-end
-
-
-
-
---- Add a Coordinate. 
--- @param #TASKINFO self
--- @param Core.Point#COORDINATE Coordinate
--- @param #number Order The display order, which is a number from 0 to 100.
--- @param #TASKINFO.Detail Detail The detail Level.
--- @param #boolean Keep (optional) If true, this would indicate that the planned taskinfo would be persistent when the task is completed, so that the original planned task info is used at the completed reports.
--- @return #TASKINFO self
-function TASKINFO:AddCoordinate( Coordinate, Order, Detail, Keep )
-  self:AddInfo( "Coordinate", Coordinate, Order, Detail, Keep )
-  return self
-end
-
-
---- Add Coordinates. 
--- @param #TASKINFO self
--- @param #list<Core.Point#COORDINATE> Coordinates
--- @param #number Order The display order, which is a number from 0 to 100.
--- @param #TASKINFO.Detail Detail The detail Level.
--- @param #boolean Keep (optional) If true, this would indicate that the planned taskinfo would be persistent when the task is completed, so that the original planned task info is used at the completed reports.
--- @return #TASKINFO self
-function TASKINFO:AddCoordinates( Coordinates, Order, Detail, Keep )
-  self:AddInfo( "Coordinates", Coordinates, Order, Detail, Keep )
-  return self
-end
-
-
-
---- Add Threat. 
--- @param #TASKINFO self
--- @param #string ThreatText The text of the Threat.
--- @param #string ThreatLevel The level of the Threat.
--- @param #number Order The display order, which is a number from 0 to 100.
--- @param #TASKINFO.Detail Detail The detail Level.
--- @param #boolean Keep (optional) If true, this would indicate that the planned taskinfo would be persistent when the task is completed, so that the original planned task info is used at the completed reports.
--- @return #TASKINFO self
-function TASKINFO:AddThreat( ThreatText, ThreatLevel, Order, Detail, Keep )
-  self:AddInfo( "Threat", ThreatText .. " [" .. string.rep(  "■", ThreatLevel ) .. string.rep(  "□", 10 - ThreatLevel ) .. "]", Order, Detail, Keep )
-  return self
-end
-
-
---- Get Threat. 
--- @param #TASKINFO self
--- @return #string The threat
-function TASKINFO:GetThreat()
-  self:GetInfo( "Threat" )
-  return self
-end
-
-
-
---- Add the Target count. 
--- @param #TASKINFO self
--- @param #number TargetCount The amount of targets.
--- @param #number Order The display order, which is a number from 0 to 100.
--- @param #TASKINFO.Detail Detail The detail Level.
--- @param #boolean Keep (optional) If true, this would indicate that the planned taskinfo would be persistent when the task is completed, so that the original planned task info is used at the completed reports.
--- @return #TASKINFO self
-function TASKINFO:AddTargetCount( TargetCount, Order, Detail, Keep )
-  self:AddInfo( "Counting", string.format( "%d", TargetCount ), Order, Detail, Keep )
-  return self
-end
-
---- Add the Targets. 
--- @param #TASKINFO self
--- @param #number TargetCount The amount of targets.
--- @param #string TargetTypes The text containing the target types.
--- @param #number Order The display order, which is a number from 0 to 100.
--- @param #TASKINFO.Detail Detail The detail Level.
--- @param #boolean Keep (optional) If true, this would indicate that the planned taskinfo would be persistent when the task is completed, so that the original planned task info is used at the completed reports.
--- @return #TASKINFO self
-function TASKINFO:AddTargets( TargetCount, TargetTypes, Order, Detail, Keep )
-  self:AddInfo( "Targets", string.format( "%d of %s", TargetCount, TargetTypes ), Order, Detail, Keep )
-  return self
-end
-
---- Get Targets. 
--- @param #TASKINFO self
--- @return #string The targets
-function TASKINFO:GetTargets()
-  self:GetInfo( "Targets" )
-  return self
-end
-
-
-
-
---- Add the QFE at a Coordinate. 
--- @param #TASKINFO self
--- @param Core.Point#COORDINATE Coordinate
--- @param #number Order The display order, which is a number from 0 to 100.
--- @param #TASKINFO.Detail Detail The detail Level.
--- @param #boolean Keep (optional) If true, this would indicate that the planned taskinfo would be persistent when the task is completed, so that the original planned task info is used at the completed reports.
--- @return #TASKINFO self
-function TASKINFO:AddQFEAtCoordinate( Coordinate, Order, Detail, Keep )
-  self:AddInfo( "QFE", Coordinate, Order, Detail, Keep )
-  return self
-end
-
---- Add the Temperature at a Coordinate. 
--- @param #TASKINFO self
--- @param Core.Point#COORDINATE Coordinate
--- @param #number Order The display order, which is a number from 0 to 100.
--- @param #TASKINFO.Detail Detail The detail Level.
--- @param #boolean Keep (optional) If true, this would indicate that the planned taskinfo would be persistent when the task is completed, so that the original planned task info is used at the completed reports.
--- @return #TASKINFO self
-function TASKINFO:AddTemperatureAtCoordinate( Coordinate, Order, Detail, Keep )
-  self:AddInfo( "Temperature", Coordinate, Order, Detail, Keep )
-  return self
-end
-
---- Add the Wind at a Coordinate. 
--- @param #TASKINFO self
--- @param Core.Point#COORDINATE Coordinate
--- @param #number Order The display order, which is a number from 0 to 100.
--- @param #TASKINFO.Detail Detail The detail Level.
--- @param #boolean Keep (optional) If true, this would indicate that the planned taskinfo would be persistent when the task is completed, so that the original planned task info is used at the completed reports.
--- @return #TASKINFO self
-function TASKINFO:AddWindAtCoordinate( Coordinate, Order, Detail, Keep )
-  self:AddInfo( "Wind", Coordinate, Order, Detail, Keep )
-  return self
-end
-
---- Add Cargo. 
--- @param #TASKINFO self
--- @param Core.Cargo#CARGO Cargo
--- @param #number Order The display order, which is a number from 0 to 100.
--- @param #TASKINFO.Detail Detail The detail Level.
--- @param #boolean Keep (optional) If true, this would indicate that the planned taskinfo would be persistent when the task is completed, so that the original planned task info is used at the completed reports.
--- @return #TASKINFO self
-function TASKINFO:AddCargo( Cargo, Order, Detail, Keep )
-  self:AddInfo( "Cargo", Cargo, Order, Detail, Keep )
-  return self
-end
-
-
---- Add Cargo set. 
--- @param #TASKINFO self
--- @param Core.Set#SET_CARGO SetCargo
--- @param #number Order The display order, which is a number from 0 to 100.
--- @param #TASKINFO.Detail Detail The detail Level.
--- @param #boolean Keep (optional) If true, this would indicate that the planned taskinfo would be persistent when the task is completed, so that the original planned task info is used at the completed reports.
--- @return #TASKINFO self
-function TASKINFO:AddCargoSet( SetCargo, Order, Detail, Keep )
-
-  local CargoReport = REPORT:New()
-  CargoReport:Add( "" )
-  SetCargo:ForEachCargo(
-    --- @param Cargo.Cargo#CARGO Cargo
-    function( Cargo )
-      CargoReport:Add( string.format( ' - %s (%s) %s - status %s ', Cargo:GetName(), Cargo:GetType(), Cargo:GetTransportationMethod(), Cargo:GetCurrentState() ) )
-    end
-  )
-
-  self:AddInfo( "Cargo", CargoReport:Text(), Order, Detail, Keep )
-  
-
-  return self
-end
-
-
-
---- Create the taskinfo Report
--- @param #TASKINFO self
--- @param Core.Report#REPORT Report
--- @param #TASKINFO.Detail Detail The detail Level.
--- @param Wrapper.Group#GROUP ReportGroup
--- @param Tasking.Task#TASK Task
--- @return #TASKINFO self
-function TASKINFO:Report( Report, Detail, ReportGroup, Task )
-
-  local Line = 0
-  local LineReport = REPORT:New()
-
-  if not self.Task:IsStatePlanned() and not self.Task:IsStateAssigned() then
-    self.Info = self.PersistentInfo
-  end
-
-  for Key, Data in UTILS.spairs( self.Info.Set, function( t, a, b ) return t[a].Order < t[b].Order end ) do
-
-    self:F( { Key = Key, Detail = Detail, Data = Data } )
-    
-    if Data.Detail:find( Detail ) then
-      local Text = ""
-      if Key == "TaskName" then
-        Key = nil
-        Text = Data.Data
-      end
-      if Key == "Coordinate" then
-        local Coordinate = Data.Data -- Core.Point#COORDINATE
-        Text = Coordinate:ToString( ReportGroup:GetUnit(1), nil, Task )
-      end
-      if Key == "Threat" then
-        local DataText = Data.Data -- #string
-        Text = DataText
-      end
-      if Key == "Counting" then
-        local DataText = Data.Data -- #string
-        Text = DataText
-      end
-      if Key == "Targets" then
-        local DataText = Data.Data -- #string
-        Text = DataText
-      end
-      if Key == "QFE" then
-        local Coordinate = Data.Data -- Core.Point#COORDINATE
-        Text = Coordinate:ToStringPressure( ReportGroup:GetUnit(1), nil, Task )
-      end
-      if Key == "Temperature" then
-        local Coordinate = Data.Data -- Core.Point#COORDINATE
-        Text = Coordinate:ToStringTemperature( ReportGroup:GetUnit(1), nil, Task )
-      end
-      if Key == "Wind" then
-        local Coordinate = Data.Data -- Core.Point#COORDINATE
-        Text = Coordinate:ToStringWind( ReportGroup:GetUnit(1), nil, Task )
-      end
-      if Key == "Cargo" then
-        local DataText = Data.Data -- #string
-        Text = DataText
-      end
-      if Key == "Friendlies" then
-        local DataText = Data.Data -- #string
-        Text = DataText
-      end
-      if Key == "Players" then
-        local DataText = Data.Data -- #string
-        Text = DataText
-      end
-
-
-      if Line < math.floor( Data.Order / 10 ) then
-        if Line == 0 then
-          if Text ~= "" then
-            Report:AddIndent( LineReport:Text( ", " ), "-" )
-          end
-        else
-          if Text ~= "" then
-            Report:AddIndent( LineReport:Text( ", " ) )
-          end
-        end
-        LineReport = REPORT:New()
-        Line = math.floor( Data.Order / 10 )
-      end
-
-      if Text ~= "" then
-        LineReport:Add( ( Key and ( Key .. ":" ) or "" ) .. Text )
-      end
-    end
-  end
-  Report:AddIndent( LineReport:Text( ", " ) )
-
-end

Moose Development/Moose/Tasking/TaskZoneCapture.lua

@@ -1,261 +0,0 @@
---- **Tasking** - The TASK_Protect models tasks for players to protect or capture specific zones.
--- 
--- ===
--- 
--- ### Author: **FlightControl**
--- 
--- ### Contributions: MillerTime
--- 
--- ===
---   
--- @module Tasking.TaskZoneCapture
--- @image MOOSE.JPG
-
-do -- TASK_ZONE_GOAL
-
-  --- The TASK_ZONE_GOAL class
-  -- @type TASK_ZONE_GOAL
-  -- @field Core.ZoneGoal#ZONE_GOAL ZoneGoal
-  -- @extends Tasking.Task#TASK
-
-  --- # TASK_ZONE_GOAL class, extends @{Tasking.Task#TASK}
-  -- 
-  -- The TASK_ZONE_GOAL class defines the task to protect or capture a protection zone. 
-  -- The TASK_ZONE_GOAL is implemented using a @{Core.Fsm#FSM_TASK}, and has the following statuses:
-  -- 
-  --   * **None**: Start of the process
-  --   * **Planned**: The A2G task is planned.
-  --   * **Assigned**: The A2G task is assigned to a @{Wrapper.Group#GROUP}.
-  --   * **Success**: The A2G task is successfully completed.
-  --   * **Failed**: The A2G task has failed. This will happen if the player exists the task early, without communicating a possible cancellation to HQ.
-  -- 
-  -- ## Set the scoring of achievements in an A2G attack.
-  -- 
-  -- Scoring or penalties can be given in the following circumstances:
-  -- 
-  --   * @{#TASK_ZONE_GOAL.SetScoreOnDestroy}(): Set a score when a target in scope of the A2G attack, has been destroyed.
-  --   * @{#TASK_ZONE_GOAL.SetScoreOnSuccess}(): Set a score when all the targets in scope of the A2G attack, have been destroyed.
-  --   * @{#TASK_ZONE_GOAL.SetPenaltyOnFailed}(): Set a penalty when the A2G attack has failed.
-  -- 
-  -- @field #TASK_ZONE_GOAL
-  TASK_ZONE_GOAL = {
-    ClassName = "TASK_ZONE_GOAL",
-  }
-  
-  --- Instantiates a new TASK_ZONE_GOAL.
-  -- @param #TASK_ZONE_GOAL self
-  -- @param Tasking.Mission#MISSION Mission
-  -- @param Core.Set#SET_GROUP SetGroup The set of groups for which the Task can be assigned.
-  -- @param #string TaskName The name of the Task.
-  -- @param Core.ZoneGoal#ZONE_GOAL ZoneGoal
-  -- @return #TASK_ZONE_GOAL self
-  function TASK_ZONE_GOAL:New( Mission, SetGroup, TaskName, ZoneGoal, TaskType, TaskBriefing )
-    local self = BASE:Inherit( self, TASK:New( Mission, SetGroup, TaskName, TaskType, TaskBriefing ) ) -- #TASK_ZONE_GOAL
-    self:F()
-  
-    self.ZoneGoal = ZoneGoal
-    self.TaskType = TaskType
-    
-    local Fsm = self:GetUnitProcess()
-    
-
-    Fsm:AddProcess   ( "Planned", "Accept", ACT_ASSIGN_ACCEPT:New( self.TaskBriefing ), { Assigned = "StartMonitoring", Rejected = "Reject" }  )
-    
-    Fsm:AddTransition( "Assigned", "StartMonitoring", "Monitoring" )
-    Fsm:AddTransition( "Monitoring", "Monitor", "Monitoring", {} )
-    Fsm:AddTransition( "Monitoring", "RouteTo", "Monitoring" )
-    Fsm:AddProcess( "Monitoring", "RouteToZone", ACT_ROUTE_ZONE:New(), {} )
-    
-    --Fsm:AddTransition( "Accounted", "DestroyedAll", "Accounted" )
-    --Fsm:AddTransition( "Accounted", "Success", "Success" )
-    Fsm:AddTransition( "Rejected", "Reject", "Aborted" )
-    Fsm:AddTransition( "Failed", "Fail", "Failed" )
-    
-    self:SetTargetZone( self.ZoneGoal:GetZone() )
-    
-    --- Test 
-    -- @param #FSM_PROCESS self
-    -- @param Wrapper.Unit#UNIT TaskUnit
-    -- @param Tasking.Task#TASK_ZONE_GOAL Task
-    function Fsm:onafterStartMonitoring( TaskUnit, Task )
-      self:F( { self } )
-      self:__Monitor( 0.1 )
-      self:__RouteTo( 0.1 )
-    end
-    
-    --- Monitor Loop
-    -- @param #FSM_PROCESS self
-    -- @param Wrapper.Unit#UNIT TaskUnit
-    -- @param Tasking.Task#TASK_ZONE_GOAL Task
-    function Fsm:onafterMonitor( TaskUnit, Task )
-      self:F( { self } )
-      self:__Monitor( 15 )
-    end
-    
-    --- Test 
-    -- @param #FSM_PROCESS self
-    -- @param Wrapper.Unit#UNIT TaskUnit
-    -- @param Tasking.Task_A2G#TASK_ZONE_GOAL Task
-    function Fsm:onafterRouteTo( TaskUnit, Task )
-      self:F( { TaskUnit = TaskUnit, Task = Task and Task:GetClassNameAndID() } )
-      -- Determine the first Unit from the self.TargetSetUnit
-      
-      if Task:GetTargetZone( TaskUnit ) then
-        self:__RouteTo( 0.1 )
-      end
-    end
-
-    return self
- 
-  end
-
-  --- @param #TASK_ZONE_GOAL self
-  -- @param Core.ZoneGoal#ZONE_GOAL ZoneGoal The ZoneGoal Engine.
-  function TASK_ZONE_GOAL:SetProtect( ZoneGoal )
-  
-    self.ZoneGoal = ZoneGoal -- Core.ZoneGoal#ZONE_GOAL
-  end
-   
-
-  
-  --- @param #TASK_ZONE_GOAL self
-  function TASK_ZONE_GOAL:GetPlannedMenuText()
-    return self:GetStateString() .. " - " .. self:GetTaskName() .. " ( " .. self.ZoneGoal:GetZoneName() .. " )"
-  end
-
-  
-  --- @param #TASK_ZONE_GOAL self
-  -- @param Core.Zone#ZONE_BASE TargetZone The Zone object where the Target is located on the map.
-  -- @param Wrapper.Unit#UNIT TaskUnit
-  function TASK_ZONE_GOAL:SetTargetZone( TargetZone, TaskUnit )
-  
-    local ProcessUnit = self:GetUnitProcess( TaskUnit )
-
-    local ActRouteZone = ProcessUnit:GetProcess( "Monitoring", "RouteToZone" ) -- Actions.Act_Route#ACT_ROUTE_ZONE
-    ActRouteZone:SetZone( TargetZone )
-  end
-   
-
-  --- @param #TASK_ZONE_GOAL self
-  -- @param Wrapper.Unit#UNIT TaskUnit
-  -- @return Core.Zone#ZONE_BASE The Zone object where the Target is located on the map.
-  function TASK_ZONE_GOAL:GetTargetZone( TaskUnit )
-
-    local ProcessUnit = self:GetUnitProcess( TaskUnit )
-
-    local ActRouteZone = ProcessUnit:GetProcess( "Monitoring", "RouteToZone" ) -- Actions.Act_Route#ACT_ROUTE_ZONE
-    return ActRouteZone:GetZone()
-  end
-
-  function TASK_ZONE_GOAL:SetGoalTotal( GoalTotal )
-  
-    self.GoalTotal = GoalTotal
-  end
-
-  function TASK_ZONE_GOAL:GetGoalTotal()
-  
-    return self.GoalTotal
-  end
-
-end 
-
-
-do -- TASK_ZONE_CAPTURE
-
-  --- The TASK_ZONE_CAPTURE class
-  -- @type TASK_ZONE_CAPTURE
-  -- @field Core.ZoneGoalCoalition#ZONE_GOAL_COALITION ZoneGoal
-  -- @extends #TASK_ZONE_GOAL
-
-  --- # TASK_ZONE_CAPTURE class, extends @{Tasking.TaskZoneGoal#TASK_ZONE_GOAL}
-  -- 
-  -- The TASK_ZONE_CAPTURE class defines an Suppression or Extermination of Air Defenses task for a human player to be executed.
-  -- These tasks are important to be executed as they will help to achieve air superiority at the vicinity.
-  -- 
-  -- The TASK_ZONE_CAPTURE is used by the @{Tasking.Task_A2G_Dispatcher#TASK_A2G_DISPATCHER} to automatically create SEAD tasks 
-  -- based on detected enemy ground targets.
-  -- 
-  -- @field #TASK_ZONE_CAPTURE
-  TASK_ZONE_CAPTURE = {
-    ClassName = "TASK_ZONE_CAPTURE",
-  }
-  
-
-  --- Instantiates a new TASK_ZONE_CAPTURE.
-  -- @param #TASK_ZONE_CAPTURE self
-  -- @param Tasking.Mission#MISSION Mission
-  -- @param Core.Set#SET_GROUP SetGroup The set of groups for which the Task can be assigned.
-  -- @param #string TaskName The name of the Task.
-  -- @param Core.ZoneGoalCoalition#ZONE_GOAL_COALITION ZoneGoalCoalition
-  -- @param #string TaskBriefing The briefing of the task.
-  -- @return #TASK_ZONE_CAPTURE self
-  function TASK_ZONE_CAPTURE:New( Mission, SetGroup, TaskName, ZoneGoalCoalition, TaskBriefing)
-    local self = BASE:Inherit( self, TASK_ZONE_GOAL:New( Mission, SetGroup, TaskName, ZoneGoalCoalition, "CAPTURE", TaskBriefing ) ) -- #TASK_ZONE_CAPTURE
-    self:F()
-    
-    Mission:AddTask( self )
-    
-    self.TaskCoalition = ZoneGoalCoalition:GetCoalition()
-    self.TaskCoalitionName = ZoneGoalCoalition:GetCoalitionName()
-    self.TaskZoneName = ZoneGoalCoalition:GetZoneName()
-    
-    ZoneGoalCoalition:MonitorDestroyedUnits()
-    
-    self:SetBriefing( 
-      TaskBriefing or 
-      "Capture Zone " .. self.TaskZoneName
-    )
-    
-    self:UpdateTaskInfo()
-
-    return self
-  end 
-
-
-  --- Instantiates a new TASK_ZONE_CAPTURE.
-  -- @param #TASK_ZONE_CAPTURE self
-  function TASK_ZONE_CAPTURE:UpdateTaskInfo() 
-
-
-    local ZoneCoordinate = self.ZoneGoal:GetZone():GetCoordinate() 
-    self.TaskInfo:AddCoordinate( ZoneCoordinate, 0, "SOD" )
-    self.TaskInfo:AddText( "Zone Name", self.ZoneGoal:GetZoneName(), 10, "MOD" )
-    self.TaskInfo:AddText( "Zone Coalition", self.ZoneGoal:GetCoalitionName(), 11, "MOD" )
-  end
-    
-
-  function TASK_ZONE_CAPTURE:ReportOrder( ReportGroup ) 
-    local Coordinate = self:GetData( "Coordinate" )
-    --local Coordinate = self.TaskInfo.Coordinates.TaskInfoText
-    local Distance = ReportGroup:GetCoordinate():Get2DDistance( Coordinate )
-    
-    return Distance
-  end
-  
-  
-  --- @param #TASK_ZONE_CAPTURE self
-  -- @param Wrapper.Unit#UNIT TaskUnit
-  function TASK_ZONE_CAPTURE:OnAfterGoal( From, Event, To, PlayerUnit, PlayerName )
-  
-    self:F( { PlayerUnit = PlayerUnit } )
-    
-    if self.ZoneGoal then
-      if self.ZoneGoal.Goal:IsAchieved() then
-        self:Success()
-        local TotalContributions = self.ZoneGoal.Goal:GetTotalContributions()
-        local PlayerContributions = self.ZoneGoal.Goal:GetPlayerContributions()
-        self:F( { TotalContributions = TotalContributions, PlayerContributions = PlayerContributions } )
-        for PlayerName, PlayerContribution in pairs( PlayerContributions ) do
-           local Scoring = self:GetScoring()
-           if Scoring then
-             Scoring:_AddMissionGoalScore( self.Mission, PlayerName, "Zone " .. self.ZoneGoal:GetZoneName() .." captured", PlayerContribution * 200 / TotalContributions )
-           end
-        end
-      end
-    end
-    
-    self:__Goal( -10, PlayerUnit, PlayerName )
-  end
-
-end
-