#SPAWN

* Fix for InitCleanup()

.appveyor/appveyor.yml

@@ -26,24 +26,25 @@ init:
 #  - ps: iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/appveyor/ci/master/scripts/enable-rdp.ps1'))
  
 install:
+  - cmd:
 # 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 7zip.commandline
-#  - call choco install lua51
+      call choco install lua51
-#  - call choco install luarocks
+      call choco install luarocks
-#  - call refreshenv
+      call refreshenv
-#  - call "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat"
+      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: 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_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 
+      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 luasrcdiet
-#  - call luarocks install checks
+      call luarocks install checks
-#  - call luarocks install luadocumentor
+      call luarocks install luadocumentor
-#  - call luarocks install luacheck
+      call luarocks install luacheck
 
 
-#cache:
+cache:
-#  - C:\ProgramData\chocolatey\lib
+C:\ProgramData\chocolatey\lib
-#  - C:\ProgramData\chocolatey\bin
+C:\ProgramData\chocolatey\bin
   
 
 
@@ -51,8 +52,9 @@ build_script:
    - ps: | 
        if( $env:appveyor_repo_branch -eq 'master' -or $env:appveyor_repo_branch -eq 'develop' )     
        {
+         echo "Hello World!"
          $apiUrl = 'https://ci.appveyor.com/api'
-         $token = 'qts80b5kpq0ooj4x6vvw'
+         $token = 'v2.6hcv3ige78kg3yvg4ge8'
          $headers = @{
            "Authorization" = "Bearer $token"
            "Content-type" = "application/json"
@@ -65,7 +67,7 @@ build_script:
        if( $env:appveyor_repo_branch -eq 'master' -or $env:appveyor_repo_branch -eq 'develop' )     
        {
          $apiUrl = 'https://ci.appveyor.com/api'
-         $token = 'qts80b5kpq0ooj4x6vvw'
+         $token = 'v2.6hcv3ige78kg3yvg4ge8'
          $headers = @{
            "Authorization" = "Bearer $token"
            "Content-type" = "application/json"

.gitignore

@@ -18,6 +18,8 @@ local.properties
 # External tool builders
 .externalToolBuilders/
 
+# AppVeyor
+.appveyor/
 
 # CDT-specific
 .cproject

.luacheckrc

@@ -0,0 +1,54 @@
+ignore = {
+    "011", -- A syntax error.
+    "021", -- An invalid inline option.
+    "022", -- An unpaired inline push directive.
+    "023", -- An unpaired inline pop directive.
+    "111", -- Setting an undefined global variable.
+    "112", -- Mutating an undefined global variable.
+    "113", -- Accessing an undefined global variable.
+    "121", -- Setting a read-only global variable.
+    "122", -- Setting a read-only field of a global variable.
+    "131", -- Unused implicitly defined global variable.
+    "142", -- Setting an undefined field of a global variable.
+    "143", -- Accessing an undefined field of a global variable.
+    "211", -- Unused local variable.
+    "212", -- Unused argument.
+    "213", -- Unused loop variable.
+    "221", -- Local variable is accessed but never set.
+    "231", -- Local variable is set but never accessed.
+    "232", -- An argument is set but never accessed.
+    "233", -- Loop variable is set but never accessed.
+    "241", -- Local variable is mutated but never accessed.
+    "311", -- Value assigned to a local variable is unused.
+    "312", -- Value of an argument is unused.
+    "313", -- Value of a loop variable is unused.
+    "314", -- Value of a field in a table literal is unused.
+    "321", -- Accessing uninitialized local variable.
+    "331", -- Value assigned to a local variable is mutated but never accessed.
+    "341", -- Mutating uninitialized local variable.
+    "411", -- Redefining a local variable.
+    "412", -- Redefining an argument.
+    "413", -- Redefining a loop variable.
+    "421", -- Shadowing a local variable.
+    "422", -- Shadowing an argument.
+    "423", -- Shadowing a loop variable.
+    "431", -- Shadowing an upvalue.
+    "432", -- Shadowing an upvalue argument.
+    "433", -- Shadowing an upvalue loop variable.
+    "511", -- Unreachable code.
+    "512", -- Loop can be executed at most once.
+    "521", -- Unused label.
+    "531", -- Left-hand side of an assignment is too short.
+    "532", -- Left-hand side of an assignment is too long.
+    "541", -- An empty do end block.
+    "542", -- An empty if branch.
+    "551", -- An empty statement.
+    "561", -- Cyclomatic complexity of a function is too high.
+    "571", -- A numeric for loop goes from #(expr) down to 1 or less without negative step.
+    "611", -- A line consists of nothing but whitespace.
+    "612", -- A line contains trailing whitespace.
+    "613", -- Trailing whitespace in a string.
+    "614", -- Trailing whitespace in a comment.
+    "621", -- Inconsistent indentation (SPACE followed by TAB).
+    "631", -- Line is too long.
+}

.vs/VSWorkspaceState.json

@@ -0,0 +1,10 @@
+{
+  "ExpandedNodes": [
+    "",
+    "\\Moose Development",
+    "\\Moose Development\\Moose",
+    "\\Moose Development\\Moose\\Ops"
+  ],
+  "SelectedNode": "\\Moose Development\\Moose\\Ops\\Airboss.lua",
+  "PreviewInSolutionExplorer": false
+}

Moose Development/Moose/.lua-format

@@ -0,0 +1,33 @@
+# See https://github.com/Koihik/LuaFormatter
+# Use '-- LuaFormatter off' and '-- LuaFormatter on' around code blocks to inhibit formatting
+
+column_limit: 500
+indent_width: 2
+use_tab: false
+continuation_indent_width: 2
+keep_simple_control_block_one_line: false
+keep_simple_function_one_line: false
+align_args: true
+break_after_functioncall_lp: false
+break_before_functioncall_rp: false
+align_parameter: true
+chop_down_parameter: true
+break_after_functiondef_lp: false
+break_before_functiondef_rp: false
+align_table_field: true
+break_after_table_lb: true
+break_before_table_rb: true
+chop_down_table: true
+chop_down_kv_table: true
+column_table_limit: 500
+table_sep: ','
+extra_sep_at_table_end: true
+break_after_operator: true
+single_quote_to_double_quote: false
+double_quote_to_single_quote: false
+spaces_before_call: 1
+spaces_inside_functiondef_parens: true
+spaces_inside_functioncall_parens: true
+spaces_inside_table_braces: true
+spaces_around_equals_in_field: true
+line_breaks_after_function_body: 1

Moose Development/Moose/.vscode/settings.json

@@ -0,0 +1,17 @@
+{
+    "Lua.workspace.preloadFileSize": 1000,
+    "Lua.diagnostics.disable": [
+        "undefined-doc-name"
+    ],
+    "Lua.diagnostics.globals": [
+        "BASE",
+        "lfs",
+        "__Moose",
+        "trigger",
+        "coord",
+        "missionCommands"
+    ],
+    "Lua.completion.displayContext": 5,
+    "Lua.runtime.version": "Lua 5.1",
+    "Lua.completion.callSnippet": "Both"
+}

Moose Development/Moose/AI/AI_A2A_Cap.lua

@@ -40,8 +40,8 @@
 --
 -- ![Process](..\Presentations\AI_CAP\Dia10.JPG)
 --
--- Until a fuel or damage treshold has been reached by the AI, or when the AI is commanded to RTB.
+-- Until a fuel or damage threshold has been reached by the AI, or when the AI is commanded to RTB.
--- When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
+-- When the fuel threshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
 --
 -- ![Process](..\Presentations\AI_CAP\Dia13.JPG)
 --
@@ -71,7 +71,7 @@
 --   * **@{AI.AI_Patrol#AI_PATROL_ZONE.Detected}**: The AI has detected new targets.
 --   * **@{#AI_A2A_CAP.Destroy}**: The AI has destroyed a bogey @{Wrapper.Unit}.
 --   * **@{#AI_A2A_CAP.Destroyed}**: The AI has destroyed all bogeys @{Wrapper.Unit}s assigned in the CAS task.
---   * **Status** ( Group ): The AI is checking status (fuel and damage). When the tresholds have been reached, the AI will RTB.
+--   * **Status** ( Group ): The AI is checking status (fuel and damage). When the thresholds have been reached, the AI will RTB.
 --
 -- ## 3. Set the Range of Engagement
 --
@@ -143,7 +143,7 @@ end
 -- @return #AI_A2A_CAP
 function AI_A2A_CAP:New( AICap, PatrolZone, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolMinSpeed, PatrolMaxSpeed, EngageMinSpeed, EngageMaxSpeed, PatrolAltType )
 
-  return self:New2( AICap, EngageMinSpeed, EngageMaxSpeed, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolZone, PatrolMinSpeed, PatrolMaxSpeed, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolAltType, PatrolAltType )
+  return self:New2( AICap, EngageMinSpeed, EngageMaxSpeed, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolAltType, PatrolZone, PatrolMinSpeed, PatrolMaxSpeed, PatrolFloorAltitude, PatrolCeilingAltitude, PatrolAltType )
 
 end
 

Moose Development/Moose/AI/AI_A2A_Gci.lua

@@ -42,8 +42,8 @@
 --
 -- ![Process](..\Presentations\AI_GCI\Dia10.JPG)
 --
--- Until a fuel or damage treshold has been reached by the AI, or when the AI is commanded to RTB.
+-- Until a fuel or damage threshold has been reached by the AI, or when the AI is commanded to RTB.
--- When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
+-- When the fuel threshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
 --
 -- ![Process](..\Presentations\AI_GCI\Dia13.JPG)
 --
@@ -73,7 +73,7 @@
 --   * **@{AI.AI_Patrol#AI_PATROL_ZONE.Detected}**: The AI has detected new targets.
 --   * **@{#AI_A2A_GCI.Destroy}**: The AI has destroyed a bogey @{Wrapper.Unit}.
 --   * **@{#AI_A2A_GCI.Destroyed}**: The AI has destroyed all bogeys @{Wrapper.Unit}s assigned in the CAS task.
---   * **Status** ( Group ): The AI is checking status (fuel and damage). When the tresholds have been reached, the AI will RTB.
+--   * **Status** ( Group ): The AI is checking status (fuel and damage). When the thresholds have been reached, the AI will RTB.
 --
 -- ## 3. Set the Range of Engagement
 --

Moose Development/Moose/AI/AI_A2A_Patrol.lua

@@ -39,8 +39,8 @@
 -- 
 -- ![Process](..\Presentations\AI_PATROL\Dia10.JPG)
 -- 
--- Until a fuel or damage treshold has been reached by the AI, or when the AI is commanded to RTB.
+-- Until a fuel or damage threshold has been reached by the AI, or when the AI is commanded to RTB.
--- When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
+-- When the fuel threshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
 -- 
 -- ![Process](..\Presentations\AI_PATROL\Dia11.JPG)
 -- 
@@ -68,7 +68,7 @@
 --   * **RTB** ( Group ): Route the AI to the home base.
 --   * **Detect** ( Group ): The AI is detecting targets.
 --   * **Detected** ( Group ): The AI has detected new targets.
---   * **Status** ( Group ): The AI is checking status (fuel and damage). When the tresholds have been reached, the AI will RTB.
+--   * **Status** ( Group ): The AI is checking status (fuel and damage). When the thresholds have been reached, the AI will RTB.
 --    
 -- ## 3. Set or Get the AI controllable
 -- 
@@ -100,8 +100,8 @@
 -- ## 6. Manage the "out of fuel" in the AI_A2A_PATROL
 -- 
 -- When the AI is out of fuel, it is required that a new AI is started, before the old AI can return to the home base.
--- Therefore, with a parameter and a calculation of the distance to the home base, the fuel treshold is calculated.
+-- Therefore, with a parameter and a calculation of the distance to the home base, the fuel threshold is calculated.
--- When the fuel treshold is reached, the AI will continue for a given time its patrol task in orbit, 
+-- When the fuel threshold is reached, the AI will continue for a given time its patrol task in orbit, 
 -- while a new AI is targetted to the AI_A2A_PATROL.
 -- Once the time is finished, the old AI will return to the base.
 -- Use the method @{#AI_A2A_PATROL.ManageFuel}() to have this proces in place.
@@ -109,7 +109,7 @@
 -- ## 7. Manage "damage" behaviour of the AI in the AI_A2A_PATROL
 -- 
 -- When the AI is damaged, it is required that a new Patrol is started. However, damage cannon be foreseen early on. 
--- Therefore, when the damage treshold is reached, the AI will return immediately to the home base (RTB).
+-- Therefore, when the damage threshold is reached, the AI will return immediately to the home base (RTB).
 -- Use the method @{#AI_A2A_PATROL.ManageDamage}() to have this proces in place.
 -- 
 -- ===

Moose Development/Moose/AI/AI_A2G_SEAD.lua

@@ -42,8 +42,8 @@
 -- 
 -- ![Process](..\Presentations\AI_GCI\Dia10.JPG)
 -- 
--- Until a fuel or damage treshold has been reached by the AI, or when the AI is commanded to RTB.
+-- Until a fuel or damage threshold has been reached by the AI, or when the AI is commanded to RTB.
--- When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
+-- When the fuel threshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
 -- 
 -- ![Process](..\Presentations\AI_GCI\Dia13.JPG)
 -- 

Moose Development/Moose/AI/AI_Air.lua

@@ -253,6 +253,9 @@ function AI_AIR:New( AIGroup )
   
   self.IdleCount = 0
   
+  self.RTBSpeedMaxFactor = 0.6
+  self.RTBSpeedMinFactor = 0.5
+  
   return self
 end
 
@@ -370,11 +373,11 @@ end
 
 
 --- When the AI is out of fuel, it is required that a new AI is started, before the old AI can return to the home base.
--- Therefore, with a parameter and a calculation of the distance to the home base, the fuel treshold is calculated.
+-- Therefore, with a parameter and a calculation of the distance to the home base, the fuel threshold is calculated.
--- When the fuel treshold is reached, the AI will continue for a given time its patrol task in orbit, while a new AIControllable is targetted to the AI_AIR.
+-- When the fuel threshold is reached, the AI will continue for a given time its patrol task in orbit, while a new AIControllable is targetted to the AI_AIR.
 -- Once the time is finished, the old AI will return to the base.
 -- @param #AI_AIR self
--- @param #number FuelThresholdPercentage The treshold in percentage (between 0 and 1) when the AIControllable is considered to get out of fuel.
+-- @param #number FuelThresholdPercentage The threshold in percentage (between 0 and 1) when the AIControllable is considered to get out of fuel.
 -- @param #number OutOfFuelOrbitTime The amount of seconds the out of fuel AIControllable will orbit before returning to the base.
 -- @return #AI_AIR self
 function AI_AIR:SetFuelThreshold( FuelThresholdPercentage, OutOfFuelOrbitTime )
@@ -387,14 +390,14 @@ function AI_AIR:SetFuelThreshold( FuelThresholdPercentage, OutOfFuelOrbitTime )
   return self
 end
 
---- When the AI is damaged beyond a certain treshold, it is required that the AI returns to the home base.
+--- When the AI is damaged beyond a certain threshold, it is required that the AI returns to the home base.
 -- However, damage cannot be foreseen early on. 
--- Therefore, when the damage treshold is reached, 
+-- Therefore, when the damage threshold is reached, 
 -- the AI will return immediately to the home base (RTB).
 -- Note that for groups, the average damage of the complete group will be calculated.
--- So, in a group of 4 airplanes, 2 lost and 2 with damage 0.2, the damage treshold will be 0.25.
+-- So, in a group of 4 airplanes, 2 lost and 2 with damage 0.2, the damage threshold will be 0.25.
 -- @param #AI_AIR self
--- @param #number PatrolDamageThreshold The treshold in percentage (between 0 and 1) when the AI is considered to be damaged.
+-- @param #number PatrolDamageThreshold The threshold in percentage (between 0 and 1) when the AI is considered to be damaged.
 -- @return #AI_AIR self
 function AI_AIR:SetDamageThreshold( PatrolDamageThreshold )
 
@@ -476,7 +479,7 @@ function AI_AIR:onafterStatus()
       
       local Fuel = self.Controllable:GetFuelMin()
       
-      -- If the fuel in the controllable is below the treshold percentage,
+      -- If the fuel in the controllable is below the threshold percentage,
       -- then send for refuel in case of a tanker, otherwise RTB.
       if Fuel < self.FuelThresholdPercentage then
       
@@ -576,6 +579,19 @@ function AI_AIR.RTBHold( AIGroup, Fsm )
   
 end
 
+--- Set the min and max factors on RTB speed. Use this, if your planes are heading back to base too fast. Default values are 0.5 and 0.6. 
+-- The RTB speed is calculated as the max speed of the unit multiplied by MinFactor (lower bracket) and multiplied by MaxFactor (upper bracket). 
+-- A random value in this bracket is then applied in the waypoint routing generation.
+-- @param #AI_AIR self
+-- @param #number MinFactor Lower bracket factor. Defaults to 0.5.
+-- @param #number MaxFactor Upper bracket factor. Defaults to 0.6.
+-- @return #AI_AIR self
+function AI_AIR:SetRTBSpeedFactors(MinFactor,MaxFactor)
+  self.RTBSpeedMaxFactor = MaxFactor or 0.6
+  self.RTBSpeedMinFactor = MinFactor or 0.5
+  return self
+end
+
 
 --- @param #AI_AIR self
 -- @param Wrapper.Group#GROUP AIGroup
@@ -585,11 +601,13 @@ function AI_AIR:onafterRTB( AIGroup, From, Event, To )
   
   if AIGroup and AIGroup:IsAlive() then
 
-    self:I( "Group " .. AIGroup:GetName() .. " ... RTB! ( " .. self:GetState() .. " )" )
+    self:T( "Group " .. AIGroup:GetName() .. " ... RTB! ( " .. self:GetState() .. " )" )
     
     self:ClearTargetDistance()
     --AIGroup:ClearTasks()
     
+    AIGroup:OptionProhibitAfterburner(true)
+     
     local EngageRoute = {}
 
     --- Calculate the target route point.
@@ -597,12 +615,14 @@ function AI_AIR:onafterRTB( AIGroup, From, Event, To )
     local FromCoord = AIGroup:GetCoordinate()
     local ToTargetCoord = self.HomeAirbase:GetCoordinate() -- coordinate is on land height(!)
     local ToTargetVec3 = ToTargetCoord:GetVec3()
-    ToTargetVec3.y = ToTargetCoord:GetLandHeight()+1000 -- let's set this 1000m/3000 feet above ground
+    ToTargetVec3.y = ToTargetCoord:GetLandHeight()+3000 -- let's set this 1000m/3000 feet above ground
     local ToTargetCoord2 = COORDINATE:NewFromVec3( ToTargetVec3 )
      
     if not self.RTBMinSpeed or not self.RTBMaxSpeed then    
       local RTBSpeedMax = AIGroup:GetSpeedMax()
-      self:SetRTBSpeed( RTBSpeedMax * 0.5, RTBSpeedMax * 0.6 )  
+      local RTBSpeedMaxFactor = self.RTBSpeedMaxFactor or 0.6
+      local RTBSpeedMinFactor = self.RTBSpeedMinFactor or 0.5
+      self:SetRTBSpeed( RTBSpeedMax * RTBSpeedMinFactor, RTBSpeedMax * RTBSpeedMaxFactor)  
     end
     
     local RTBSpeed = math.random( self.RTBMinSpeed, self.RTBMaxSpeed )

Moose Development/Moose/AI/AI_Air_Dispatcher.lua

@@ -10,11 +10,11 @@
 --    * Setup (CAS) Controlled Air Support squadrons, to attack closeby enemy ground units near friendly installations.
 --    * Setup (BAI) Battleground Air Interdiction squadrons to attack remote enemy ground units and targets.
 --    * Define and use a detection network controlled by recce.
---    * Define AIR defense squadrons at airbases, farps and carriers.
+--    * Define AIR defense squadrons at airbases, FARPs and carriers.
 --    * Enable airbases for AIR defenses.
 --    * Add different planes and helicopter templates to squadrons.
 --    * Assign squadrons to execute a specific engagement type depending on threat level of the detected ground enemy unit composition.
---    * Add multiple squadrons to different airbases, farps or carriers.
+--    * Add multiple squadrons to different airbases, FARPs or carriers.
 --    * Define different ranges to engage upon.
 --    * Establish an automatic in air refuel process for planes using refuel tankers.
 --    * Setup default settings for all squadrons and AIR defenses.
@@ -40,7 +40,7 @@
 -- 
 -- AI_AIR_DISPATCHER is the main AIR defense class that models the AIR defense system.
 -- 
--- Before you start using the AI_AIR_DISPATCHER, ask youself the following questions.
+-- Before you start using the AI_AIR_DISPATCHER, ask yourself the following questions.
 -- 
 -- 
 -- ## 1. Which coalition am I modeling an AIR defense system for? blue or red?
@@ -128,7 +128,7 @@
 -- Depending on the defense type, different payloads will be needed. See further points on squadron definition.
 -- 
 -- 
--- ## 7. Where will the Squadrons be located? On Airbases? On Carrier Ships? On Farps?
+-- ## 7. Where will the Squadrons be located? On Airbases? On Carrier Ships? On FARPs?
 -- 
 -- Squadrons are placed at the **home base** on an **airfield**, **carrier** or **farp**.
 -- Carefully plan where each Squadron will be located as part of the defense system required for mission effective defenses.
@@ -354,7 +354,7 @@ do -- AI_AIR_DISPATCHER
   -- **DetectionSetGroup** is then calling `FilterStart()`, which is starting the dynamic filtering or inclusion of these groups. 
   -- Note that any destroy or new spawn of a group having a name, starting with the above prefix, will be removed or added to the set.
   -- 
-  -- Then a new detection object is created from the class `DETECTION_AREAS`. A grouping radius of 1000 meters (1km) is choosen.
+  -- Then a new detection object is created from the class `DETECTION_AREAS`. A grouping radius of 1000 meters (1km) is chosen.
   -- 
   -- The `Detection` object is then passed to the @{#AI_AIR_DISPATCHER.New}() method to indicate the reconnaissance network 
   -- configuration and setup the AIR defense detection mechanism.
@@ -647,7 +647,7 @@ do -- AI_AIR_DISPATCHER
   --   * @{#AI_AIR_DISPATCHER.SetSquadronLandingAtRunway}() will despawn the returning aircraft directly after landing at the runway.
   --   * @{#AI_AIR_DISPATCHER.SetSquadronLandingAtEngineShutdown}() will despawn the returning aircraft when the aircraft has returned to its parking spot and has turned off its engines.
   -- 
-  -- You can use these methods to minimize the airbase coodination overhead and to increase the airbase efficiency.
+  -- You can use these methods to minimize the airbase coordination overhead and to increase the airbase efficiency.
   -- When there are lots of aircraft returning for landing, at the same airbase, the takeoff process will be halted, which can cause a complete failure of the
   -- A2A defense system, as no new CAP or GCI planes can takeoff.
   -- Note that the method @{#AI_AIR_DISPATCHER.SetSquadronLandingNearAirbase}() will only work for returning aircraft, not for damaged or out of fuel aircraft.
@@ -724,13 +724,13 @@ do -- AI_AIR_DISPATCHER
   -- 
   -- Use the method @{#AI_AIR_DISPATCHER.SetSquadronEngageLimit}() to limit the amount of aircraft that will engage with the enemy, per squadron.
   --
-  -- ## 4. Set the **fuel treshold**.
+  -- ## 4. Set the **fuel threshold**.
   -- 
-  -- When aircraft get **out of fuel** to a certain %-tage, which is by default **15% (0.15)**, there are two possible actions that can be taken:
+  -- When aircraft get **out of fuel** to a certain %, which is by default **15% (0.15)**, there are two possible actions that can be taken:
   --  - The aircraft will go RTB, and will be replaced with a new aircraft if possible.
   --  - The aircraft will refuel at a tanker, if a tanker has been specified for the squadron.
   -- 
-  -- Use the method @{#AI_AIR_DISPATCHER.SetSquadronFuelThreshold}() to set the **squadron fuel treshold** of the aircraft for all squadrons.
+  -- Use the method @{#AI_AIR_DISPATCHER.SetSquadronFuelThreshold}() to set the **squadron fuel threshold** of the aircraft for all squadrons.
   -- 
   -- ## 6. Other configuration options
   -- 
@@ -786,17 +786,17 @@ do -- AI_AIR_DISPATCHER
   -- 
   -- Use the method @{#AI_AIR_DISPATCHER.SetDefaultGrouping}() to set the **default grouping** of spawned airplanes for all squadrons.
   -- 
-  -- ## 10.5. Default RTB fuel treshold.
+  -- ## 10.5. Default RTB fuel threshold.
   -- 
-  -- When an airplane gets **out of fuel** to a certain %-tage, which is **15% (0.15)**, it will go RTB, and will be replaced with a new airplane when applicable.
+  -- When an airplane gets **out of fuel** to a certain %, which is **15% (0.15)**, it will go RTB, and will be replaced with a new airplane when applicable.
   -- 
-  -- Use the method @{#AI_AIR_DISPATCHER.SetDefaultFuelThreshold}() to set the **default fuel treshold** of spawned airplanes for all squadrons.
+  -- Use the method @{#AI_AIR_DISPATCHER.SetDefaultFuelThreshold}() to set the **default fuel threshold** of spawned airplanes for all squadrons.
   -- 
-  -- ## 10.6. Default RTB damage treshold.
+  -- ## 10.6. Default RTB damage threshold.
   -- 
-  -- When an airplane is **damaged** to a certain %-tage, which is **40% (0.40)**, it will go RTB, and will be replaced with a new airplane when applicable.
+  -- When an airplane is **damaged** to a certain %, which is **40% (0.40)**, it will go RTB, and will be replaced with a new airplane when applicable.
   -- 
-  -- Use the method @{#AI_AIR_DISPATCHER.SetDefaultDamageThreshold}() to set the **default damage treshold** of spawned airplanes for all squadrons.
+  -- Use the method @{#AI_AIR_DISPATCHER.SetDefaultDamageThreshold}() to set the **default damage threshold** of spawned airplanes for all squadrons.
   -- 
   -- ## 10.7. Default settings for **patrol**.
   -- 
@@ -829,7 +829,7 @@ do -- AI_AIR_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_AIR_DISPATCHER.SetDefaultTanker}() to set the tanker for the dispatcher.
-  -- Use the method @{#AI_AIR_DISPATCHER.SetDefaultFuelThreshold}() to set the %-tage left in the defender airplane tanks when a refuel action is needed.
+  -- Use the method @{#AI_AIR_DISPATCHER.SetDefaultFuelThreshold}() to set the % 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.
   -- 
@@ -843,7 +843,7 @@ do -- AI_AIR_DISPATCHER
   --      A2ADispatcher:SetSquadronCapInterval("Sochi", 2, 30, 600, 1 ) 
   --      A2ADispatcher:SetSquadronGci( "Sochi", 900, 1200 )
   --      
-  --      -- Set the default tanker for refuelling to "Tanker", when the default fuel treshold has reached 90% fuel left.
+  --      -- Set the default tanker for refuelling to "Tanker", when the default fuel threshold has reached 90% fuel left.
   --      A2ADispatcher:SetDefaultFuelThreshold( 0.9 )
   --      A2ADispatcher:SetDefaultTanker( "Tanker" )
   --  
@@ -883,9 +883,6 @@ do -- AI_AIR_DISPATCHER
   -- However, the squadron will still stay alive. Any airplane that is airborne will continue its operations until all airborne airplanes
   -- of the squadron will be destroyed. This to keep consistency of air operations not to confuse the players.
   --
-  -- 
-  -- 
-  -- 
   -- @field #AI_AIR_DISPATCHER
   AI_AIR_DISPATCHER = {
     ClassName = "AI_AIR_DISPATCHER",
@@ -949,7 +946,6 @@ do -- AI_AIR_DISPATCHER
   --- @field #AI_AIR_DISPATCHER.DefenseQueue DefenseQueue
   AI_AIR_DISPATCHER.DefenseQueue = {}
 
-  
   --- Defense approach types
   -- @type #AI_AIR_DISPATCHER.DefenseApproach
   AI_AIR_DISPATCHER.DefenseApproach = {
@@ -958,26 +954,26 @@ do -- AI_AIR_DISPATCHER
   }
 
   --- AI_AIR_DISPATCHER constructor.
-  -- This is defining the AIR DISPATCHER for one coaliton.
+  -- This is defining the AIR DISPATCHER for one coalition.
   -- The Dispatcher works with a @{Functional.Detection#DETECTION_BASE} 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.
+  -- The Detection object is polymorphic, depending on the type of detection object chosen, the detection will work differently.
   -- @param #AI_AIR_DISPATCHER self
   -- @param Functional.Detection#DETECTION_BASE Detection The DETECTION object that will detects targets using the the Early Warning Radar network.
   -- @return #AI_AIR_DISPATCHER self
   -- @usage
   --
-  --   -- Setup the Detection, using DETECTION_AREAS.
+  --     -- Setup the Detection, using DETECTION_AREAS.
-  --   -- First define the SET of GROUPs that are defining the EWR network.
+  --     -- First define the SET of GROUPs that are defining the EWR network.
-  --   -- Here with prefixes DF CCCP AWACS, DF CCCP EWR.
+  --     -- Here with prefixes DF CCCP AWACS, DF CCCP EWR.
-  --   DetectionSetGroup = SET_GROUP:New()
+  --     DetectionSetGroup = SET_GROUP:New()
-  --   DetectionSetGroup:FilterPrefixes( { "DF CCCP AWACS", "DF CCCP EWR" } )
+  --     DetectionSetGroup:FilterPrefixes( { "DF CCCP AWACS", "DF CCCP EWR" } )
-  --   DetectionSetGroup:FilterStart()
+  --     DetectionSetGroup:FilterStart()
   --
-  --   -- Define the DETECTION_AREAS, using the DetectionSetGroup, with a 30km grouping radius.
+  --     -- Define the DETECTION_AREAS, using the DetectionSetGroup, with a 30km grouping radius.
-  --   Detection = DETECTION_AREAS:New( DetectionSetGroup, 30000 )
+  --     Detection = DETECTION_AREAS:New( DetectionSetGroup, 30000 )
   --
-  --   -- Now Setup the AIR dispatcher, and initialize it using the Detection object.
+  --     -- Now Setup the AIR dispatcher, and initialize it using the Detection object.
-  --   AIRDispatcher = AI_AIR_DISPATCHER:New( Detection )  --   
+  --     AIRDispatcher = AI_AIR_DISPATCHER:New( Detection )
   --
   function AI_AIR_DISPATCHER:New( Detection )
 
@@ -1435,17 +1431,17 @@ do -- AI_AIR_DISPATCHER
   end  
 
 
-  --- Set the default damage treshold when defenders will RTB.
+  --- Set the default damage threshold when defenders will RTB.
-  -- The default damage treshold is by default set to 40%, which means that when the airplane is 40% damaged, it will go RTB.
+  -- The default damage threshold is by default set to 40%, which means that when the airplane is 40% damaged, it will go RTB.
   -- @param #AI_AIR_DISPATCHER self
-  -- @param #number DamageThreshold A decimal number between 0 and 1, that expresses the %-tage of the damage treshold before going RTB.
+  -- @param #number DamageThreshold A decimal number between 0 and 1, that expresses the % of the damage threshold before going RTB.
   -- @return #AI_AIR_DISPATCHER
   -- @usage
   -- 
   --   -- Now Setup the AIR dispatcher, and initialize it using the Detection object.
   --   AIRDispatcher = AI_AIR_DISPATCHER:New( Detection )  
   --   
-  --   -- Now Setup the default damage treshold.
+  --   -- Now Setup the default damage threshold.
   --   AIRDispatcher:SetDefaultDamageThreshold( 0.90 ) -- Go RTB when the airplane 90% damaged.
   --   
   function AI_AIR_DISPATCHER:SetDefaultDamageThreshold( DamageThreshold )
@@ -1989,7 +1985,7 @@ do -- AI_AIR_DISPATCHER
 
   --- Defines the default amount of extra planes that will take-off as part of the defense system.
   -- @param #AI_AIR_DISPATCHER self
-  -- @param #number Overhead The %-tage of Units that dispatching command will allocate to intercept in surplus of detected amount of units.
+  -- @param #number Overhead The % of Units that dispatching command will allocate to intercept in surplus of detected amount of units.
   -- The default overhead is 1, so equal balance. The @{#AI_AIR_DISPATCHER.SetOverhead}() method can be used to tweak the defense strength,
   -- taking into account the plane types of the squadron. For example, a MIG-31 with full long-distance AIR missiles payload, may still be less effective than a F-15C with short missiles...
   -- So in this case, one may want to use the Overhead method to allocate more defending planes as the amount of detected attacking planes.
@@ -2028,7 +2024,7 @@ do -- AI_AIR_DISPATCHER
   --- Defines the amount of extra planes that will take-off as part of the defense system.
   -- @param #AI_AIR_DISPATCHER self
   -- @param #string SquadronName The name of the squadron.
-  -- @param #number Overhead The %-tage of Units that dispatching command will allocate to intercept in surplus of detected amount of units.
+  -- @param #number Overhead The % of Units that dispatching command will allocate to intercept in surplus of detected amount of units.
   -- The default overhead is 1, so equal balance. The @{#AI_AIR_DISPATCHER.SetOverhead}() method can be used to tweak the defense strength,
   -- taking into account the plane types of the squadron. For example, a MIG-31 with full long-distance AIR missiles payload, may still be less effective than a F-15C with short missiles...
   -- So in this case, one may want to use the Overhead method to allocate more defending planes as the amount of detected attacking planes.
@@ -2068,7 +2064,7 @@ do -- AI_AIR_DISPATCHER
   --- Gets the overhead of planes as part of the defense system, in comparison with the attackers.
   -- @param #AI_AIR_DISPATCHER self
   -- @param #string SquadronName The name of the squadron.
-  -- @return #number The %-tage of Units that dispatching command will allocate to intercept in surplus of detected amount of units.
+  -- @return #number The % of Units that dispatching command will allocate to intercept in surplus of detected amount of units.
   -- The default overhead is 1, so equal balance. The @{#AI_AIR_DISPATCHER.SetOverhead}() method can be used to tweak the defense strength,
   -- taking into account the plane types of the squadron. For example, a MIG-31 with full long-distance AIR missiles payload, may still be less effective than a F-15C with short missiles...
   -- So in this case, one may want to use the Overhead method to allocate more defending planes as the amount of detected attacking planes.
@@ -2674,17 +2670,17 @@ do -- AI_AIR_DISPATCHER
     return self
   end
   
-  --- Set the default fuel treshold when defenders will RTB or Refuel in the air.
+  --- Set the default fuel threshold when defenders will RTB or Refuel in the air.
-  -- The fuel treshold is by default set to 15%, which means that an airplane will stay in the air until 15% of its fuel has been consumed.
+  -- The fuel threshold is by default set to 15%, which means that an airplane will stay in the air until 15% of its fuel has been consumed.
   -- @param #AI_AIR_DISPATCHER self
-  -- @param #number FuelThreshold A decimal number between 0 and 1, that expresses the %-tage of the treshold of fuel remaining in the tank when the plane will go RTB or Refuel.
+  -- @param #number FuelThreshold A decimal number between 0 and 1, that expresses the % of the threshold of fuel remaining in the tank when the plane will go RTB or Refuel.
   -- @return #AI_AIR_DISPATCHER
   -- @usage
   -- 
   --   -- Now Setup the AIR dispatcher, and initialize it using the Detection object.
   --   AIRDispatcher = AI_AIR_DISPATCHER:New( Detection )  
   --   
-  --   -- Now Setup the default fuel treshold.
+  --   -- Now Setup the default fuel threshold.
   --   AIRDispatcher:SetDefaultFuelThreshold( 0.30 ) -- Go RTB when only 30% of fuel remaining in the tank.
   --   
   function AI_AIR_DISPATCHER:SetDefaultFuelThreshold( FuelThreshold )
@@ -2695,18 +2691,18 @@ do -- AI_AIR_DISPATCHER
   end  
 
 
-  --- Set the fuel treshold for the squadron when defenders will RTB or Refuel in the air.
+  --- Set the fuel threshold for the squadron when defenders will RTB or Refuel in the air.
-  -- The fuel treshold is by default set to 15%, which means that an airplane will stay in the air until 15% of its fuel has been consumed.
+  -- The fuel threshold is by default set to 15%, which means that an airplane will stay in the air until 15% of its fuel has been consumed.
   -- @param #AI_AIR_DISPATCHER self
   -- @param #string SquadronName The name of the squadron.
-  -- @param #number FuelThreshold A decimal number between 0 and 1, that expresses the %-tage of the treshold of fuel remaining in the tank when the plane will go RTB or Refuel.
+  -- @param #number FuelThreshold A decimal number between 0 and 1, that expresses the % of the threshold of fuel remaining in the tank when the plane will go RTB or Refuel.
   -- @return #AI_AIR_DISPATCHER
   -- @usage
   -- 
   --   -- Now Setup the AIR dispatcher, and initialize it using the Detection object.
   --   AIRDispatcher = AI_AIR_DISPATCHER:New( Detection )  
   --   
-  --   -- Now Setup the default fuel treshold.
+  --   -- Now Setup the default fuel threshold.
   --   AIRDispatcher:SetSquadronRefuelThreshold( "SquadronName", 0.30 ) -- Go RTB when only 30% of fuel remaining in the tank.
   --   
   function AI_AIR_DISPATCHER:SetSquadronFuelThreshold( SquadronName, FuelThreshold )
@@ -2726,7 +2722,7 @@ do -- AI_AIR_DISPATCHER
   --   -- Now Setup the AIR dispatcher, and initialize it using the Detection object.
   --   AIRDispatcher = AI_AIR_DISPATCHER:New( Detection )  
   --   
-  --   -- Now Setup the default fuel treshold.
+  --   -- Now Setup the default fuel threshold.
   --   AIRDispatcher:SetDefaultFuelThreshold( 0.30 ) -- Go RTB when only 30% of fuel remaining in the tank.
   --   
   --   -- Now Setup the default tanker.
@@ -2749,7 +2745,7 @@ do -- AI_AIR_DISPATCHER
   --   -- Now Setup the AIR dispatcher, and initialize it using the Detection object.
   --   AIRDispatcher = AI_AIR_DISPATCHER:New( Detection )  
   --   
-  --   -- Now Setup the squadron fuel treshold.
+  --   -- Now Setup the squadron fuel threshold.
   --   AIRDispatcher:SetSquadronRefuelThreshold( "SquadronName", 0.30 ) -- Go RTB when only 30% of fuel remaining in the tank.
   --   
   --   -- Now Setup the squadron tanker.
@@ -2847,7 +2843,7 @@ do -- AI_AIR_DISPATCHER
   -- @param #AI_AIR_DISPATCHER self
   function AI_AIR_DISPATCHER:CountDefendersEngaged( AttackerDetection, AttackerCount )
 
-    -- First, count the active AIGroups Units, targetting the DetectedSet
+    -- First, count the active AIGroups Units, targeting the DetectedSet
     local DefendersEngaged = 0
     local DefendersTotal = 0
     

Moose Development/Moose/AI/AI_Air_Engage.lua

@@ -42,8 +42,8 @@
 -- 
 -- ![Process](..\Presentations\AI_GCI\Dia10.JPG)
 -- 
--- Until a fuel or damage treshold has been reached by the AI, or when the AI is commanded to RTB.
+-- Until a fuel or damage threshold has been reached by the AI, or when the AI is commanded to RTB.
--- When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
+-- When the fuel threshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
 -- 
 -- ![Process](..\Presentations\AI_GCI\Dia13.JPG)
 -- 
@@ -533,6 +533,10 @@ function AI_AIR_ENGAGE:onafterEngage( DefenderGroup, From, Event, To, AttackSetU
       DefenderCoord:SetY( EngageAltitude ) -- Ground targets don't have an altitude.
 
       local TargetCoord = AttackSetUnit:GetFirst():GetPointVec3()
+      if not TargetCoord then
+          self:Return()
+          return
+      end
       TargetCoord:SetY( EngageAltitude ) -- Ground targets don't have an altitude.
       
       local TargetDistance = DefenderCoord:Get2DDistance( TargetCoord )

Moose Development/Moose/AI/AI_Air_Patrol.lua

@@ -39,8 +39,8 @@
 -- 
 -- ![Process](..\Presentations\AI_CAP\Dia10.JPG)
 -- 
--- Until a fuel or damage treshold has been reached by the AI, or when the AI is commanded to RTB.
+-- Until a fuel or damage threshold has been reached by the AI, or when the AI is commanded to RTB.
--- When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
+-- When the fuel threshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
 -- 
 -- ![Process](..\Presentations\AI_CAP\Dia13.JPG)
 -- 
@@ -70,7 +70,7 @@
 --   * **@{AI.AI_Patrol#AI_PATROL_ZONE.Detected}**: The AI has detected new targets.
 --   * **@{#AI_AIR_PATROL.Destroy}**: The AI has destroyed a bogey @{Wrapper.Unit}.
 --   * **@{#AI_AIR_PATROL.Destroyed}**: The AI has destroyed all bogeys @{Wrapper.Unit}s assigned in the CAS task.
---   * **Status** ( Group ): The AI is checking status (fuel and damage). When the tresholds have been reached, the AI will RTB.
+--   * **Status** ( Group ): The AI is checking status (fuel and damage). When the thresholds have been reached, the AI will RTB.
 --
 -- ## 3. Set the Range of Engagement
 -- 

Moose Development/Moose/AI/AI_BAI.lua

@@ -49,7 +49,7 @@
 -- Upon started, The AI will **Route** itself towards the random 3D point within a patrol zone, 
 -- using a random speed within the given altitude and speed limits.
 -- Upon arrival at the 3D point, a new random 3D point will be selected within the patrol zone using the given limits.
--- This cycle will continue until a fuel or damage treshold has been reached by the AI, or when the AI is commanded to RTB.
+-- This cycle will continue until a fuel or damage threshold has been reached by the AI, or when the AI is commanded to RTB.
 -- 
 -- ![Route Event](..\Presentations\AI_BAI\Dia5.JPG)
 -- 
@@ -87,7 +87,7 @@
 -- It will keep patrolling there, until it is notified to RTB or move to another BOMB Zone.
 -- It can be notified to go RTB through the **RTB** event.
 -- 
--- When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
+-- When the fuel threshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
 -- 
 -- ![Engage Event](..\Presentations\AI_BAI\Dia12.JPG)
 --
@@ -117,7 +117,7 @@
 --   * **@{AI.AI_Patrol#AI_PATROL_ZONE.Detected}**: The AI has detected new targets.
 --   * **@{#AI_BAI_ZONE.Destroy}**: The AI has destroyed a target @{Wrapper.Unit}.
 --   * **@{#AI_BAI_ZONE.Destroyed}**: The AI has destroyed all target @{Wrapper.Unit}s assigned in the BOMB task.
---   * **Status**: The AI is checking status (fuel and damage). When the tresholds have been reached, the AI will RTB.
+--   * **Status**: The AI is checking status (fuel and damage). When the thresholds have been reached, the AI will RTB.
 -- 
 -- ## 3. Modify the Engage Zone behaviour to pinpoint a **map object** or **scenery object**
 -- 
@@ -515,8 +515,8 @@ function AI_BAI_ZONE:onafterEngage( Controllable, From, Event, To,
     --- Calculate the current route point.
     local CurrentVec2 = self.Controllable:GetVec2()
     
-    --TODO: Create GetAltitude function for GROUP, and delete GetUnit(1).
+    --DONE: Create GetAltitude function for GROUP, and delete GetUnit(1).
-    local CurrentAltitude = self.Controllable:GetUnit(1):GetAltitude()
+    local CurrentAltitude = self.Controllable:GetAltitude()
     local CurrentPointVec3 = POINT_VEC3:New( CurrentVec2.x, CurrentAltitude, CurrentVec2.y )
     local ToEngageZoneSpeed = self.PatrolMaxSpeed
     local CurrentRoutePoint = CurrentPointVec3:WaypointAir( 
@@ -602,7 +602,7 @@ function AI_BAI_ZONE:onafterEngage( Controllable, From, Event, To,
 
     self:SetRefreshTimeInterval( 2 )
     self:SetDetectionActivated()
-    self:__Target( -2 ) -- Start Targetting
+    self:__Target( -2 ) -- Start targeting
   end
 end
 

Moose Development/Moose/AI/AI_Balancer.lua

@@ -9,7 +9,7 @@
 -- 
 -- ===
 -- 
--- ### [Demo Missions](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/AIB%20-%20AI%20Balancing)
 -- 
 -- ===
 -- 

Moose Development/Moose/AI/AI_CAP.lua

@@ -4,13 +4,13 @@
 -- 
 --   * Patrol AI airplanes within a given zone.
 --   * Trigger detected events when enemy airplanes are detected.
---   * Manage a fuel treshold to RTB on time.
+--   * Manage a fuel threshold to RTB on time.
 --   * Engage the enemy when detected.
 -- 
 --
 -- ===
 -- 
--- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/CAP%20-%20Combat%20Air%20Patrol)
+-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/CAP%20-%20Combat%20Air%20Patrol)
 -- 
 -- ===
 -- 
@@ -65,8 +65,8 @@
 -- 
 -- ![Process](..\Presentations\AI_CAP\Dia10.JPG)
 -- 
--- Until a fuel or damage treshold has been reached by the AI, or when the AI is commanded to RTB.
+-- Until a fuel or damage threshold has been reached by the AI, or when the AI is commanded to RTB.
--- When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
+-- When the fuel threshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
 -- 
 -- ![Process](..\Presentations\AI_CAP\Dia13.JPG)
 -- 
@@ -96,7 +96,7 @@
 --   * **@{AI.AI_Patrol#AI_PATROL_ZONE.Detected}**: The AI has detected new targets.
 --   * **@{#AI_CAP_ZONE.Destroy}**: The AI has destroyed a bogey @{Wrapper.Unit}.
 --   * **@{#AI_CAP_ZONE.Destroyed}**: The AI has destroyed all bogeys @{Wrapper.Unit}s assigned in the CAS task.
---   * **Status** ( Group ): The AI is checking status (fuel and damage). When the tresholds have been reached, the AI will RTB.
+--   * **Status** ( Group ): The AI is checking status (fuel and damage). When the thresholds have been reached, the AI will RTB.
 --
 -- ## 3. Set the Range of Engagement
 -- 
@@ -428,8 +428,10 @@ function AI_CAP_ZONE:onafterEngage( Controllable, From, Event, To )
     --- Calculate the current route point.
     local CurrentVec2 = self.Controllable:GetVec2()
     
-    --TODO: Create GetAltitude function for GROUP, and delete GetUnit(1).
+    if not CurrentVec2 then return self end
-    local CurrentAltitude = self.Controllable:GetUnit(1):GetAltitude()
+    
+    --DONE: Create GetAltitude function for GROUP, and delete GetUnit(1).
+    local CurrentAltitude = self.Controllable:GetAltitude()
     local CurrentPointVec3 = POINT_VEC3:New( CurrentVec2.x, CurrentAltitude, CurrentVec2.y )
     local ToEngageZoneSpeed = self.PatrolMaxSpeed
     local CurrentRoutePoint = CurrentPointVec3:WaypointAir( 

Moose Development/Moose/AI/AI_CAS.lua

@@ -11,7 +11,7 @@
 --
 -- ===
 -- 
--- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/CAS%20-%20Close%20Air%20Support)
+-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/CAS%20-%20Close%20Air%20Support)
 -- 
 -- ===
 -- 
@@ -49,7 +49,7 @@
 -- Upon started, The AI will **Route** itself towards the random 3D point within a patrol zone, 
 -- using a random speed within the given altitude and speed limits.
 -- Upon arrival at the 3D point, a new random 3D point will be selected within the patrol zone using the given limits.
--- This cycle will continue until a fuel or damage treshold has been reached by the AI, or when the AI is commanded to RTB.
+-- This cycle will continue until a fuel or damage threshold has been reached by the AI, or when the AI is commanded to RTB.
 -- 
 -- ![Route Event](..\Presentations\AI_CAS\Dia5.JPG)
 -- 
@@ -87,7 +87,7 @@
 -- It will keep patrolling there, until it is notified to RTB or move to another CAS Zone.
 -- It can be notified to go RTB through the **RTB** event.
 -- 
--- When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
+-- When the fuel threshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
 -- 
 -- ![Engage Event](..\Presentations\AI_CAS\Dia12.JPG)
 --
@@ -117,7 +117,7 @@
 --   * **@{AI.AI_Patrol#AI_PATROL_ZONE.Detected}**: The AI has detected new targets.
 --   * **@{#AI_CAS_ZONE.Destroy}**: The AI has destroyed a target @{Wrapper.Unit}.
 --   * **@{#AI_CAS_ZONE.Destroyed}**: The AI has destroyed all target @{Wrapper.Unit}s assigned in the CAS task.
---   * **Status**: The AI is checking status (fuel and damage). When the tresholds have been reached, the AI will RTB.
+--   * **Status**: The AI is checking status (fuel and damage). When the thresholds have been reached, the AI will RTB.
 -- 
 -- ===
 -- 
@@ -459,8 +459,8 @@ function AI_CAS_ZONE:onafterEngage( Controllable, From, Event, To,
     --- Calculate the current route point.
     local CurrentVec2 = self.Controllable:GetVec2()
     
-    --TODO: Create GetAltitude function for GROUP, and delete GetUnit(1).
+    --DONE: Create GetAltitude function for GROUP, and delete GetUnit(1).
-    local CurrentAltitude = self.Controllable:GetUnit(1):GetAltitude()
+    local CurrentAltitude = self.Controllable:GetAltitude()
     local CurrentPointVec3 = POINT_VEC3:New( CurrentVec2.x, CurrentAltitude, CurrentVec2.y )
     local ToEngageZoneSpeed = self.PatrolMaxSpeed
     local CurrentRoutePoint = CurrentPointVec3:WaypointAir( 
@@ -520,7 +520,7 @@ function AI_CAS_ZONE:onafterEngage( Controllable, From, Event, To,
     
     self:SetRefreshTimeInterval( 2 )
     self:SetDetectionActivated()
-    self:__Target( -2 ) -- Start Targetting
+    self:__Target( -2 ) -- Start targeting
   end
 end
 

Moose Development/Moose/AI/AI_Cargo.lua

@@ -47,19 +47,21 @@ function AI_CARGO:New( Carrier, CargoSet )
 
   self:SetStartState( "Unloaded" )
   
-  self:AddTransition( "Unloaded", "Pickup", "*" )
+  -- Board
-  self:AddTransition( "Loaded", "Deploy", "*" )
+  self:AddTransition( "Unloaded",     "Pickup",     "Unloaded" )
+  self:AddTransition( "*",            "Load",       "*" )
+  self:AddTransition( "*",            "Reload",       "*" )
+  self:AddTransition( "*",            "Board",      "*" )
+  self:AddTransition( "*",            "Loaded",     "Loaded" )
+  self:AddTransition( "Loaded",       "PickedUp",   "Loaded" )
   
-  self:AddTransition( "*", "Load", "Boarding" )
+  -- Unload
-  self:AddTransition( "Boarding", "Board", "Boarding" )
+  self:AddTransition( "Loaded",       "Deploy",     "*" )
-  self:AddTransition( "Loaded", "Board", "Loaded" )
+  self:AddTransition( "*",            "Unload",     "*" )
-  self:AddTransition( "Boarding", "Loaded", "Boarding" )
+  self:AddTransition( "*",            "Unboard",    "*" )
-  self:AddTransition( "Boarding", "PickedUp", "Loaded" )
+  self:AddTransition( "*",            "Unloaded",   "Unloaded" )
+  self:AddTransition( "Unloaded",     "Deployed",   "Unloaded" )
 
-  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
@@ -393,7 +395,7 @@ end
 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() and From == "Boarding" then
+  if Carrier and Carrier:IsAlive() then
     self:F({ IsLoaded = Cargo:IsLoaded(), Cargo:GetName(), Carrier:GetName() } )
     if not Cargo:IsLoaded() and not Cargo:IsDestroyed() then
       self:__Board( -10, Cargo, CarrierUnit, PickupZone )
@@ -509,7 +511,7 @@ end
 function AI_CARGO:onafterUnboard( Carrier, From, Event, To, Cargo, CarrierUnit, DeployZone, Defend )
   self:F( { Carrier, From, Event, To, Cargo:GetName(), DeployZone = DeployZone, Defend = Defend } )
 
-  if Carrier and Carrier:IsAlive() and From == "Unboarding" then
+  if Carrier and Carrier:IsAlive() then
     if not Cargo:IsUnLoaded() then
       self:__Unboard( 10, Cargo, CarrierUnit, DeployZone, Defend ) 
       return
@@ -580,4 +582,3 @@ function AI_CARGO:onafterDeployed( Carrier, From, Event, To, DeployZone, Defend
   end
 
 end
-

Moose Development/Moose/AI/AI_Cargo_APC.lua

@@ -98,7 +98,8 @@ function AI_CARGO_APC:New( APC, CargoSet, CombatRadius )
   self:AddTransition( "*", "Guard", "Unloaded" )
   self:AddTransition( "*", "Home", "*" )
   self:AddTransition( "*", "Reload", "Boarding" )
-  
+  self:AddTransition( "*", "Deployed", "*" )
+  self:AddTransition( "*", "PickedUp", "*" )
   self:AddTransition( "*", "Destroyed", "Destroyed" )
 
   self:SetCombatRadius( CombatRadius )

Moose Development/Moose/AI/AI_Cargo_Dispatcher_Helicopter.lua

@@ -174,8 +174,8 @@ function AI_CARGO_DISPATCHER_HELICOPTER:New( HelicopterSet, CargoSet, PickupZone
   self:SetPickupSpeed( 350, 150 )
   self:SetDeploySpeed( 350, 150 )
 
-  self:SetPickupRadius( 0, 0 )
+  self:SetPickupRadius( 40, 12 )
-  self:SetDeployRadius( 0, 0 )
+  self:SetDeployRadius( 40, 12 )
   
   self:SetPickupHeight( 500, 200 )
   self:SetDeployHeight( 500, 200 )
@@ -186,6 +186,9 @@ end
 
 function AI_CARGO_DISPATCHER_HELICOPTER:AICargo( Helicopter, CargoSet )
 
-  return AI_CARGO_HELICOPTER:New( Helicopter, CargoSet )
+  local dispatcher = AI_CARGO_HELICOPTER:New( Helicopter, CargoSet )
+  dispatcher:SetLandingSpeedAndHeight(27, 6)
+  return dispatcher
+  
 end
 

Moose Development/Moose/AI/AI_Cargo_Dispatcher_Ship.lua

@@ -21,7 +21,7 @@
 -- ===
 --
 -- @module AI.AI_Cargo_Dispatcher_Ship
--- @image AI_Cargo_Dispatching_For_Ship.JPG
+-- @image AI_Cargo_Dispatcher.JPG
 
 --- @type AI_CARGO_DISPATCHER_SHIP
 -- @extends AI.AI_Cargo_Dispatcher#AI_CARGO_DISPATCHER

Moose Development/Moose/AI/AI_Cargo_Helicopter.lua

@@ -33,7 +33,7 @@
 -- 
 -- ## Infantry health.
 -- 
--- When infantry is unboarded from the APCs, the infantry is actually respawned into the battlefield. 
+-- When infantry is unboarded from the helicopters, the infantry is actually respawned into the battlefield. 
 -- As a result, the unboarding infantry is very _healthy_ every time it unboards.
 -- This is due to the limitation of the DCS simulator, which is not able to specify the health of new spawned units as a parameter.
 -- However, infantry that was destroyed when unboarded, won't be respawned again. Destroyed is destroyed.
@@ -64,33 +64,25 @@ function AI_CARGO_HELICOPTER:New( Helicopter, CargoSet )
   self.Zone = ZONE_GROUP:New( Helicopter:GetName(), Helicopter, 300 )
 
   self:SetStartState( "Unloaded" ) 
+  -- Boarding
+  self:AddTransition( "Unloaded",     "Pickup",     "Unloaded" )
+  self:AddTransition( "*",            "Landed",     "*" )
+  self:AddTransition( "*",            "Load",       "*" )
+  self:AddTransition( "*",            "Loaded",     "Loaded" )
+  self:AddTransition( "Loaded",       "PickedUp",   "Loaded" )
   
-  self:AddTransition( "Unloaded", "Pickup", "*" )
+  -- Unboarding
-  self:AddTransition( "Loaded", "Deploy", "*" )
+  self:AddTransition( "Loaded",       "Deploy",     "*" )
-  --[[
+  self:AddTransition( "*",            "Queue",      "*" )
-  self:AddTransition( { "Unloaded", "Loading" }, "Load", "Boarding" )
+  self:AddTransition( "*",            "Orbit" ,     "*" )
-  self:AddTransition( "Boarding", "Board", "Boarding" )
+  self:AddTransition( "*",            "Destroyed",  "*" )
-  self:AddTransition( "Boarding", "Loaded", "Loaded" )
+  self:AddTransition( "*",            "Unload",     "*" )    
-  self:AddTransition( "Boarding", "PickedUp", "Loaded" )
+  self:AddTransition( "*",            "Unloaded",   "Unloaded" )
-  self:AddTransition( "Boarding", "Deploy", "Loaded" )
+  self:AddTransition( "Unloaded",     "Deployed",   "Unloaded" )
-  self:AddTransition( "Loaded", "Unload", "Unboarding" )
+  
-  self:AddTransition( "Unboarding", "Unboard", "Unboarding" )
+  -- RTB
-  self:AddTransition( "Unboarding", "Unloaded", "Unboarding" )
-  self:AddTransition( "Unboarding", "Deployed", "Unloaded" )
-  self:AddTransition( "Unboarding", "Pickup", "Unloaded" )
-  --]]
-  self:AddTransition( "*", "Loaded", "Loaded" )
-  self:AddTransition( "Unboarding", "Pickup", "Unloaded" )  
-  self:AddTransition( "Unloaded", "Unboard", "Unloaded" )  
-  self:AddTransition( "Unloaded", "Unloaded", "Unloaded" )
-  self:AddTransition( "*", "PickedUp", "*" )
-  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
@@ -107,13 +99,31 @@ function AI_CARGO_HELICOPTER:New( Helicopter, CargoSet )
   -- @param #string Event
   -- @param #string To
   -- @param Core.Point#COORDINATE Coordinate
-  -- @param #number Speed Speed in km/h to drive to the pickup coordinate. Default is 50% of max possible speed the unit can go.
+  -- @param #number Speed Speed in km/h to fly to the pickup coordinate. Default is 50% of max possible speed the unit can go.
+  
+    --- PickedUp Handler OnAfter for AI_CARGO_HELICOPTER - Cargo set has been picked up, ready to deploy
+  -- @function [parent=#AI_CARGO_HELICOPTER] OnAfterPickedUp
+  -- @param #AI_CARGO_HELICOPTER self
+  -- @param Wrapper.Group#GROUP Helicopter The helicopter #GROUP object
+  -- @param #string From
+  -- @param #string Event
+  -- @param #string To
+  -- @param Wrapper.Unit#UNIT Unit The helicopter #UNIT object
+
+    --- Unloaded Handler OnAfter for AI_CARGO_HELICOPTER - Cargo unloaded, carrier is empty
+  -- @function [parent=#AI_CARGO_HELICOPTER] OnAfterUnloaded
+  -- @param #AI_CARGO_HELICOPTER self
+  -- @param #string From
+  -- @param #string Event
+  -- @param #string To
+  -- @param Cargo.CargoGroup#CARGO_GROUP Cargo The #CARGO_GROUP object.
+  -- @param Wrapper.Unit#UNIT Unit The helicopter #UNIT object
   
   --- Pickup Trigger for AI_CARGO_HELICOPTER
   -- @function [parent=#AI_CARGO_HELICOPTER] Pickup
   -- @param #AI_CARGO_HELICOPTER self
   -- @param Core.Point#COORDINATE Coordinate
-  -- @param #number Speed Speed in km/h to drive to the pickup coordinate. Default is 50% of max possible speed the unit can go.
+  -- @param #number Speed Speed in km/h to fly to the pickup coordinate. Default is 50% of max possible speed the unit can go.
   
   --- Pickup Asynchronous Trigger for AI_CARGO_HELICOPTER
   -- @function [parent=#AI_CARGO_HELICOPTER] __Pickup
@@ -129,7 +139,7 @@ function AI_CARGO_HELICOPTER:New( Helicopter, CargoSet )
   -- @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.
+  -- @param #number Speed Speed in km/h to fly to the pickup coordinate. Default is 50% of max possible speed the unit can go.
   -- @return #boolean
   
   --- Deploy Handler OnAfter for AI_CARGO_HELICOPTER
@@ -139,21 +149,42 @@ function AI_CARGO_HELICOPTER:New( Helicopter, CargoSet )
   -- @param #string Event
   -- @param #string To
   -- @param Core.Point#COORDINATE Coordinate
-  -- @param #number Speed Speed in km/h to drive to the pickup coordinate. Default is 50% of max possible speed the unit can go.
+  -- @param #number Speed Speed in km/h to fly to the pickup coordinate. Default is 50% of max possible speed the unit can go.
+  
+    --- Deployed Handler OnAfter for AI_CARGO_HELICOPTER
+  -- @function [parent=#AI_CARGO_HELICOPTER] OnAfterDeployed
+  -- @param #AI_CARGO_HELICOPTER self
+  -- @param #string From
+  -- @param #string Event
+  -- @param #string To
   
   --- Deploy Trigger for AI_CARGO_HELICOPTER
   -- @function [parent=#AI_CARGO_HELICOPTER] Deploy
   -- @param #AI_CARGO_HELICOPTER self
   -- @param Core.Point#COORDINATE Coordinate Place at which the cargo is deployed.
-  -- @param #number Speed Speed in km/h to drive to the pickup coordinate. Default is 50% of max possible speed the unit can go.
+  -- @param #number Speed Speed in km/h to fly to the pickup coordinate. Default is 50% of max possible speed the unit can go.
   
   --- Deploy Asynchronous Trigger for AI_CARGO_HELICOPTER
   -- @function [parent=#AI_CARGO_HELICOPTER] __Deploy
   -- @param #number Delay Delay in seconds.
   -- @param #AI_CARGO_HELICOPTER self
   -- @param Core.Point#COORDINATE Coordinate Place at which the cargo is deployed.
-  -- @param #number Speed Speed in km/h to drive to the pickup coordinate. Default is 50% of max possible speed the unit can go.
+  -- @param #number Speed Speed in km/h to fly to the pickup coordinate. Default is 50% of max possible speed the unit can go.
   
+  --- Home Trigger for AI_CARGO_HELICOPTER
+  -- @function [parent=#AI_CARGO_HELICOPTER] Home
+  -- @param #AI_CARGO_HELICOPTER self
+  -- @param Core.Point#COORDINATE Coordinate Place to which the helicopter will go.
+  -- @param #number Speed (optional) Speed in km/h to fly to the pickup coordinate. Default is 50% of max possible speed the unit can go.
+  -- @param #number Height (optional) Height the Helicopter should be flying at.
+  
+  --- Home Asynchronous Trigger for AI_CARGO_HELICOPTER
+  -- @function [parent=#AI_CARGO_HELICOPTER] __Home
+  -- @param #number Delay Delay in seconds.
+  -- @param #AI_CARGO_HELICOPTER self
+  -- @param Core.Point#COORDINATE Coordinate Place to which the helicopter will go.
+  -- @param #number Speed (optional) Speed in km/h to fly to the pickup coordinate. Default is 50% of max possible speed the unit can go.
+  -- @param #number Height (optional) Height the Helicopter should be flying at. 
 
   -- We need to capture the Crash events for the helicopters.
   -- The helicopter reference is used in the semaphore AI_CARGO_QUEUE.
@@ -180,6 +211,9 @@ function AI_CARGO_HELICOPTER:New( Helicopter, CargoSet )
 
   self:SetCarrier( Helicopter )
   
+  self.landingspeed = 15 -- kph
+  self.landingheight = 5.5 -- meter
+  
   return self
 end
 
@@ -228,6 +262,25 @@ function AI_CARGO_HELICOPTER:SetCarrier( Helicopter )
   return self
 end
 
+--- Set landingspeed and -height for helicopter landings. Adjust after tracing if your helis get stuck after landing.
+-- @param #AI_CARGO_HELICOPTER self
+-- @param #number speed Landing speed in kph(!), e.g. 15
+-- @param #number height Landing height in meters(!), e.g. 5.5
+-- @return #AI_CARGO_HELICOPTER self
+-- @usage If your choppers get stuck, add tracing to your script to determine if they hit the right parameters like so:
+--    
+--        BASE:TraceOn()
+--        BASE:TraceClass("AI_CARGO_HELICOPTER")
+--        
+-- Watch the DCS.log for entries stating `Helicopter:<name>, Height = Helicopter:<number>, Velocity = Helicopter:<number>`
+-- Adjust if necessary.
+function AI_CARGO_HELICOPTER:SetLandingSpeedAndHeight(speed, height)
+  local _speed = speed or 15
+  local _height = height or 5.5
+  self.landingheight = _height
+  self.landingspeed = _speed
+  return self
+end
 
 --- @param #AI_CARGO_HELICOPTER self
 -- @param Wrapper.Group#GROUP Helicopter
@@ -235,7 +288,7 @@ end
 -- @param Event
 -- @param To
 function AI_CARGO_HELICOPTER:onafterLanded( Helicopter, From, Event, To )
-
+  self:F({From, Event, To})
   Helicopter:F( { Name = Helicopter:GetName() } )
 
   if Helicopter and Helicopter:IsAlive() then
@@ -244,13 +297,13 @@ function AI_CARGO_HELICOPTER:onafterLanded( Helicopter, From, Event, To )
     -- 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.
+    -- So we check if the helo is on the ground, and velocity< 15.
     -- Only then the infantry can unload (and load too, for consistency)!
 
-    self:F( { Helicopter:GetName(), Height = Helicopter:GetHeight( true ), Velocity = Helicopter:GetVelocityKMH() } )
+    self:T( { Helicopter:GetName(), Height = Helicopter:GetHeight( true ), Velocity = Helicopter:GetVelocityKMH() } )
 
     if self.RoutePickup == true then
-      if Helicopter:GetHeight( true ) <= 5.5 and Helicopter:GetVelocityKMH() < 10 then
+      if Helicopter:GetHeight( true ) <= self.landingheight then --and Helicopter:GetVelocityKMH() < self.landingspeed then
         --self:Load( Helicopter:GetPointVec2() )
         self:Load( self.PickupZone )
         self.RoutePickup = false
@@ -258,7 +311,7 @@ function AI_CARGO_HELICOPTER:onafterLanded( Helicopter, From, Event, To )
     end
     
     if self.RouteDeploy == true then
-      if Helicopter:GetHeight( true ) <= 5.5 and Helicopter:GetVelocityKMH() < 10 then
+      if Helicopter:GetHeight( true ) <= self.landingheight then --and Helicopter:GetVelocityKMH() < self.landingspeed then
         self:Unload( self.DeployZone )
         self.RouteDeploy = false
       end
@@ -276,7 +329,7 @@ end
 -- @param Core.Point#COORDINATE Coordinate
 -- @param #number Speed
 function AI_CARGO_HELICOPTER:onafterQueue( Helicopter, From, Event, To, Coordinate, Speed, DeployZone )
-
+  self:F({From, Event, To, Coordinate, Speed, DeployZone})
   local HelicopterInZone = false
 
   if Helicopter and Helicopter:IsAlive() == true then
@@ -359,6 +412,7 @@ end
 -- @param Core.Point#COORDINATE Coordinate
 -- @param #number Speed
 function AI_CARGO_HELICOPTER:onafterOrbit( Helicopter, From, Event, To, Coordinate )
+  self:F({From, Event, To, Coordinate})
   
   if Helicopter and Helicopter:IsAlive() then
     
@@ -394,7 +448,7 @@ end
 -- @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:F( { From, Event, To, DeployZone = DeployZone } )
 
   self:Orbit( Helicopter:GetCoordinate(), 50 )
 
@@ -416,7 +470,7 @@ end
 -- @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 Speed Speed in km/h to fly to the pickup coordinate. Default is 50% of max possible speed the unit can go.
 -- @param #number Height Height in meters to move to the pickup coordinate. This parameter is ignored for APCs.
 -- @param Core.Zone#ZONE PickupZone (optional) The zone where the cargo will be picked up. The PickupZone can be nil, if there wasn't any PickupZoneSet provided.
 function AI_CARGO_HELICOPTER:onafterPickup( Helicopter, From, Event, To, Coordinate, Speed, Height, PickupZone )
@@ -485,10 +539,10 @@ end
 -- @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 Speed Speed in km/h to fly to the pickup coordinate. Default is 50% of max possible speed the unit can go.
 -- @param #number Height Height in meters to move to the deploy coordinate.
 function AI_CARGO_HELICOPTER:onafterDeploy( Helicopter, From, Event, To, Coordinate, Speed, Height, DeployZone )
-
+  self:F({From, Event, To, Coordinate, Speed, Height, DeployZone})
   if Helicopter and Helicopter:IsAlive() ~= nil then
 
     self.RouteDeploy = true
@@ -550,10 +604,11 @@ end
 -- @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 Speed Speed in km/h to fly to the pickup coordinate. Default is 50% of max possible speed the unit can go.
 -- @param #number Height Height in meters to move to the home coordinate.
 -- @param Core.Zone#ZONE HomeZone The zone wherein the carrier will return when all cargo has been transported. This can be any zone type, like a ZONE, ZONE_GROUP, ZONE_AIRBASE.
 function AI_CARGO_HELICOPTER:onafterHome( Helicopter, From, Event, To, Coordinate, Speed, Height, HomeZone )
+  self:F({From, Event, To, Coordinate, Speed, Height})
   
   if Helicopter and Helicopter:IsAlive() ~= nil then
 
@@ -563,7 +618,8 @@ function AI_CARGO_HELICOPTER:onafterHome( Helicopter, From, Event, To, Coordinat
     
     --- Calculate the target route point.
 
-    Coordinate.y = Height
+    --Coordinate.y = Height
+    Height = Height or 50
     
     Speed = Speed or Helicopter:GetSpeedMax()*0.5          
 
@@ -576,7 +632,7 @@ function AI_CARGO_HELICOPTER:onafterHome( Helicopter, From, Event, To, Coordinat
     --- Create a route point of type air.
     local CoordinateTo = Coordinate
     local landheight = CoordinateTo:GetLandHeight() -- get target height
-    CoordinateTo.y = landheight + 50 -- flight height should be 50m above ground
+    CoordinateTo.y = landheight + Height -- flight height should be 50m above ground
     
     local WaypointTo = CoordinateTo:WaypointAir("RADIO", POINT_VEC3.RoutePointType.TurningPoint, POINT_VEC3.RoutePointAction.TurningPoint, Speed, true)
 
@@ -594,7 +650,6 @@ function AI_CARGO_HELICOPTER:onafterHome( Helicopter, From, Event, To, Coordinat
 
     -- Now route the helicopter
     Helicopter:Route(Route, 0)
-    
   end
   
 end

Moose Development/Moose/AI/AI_Cargo_Ship.lua

@@ -7,7 +7,7 @@
 -- ===
 --
 -- @module AI.AI_Cargo_Ship
--- @image AI_Cargo_Dispatching_For_Ship.JPG
+-- @image AI_Cargo_Dispatcher.JPG
 
 --- @type AI_CARGO_SHIP
 -- @extends AI.AI_Cargo#AI_CARGO

Moose Development/Moose/AI/AI_Formation.lua

@@ -1140,7 +1140,7 @@ end
 -- @param DCS#Vec3 CV2 Vec3
 function AI_FORMATION:FollowMe(FollowGroup, ClientUnit, CT1, CV1, CT2, CV2)
 
-  if FollowGroup:GetState( FollowGroup, "Mode" ) == self.__Enum.Mode.Formation then
+  if FollowGroup:GetState( FollowGroup, "Mode" ) == self.__Enum.Mode.Formation and not self:Is("Stopped") then
  
     self:T({Mode=FollowGroup:GetState( FollowGroup, "Mode" )})
 

Moose Development/Moose/AI/AI_Patrol.lua

@@ -4,7 +4,7 @@
 -- 
 --   * Patrol AI airplanes within a given zone.
 --   * Trigger detected events when enemy airplanes are detected.
---   * Manage a fuel treshold to RTB on time.
+--   * Manage a fuel threshold to RTB on time.
 -- 
 -- ===
 -- 
@@ -16,7 +16,7 @@
 --   
 -- ===
 -- 
--- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/PAT%20-%20Patrolling)
+-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/PAT%20-%20Patrolling)
 -- 
 -- ===
 -- 
@@ -72,8 +72,8 @@
 -- 
 -- ![Process](..\Presentations\AI_PATROL\Dia10.JPG)
 -- 
--- Until a fuel or damage treshold has been reached by the AI, or when the AI is commanded to RTB.
+-- Until a fuel or damage threshold has been reached by the AI, or when the AI is commanded to RTB.
--- When the fuel treshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
+-- When the fuel threshold has been reached, the airplane will fly towards the nearest friendly airbase and will land.
 -- 
 -- ![Process](..\Presentations\AI_PATROL\Dia11.JPG)
 -- 
@@ -101,7 +101,7 @@
 --   * **RTB** ( Group ): Route the AI to the home base.
 --   * **Detect** ( Group ): The AI is detecting targets.
 --   * **Detected** ( Group ): The AI has detected new targets.
---   * **Status** ( Group ): The AI is checking status (fuel and damage). When the tresholds have been reached, the AI will RTB.
+--   * **Status** ( Group ): The AI is checking status (fuel and damage). When the thresholds have been reached, the AI will RTB.
 --    
 -- ## 3. Set or Get the AI controllable
 -- 
@@ -133,8 +133,8 @@
 -- ## 6. Manage the "out of fuel" in the AI_PATROL_ZONE
 -- 
 -- When the AI is out of fuel, it is required that a new AI is started, before the old AI can return to the home base.
--- Therefore, with a parameter and a calculation of the distance to the home base, the fuel treshold is calculated.
+-- Therefore, with a parameter and a calculation of the distance to the home base, the fuel threshold is calculated.
--- When the fuel treshold is reached, the AI will continue for a given time its patrol task in orbit, 
+-- When the fuel threshold is reached, the AI will continue for a given time its patrol task in orbit, 
 -- while a new AI is targetted to the AI_PATROL_ZONE.
 -- Once the time is finished, the old AI will return to the base.
 -- Use the method @{#AI_PATROL_ZONE.ManageFuel}() to have this proces in place.
@@ -142,7 +142,7 @@
 -- ## 7. Manage "damage" behaviour of the AI in the AI_PATROL_ZONE
 -- 
 -- When the AI is damaged, it is required that a new AIControllable is started. However, damage cannon be foreseen early on. 
--- Therefore, when the damage treshold is reached, the AI will return immediately to the home base (RTB).
+-- Therefore, when the damage threshold is reached, the AI will return immediately to the home base (RTB).
 -- Use the method @{#AI_PATROL_ZONE.ManageDamage}() to have this proces in place.
 -- 
 -- ===
@@ -581,11 +581,11 @@ function AI_PATROL_ZONE:ClearDetectedUnits()
 end
 
 --- When the AI is out of fuel, it is required that a new AI is started, before the old AI can return to the home base.
--- Therefore, with a parameter and a calculation of the distance to the home base, the fuel treshold is calculated.
+-- Therefore, with a parameter and a calculation of the distance to the home base, the fuel threshold is calculated.
--- When the fuel treshold is reached, the AI will continue for a given time its patrol task in orbit, while a new AIControllable is targetted to the AI_PATROL_ZONE.
+-- When the fuel threshold is reached, the AI will continue for a given time its patrol task in orbit, while a new AIControllable is targetted to the AI_PATROL_ZONE.
 -- Once the time is finished, the old AI will return to the base.
 -- @param #AI_PATROL_ZONE self
--- @param #number PatrolFuelThresholdPercentage The treshold in percentage (between 0 and 1) when the AIControllable is considered to get out of fuel.
+-- @param #number PatrolFuelThresholdPercentage The threshold in percentage (between 0 and 1) when the AIControllable is considered to get out of fuel.
 -- @param #number PatrolOutOfFuelOrbitTime The amount of seconds the out of fuel AIControllable will orbit before returning to the base.
 -- @return #AI_PATROL_ZONE self
 function AI_PATROL_ZONE:ManageFuel( PatrolFuelThresholdPercentage, PatrolOutOfFuelOrbitTime )
@@ -596,14 +596,14 @@ function AI_PATROL_ZONE:ManageFuel( PatrolFuelThresholdPercentage, PatrolOutOfFu
   return self
 end
 
---- When the AI is damaged beyond a certain treshold, it is required that the AI returns to the home base.
+--- When the AI is damaged beyond a certain threshold, it is required that the AI returns to the home base.
 -- However, damage cannot be foreseen early on. 
--- Therefore, when the damage treshold is reached, 
+-- Therefore, when the damage threshold is reached, 
 -- the AI will return immediately to the home base (RTB).
 -- Note that for groups, the average damage of the complete group will be calculated.
--- So, in a group of 4 airplanes, 2 lost and 2 with damage 0.2, the damage treshold will be 0.25.
+-- So, in a group of 4 airplanes, 2 lost and 2 with damage 0.2, the damage threshold will be 0.25.
 -- @param #AI_PATROL_ZONE self
--- @param #number PatrolDamageThreshold The treshold in percentage (between 0 and 1) when the AI is considered to be damaged.
+-- @param #number PatrolDamageThreshold The threshold in percentage (between 0 and 1) when the AI is considered to be damaged.
 -- @return #AI_PATROL_ZONE self
 function AI_PATROL_ZONE:ManageDamage( PatrolDamageThreshold )
 
@@ -725,8 +725,8 @@ function AI_PATROL_ZONE:onafterRoute( Controllable, From, Event, To )
     return
   end
 
-  
+  local life = self.Controllable:GetLife() or 0
-  if self.Controllable:IsAlive() then
+  if self.Controllable:IsAlive() and life > 1 then
     -- Determine if the AIControllable is within the PatrolZone. 
     -- If not, make a waypoint within the to that the AIControllable will fly at maximum speed to that point.
     
@@ -743,8 +743,9 @@ function AI_PATROL_ZONE:onafterRoute( Controllable, From, Event, To )
     if self.Controllable:InAir() == false then
       self:T( "Not in the air, finding route path within PatrolZone" )
       local CurrentVec2 = self.Controllable:GetVec2()
-      --TODO: Create GetAltitude function for GROUP, and delete GetUnit(1).
+      if not CurrentVec2 then return end
-      local CurrentAltitude = self.Controllable:GetUnit(1):GetAltitude()
+      --Done: Create GetAltitude function for GROUP, and delete GetUnit(1).
+      local CurrentAltitude = self.Controllable:GetAltitude()
       local CurrentPointVec3 = POINT_VEC3:New( CurrentVec2.x, CurrentAltitude, CurrentVec2.y )
       local ToPatrolZoneSpeed = self.PatrolMaxSpeed
       local CurrentRoutePoint = CurrentPointVec3:WaypointAir( 
@@ -758,8 +759,9 @@ function AI_PATROL_ZONE:onafterRoute( Controllable, From, Event, To )
     else
       self:T( "In the air, finding route path within PatrolZone" )
       local CurrentVec2 = self.Controllable:GetVec2()
-      --TODO: Create GetAltitude function for GROUP, and delete GetUnit(1).
+      if not CurrentVec2 then return end
-      local CurrentAltitude = self.Controllable:GetUnit(1):GetAltitude()
+      --DONE: Create GetAltitude function for GROUP, and delete GetUnit(1).
+      local CurrentAltitude = self.Controllable:GetAltitude()
       local CurrentPointVec3 = POINT_VEC3:New( CurrentVec2.x, CurrentAltitude, CurrentVec2.y )
       local ToPatrolZoneSpeed = self.PatrolMaxSpeed
       local CurrentRoutePoint = CurrentPointVec3:WaypointAir( 
@@ -870,9 +872,10 @@ function AI_PATROL_ZONE:onafterRTB()
   
     --- Calculate the current route point.
     local CurrentVec2 = self.Controllable:GetVec2()
-    
+    if not CurrentVec2 then return end
-    --TODO: Create GetAltitude function for GROUP, and delete GetUnit(1).
+    --DONE: Create GetAltitude function for GROUP, and delete GetUnit(1).
-    local CurrentAltitude = self.Controllable:GetUnit(1):GetAltitude()
+    --local CurrentAltitude = self.Controllable:GetUnit(1):GetAltitude()
+    local CurrentAltitude = self.Controllable:GetAltitude()
     local CurrentPointVec3 = POINT_VEC3:New( CurrentVec2.x, CurrentAltitude, CurrentVec2.y )
     local ToPatrolZoneSpeed = self.PatrolMaxSpeed
     local CurrentRoutePoint = CurrentPointVec3:WaypointAir( 

Moose Development/Moose/Actions/Act_Route.lua

@@ -190,7 +190,7 @@ do -- ACT_ROUTE
           self:F( { ZoneName = ZoneName } )
           local Zone = Zone -- Core.Zone#ZONE
           local ZoneCoord = Zone:GetCoordinate()
-          local ZoneDistance = ZoneCoord:Get2DDistance( self.Coordinate )
+          local ZoneDistance = ZoneCoord:Get2DDistance( Coordinate )
           self:F( { ShortestDistance, ShortestReferenceName } )
           if ShortestDistance == 0 or ZoneDistance < ShortestDistance then
             ShortestDistance = ZoneDistance

Moose Development/Moose/Cargo/Cargo.lua

@@ -194,7 +194,7 @@
 --    * is of type `Workmaterials`
 --    * will report when a carrier is within 500 meters
 --    * will board to carriers when the carrier is within 500 meters from the cargo object
---    * will dissapear when the cargo is within 25 meters from the carrier during boarding
+--    * will disappear when the cargo is within 25 meters from the carrier during boarding
 -- 
 -- So the overall syntax of the #CARGO naming tag and arguments are:
 -- 
@@ -206,27 +206,29 @@
 --    * **NR=** Provide the maximum range in meters when the cargo units will be boarded within the carrier during boarding.
 --      Note that this option is optional, so can be omitted. The default value of the RR is 10 meters.
 -- 
--- ## 5.2) The \#CARGO tag to create CARGO_CRATE objects:
+-- ## 5.2) The \#CARGO tag to create CARGO_CRATE or CARGO_SLINGLOAD objects:
 -- 
 -- You can also use the \#CARGO tag on **static** objects, including **static cargo** objects of the mission editor.
 -- 
 -- For example, the following #CARGO naming in the **static name** of the object, will create a CARGO_CRATE object when the mission starts.
 -- 
---   `Static #CARGO(T=Workmaterials,RR=500,NR=25)`
+--   `Static #CARGO(T=Workmaterials,C=CRATE,RR=500,NR=25)`
 -- 
 -- This will create a CARGO_CRATE object:
 -- 
 --    * with the group name `Static #CARGO`
 --    * is of type `Workmaterials`
+--    * is of category `CRATE` (as opposed to `SLING`)
 --    * will report when a carrier is within 500 meters
 --    * will board to carriers when the carrier is within 500 meters from the cargo object
---    * will dissapear when the cargo is within 25 meters from the carrier during boarding
+--    * will disappear when the cargo is within 25 meters from the carrier during boarding
 -- 
 -- So the overall syntax of the #CARGO naming tag and arguments are:
 -- 
---   `StaticName #CARGO(T=CargoTypeName,RR=Range,NR=Range)`
+--   `StaticName #CARGO(T=CargoTypeName,C=Category,RR=Range,NR=Range)`
 -- 
 --    * **T=** Provide a text that contains the type name of the cargo object. This type name can be used to filter cargo within a SET_CARGO object.
+--    * **C=** Provide either `CRATE` or `SLING` to have this static created as a CARGO_CRATE or CARGO_SLINGLOAD respectivly.
 --    * **RR=** Provide the minimal range in meters when the report to the carrier, and board to the carrier.
 --      Note that this option is optional, so can be omitted. The default value of the RR is 250 meters.
 --    * **NR=** Provide the maximum range in meters when the cargo units will be boarded within the carrier during boarding.

Moose Development/Moose/Core/Astar.lua

@@ -0,0 +1,943 @@
+--- **Core** - A* Pathfinding.
+--
+-- **Main Features:**
+--
+--    * Find path from A to B.
+--    * Pre-defined as well as custom valid neighbour functions.
+--    * Pre-defined as well as custom cost functions.
+--    * Easy rectangular grid setup.
+--
+-- ===
+--
+-- ### Author: **funkyfranky**
+-- 
+-- ===
+-- @module Core.Astar
+-- @image CORE_Astar.png
+
+
+--- ASTAR class.
+-- @type ASTAR
+-- @field #string ClassName Name of the class.
+-- @field #boolean Debug Debug mode. Messages to all about status.
+-- @field #string lid Class id string for output to DCS log file.
+-- @field #table nodes Table of nodes.
+-- @field #number counter Node counter.
+-- @field #number Nnodes Number of nodes.
+-- @field #number nvalid Number of nvalid calls.
+-- @field #number nvalidcache Number of cached valid evals.
+-- @field #number ncost Number of cost evaluations.
+-- @field #number ncostcache Number of cached cost evals.
+-- @field #ASTAR.Node startNode Start node.
+-- @field #ASTAR.Node endNode End node.
+-- @field Core.Point#COORDINATE startCoord Start coordinate.
+-- @field Core.Point#COORDINATE endCoord End coordinate.
+-- @field #function ValidNeighbourFunc Function to check if a node is valid.
+-- @field #table ValidNeighbourArg Optional arguments passed to the valid neighbour function.
+-- @field #function CostFunc Function to calculate the heuristic "cost" to go from one node to another.
+-- @field #table CostArg Optional arguments passed to the cost function. 
+-- @extends Core.Base#BASE
+
+--- *When nothing goes right... Go left!*
+--
+-- ===
+--
+-- # The ASTAR Concept
+-- 
+-- Pathfinding algorithm.
+-- 
+-- 
+-- # Start and Goal
+-- 
+-- The first thing we need to define is obviously the place where we want to start and where we want to go eventually.
+-- 
+-- ## Start
+-- 
+-- The start
+-- 
+-- ## Goal 
+-- 
+-- 
+-- # Nodes
+-- 
+-- ## Rectangular Grid
+-- 
+-- A rectangular grid can be created using the @{#ASTAR.CreateGrid}(*ValidSurfaceTypes, BoxHY, SpaceX, deltaX, deltaY, MarkGrid*), where
+-- 
+-- * *ValidSurfaceTypes* is a table of valid surface types. By default all surface types are valid.
+-- * *BoxXY* is the width of the grid perpendicular the the line between start and end node. Default is 40,000 meters (40 km).
+-- * *SpaceX* is the additional space behind the start and end nodes. Default is 20,000 meters (20 km).
+-- * *deltaX* is the grid spacing between nodes in the direction of start and end node. Default is 2,000 meters (2 km).
+-- * *deltaY* is the grid spacing perpendicular to the direction of start and end node. Default is the same as *deltaX*.
+-- * *MarkGrid* If set to *true*, this places marker on the F10 map on each grid node. Note that this can stall DCS if too many nodes are created. 
+-- 
+-- ## Valid Surfaces
+-- 
+-- Certain unit types can only travel on certain surfaces types, for example
+-- 
+-- * Naval units can only travel on water (that also excludes shallow water in DCS currently),
+-- * Ground units can only traval on land.
+-- 
+-- By restricting the surface type in the grid construction, we also reduce the number of nodes, which makes the algorithm more efficient.
+-- 
+-- ## Box Width (BoxHY)
+-- 
+-- The box width needs to be large enough to capture all paths you want to consider.
+-- 
+-- ## Space in X
+-- 
+-- The space in X value is important if the algorithm needs to to backwards from the start node or needs to extend even further than the end node.
+-- 
+-- ## Grid Spacing
+-- 
+-- The grid spacing is an important factor as it determines the number of nodes and hence the performance of the algorithm. It should be as large as possible.
+-- However, if the value is too large, the algorithm might fail to get a valid path.
+-- 
+-- A good estimate of the grid spacing is to set it to be smaller (~ half the size) of the smallest gap you need to path.
+-- 
+-- # Valid Neighbours
+-- 
+-- The A* algorithm needs to know if a transition from one node to another is allowed or not. By default, hopping from one node to another is always possible.
+-- 
+-- ## Line of Sight
+-- 
+-- For naval
+--  
+-- 
+-- # Heuristic Cost
+-- 
+-- In order to determine the optimal path, the pathfinding algorithm needs to know, how costly it is to go from one node to another.
+-- Often, this can simply be determined by the distance between two nodes. Therefore, the default cost function is set to be the 2D distance between two nodes.
+-- 
+-- 
+-- # Calculate the Path
+-- 
+-- Finally, we have to calculate the path. This is done by the @{ASTAR.GetPath}(*ExcludeStart, ExcludeEnd*) function. This function returns a table of nodes, which
+-- describe the optimal path from the start node to the end node.
+-- 
+-- By default, the start and end node are include in the table that is returned.
+-- 
+-- Note that a valid path must not always exist. So you should check if the function returns *nil*.
+-- 
+-- Common reasons that a path cannot be found are:
+-- 
+-- * The grid is too small ==> increase grid size, e.g. *BoxHY* and/or *SpaceX* if you use a rectangular grid.  
+-- * The grid spacing is too large ==> decrease *deltaX* and/or *deltaY*
+-- * There simply is no valid path ==> you are screwed :(
+-- 
+-- 
+-- # Examples
+-- 
+-- ## Strait of Hormuz
+-- 
+-- Carrier Group finds its way through the Stait of Hormuz.
+-- 
+-- ## 
+-- 
+--
+--
+-- @field #ASTAR
+ASTAR = {
+  ClassName      = "ASTAR",
+  Debug          =   nil,
+  lid            =   nil,
+  nodes          =    {},
+  counter        =     1,
+  Nnodes         =     0,
+  ncost          =     0,
+  ncostcache     =     0,
+  nvalid         =     0,
+  nvalidcache    =     0,
+}
+
+--- Node data.
+-- @type ASTAR.Node
+-- @field #number id Node id.
+-- @field Core.Point#COORDINATE coordinate Coordinate of the node.
+-- @field #number surfacetype Surface type.
+-- @field #table valid Cached valid/invalid nodes.
+-- @field #table cost Cached cost.
+
+--- ASTAR infinity.
+-- @field #number INF
+ASTAR.INF=1/0
+
+--- ASTAR class version.
+-- @field #string version
+ASTAR.version="0.4.0"
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- TODO list
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+-- TODO: Add more valid neighbour functions.
+-- TODO: Write docs.
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- Constructor
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+--- Create a new ASTAR object.
+-- @param #ASTAR self
+-- @return #ASTAR self
+function ASTAR:New()
+
+  -- Inherit everything from INTEL class.
+  local self=BASE:Inherit(self, BASE:New()) --#ASTAR
+
+  self.lid="ASTAR | "
+
+  return self
+end
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- User functions
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+--- Set coordinate from where to start.
+-- @param #ASTAR self
+-- @param Core.Point#COORDINATE Coordinate Start coordinate.
+-- @return #ASTAR self
+function ASTAR:SetStartCoordinate(Coordinate)
+
+  self.startCoord=Coordinate
+  
+  return self
+end
+
+--- Set coordinate where you want to go.
+-- @param #ASTAR self
+-- @param Core.Point#COORDINATE Coordinate end coordinate.
+-- @return #ASTAR self
+function ASTAR:SetEndCoordinate(Coordinate)
+
+  self.endCoord=Coordinate
+  
+  return self
+end
+
+--- Create a node from a given coordinate.
+-- @param #ASTAR self
+-- @param Core.Point#COORDINATE Coordinate The coordinate where to create the node.
+-- @return #ASTAR.Node The node.
+function ASTAR:GetNodeFromCoordinate(Coordinate)
+
+  local node={} --#ASTAR.Node
+  
+  node.coordinate=Coordinate
+  node.surfacetype=Coordinate:GetSurfaceType()
+  node.id=self.counter
+  
+  node.valid={}
+  node.cost={}
+  
+  self.counter=self.counter+1
+  
+  return node
+end
+
+
+--- Add a node to the table of grid nodes.
+-- @param #ASTAR self
+-- @param #ASTAR.Node Node The node to be added.
+-- @return #ASTAR self
+function ASTAR:AddNode(Node)
+
+  self.nodes[Node.id]=Node
+  self.Nnodes=self.Nnodes+1 
+    
+  return self
+end
+
+--- Add a node to the table of grid nodes specifying its coordinate.
+-- @param #ASTAR self
+-- @param Core.Point#COORDINATE Coordinate The coordinate where the node is created.
+-- @return #ASTAR.Node The node.
+function ASTAR:AddNodeFromCoordinate(Coordinate)
+
+  local node=self:GetNodeFromCoordinate(Coordinate)
+  
+  self:AddNode(node)
+    
+  return node
+end
+
+--- Check if the coordinate of a node has is at a valid surface type.
+-- @param #ASTAR self
+-- @param #ASTAR.Node Node The node to be added.
+-- @param #table SurfaceTypes Surface types, for example `{land.SurfaceType.WATER}`. By default all surface types are valid.
+-- @return #boolean If true, surface type of node is valid.
+function ASTAR:CheckValidSurfaceType(Node, SurfaceTypes)
+
+  if SurfaceTypes then
+  
+    if type(SurfaceTypes)~="table" then
+      SurfaceTypes={SurfaceTypes}
+    end
+    
+    for _,surface in pairs(SurfaceTypes) do
+      if surface==Node.surfacetype then
+        return true
+      end
+    end
+  
+    return false
+    
+  else
+    return true
+  end
+
+end
+
+--- Add a function to determine if a neighbour of a node is valid.
+-- @param #ASTAR self
+-- @param #function NeighbourFunction Function that needs to return *true* for a neighbour to be valid.
+-- @param ... Condition function arguments if any.
+-- @return #ASTAR self
+function ASTAR:SetValidNeighbourFunction(NeighbourFunction, ...)
+
+  self.ValidNeighbourFunc=NeighbourFunction
+  
+  self.ValidNeighbourArg={}
+  if arg then
+    self.ValidNeighbourArg=arg
+  end
+  
+  return self
+end
+
+
+--- Set valid neighbours to require line of sight between two nodes.
+-- @param #ASTAR self
+-- @param #number CorridorWidth Width of LoS corridor in meters.
+-- @return #ASTAR self
+function ASTAR:SetValidNeighbourLoS(CorridorWidth)
+
+  self:SetValidNeighbourFunction(ASTAR.LoS, CorridorWidth)
+
+  return self
+end
+
+--- Set valid neighbours to be in a certain distance.
+-- @param #ASTAR self
+-- @param #number MaxDistance Max distance between nodes in meters. Default is 2000 m.
+-- @return #ASTAR self
+function ASTAR:SetValidNeighbourDistance(MaxDistance)
+
+  self:SetValidNeighbourFunction(ASTAR.DistMax, MaxDistance)
+
+  return self
+end
+
+--- Set valid neighbours to be in a certain distance.
+-- @param #ASTAR self
+-- @param #number MaxDistance Max distance between nodes in meters. Default is 2000 m.
+-- @return #ASTAR self
+function ASTAR:SetValidNeighbourRoad(MaxDistance)
+
+  self:SetValidNeighbourFunction(ASTAR.Road, MaxDistance)
+
+  return self
+end
+
+--- Set the function which calculates the "cost" to go from one to another node.
+-- The first to arguments of this function are always the two nodes under consideration. But you can add optional arguments.
+-- Very often the distance between nodes is a good measure for the cost.
+-- @param #ASTAR self
+-- @param #function CostFunction Function that returns the "cost".
+-- @param ... Condition function arguments if any.
+-- @return #ASTAR self
+function ASTAR:SetCostFunction(CostFunction, ...)
+
+  self.CostFunc=CostFunction
+  
+  self.CostArg={}
+  if arg then
+    self.CostArg=arg
+  end
+  
+  return self
+end
+
+--- Set heuristic cost to go from one node to another to be their 2D distance.
+-- @param #ASTAR self
+-- @return #ASTAR self
+function ASTAR:SetCostDist2D()
+
+  self:SetCostFunction(ASTAR.Dist2D)
+
+  return self
+end
+
+--- Set heuristic cost to go from one node to another to be their 3D distance.
+-- @param #ASTAR self
+-- @return #ASTAR self
+function ASTAR:SetCostDist3D()
+
+  self:SetCostFunction(ASTAR.Dist3D)
+
+  return self
+end
+
+--- Set heuristic cost to go from one node to another to be their 3D distance.
+-- @param #ASTAR self
+-- @return #ASTAR self
+function ASTAR:SetCostRoad()
+
+  self:SetCostFunction(ASTAR)
+
+  return self
+end
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- Grid functions
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+--- Create a rectangular grid of nodes between star and end coordinate.
+-- The coordinate system is oriented along the line between start and end point.
+-- @param #ASTAR self
+-- @param #table ValidSurfaceTypes Valid surface types. By default is all surfaces are allowed.
+-- @param #number BoxHY Box "height" in meters along the y-coordinate. Default 40000 meters (40 km).
+-- @param #number SpaceX Additional space in meters before start and after end coordinate. Default 10000 meters (10 km).
+-- @param #number deltaX Increment in the direction of start to end coordinate in meters. Default 2000 meters.
+-- @param #number deltaY Increment perpendicular to the direction of start to end coordinate in meters. Default is same as deltaX.
+-- @param #boolean MarkGrid If true, create F10 map markers at grid nodes.
+-- @return #ASTAR self
+function ASTAR:CreateGrid(ValidSurfaceTypes, BoxHY, SpaceX, deltaX, deltaY, MarkGrid)
+
+  -- Note that internally
+  -- x coordinate is z: x-->z  Line from start to end
+  -- y coordinate is x: y-->x  Perpendicular
+
+  -- Grid length and width.
+  local Dz=SpaceX or 10000
+  local Dx=BoxHY and BoxHY/2 or 20000
+
+  -- Increments.
+  local dz=deltaX or 2000  
+  local dx=deltaY or dz
+  
+  -- Heading from start to end coordinate.
+  local angle=self.startCoord:HeadingTo(self.endCoord)
+  
+  --Distance between start and end.
+  local dist=self.startCoord:Get2DDistance(self.endCoord)+2*Dz
+  
+  -- Origin of map. Needed to translate back to wanted position.
+  local co=COORDINATE:New(0, 0, 0)
+  local do1=co:Get2DDistance(self.startCoord)
+  local ho1=co:HeadingTo(self.startCoord)
+  
+  -- Start of grid.
+  local xmin=-Dx
+  local zmin=-Dz
+  
+  -- Number of grid points.
+  local nz=dist/dz+1
+  local nx=2*Dx/dx+1
+  
+  -- Debug info.
+  local text=string.format("Building grid with nx=%d ny=%d => total=%d nodes", nx, nz, nx*nz)
+  self:T(self.lid..text)
+  
+  -- Loop over x and z coordinate to create a 2D grid.
+  for i=1,nx do
+  
+    -- x coordinate perpendicular to z.
+    local x=xmin+dx*(i-1)
+  
+    for j=1,nz do
+    
+      -- z coordinate connecting start and end.
+      local z=zmin+dz*(j-1)
+      
+      -- Rotate 2D.
+      local vec3=UTILS.Rotate2D({x=x, y=0, z=z}, angle)
+      
+      -- Coordinate of the node.
+      local c=COORDINATE:New(vec3.z, vec3.y, vec3.x):Translate(do1, ho1, true)
+        
+      -- Create a node at this coordinate.
+      local node=self:GetNodeFromCoordinate(c)
+        
+      -- Check if node has valid surface type.
+      if self:CheckValidSurfaceType(node, ValidSurfaceTypes) then
+          
+        if MarkGrid then
+          c:MarkToAll(string.format("i=%d, j=%d surface=%d", i, j, node.surfacetype))
+        end
+          
+        -- Add node to grid.
+        self:AddNode(node)
+        
+      end
+    
+    end
+  end
+    
+  -- Debug info.
+  local text=string.format("Done building grid!")
+  self:T2(self.lid..text)
+
+  return self
+end
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- Valid neighbour functions
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+--- Function to check if two nodes have line of sight (LoS).
+-- @param #ASTAR.Node nodeA First node.
+-- @param #ASTAR.Node nodeB Other node.
+-- @param #number corridor (Optional) Width of corridor in meters.
+-- @return #boolean If true, two nodes have LoS.
+function ASTAR.LoS(nodeA, nodeB, corridor)
+
+  local offset=1
+  
+  local dx=corridor and corridor/2 or nil
+  local dy=dx
+  
+  local cA=nodeA.coordinate:GetVec3()
+  local cB=nodeB.coordinate:GetVec3()
+  cA.y=offset
+  cB.y=offset
+
+  local los=land.isVisible(cA, cB)
+  
+  if los and corridor then
+  
+    -- Heading from A to B.
+    local heading=nodeA.coordinate:HeadingTo(nodeB.coordinate)
+    
+    local Ap=UTILS.VecTranslate(cA, dx, heading+90)
+    local Bp=UTILS.VecTranslate(cB, dx, heading+90)
+
+    los=land.isVisible(Ap, Bp)
+    
+    if los then
+
+      local Am=UTILS.VecTranslate(cA, dx, heading-90)
+      local Bm=UTILS.VecTranslate(cB, dx, heading-90)
+    
+      los=land.isVisible(Am, Bm)
+    end
+    
+  end
+
+  return los
+end
+
+--- Function to check if two nodes have a road connection.
+-- @param #ASTAR.Node nodeA First node.
+-- @param #ASTAR.Node nodeB Other node.
+-- @return #boolean If true, two nodes are connected via a road.
+function ASTAR.Road(nodeA, nodeB)
+
+  local path=land.findPathOnRoads("roads", nodeA.coordinate.x, nodeA.coordinate.z, nodeB.coordinate.x, nodeB.coordinate.z)
+  
+  if path then
+    return true    
+  else
+    return false
+  end
+
+end
+
+--- Function to check if distance between two nodes is less than a threshold distance.
+-- @param #ASTAR.Node nodeA First node.
+-- @param #ASTAR.Node nodeB Other node.
+-- @param #number distmax Max distance in meters. Default is 2000 m.
+-- @return #boolean If true, distance between the two nodes is below threshold.
+function ASTAR.DistMax(nodeA, nodeB, distmax)
+
+  distmax=distmax or 2000
+
+  local dist=nodeA.coordinate:Get2DDistance(nodeB.coordinate)
+  
+  return dist<=distmax
+end
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- Heuristic cost functions
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+--- Heuristic cost is given by the 2D distance between the nodes. 
+-- @param #ASTAR.Node nodeA First node.
+-- @param #ASTAR.Node nodeB Other node.
+-- @return #number Distance between the two nodes.
+function ASTAR.Dist2D(nodeA, nodeB)
+  local dist=nodeA.coordinate:Get2DDistance(nodeB)
+  return dist
+end
+
+--- Heuristic cost is given by the 3D distance between the nodes. 
+-- @param #ASTAR.Node nodeA First node.
+-- @param #ASTAR.Node nodeB Other node.
+-- @return #number Distance between the two nodes.
+function ASTAR.Dist3D(nodeA, nodeB)
+  local dist=nodeA.coordinate:Get3DDistance(nodeB.coordinate)
+  return dist
+end
+
+--- Heuristic cost is given by the distance between the nodes on road. 
+-- @param #ASTAR.Node nodeA First node.
+-- @param #ASTAR.Node nodeB Other node.
+-- @return #number Distance between the two nodes.
+function ASTAR.DistRoad(nodeA, nodeB)
+
+  -- Get the path.
+  local path=land.findPathOnRoads("roads", nodeA.coordinate.x, nodeA.coordinate.z, nodeB.coordinate.x, nodeB.coordinate.z)
+  
+  if path then
+  
+    local dist=0
+    
+    for i=2,#path do
+      local b=path[i] --DCS#Vec2
+      local a=path[i-1] --DCS#Vec2
+      
+      dist=dist+UTILS.VecDist2D(a,b)
+      
+    end
+
+    return dist
+  end
+  
+
+  return math.huge
+end
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- Misc functions
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+--- Find the closest node from a given coordinate.
+-- @param #ASTAR self
+-- @param Core.Point#COORDINATE Coordinate.
+-- @return #ASTAR.Node Cloest node to the coordinate.
+-- @return #number Distance to closest node in meters.
+function ASTAR:FindClosestNode(Coordinate)
+
+  local distMin=math.huge
+  local closeNode=nil
+  
+  for _,_node in pairs(self.nodes) do
+    local node=_node --#ASTAR.Node
+    
+    local dist=node.coordinate:Get2DDistance(Coordinate)
+    
+    if dist<distMin then
+      distMin=dist
+      closeNode=node
+    end
+    
+  end
+    
+  return closeNode, distMin
+end
+
+--- Find the start node.
+-- @param #ASTAR self
+-- @param #ASTAR.Node Node The node to be added to the nodes table.
+-- @return #ASTAR self
+function ASTAR:FindStartNode()
+
+  local node, dist=self:FindClosestNode(self.startCoord)
+  
+  self.startNode=node
+  
+  if dist>1000 then
+    self:T(self.lid.."Adding start node to node grid!")
+    self:AddNode(node)
+  end
+    
+  return self
+end
+
+--- Add a node.
+-- @param #ASTAR self
+-- @param #ASTAR.Node Node The node to be added to the nodes table.
+-- @return #ASTAR self
+function ASTAR:FindEndNode()
+
+  local node, dist=self:FindClosestNode(self.endCoord)
+
+  self.endNode=node
+  
+  if dist>1000 then
+    self:T(self.lid.."Adding end node to node grid!")
+    self:AddNode(node)
+  end
+    
+  return self
+end
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- Main A* pathfinding function
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+--- A* pathfinding function. This seaches the path along nodes between start and end nodes/coordinates.
+-- @param #ASTAR self
+-- @param #boolean ExcludeStartNode If *true*, do not include start node in found path. Default is to include it.
+-- @param #boolean ExcludeEndNode If *true*, do not include end node in found path. Default is to include it.
+-- @return #table Table of nodes from start to finish.
+function ASTAR:GetPath(ExcludeStartNode, ExcludeEndNode)
+
+  self:FindStartNode()
+  self:FindEndNode()
+
+  local nodes=self.nodes
+  local start=self.startNode
+  local goal=self.endNode
+
+  -- Sets.
+  local openset   = {}
+  local closedset = {}
+  local came_from = {}
+  local g_score   = {}
+  local f_score   = {}
+  
+  openset[start.id]=true
+  local Nopen=1
+  
+  -- Initial scores.
+  g_score[start.id]=0
+  f_score[start.id]=g_score[start.id]+self:_HeuristicCost(start, goal)
+  
+  -- Set start time.
+  local T0=timer.getAbsTime()
+
+  -- Debug message.
+  local text=string.format("Starting A* pathfinding with %d Nodes", self.Nnodes)
+  self:T(self.lid..text)
+  
+  local Tstart=UTILS.GetOSTime()
+
+  -- Loop while we still have an open set.
+  while Nopen > 0 do
+  
+    -- Get current node.
+    local current=self:_LowestFscore(openset, f_score)
+    
+    -- Check if we are at the end node.
+    if current.id==goal.id then
+    
+      local path=self:_UnwindPath({}, came_from, goal)
+      
+      if not ExcludeEndNode then
+        table.insert(path, goal)
+      end
+      
+      if ExcludeStartNode then
+        table.remove(path, 1)
+      end
+      
+      local Tstop=UTILS.GetOSTime()
+      
+      local dT=nil
+      if Tstart and Tstop then
+        dT=Tstop-Tstart
+      end
+      
+      -- Debug message.
+      local text=string.format("Found path with %d nodes (%d total)", #path, self.Nnodes)
+      if dT then
+        text=text..string.format(", OS Time %.6f sec", dT)
+      end
+      text=text..string.format(", Nvalid=%d [%d cached]", self.nvalid, self.nvalidcache)
+      text=text..string.format(", Ncost=%d [%d cached]", self.ncost, self.ncostcache)
+      self:T(self.lid..text)
+      
+      return path
+    end
+
+    -- Move Node from open to closed set.
+    openset[current.id]=nil
+    Nopen=Nopen-1
+    closedset[current.id]=true
+    
+    -- Get neighbour nodes.
+    local neighbors=self:_NeighbourNodes(current, nodes)
+    
+    -- Loop over neighbours.
+    for _,neighbor in pairs(neighbors) do
+    
+      if self:_NotIn(closedset, neighbor.id) then
+      
+        local tentative_g_score=g_score[current.id]+self:_DistNodes(current, neighbor)
+         
+        if self:_NotIn(openset, neighbor.id) or tentative_g_score < g_score[neighbor.id] then
+        
+          came_from[neighbor]=current
+          
+          g_score[neighbor.id]=tentative_g_score
+          f_score[neighbor.id]=g_score[neighbor.id]+self:_HeuristicCost(neighbor, goal)
+          
+          if self:_NotIn(openset, neighbor.id) then
+            -- Add to open set.
+            openset[neighbor.id]=true
+            Nopen=Nopen+1
+          end
+          
+        end
+      end
+    end
+  end
+
+  -- Debug message.
+  local text=string.format("WARNING: Could NOT find valid path!")
+  self:E(self.lid..text)
+  MESSAGE:New(text, 60, "ASTAR"):ToAllIf(self.Debug)
+  
+  return nil -- no valid path
+end
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- A* pathfinding helper functions
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+--- Heuristic "cost" function to go from node A to node B. Default is the distance between the nodes.
+-- @param #ASTAR self
+-- @param #ASTAR.Node nodeA Node A.
+-- @param #ASTAR.Node nodeB Node B.
+-- @return #number "Cost" to go from node A to node B.
+function ASTAR:_HeuristicCost(nodeA, nodeB)
+  
+  -- Counter.
+  self.ncost=self.ncost+1
+
+  -- Get chached cost if available.
+  local cost=nodeA.cost[nodeB.id]
+  if cost~=nil then
+    self.ncostcache=self.ncostcache+1
+    return cost
+  end
+
+  local cost=nil
+  if self.CostFunc then
+    cost=self.CostFunc(nodeA, nodeB, unpack(self.CostArg))
+  else
+    cost=self:_DistNodes(nodeA, nodeB)
+  end
+  
+  nodeA.cost[nodeB.id]=cost
+  nodeB.cost[nodeA.id]=cost  -- Symmetric problem. 
+  
+  return cost
+end
+
+--- Check if going from a node to a neighbour is possible.
+-- @param #ASTAR self
+-- @param #ASTAR.Node node A node.
+-- @param #ASTAR.Node neighbor Neighbour node.
+-- @return #boolean If true, transition between nodes is possible.
+function ASTAR:_IsValidNeighbour(node, neighbor)
+
+  -- Counter.
+  self.nvalid=self.nvalid+1
+  
+  local valid=node.valid[neighbor.id]
+  if valid~=nil then
+    --env.info(string.format("Node %d has valid=%s neighbour %d", node.id, tostring(valid), neighbor.id))
+    self.nvalidcache=self.nvalidcache+1
+    return valid
+  end
+
+  local valid=nil
+  if self.ValidNeighbourFunc then
+    valid=self.ValidNeighbourFunc(node, neighbor, unpack(self.ValidNeighbourArg))  
+  else
+    valid=true
+  end
+
+  node.valid[neighbor.id]=valid
+  neighbor.valid[node.id]=valid  -- Symmetric problem. 
+
+  return valid
+end
+
+--- Calculate 2D distance between two nodes.
+-- @param #ASTAR self
+-- @param #ASTAR.Node nodeA Node A.
+-- @param #ASTAR.Node nodeB Node B.
+-- @return #number Distance between nodes in meters.
+function ASTAR:_DistNodes(nodeA, nodeB)
+  return nodeA.coordinate:Get2DDistance(nodeB.coordinate)
+end
+
+--- Function that calculates the lowest F score.
+-- @param #ASTAR self
+-- @param #table set The set of nodes IDs.
+-- @param #number f_score F score.
+-- @return #ASTAR.Node Best node.
+function ASTAR:_LowestFscore(set, f_score)
+
+  local lowest, bestNode = ASTAR.INF, nil
+  
+  for nid,node in pairs(set) do
+  
+    local score=f_score[nid]
+    
+    if score<lowest then
+      lowest, bestNode = score, nid
+    end
+  end
+  
+  return self.nodes[bestNode]
+end
+
+--- Function to get valid neighbours of a node.
+-- @param #ASTAR self
+-- @param #ASTAR.Node theNode The node.
+-- @param #table nodes Possible neighbours.
+-- @param #table Valid neighbour nodes.
+function ASTAR:_NeighbourNodes(theNode, nodes)
+
+  local neighbors = {}
+  
+  for _,node in pairs(nodes) do
+  
+    if theNode.id~=node.id then
+    
+      local isvalid=self:_IsValidNeighbour(theNode, node)
+    
+      if isvalid then
+        table.insert(neighbors, node)
+      end
+      
+    end
+    
+  end
+  
+  return neighbors
+end
+
+--- Function to check if a node is not in a set.
+-- @param #ASTAR self
+-- @param #table set Set of nodes.
+-- @param #ASTAR.Node theNode The node to check.
+-- @return #boolean If true, the node is not in the set.
+function ASTAR:_NotIn(set, theNode)
+  return set[theNode]==nil
+end
+
+--- Unwind path function.
+-- @param #ASTAR self
+-- @param #table flat_path Flat path.
+-- @param #table map Map.
+-- @param #ASTAR.Node current_node The current node.
+-- @return #table Unwinded path.
+function ASTAR:_UnwindPath( flat_path, map, current_node )
+
+  if map [current_node] then
+    table.insert (flat_path, 1, map[current_node]) 
+    return self:_UnwindPath(flat_path, map, map[current_node])
+  else
+    return flat_path
+  end
+end
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Moose Development/Moose/Core/Base.lua

@@ -7,7 +7,7 @@
 --   * 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 tracing of information or objects during mission execution for debugging purposes.
 --   * The subscription to DCS events for event handling in MOOSE objects.
 --   * Object inspection.
 --
@@ -49,7 +49,8 @@ local _ClassID = 0
 -- # 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.
+-- These trace methods are inherited by each MOOSE class inheriting BASE, thus all objects created from
+-- a class derived from BASE can use the tracing methods to trace its execution.
 --
 -- Any type of information can be passed to these tracing methods. See the following examples:
 --
@@ -111,7 +112,6 @@ local _ClassID = 0
 --
 -- The method @{#BASE.IsTrace}() will validate if tracing is activated or not.
 --
--- 
 -- # 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,
@@ -157,8 +157,6 @@ local _ClassID = 0
 --        self:SmokeBlue()
 --      end
 --
--- 
--- 
 -- See the @{Event} module for more information about event handling.
 --
 -- # 4. Class identification methods.
@@ -203,13 +201,12 @@ BASE = {
   Scheduler = nil,
 }
 
-
 --- @field #BASE.__
 BASE.__ = {}
 
 --- @field #BASE._
 BASE._ = {
-  Schedules = {} --- Contains the Schedulers Active
+  Schedules = {}, --- Contains the Schedulers Active
 }
 
 --- The Formation Class
@@ -217,11 +214,9 @@ BASE._ = {
 -- @field Cone A cone formation.
 FORMATION = {
   Cone = "Cone",
-  Vee = "Vee" 
+  Vee = "Vee",
 }
 
-
-
 --- BASE constructor.
 --
 -- This is an example how to use the BASE:New() constructor in a new class definition when inheriting from BASE.
@@ -234,18 +229,19 @@ FORMATION = {
 -- @param #BASE self
 -- @return #BASE
 function BASE:New()
-  local self = routines.utils.deepCopy( self ) -- Create a new self instance
+  --local self = routines.utils.deepCopy( self ) -- Create a new self instance
+  local self = UTILS.DeepCopy(self)
 
-	_ClassID = _ClassID + 1
+  _ClassID = _ClassID + 1
-	self.ClassID = _ClassID
+  self.ClassID = _ClassID
 
-	-- This is for "private" methods...
+  -- This is for "private" methods...
-	-- When a __ is passed to a method as "self", the __index will search for the method on the public method list too!
+  -- When a __ is passed to a method as "self", the __index will search for the method on the public method list too!
---  if rawget( self, "__" ) then
+  --  if rawget( self, "__" ) then
-    --setmetatable( self, { __index = self.__ } )
+  -- setmetatable( self, { __index = self.__ } )
---  end
+  --  end
 
-	return self
+  return self
 end
 
 --- This is the worker method to inherit from a parent class.
@@ -256,26 +252,25 @@ end
 function BASE:Inherit( Child, Parent )
 
   -- Create child.
-	local Child = routines.utils.deepCopy( Child )
+  local Child = routines.utils.deepCopy( Child )
 
-	if Child ~= nil then
+  if Child ~= nil then
 
-  -- This is for "private" methods...
+    -- This is for "private" methods...
-  -- When a __ is passed to a method as "self", the __index will search for the method on the public method list of the same object too!
+    -- When a __ is passed to a method as "self", the __index will search for the method on the public method list of the same object too!
     if rawget( Child, "__" ) then
-      setmetatable( Child, { __index = Child.__  } )
+      setmetatable( Child, { __index = Child.__ } )
       setmetatable( Child.__, { __index = Parent } )
     else
       setmetatable( Child, { __index = Parent } )
     end
 
-		--Child:_SetDestructor()
+    -- Child:_SetDestructor()
-	end
+  end
 
-	return Child
+  return Child
 end
 
-
 local function getParent( Child )
   local Parent = nil
 
@@ -291,7 +286,6 @@ local function getParent( Child )
   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.
 --
@@ -304,19 +298,18 @@ end
 -- @return #BASE
 function BASE:GetParent( Child, FromClass )
 
-
   local Parent
   -- BASE class has no parent
   if Child.ClassName == 'BASE' then
     Parent = nil
   else
 
-    --self:E({FromClass = FromClass})
+    -- self:E({FromClass = FromClass})
-    --self:E({Child = Child.ClassName})
+    -- self:E({Child = Child.ClassName})
     if FromClass then
-      while( Child.ClassName ~= "BASE" and Child.ClassName ~= FromClass.ClassName ) do
+      while (Child.ClassName ~= "BASE" and Child.ClassName ~= FromClass.ClassName) do
         Child = getParent( Child )
-        --self:E({Child.ClassName})
+        -- self:E({Child.ClassName})
       end
     end
     if Child.ClassName == 'BASE' then
@@ -325,7 +318,7 @@ function BASE:GetParent( Child, FromClass )
       Parent = getParent( Child )
     end
   end
-  --self:E({Parent.ClassName})
+  -- self:E({Parent.ClassName})
   return Parent
 end
 
@@ -354,11 +347,11 @@ function BASE:IsInstanceOf( ClassName )
       -- Get the name of the Moose class as a string
       ClassName = ClassName.ClassName
 
-    -- className is neither a string nor a Moose class, throw an error
+      -- className is neither a string nor a Moose class, throw an error
     else
 
       -- I'm not sure if this should take advantage of MOOSE logging function, or throw an error for pcall
-      local err_str = 'className parameter should be a string; parameter received: '..type( ClassName )
+      local err_str = 'className parameter should be a string; parameter received: ' .. type( ClassName )
       self:E( err_str )
       -- error( err_str )
       return false
@@ -372,7 +365,7 @@ function BASE:IsInstanceOf( ClassName )
     return true
   end
 
-  local Parent = getParent(self)
+  local Parent = getParent( self )
 
   while Parent do
 
@@ -419,7 +412,6 @@ do -- Event Handling
     return _EVENTDISPATCHER
   end
 
-  
   --- Get the Class @{Event} processing Priority.
   -- The Event processing Priority is a number from 1 to 10,
   -- reflecting the order of the classes subscribed to the Event to be processed.
@@ -472,14 +464,16 @@ do -- Event Handling
     return self
   end
   
-  -- Event handling function prototypes
+  -- Event handling function prototypes - Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
   
   --- Occurs whenever any unit in a mission fires a weapon. But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart.
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
   -- @function [parent=#BASE] OnEventShot
   -- @param #BASE self
   -- @param Core.Event#EVENTDATA EventData The EventData structure.
 
   --- Occurs whenever an object is hit by a weapon.
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
   -- initiator : The unit object the fired the weapon
   -- weapon: Weapon object that hit the target
   -- target: The Object that was hit. 
@@ -488,6 +482,7 @@ do -- Event Handling
   -- @param Core.Event#EVENTDATA EventData The EventData structure.
 
   --- Occurs when an aircraft takes off from an airbase, farp, or ship.
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
   -- initiator : The unit that tookoff
   -- place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships 
   -- @function [parent=#BASE] OnEventTakeoff
@@ -495,6 +490,7 @@ do -- Event Handling
   -- @param Core.Event#EVENTDATA EventData The EventData structure.
 
   --- Occurs when an aircraft lands at an airbase, farp or ship
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
   -- initiator : The unit that has landed
   -- place: Object that the unit landed on. Can be an Airbase Object, FARP, or Ships 
   -- @function [parent=#BASE] OnEventLand
@@ -502,42 +498,49 @@ do -- Event Handling
   -- @param Core.Event#EVENTDATA EventData The EventData structure.
 
   --- Occurs when any aircraft crashes into the ground and is completely destroyed.
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
   -- initiator : The unit that has crashed 
   -- @function [parent=#BASE] OnEventCrash
   -- @param #BASE self
   -- @param Core.Event#EVENTDATA EventData The EventData structure.
 
   --- Occurs when a pilot ejects from an aircraft
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
   -- initiator : The unit that has ejected 
   -- @function [parent=#BASE] OnEventEjection
   -- @param #BASE self
   -- @param Core.Event#EVENTDATA EventData The EventData structure.
 
   --- Occurs when an aircraft connects with a tanker and begins taking on fuel.
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
   -- initiator : The unit that is receiving fuel. 
   -- @function [parent=#BASE] OnEventRefueling
   -- @param #BASE self
   -- @param Core.Event#EVENTDATA EventData The EventData structure.
 
   --- Occurs when an object is dead.
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
   -- initiator : The unit that is dead. 
   -- @function [parent=#BASE] OnEventDead
   -- @param #BASE self
   -- @param Core.Event#EVENTDATA EventData The EventData structure.
 
-  --- Occurs when an object is completely destroyed.
+  --- Occurs when an Event for an object is triggered.
-  -- initiator : The unit that is was destroyed. 
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
+  -- initiator : The unit that triggered the event. 
   -- @function [parent=#BASE] OnEvent
   -- @param #BASE self
   -- @param Core.Event#EVENTDATA EventData The EventData structure.
 
   --- Occurs when the pilot of an aircraft is killed. Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane.
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
   -- initiator : The unit that the pilot has died in. 
   -- @function [parent=#BASE] OnEventPilotDead
   -- @param #BASE self
   -- @param Core.Event#EVENTDATA EventData The EventData structure.
 
   --- Occurs when a ground unit captures either an airbase or a farp.
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
   -- initiator : The unit that captured the base
   -- place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction. 
   -- @function [parent=#BASE] OnEventBaseCaptured
@@ -545,58 +548,68 @@ do -- Event Handling
   -- @param Core.Event#EVENTDATA EventData The EventData structure.
 
   --- Occurs when a mission starts
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes. 
   -- @function [parent=#BASE] OnEventMissionStart
   -- @param #BASE self
   -- @param Core.Event#EVENTDATA EventData The EventData structure.
 
   --- Occurs when a mission ends
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
   -- @function [parent=#BASE] OnEventMissionEnd
   -- @param #BASE self
   -- @param Core.Event#EVENTDATA EventData The EventData structure.
 
   --- Occurs when an aircraft is finished taking fuel.
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
   -- initiator : The unit that was receiving fuel. 
   -- @function [parent=#BASE] OnEventRefuelingStop
   -- @param #BASE self
   -- @param Core.Event#EVENTDATA EventData The EventData structure.
 
   --- Occurs when any object is spawned into the mission.
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
   -- initiator : The unit that was spawned 
   -- @function [parent=#BASE] OnEventBirth
   -- @param #BASE self
   -- @param Core.Event#EVENTDATA EventData The EventData structure.
 
   --- Occurs when any system fails on a human controlled aircraft.
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
   -- initiator : The unit that had the failure 
   -- @function [parent=#BASE] OnEventHumanFailure
   -- @param #BASE self
   -- @param Core.Event#EVENTDATA EventData The EventData structure.
 
   --- Occurs when any aircraft starts its engines.
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
   -- initiator : The unit that is starting its engines. 
   -- @function [parent=#BASE] OnEventEngineStartup
   -- @param #BASE self
   -- @param Core.Event#EVENTDATA EventData The EventData structure.
 
   --- Occurs when any aircraft shuts down its engines.
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
   -- initiator : The unit that is stopping its engines. 
   -- @function [parent=#BASE] OnEventEngineShutdown
   -- @param #BASE self
   -- @param Core.Event#EVENTDATA EventData The EventData structure.
 
-  --- Occurs when any player assumes direct control of a unit.
+  --- Occurs when any player assumes direct control of a unit. Note - not Mulitplayer safe. Use PlayerEnterAircraft.
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
   -- initiator : The unit that is being taken control of. 
   -- @function [parent=#BASE] OnEventPlayerEnterUnit
   -- @param #BASE self
   -- @param Core.Event#EVENTDATA EventData The EventData structure.
 
   --- Occurs when any player relieves control of a unit to the AI.
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
   -- initiator : The unit that the player left. 
   -- @function [parent=#BASE] OnEventPlayerLeaveUnit
   -- @param #BASE self
   -- @param Core.Event#EVENTDATA EventData The EventData structure.
 
   --- Occurs when any unit begins firing a weapon that has a high rate of fire. Most common with aircraft cannons (GAU-8), autocannons, and machine guns.
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
   -- initiator : The unit that is doing the shooting.
   -- target: The unit that is being targeted.
   -- @function [parent=#BASE] OnEventShootingStart
@@ -604,30 +617,33 @@ do -- Event Handling
   -- @param Core.Event#EVENTDATA EventData The EventData structure.
 
   --- Occurs when any unit stops firing its weapon. Event will always correspond with a shooting start event.
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
   -- initiator : The unit that was doing the shooting. 
   -- @function [parent=#BASE] OnEventShootingEnd
   -- @param #BASE self
   -- @param Core.Event#EVENTDATA EventData The EventData structure.
 
   --- Occurs when a new mark was added.
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
   -- MarkID: ID of the mark. 
   -- @function [parent=#BASE] OnEventMarkAdded
   -- @param #BASE self
   -- @param Core.Event#EVENTDATA EventData The EventData structure.
 
   --- Occurs when a mark was removed.
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
   -- MarkID: ID of the mark. 
   -- @function [parent=#BASE] OnEventMarkRemoved
   -- @param #BASE self
   -- @param Core.Event#EVENTDATA EventData The EventData structure.
 
   --- Occurs when a mark text was changed.
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
   -- MarkID: ID of the mark. 
   -- @function [parent=#BASE] OnEventMarkChange
   -- @param #BASE self
   -- @param Core.Event#EVENTDATA EventData The EventData structure.
 
-
   --- Unknown precisely what creates this event, likely tied into newer damage model. Will update this page when new information become available.
   --
   -- * initiator: The unit that had the failure.
@@ -638,11 +654,13 @@ do -- Event Handling
 
   --- Occurs when any modification to the "Score" as seen on the debrief menu would occur.
   -- There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard.
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
   -- @function [parent=#BASE] OnEventScore
   -- @param #BASE self
   -- @param Core.Event#EVENTDATA EventData The EventData structure.
 
   --- Occurs on the death of a unit. Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs.
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
   -- 
   -- * initiator: The unit that killed the target
   -- * target: Target Object
@@ -654,11 +672,13 @@ do -- Event Handling
 
   --- Occurs when any modification to the "Score" as seen on the debrief menu would occur.
   -- There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard.
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
   -- @function [parent=#BASE] OnEventScore
   -- @param #BASE self
   -- @param Core.Event#EVENTDATA EventData The EventData structure.
 
   --- Occurs when the game thinks an object is destroyed.
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
   -- 
   -- * initiator: The unit that is was destroyed.
   --
@@ -667,6 +687,7 @@ do -- Event Handling
   -- @param Core.Event#EVENTDATA EventData The EventData structure.
 
   --- Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up. Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker.
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
   -- 
   -- * initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.
   -- * place: may not return as a valid object if the aircraft has crashed into the ground and no longer exists.
@@ -676,7 +697,44 @@ do -- Event Handling
   -- @param #BASE self
   -- @param Core.Event#EVENTDATA EventData The EventData structure.
 
+  --- Paratrooper landing.
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
+  -- @function [parent=#BASE] OnEventParatrooperLanding
+  -- @param #BASE self
+  -- @param Core.Event#EVENTDATA EventData The EventData structure.
+
+  --- Discard chair after ejection.
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
+  -- @function [parent=#BASE] OnEventDiscardChairAfterEjection
+  -- @param #BASE self
+  -- @param Core.Event#EVENTDATA EventData The EventData structure.
+
+  --- Weapon add. Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted.
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
+  -- @function [parent=#BASE] OnEventParatrooperLanding
+  -- @param #BASE self
+  -- @param Core.Event#EVENTDATA EventData The EventData structure.
+
+  --- Trigger zone.
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
+  -- @function [parent=#BASE] OnEventTriggerZone
+  -- @param #BASE self
+  -- @param Core.Event#EVENTDATA EventData The EventData structure.
+
+  --- Landing quality mark. 
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
+  -- @function [parent=#BASE] OnEventLandingQualityMark
+  -- @param #BASE self
+  -- @param Core.Event#EVENTDATA EventData The EventData structure.
+
+  --- BDA.
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
+  -- @function [parent=#BASE] OnEventBDA
+  -- @param #BASE self
+  -- @param Core.Event#EVENTDATA EventData The EventData structure.
+
   --- Occurs when a player enters a slot and takes control of an aircraft.
+  -- Have a look at the class @{Core.EVENT#EVENT} as these are just the prototypes.
   -- **NOTE**: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event. 
   -- initiator : The unit that is being taken control of. 
   -- @function [parent=#BASE] OnEventPlayerEnterAircraft
@@ -685,7 +743,6 @@ do -- Event Handling
 
 end
 
-
 --- Creation of a Birth Event.
 -- @param #BASE self
 -- @param DCS#Time EventTime The time stamp of the event.
@@ -694,47 +751,65 @@ end
 -- @param place
 -- @param subplace
 function BASE:CreateEventBirth( EventTime, Initiator, IniUnitName, place, subplace )
-	self:F( { EventTime, Initiator, IniUnitName, place, subplace } )
+  self:F( { EventTime, Initiator, IniUnitName, place, subplace } )
 
-	local Event = {
+  local Event = {
-		id = world.event.S_EVENT_BIRTH,
+    id = world.event.S_EVENT_BIRTH,
-		time = EventTime,
+    time = EventTime,
-		initiator = Initiator,
+    initiator = Initiator,
-		IniUnitName = IniUnitName,
+    IniUnitName = IniUnitName,
-		place = place,
+    place = place,
-		subplace = subplace
+    subplace = subplace,
-		}
+  }
 
-	world.onEvent( Event )
+  world.onEvent( Event )
 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.
-function BASE:CreateEventCrash( EventTime, Initiator )
+function BASE:CreateEventCrash( EventTime, Initiator, IniObjectCategory )
-	self:F( { EventTime, Initiator } )
+  self:F( { EventTime, Initiator } )
 
-	local Event = {
+  local Event = {
-		id = world.event.S_EVENT_CRASH,
+    id = world.event.S_EVENT_CRASH,
-		time = EventTime,
+    time = EventTime,
-		initiator = Initiator,
+    initiator = Initiator,
-		}
+    IniObjectCategory = IniObjectCategory,
+  }
 
-	world.onEvent( Event )
+  world.onEvent( Event )
+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.
+function BASE:CreateEventUnitLost(EventTime, Initiator)
+  self:F( { EventTime, Initiator } )
+
+  local Event = {
+    id = world.event.S_EVENT_UNIT_LOST,
+    time = EventTime,
+    initiator = 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 )
+function BASE:CreateEventDead( EventTime, Initiator, IniObjectCategory )
-  self:F( { EventTime, Initiator } )
+  self:F( { EventTime, Initiator, IniObjectCategory } )
 
   local Event = {
     id = world.event.S_EVENT_DEAD,
     time = EventTime,
     initiator = Initiator,
+    IniObjectCategory = IniObjectCategory,
     }
 
   world.onEvent( Event )
@@ -751,7 +826,7 @@ function BASE:CreateEventRemoveUnit( EventTime, Initiator )
     id = EVENTS.RemoveUnit,
     time = EventTime,
     initiator = Initiator,
-    }
+  }
 
   world.onEvent( Event )
 end
@@ -767,7 +842,7 @@ function BASE:CreateEventTakeoff( EventTime, Initiator )
     id = world.event.S_EVENT_TAKEOFF,
     time = EventTime,
     initiator = Initiator,
-    }
+  }
 
   world.onEvent( Event )
 end
@@ -787,36 +862,35 @@ end
     world.onEvent(Event)
   end  
                   
--- TODO: Complete DCS#Event structure.                       
 --- The main event handling function... This function captures all events generated for the class.
 -- @param #BASE self
 -- @param DCS#Event event
-function BASE:onEvent(event)
+function BASE:onEvent( event )
 
-	if self then
+  if self then
 
-		for EventID, EventObject in pairs(self.Events) do
+    for EventID, EventObject in pairs( self.Events ) do
-			if EventObject.EventEnabled then
+      if EventObject.EventEnabled then
 
-				if event.id == EventObject.Event then
+        if event.id == EventObject.Event then
 
-					if self == EventObject.Self then
+          if self == EventObject.Self then
 
-						if event.initiator and event.initiator:isExist() then
+            if event.initiator and event.initiator:isExist() then
-							event.IniUnitName = event.initiator:getName()
+              event.IniUnitName = event.initiator:getName()
-						end
+            end
 
-						if event.target and event.target:isExist() then
+            if event.target and event.target:isExist() then
-							event.TgtUnitName = event.target:getName()
+              event.TgtUnitName = event.target:getName()
-						end
+            end
 
-					end
+          end
 
-				end
+        end
 
-			end
+      end
-		end
+    end
-	end
+  end
 end
 
 do -- Scheduling
@@ -826,20 +900,22 @@ do -- Scheduling
   -- @param #number Start Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.
   -- @param #function SchedulerFunction The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
   -- @param #table ... Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.
-  -- @return #number The ScheduleID of the planned schedule.
+  -- @return #string The Schedule ID of the planned schedule.
   function BASE:ScheduleOnce( Start, SchedulerFunction, ... )
-    self:F2( { Start } )
-    self:T3( { ... } )
   
+    -- Object name.
     local ObjectName = "-"
     ObjectName = self.ClassName .. self.ClassID
     
+    -- Debug info.
     self:F3( { "ScheduleOnce: ", ObjectName,  Start } )
     
     if not self.Scheduler then
       self.Scheduler = SCHEDULER:New( self )
     end
   
+    -- FF this was wrong!
+    --[[
     local ScheduleID = _SCHEDULEDISPATCHER:AddSchedule( 
       self, 
       SchedulerFunction,
@@ -849,6 +925,10 @@ do -- Scheduling
       nil,
       nil
     )
+    ]]
+    
+    -- NOTE: MasterObject (first parameter) needs to be nil or it will be the first argument passed to the SchedulerFunction!
+    local ScheduleID = self.Scheduler:Schedule(nil, SchedulerFunction, {...}, Start)
     
     self._.Schedules[#self._.Schedules+1] = ScheduleID
   
@@ -863,7 +943,7 @@ do -- Scheduling
   -- @param #number Stop Specifies the amount of seconds when the scheduler will be stopped.
   -- @param #function SchedulerFunction The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
   -- @param #table ... Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.
-  -- @return #number The ScheduleID of the planned schedule.
+  -- @return #string The Schedule ID of the planned schedule.
   function BASE:ScheduleRepeat( Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ... )
     self:F2( { Start } )
     self:T3( { ... } )
@@ -877,8 +957,9 @@ do -- Scheduling
       self.Scheduler = SCHEDULER:New( self )
     end
     
+    -- NOTE: MasterObject (first parameter) should(!) be nil as it will be the first argument passed to the SchedulerFunction!
     local ScheduleID = self.Scheduler:Schedule(
-      self, 
+      nil, 
       SchedulerFunction,
       { ... },
       Start,
@@ -895,21 +976,20 @@ do -- Scheduling
 
   --- Stops the Schedule.
   -- @param #BASE self
-  -- @param #function SchedulerFunction The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.
+  -- @param #string SchedulerID (Optional) Scheduler ID to be stopped. If nil, all pending schedules are stopped.
-  function BASE:ScheduleStop( SchedulerFunction )
+  function BASE:ScheduleStop( SchedulerID )  
-  
     self:F3( { "ScheduleStop:" } )
 
     if self.Scheduler then
-      _SCHEDULEDISPATCHER:Stop( self.Scheduler, self._.Schedules[SchedulerFunction] )
+      --_SCHEDULEDISPATCHER:Stop( self.Scheduler, self._.Schedules[SchedulerFunction] )
+      _SCHEDULEDISPATCHER:Stop(self.Scheduler, SchedulerID)
     end
   end
 
 end
 
-
 --- Set a state or property of the Object given a Key and a Value.
--- Note that if the Object is destroyed, nillified or garbage collected, then the Values and Keys will also be gone.
+-- Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.
 -- @param #BASE self
 -- @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!
@@ -925,9 +1005,8 @@ function BASE:SetState( Object, Key, Value )
   return self.States[ClassNameAndID][Key]
 end
 
-
 --- Get a Value given a Key from the Object.
--- Note that if the Object is destroyed, nillified or garbage collected, then the Values and Keys will also be gone.
+-- Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.
 -- @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!
@@ -979,8 +1058,6 @@ function BASE:TraceOff()
   self:TraceOnOff( false )
 end
 
-
-
 --- Set trace on or off
 -- Note that when trace is off, no BASE.Debug statement is performed, increasing performance!
 -- When Moose is loaded statically, (as one file), tracing is switched off by default.
@@ -989,28 +1066,29 @@ end
 -- @param #BASE self
 -- @param #boolean TraceOnOff Switch the tracing on or off.
 -- @usage
--- -- Switch the tracing On
--- BASE:TraceOnOff( true )
 --
--- -- Switch the tracing Off
+--   -- Switch the tracing On
--- BASE:TraceOnOff( false )
+--   BASE:TraceOnOff( true )
+--
+--   -- Switch the tracing Off
+--   BASE:TraceOnOff( false )
+--
 function BASE:TraceOnOff( TraceOnOff )
-  if TraceOnOff==false then
+  if TraceOnOff == false then
     self:I( "Tracing in MOOSE is OFF" )
     _TraceOnOff = false
   else
-  self:I( "Tracing in MOOSE is ON" )
+    self:I( "Tracing in MOOSE is ON" )
     _TraceOnOff = true
   end
 end
 
-
 --- Enquires if tracing is on (for the class).
 -- @param #BASE self
 -- @return #boolean
 function BASE:IsTrace()
 
-  if BASE.Debug and ( _TraceAll == true ) or ( _TraceClass[self.ClassName] or _TraceClassMethod[self.ClassName] ) then
+  if BASE.Debug and (_TraceAll == true) or (_TraceClass[self.ClassName] or _TraceClassMethod[self.ClassName]) then
     return true
   else
     return false
@@ -1030,8 +1108,8 @@ end
 -- @param #boolean TraceAll true = trace all methods in MOOSE.
 function BASE:TraceAll( TraceAll )
 
-  if TraceAll==false then
+  if TraceAll == false then
-    _TraceAll=false
+    _TraceAll = false
   else
     _TraceAll = true
   end
@@ -1045,7 +1123,7 @@ end
 
 --- Set tracing for a class
 -- @param #BASE self
--- @param #string Class
+-- @param #string Class Class name.
 function BASE:TraceClass( Class )
   _TraceClass[Class] = true
   _TraceClassMethod[Class] = {}
@@ -1054,8 +1132,8 @@ end
 
 --- Set tracing for a specific method of  class
 -- @param #BASE self
--- @param #string Class
+-- @param #string Class Class name.
--- @param #string Method
+-- @param #string Method Method.
 function BASE:TraceClassMethod( Class, Method )
   if not _TraceClassMethod[Class] then
     _TraceClassMethod[Class] = {}
@@ -1070,7 +1148,7 @@ 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 BASE.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" )
@@ -1089,7 +1167,7 @@ function BASE:_F( Arguments, DebugInfoCurrentParam, DebugInfoFromParam )
       if DebugInfoFrom then
         LineFrom = DebugInfoFrom.currentline
       end
-      env.info( string.format( "%6d(%6d)/%1s:%30s%05d.%s(%s)" , LineCurrent, LineFrom, "F", self.ClassName, self.ClassID, Function, routines.utils.oneLineSerialize( Arguments ) ) )
+      env.info( string.format( "%6d(%6d)/%1s:%30s%05d.%s(%s)", LineCurrent, LineFrom, "F", self.ClassName, self.ClassID, Function, routines.utils.oneLineSerialize( Arguments ) ) )
     end
   end
 end
@@ -1109,7 +1187,6 @@ function BASE:F( Arguments )
   end
 end
 
-
 --- Trace a function call level 2. Must be at the beginning of the function logic.
 -- @param #BASE self
 -- @param Arguments A #table or any field.
@@ -1145,28 +1222,28 @@ 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 BASE.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 Function = "function"
+    local Function = "function"
-		if DebugInfoCurrent.name then
+    if DebugInfoCurrent.name then
-			Function = DebugInfoCurrent.name
+      Function = DebugInfoCurrent.name
-		end
+    end
 
     if _TraceAll == true or _TraceClass[self.ClassName] or _TraceClassMethod[self.ClassName].Method[Function] then
       local LineCurrent = 0
       if DebugInfoCurrent.currentline then
         LineCurrent = DebugInfoCurrent.currentline
       end
-  		local LineFrom = 0
+      local LineFrom = 0
-  		if DebugInfoFrom then
+      if DebugInfoFrom then
-  		  LineFrom = DebugInfoFrom.currentline
+        LineFrom = DebugInfoFrom.currentline
-  	  end
+      end
-  		env.info( string.format( "%6d(%6d)/%1s:%30s%05d.%s" , LineCurrent, LineFrom, "T", self.ClassName, self.ClassID, routines.utils.oneLineSerialize( Arguments ) ) )
+      env.info( string.format( "%6d(%6d)/%1s:%30s%05d.%s", LineCurrent, LineFrom, "T", self.ClassName, self.ClassID, routines.utils.oneLineSerialize( Arguments ) ) )
     end
-	end
+  end
 end
 
 --- Trace a function logic level 1. Can be anywhere within the function logic.
@@ -1184,7 +1261,6 @@ function BASE:T( Arguments )
   end
 end
 
-
 --- Trace a function logic level 2. Can be anywhere within the function logic.
 -- @param #BASE self
 -- @param Arguments A #table or any field.
@@ -1221,28 +1297,27 @@ end
 function BASE:E( Arguments )
 
   if BASE.Debug then
-  	local DebugInfoCurrent = BASE.Debug.getinfo( 2, "nl" )
+    local DebugInfoCurrent = BASE.Debug.getinfo( 2, "nl" )
-  	local DebugInfoFrom = BASE.Debug.getinfo( 3, "l" )
+    local DebugInfoFrom = BASE.Debug.getinfo( 3, "l" )
 
-  	local Function = "function"
+    local Function = "function"
-  	if DebugInfoCurrent.name then
+    if DebugInfoCurrent.name then
-  		Function = DebugInfoCurrent.name
+      Function = DebugInfoCurrent.name
-  	end
+    end
 
-  	local LineCurrent = DebugInfoCurrent.currentline
+    local LineCurrent = DebugInfoCurrent.currentline
     local LineFrom = -1
-  	if DebugInfoFrom then
+    if DebugInfoFrom then
-  	  LineFrom = DebugInfoFrom.currentline
+      LineFrom = DebugInfoFrom.currentline
-  	end
+    end
 
-  	env.info( string.format( "%6d(%6d)/%1s:%30s%05d.%s(%s)" , LineCurrent, LineFrom, "E", self.ClassName, self.ClassID, Function, routines.utils.oneLineSerialize( Arguments ) ) )
+    env.info( string.format( "%6d(%6d)/%1s:%30s%05d.%s(%s)", LineCurrent, LineFrom, "E", self.ClassName, self.ClassID, Function, routines.utils.oneLineSerialize( Arguments ) ) )
   else
-    env.info( string.format( "%1s:%30s%05d(%s)" , "E", self.ClassName, self.ClassID, routines.utils.oneLineSerialize( Arguments ) ) )
+    env.info( string.format( "%1s:%30s%05d(%s)", "E", self.ClassName, self.ClassID, routines.utils.oneLineSerialize( Arguments ) ) )
   end
 
 end
 
-
 --- 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.
@@ -1263,26 +1338,23 @@ function BASE:I( Arguments )
       LineFrom = DebugInfoFrom.currentline
     end
 
-    env.info( string.format( "%6d(%6d)/%1s:%30s%05d.%s(%s)" , LineCurrent, LineFrom, "I", self.ClassName, self.ClassID, Function, routines.utils.oneLineSerialize( Arguments ) ) )
+    env.info( string.format( "%6d(%6d)/%1s:%30s%05d.%s(%s)", LineCurrent, LineFrom, "I", self.ClassName, self.ClassID, Function, routines.utils.oneLineSerialize( Arguments ) ) )
   else
-    env.info( string.format( "%1s:%30s%05d(%s)" , "I", self.ClassName, self.ClassID, routines.utils.oneLineSerialize( Arguments ) ) )
+    env.info( string.format( "%1s:%30s%05d(%s)", "I", self.ClassName, self.ClassID, routines.utils.oneLineSerialize( Arguments ) ) )
   end
 
 end
 
-
-
 --- old stuff
 
---function BASE:_Destructor()
+-- function BASE:_Destructor()
 --  --self:E("_Destructor")
 --
 --  --self:EventRemoveAll()
---end
+-- end
-
 
 -- THIS IS WHY WE NEED LUA 5.2 ...
---function BASE:_SetDestructor()
+-- function BASE:_SetDestructor()
 --
 --  -- TODO: Okay, this is really technical...
 --  -- When you set a proxy to a table to catch __gc, weak tables don't behave like weak...
@@ -1303,4 +1375,4 @@ end
 --  -- will be invoked and the destructor called
 --  rawset( self, '__proxy', proxy )
 --
---end
+-- end

Moose Development/Moose/Core/Beacon.lua

@@ -0,0 +1,478 @@
+--- **Core** - TACAN and other beacons.
+-- 
+-- ===
+-- 
+-- ## Features:
+-- 
+--   * Provide beacon functionality to assist pilots.
+--
+-- ===
+--
+-- ### Authors: Hugues "Grey_Echo" Bousquet, funkyfranky
+--
+-- @module Core.Beacon
+-- @image Core_Radio.JPG
+
+--- *In order for the light to shine so brightly, the darkness must be present.* -- Francis Bacon
+-- 
+-- After attaching a @{#BEACON} to your @{Wrapper.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 (aircraft) 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. 
+-- 
+-- ## Aircraft TACAN Beacon usage
+-- 
+-- This beacon only works with airborne @{Wrapper.Unit#UNIT} or a @{Wrapper.Group#GROUP}. Use @{#BEACON.ActivateTACAN}() to set the beacon parameters and start the beacon.
+-- Use @{#BEACON.StopRadioBeacon}() 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.
+-- Use @{#BEACON.StopRadioBeacon}() to stop it.
+-- 
+-- @type BEACON
+-- @field #string ClassName Name of the class "BEACON".
+-- @field Wrapper.Controllable#CONTROLLABLE Positionable The @{#CONTROLLABLE} that will receive radio capabilities.
+-- @extends Core.Base#BASE
+BEACON = {
+  ClassName    = "BEACON",
+  Positionable = nil,
+  name         = nil,
+}
+
+--- Beacon types supported by DCS. 
+-- @type BEACON.Type
+-- @field #number NULL
+-- @field #number VOR
+-- @field #number DME
+-- @field #number VOR_DME
+-- @field #number TACAN TACtical Air Navigation system.
+-- @field #number VORTAC
+-- @field #number RSBN
+-- @field #number BROADCAST_STATION
+-- @field #number HOMER
+-- @field #number AIRPORT_HOMER
+-- @field #number AIRPORT_HOMER_WITH_MARKER
+-- @field #number ILS_FAR_HOMER
+-- @field #number ILS_NEAR_HOMER
+-- @field #number ILS_LOCALIZER
+-- @field #number ILS_GLIDESLOPE
+-- @field #number PRMG_LOCALIZER
+-- @field #number PRMG_GLIDESLOPE
+-- @field #number ICLS Same as ICLS glideslope.
+-- @field #number ICLS_LOCALIZER
+-- @field #number ICLS_GLIDESLOPE
+-- @field #number NAUTICAL_HOMER
+BEACON.Type={
+  NULL                      = 0, 
+  VOR                       = 1,
+  DME                       = 2,
+  VOR_DME                   = 3, 
+  TACAN                     = 4,
+  VORTAC                    = 5, 
+  RSBN                      = 128,
+  BROADCAST_STATION         = 1024, 
+  HOMER                     = 8,
+  AIRPORT_HOMER             = 4104, 
+  AIRPORT_HOMER_WITH_MARKER = 4136, 
+  ILS_FAR_HOMER             = 16408,
+  ILS_NEAR_HOMER            = 16424, 
+  ILS_LOCALIZER             = 16640,
+  ILS_GLIDESLOPE            = 16896,
+  PRMG_LOCALIZER            = 33024,
+  PRMG_GLIDESLOPE           = 33280,
+  ICLS                      = 131584, --leaving this in here but it is the same as ICLS_GLIDESLOPE
+  ICLS_LOCALIZER            = 131328,
+  ICLS_GLIDESLOPE           = 131584,
+  NAUTICAL_HOMER            = 65536,
+}
+
+--- Beacon systems supported by DCS. https://wiki.hoggitworld.com/view/DCS_command_activateBeacon
+-- @type BEACON.System
+-- @field #number PAR_10 ?
+-- @field #number RSBN_5 Russian VOR/DME system.
+-- @field #number TACAN TACtical Air Navigation system on ground.
+-- @field #number TACAN_TANKER_X TACtical Air Navigation system for tankers on X band.
+-- @field #number TACAN_TANKER_Y TACtical Air Navigation system for tankers on Y band.
+-- @field #number VOR Very High Frequency Omni-Directional Range
+-- @field #number ILS_LOCALIZER ILS localizer
+-- @field #number ILS_GLIDESLOPE ILS glide slope.
+-- @field #number PRGM_LOCALIZER PRGM localizer.
+-- @field #number PRGM_GLIDESLOPE PRGM glide slope.
+-- @field #number BROADCAST_STATION Broadcast station.
+-- @field #number VORTAC Radio-based navigational aid for aircraft pilots consisting of a co-located VHF omni-directional range (VOR) beacon and a tactical air navigation system (TACAN) beacon.
+-- @field #number TACAN_AA_MODE_X TACtical Air Navigation for aircraft on X band.
+-- @field #number TACAN_AA_MODE_Y TACtical Air Navigation for aircraft on Y band.
+-- @field #number VORDME Radio beacon that combines a VHF omnidirectional range (VOR) with a distance measuring equipment (DME).
+-- @field #number ICLS_LOCALIZER Carrier landing system.
+-- @field #number ICLS_GLIDESLOPE Carrier landing system.
+BEACON.System={
+  PAR_10            = 1, 
+  RSBN_5            = 2, 
+  TACAN             = 3, 
+  TACAN_TANKER_X    = 4,
+  TACAN_TANKER_Y    = 5,
+  VOR               = 6, 
+  ILS_LOCALIZER     = 7, 
+  ILS_GLIDESLOPE    = 8,
+  PRMG_LOCALIZER    = 9,
+  PRMG_GLIDESLOPE   = 10,
+  BROADCAST_STATION = 11,
+  VORTAC            = 12,
+  TACAN_AA_MODE_X   = 13,
+  TACAN_AA_MODE_Y   = 14,
+  VORDME            = 15,
+  ICLS_LOCALIZER    = 16,
+  ICLS_GLIDESLOPE   = 17,
+}
+
+--- Create a new BEACON Object. This doesn't activate the beacon, though, use @{#BEACON.ActivateTACAN} etc.
+-- If you want to create a BEACON, you probably should use @{Wrapper.Positionable#POSITIONABLE.GetBeacon}() instead.
+-- @param #BEACON self
+-- @param Wrapper.Positionable#POSITIONABLE Positionable The @{Positionable} that will receive radio capabilities.
+-- @return #BEACON Beacon object or #nil if the positionable is invalid.
+function BEACON:New(Positionable)
+
+  -- Inherit BASE.
+  local self=BASE:Inherit(self, BASE:New()) --#BEACON
+  
+  -- Debug.
+  self:F(Positionable)
+  
+  -- Set positionable.
+  if Positionable:GetPointVec2() then -- It's stupid, but the only way I found to make sure positionable is valid
+    self.Positionable = Positionable
+    self.name=Positionable:GetName()
+    self:I(string.format("New BEACON %s", tostring(self.name)))
+    return self
+  end
+  
+  self:E({"The passed positionable is invalid, no BEACON created", Positionable})
+  return nil
+end
+
+
+--- Activates a TACAN BEACON.
+-- @param #BEACON self
+-- @param #number Channel TACAN channel, i.e. the "10" part in "10Y".
+-- @param #string Mode TACAN mode, i.e. the "Y" part in "10Y".
+-- @param #string Message The Message that is going to be coded in Morse and broadcasted by the beacon.
+-- @param #boolean Bearing If true, beacon provides bearing information. If false (or nil), only distance information is available.
+-- @param #number Duration How long will the beacon last in seconds. Omit for forever.
+-- @return #BEACON self
+-- @usage
+-- -- Let's create a TACAN Beacon for a tanker
+-- local myUnit = UNIT:FindByName("MyUnit") 
+-- local myBeacon = myUnit:GetBeacon() -- Creates the beacon
+-- 
+-- myBeacon:ActivateTACAN(20, "Y", "TEXACO", true) -- Activate the beacon
+function BEACON:ActivateTACAN(Channel, Mode, Message, Bearing, Duration)
+  self:T({channel=Channel, mode=Mode, callsign=Message, bearing=Bearing, duration=Duration})
+  
+  Mode=Mode or "Y"
+  
+  -- Get frequency.
+  local Frequency=UTILS.TACANToFrequency(Channel, Mode)
+  
+  -- Check.
+  if not Frequency then 
+    self:E({"The passed TACAN channel is invalid, the BEACON is not emitting"})
+    return self
+  end
+  
+  -- Beacon type.
+  local Type=BEACON.Type.TACAN
+  
+  -- Beacon system.  
+  local System=BEACON.System.TACAN
+  
+  -- Check if unit is an aircraft and set system accordingly.
+  local AA=self.Positionable:IsAir()
+  
+  
+  if AA then
+    System=5 --NOTE: 5 is how you cat the correct tanker behaviour! --BEACON.System.TACAN_TANKER
+    -- Check if "Y" mode is selected for aircraft.
+    if Mode=="X" then
+      --self:E({"WARNING: The POSITIONABLE you want to attach the AA Tacan Beacon is an aircraft: Mode should Y!", self.Positionable})
+      System=BEACON.System.TACAN_TANKER_X
+    else
+      System=BEACON.System.TACAN_TANKER_Y
+    end
+  end
+  
+  -- Attached unit.
+  local UnitID=self.Positionable:GetID()
+  
+  -- Debug.
+  self:I({string.format("BEACON Activating TACAN %s: Channel=%d%s, Morse=%s, Bearing=%s, Duration=%s!", tostring(self.name), Channel, Mode, Message, tostring(Bearing), tostring(Duration))})
+    
+  -- Start beacon.
+  self.Positionable:CommandActivateBeacon(Type, System, Frequency, UnitID, Channel, Mode, AA, Message, Bearing)
+      
+  -- Stop scheduler.
+  if Duration then
+    self.Positionable:DeactivateBeacon(Duration)
+  end
+  
+  return self
+end
+
+--- Activates an ICLS BEACON. The unit the BEACON is attached to should be an aircraft carrier supporting this system.
+-- @param #BEACON self
+-- @param #number Channel ICLS channel.
+-- @param #string Callsign The Message that is going to be coded in Morse and broadcasted by the beacon.
+-- @param #number Duration How long will the beacon last in seconds. Omit for forever.
+-- @return #BEACON self
+function BEACON:ActivateICLS(Channel, Callsign, Duration)
+  self:F({Channel=Channel, Callsign=Callsign, Duration=Duration})
+  
+  -- Attached unit.
+  local UnitID=self.Positionable:GetID()
+  
+  -- Debug
+  self:T2({"ICLS BEACON started!"})
+    
+  -- Start beacon.
+  self.Positionable:CommandActivateICLS(Channel, UnitID, Callsign)
+      
+  -- Stop scheduler
+  if Duration then -- Schedule the stop of the BEACON if asked by the MD
+    self.Positionable:DeactivateBeacon(Duration)
+  end
+  
+  return self
+end
+
+--- Activates a LINK4 BEACON. The unit the BEACON is attached to should be an aircraft carrier supporting this system.
+-- @param #BEACON self
+-- @param #number Frequency LINK4 FRequency in MHz, eg 336.
+-- @param #string Morse The ID that is going to be coded in Morse and broadcasted by the beacon.
+-- @param #number Duration How long will the beacon last in seconds. Omit for forever.
+-- @return #BEACON self
+function BEACON:ActivateLink4(Frequency, Morse, Duration)
+  self:F({Frequency=Frequency, Morse=Morse, Duration=Duration})
+  
+  -- Attached unit.
+  local UnitID=self.Positionable:GetID()
+  
+  -- Debug
+  self:T2({"LINK4 BEACON started!"})
+    
+  -- Start beacon.
+  self.Positionable:CommandActivateLink4(Frequency,UnitID,Morse)
+      
+  -- Stop sheduler
+  if Duration then -- Schedule the stop of the BEACON if asked by the MD
+    self.Positionable:CommandDeactivateLink4(Duration)
+  end
+  
+  return self
+end
+
+--- DEPRECATED: Please use @{BEACON:ActivateTACAN}() instead.
+-- Activates a TACAN BEACON on an Aircraft.
+-- @param #BEACON self
+-- @param #number TACANChannel (the "10" part in "10Y"). Note that AA TACAN are only available on Y Channels
+-- @param #string Message The Message that is going to be coded in Morse and broadcasted by the beacon
+-- @param #boolean Bearing Can the BEACON be homed on ?
+-- @param #number BeaconDuration How long will the beacon last in seconds. Omit for forever.
+-- @return #BEACON self
+-- @usage
+-- -- Let's create a TACAN Beacon for a tanker
+-- local myUnit = UNIT:FindByName("MyUnit") 
+-- local myBeacon = myUnit:GetBeacon() -- Creates the beacon
+-- 
+-- myBeacon:AATACAN(20, "TEXACO", true) -- Activate the beacon
+function BEACON:AATACAN(TACANChannel, Message, Bearing, BeaconDuration)
+  self:F({TACANChannel, Message, Bearing, BeaconDuration})
+  
+  local IsValid = true
+  
+  if not self.Positionable:IsAir() then
+    self:E({"The POSITIONABLE you want to attach the AA Tacan Beacon is not an aircraft ! The BEACON is not emitting", self.Positionable})
+    IsValid = false
+  end
+    
+  local Frequency = self:_TACANToFrequency(TACANChannel, "Y")
+  if not Frequency then 
+    self:E({"The passed TACAN channel is invalid, the BEACON is not emitting"})
+    IsValid = false
+  end
+  
+  -- I'm using the beacon type 4 (BEACON_TYPE_TACAN). For System, I'm using 5 (TACAN_TANKER_MODE_Y) if the bearing shows its bearing or 14 (TACAN_AA_MODE_Y) if it does not
+  local System
+  if Bearing then
+    System = BEACON.System.TACAN_TANKER_Y
+  else
+    System = BEACON.System.TACAN_AA_MODE_Y
+  end
+  
+  if IsValid then -- Starts the BEACON
+    self:T2({"AA TACAN BEACON started !"})
+    self.Positionable:SetCommand({
+      id = "ActivateBeacon",
+      params = {
+        type = BEACON.Type.TACAN,
+        system = System,
+        callsign = Message,
+        AA = true,
+        frequency = Frequency,
+        bearing = Bearing,
+        modeChannel = "Y",
+        }
+      })
+      
+    if BeaconDuration then -- Schedule the stop of the BEACON if asked by the MD
+      SCHEDULER:New(nil, 
+      function()
+        self:StopAATACAN()
+      end, {}, BeaconDuration)
+    end
+  end
+  
+  return self
+end
+
+--- Stops the AA TACAN BEACON
+-- @param #BEACON self
+-- @return #BEACON self
+function BEACON:StopAATACAN()
+  self:F()
+  if not self.Positionable then
+    self:E({"Start the beacon first before stoping it !"})
+  else
+    self.Positionable:SetCommand({
+      id = 'DeactivateBeacon', 
+        params = { 
+      } 
+    })
+  end
+end
+
+
+--- Activates a general purpose Radio Beacon
+-- This uses the very generic singleton function "trigger.action.radioTransmission()" provided by DCS to broadcast a sound file on a specific frequency.
+-- Although any frequency could be used, only a few DCS Modules can home on radio beacons at the time of writing, i.e. the Mi-8, Huey, Gazelle etc.
+-- The following e.g. can home in on these specific frequencies : 
+-- * **Mi8**
+-- * R-828 -> 20-60MHz
+-- * ARKUD -> 100-150MHz (canal 1 : 114166, canal 2 : 114333, canal 3 : 114583, canal 4 : 121500, canal 5 : 123100, canal 6 : 124100) AM
+-- * ARK9 -> 150-1300KHz
+-- * **Huey**
+-- * AN/ARC-131 -> 30-76 Mhz FM
+-- @param #BEACON self
+-- @param #string FileName The name of the audio file
+-- @param #number Frequency in MHz
+-- @param #number Modulation either radio.modulation.AM or radio.modulation.FM
+-- @param #number Power in W
+-- @param #number BeaconDuration How long will the beacon last in seconds. Omit for forever.
+-- @return #BEACON self
+-- @usage
+-- -- Let's create a beacon for a unit in distress.
+-- -- Frequency will be 40MHz FM (home-able by a Huey's AN/ARC-131)
+-- -- The beacon they use is battery-powered, and only lasts for 5 min
+-- local UnitInDistress = UNIT:FindByName("Unit1")
+-- local UnitBeacon = UnitInDistress:GetBeacon()
+-- 
+-- -- Set the beacon and start it
+-- UnitBeacon:RadioBeacon("MySoundFileSOS.ogg", 40, radio.modulation.FM, 20, 5*60)
+function BEACON:RadioBeacon(FileName, Frequency, Modulation, Power, BeaconDuration)
+  self:F({FileName, Frequency, Modulation, Power, BeaconDuration})
+  local IsValid = false
+  
+  -- Check the filename
+  if type(FileName) == "string" then
+    if FileName:find(".ogg") or FileName:find(".wav") then
+      if not FileName:find("l10n/DEFAULT/") then
+        FileName = "l10n/DEFAULT/" .. FileName
+      end
+      IsValid = true
+    end
+  end
+  if not IsValid then
+    self:E({"File name invalid. Maybe something wrong with the extension ? ", FileName})
+  end
+  
+  -- Check the Frequency
+  if type(Frequency) ~= "number" and IsValid then
+    self:E({"Frequency invalid. ", Frequency})
+    IsValid = false
+  end
+  Frequency = Frequency * 1000000 -- Conversion to Hz
+  
+  -- Check the modulation
+  if Modulation ~= radio.modulation.AM and Modulation ~= radio.modulation.FM and IsValid then --TODO Maybe make this future proof if ED decides to add an other modulation ?
+    self:E({"Modulation is invalid. Use DCS's enum radio.modulation.", Modulation})
+    IsValid = false
+  end
+  
+  -- Check the Power
+  if type(Power) ~= "number" and IsValid then
+    self:E({"Power is invalid. ", Power})
+    IsValid = false
+  end
+  Power = math.floor(math.abs(Power)) --TODO Find what is the maximum power allowed by DCS and limit power to that
+  
+  if IsValid then
+    self:T2({"Activating Beacon on ", Frequency, Modulation})
+    -- Note that this is looped. I have to give this transmission a unique name, I use the class ID
+    trigger.action.radioTransmission(FileName, self.Positionable:GetPositionVec3(), Modulation, true, Frequency, Power, tostring(self.ID))
+    
+     if BeaconDuration then -- Schedule the stop of the BEACON if asked by the MD
+       SCHEDULER:New( nil, 
+         function()
+           self:StopRadioBeacon()
+         end, {}, BeaconDuration)
+     end
+  end 
+end
+
+--- Stops the Radio Beacon
+-- @param #BEACON self
+-- @return #BEACON self
+function BEACON:StopRadioBeacon()
+  self:F()
+  -- The unique name of the transmission is the class ID
+  trigger.action.stopRadioTransmission(tostring(self.ID))
+  return self
+end
+
+--- Converts a TACAN Channel/Mode couple into a frequency in Hz
+-- @param #BEACON self
+-- @param #number TACANChannel
+-- @param #string TACANMode
+-- @return #number Frequecy
+-- @return #nil if parameters are invalid
+function BEACON:_TACANToFrequency(TACANChannel, TACANMode)
+  self:F3({TACANChannel, TACANMode})
+
+  if type(TACANChannel) ~= "number" then
+    if TACANMode ~= "X" and TACANMode ~= "Y" then
+      return nil -- error in arguments
+    end
+  end
+  
+-- This code is largely based on ED's code, in DCS World\Scripts\World\Radio\BeaconTypes.lua, line 137.
+-- I have no idea what it does but it seems to work
+  local A = 1151 -- 'X', channel >= 64
+  local B = 64   -- channel >= 64
+  
+  if TACANChannel < 64 then
+    B = 1
+  end
+  
+  if TACANMode == 'Y' then
+    A = 1025
+    if TACANChannel < 64 then
+      A = 1088
+    end
+  else -- 'X'
+    if TACANChannel < 64 then
+      A = 962
+    end
+  end
+  
+  return (A + TACANChannel - B) * 1000000
+end

Moose Development/Moose/Core/Condition.lua

@@ -0,0 +1,295 @@
+--- **Core** - Define any or all conditions to be evaluated.
+--
+-- **Main Features:**
+--
+--    * Add arbitrary numbers of conditon functions
+--    * Evaluate *any* or *all* conditions
+--
+-- ===
+--
+-- ## Example Missions:
+--
+-- Demo missions can be found on [github](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/OPS%20-%20Operation).
+--
+-- ===
+--
+-- ### Author: **funkyfranky**
+--
+-- ===
+-- @module Core.Condition
+-- @image Core_Conditon.png
+
+--- CONDITON class.
+-- @type CONDITION
+-- @field #string ClassName Name of the class.
+-- @field #string lid Class id string for output to DCS log file.
+-- @field #boolean isAny General functions are evaluated as any condition.
+-- @field #boolean negateResult Negeate result of evaluation.
+-- @field #table functionsGen General condition functions.
+-- @field #table functionsAny Any condition functions.
+-- @field #table functionsAll All condition functions.
+-- 
+-- @extends Core.Base#BASE
+
+--- *Better three hours too soon than a minute too late.* - William Shakespeare
+--
+-- ===
+--
+-- # The CONDITION Concept
+-- 
+-- 
+--
+-- @field #CONDITION
+CONDITION = {
+  ClassName      = "CONDITION",
+  lid            =   nil,
+  functionsGen   =    {},
+  functionsAny   =    {},
+  functionsAll   =    {},
+}
+
+--- Condition function.
+-- @type CONDITION.Function
+-- @field #function func Callback function to check for a condition. Should return a `#boolean`.
+-- @field #table arg (Optional) Arguments passed to the condition callback function if any.
+
+--- CONDITION class version.
+-- @field #string version
+CONDITION.version="0.1.0"
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- TODO list
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+-- TODO: Make FSM.
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- Constructor
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+--- Create a new CONDITION object.
+-- @param #CONDITION self
+-- @param #string Name (Optional) Name used in the logs. 
+-- @return #CONDITION self
+function CONDITION:New(Name)
+
+  -- Inherit BASE.
+  local self=BASE:Inherit(self, BASE:New()) --#CONDITION
+  
+  self.name=Name or "Condition X"
+  
+  self.lid=string.format("%s | ", self.name)
+
+  return self
+end
+
+--- Set that general condition functions return `true` if `any` function returns `true`. Default is that *all* functions must return `true`.
+-- @param #CONDITION self
+-- @param #boolean Any If `true`, *any* condition can be true. Else *all* conditions must result `true`.
+-- @return #CONDITION self
+function CONDITION:SetAny(Any)
+  self.isAny=Any
+  return self
+end
+
+--- Negate result.
+-- @param #CONDITION self
+-- @param #boolean Negate If `true`, result is negated else  not.
+-- @return #CONDITION self
+function CONDITION:SetNegateResult(Negate)
+  self.negateResult=Negate
+  return self
+end
+
+--- Add a function that is evaluated. It must return a `#boolean` value, *i.e.* either `true` or `false` (or `nil`).
+-- @param #CONDITION self
+-- @param #function Function The function to call.
+-- @param ... (Optional) Parameters passed to the function (if any).
+-- 
+-- @usage
+-- local function isAequalB(a, b)
+--   return a==b
+-- end
+-- 
+-- myCondition:AddFunction(isAequalB, a, b)
+-- 
+-- @return #CONDITION self
+function CONDITION:AddFunction(Function, ...)
+
+  -- Condition function.
+  local condition=self:_CreateCondition(Function, ...)
+
+  -- Add to table.
+  table.insert(self.functionsGen, condition)
+
+  return self
+end
+
+--- Add a function that is evaluated. It must return a `#boolean` value, *i.e.* either `true` or `false` (or `nil`).
+-- @param #CONDITION self
+-- @param #function Function The function to call.
+-- @param ... (Optional) Parameters passed to the function (if any).
+-- @return #CONDITION self
+function CONDITION:AddFunctionAny(Function, ...)
+
+  -- Condition function.
+  local condition=self:_CreateCondition(Function, ...)
+
+  -- Add to table.
+  table.insert(self.functionsAny, condition)
+
+  return self
+end
+
+--- Add a function that is evaluated. It must return a `#boolean` value, *i.e.* either `true` or `false` (or `nil`).
+-- @param #CONDITION self
+-- @param #function Function The function to call.
+-- @param ... (Optional) Parameters passed to the function (if any).
+-- @return #CONDITION self
+function CONDITION:AddFunctionAll(Function, ...)
+
+  -- Condition function.
+  local condition=self:_CreateCondition(Function, ...)
+
+  -- Add to table.
+  table.insert(self.functionsAll, condition)
+
+  return self
+end
+
+
+--- Evaluate conditon functions.
+-- @param #CONDITION self
+-- @param #boolean AnyTrue If `true`, evaluation return `true` if *any* condition function returns `true`. By default, *all* condition functions must return true.
+-- @return #boolean Result of condition functions.
+function CONDITION:Evaluate(AnyTrue)
+
+  -- Check if at least one function was given.
+  if #self.functionsAll + #self.functionsAny + #self.functionsAll == 0 then
+    if self.negateResult then
+      return true
+    else
+      return false
+    end
+  end
+
+  -- Any condition for gen.
+  local evalAny=self.isAny
+  if AnyTrue~=nil then
+    evalAny=AnyTrue
+  end
+  
+  local isGen=nil
+  if evalAny then
+    isGen=self:_EvalConditionsAny(self.functionsGen)
+  else
+    isGen=self:_EvalConditionsAll(self.functionsGen)
+  end
+  
+  -- Is any?
+  local isAny=self:_EvalConditionsAny(self.functionsAny)
+  
+  -- Is all?
+  local isAll=self:_EvalConditionsAll(self.functionsAll)
+  
+  -- Result.
+  local result=isGen and isAny and isAll
+  
+  -- Negate result.
+  if self.negateResult then
+    result=not result
+  end
+  
+  -- Debug message.
+  self:T(self.lid..string.format("Evaluate: isGen=%s, isAny=%s, isAll=%s (negate=%s) ==> result=%s", tostring(isGen), tostring(isAny), tostring(isAll), tostring(self.negateResult), tostring(result)))
+
+  return result
+end
+
+--- Check if all given condition are true.
+-- @param #CONDITION self
+-- @param #table functions Functions to evaluate.
+-- @return #boolean If true, all conditions were true (or functions was empty/nil). Returns false if at least one condition returned false.
+function CONDITION:_EvalConditionsAll(functions)
+
+  -- At least one condition?
+  local gotone=false
+
+
+  -- Any stop condition must be true.
+  for _,_condition in pairs(functions or {}) do
+    local condition=_condition --#CONDITION.Function
+
+    -- At least one condition was defined.
+    gotone=true
+
+    -- Call function.
+    local istrue=condition.func(unpack(condition.arg))
+
+    -- Any false will return false.
+    if not istrue then
+      return false
+    end
+
+  end
+  
+  -- All conditions were true.
+  return true
+end
+
+
+--- Check if any of the given conditions is true.
+-- @param #CONDITION self
+-- @param #table functions Functions to evaluate.
+-- @return #boolean If true, at least one condition is true (or functions was emtpy/nil).
+function CONDITION:_EvalConditionsAny(functions)
+
+  -- At least one condition?
+  local gotone=false
+
+  -- Any stop condition must be true.
+  for _,_condition in pairs(functions or {}) do
+    local condition=_condition --#CONDITION.Function
+    
+    -- At least one condition was defined.
+    gotone=true
+
+    -- Call function.
+    local istrue=condition.func(unpack(condition.arg))
+
+    -- Any true will return true.
+    if istrue then
+      return true
+    end
+
+  end
+  
+  -- No condition was true.
+  if gotone then
+    return false
+  else
+    -- No functions passed.
+    return true
+  end
+end
+
+--- Create conditon function object.
+-- @param #CONDITION self
+-- @param #function Function The function to call.
+-- @param ... (Optional) Parameters passed to the function (if any).
+-- @return #CONDITION.Function Condition function.
+function CONDITION:_CreateCondition(Function, ...)
+
+  local condition={} --#CONDITION.Function
+
+  condition.func=Function
+  condition.arg={}
+  if arg then
+    condition.arg=arg
+  end
+  
+  return condition
+end
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Moose Development/Moose/Core/Database.lua

@@ -124,6 +124,7 @@ function DATABASE:New()
   self:HandleEvent( EVENTS.Dead, self._EventOnDeadOrCrash )
   self:HandleEvent( EVENTS.Crash, self._EventOnDeadOrCrash )
   self:HandleEvent( EVENTS.RemoveUnit, self._EventOnDeadOrCrash )
+  --self:HandleEvent( EVENTS.UnitLost, self._EventOnDeadOrCrash )  -- DCS 2.7.1 for Aerial units no dead event ATM
   self:HandleEvent( EVENTS.Hit, self.AccountHits )
   self:HandleEvent( EVENTS.NewCargo )
   self:HandleEvent( EVENTS.DeleteCargo )
@@ -136,8 +137,8 @@ function DATABASE:New()
   self:_RegisterGroupsAndUnits()
   self:_RegisterClients()
   self:_RegisterStatics()
-  self:_RegisterAirbases()
   --self:_RegisterPlayers()
+  --self:_RegisterAirbases()
 
   self.UNITS_Position = 0
 
@@ -162,17 +163,11 @@ end
 function DATABASE:AddUnit( DCSUnitName )
 
   if not self.UNITS[DCSUnitName] then
-  
     -- Debug info.
     self:T( { "Add UNIT:", DCSUnitName } )
 
-    --local UnitRegister = UNIT:Register( DCSUnitName )
-    
     -- Register unit
     self.UNITS[DCSUnitName]=UNIT:Register(DCSUnitName)
-
-    -- This is not used anywhere in MOOSE as far as I can see so I remove it until there comes an error somewhere.
-    --table.insert(self.UNITS_Index, DCSUnitName )
   end
 
   return self.UNITS[DCSUnitName]
@@ -182,7 +177,6 @@ end
 --- Deletes a Unit from the DATABASE based on the Unit Name.
 -- @param #DATABASE self
 function DATABASE:DeleteUnit( DCSUnitName )
-
   self.UNITS[DCSUnitName] = nil
 end
 
@@ -217,16 +211,6 @@ function DATABASE:FindStatic( StaticName )
   return StaticFound
 end
 
---- Finds a AIRBASE based on the AirbaseName.
--- @param #DATABASE self
--- @param #string AirbaseName
--- @return Wrapper.Airbase#AIRBASE The found AIRBASE.
-function DATABASE:FindAirbase( AirbaseName )
-
-  local AirbaseFound = self.AIRBASES[AirbaseName]
-  return AirbaseFound
-end
-
 --- Adds a Airbase based on the Airbase Name in the DATABASE.
 -- @param #DATABASE self
 -- @param #string AirbaseName The name of the airbase.
@@ -298,24 +282,92 @@ do -- Zones
   -- @return #DATABASE self
   function DATABASE:_RegisterZones()
 
-    for ZoneID, ZoneData in pairs( env.mission.triggers.zones ) do
+    for ZoneID, ZoneData in pairs(env.mission.triggers.zones) do
       local ZoneName = ZoneData.name
 
-      self:I( { "Register ZONE:", Name = ZoneName } )
+      -- Color
-      local Zone = ZONE:New( ZoneName )
+      local color=ZoneData.color or {1, 0, 0, 0.15}
-      self.ZONENAMES[ZoneName] = ZoneName
+
-      self:AddZone( ZoneName, Zone )
+      -- Create new Zone
+      local Zone=nil   --Core.Zone#ZONE_BASE
+
+      if ZoneData.type==0 then
+
+        ---
+        -- Circular zone
+        ---
+
+        self:I(string.format("Register ZONE: %s (Circular)", ZoneName))
+
+        Zone=ZONE:New(ZoneName)
+
+      else
+
+        ---
+        -- Quad-point zone
+        ---
+
+        self:I(string.format("Register ZONE: %s (Polygon, Quad)", ZoneName))
+
+        Zone=ZONE_POLYGON_BASE:New(ZoneName, ZoneData.verticies)
+
+        --for i,vec2 in pairs(ZoneData.verticies) do
+        --  local coord=COORDINATE:NewFromVec2(vec2)
+        --  coord:MarkToAll(string.format("%s Point %d", ZoneName, i))
+        --end
+
+      end
+
+      if Zone then
+
+        -- Store color of zone.
+        Zone.Color=color
+        
+        -- Store zone ID.
+        Zone.ZoneID=ZoneData.zoneId
+
+        -- Store zone properties (if any)
+        local ZoneProperties = ZoneData.properties or nil
+        Zone.Properties = {}
+        if ZoneName and ZoneProperties then
+          for _,ZoneProp in ipairs(ZoneProperties) do
+            if ZoneProp.key then
+              Zone.Properties[ZoneProp.key] = ZoneProp.value
+            end
+          end
+        end
+
+        -- Store in DB.
+        self.ZONENAMES[ZoneName] = ZoneName
+
+        -- Add zone.
+        self:AddZone(ZoneName, Zone)
+
+      end
+
     end
 
+    -- Polygon zones defined by late activated groups.
     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 } )
+        -- Debug output
+        self:I(string.format("Register ZONE: %s (Polygon)", ZoneName))
+
+        -- Create a new polygon zone.
         local Zone_Polygon = ZONE_POLYGON:New( ZoneName, ZoneGroup )
+
+        -- Set color.
+        Zone_Polygon:SetColor({1, 0, 0}, 0.15)
+
+        -- Store name in DB.
         self.ZONENAMES[ZoneName] = ZoneName
+
+        -- Add zone to DB.
         self:AddZone( ZoneName, Zone_Polygon )
       end
     end
@@ -724,7 +776,9 @@ function DATABASE:_RegisterStaticTemplate( StaticTemplate, CoalitionID, Category
 
   local StaticTemplate = UTILS.DeepCopy( StaticTemplate )
 
-  local StaticTemplateName = env.getValueDictByKey(StaticTemplate.name)
+  local StaticTemplateGroupName = env.getValueDictByKey(StaticTemplate.name)
+  
+  local StaticTemplateName=StaticTemplate.units[1].name
 
   self.Templates.Statics[StaticTemplateName] = self.Templates.Statics[StaticTemplateName] or {}
 
@@ -732,7 +786,7 @@ function DATABASE:_RegisterStaticTemplate( StaticTemplate, CoalitionID, Category
   StaticTemplate.CoalitionID = CoalitionID
   StaticTemplate.CountryID = CountryID
 
-  self.Templates.Statics[StaticTemplateName].StaticName = StaticTemplateName
+  self.Templates.Statics[StaticTemplateName].StaticName = StaticTemplateGroupName
   self.Templates.Statics[StaticTemplateName].GroupTemplate = StaticTemplate
   self.Templates.Statics[StaticTemplateName].UnitTemplate = StaticTemplate.units[1]
   self.Templates.Statics[StaticTemplateName].CategoryID = CategoryID
@@ -806,6 +860,20 @@ function DATABASE:GetGroupTemplateFromUnitName( UnitName )
   end
 end
 
+--- Get group template from unit name.
+-- @param #DATABASE self
+-- @param #string UnitName Name of the unit.
+-- @return #table Group template.
+function DATABASE:GetUnitTemplateFromUnitName( UnitName )
+  if self.Templates.Units[UnitName] then
+    return self.Templates.Units[UnitName]
+  else
+    self:E("ERROR: Unit template does not exist for unit "..tostring(UnitName))
+    return nil
+  end
+end
+
+
 --- Get coalition ID from client name.
 -- @param #DATABASE self
 -- @param #string ClientName Name of the Client.
@@ -922,13 +990,15 @@ function DATABASE:_RegisterClients()
 
   for ClientName, ClientTemplate in pairs( self.Templates.ClientsByName ) do
     self:I(string.format("Register Client: %s", tostring(ClientName)))
-    self:AddClient( ClientName )
+    local client=self:AddClient( ClientName )
+    client.SpawnCoord=COORDINATE:New(ClientTemplate.x, ClientTemplate.alt, ClientTemplate.y)    
   end
 
   return self
 end
 
---- @param #DATABASE self
+--- Private method that registeres all static objects.
+-- @param #DATABASE self
 function DATABASE:_RegisterStatics()
 
   local CoalitionsData={GroupsRed=coalition.getStaticObjects(coalition.side.RED), GroupsBlue=coalition.getStaticObjects(coalition.side.BLUE), GroupsNeutral=coalition.getStaticObjects(coalition.side.NEUTRAL)}
@@ -970,7 +1040,7 @@ function DATABASE:_RegisterAirbases()
     local airbaseUID=airbase:GetID(true)
 
     -- Debug output.
-    local text=string.format("Register %s: %s (ID=%d UID=%d), parking=%d [", AIRBASE.CategoryName[airbase.category], tostring(DCSAirbaseName), airbaseID, airbaseUID, airbase.NparkingTotal)
+    local text=string.format("Register %s: %s (UID=%d), Runways=%d, Parking=%d [", AIRBASE.CategoryName[airbase.category], tostring(DCSAirbaseName), airbaseUID, #airbase.runways, airbase.NparkingTotal)
     for _,terminalType in pairs(AIRBASE.TerminalType) do
       if airbase.NparkingTerminal and airbase.NparkingTerminal[terminalType] then
         text=text..string.format("%d=%d ", terminalType, airbase.NparkingTerminal[terminalType])
@@ -979,11 +1049,6 @@ function DATABASE:_RegisterAirbases()
     text=text.."]"
     self:I(text)
 
-    -- Check for DCS bug IDs.
-    if airbaseID~=airbase:GetID() then
-      --self:E("WARNING: :getID does NOT match :GetID!")
-    end    
-    
   end
 
   return self
@@ -1089,6 +1154,22 @@ function DATABASE:_EventOnDeadOrCrash( Event )
         self:DeleteStatic( Event.IniDCSUnitName )
       end
       
+      ---
+      -- Maybe a UNIT?
+      ---
+      
+      -- Delete unit.
+      if self.UNITS[Event.IniDCSUnitName] then
+        self:T("STATIC Event for UNIT "..tostring(Event.IniDCSUnitName))
+        local DCSUnit = _DATABASE:FindUnit( Event.IniDCSUnitName )
+        self:T({DCSUnit})
+        if DCSUnit then
+          --self:I("Creating DEAD Event for UNIT "..tostring(Event.IniDCSUnitName))
+          --DCSUnit:Destroy(true)
+          return
+        end
+      end
+
     else
 
       if Event.IniObjectCategory == 1 then
@@ -1420,19 +1501,19 @@ function DATABASE:SetPlayerSettings( PlayerName, Settings )
   self.PLAYERSETTINGS[PlayerName] = Settings
 end
 
---- Add a flight group to the data base.
+--- Add an OPS group (FLIGHTGROUP, ARMYGROUP, NAVYGROUP) to the data base.
 -- @param #DATABASE self
--- @param Ops.FlightGroup#FLIGHTGROUP flightgroup
+-- @param Ops.OpsGroup#OPSGROUP opsgroup The OPS group added to the DB.
-function DATABASE:AddFlightGroup(flightgroup)
+function DATABASE:AddOpsGroup(opsgroup)
-  self:I({NewFlightGroup=flightgroup.groupname})
+  --env.info("Adding OPSGROUP "..tostring(opsgroup.groupname))
-  self.FLIGHTGROUPS[flightgroup.groupname]=flightgroup
+  self.FLIGHTGROUPS[opsgroup.groupname]=opsgroup
 end
 
---- Get a flight group from the data base.
+--- Get an OPS group (FLIGHTGROUP, ARMYGROUP, NAVYGROUP) from the data base.
 -- @param #DATABASE self
--- @param #string groupname Group name of the flight group. Can also be passed as GROUP object.
+-- @param #string groupname Group name of the group. Can also be passed as GROUP object.
--- @return Ops.FlightGroup#FLIGHTGROUP Flight group object.
+-- @return Ops.OpsGroup#OPSGROUP OPS group object.
-function DATABASE:GetFlightGroup(groupname)
+function DATABASE:GetOpsGroup(groupname)
 
   -- Get group and group name.
   if type(groupname)=="string" then
@@ -1440,9 +1521,53 @@ function DATABASE:GetFlightGroup(groupname)
     groupname=groupname:GetName()
   end
 
+  --env.info("Getting OPSGROUP "..tostring(groupname))
   return self.FLIGHTGROUPS[groupname]
 end
 
+--- Find an OPSGROUP (FLIGHTGROUP, ARMYGROUP, NAVYGROUP) in the data base.
+-- @param #DATABASE self
+-- @param #string groupname Group name of the group. Can also be passed as GROUP object.
+-- @return Ops.OpsGroup#OPSGROUP OPS group object.
+function DATABASE:FindOpsGroup(groupname)
+
+  -- Get group and group name.
+  if type(groupname)=="string" then
+  else
+    groupname=groupname:GetName()
+  end
+
+  --env.info("Getting OPSGROUP "..tostring(groupname))
+  return self.FLIGHTGROUPS[groupname]
+end
+
+--- Find an OPSGROUP (FLIGHTGROUP, ARMYGROUP, NAVYGROUP) in the data base for a given unit.
+-- @param #DATABASE self
+-- @param #string unitname Unit name. Can also be passed as UNIT object.
+-- @return Ops.OpsGroup#OPSGROUP OPS group object.
+function DATABASE:FindOpsGroupFromUnit(unitname)
+
+  local unit=nil --Wrapper.Unit#UNIT
+  local groupname
+
+  -- Get group and group name.
+  if type(unitname)=="string" then
+    unit=UNIT:FindByName(unitname)
+  else
+    unit=unitname
+  end
+  
+  if unit then
+    groupname=unit:GetGroup():GetName()
+  end
+  
+  if groupname then
+    return self.FLIGHTGROUPS[groupname]
+  else
+    return nil
+  end
+end
+
 --- Add a flight control to the data base.
 -- @param #DATABASE self
 -- @param Ops.FlightControl#FLIGHTCONTROL flightcontrol

Moose Development/Moose/Core/Event.lua

@@ -14,7 +14,7 @@
 -- ![Objects](..\Presentations\EVENT\Dia2.JPG)
 --
 -- Within a running mission, various DCS events occur. Units are dynamically created, crash, die, shoot stuff, get hit etc.
--- This module provides a mechanism to dispatch those events occuring within your running mission, to the different objects orchestrating your mission.
+-- This module provides a mechanism to dispatch those events occurring within your running mission, to the different objects orchestrating your mission.
 --
 -- ![Objects](..\Presentations\EVENT\Dia3.JPG)
 --
@@ -32,11 +32,11 @@
 --
 -- ![Objects](..\Presentations\EVENT\Dia5.JPG)
 --
--- There are 5 levels of kind of objects that the _EVENTDISPATCHER services:
+-- There are 5 types/levels of objects that the _EVENTDISPATCHER services:
 --
 --  * _DATABASE object: The core of the MOOSE objects. Any object that is created, deleted or updated, is done in this database.
---  * SET_ derived classes: Subsets of the _DATABASE object. These subsets are updated by the _EVENTDISPATCHER as the second priority.
+--  * SET_ derived classes: These are subsets of the _DATABASE object. These subsets are updated by the _EVENTDISPATCHER as the second priority.
---  * UNIT objects: UNIT objects can subscribe to DCS events. Each DCS event will be directly published to teh subscribed UNIT object.
+--  * UNIT objects: UNIT objects can subscribe to DCS events. Each DCS event will be directly published to the subscribed UNIT object.
 --  * GROUP objects: GROUP objects can subscribe to DCS events. Each DCS event will be directly published to the subscribed GROUP object.
 --  * Any other object: Various other objects can subscribe to DCS events. Each DCS event triggered will be published to each subscribed object.
 --
@@ -236,18 +236,25 @@ EVENTS = {
   RemoveUnit =        world.event.S_EVENT_REMOVE_UNIT,
   PlayerEnterAircraft = world.event.S_EVENT_PLAYER_ENTER_AIRCRAFT,
   -- Added with DCS 2.5.6
-  DetailedFailure =   world.event.S_EVENT_DETAILED_FAILURE or -1,  --We set this to -1 for backward compatibility to DCS 2.5.5 and earlier
+  DetailedFailure           = world.event.S_EVENT_DETAILED_FAILURE or -1,  --We set this to -1 for backward compatibility to DCS 2.5.5 and earlier
-  Kill =              world.event.S_EVENT_KILL or -1,
+  Kill                      = world.event.S_EVENT_KILL or -1,
-  Score =             world.event.S_EVENT_SCORE or -1,
+  Score                     = world.event.S_EVENT_SCORE or -1,
-  UnitLost =          world.event.S_EVENT_UNIT_LOST or -1,
+  UnitLost                  = world.event.S_EVENT_UNIT_LOST or -1,
-  LandingAfterEjection = world.event.S_EVENT_LANDING_AFTER_EJECTION or -1,
+  LandingAfterEjection      = world.event.S_EVENT_LANDING_AFTER_EJECTION or -1,
+  -- Added with DCS 2.7.0
+  ParatrooperLanding        = world.event.S_EVENT_PARATROOPER_LENDING or -1,
+  DiscardChairAfterEjection = world.event.S_EVENT_DISCARD_CHAIR_AFTER_EJECTION or -1,
+  WeaponAdd                 = world.event.S_EVENT_WEAPON_ADD or -1,
+  TriggerZone               = world.event.S_EVENT_TRIGGER_ZONE or -1,
+  LandingQualityMark        = world.event.S_EVENT_LANDING_QUALITY_MARK or -1,
+  BDA                       = world.event.S_EVENT_BDA or -1,
 }
 
 --- The Event structure
 -- Note that at the beginning of each field description, there is an indication which field will be populated depending on the object type involved in the Event:
 --
 --   * A (Object.Category.)UNIT : A UNIT object type is involved in the Event.
---   * A (Object.Category.)STATIC : A STATIC object type is involved in the Event.µ
+--   * A (Object.Category.)STATIC : A STATIC object type is involved in the Event.
 --
 -- @type EVENTDATA
 -- @field #number id The identifier of the event.
@@ -522,6 +529,37 @@ local _EVENTMETA = {
      Event = "OnEventLandingAfterEjection",
      Text = "S_EVENT_LANDING_AFTER_EJECTION"
    },
+   -- Added with DCS 2.7.0
+   [EVENTS.ParatrooperLanding] = {
+     Order = 1,
+     Event = "OnEventParatrooperLanding",
+     Text = "S_EVENT_PARATROOPER_LENDING"
+   },
+   [EVENTS.DiscardChairAfterEjection] = {
+     Order = 1,
+     Event = "OnEventDiscardChairAfterEjection",
+     Text = "S_EVENT_DISCARD_CHAIR_AFTER_EJECTION"
+   },
+   [EVENTS.WeaponAdd] = {
+     Order = 1,
+     Event = "OnEventWeaponAdd",
+     Text = "S_EVENT_WEAPON_ADD"
+   },
+   [EVENTS.TriggerZone] = {
+     Order = 1,
+     Event = "OnEventTriggerZone",
+     Text = "S_EVENT_TRIGGER_ZONE"
+   },
+   [EVENTS.LandingQualityMark] = {
+     Order = 1,
+     Event = "OnEventLandingQualityMark",
+     Text = "S_EVENT_LANDING_QUALITYMARK"
+   },
+   [EVENTS.BDA] = {
+     Order = 1,
+     Event = "OnEventBDA",
+     Text = "S_EVENT_BDA"
+   },
 }
 
 
@@ -945,13 +983,12 @@ end
 -- @param #EVENTDATA Event Event data table.
 function EVENT:onEvent( Event )
 
+  --- Function to handle errors.
   local ErrorHandler = function( errmsg )
-
     env.info( "Error in SCHEDULER function:" .. errmsg )
     if BASE.Debug ~= nil then
       env.info( debug.traceback() )
     end
-    
     return errmsg
   end
 
@@ -962,12 +999,9 @@ function EVENT:onEvent( Event )
   -- Check if this is a known event?
   if EventMeta then
 
-    if self and 
+    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
-       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
 
+      -- Check if mission has ended.
       if Event.id and Event.id == EVENTS.MissionEnd then
         self.MissionEnd = true
       end
@@ -976,34 +1010,12 @@ function EVENT:onEvent( Event )
 
         Event.IniObjectCategory = Event.initiator:getCategory()
         
-        if Event.IniObjectCategory == Object.Category.UNIT then
+       if Event.IniObjectCategory == Object.Category.STATIC then
-          Event.IniDCSUnit = Event.initiator
+          ---
-          Event.IniDCSUnitName = Event.IniDCSUnit:getName()
+          -- Static
-          Event.IniUnitName = Event.IniDCSUnitName
+          ---          
-          Event.IniDCSGroup = Event.IniDCSUnit:getGroup()
-          Event.IniUnit = UNIT:FindByName( Event.IniDCSUnitName )
-          if not Event.IniUnit then
-            -- Unit can be a CLIENT. Most likely this will be the case ...
-            Event.IniUnit = CLIENT:FindByName( Event.IniDCSUnitName, '', true )
-          end
-          Event.IniDCSGroupName = ""
-          if Event.IniDCSGroup and Event.IniDCSGroup:isExist() then
-            Event.IniDCSGroupName = Event.IniDCSGroup:getName()
-            Event.IniGroup = GROUP:FindByName( Event.IniDCSGroupName )
-            --if Event.IniGroup then
-              Event.IniGroupName = Event.IniDCSGroupName
-            --end
-          end
-          Event.IniPlayerName = Event.IniDCSUnit:getPlayerName()
-          Event.IniCoalition = Event.IniDCSUnit:getCoalition()
-          Event.IniTypeName = Event.IniDCSUnit:getTypeName()
-          Event.IniCategory = Event.IniDCSUnit:getDesc().category
-        end
-        
-        if Event.IniObjectCategory == Object.Category.STATIC then
           if Event.id==31 then
-            --env.info("FF event 31")
+            -- Event.initiator is a Static object representing the pilot. But getName() errors due to DCS bug.
-            -- Event.initiator is a Static object representing the pilot. But getName() error due to DCS bug.
             Event.IniDCSUnit = Event.initiator
             local ID=Event.initiator.id_
             Event.IniDCSUnitName = string.format("Ejected Pilot ID %s", tostring(ID))
@@ -1011,6 +1023,14 @@ function EVENT:onEvent( Event )
             Event.IniCoalition = 0
             Event.IniCategory  = 0
             Event.IniTypeName = "Ejected Pilot"
+         elseif Event.id == 33 then -- ejection seat discarded
+            Event.IniDCSUnit = Event.initiator
+            local ID=Event.initiator.id_
+            Event.IniDCSUnitName = string.format("Ejection Seat ID %s", tostring(ID))
+            Event.IniUnitName = Event.IniDCSUnitName
+            Event.IniCoalition = 0
+            Event.IniCategory  = 0
+            Event.IniTypeName = "Ejection Seat"
           else
             Event.IniDCSUnit = Event.initiator
             Event.IniDCSUnitName = Event.IniDCSUnit:getName()
@@ -1020,9 +1040,47 @@ function EVENT:onEvent( Event )
             Event.IniCategory = Event.IniDCSUnit:getDesc().category
             Event.IniTypeName = Event.IniDCSUnit:getTypeName()
           end
+          
+          -- Dead events of units can be delayed and the initiator changed to a static.
+          -- Take care of that.
+          local Unit=UNIT:FindByName(Event.IniDCSUnitName)
+          if Unit then
+            Event.IniObjectCategory = Object.Category.UNIT
+          end
+        end        
+
+        if Event.IniObjectCategory == Object.Category.UNIT then
+          ---
+          -- Unit
+          ---        
+          Event.IniDCSUnit = Event.initiator
+          Event.IniDCSUnitName = Event.IniDCSUnit:getName()
+          Event.IniUnitName = Event.IniDCSUnitName
+          Event.IniDCSGroup = Event.IniDCSUnit:getGroup()
+          Event.IniUnit = UNIT:FindByName( Event.IniDCSUnitName )
+          
+          if not Event.IniUnit then
+            -- Unit can be a CLIENT. Most likely this will be the case ...
+            Event.IniUnit = CLIENT:FindByName( Event.IniDCSUnitName, '', true )
+          end
+          
+          Event.IniDCSGroupName = Event.IniUnit and Event.IniUnit.GroupName or ""
+          if Event.IniDCSGroup and Event.IniDCSGroup:isExist() then
+            Event.IniDCSGroupName = Event.IniDCSGroup:getName()
+            Event.IniGroup = GROUP:FindByName( Event.IniDCSGroupName )
+            Event.IniGroupName = Event.IniDCSGroupName
+          end
+          
+          Event.IniPlayerName = Event.IniDCSUnit:getPlayerName()
+          Event.IniCoalition = Event.IniDCSUnit:getCoalition()
+          Event.IniTypeName = Event.IniDCSUnit:getTypeName()
+          Event.IniCategory = Event.IniDCSUnit:getDesc().category  
         end
 
         if Event.IniObjectCategory == Object.Category.CARGO then
+          ---
+          -- Cargo
+          ---
           Event.IniDCSUnit = Event.initiator
           Event.IniDCSUnitName = Event.IniDCSUnit:getName()
           Event.IniUnitName = Event.IniDCSUnitName
@@ -1033,15 +1091,22 @@ function EVENT:onEvent( Event )
         end
 
         if Event.IniObjectCategory == Object.Category.SCENERY then
+          ---
+          -- Scenery
+          ---
+          
           Event.IniDCSUnit = Event.initiator
           Event.IniDCSUnitName = Event.IniDCSUnit:getName()
           Event.IniUnitName = Event.IniDCSUnitName
           Event.IniUnit = SCENERY:Register( Event.IniDCSUnitName, Event.initiator )
           Event.IniCategory = Event.IniDCSUnit:getDesc().category
-          Event.IniTypeName = Event.initiator:isExist() and Event.IniDCSUnit:getTypeName() or "SCENERY" -- TODO: Bug fix for 2.1!
+          Event.IniTypeName = Event.initiator:isExist() and Event.IniDCSUnit:getTypeName() or "SCENERY"
         end
 
         if Event.IniObjectCategory == Object.Category.BASE then
+          ---
+          -- Base Object
+          ---
           Event.IniDCSUnit = Event.initiator
           Event.IniDCSUnitName = Event.IniDCSUnit:getName()
           Event.IniUnitName = Event.IniDCSUnitName
@@ -1054,6 +1119,11 @@ function EVENT:onEvent( Event )
 
       if Event.target then
       
+        ---
+        -- TARGET
+        ---
+
+        -- Target category.
         Event.TgtObjectCategory = Event.target:getCategory()
 
         if Event.TgtObjectCategory == Object.Category.UNIT then
@@ -1066,9 +1136,7 @@ function EVENT:onEvent( Event )
           if Event.TgtDCSGroup and Event.TgtDCSGroup:isExist() then
             Event.TgtDCSGroupName = Event.TgtDCSGroup:getName()
             Event.TgtGroup = GROUP:FindByName( Event.TgtDCSGroupName )
-            --if Event.TgtGroup then
+            Event.TgtGroupName = Event.TgtDCSGroupName
-              Event.TgtGroupName = Event.TgtDCSGroupName
-            --end
           end
           Event.TgtPlayerName = Event.TgtDCSUnit:getPlayerName()
           Event.TgtCoalition = Event.TgtDCSUnit:getCoalition()
@@ -1077,13 +1145,33 @@ function EVENT:onEvent( Event )
         end
 
         if Event.TgtObjectCategory == Object.Category.STATIC then
+          -- get base data
           Event.TgtDCSUnit = Event.target
-          Event.TgtDCSUnitName = Event.TgtDCSUnit:getName()
+          if Event.target:isExist() and Event.id ~= 33 then -- leave out ejected seat object
-          Event.TgtUnitName = Event.TgtDCSUnitName
+            Event.TgtDCSUnitName = Event.TgtDCSUnit:getName()
-          Event.TgtUnit = STATIC:FindByName( Event.TgtDCSUnitName, false )
+            Event.TgtUnitName = Event.TgtDCSUnitName
-          Event.TgtCoalition = Event.TgtDCSUnit:getCoalition()
+            Event.TgtUnit = STATIC:FindByName( Event.TgtDCSUnitName, false )
-          Event.TgtCategory = Event.TgtDCSUnit:getDesc().category
+            Event.TgtCoalition = Event.TgtDCSUnit:getCoalition()
-          Event.TgtTypeName = Event.TgtDCSUnit:getTypeName()
+            Event.TgtCategory = Event.TgtDCSUnit:getDesc().category
+            Event.TgtTypeName = Event.TgtDCSUnit:getTypeName()
+          else
+            Event.TgtDCSUnitName = string.format("No target object for Event ID %s", tostring(Event.id))
+            Event.TgtUnitName = Event.TgtDCSUnitName
+            Event.TgtUnit = nil
+            Event.TgtCoalition = 0
+            Event.TgtCategory = 0
+            if Event.id == 6 then
+              Event.TgtTypeName = "Ejected Pilot"
+              Event.TgtDCSUnitName = string.format("Ejected Pilot ID %s", tostring(Event.IniDCSUnitName))
+              Event.TgtUnitName = Event.TgtDCSUnitName
+            elseif Event.id == 33 then
+              Event.TgtTypeName = "Ejection Seat"
+              Event.TgtDCSUnitName = string.format("Ejection Seat ID %s", tostring(Event.IniDCSUnitName))
+              Event.TgtUnitName = Event.TgtDCSUnitName
+            else
+              Event.TgtTypeName = "Static"
+            end
+          end
         end
 
         if Event.TgtObjectCategory == Object.Category.SCENERY then
@@ -1096,6 +1184,7 @@ function EVENT:onEvent( Event )
         end
       end
 
+      -- Weapon.
       if Event.weapon then
         Event.Weapon = Event.weapon
         Event.WeaponName = Event.Weapon:getTypeName()
@@ -1130,23 +1219,22 @@ function EVENT:onEvent( Event )
         Event.MarkGroupID = Event.groupID
       end
 
+      -- Cargo object.
       if Event.cargo then
         Event.Cargo = Event.cargo
         Event.CargoName = Event.cargo.Name
       end
 
+      -- Zone object.
       if Event.zone then
         Event.Zone = Event.zone
         Event.ZoneName = Event.zone.ZoneName
       end
 
+      -- Priority order.
       local PriorityOrder = EventMeta.Order
       local PriorityBegin = PriorityOrder == -1 and 5 or 1
-      local PriorityEnd = PriorityOrder == -1 and 1 or 5
+      local PriorityEnd   = PriorityOrder == -1 and 1 or 5
-  
-      if Event.IniObjectCategory ~= Object.Category.STATIC then
-        self:F( { EventMeta.Text, Event, Event.IniDCSUnitName, Event.TgtDCSUnitName, PriorityOrder } )
-      end
 
       for EventPriority = PriorityBegin, PriorityEnd, PriorityOrder do
 
@@ -1159,8 +1247,8 @@ function EVENT:onEvent( Event )
             --  self:E( { "Evaluating: ", EventClass:GetClassNameAndID() } )
             --end
 
-            Event.IniGroup = GROUP:FindByName( Event.IniDCSGroupName )
+            Event.IniGroup = Event.IniGroup or GROUP:FindByName( Event.IniDCSGroupName )
-            Event.TgtGroup = GROUP:FindByName( Event.TgtDCSGroupName )
+            Event.TgtGroup = Event.TgtGroup or GROUP:FindByName( Event.TgtDCSGroupName )
 
             -- If the EventData is for a UNIT, the call directly the EventClass EventFunction for that UNIT.
             if EventData.EventUnit then
@@ -1170,7 +1258,8 @@ function EVENT:onEvent( Event )
                  Event.id == EVENTS.PlayerEnterUnit or
                  Event.id == EVENTS.Crash or
                  Event.id == EVENTS.Dead or
-                 Event.id == EVENTS.RemoveUnit then
+                 Event.id == EVENTS.RemoveUnit or
+                 Event.id == EVENTS.UnitLost then
 
                 local UnitName = EventClass:GetName()
 
@@ -1180,10 +1269,6 @@ function EVENT:onEvent( Event )
                   -- First test if a EventFunction is Set, otherwise search for the default function
                   if EventData.EventFunction then
  
-                    if Event.IniObjectCategory ~= 3 then
-                      self:F( { "Calling EventFunction for UNIT ", EventClass:GetClassNameAndID(), ", Unit ", Event.IniUnitName, EventPriority } )
-                    end
-                                    
                     local Result, Value = xpcall(
                       function()
                         return EventData.EventFunction( EventClass, Event )
@@ -1196,15 +1281,12 @@ function EVENT:onEvent( Event )
                     if EventFunction and type( EventFunction ) == "function" then
 
                       -- Now call the default event function.
-                      if Event.IniObjectCategory ~= 3 then
-                        self:F( { "Calling " .. EventMeta.Event .. " for Class ", EventClass:GetClassNameAndID(), EventPriority } )
-                      end
-                                    
                       local Result, Value = xpcall(
                         function()
                           return EventFunction( EventClass, Event )
                         end, ErrorHandler )
                     end
+                    
                   end
                 end
               else
@@ -1222,7 +1304,8 @@ function EVENT:onEvent( Event )
                    Event.id == EVENTS.PlayerEnterUnit or
                    Event.id == EVENTS.Crash or
                    Event.id == EVENTS.Dead or
-                   Event.id == EVENTS.RemoveUnit then
+                   Event.id == EVENTS.RemoveUnit or
+                   Event.id == EVENTS.UnitLost then
 
                   -- We can get the name of the EventClass, which is now always a GROUP object.
                   local GroupName = EventClass:GetName()
@@ -1233,10 +1316,6 @@ function EVENT:onEvent( Event )
                     -- First test if a EventFunction is Set, otherwise search for the default function
                     if EventData.EventFunction then
 
-                      if Event.IniObjectCategory ~= 3 then
-                        self:F( { "Calling EventFunction for GROUP ", EventClass:GetClassNameAndID(), ", Unit ", Event.IniUnitName, EventPriority } )
-                      end
-                                        
                       local Result, Value = xpcall(
                         function()
                           return EventData.EventFunction( EventClass, Event, unpack( EventData.Params ) )
@@ -1249,10 +1328,6 @@ function EVENT:onEvent( Event )
                       if EventFunction and type( EventFunction ) == "function" then
 
                         -- Now call the default event function.
-                        if Event.IniObjectCategory ~= 3 then
-                          self:F( { "Calling " .. EventMeta.Event .. " for GROUP ", EventClass:GetClassNameAndID(), EventPriority } )
-                        end
-                                            
                         local Result, Value = xpcall(
                           function()
                             return EventFunction( EventClass, Event, unpack( EventData.Params ) )
@@ -1274,9 +1349,6 @@ function EVENT:onEvent( Event )
                   if EventData.EventFunction then
 
                     -- There is an EventFunction defined, so call the EventFunction.
-                    if Event.IniObjectCategory ~= 3 then
-                      self:F2( { "Calling EventFunction for Class ", EventClass:GetClassNameAndID(), EventPriority } )
-                    end                
                     local Result, Value = xpcall(
                       function()
                         return EventData.EventFunction( EventClass, Event )
@@ -1288,16 +1360,14 @@ function EVENT:onEvent( Event )
                     if EventFunction and type( EventFunction ) == "function" then
 
                       -- Now call the default event function.
-                      if Event.IniObjectCategory ~= 3 then
-                        self:F2( { "Calling " .. EventMeta.Event .. " for Class ", EventClass:GetClassNameAndID(), EventPriority } )
-                      end
-                                    
                       local Result, Value = xpcall(
                         function()
                           local Result, Value = EventFunction( EventClass, Event )
                           return Result, Value
                         end, ErrorHandler )
+                        
                     end
+                    
                   end
 
                 end

Moose Development/Moose/Core/Fsm.lua

@@ -21,8 +21,8 @@
 -- 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**.
 -- It can change from one state to another when initiated by an **__internal__ or __external__ triggering event**, which is called a **transition**.
--- An **FSM implementation** is defined by **a list of its states**, **its initial state**, and **the triggering events** for **each possible transition**.
+-- A **FSM implementation** is defined by **a list of its states**, **its initial state**, and **the triggering events** for **each possible transition**.
--- An FSM implementation is composed out of **two parts**, a set of **state transition rules**, and an implementation set of **state transition handlers**, implementing those transitions.
+-- A FSM implementation is composed out of **two parts**, a set of **state transition rules**, and an implementation set of **state transition handlers**, implementing those transitions.
 --
 -- The FSM class supports a **hierarchical implementation of a Finite State Machine**,
 -- that is, it allows to **embed existing FSM implementations in a master FSM**.
@@ -34,32 +34,32 @@
 -- orders him to destroy x targets and account the results.
 -- Other examples of ready made FSM could be:
 --
---   * route a plane to a zone flown by a human
+--   * Route a plane to a zone flown by a human.
---   * detect targets by an AI and report to humans
+--   * Detect targets by an AI and report to humans.
---   * account for destroyed targets by human players
+--   * Account for destroyed targets by human players.
---   * handle AI infantry to deploy from or embark to a helicopter or airplane or vehicle 
+--   * Handle AI infantry to deploy from or embark to a helicopter or airplane or vehicle.
---   * let an AI patrol a zone
+--   * Let an AI patrol a zone.
 --
--- The **MOOSE framework** uses extensively the FSM class and derived FSM\_ classes, 
+-- The **MOOSE framework** extensively uses the FSM class and derived FSM\_ classes,
 -- because **the goal of MOOSE is to simplify mission design complexity for mission building**.
 -- By efficiently utilizing the FSM class and derived classes, MOOSE allows mission designers to quickly build processes.
 -- **Ready made FSM-based implementations classes** exist within the MOOSE framework that **can easily be re-used,
 -- and tailored** by mission designers through **the implementation of Transition Handlers**.
 -- Each of these FSM implementation classes start either with:
 --
---   * an acronym **AI\_**, which indicates an FSM implementation directing **AI controlled** @{GROUP} and/or @{UNIT}. These AI\_ classes derive the @{#FSM_CONTROLLABLE} class.
+--   * an acronym **AI\_**, which indicates a FSM implementation directing **AI controlled** @{GROUP} and/or @{UNIT}. These AI\_ classes derive the @{#FSM_CONTROLLABLE} class.
---   * an acronym **TASK\_**, which indicates an FSM implementation executing a @{TASK} executed by Groups of players. These TASK\_ classes derive the @{#FSM_TASK} class.
+--   * an acronym **TASK\_**, which indicates a FSM implementation executing a @{TASK} executed by Groups of players. These TASK\_ classes derive the @{#FSM_TASK} class.
 --   * an acronym **ACT\_**, which indicates an Sub-FSM implementation, directing **Humans actions** that need to be done in a @{TASK}, seated in a @{CLIENT} (slot) or a @{UNIT} (CA join). These ACT\_ classes derive the @{#FSM_PROCESS} class.
 --
 -- Detailed explanations and API specifics are further below clarified and FSM derived class specifics are described in those class documentation sections.
 --
--- ##__Dislaimer:__
+-- ##__Disclaimer:__
 -- The FSM class development is based on a finite state machine implementation made by Conroy Kyle.
 -- The state machine can be found on [github](https://github.com/kyleconroy/lua-state-machine)
 -- I've reworked this development (taken the concept), and created a **hierarchical state machine** out of it, embedded within the DCS simulator.
 -- Additionally, I've added extendability and created an API that allows seamless FSM implementation.
 --
--- The following derived classes are available in the MOOSE framework, that implement a specialised form of a FSM:
+-- The following derived classes are available in the MOOSE framework, that implement a specialized form of a FSM:
 --
 --   * @{#FSM_TASK}: Models Finite State Machines for @{Task}s.
 --   * @{#FSM_PROCESS}: Models Finite State Machines for @{Task} actions, which control @{Client}s.
@@ -69,7 +69,6 @@
 --
 -- ===
 --
--- 
 -- ### Author: **FlightControl**
 -- ### Contributions: **funkyfranky**
 --
@@ -89,7 +88,6 @@ do -- FSM
   -- @field #string current Current state name.
   -- @extends Core.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. 
@@ -145,12 +143,12 @@ do -- FSM
   -- Most of the time, these Event Triggers are used within the Transition Handler methods, so that a workflow is created running through the state machine.
   --
   -- As explained above, a FSM supports **Linear State Transitions** and **Hierarchical State Transitions**, and both can be mixed to make a comprehensive FSM implementation.
-  -- The below documentation has a seperate chapter explaining both transition modes, taking into account the **Transition Rules**, **Transition Handlers** and **Event Triggers**.
+  -- The below documentation has a separate chapter explaining both transition modes, taking into account the **Transition Rules**, **Transition Handlers** and **Event Triggers**.
   --
   -- ## FSM Linear Transitions
   --
   -- Linear Transitions are Transition Rules allowing an FSM to transition from one or multiple possible **From** state(s) towards a **To** state upon a Triggered **Event**.
-  -- The Lineair transition rule evaluation will always be done from the **current state** of the FSM.
+  -- The Linear transition rule evaluation will always be done from the **current state** of the FSM.
   -- If no valid Transition Rule can be found in the FSM, the FSM will log an error and stop.
   --
   -- ### FSM Transition Rules
@@ -185,7 +183,7 @@ do -- FSM
   --    * The From states can be **a table of strings**, indicating that the transition rule will be valid **if the current state** of the FSM will be **one of the given From states**.
   --    * The From state can be a **"*"**, indicating that **the transition rule will always be valid**, regardless of the current state of the FSM.
   --
-  -- The below code snippet shows how the two last lines can be rewritten and consensed.
+  -- The below code snippet shows how the two last lines can be rewritten and condensed.
   --
   --      FsmSwitch:AddTransition( { "On",  "Middle" }, "SwitchOff", "Off" )
   --
@@ -221,7 +219,7 @@ do -- FSM
   --    * The method **FSM:Event()** triggers an Event that will be processed **synchronously** or **immediately**.
   --    * The method **FSM:__Event( __seconds__ )** triggers an Event that will be processed **asynchronously** over time, waiting __x seconds__.
   --
-  -- The destinction between these 2 Event Trigger methods are important to understand. An asynchronous call will "log" the Event Trigger to be executed at a later time.
+  -- The distinction between these 2 Event Trigger methods are important to understand. An asynchronous call will "log" the Event Trigger to be executed at a later time.
   -- Processing will just continue. Synchronous Event Trigger methods are useful to change states of the FSM immediately, but may have a larger processing impact.
   --
   -- The following example provides a little demonstration on the difference between synchronous and asynchronous Event Triggering.
@@ -345,7 +343,6 @@ do -- FSM
   -- ===
   --
   -- @field #FSM
-  -- 
   FSM = {
     ClassName = "FSM",
   }
@@ -379,7 +376,6 @@ do -- FSM
     return self
   end
 
-  
   --- Sets the start state of the FSM.
   -- @param #FSM self
   -- @param #string State A string defining the start state.
@@ -388,7 +384,6 @@ do -- FSM
     self.current = State
   end
 
-  
   --- Returns the start state of the FSM.
   -- @param #FSM self
   -- @return #string A string containing the start state.
@@ -410,13 +405,12 @@ do -- FSM
     Transition.To = To
 
     -- Debug message.
-    self:T2( Transition )
+    --self:T3( Transition )
     
     self._Transitions[Transition] = Transition
     self:_eventmap( self.Events, Transition )
   end
 
-  
   --- Returns a table of the transition rules defined within the FSM.
   -- @param #FSM self
   -- @return #table Transitions.
@@ -432,7 +426,7 @@ do -- FSM
   -- @param #table ReturnEvents A table indicating for which returned events of the SubFSM which Event must be triggered in the FSM.
   -- @return Core.Fsm#FSM_PROCESS The SubFSM.
   function FSM:AddProcess( From, Event, Process, ReturnEvents )
-    self:T( { From, Event } )
+    --self:T3( { From, Event } )
   
     local Sub = {}
     Sub.From = From
@@ -450,7 +444,6 @@ do -- FSM
     return Process
   end
 
-  
   --- Returns a table of the SubFSM rules defined within the FSM.
   -- @param #FSM self
   -- @return #table Sub processes.
@@ -499,7 +492,6 @@ do -- FSM
     return self._EndStates or {}
   end
 
-  
   --- Adds a score for the FSM to be achieved.
   -- @param #FSM self
   -- @param #string State is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).
@@ -533,14 +525,14 @@ do -- FSM
     Process._Scores[State].ScoreText = ScoreText
     Process._Scores[State].Score = Score
     
-    self:T( Process._Scores )
+    --self:T3( Process._Scores )
   
     return Process
   end
 
   --- Returns a table with the scores defined.
   -- @param #FSM self
-  -- @param #table Scores.
+  -- @return #table Scores.
   function FSM:GetScores()
     return self._Scores or {}
   end
@@ -563,7 +555,7 @@ do -- FSM
 
   end
 
-   --- Event map.
+  --- Event map.
   -- @param #FSM self
   -- @param #table Events Events.
   -- @param #table EventStructure Event structure.
@@ -576,14 +568,14 @@ do -- FSM
       self[__Event] = self[__Event] or self:_delayed_transition(Event)
       
       -- Debug message.
-      self:T2( "Added methods: " .. Event .. ", " .. __Event )
+      --self:T3( "Added methods: " .. Event .. ", " .. __Event )
       
       Events[Event] = self.Events[Event] or { map = {} }
       self:_add_to_map( Events[Event].map, EventStructure )
   
   end
 
-   --- Sub maps.
+  --- Sub maps.
   -- @param #FSM self
   -- @param #table subs Subs.
   -- @param #table sub Sub.
@@ -613,7 +605,7 @@ do -- FSM
   -- @param #string EventName Event name.
   -- @return Value.
   function FSM:_call_handler( step, trigger, params, EventName )
-    --env.info(string.format("FF T=%.3f _call_handler step=%s, trigger=%s, event=%s", timer.getTime(), step, trigger, EventName))
+    -- env.info(string.format("FF T=%.3f _call_handler step=%s, trigger=%s, event=%s", timer.getTime(), step, trigger, EventName))
 
     local handler = step .. trigger
 
@@ -644,10 +636,12 @@ do -- FSM
         return errmsg
       end
 
-      --return self[handler](self, unpack( params ))
+      -- return self[handler](self, unpack( params ))
 
       -- Protected call.
-      local Result, Value = xpcall( function() return self[handler]( self, unpack( params ) ) end, ErrorHandler )      
+      local Result, Value = xpcall( function()
+        return self[handler]( self, unpack( params ) )
+      end, ErrorHandler )
       return Value
     end
 
@@ -671,17 +665,16 @@ do -- FSM
       local From = self.current
 
       -- Parameters.
-      local Params = { From, EventName, To, ...  }
+      local Params = { From, EventName, To, ... }
 
-
+      if self["onleave" .. From] or
-      if self["onleave".. From] or
+         self["OnLeave" .. From] or
-         self["OnLeave".. From] or
+         self["onbefore" .. EventName] or
-         self["onbefore".. EventName] or
+         self["OnBefore" .. EventName] or
-         self["OnBefore".. EventName] or
+         self["onafter" .. EventName] or
-         self["onafter".. EventName] or
+         self["OnAfter" .. EventName] or
-         self["OnAfter".. EventName] or
+         self["onenter" .. To] or
-         self["onenter".. To] or
+         self["OnEnter" .. To] then
-         self["OnEnter".. To] then
 
         if self:_call_handler( "onbefore", EventName, Params, EventName ) == false then
           self:T( "*** FSM ***    Cancel" .. " *** " .. self.current .. " --> " .. EventName .. " --> " .. To .. " *** onbefore" .. EventName )
@@ -716,11 +709,11 @@ do -- FSM
         end
 
         if ClassName == "FSM_CONTROLLABLE" then
-          self:T( "*** FSM ***    Transit *** " .. self.current .. " --> " .. EventName .. " --> " .. To .. " *** TaskUnit: " .. self.Controllable.ControllableName .. " *** "  )
+          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 .. " *** "  )
+          self:T( "*** FSM ***    Transit *** " .. self.current .. " --> " .. EventName .. " --> " .. To .. " *** Task: " .. self.Task:GetName() .. ", TaskUnit: " .. self.Controllable.ControllableName .. " *** " )
         end
       end
 
@@ -733,10 +726,10 @@ do -- FSM
 
       for _, sub in pairs( subtable ) do
 
-        --if sub.nextevent then
+        -- if sub.nextevent then
         --  self:F2( "nextevent = " .. sub.nextevent )
         --  self[sub.nextevent]( self )
-        --end
+        -- end
 
         self:T( "*** FSM ***    Sub *** " .. sub.StartEvent )
 
@@ -753,11 +746,11 @@ do -- FSM
 
         self:T( "*** FSM ***    End *** " .. Event )
 
-        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 )
-        self:_call_handler("onafter", EventName, Params, EventName )
+        self:_call_handler( "onafter", EventName, Params, EventName )
-        self:_call_handler("OnAfter", EventName, Params, EventName )
+        self:_call_handler( "OnAfter", EventName, Params, EventName )
-        self:_call_handler("onstate", "change", Params, EventName )
+        self:_call_handler( "onstate", "change", Params, EventName )
 
         fsmparent[Event]( fsmparent )
 
@@ -766,13 +759,13 @@ do -- FSM
 
       if execute then
 
-        self:_call_handler("onafter", EventName, Params, EventName )
+        self:_call_handler( "onafter", EventName, Params, EventName )
-        self:_call_handler("OnAfter", EventName, Params, EventName )
+        self:_call_handler( "OnAfter", EventName, Params, EventName )
 
-        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 )
 
-        self:_call_handler("onstate", "change", Params, EventName )
+        self:_call_handler( "onstate", "change", Params, EventName )
 
       end
     else
@@ -791,7 +784,7 @@ do -- FSM
     return function( self, DelaySeconds, ... )
 
       -- Debug.
-      self:T2( "Delayed Event: " .. EventName )
+      self:T3( "Delayed Event: " .. EventName )
       
       local CallID = 0
       if DelaySeconds ~= nil then
@@ -809,23 +802,23 @@ do -- FSM
             self._EventSchedules[EventName] = CallID
 
             -- Debug output.
-            self:T2(string.format("NEGATIVE Event %s delayed by %.1f sec SCHEDULED with CallID=%s", EventName, DelaySeconds, tostring(CallID)))
+            self:T2(string.format("NEGATIVE Event %s delayed by %.3f sec SCHEDULED with CallID=%s", EventName, DelaySeconds, tostring(CallID)))
           else
-            self:T2(string.format("NEGATIVE Event %s delayed by %.1f sec CANCELLED as we already have such an event in the queue.", EventName, DelaySeconds))
+            self:T2(string.format("NEGATIVE Event %s delayed by %.3f sec CANCELLED as we already have such an event in the queue.", EventName, DelaySeconds))
             -- reschedule
           end
         else
 
           CallID = self.CallScheduler:Schedule( self, self._handler, { EventName, ... }, DelaySeconds or 1, nil, nil, nil, 4, true )
           
-          self:T2(string.format("Event %s delayed by %.1f sec SCHEDULED with CallID=%s", EventName, DelaySeconds, tostring(CallID)))
+          self:T2(string.format("Event %s delayed by %.3f sec SCHEDULED with CallID=%s", EventName, DelaySeconds, tostring(CallID)))
         end
       else
         error( "FSM: An asynchronous event trigger requires a DelaySeconds parameter!!! This can be positive or negative! Sorry, but will not process this." )
       end
 
       -- Debug.
-      self:T2( { CallID = CallID } )
+      --self:T3( { CallID = CallID } )
     end
 
   end
@@ -835,7 +828,9 @@ do -- FSM
   -- @param #string EventName Event name.
   -- @return #function Function.
   function FSM:_create_transition( EventName )
-    return function( self, ... ) return self._handler( self,  EventName , ... ) end
+    return function( self, ... )
+      return self._handler( self, EventName, ... )
+    end
   end
 
   --- Go sub.
@@ -846,7 +841,7 @@ do -- FSM
   function FSM:_gosub( ParentFrom, ParentEvent )
     local fsmtable = {}
     if self.subs[ParentFrom] and self.subs[ParentFrom][ParentEvent] then
-      self:T( { ParentFrom, ParentEvent, self.subs[ParentFrom], self.subs[ParentFrom][ParentEvent] } )
+      --self:T3( { ParentFrom, ParentEvent, self.subs[ParentFrom], self.subs[ParentFrom][ParentEvent] } )
       return self.subs[ParentFrom][ParentEvent]
     else
       return {}
@@ -862,16 +857,16 @@ do -- FSM
     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.ReturnEvents } )
       local Event = self.ReturnEvents[Current]
-      --self:T( { Event } )
+      -- self:T( { Event } )
       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
 
@@ -883,17 +878,17 @@ do -- FSM
   -- @param #table Map Map.
   -- @param #table Event Event table.
   function FSM:_add_to_map( Map, Event )
-    self:F3( {  Map, Event } )
+    self:F3( { Map, Event } )
 
-    if type(Event.From) == 'string' then
+    if type( Event.From ) == 'string' then
-       Map[Event.From] = Event.To
+      Map[Event.From] = Event.To
     else
-      for _, From in ipairs(Event.From) do
+      for _, From in ipairs( Event.From ) do
-         Map[From] = Event.To
+        Map[From] = Event.To
       end
     end
     
-    self:T3( {  Map, Event } )
+    --self:T3( {  Map, Event } )
   end
 
   --- Get current state.
@@ -913,7 +908,7 @@ do -- FSM
   --- Check if FSM is in state.
   -- @param #FSM self
   -- @param #string State State name.
-  -- @param #boolean If true, FSM is in this state.
+  -- @return #boolean If true, FSM is in this state.
   function FSM:Is( State )
     return self.current == State
   end
@@ -921,7 +916,7 @@ do -- FSM
   --- Check if FSM is in state.
   -- @param #FSM self
   -- @param #string State State name.
-  -- @param #boolean If true, FSM is in this state.  
+  -- @return #boolean If true, FSM is in this state.  
   function FSM:is(state)
     return self.current == state
   end
@@ -931,11 +926,11 @@ do -- FSM
   -- @param #string e Event name.
   -- @return #boolean If true, FSM can do the event.
   -- @return #string To state.
-  function FSM:can(e)
+  function FSM:can( e )
 
     local Event = self.Events[e]
 
-    --self:F3( { self.current, Event } )
+    -- self:F3( { self.current, Event } )
 
     local To = Event and Event.map[self.current] or Event.map['*']
 
@@ -946,8 +941,8 @@ do -- FSM
   -- @param #FSM self
   -- @param #string e Event name.
   -- @return #boolean If true, FSM cannot do the event.
-  function FSM:cannot(e)
+  function FSM:cannot( e )
-    return not self:can(e)
+    return not self:can( e )
   end
 
 end
@@ -1036,7 +1031,7 @@ do -- FSM_CONTROLLABLE
   -- @param #string From The From State string.
   -- @param #string Event The Event string.
   -- @param #string To The To State string.
-  function FSM_CONTROLLABLE:OnAfterStop(Controllable,From,Event,To)  
+  function FSM_CONTROLLABLE:OnAfterStop( Controllable, From, Event, To )
 
     -- Clear all pending schedules
     self.CallScheduler:Clear()
@@ -1047,7 +1042,7 @@ do -- FSM_CONTROLLABLE
   -- @param Wrapper.Controllable#CONTROLLABLE FSMControllable
   -- @return #FSM_CONTROLLABLE
   function FSM_CONTROLLABLE:SetControllable( FSMControllable )
-    --self:F( FSMControllable:GetName() )
+    -- self:F( FSMControllable:GetName() )
     self.Controllable = FSMControllable
   end
 
@@ -1075,9 +1070,11 @@ do -- FSM_CONTROLLABLE
     if self[handler] then
       self:T( "*** FSM ***    " .. step .. " *** " .. params[1] .. " --> " .. params[2] .. " --> " .. params[3] .. " *** TaskUnit: " .. self.Controllable:GetName() )
       self._EventSchedules[EventName] = nil
-      local Result, Value = xpcall( function() return self[handler]( self, self.Controllable, unpack( params ) ) end, ErrorHandler )
+      local Result, Value = xpcall( function()
+        return self[handler]( self, self.Controllable, unpack( params ) )
+      end, ErrorHandler )
       return Value
-      --return self[handler]( self, self.Controllable, unpack( params ) )
+      -- return self[handler]( self, self.Controllable, unpack( params ) )
     end
   end
 
@@ -1089,16 +1086,13 @@ do -- FSM_PROCESS
   -- @field Tasking.Task#TASK Task
   -- @extends Core.Fsm#FSM_CONTROLLABLE
 
-  
   --- FSM_PROCESS class models Finite State Machines for @{Task} actions, which control @{Client}s.
   -- 
   -- ===
   -- 
   -- @field #FSM_PROCESS FSM_PROCESS
   -- 
-  FSM_PROCESS = {
+  FSM_PROCESS = { ClassName = "FSM_PROCESS" }
-    ClassName = "FSM_PROCESS",
-  }
 
   --- Creates a new FSM_PROCESS object.
   -- @param #FSM_PROCESS self
@@ -1107,7 +1101,7 @@ do -- FSM_PROCESS
 
     local self = BASE:Inherit( self, FSM_CONTROLLABLE:New() ) -- Core.Fsm#FSM_PROCESS
 
-    --self:F( Controllable )
+    -- self:F( Controllable )
 
     self:Assign( Controllable, Task )
 
@@ -1139,10 +1133,12 @@ do -- FSM_PROCESS
       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 )
+        Result, Value = xpcall( function()
+          return self[handler]( self, self.Controllable, self.Task, unpack( params ) )
+        end, ErrorHandler )
       end
       return Value
-      --return self[handler]( self, self.Controllable, unpack( params ) )
+      -- return self[handler]( self, self.Controllable, unpack( params ) )
     end
   end
 
@@ -1150,8 +1146,7 @@ do -- FSM_PROCESS
   -- @param #FSM_PROCESS self
   -- @return #FSM_PROCESS
   function FSM_PROCESS:Copy( Controllable, Task )
-    self:T( { self:GetClassNameAndID() } )
+    --self:T3( { self:GetClassNameAndID() } )
-
 
     local NewFsm = self:New( Controllable, Task ) -- Core.Fsm#FSM_PROCESS
 
@@ -1170,19 +1165,19 @@ do -- FSM_PROCESS
 
     -- Copy Processes
     for ProcessID, Process in pairs( self:GetProcesses() ) do
-      --self:E( { Process:GetName() } )
+      -- self:E( { Process:GetName() } )
       local FsmProcess = NewFsm:AddProcess( Process.From, Process.Event, Process.fsm:Copy( Controllable, Task ), Process.ReturnEvents )
     end
 
     -- Copy End States
     for EndStateID, EndState in pairs( self:GetEndStates() ) do
-      self:T( EndState )
+      --self:T3( EndState )
       NewFsm:AddEndState( EndState )
     end
 
     -- Copy the score tables
     for ScoreID, Score in pairs( self:GetScores() ) do
-      self:T( Score )
+      --self:T3( Score )
       NewFsm:AddScore( ScoreID, Score.ScoreText, Score.Score )
     end
 
@@ -1244,7 +1239,7 @@ do -- FSM_PROCESS
     return self:GetTask():GetMission():GetCommandCenter()
   end
 
--- TODO: Need to check and fix that an FSM_PROCESS is only for a UNIT. Not for a GROUP.  
+  -- 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
@@ -1263,32 +1258,29 @@ do -- FSM_PROCESS
     CC:MessageToGroup( Message, TaskGroup )
   end
 
-  
-  
-  
   --- Assign the process to a @{Wrapper.Unit} and activate the process.
   -- @param #FSM_PROCESS self
   -- @param Task.Tasking#TASK Task
   -- @param Wrapper.Unit#UNIT ProcessUnit
   -- @return #FSM_PROCESS self
   function FSM_PROCESS:Assign( ProcessUnit, Task )
-    --self:T( { Task:GetName(), ProcessUnit:GetName() } )
+    -- self:T( { Task:GetName(), ProcessUnit:GetName() } )
 
     self:SetControllable( ProcessUnit )
     self:SetTask( Task )
 
-    --self.ProcessGroup = ProcessUnit:GetGroup()
+    -- self.ProcessGroup = ProcessUnit:GetGroup()
 
     return self
   end
 
---  function FSM_PROCESS:onenterAssigned( ProcessUnit, Task, From, Event, To )
+  --  function FSM_PROCESS:onenterAssigned( ProcessUnit, Task, From, Event, To )
---  
+  --  
---    if From( "Planned" ) then
+  --    if From( "Planned" ) then
---      self:T( "*** FSM ***    Assign *** " .. Task:GetName() .. "/" .. ProcessUnit:GetName() .. " *** " .. From .. " --> " .. Event .. " --> " .. To )
+  --      self:T( "*** FSM ***    Assign *** " .. Task:GetName() .. "/" .. ProcessUnit:GetName() .. " *** " .. From .. " --> " .. Event .. " --> " .. To )
---      self.Task:Assign()
+  --      self.Task:Assign()
---    end
+  --    end
---  end
+  --  end
 
   function FSM_PROCESS:onenterFailed( ProcessUnit, Task, From, Event, To )
     self:T( "*** FSM ***    Failed *** " .. Task:GetName() .. "/" .. ProcessUnit:GetName() .. " *** " .. From .. " --> " .. Event .. " --> " .. To )
@@ -1296,7 +1288,6 @@ do -- FSM_PROCESS
     self.Task:Fail()
   end
 
-  
   --- StateMachine callback function for a FSM_PROCESS
   -- @param #FSM_PROCESS self
   -- @param Wrapper.Controllable#CONTROLLABLE ProcessUnit
@@ -1309,10 +1300,10 @@ do -- FSM_PROCESS
       self:T( "*** FSM ***    Change *** " .. Task:GetName() .. "/" .. ProcessUnit:GetName() .. " *** " .. From .. " --> " .. Event .. " --> " .. To )
     end
 
---    if self:IsTrace() then
+    --    if self:IsTrace() then
---      MESSAGE:New( "@ Process " .. self:GetClassNameAndID() .. " : " .. Event .. " changed to state " .. To, 2 ):ToAll()
+    --      MESSAGE:New( "@ Process " .. self:GetClassNameAndID() .. " : " .. Event .. " changed to state " .. To, 2 ):ToAll()
---      self:F2( { Scores = self._Scores, To = To } )
+    --      self:F2( { Scores = self._Scores, To = To } )
---    end
+    --    end
 
     -- 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
@@ -1374,8 +1365,10 @@ do -- FSM_TASK
     if self[handler] then
       self:T( "*** FSM ***    " .. step .. " *** " .. params[1] .. " --> " .. params[2] .. " --> " .. params[3] .. " *** Task: " .. self.TaskName )
       self._EventSchedules[EventName] = nil
-      --return self[handler]( self, unpack( params ) )
+      -- return self[handler]( self, unpack( params ) )
-      local Result, Value = xpcall( function() return self[handler]( self, unpack( params ) ) end, ErrorHandler )
+      local Result, Value = xpcall( function()
+        return self[handler]( self, unpack( params ) )
+      end, ErrorHandler )
       return Value
     end
   end
@@ -1389,14 +1382,12 @@ do -- FSM_SET
   -- @field Core.Set#SET_BASE 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
   -- for multiple objects or the position of the state machine in the process.
   --
   -- ===
   --
   -- @field #FSM_SET FSM_SET
-  -- 
   FSM_SET = {
     ClassName = "FSM_SET",
   }
@@ -1431,11 +1422,11 @@ do -- FSM_SET
   -- @param #FSM_SET self
   -- @return Core.Set#SET_BASE
   function FSM_SET:Get()
-    return self.Controllable
+    return self.Set
   end
 
-  function FSM_SET:_call_handler( step, trigger, params, EventName  )
+  function FSM_SET:_call_handler( step, trigger, params, EventName )
-  local handler = step .. trigger
+    local handler = step .. trigger
     if self[handler] then
       self:T( "*** FSM ***    " .. step .. " *** " .. params[1] .. " --> " .. params[2] .. " --> " .. params[3] )
       self._EventSchedules[EventName] = nil

Moose Development/Moose/Core/Goal.lua

@@ -22,13 +22,11 @@
 -- @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
@@ -105,9 +103,8 @@ do -- Goal
     -- @param #string Event
     -- @param #string To
 
-    
     self:SetStartState( "Pending" )
-    self:AddTransition( "*",  "Achieved", "Achieved" )
+    self:AddTransition( "*", "Achieved", "Achieved" )
 
     --- Achieved Handler OnBefore for GOAL
     -- @function [parent=#GOAL] OnBeforeAchieved
@@ -138,25 +135,22 @@ do -- Goal
     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:F({PlayerName})
+    self:F( { 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
@@ -165,7 +159,6 @@ do -- Goal
     return self.Players or {}
   end
 
-  
   --- Gets the total contributions that happened to achieve the goal.
   -- The result is a number.
   -- @param #GOAL self
@@ -174,8 +167,6 @@ do -- Goal
     return self.TotalContributions or 0
   end
 
-  
-  
   --- Validates if the goal is achieved.
   -- @param #GOAL self
   -- @return #boolean true if the goal is achieved.

Moose Development/Moose/Core/MarkerOps_Base.lua

@@ -0,0 +1,267 @@
+--- **Core** - MarkerOps_Base.
+--
+-- **Main Features:**
+--
+--    * Create an easy way to tap into markers added to the F10 map by users.
+--    * Recognize own tag and list of keywords.
+--    * Matched keywords are handed down to functions.
+--
+-- ===
+--
+-- ### Author: **Applevangelist**
+-- 
+-- Date: 5 May 2021
+-- Last Update: Sep 2022
+-- 
+-- ===
+---
+-- @module Core.MarkerOps_Base
+-- @image MOOSE_Core.JPG
+
+--------------------------------------------------------------------------
+-- MARKEROPS_BASE Class Definition.
+--------------------------------------------------------------------------
+
+--- MARKEROPS_BASE class.
+-- @type MARKEROPS_BASE
+-- @field #string ClassName Name of the class.
+-- @field #string Tag Tag to identify commands.
+-- @field #table Keywords Table of keywords to recognize.
+-- @field #string version Version of #MARKEROPS_BASE.
+-- @field #boolean Casesensitive Enforce case when identifying the Tag, i.e. tag ~= Tag
+-- @extends Core.Fsm#FSM
+
+--- *Fiat lux.* -- Latin proverb.
+--
+-- ===
+--
+-- # The MARKEROPS_BASE Concept
+-- 
+-- This class enable scripting text-based actions from markers.
+-- 
+-- @field #MARKEROPS_BASE
+MARKEROPS_BASE = {
+  ClassName = "MARKEROPS",
+  Tag = "mytag",
+  Keywords = {},
+  version = "0.1.0",
+  debug = false,
+  Casesensitive = true,
+}
+
+--- Function to instantiate a new #MARKEROPS_BASE object.
+-- @param #MARKEROPS_BASE self
+-- @param #string Tagname Name to identify us from the event text.
+-- @param #table Keywords Table of keywords  recognized from the event text.
+-- @param #boolean Casesensitive (Optional) Switch case sensitive identification of Tagname. Defaults to true.
+-- @return #MARKEROPS_BASE self
+function MARKEROPS_BASE:New(Tagname,Keywords,Casesensitive)
+   -- Inherit FSM
+  local self=BASE:Inherit(self, FSM:New()) -- #MARKEROPS_BASE
+  
+    -- Set some string id for output to DCS.log file.
+  self.lid=string.format("MARKEROPS_BASE %s | ", tostring(self.version))
+  
+  self.Tag = Tagname or "mytag"-- #string
+  self.Keywords = Keywords or {} -- #table - might want to use lua regex here, too
+  self.debug = false
+  self.Casesensitive = true
+  
+  if Casesensitive and Casesensitive == false then
+    self.Casesensitive = false
+  end
+  
+  -----------------------
+  --- FSM Transitions ---
+  -----------------------
+  
+  -- Start State.
+  self:SetStartState("Stopped")
+
+  -- Add FSM transitions.
+  --                 From State  -->   Event   -->   To State
+  self:AddTransition("Stopped", "Start",        "Running")        -- Start the FSM.
+  self:AddTransition("*",       "MarkAdded",    "*")        -- Start the FSM.
+  self:AddTransition("*",       "MarkChanged",   "*")        -- Start the FSM.
+  self:AddTransition("*",       "MarkDeleted",  "*")        -- Start the FSM.
+  self:AddTransition("Running", "Stop",         "Stopped")        -- Stop the FSM.
+  
+  self:HandleEvent(EVENTS.MarkAdded, self.OnEventMark)
+  self:HandleEvent(EVENTS.MarkChange, self.OnEventMark)
+  self:HandleEvent(EVENTS.MarkRemoved, self.OnEventMark)
+  
+  -- start
+  self:I(self.lid..string.format("started for %s",self.Tag))
+  self:__Start(1)
+  return self
+  
+  -------------------
+  -- PSEUDO Functions
+  -------------------
+  
+   --- On after "MarkAdded" event. Triggered when a Marker is added to the F10 map.
+   -- @function [parent=#MARKEROPS_BASE] OnAfterMarkAdded
+   -- @param #MARKEROPS_BASE self
+   -- @param #string From The From state
+   -- @param #string Event The Event called
+   -- @param #string To The To state
+   -- @param #string Text The text on the marker
+   -- @param #table Keywords Table of matching keywords found in the Event text
+   -- @param Core.Point#COORDINATE Coord Coordinate of the marker.
+   
+   --- On after "MarkChanged" event. Triggered when a Marker is changed on the F10 map.
+   -- @function [parent=#MARKEROPS_BASE] OnAfterMarkChanged
+   -- @param #MARKEROPS_BASE self
+   -- @param #string From The From state
+   -- @param #string Event The Event called
+   -- @param #string To The To state
+   -- @param #string Text The text on the marker
+   -- @param #table Keywords Table of matching keywords found in the Event text
+   -- @param Core.Point#COORDINATE Coord Coordinate of the marker.
+  
+   --- On after "MarkDeleted" event. Triggered when a Marker is deleted from the F10 map.
+   -- @function [parent=#MARKEROPS_BASE] OnAfterMarkDeleted
+   -- @param #MARKEROPS_BASE self
+   -- @param #string From The From state
+   -- @param #string Event The Event called
+   -- @param #string To The To state
+   
+      --- "Stop" trigger. Used to stop the function an unhandle events
+   -- @function [parent=#MARKEROPS_BASE] Stop
+
+end
+
+--- (internal) Handle events.
+-- @param #MARKEROPS_BASE self
+-- @param Core.Event#EVENTDATA Event
+function MARKEROPS_BASE:OnEventMark(Event)
+  self:T({Event})
+    if Event == nil or Event.idx == nil then
+      self:E("Skipping onEvent. Event or Event.idx unknown.")
+      return true
+    end
+    --position
+    local vec3={y=Event.pos.y, x=Event.pos.x, z=Event.pos.z}
+    local coord=COORDINATE:NewFromVec3(vec3)
+    if self.debug then
+      local coordtext = coord:ToStringLLDDM()
+      local text = tostring(Event.text)
+      local m = MESSAGE:New(string.format("Mark added at %s with text: %s",coordtext,text),10,"Info",false):ToAll()
+    end
+    -- decision
+    if Event.id==world.event.S_EVENT_MARK_ADDED then
+      self:T({event="S_EVENT_MARK_ADDED", carrier=self.groupname, vec3=Event.pos})
+      -- Handle event
+      local Eventtext = tostring(Event.text)
+      if Eventtext~=nil then
+        if self:_MatchTag(Eventtext) then
+         local matchtable = self:_MatchKeywords(Eventtext)
+         self:MarkAdded(Eventtext,matchtable,coord)
+        end
+      end
+    elseif Event.id==world.event.S_EVENT_MARK_CHANGE then
+      self:T({event="S_EVENT_MARK_CHANGE", carrier=self.groupname, vec3=Event.pos})
+      -- Handle event.
+      local Eventtext = tostring(Event.text)
+      if Eventtext~=nil then
+        if self:_MatchTag(Eventtext) then
+         local matchtable = self:_MatchKeywords(Eventtext)
+         self:MarkChanged(Eventtext,matchtable,coord)
+        end
+      end
+    elseif Event.id==world.event.S_EVENT_MARK_REMOVED then
+      self:T({event="S_EVENT_MARK_REMOVED", carrier=self.groupname, vec3=Event.pos})
+      -- Hande event.
+      local Eventtext = tostring(Event.text)
+      if Eventtext~=nil then
+        if self:_MatchTag(Eventtext) then
+         self:MarkDeleted()
+        end
+      end
+    end
+end
+
+--- (internal) Match tag.
+-- @param #MARKEROPS_BASE self
+-- @param #string Eventtext Text added to the marker.
+-- @return #boolean
+function MARKEROPS_BASE:_MatchTag(Eventtext)
+  local matches = false
+  if not self.Casesensitive then
+    local type = string.lower(self.Tag) -- #string
+    if string.find(string.lower(Eventtext),type) then
+      matches = true --event text contains tag
+    end
+  else
+    local type = self.Tag -- #string
+    if string.find(Eventtext,type) then
+      matches = true --event text contains tag
+    end
+  end
+  return matches
+end
+
+--- (internal) Match keywords table.
+-- @param #MARKEROPS_BASE self
+-- @param #string Eventtext Text added to the marker.
+-- @return #table
+function MARKEROPS_BASE:_MatchKeywords(Eventtext)
+  local matchtable = {}
+  local keytable = self.Keywords
+  for _index,_word in pairs (keytable) do
+    if string.find(string.lower(Eventtext),string.lower(_word))then
+      table.insert(matchtable,_word)
+    end
+  end
+  return matchtable
+end
+
+--- On before "MarkAdded" event. Triggered when a Marker is added to the F10 map.
+ -- @param #MARKEROPS_BASE self
+ -- @param #string From The From state
+ -- @param #string Event The Event called
+ -- @param #string To The To state
+ -- @param #string Text The text on the marker
+ -- @param #table Keywords Table of matching keywords found in the Event text
+ -- @param Core.Point#COORDINATE Coord Coordinate of the marker.
+function MARKEROPS_BASE:onbeforeMarkAdded(From,Event,To,Text,Keywords,Coord)
+  self:T({self.lid,From,Event,To,Text,Keywords,Coord:ToStringLLDDM()})
+end
+
+--- On before "MarkChanged" event. Triggered when a Marker is changed on the F10 map.
+ -- @param #MARKEROPS_BASE self
+ -- @param #string From The From state
+ -- @param #string Event The Event called
+ -- @param #string To The To state
+ -- @param #string Text The text on the marker
+ -- @param #table Keywords Table of matching keywords found in the Event text
+ -- @param Core.Point#COORDINATE Coord Coordinate of the marker.
+function MARKEROPS_BASE:onbeforeMarkChanged(From,Event,To,Text,Keywords,Coord)
+  self:T({self.lid,From,Event,To,Text,Keywords,Coord:ToStringLLDDM()})
+end
+
+--- On before "MarkDeleted" event. Triggered when a Marker is removed from the F10 map.
+ -- @param #MARKEROPS_BASE self
+ -- @param #string From The From state
+ -- @param #string Event The Event called
+ -- @param #string To The To state
+function MARKEROPS_BASE:onbeforeMarkDeleted(From,Event,To)
+  self:T({self.lid,From,Event,To})
+end
+
+--- On enter "Stopped" event. Unsubscribe events.
+ -- @param #MARKEROPS_BASE self
+ -- @param #string From The From state
+ -- @param #string Event The Event called
+ -- @param #string To The To state
+function MARKEROPS_BASE:onenterStopped(From,Event,To)
+  self:T({self.lid,From,Event,To})
+  -- unsubscribe from events
+  self:UnHandleEvent(EVENTS.MarkAdded)
+  self:UnHandleEvent(EVENTS.MarkChange)
+  self:UnHandleEvent(EVENTS.MarkRemoved)
+end
+
+--------------------------------------------------------------------------
+-- MARKEROPS_BASE Class Definition End.
+--------------------------------------------------------------------------

Moose Development/Moose/Core/Menu.lua

@@ -14,7 +14,7 @@
 --   * Only create or delete menus when required, and keep existing menus persistent.
 --   * Update menu structures.
 --   * Refresh menu structures intelligently, based on a time stamp of updates.
---     - Delete obscolete menus.
+--     - Delete obsolete menus.
 --     - Create new one where required.
 --     - Don't touch the existing ones.
 --   * Provide a variable amount of parameters to menus.
@@ -23,7 +23,7 @@
 --   * Provide a great tool to manage menus in your code.
 -- 
 -- DCS Menus can be managed using the MENU classes. 
--- The advantage of using MENU classes is that it hides the complexity of dealing with menu management in more advanced scanerios where you need to 
+-- The advantage of using MENU classes is that it hides the complexity of dealing with menu management in more advanced scenarios where you need to 
 -- set menus and later remove them, and later set them again. You'll find while using use normal DCS scripting functions, that setting and removing
 -- menus is not a easy feat if you have complex menu hierarchies defined. 
 -- Using the MOOSE menu classes, the removal and refreshing of menus are nicely being handled within these classes, and becomes much more easy.
@@ -53,7 +53,6 @@
 -- @module Core.Menu
 -- @image Core_Menu.JPG
 
-
 MENU_INDEX = {}
 MENU_INDEX.MenuMission = {}
 MENU_INDEX.MenuMission.Menus = {}
@@ -64,10 +63,7 @@ MENU_INDEX.Coalition[coalition.side.RED] = {}
 MENU_INDEX.Coalition[coalition.side.RED].Menus = {}
 MENU_INDEX.Group = {}
 
-
-
 function MENU_INDEX:ParentPath( ParentMenu, MenuText )
-
   local Path = ParentMenu and "@" .. table.concat( ParentMenu.MenuPath or {}, "@" ) or ""
   if ParentMenu then 
     if ParentMenu:IsInstanceOf( "MENU_GROUP" ) or ParentMenu:IsInstanceOf( "MENU_GROUP_COMMAND" ) then
@@ -95,20 +91,16 @@ function MENU_INDEX:ParentPath( ParentMenu, MenuText )
   
   Path = Path .. "@" .. MenuText
   return Path
-
 end
 
-
 function MENU_INDEX:PrepareMission()
     self.MenuMission.Menus = self.MenuMission.Menus or {}
 end
 
-
 function MENU_INDEX:PrepareCoalition( CoalitionSide )
     self.Coalition[CoalitionSide] = self.Coalition[CoalitionSide] or {}
     self.Coalition[CoalitionSide].Menus = self.Coalition[CoalitionSide].Menus or {}
 end
-
 ---
 -- @param Wrapper.Group#GROUP Group
 function MENU_INDEX:PrepareGroup( Group )
@@ -119,42 +111,26 @@ function MENU_INDEX:PrepareGroup( Group )
   end
 end
 
-
-
 function MENU_INDEX:HasMissionMenu( Path )
-
   return self.MenuMission.Menus[Path]
 end
-
 function MENU_INDEX:SetMissionMenu( Path, Menu )
-
   self.MenuMission.Menus[Path] = Menu
 end
-
 function MENU_INDEX:ClearMissionMenu( Path )
-
   self.MenuMission.Menus[Path] = nil
 end
 
-
-
 function MENU_INDEX:HasCoalitionMenu( Coalition, Path )
-
   return self.Coalition[Coalition].Menus[Path]
 end
-
 function MENU_INDEX:SetCoalitionMenu( Coalition, Path, Menu )
-
   self.Coalition[Coalition].Menus[Path] = Menu
 end
-
 function MENU_INDEX:ClearCoalitionMenu( Coalition, Path )
-
   self.Coalition[Coalition].Menus[Path] = nil
 end
 
-
-
 function MENU_INDEX:HasGroupMenu( Group, Path )
   if Group and Group:IsAlive() then
     local MenuGroupName = Group:GetName()
@@ -162,53 +138,36 @@ function MENU_INDEX:HasGroupMenu( Group, Path )
   end
   return nil
 end
-
 function MENU_INDEX:SetGroupMenu( Group, Path, Menu )
-
   local MenuGroupName = Group:GetName()
   Group:F({MenuGroupName=MenuGroupName,Path=Path})
   self.Group[MenuGroupName].Menus[Path] = Menu
 end
-
 function MENU_INDEX:ClearGroupMenu( Group, Path )
-
   local MenuGroupName = Group:GetName()
   self.Group[MenuGroupName].Menus[Path] = nil
 end
-
 function MENU_INDEX:Refresh( Group )
-
     for MenuID, Menu in pairs( self.MenuMission.Menus ) do
       Menu:Refresh()  
     end 
-
     for MenuID, Menu in pairs( self.Coalition[coalition.side.BLUE].Menus ) do
       Menu:Refresh()  
     end 
-
     for MenuID, Menu in pairs( self.Coalition[coalition.side.RED].Menus ) do
       Menu:Refresh()  
     end 
-
     local GroupName = Group:GetName()
     for MenuID, Menu in pairs( self.Group[GroupName].Menus ) do
       Menu:Refresh()  
     end 
   
+  return self
 end
 
-
-
-
-
-
-
-
 do -- MENU_BASE
-
   --- @type MENU_BASE
-  -- @extends Base#BASE
+  -- @extends Core.Base#BASE
-
   --- Defines the main MENU class where other MENU classes are derived from.
   -- This is an abstract class, so don't use it.
   -- @field #MENU_BASE
@@ -216,10 +175,10 @@ do -- MENU_BASE
     ClassName = "MENU_BASE",
     MenuPath = nil,
     MenuText = "",
-    MenuParentPath = nil
+    MenuParentPath = nil,
   }
   
-  --- Consructor
+  --- Constructor
   -- @param #MENU_BASE
   -- @return #MENU_BASE
   function MENU_BASE:New( MenuText, ParentMenu )
@@ -228,14 +187,13 @@ do -- MENU_BASE
     if ParentMenu ~= nil then
       MenuParentPath = ParentMenu.MenuPath
     end
+    local self = BASE:Inherit( self, BASE:New() )
   
-  	local self = BASE:Inherit( self, BASE:New() )
+    self.MenuPath = nil 
-  
+    self.MenuText = MenuText
-  	self.MenuPath = nil 
+    self.ParentMenu = ParentMenu
-  	self.MenuText = MenuText
+    self.MenuParentPath = MenuParentPath
-  	self.ParentMenu = ParentMenu
+    self.Path = ( self.ParentMenu and "@" .. table.concat( self.MenuParentPath or {}, "@" ) or "" ) .. "@" .. self.MenuText
-  	self.MenuParentPath = MenuParentPath
-  	self.Path = ( self.ParentMenu and "@" .. table.concat( self.MenuParentPath or {}, "@" ) or "" ) .. "@" .. self.MenuText
     self.Menus = {}
     self.MenuCount = 0
     self.MenuStamp = timer.getTime()
@@ -246,9 +204,8 @@ do -- MENU_BASE
       self.ParentMenu.Menus[MenuText] = self
     end
     
-  	return self
+    return self
   end
-
   function MENU_BASE:SetParentMenu( MenuText, Menu )
     if self.ParentMenu then
       self.ParentMenu.Menus = self.ParentMenu.Menus or {}
@@ -256,7 +213,6 @@ do -- MENU_BASE
       self.ParentMenu.MenuCount = self.ParentMenu.MenuCount + 1
     end
   end
-
   function MENU_BASE:ClearParentMenu( MenuText )
     if self.ParentMenu and self.ParentMenu.Menus[MenuText] then
       self.ParentMenu.Menus[MenuText] = nil
@@ -266,7 +222,6 @@ do -- MENU_BASE
       end
     end
   end
-
   --- Sets a @{Menu} to remove automatically the parent menu when the menu removed is the last child menu of that parent @{Menu}.
   -- @param #MENU_BASE self
   -- @param #boolean RemoveParent If true, the parent menu is automatically removed when this menu is the last child menu of that parent @{Menu}.
@@ -277,7 +232,6 @@ do -- MENU_BASE
     return self
   end
   
-  
   --- Gets a @{Menu} from a parent @{Menu}
   -- @param #MENU_BASE self
   -- @param #string MenuText The text of the child menu.
@@ -323,9 +277,7 @@ do -- MENU_BASE
   end
   
 end
-
 do -- MENU_COMMAND_BASE
-
   --- @type MENU_COMMAND_BASE
   -- @field #function MenuCallHandler
   -- @extends Core.Menu#MENU_BASE
@@ -346,8 +298,7 @@ do -- MENU_COMMAND_BASE
   -- @return #MENU_COMMAND_BASE
   function MENU_COMMAND_BASE:New( MenuText, ParentMenu, CommandMenuFunction, CommandMenuArguments )
   
-  	local self = BASE:Inherit( self, MENU_BASE:New( MenuText, ParentMenu ) ) -- #MENU_COMMAND_BASE
+    local self = BASE:Inherit( self, MENU_BASE:New( MenuText, ParentMenu ) ) -- #MENU_COMMAND_BASE
-
     -- When a menu function goes into error, DCS displays an obscure menu message.
     -- This error handler catches the menu error and displays the full call stack.
     local ErrorHandler = function( errmsg )
@@ -367,7 +318,7 @@ do -- MENU_COMMAND_BASE
       local Status, Result = xpcall( MenuFunction, ErrorHandler )
     end
     
-  	return self
+    return self
   end
   
   --- This sets the new command function of a menu, 
@@ -380,7 +331,6 @@ do -- MENU_COMMAND_BASE
     self.CommandMenuFunction = CommandMenuFunction
     return self
   end
-
   --- This sets the new command arguments of a menu, 
   -- so that if a menu is regenerated, or if command arguments change,
   -- that the arguments set for the menu are loosely coupled with the menu itself!!!
@@ -391,35 +341,30 @@ do -- MENU_COMMAND_BASE
     self.CommandMenuArguments = CommandMenuArguments
     return self
   end
-
 end
 
-
 do -- MENU_MISSION
-
   --- @type MENU_MISSION
   -- @extends Core.Menu#MENU_BASE
-
   --- Manages the main menus for a complete mission.  
   -- 
   -- You can add menus with the @{#MENU_MISSION.New} method, which constructs a MENU_MISSION object and returns you the object reference.
   -- Using this object reference, you can then remove ALL the menus and submenus underlying automatically with @{#MENU_MISSION.Remove}.
   -- @field #MENU_MISSION
   MENU_MISSION = {
-    ClassName = "MENU_MISSION"
+    ClassName = "MENU_MISSION",
   }
   
   --- MENU_MISSION constructor. Creates a new MENU_MISSION object and creates the menu for a complete mission file.
   -- @param #MENU_MISSION self
   -- @param #string MenuText The text for the menu.
-  -- @param #table ParentMenu The parent menu. This parameter can be ignored if you want the menu to be located at the perent menu of DCS world (under F10 other).
+  -- @param #table ParentMenu The parent menu. This parameter can be ignored if you want the menu to be located at the parent menu of DCS world (under F10 other).
   -- @return #MENU_MISSION
   function MENU_MISSION:New( MenuText, ParentMenu )
   
     MENU_INDEX:PrepareMission()
     local Path = MENU_INDEX:ParentPath( ParentMenu, MenuText )
     local MissionMenu = MENU_INDEX:HasMissionMenu( Path )   
-
     if MissionMenu then
       return MissionMenu
     else
@@ -437,12 +382,11 @@ do -- MENU_MISSION
   -- @param #MENU_MISSION self
   -- @return #MENU_MISSION
   function MENU_MISSION:Refresh()
-
     do
       missionCommands.removeItem( self.MenuPath )
       self.MenuPath = missionCommands.addSubMenu( self.MenuText, self.MenuParentPath )
     end
-
+    return self
   end
   
   --- Removes the sub menus recursively of this MENU_MISSION. Note that the main menu is kept!
@@ -466,7 +410,6 @@ do -- MENU_MISSION
     MENU_INDEX:PrepareMission()
     local Path = MENU_INDEX:ParentPath( self.ParentMenu, self.MenuText )
     local MissionMenu = MENU_INDEX:HasMissionMenu( Path )   
-
     if MissionMenu == self then
       self:RemoveSubMenus()
       if not MenuStamp or self.MenuStamp ~= MenuStamp then
@@ -487,10 +430,7 @@ do -- MENU_MISSION
     return self
   end
 
-
-
 end
-
 do -- MENU_MISSION_COMMAND
   
   --- @type MENU_MISSION_COMMAND
@@ -503,7 +443,7 @@ do -- MENU_MISSION_COMMAND
   -- 
   -- @field #MENU_MISSION_COMMAND
   MENU_MISSION_COMMAND = {
-    ClassName = "MENU_MISSION_COMMAND"
+    ClassName = "MENU_MISSION_COMMAND",
   }
   
   --- MENU_MISSION constructor. Creates a new radio command item for a complete mission file, which can invoke a function with parameters.
@@ -518,7 +458,6 @@ do -- MENU_MISSION_COMMAND
     MENU_INDEX:PrepareMission()
     local Path = MENU_INDEX:ParentPath( ParentMenu, MenuText )
     local MissionMenu = MENU_INDEX:HasMissionMenu( Path )   
-
     if MissionMenu then
       MissionMenu:SetCommandMenuFunction( CommandMenuFunction )
       MissionMenu:SetCommandMenuArguments( arg )
@@ -532,17 +471,15 @@ do -- MENU_MISSION_COMMAND
       return self
     end
   end
-
   --- Refreshes a radio item for a mission
   -- @param #MENU_MISSION_COMMAND self
   -- @return #MENU_MISSION_COMMAND
   function MENU_MISSION_COMMAND:Refresh()
-
     do
       missionCommands.removeItem( self.MenuPath )
       missionCommands.addCommand( self.MenuText, self.MenuParentPath, self.MenuCallHandler )
     end
-
+    return self
   end
   
   --- Removes a radio command item for a coalition
@@ -553,7 +490,6 @@ do -- MENU_MISSION_COMMAND
     MENU_INDEX:PrepareMission()
     local Path = MENU_INDEX:ParentPath( self.ParentMenu, self.MenuText )
     local MissionMenu = MENU_INDEX:HasMissionMenu( Path )   
-
     if MissionMenu == self then
       if not MenuStamp or self.MenuStamp ~= MenuStamp then
         if ( not MenuTag ) or ( MenuTag and self.MenuTag and MenuTag == self.MenuTag ) then
@@ -572,13 +508,8 @@ do -- MENU_MISSION_COMMAND
   
     return self
   end
-
 end
-
-
-
 do -- MENU_COALITION
-
   --- @type MENU_COALITION
   -- @extends Core.Menu#MENU_BASE
   
@@ -634,18 +565,15 @@ do -- MENU_COALITION
   -- @param #MENU_COALITION self
   -- @param DCS#coalition.side Coalition The coalition owning the menu.
   -- @param #string MenuText The text for the menu.
-  -- @param #table ParentMenu The parent menu. This parameter can be ignored if you want the menu to be located at the perent menu of DCS world (under F10 other).
+  -- @param #table ParentMenu The parent menu. This parameter can be ignored if you want the menu to be located at the parent menu of DCS world (under F10 other).
   -- @return #MENU_COALITION self
   function MENU_COALITION:New( Coalition, MenuText, ParentMenu )
-
     MENU_INDEX:PrepareCoalition( Coalition )
     local Path = MENU_INDEX:ParentPath( ParentMenu, MenuText )
     local CoalitionMenu = MENU_INDEX:HasCoalitionMenu( Coalition, Path )   
-
     if CoalitionMenu then
       return CoalitionMenu
     else
-
       local self = BASE:Inherit( self, MENU_BASE:New( MenuText, ParentMenu ) )
       MENU_INDEX:SetCoalitionMenu( Coalition, Path, self )
       
@@ -656,17 +584,15 @@ do -- MENU_COALITION
       return self
     end
   end
-
   --- Refreshes a radio item for a coalition
   -- @param #MENU_COALITION self
   -- @return #MENU_COALITION
   function MENU_COALITION:Refresh()
-
     do
       missionCommands.removeItemForCoalition( self.Coalition, self.MenuPath )
       missionCommands.addSubMenuForCoalition( self.Coalition, self.MenuText, self.MenuParentPath )
     end
-
+    return self
   end
   
   --- Removes the sub menus recursively of this MENU_COALITION. Note that the main menu is kept!
@@ -689,7 +615,6 @@ do -- MENU_COALITION
     MENU_INDEX:PrepareCoalition( self.Coalition )
     local Path = MENU_INDEX:ParentPath( self.ParentMenu, self.MenuText )
     local CoalitionMenu = MENU_INDEX:HasCoalitionMenu( self.Coalition, Path )   
-
     if CoalitionMenu == self then
       self:RemoveSubMenus()
       if not MenuStamp or self.MenuStamp ~= MenuStamp then
@@ -709,11 +634,7 @@ do -- MENU_COALITION
   
     return self
   end
-
 end
-
-
-
 do -- MENU_COALITION_COMMAND
   
   --- @type MENU_COALITION_COMMAND
@@ -742,7 +663,6 @@ do -- MENU_COALITION_COMMAND
     MENU_INDEX:PrepareCoalition( Coalition )
     local Path = MENU_INDEX:ParentPath( ParentMenu, MenuText )
     local CoalitionMenu = MENU_INDEX:HasCoalitionMenu( Coalition, Path )   
-
     if CoalitionMenu then
       CoalitionMenu:SetCommandMenuFunction( CommandMenuFunction )
       CoalitionMenu:SetCommandMenuArguments( arg )
@@ -757,20 +677,17 @@ do -- MENU_COALITION_COMMAND
       self:SetParentMenu( self.MenuText, self )
       return self
     end
-
   end
-
-
   --- Refreshes a radio item for a coalition
   -- @param #MENU_COALITION_COMMAND self
   -- @return #MENU_COALITION_COMMAND
   function MENU_COALITION_COMMAND:Refresh()
-
     do
       missionCommands.removeItemForCoalition( self.Coalition, self.MenuPath )
       missionCommands.addCommandForCoalition( self.Coalition, self.MenuText, self.MenuParentPath, self.MenuCallHandler )
     end
     
+    return self
   end
   
   --- Removes a radio command item for a coalition
@@ -781,7 +698,6 @@ do -- MENU_COALITION_COMMAND
     MENU_INDEX:PrepareCoalition( self.Coalition )
     local Path = MENU_INDEX:ParentPath( self.ParentMenu, self.MenuText )
     local CoalitionMenu = MENU_INDEX:HasCoalitionMenu( self.Coalition, Path )   
-
     if CoalitionMenu == self then
       if not MenuStamp or self.MenuStamp ~= MenuStamp then
         if ( not MenuTag ) or ( MenuTag and self.MenuTag and MenuTag == self.MenuTag ) then
@@ -800,20 +716,16 @@ do -- MENU_COALITION_COMMAND
   
     return self
   end
-
 end
 
-
 --- MENU_GROUP
-
 do
   -- This local variable is used to cache the menus registered under groups.
-  -- Menus don't dissapear when groups for players are destroyed and restarted.
+  -- Menus don't disappear when groups for players are destroyed and restarted.
   -- So every menu for a client created must be tracked so that program logic accidentally does not create.
   -- the same menus twice during initialization logic.
   -- These menu classes are handling this logic with this variable.
   local _MENUGROUPS = {}
-
   --- @type MENU_GROUP
   -- @extends Core.Menu#MENU_BASE
   
@@ -889,16 +801,13 @@ do
     MENU_INDEX:PrepareGroup( Group )
     local Path = MENU_INDEX:ParentPath( ParentMenu, MenuText )
     local GroupMenu = MENU_INDEX:HasGroupMenu( Group, Path )
-
     if GroupMenu then
       return GroupMenu
     else
       self = BASE:Inherit( self, MENU_BASE:New( MenuText, ParentMenu ) )
       MENU_INDEX:SetGroupMenu( Group, Path, self )
-
       self.Group = Group
       self.GroupID = Group:GetID()
-
       self.MenuPath = missionCommands.addSubMenuForGroup( self.GroupID, MenuText, self.MenuParentPath )
       
       self:SetParentMenu( self.MenuText, self )
@@ -911,7 +820,6 @@ do
   -- @param #MENU_GROUP self
   -- @return #MENU_GROUP
   function MENU_GROUP:Refresh()
-
     do
       missionCommands.removeItemForGroup( self.GroupID, self.MenuPath )
       missionCommands.addSubMenuForGroup( self.GroupID, self.MenuText, self.MenuParentPath )
@@ -921,6 +829,30 @@ do
       end
     end
     
+    return self
+  end
+  
+  --- Refreshes a new radio item for a group and submenus, ordering by (numerical) MenuTag
+  -- @param #MENU_GROUP self
+  -- @return #MENU_GROUP
+  function MENU_GROUP:RefreshAndOrderByTag()
+
+    do
+      missionCommands.removeItemForGroup( self.GroupID, self.MenuPath )
+      missionCommands.addSubMenuForGroup( self.GroupID, self.MenuText, self.MenuParentPath )
+      
+      local MenuTable = {}
+      for MenuText, Menu in pairs( self.Menus or {} ) do
+        local tag = Menu.MenuTag or math.random(1,10000)
+        MenuTable[#MenuTable+1] = {Tag=tag, Enty=Menu}
+      end
+      table.sort(MenuTable, function (k1, k2) return k1.tag < k2.tag end )
+      for _, Menu in pairs( MenuTable ) do
+        Menu.Entry:Refresh()
+      end 
+    end
+    
+    return self
   end
   
   --- Removes the sub menus recursively of this MENU_GROUP.
@@ -929,7 +861,6 @@ do
   -- @param MenuTag A Tag or Key to filter the menus to be refreshed with the Tag set.
   -- @return #MENU_GROUP self
   function MENU_GROUP:RemoveSubMenus( MenuStamp, MenuTag )
-
     for MenuText, Menu in pairs( self.Menus or {} ) do
       Menu:Remove( MenuStamp, MenuTag )
     end
@@ -938,18 +869,15 @@ do
   
   end
 
-
   --- Removes the main menu and sub menus recursively of this MENU_GROUP.
   -- @param #MENU_GROUP self
   -- @param MenuStamp
   -- @param MenuTag A Tag or Key to filter the menus to be refreshed with the Tag set.
   -- @return #nil
   function MENU_GROUP:Remove( MenuStamp, MenuTag )
-
     MENU_INDEX:PrepareGroup( self.Group )
     local Path = MENU_INDEX:ParentPath( self.ParentMenu, self.MenuText )
     local GroupMenu = MENU_INDEX:HasGroupMenu( self.Group, Path )   
-
     if GroupMenu == self then
       self:RemoveSubMenus( MenuStamp, MenuTag )
       if not MenuStamp or self.MenuStamp ~= MenuStamp then
@@ -993,18 +921,15 @@ do
   -- @param CommandMenuArgument An argument for the function.
   -- @return #MENU_GROUP_COMMAND
   function MENU_GROUP_COMMAND:New( Group, MenuText, ParentMenu, CommandMenuFunction, ... )
-
     MENU_INDEX:PrepareGroup( Group )
     local Path = MENU_INDEX:ParentPath( ParentMenu, MenuText )
     local GroupMenu = MENU_INDEX:HasGroupMenu( Group, Path )   
-
     if GroupMenu then
       GroupMenu:SetCommandMenuFunction( CommandMenuFunction )
       GroupMenu:SetCommandMenuArguments( arg )
       return GroupMenu
     else
       self = BASE:Inherit( self, MENU_COMMAND_BASE:New( MenuText, ParentMenu, CommandMenuFunction, arg ) )
-
       MENU_INDEX:SetGroupMenu( Group, Path, self )
   
       self.Group = Group
@@ -1015,19 +940,17 @@ do
       self:SetParentMenu( self.MenuText, self )
       return self
     end
-
   end
-
   --- Refreshes a radio item for a group
   -- @param #MENU_GROUP_COMMAND self
   -- @return #MENU_GROUP_COMMAND
   function MENU_GROUP_COMMAND:Refresh()
-
     do
       missionCommands.removeItemForGroup( self.GroupID, self.MenuPath )
       missionCommands.addCommandForGroup( self.GroupID, self.MenuText, self.MenuParentPath, self.MenuCallHandler )
     end
     
+    return self
   end
   
   --- Removes a menu structure for a group.
@@ -1036,11 +959,9 @@ do
   -- @param MenuTag A Tag or Key to filter the menus to be refreshed with the Tag set.
   -- @return #nil
   function MENU_GROUP_COMMAND:Remove( MenuStamp, MenuTag )
-
     MENU_INDEX:PrepareGroup( self.Group )
     local Path = MENU_INDEX:ParentPath( self.ParentMenu, self.MenuText )
     local GroupMenu = MENU_INDEX:HasGroupMenu( self.Group, Path )   
-
     if GroupMenu == self then
       if not MenuStamp or self.MenuStamp ~= MenuStamp then
         if ( not MenuTag ) or ( MenuTag and self.MenuTag and MenuTag == self.MenuTag ) then
@@ -1059,13 +980,9 @@ do
     
     return self
   end
-
 end
-
 --- MENU_GROUP_DELAYED
-
 do
-
   --- @type MENU_GROUP_DELAYED
   -- @extends Core.Menu#MENU_BASE
   
@@ -1093,16 +1010,13 @@ do
     MENU_INDEX:PrepareGroup( Group )
     local Path = MENU_INDEX:ParentPath( ParentMenu, MenuText )
     local GroupMenu = MENU_INDEX:HasGroupMenu( Group, Path )
-
     if GroupMenu then
       return GroupMenu
     else
       self = BASE:Inherit( self, MENU_BASE:New( MenuText, ParentMenu ) )
       MENU_INDEX:SetGroupMenu( Group, Path, self )
-
       self.Group = Group
       self.GroupID = Group:GetID()
-
       if self.MenuParentPath then
         self.MenuPath = UTILS.DeepCopy( self.MenuParentPath )
       else
@@ -1116,12 +1030,10 @@ do
     
   end
 
-
   --- Refreshes a new radio item for a group and submenus
   -- @param #MENU_GROUP_DELAYED self
   -- @return #MENU_GROUP_DELAYED
   function MENU_GROUP_DELAYED:Set()
-
     do
       if not self.MenuSet then
         missionCommands.addSubMenuForGroup( self.GroupID, self.MenuText, self.MenuParentPath )
@@ -1132,15 +1044,12 @@ do
         Menu:Set()
       end
     end
-
   end
 
-
   --- Refreshes a new radio item for a group and submenus
   -- @param #MENU_GROUP_DELAYED self
   -- @return #MENU_GROUP_DELAYED
   function MENU_GROUP_DELAYED:Refresh()
-
     do
       missionCommands.removeItemForGroup( self.GroupID, self.MenuPath )
       missionCommands.addSubMenuForGroup( self.GroupID, self.MenuText, self.MenuParentPath )
@@ -1150,6 +1059,7 @@ do
       end
     end
   
+    return self
   end
   
   --- Removes the sub menus recursively of this MENU_GROUP_DELAYED.
@@ -1158,7 +1068,6 @@ do
   -- @param MenuTag A Tag or Key to filter the menus to be refreshed with the Tag set.
   -- @return #MENU_GROUP_DELAYED self
   function MENU_GROUP_DELAYED:RemoveSubMenus( MenuStamp, MenuTag )
-
     for MenuText, Menu in pairs( self.Menus or {} ) do
       Menu:Remove( MenuStamp, MenuTag )
     end
@@ -1167,18 +1076,15 @@ do
   
   end
 
-
   --- Removes the main menu and sub menus recursively of this MENU_GROUP.
   -- @param #MENU_GROUP_DELAYED self
   -- @param MenuStamp
   -- @param MenuTag A Tag or Key to filter the menus to be refreshed with the Tag set.
   -- @return #nil
   function MENU_GROUP_DELAYED:Remove( MenuStamp, MenuTag )
-
     MENU_INDEX:PrepareGroup( self.Group )
     local Path = MENU_INDEX:ParentPath( self.ParentMenu, self.MenuText )
     local GroupMenu = MENU_INDEX:HasGroupMenu( self.Group, Path )   
-
     if GroupMenu == self then
       self:RemoveSubMenus( MenuStamp, MenuTag )
       if not MenuStamp or self.MenuStamp ~= MenuStamp then
@@ -1223,18 +1129,15 @@ do
   -- @param CommandMenuArgument An argument for the function.
   -- @return #MENU_GROUP_COMMAND_DELAYED
   function MENU_GROUP_COMMAND_DELAYED:New( Group, MenuText, ParentMenu, CommandMenuFunction, ... )
-
     MENU_INDEX:PrepareGroup( Group )
     local Path = MENU_INDEX:ParentPath( ParentMenu, MenuText )
     local GroupMenu = MENU_INDEX:HasGroupMenu( Group, Path )   
-
     if GroupMenu then
       GroupMenu:SetCommandMenuFunction( CommandMenuFunction )
       GroupMenu:SetCommandMenuArguments( arg )
       return GroupMenu
     else
       self = BASE:Inherit( self, MENU_COMMAND_BASE:New( MenuText, ParentMenu, CommandMenuFunction, arg ) )
-
       MENU_INDEX:SetGroupMenu( Group, Path, self )
   
       self.Group = Group
@@ -1250,33 +1153,29 @@ do
       self:SetParentMenu( self.MenuText, self )
       return self
     end
-
   end
-
   --- Refreshes a radio item for a group
   -- @param #MENU_GROUP_COMMAND_DELAYED self
   -- @return #MENU_GROUP_COMMAND_DELAYED
   function MENU_GROUP_COMMAND_DELAYED:Set()
-
     do
       if not self.MenuSet then
         self.MenuPath = missionCommands.addCommandForGroup( self.GroupID, self.MenuText, self.MenuParentPath, self.MenuCallHandler )
         self.MenuSet = true
       end
     end
-
   end
   
   --- Refreshes a radio item for a group
   -- @param #MENU_GROUP_COMMAND_DELAYED self
   -- @return #MENU_GROUP_COMMAND_DELAYED
   function MENU_GROUP_COMMAND_DELAYED:Refresh()
-
     do
       missionCommands.removeItemForGroup( self.GroupID, self.MenuPath )
       missionCommands.addCommandForGroup( self.GroupID, self.MenuText, self.MenuParentPath, self.MenuCallHandler )
     end
   
+    return self
   end
   
   --- Removes a menu structure for a group.
@@ -1285,11 +1184,9 @@ do
   -- @param MenuTag A Tag or Key to filter the menus to be refreshed with the Tag set.
   -- @return #nil
   function MENU_GROUP_COMMAND_DELAYED:Remove( MenuStamp, MenuTag )
-
     MENU_INDEX:PrepareGroup( self.Group )
     local Path = MENU_INDEX:ParentPath( self.ParentMenu, self.MenuText )
     local GroupMenu = MENU_INDEX:HasGroupMenu( self.Group, Path )   
-
     if GroupMenu == self then
       if not MenuStamp or self.MenuStamp ~= MenuStamp then
         if ( not MenuTag ) or ( MenuTag and self.MenuTag and MenuTag == self.MenuTag ) then
@@ -1308,6 +1205,4 @@ do
     
     return self
   end
-
 end
-

Moose Development/Moose/Core/Message.lua

@@ -10,6 +10,7 @@
 --   * Send message to all players.
 --   * Send messages to a coalition.
 --   * Send messages to a specific group.
+--   * Send messages to a specific unit or client.
 -- 
 -- ===
 --
@@ -35,6 +36,7 @@
 --
 --   * To a @{Client} using @{#MESSAGE.ToClient}().
 --   * To a @{Wrapper.Group} using @{#MESSAGE.ToGroup}()
+--   * To a @{Wrapper.Unit} using @{#MESSAGE.ToUnit}()
 --   * To a coalition using @{#MESSAGE.ToCoalition}().
 --   * To the red coalition using @{#MESSAGE.ToRed}().
 --   * To the blue coalition using @{#MESSAGE.ToBlue}().
@@ -56,9 +58,9 @@
 --
 -- @field #MESSAGE
 MESSAGE = {
-	ClassName = "MESSAGE", 
+  ClassName = "MESSAGE",
-	MessageCategory = 0,
+  MessageCategory = 0,
-	MessageID = 0,
+  MessageID = 0,
 }
 
 --- Message Types
@@ -68,10 +70,9 @@ MESSAGE.Type = {
   Information = "Information",
   Briefing = "Briefing Report",
   Overview = "Overview Report",
-  Detailed = "Detailed Report"
+  Detailed = "Detailed Report",
 }
 
-
 --- Creates a new MESSAGE object. Note that these MESSAGE objects are not yet displayed on the display panel. You must use the functions @{ToClient} or @{ToCoalition} or @{ToAll} to send these Messages to the respective recipients.
 -- @param self
 -- @param #string MessageText is the text of the Message.
@@ -80,25 +81,26 @@ MESSAGE.Type = {
 -- @param #boolean ClearScreen (optional) Clear all previous messages if true.
 -- @return #MESSAGE
 -- @usage
--- -- Create a series of new Messages.
+--
--- -- MessageAll is meant to be sent to all players, for 25 seconds, and is classified as "Score".
+--    -- Create a series of new Messages.
--- -- MessageRED is meant to be sent to the RED players only, for 10 seconds, and is classified as "End of Mission", with ID "Win".
+--    -- MessageAll is meant to be sent to all players, for 25 seconds, and is classified as "Score".
--- -- MessageClient1 is meant to be sent to a Client, for 25 seconds, and is classified as "Score", with ID "Score".
+--    -- MessageRED is meant to be sent to the RED players only, for 10 seconds, and is classified as "End of Mission", with ID "Win".
--- -- MessageClient1 is meant to be sent to a Client, for 25 seconds, and is classified as "Score", with ID "Score".
+--    -- MessageClient1 is meant to be sent to a Client, for 25 seconds, and is classified as "Score", with ID "Score".
--- MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!",  25, "End of Mission" )
+--    -- MessageClient1 is meant to be sent to a Client, for 25 seconds, and is classified as "Score", with ID "Score".
--- MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", 25, "Penalty" )
+--   MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!",  25, "End of Mission" )
--- MessageClient1 = MESSAGE:New( "Congratulations, you've just hit a target",  25, "Score" )
+--   MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", 25, "Penalty" )
--- MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", 25, "Score")
+--   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 )
-	local self = BASE:Inherit( self, BASE:New() )
+  local self = BASE:Inherit( self, BASE:New() )
-	self:F( { MessageText, MessageDuration, MessageCategory } )
+  self:F( { MessageText, MessageDuration, MessageCategory } )
-
 
   self.MessageType = nil
 
   -- When no MessageCategory is given, we don't show it as a title...	
-	if MessageCategory and MessageCategory ~= "" then
+  if MessageCategory and MessageCategory ~= "" then
-	  if MessageCategory:sub(-1) ~= "\n" then
+    if MessageCategory:sub( -1 ) ~= "\n" then
       self.MessageCategory = MessageCategory .. ": "
     else
       self.MessageCategory = MessageCategory:sub( 1, -2 ) .. ":\n"
@@ -107,23 +109,22 @@ function MESSAGE:New( MessageText, MessageDuration, MessageCategory, ClearScreen
     self.MessageCategory = ""
   end
 
-  self.ClearScreen=false
+  self.ClearScreen = false
-  if ClearScreen~=nil then
+  if ClearScreen ~= nil then
-    self.ClearScreen=ClearScreen
+    self.ClearScreen = ClearScreen
   end
 
-	self.MessageDuration = MessageDuration or 5
+  self.MessageDuration = MessageDuration or 5
-	self.MessageTime = timer.getTime()
+  self.MessageTime = timer.getTime()
-	self.MessageText = MessageText:gsub("^\n","",1):gsub("\n$","",1)
+  self.MessageText = MessageText:gsub( "^\n", "", 1 ):gsub( "\n$", "", 1 )
 
-	self.MessageSent = false
+  self.MessageSent = false
-	self.MessageGroup = false
+  self.MessageGroup = false
-	self.MessageCoalition = false
+  self.MessageCoalition = false
 
-	return self
+  return self
 end
 
-
 --- Creates a new MESSAGE object of a certain type.
 -- Note that these MESSAGE objects are not yet displayed on the display panel.
 -- You must use the functions @{ToClient} or @{ToCoalition} or @{ToAll} to send these Messages to the respective recipients.
@@ -134,10 +135,12 @@ end
 -- @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 )
 
   local self = BASE:Inherit( self, BASE:New() )
@@ -145,54 +148,52 @@ function MESSAGE:NewType( MessageText, MessageType, ClearScreen )
 
   self.MessageType = MessageType
 
-  self.ClearScreen=false
+  self.ClearScreen = false
-  if ClearScreen~=nil then
+  if ClearScreen ~= nil then
-    self.ClearScreen=ClearScreen
+    self.ClearScreen = ClearScreen
   end
 
   self.MessageTime = timer.getTime()
-  self.MessageText = MessageText:gsub("^\n","",1):gsub("\n$","",1)
+  self.MessageText = MessageText:gsub( "^\n", "", 1 ):gsub( "\n$", "", 1 )
 
   return self
 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
+  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.
--- -- Note that the Message of MessageClient2 is overwriting the Message of MessageClient1.
--- ClientGroup = Group.getByName( "ClientGroup" )
 --
--- MessageClient1 = MESSAGE:New( "Congratulations, you've just hit a target", "Score", 25, "Score" ):ToClient( ClientGroup )
+--   -- Send the 2 messages created with the @{New} method to the Client Group.
--- MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", "Score", 25, "Score" ):ToClient( ClientGroup )
+--   -- Note that the Message of MessageClient2 is overwriting the Message of MessageClient1.
--- or
+--   ClientGroup = Group.getByName( "ClientGroup" )
--- MESSAGE:New( "Congratulations, you've just hit a target", "Score", 25, "Score" ):ToClient( ClientGroup )
+--
--- MESSAGE:New( "Congratulations, you've just killed a target", "Score", 25, "Score" ):ToClient( ClientGroup )
+--   MessageClient1 = MESSAGE:New( "Congratulations, you've just hit a target", "Score", 25, "Score" ):ToClient( ClientGroup )
--- or
+--   MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", "Score", 25, "Score" ):ToClient( ClientGroup )
--- MessageClient1 = MESSAGE:New( "Congratulations, you've just hit a target", "Score", 25, "Score" )
+--   or
--- MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", "Score", 25, "Score" )
+--   MESSAGE:New( "Congratulations, you've just hit a target", "Score", 25, "Score" ):ToClient( ClientGroup )
--- MessageClient1:ToClient( ClientGroup )
+--   MESSAGE:New( "Congratulations, you've just killed a target", "Score", 25, "Score" ):ToClient( ClientGroup )
--- MessageClient2:ToClient( ClientGroup )
+--   or
+--   MessageClient1 = MESSAGE:New( "Congratulations, you've just hit a target", "Score", 25, "Score" )
+--   MessageClient2 = MESSAGE:New( "Congratulations, you've just killed a target", "Score", 25, "Score" )
+--   MessageClient1:ToClient( ClientGroup )
+--   MessageClient2:ToClient( ClientGroup )
+--
 function MESSAGE:ToClient( Client, Settings )
-	self:F( Client )
+  self:F( Client )
 
-	if Client and Client:GetClientGroupID() then
+  if Client and Client:GetClientGroupID() then
 
     if self.MessageType then
       local Settings = Settings or ( Client and _DATABASE:GetPlayerSettings( Client:GetPlayerName() ) ) or _SETTINGS -- Core.Settings#SETTINGS
@@ -200,10 +201,13 @@ function MESSAGE:ToClient( Client, Settings )
       self.MessageCategory = "" -- self.MessageType .. ": "
     end
     
+    local Unit = Client:GetClient()
+    
     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 , self.ClearScreen)
+  		trigger.action.outTextForUnit( Unit:GetID(), self.MessageCategory .. self.MessageText:gsub("\n$",""):gsub("\n$",""), self.MessageDuration , self.ClearScreen)
 		end
 	end
 	
@@ -220,55 +224,108 @@ function MESSAGE:ToGroup( Group, Settings )
   if Group then
 
     if self.MessageType then
-      local Settings = Settings or ( Group and _DATABASE:GetPlayerSettings( Group:GetPlayerName() ) ) or _SETTINGS -- Core.Settings#SETTINGS
+      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 .. ": "
+    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 )
+    end
+  end
+
+  return self
+end
+
+--- Sends a MESSAGE to a Unit. 
+-- @param #MESSAGE self
+-- @param Wrapper.Unit#UNIT Unit to which the message is displayed.
+-- @return #MESSAGE Message object.
+function MESSAGE:ToUnit( Unit, Settings )
+  self:F( Unit.IdentifiableName )
+
+  if Unit then
+    
+    if self.MessageType then
+      local Settings = Settings or ( Unit and _DATABASE:GetPlayerSettings( Unit:GetPlayerName() ) ) or _SETTINGS -- Core.Settings#SETTINGS
       self.MessageDuration = Settings:GetMessageTime( 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.outTextForUnit( Unit:GetID(), self.MessageCategory .. self.MessageText:gsub("\n$",""):gsub("\n$",""), self.MessageDuration, self.ClearScreen )
     end
   end
   
   return self
 end
+
+--- Sends a MESSAGE to a Unit. 
+-- @param #MESSAGE self
+-- @param Wrapper.Unit#UNIT Unit to which the message is displayed.
+-- @return #MESSAGE Message object.
+function MESSAGE:ToUnit( Unit, Settings )
+  self:F( Unit.IdentifiableName )
+
+  if Unit then
+    
+    if self.MessageType then
+      local Settings = Settings or ( Unit and _DATABASE:GetPlayerSettings( Unit:GetPlayerName() ) ) or _SETTINGS -- Core.Settings#SETTINGS
+      self.MessageDuration = Settings:GetMessageTime( 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.outTextForUnit( Unit:GetID(), self.MessageCategory .. self.MessageText:gsub("\n$",""):gsub("\n$",""), self.MessageDuration, self.ClearScreen )
+    end
+  end
+  
+  return self
+end
+
 --- Sends a MESSAGE to the Blue coalition.
 -- @param #MESSAGE self
 -- @return #MESSAGE
 -- @usage
--- -- Send a message created with the @{New} method to the BLUE coalition.
+--
--- MessageBLUE = MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToBlue()
+--   -- Send a message created with the @{New} method to the BLUE coalition.
--- or
+--   MessageBLUE = MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToBlue()
--- MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToBlue()
+--   or
--- or
+--   MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToBlue()
--- MessageBLUE = MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" )
+--   or
--- MessageBLUE:ToBlue()
+--   MessageBLUE = MESSAGE:New( "To the BLUE Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" )
+--   MessageBLUE:ToBlue()
+--
 function MESSAGE:ToBlue()
-	self:F()
+  self:F()
 
-	self:ToCoalition( coalition.side.BLUE )
+  self:ToCoalition( coalition.side.BLUE )
 
-	return self
+  return self
 end
 
 --- Sends a MESSAGE to the Red Coalition.
 -- @param #MESSAGE self
 -- @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" ):ToRed()
+--   -- Send a message created with the @{New} method to the RED coalition.
--- or
+--   MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToRed()
--- MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToRed()
+--   or
--- or
+--   MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToRed()
--- MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" )
+--   or
--- MessageRED:ToRed()
+--   MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" )
-function MESSAGE:ToRed( )
+--   MessageRED:ToRed()
-	self:F()
+--
+function MESSAGE:ToRed()
+  self:F()
 
-	self:ToCoalition( coalition.side.RED )
+  self:ToCoalition( coalition.side.RED )
 
-	return self
+  return self
 end
 
 --- Sends a MESSAGE to a Coalition.
@@ -277,15 +334,17 @@ end
 -- @param Core.Settings#SETTINGS Settings (Optional) Settings for message display.
 -- @return #MESSAGE Message object.
 -- @usage
--- -- Send a message created with the @{New} method to the RED coalition.
+--
--- MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" ):ToCoalition( coalition.side.RED )
+--   -- Send a message created with the @{New} method to the RED coalition.
--- or
+--   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 )
--- 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 )
+--   or
--- or
+--   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 )
--- MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" )
+--   or
--- MessageRED:ToCoalition( coalition.side.RED )
+--   MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" )
+--   MessageRED:ToCoalition( coalition.side.RED )
+--
 function MESSAGE:ToCoalition( CoalitionSide, Settings )
-	self:F( CoalitionSide )
+  self:F( CoalitionSide )
 
   if self.MessageType then
     local Settings = Settings or _SETTINGS -- Core.Settings#SETTINGS
@@ -293,14 +352,14 @@ function MESSAGE:ToCoalition( CoalitionSide, Settings )
     self.MessageCategory = "" -- self.MessageType .. ": "
   end
 
-	if CoalitionSide then
+  if CoalitionSide then
     if self.MessageDuration ~= 0 then
-  		self:T( self.MessageCategory .. self.MessageText:gsub("\n$",""):gsub("\n$","") .. " / " .. self.MessageDuration )
+      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.MessageText:gsub( "\n$", "" ):gsub( "\n$", "" ), self.MessageDuration, self.ClearScreen )
     end
-	end
+  end
 
-	return self
+  return self
 end
 
 --- Sends a MESSAGE to a Coalition if the given Condition is true.
@@ -323,14 +382,16 @@ end
 -- @param Core.Settings#Settings Settings (Optional) Settings for message display.
 -- @return #MESSAGE
 -- @usage
--- -- Send a message created to all players.
+--
--- MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", "End of Mission", 25, "Win" ):ToAll()
+--   -- Send a message created to all players.
--- or
+--   MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", "End of Mission", 25, "Win" ):ToAll()
--- MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", "End of Mission", 25, "Win" ):ToAll()
+--   or
--- or
+--   MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", "End of Mission", 25, "Win" ):ToAll()
--- MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", "End of Mission", 25, "Win" )
+--   or
--- MessageAll:ToAll()
+--   MessageAll = MESSAGE:New( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", "End of Mission", 25, "Win" )
-function MESSAGE:ToAll(Settings)
+--   MessageAll:ToAll()
+--
+function MESSAGE:ToAll( Settings )
   self:F()
 
   if self.MessageType then
@@ -340,14 +401,13 @@ function MESSAGE:ToAll(Settings)
   end
 
   if self.MessageDuration ~= 0 then
-    self:T( self.MessageCategory .. self.MessageText:gsub("\n$",""):gsub("\n$","") .. " / " .. self.MessageDuration )
+    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, self.ClearScreen )
   end
 
   return self
 end
 
-
 --- Sends a MESSAGE to all players if the given Condition is true.
 -- @param #MESSAGE self
 -- @return #MESSAGE
@@ -357,5 +417,5 @@ function MESSAGE:ToAllIf( Condition )
     self:ToAll()
   end
 
-	return self
+  return self
 end

Moose Development/Moose/Core/Radio.lua

@@ -1,832 +0,0 @@
---- **Core** - Is responsible for everything that is related to radio transmission and you can hear in DCS, be it TACAN beacons, Radio transmissions.
--- 
--- ===
--- 
--- ## Features:
--- 
---   * Provide radio functionality to broadcast radio transmissions.
---   * Provide beacon functionality to assist pilots.
---
--- The Radio contains 2 classes : RADIO and BEACON
---  
--- What are radio communications in DCS?
--- 
---   * Radio transmissions consist of **sound files** that are broadcasted on a specific **frequency** (e.g. 115MHz) and **modulation** (e.g. AM),
---   * They can be **subtitled** for a specific **duration**, the **power** in Watts of the transmiter's antenna can be set, and the transmission can be **looped**.
--- 
--- How to supply DCS my own Sound Files?
---   
---   * Your sound files need to be encoded in **.ogg** or .wav,
---   * Your sound files should be **as tiny as possible**. It is suggested you encode in .ogg with low bitrate and sampling settings,
---   * They need to be added in .\l10n\DEFAULT\ in you .miz file (wich can be decompressed like a .zip file),
---   * For simplicity sake, you can **let DCS' Mission Editor add the file** itself, by creating a new Trigger with the action "Sound to Country", and choosing your sound file and a country you don't use in your mission.
---   
--- Due to weird DCS quirks, **radio communications behave differently** if sent by a @{Wrapper.Unit#UNIT} or a @{Wrapper.Group#GROUP} or by any other @{Wrapper.Positionable#POSITIONABLE}
--- 
---   * If the transmitter is a @{Wrapper.Unit#UNIT} or a @{Wrapper.Group#GROUP}, DCS will set the power of the transmission automatically,
---   * If the transmitter is any other @{Wrapper.Positionable#POSITIONABLE}, the transmisison can't be subtitled or looped.
---   
--- Note that obviously, the **frequency** and the **modulation** of the transmission are important only if the players are piloting an **Advanced System Modelling** enabled aircraft,
--- like the A10C or the Mirage 2000C. They will **hear the transmission** if they are tuned on the **right frequency and modulation** (and if they are close enough - more on that below).
--- If an FC3 aircraft is used, it will **hear every communication, whatever the frequency and the modulation** is set to. The same is true for TACAN beacons. If your aircraft isn't compatible,
--- you won't hear/be able to use the TACAN beacon informations.
---
--- ===
---
--- ### Authors: Hugues "Grey_Echo" Bousquet, funkyfranky
---
--- @module Core.Radio
--- @image Core_Radio.JPG
-
-
---- Models the radio capability.
--- 
--- ## 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,
---   * 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}
--- 
---   * @{#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 transmitter is a @{Wrapper.Unit#UNIT} or a @{Wrapper.Group#GROUP}
--- 
---   * @{#RADIO.SetSubtitle}() : Set both the subtitle and its duration,
---   * @{#RADIO.NewUnitTransmission}() : Shortcut to set all the relevant parameters in one method call
--- 
--- Additional Methods to set relevant parameters if the transmitter is any other @{Wrapper.Positionable#POSITIONABLE}
--- 
---   * @{#RADIO.SetPower}() : Sets the power of the antenna in Watts
---   * @{#RADIO.NewGenericTransmission}() : Shortcut to set all the relevant parameters in one method call
--- 
--- What is this power thing?
--- 
---   * If your transmission is sent by a @{Wrapper.Positionable#POSITIONABLE} other than a @{Wrapper.Unit#UNIT} or a @{Wrapper.Group#GROUP}, you can set the power of the antenna,
---   * Otherwise, DCS sets it automatically, depending on what's available on your Unit,
---   * If the player gets **too far** from the transmitter, or if the antenna is **too weak**, the transmission will **fade** and **become noisyer**,
---   * This an automated DCS calculation you have no say on,
---   * For reference, a standard VOR station has a 100 W antenna, a standard AA TACAN has a 120 W antenna, and civilian ATC's antenna usually range between 300 and 500 W,
---   * Note that if the transmission has a subtitle, it will be readable, regardless of the quality of the transmission. 
---   
--- @type RADIO
--- @field Wrapper.Controllable#CONTROLLABLE Positionable The @{#CONTROLLABLE} that will transmit the radio calls.
--- @field #string FileName Name of the sound file played.
--- @field #number Frequency Frequency of the transmission in Hz.
--- @field #number Modulation Modulation of the transmission (either radio.modulation.AM or radio.modulation.FM).
--- @field #string Subtitle Subtitle of the transmission.
--- @field #number SubtitleDuration Duration of the Subtitle in seconds.
--- @field #number Power Power of the antenna is Watts.
--- @field #boolean Loop Transmission is repeated (default true).
--- @field #string alias Name of the radio transmitter.
--- @extends Core.Base#BASE
-RADIO = {
-  ClassName = "RADIO",
-  FileName = "",
-  Frequency = 0,
-  Modulation = radio.modulation.AM,
-  Subtitle = "",
-  SubtitleDuration = 0,
-  Power = 100,
-  Loop = false,
-  alias=nil,
-}
-
---- Create a new RADIO Object. This doesn't broadcast a transmission, though, use @{#RADIO.Broadcast} to actually broadcast.
--- If you want to create a RADIO, you probably should use @{Wrapper.Positionable#POSITIONABLE.GetRadio}() instead.
--- @param #RADIO self
--- @param Wrapper.Positionable#POSITIONABLE Positionable The @{Positionable} that will receive radio capabilities.
--- @return #RADIO The RADIO object or #nil if Positionable is invalid.
-function RADIO:New(Positionable)
-
-  -- Inherit base
-  local self = BASE:Inherit( self, BASE:New() ) -- Core.Radio#RADIO
-  self:F(Positionable)
-  
-  if Positionable:GetPointVec2() then -- It's stupid, but the only way I found to make sure positionable is valid
-    self.Positionable = Positionable
-    return self
-  end
-  
-  self:E({error="The passed positionable is invalid, no RADIO created!", positionable=Positionable})
-  return nil
-end
-
---- Set alias of the transmitter.
--- @param #RADIO self
--- @param #string alias Name of the radio transmitter.
--- @return #RADIO self
-function RADIO:SetAlias(alias)
-  self.alias=tostring(alias)
-  return self
-end
-
---- Get alias of the transmitter.
--- @param #RADIO self
--- @return #string Name of the transmitter.
-function RADIO:GetAlias()
-  return tostring(self.alias)
-end
-
---- Set the file name for the radio transmission.
--- @param #RADIO self
--- @param #string FileName File name of the sound file (i.e. "Noise.ogg")
--- @return #RADIO self
-function RADIO:SetFileName(FileName)
-  self:F2(FileName)
-  
-  if type(FileName) == "string" then
-  
-    if FileName:find(".ogg") or FileName:find(".wav") then
-      if not FileName:find("l10n/DEFAULT/") then
-        FileName = "l10n/DEFAULT/" .. FileName
-      end
-      
-      self.FileName = FileName
-      return self
-    end
-  end
-  
-  self:E({"File name invalid. Maybe something wrong with the extension?", FileName})
-  return self
-end
-
---- Set the frequency for the radio transmission.
--- If the transmitting positionable is a unit or group, this also set the command "SetFrequency" with the defined frequency and modulation.
--- @param #RADIO self
--- @param #number Frequency Frequency in MHz. Ranges allowed for radio transmissions in DCS : 30-87.995 / 108-173.995 / 225-399.975MHz.
--- @return #RADIO self
-function RADIO:SetFrequency(Frequency)
-  self:F2(Frequency)
-  
-  if type(Frequency) == "number" then
-  
-    -- If frequency is in range
-    if (Frequency >= 30 and Frequency <= 87.995) or (Frequency >= 108 and Frequency <= 173.995) or (Frequency >= 225 and Frequency <= 399.975) then
-    
-      -- Convert frequency from MHz to Hz
-      self.Frequency = Frequency * 1000000
-            
-      -- If the RADIO is attached to a UNIT or a GROUP, we need to send the DCS Command "SetFrequency" to change the UNIT or GROUP frequency
-      if self.Positionable.ClassName == "UNIT" or self.Positionable.ClassName == "GROUP" then
-      
-        local commandSetFrequency={
-          id = "SetFrequency",
-          params = {
-            frequency  = self.Frequency,
-            modulation = self.Modulation,
-          }
-        }            
-      
-        self:T2(commandSetFrequency)
-        self.Positionable:SetCommand(commandSetFrequency)
-      end
-      
-      return self
-    end
-  end
-  
-  self:E({"Frequency is outside of DCS Frequency ranges (30-80, 108-152, 225-400). Frequency unchanged.", Frequency})
-  return self
-end
-
---- Set AM or FM modulation of the radio transmitter.
--- @param #RADIO self
--- @param #number Modulation Modulation is either radio.modulation.AM or radio.modulation.FM.
--- @return #RADIO self
-function RADIO:SetModulation(Modulation)
-  self:F2(Modulation)
-  if type(Modulation) == "number" then
-    if Modulation == radio.modulation.AM or Modulation == radio.modulation.FM then --TODO Maybe make this future proof if ED decides to add an other modulation ?
-      self.Modulation = Modulation
-      return self
-    end
-  end
-  self:E({"Modulation is invalid. Use DCS's enum radio.modulation. Modulation unchanged.", self.Modulation})
-  return self
-end
-
---- Check validity of the power passed and sets RADIO.Power
--- @param #RADIO self
--- @param #number Power Power in W.
--- @return #RADIO self
-function RADIO:SetPower(Power)
-  self:F2(Power)
-  
-  if type(Power) == "number" then
-    self.Power = math.floor(math.abs(Power)) --TODO Find what is the maximum power allowed by DCS and limit power to that
-  else
-    self:E({"Power is invalid. Power unchanged.", self.Power})
-  end
-  
-  return self
-end
-
---- Set message looping on or off.
--- @param #RADIO self
--- @param #boolean Loop If true, message is repeated indefinitely.
--- @return #RADIO self
-function RADIO:SetLoop(Loop)
-  self:F2(Loop)
-  if type(Loop) == "boolean" then
-    self.Loop = Loop
-    return self
-  end
-  self:E({"Loop is invalid. Loop unchanged.", self.Loop})
-  return self
-end
-
---- Check validity of the subtitle and the subtitleDuration  passed and sets RADIO.subtitle and RADIO.subtitleDuration
--- Both parameters are mandatory, since it wouldn't make much sense to change the Subtitle and not its duration
--- @param #RADIO self
--- @param #string Subtitle
--- @param #number SubtitleDuration in s
--- @return #RADIO self
--- @usage
--- -- create the broadcaster and attaches it a RADIO
--- local MyUnit = UNIT:FindByName("MyUnit")
--- local MyUnitRadio = MyUnit:GetRadio()
--- 
--- -- add a subtitle for the next transmission, which will be up for 10s
--- MyUnitRadio:SetSubtitle("My Subtitle, 10)
-function RADIO:SetSubtitle(Subtitle, SubtitleDuration)
-  self:F2({Subtitle, SubtitleDuration})
-  if type(Subtitle) == "string" then
-    self.Subtitle = Subtitle
-  else
-    self.Subtitle = ""
-    self:E({"Subtitle is invalid. Subtitle reset.", self.Subtitle})
-  end
-  if type(SubtitleDuration) == "number" then
-    self.SubtitleDuration = SubtitleDuration
-  else
-    self.SubtitleDuration = 0
-    self:E({"SubtitleDuration is invalid. SubtitleDuration reset.", self.SubtitleDuration})  
-  end
-  return self
-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 anything but a UNIT or a GROUP,
--- but it will work with a UNIT or a GROUP anyway. 
--- Only the #RADIO and the Filename are mandatory
--- @param #RADIO self
--- @param #string FileName Name of the sound file that will be transmitted.
--- @param #number Frequency Frequency in MHz.
--- @param #number Modulation Modulation of frequency, which is either radio.modulation.AM or radio.modulation.FM.
--- @param #number Power Power in W.
--- @return #RADIO self
-function RADIO:NewGenericTransmission(FileName, Frequency, Modulation, Power, Loop)
-  self:F({FileName, Frequency, Modulation, Power})
-  
-  self:SetFileName(FileName)
-  if Frequency then self:SetFrequency(Frequency) end
-  if Modulation then self:SetModulation(Modulation) end
-  if Power then self:SetPower(Power) end
-  if Loop then self:SetLoop(Loop) end
-  
-  return self
-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}. 
--- Only the RADIO and the Filename are mandatory.
--- @param #RADIO self
--- @param #string FileName Name of sound file.
--- @param #string Subtitle Subtitle to be displayed with sound file.
--- @param #number SubtitleDuration Duration of subtitle display in seconds.
--- @param #number Frequency Frequency in MHz.
--- @param #number Modulation Modulation which can be either radio.modulation.AM or radio.modulation.FM
--- @param #boolean Loop If true, loop message.
--- @return #RADIO self
-function RADIO:NewUnitTransmission(FileName, Subtitle, SubtitleDuration, Frequency, Modulation, Loop)
-  self:F({FileName, Subtitle, SubtitleDuration, Frequency, Modulation, Loop})
-
-  -- Set file name.
-  self:SetFileName(FileName)
-
-  -- Set modulation AM/FM.
-  if Modulation then
-    self:SetModulation(Modulation)
-  end
-
-  -- Set frequency.
-  if Frequency then 
-    self:SetFrequency(Frequency)
-  end
-  
-  -- Set subtitle.
-  if Subtitle then
-    self:SetSubtitle(Subtitle, SubtitleDuration or 0)
-  end
- 
-  -- Set Looping.
-  if Loop then 
-    self:SetLoop(Loop)
-  end
-  
-  return self
-end
-
---- Broadcast the transmission.
--- * The Radio has to be populated with the new transmission before broadcasting.
--- * Please use RADIO setters or either @{#RADIO.NewGenericTransmission} or @{#RADIO.NewUnitTransmission}
--- * This class is in fact pretty smart, it determines the right DCS function to use depending on the type of POSITIONABLE
--- * 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
--- * If your POSITIONABLE is a UNIT or a GROUP, the Power is ignored.
--- * If your POSITIONABLE is not a UNIT or a GROUP, the Subtitle, SubtitleDuration are ignored
--- @param #RADIO self
--- @param #boolean viatrigger Use trigger.action.radioTransmission() in any case, i.e. also for UNITS and GROUPS.
--- @return #RADIO self
-function RADIO:Broadcast(viatrigger)
-  self:F({viatrigger=viatrigger})
-  
-  -- If the POSITIONABLE is actually a UNIT or a GROUP, use the more complicated DCS command system.
-  if (self.Positionable.ClassName=="UNIT" or self.Positionable.ClassName=="GROUP") and (not viatrigger) then
-    self:T("Broadcasting from a UNIT or a GROUP")
-
-    local commandTransmitMessage={
-      id = "TransmitMessage",
-      params = {
-        file = self.FileName,
-        duration = self.SubtitleDuration,
-        subtitle = self.Subtitle,
-        loop = self.Loop,
-      }}
-    
-    self:T3(commandTransmitMessage)
-    self.Positionable:SetCommand(commandTransmitMessage)
-  else
-    -- If the POSITIONABLE is anything else, we revert to the general singleton function
-    -- I need to give it a unique name, so that the transmission can be stopped later. I use the class ID
-    self:T("Broadcasting from a POSITIONABLE")
-    trigger.action.radioTransmission(self.FileName, self.Positionable:GetPositionVec3(), self.Modulation, self.Loop, self.Frequency, self.Power, tostring(self.ID))
-  end
-  
-  return self
-end
-
-
-
---- Stops a transmission
--- This function is especially usefull to stop the broadcast of looped transmissions
--- @param #RADIO self
--- @return #RADIO self
-function RADIO:StopBroadcast()
-  self:F()
-  -- If the POSITIONABLE is a UNIT or a GROUP, stop the transmission with the DCS "StopTransmission" command 
-  if self.Positionable.ClassName == "UNIT" or self.Positionable.ClassName == "GROUP" then
-  
-    local commandStopTransmission={id="StopTransmission", params={}}
-  
-    self.Positionable:SetCommand(commandStopTransmission)
-  else
-    -- Else, we use the appropriate singleton funciton
-    trigger.action.stopRadioTransmission(tostring(self.ID))
-  end
-  return self
-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. 
--- 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.
--- 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.
--- Use @{#BEACON:StopRadioBeacon}() to stop it.
--- 
--- @type BEACON
--- @field #string ClassName Name of the class "BEACON".
--- @field Wrapper.Controllable#CONTROLLABLE Positionable The @{#CONTROLLABLE} that will receive radio capabilities.
--- @extends Core.Base#BASE
-BEACON = {
-  ClassName = "BEACON",
-  Positionable = nil,
-  name=nil,
-}
-
---- Beacon types supported by DCS. 
--- @type BEACON.Type
--- @field #number NULL
--- @field #number VOR
--- @field #number DME
--- @field #number VOR_DME
--- @field #number TACAN TACtical Air Navigation system.
--- @field #number VORTAC
--- @field #number RSBN
--- @field #number BROADCAST_STATION
--- @field #number HOMER
--- @field #number AIRPORT_HOMER
--- @field #number AIRPORT_HOMER_WITH_MARKER
--- @field #number ILS_FAR_HOMER
--- @field #number ILS_NEAR_HOMER
--- @field #number ILS_LOCALIZER
--- @field #number ILS_GLIDESLOPE
--- @field #number PRMG_LOCALIZER
--- @field #number PRMG_GLIDESLOPE
--- @field #number ICLS Same as ICLS glideslope.
--- @field #number ICLS_LOCALIZER
--- @field #number ICLS_GLIDESLOPE
--- @field #number NAUTICAL_HOMER
-BEACON.Type={
-  NULL                      = 0, 
-  VOR                       = 1,
-  DME                       = 2,
-  VOR_DME                   = 3, 
-  TACAN                     = 4,
-  VORTAC                    = 5, 
-  RSBN                      = 128,
-  BROADCAST_STATION         = 1024, 
-  HOMER                     = 8,
-  AIRPORT_HOMER             = 4104, 
-  AIRPORT_HOMER_WITH_MARKER = 4136, 
-  ILS_FAR_HOMER             = 16408,
-  ILS_NEAR_HOMER            = 16424, 
-  ILS_LOCALIZER             = 16640,
-  ILS_GLIDESLOPE            = 16896,
-  PRMG_LOCALIZER            = 33024,
-  PRMG_GLIDESLOPE           = 33280,
-  ICLS                      = 131584, --leaving this in here but it is the same as ICLS_GLIDESLOPE
-  ICLS_LOCALIZER            = 131328,
-  ICLS_GLIDESLOPE           = 131584,
-  NAUTICAL_HOMER            = 65536,
-
-}
-
---- Beacon systems supported by DCS. https://wiki.hoggitworld.com/view/DCS_command_activateBeacon
--- @type BEACON.System
--- @field #number PAR_10 ?
--- @field #number RSBN_5 Russian VOR/DME system.
--- @field #number TACAN TACtical Air Navigation system on ground.
--- @field #number TACAN_TANKER_X TACtical Air Navigation system for tankers on X band.
--- @field #number TACAN_TANKER_Y TACtical Air Navigation system for tankers on Y band.
--- @field #number VOR Very High Frequency Omni-Directional Range
--- @field #number ILS_LOCALIZER ILS localizer
--- @field #number ILS_GLIDESLOPE ILS glideslope.
--- @field #number PRGM_LOCALIZER PRGM localizer.
--- @field #number PRGM_GLIDESLOPE PRGM glideslope.
--- @field #number BROADCAST_STATION Broadcast station.
--- @field #number VORTAC Radio-based navigational aid for aircraft pilots consisting of a co-located VHF omnidirectional range (VOR) beacon and a tactical air navigation system (TACAN) beacon.
--- @field #number TACAN_AA_MODE_X TACtical Air Navigation for aircraft on X band.
--- @field #number TACAN_AA_MODE_Y TACtical Air Navigation for aircraft on Y band.
--- @field #number VORDME Radio beacon that combines a VHF omnidirectional range (VOR) with a distance measuring equipment (DME).
--- @field #number ICLS_LOCALIZER Carrier landing system.
--- @field #number ICLS_GLIDESLOPE Carrier landing system.
-BEACON.System={
-  PAR_10            = 1, 
-  RSBN_5            = 2, 
-  TACAN             = 3, 
-  TACAN_TANKER_X    = 4,
-  TACAN_TANKER_Y    = 5,
-  VOR               = 6, 
-  ILS_LOCALIZER     = 7, 
-  ILS_GLIDESLOPE    = 8,
-  PRMG_LOCALIZER    = 9,
-  PRMG_GLIDESLOPE   = 10,
-  BROADCAST_STATION = 11,
-  VORTAC            = 12,
-  TACAN_AA_MODE_X   = 13,
-  TACAN_AA_MODE_Y   = 14,
-  VORDME            = 15,
-  ICLS_LOCALIZER    = 16,
-  ICLS_GLIDESLOPE   = 17,
-}
-
---- Create a new BEACON Object. This doesn't activate the beacon, though, use @{#BEACON.ActivateTACAN} etc.
--- If you want to create a BEACON, you probably should use @{Wrapper.Positionable#POSITIONABLE.GetBeacon}() instead.
--- @param #BEACON self
--- @param Wrapper.Positionable#POSITIONABLE Positionable The @{Positionable} that will receive radio capabilities.
--- @return #BEACON Beacon object or #nil if the positionable is invalid.
-function BEACON:New(Positionable)
-
-  -- Inherit BASE.
-  local self=BASE:Inherit(self, BASE:New()) --#BEACON
-  
-  -- Debug.
-  self:F(Positionable)
-  
-  -- Set positionable.
-  if Positionable:GetPointVec2() then -- It's stupid, but the only way I found to make sure positionable is valid
-    self.Positionable = Positionable
-    self.name=Positionable:GetName()
-    self:I(string.format("New BEACON %s", tostring(self.name)))
-    return self
-  end
-  
-  self:E({"The passed positionable is invalid, no BEACON created", Positionable})
-  return nil
-end
-
-
---- Activates a TACAN BEACON.
--- @param #BEACON self
--- @param #number Channel TACAN channel, i.e. the "10" part in "10Y".
--- @param #string Mode TACAN mode, i.e. the "Y" part in "10Y".
--- @param #string Message The Message that is going to be coded in Morse and broadcasted by the beacon.
--- @param #boolean Bearing If true, beacon provides bearing information. If false (or nil), only distance information is available.
--- @param #number Duration How long will the beacon last in seconds. Omit for forever.
--- @return #BEACON self
--- @usage
--- -- Let's create a TACAN Beacon for a tanker
--- local myUnit = UNIT:FindByName("MyUnit") 
--- local myBeacon = myUnit:GetBeacon() -- Creates the beacon
--- 
--- myBeacon:ActivateTACAN(20, "Y", "TEXACO", true) -- Activate the beacon
-function BEACON:ActivateTACAN(Channel, Mode, Message, Bearing, Duration)
-  self:T({channel=Channel, mode=Mode, callsign=Message, bearing=Bearing, duration=Duration})
-  
-  -- Get frequency.
-  local Frequency=UTILS.TACANToFrequency(Channel, Mode)
-  
-  -- Check.
-  if not Frequency then 
-    self:E({"The passed TACAN channel is invalid, the BEACON is not emitting"})
-    return self
-  end
-  
-  -- Beacon type.
-  local Type=BEACON.Type.TACAN
-  
-  -- Beacon system.  
-  local System=BEACON.System.TACAN
-  
-  -- Check if unit is an aircraft and set system accordingly.
-  local AA=self.Positionable:IsAir()
-  if AA then
-    System=5 --NOTE: 5 is how you cat the correct tanker behaviour! --BEACON.System.TACAN_TANKER
-    -- Check if "Y" mode is selected for aircraft.
-    if Mode~="Y" then
-      self:E({"WARNING: The POSITIONABLE you want to attach the AA Tacan Beacon is an aircraft: Mode should Y !The BEACON is not emitting.", self.Positionable})
-    end
-  end
-  
-  -- Attached unit.
-  local UnitID=self.Positionable:GetID()
-  
-  -- Debug.
-  self:I({string.format("BEACON Activating TACAN %s: Channel=%d%s, Morse=%s, Bearing=%s, Duration=%s!", tostring(self.name), Channel, Mode, Message, tostring(Bearing), tostring(Duration))})
-    
-  -- Start beacon.
-  self.Positionable:CommandActivateBeacon(Type, System, Frequency, UnitID, Channel, Mode, AA, Message, Bearing)
-      
-  -- Stop sheduler.
-  if Duration then
-    self.Positionable:DeactivateBeacon(Duration)
-  end
-  
-  return self
-end
-
---- Activates an ICLS BEACON. The unit the BEACON is attached to should be an aircraft carrier supporting this system.
--- @param #BEACON self
--- @param #number Channel ICLS channel.
--- @param #string Callsign The Message that is going to be coded in Morse and broadcasted by the beacon.
--- @param #number Duration How long will the beacon last in seconds. Omit for forever.
--- @return #BEACON self
-function BEACON:ActivateICLS(Channel, Callsign, Duration)
-  self:F({Channel=Channel, Callsign=Callsign, Duration=Duration})
-  
-  -- Attached unit.
-  local UnitID=self.Positionable:GetID()
-  
-  -- Debug
-  self:T2({"ICLS BEACON started!"})
-    
-  -- Start beacon.
-  self.Positionable:CommandActivateICLS(Channel, UnitID, Callsign)
-      
-  -- Stop sheduler
-  if Duration then -- Schedule the stop of the BEACON if asked by the MD
-    self.Positionable:DeactivateBeacon(Duration)
-  end
-  
-  return self
-end
-
-
-
-
-
-
---- Activates a TACAN BEACON on an Aircraft.
--- @param #BEACON self
--- @param #number TACANChannel (the "10" part in "10Y"). Note that AA TACAN are only available on Y Channels
--- @param #string Message The Message that is going to be coded in Morse and broadcasted by the beacon
--- @param #boolean Bearing Can the BEACON be homed on ?
--- @param #number BeaconDuration How long will the beacon last in seconds. Omit for forever.
--- @return #BEACON self
--- @usage
--- -- Let's create a TACAN Beacon for a tanker
--- local myUnit = UNIT:FindByName("MyUnit") 
--- local myBeacon = myUnit:GetBeacon() -- Creates the beacon
--- 
--- myBeacon:AATACAN(20, "TEXACO", true) -- Activate the beacon
-function BEACON:AATACAN(TACANChannel, Message, Bearing, BeaconDuration)
-  self:F({TACANChannel, Message, Bearing, BeaconDuration})
-  
-  local IsValid = true
-  
-  if not self.Positionable:IsAir() then
-    self:E({"The POSITIONABLE you want to attach the AA Tacan Beacon is not an aircraft ! The BEACON is not emitting", self.Positionable})
-    IsValid = false
-  end
-    
-  local Frequency = self:_TACANToFrequency(TACANChannel, "Y")
-  if not Frequency then 
-    self:E({"The passed TACAN channel is invalid, the BEACON is not emitting"})
-    IsValid = false
-  end
-  
-  -- I'm using the beacon type 4 (BEACON_TYPE_TACAN). For System, I'm using 5 (TACAN_TANKER_MODE_Y) if the bearing shows its bearing
-  -- or 14 (TACAN_AA_MODE_Y) if it does not
-  local System
-  if Bearing then
-    System = 5
-  else
-    System = 14
-  end
-  
-  if IsValid then -- Starts the BEACON
-    self:T2({"AA TACAN BEACON started !"})
-    self.Positionable:SetCommand({
-      id = "ActivateBeacon",
-      params = {
-        type = 4,
-        system = System,
-        callsign = Message,
-        frequency = Frequency,
-        }
-      })
-      
-    if BeaconDuration then -- Schedule the stop of the BEACON if asked by the MD
-      SCHEDULER:New(nil, 
-      function()
-        self:StopAATACAN()
-      end, {}, BeaconDuration)
-    end
-  end
-  
-  return self
-end
-
---- Stops the AA TACAN BEACON
--- @param #BEACON self
--- @return #BEACON self
-function BEACON:StopAATACAN()
-  self:F()
-  if not self.Positionable then
-    self:E({"Start the beacon first before stoping it !"})
-  else
-    self.Positionable:SetCommand({
-      id = 'DeactivateBeacon', 
-        params = { 
-      } 
-    })
-  end
-end
-
-
---- Activates a general pupose Radio Beacon
--- This uses the very generic singleton function "trigger.action.radioTransmission()" provided by DCS to broadcast a sound file on a specific frequency.
--- Although any frequency could be used, only 2 DCS Modules can home on radio beacons at the time of writing : the Huey and the Mi-8. 
--- They can home in on these specific frequencies : 
--- * **Mi8**
--- * R-828 -> 20-60MHz
--- * ARKUD -> 100-150MHz (canal 1 : 114166, canal 2 : 114333, canal 3 : 114583, canal 4 : 121500, canal 5 : 123100, canal 6 : 124100) AM
--- * ARK9 -> 150-1300KHz
--- * **Huey**
--- * AN/ARC-131 -> 30-76 Mhz FM
--- @param #BEACON self
--- @param #string FileName The name of the audio file
--- @param #number Frequency in MHz
--- @param #number Modulation either radio.modulation.AM or radio.modulation.FM
--- @param #number Power in W
--- @param #number BeaconDuration How long will the beacon last in seconds. Omit for forever.
--- @return #BEACON self
--- @usage
--- -- Let's create a beacon for a unit in distress.
--- -- Frequency will be 40MHz FM (home-able by a Huey's AN/ARC-131)
--- -- The beacon they use is battery-powered, and only lasts for 5 min
--- local UnitInDistress = UNIT:FindByName("Unit1")
--- local UnitBeacon = UnitInDistress:GetBeacon()
--- 
--- -- Set the beacon and start it
--- UnitBeacon:RadioBeacon("MySoundFileSOS.ogg", 40, radio.modulation.FM, 20, 5*60)
-function BEACON:RadioBeacon(FileName, Frequency, Modulation, Power, BeaconDuration)
-  self:F({FileName, Frequency, Modulation, Power, BeaconDuration})
-  local IsValid = false
-  
-  -- Check the filename
-  if type(FileName) == "string" then
-    if FileName:find(".ogg") or FileName:find(".wav") then
-      if not FileName:find("l10n/DEFAULT/") then
-        FileName = "l10n/DEFAULT/" .. FileName
-      end
-      IsValid = true
-    end
-  end
-  if not IsValid then
-    self:E({"File name invalid. Maybe something wrong with the extension ? ", FileName})
-  end
-  
-  -- Check the Frequency
-  if type(Frequency) ~= "number" and IsValid then
-    self:E({"Frequency invalid. ", Frequency})
-    IsValid = false
-  end
-  Frequency = Frequency * 1000000 -- Conversion to Hz
-  
-  -- Check the modulation
-  if Modulation ~= radio.modulation.AM and Modulation ~= radio.modulation.FM and IsValid then --TODO Maybe make this future proof if ED decides to add an other modulation ?
-    self:E({"Modulation is invalid. Use DCS's enum radio.modulation.", Modulation})
-    IsValid = false
-  end
-  
-  -- Check the Power
-  if type(Power) ~= "number" and IsValid then
-    self:E({"Power is invalid. ", Power})
-    IsValid = false
-  end
-  Power = math.floor(math.abs(Power)) --TODO Find what is the maximum power allowed by DCS and limit power to that
-  
-  if IsValid then
-    self:T2({"Activating Beacon on ", Frequency, Modulation})
-    -- Note that this is looped. I have to give this transmission a unique name, I use the class ID
-    trigger.action.radioTransmission(FileName, self.Positionable:GetPositionVec3(), Modulation, true, Frequency, Power, tostring(self.ID))
-    
-     if BeaconDuration then -- Schedule the stop of the BEACON if asked by the MD
-       SCHEDULER:New( nil, 
-         function()
-           self:StopRadioBeacon()
-         end, {}, BeaconDuration)
-     end
-  end 
-end
-
---- Stops the AA TACAN BEACON
--- @param #BEACON self
--- @return #BEACON self
-function BEACON:StopRadioBeacon()
-  self:F()
-  -- The unique name of the transmission is the class ID
-  trigger.action.stopRadioTransmission(tostring(self.ID))
-  return self
-end
-
---- Converts a TACAN Channel/Mode couple into a frequency in Hz
--- @param #BEACON self
--- @param #number TACANChannel
--- @param #string TACANMode
--- @return #number Frequecy
--- @return #nil if parameters are invalid
-function BEACON:_TACANToFrequency(TACANChannel, TACANMode)
-  self:F3({TACANChannel, TACANMode})
-
-  if type(TACANChannel) ~= "number" then
-    if TACANMode ~= "X" and TACANMode ~= "Y" then
-      return nil -- error in arguments
-    end
-  end
-  
--- This code is largely based on ED's code, in DCS World\Scripts\World\Radio\BeaconTypes.lua, line 137.
--- I have no idea what it does but it seems to work
-  local A = 1151 -- 'X', channel >= 64
-  local B = 64   -- channel >= 64
-  
-  if TACANChannel < 64 then
-    B = 1
-  end
-  
-  if TACANMode == 'Y' then
-    A = 1025
-    if TACANChannel < 64 then
-      A = 1088
-    end
-  else -- 'X'
-    if TACANChannel < 64 then
-      A = 962
-    end
-  end
-  
-  return (A + TACANChannel - B) * 1000000
-end
-
-

Moose Development/Moose/Core/Report.lua

@@ -15,7 +15,6 @@
 -- @module Core.Report
 -- @image Core_Report.JPG
 
-
 --- @type REPORT
 -- @extends Core.Base#BASE
 
@@ -45,28 +44,26 @@ end
 --- Has the REPORT Text?
 -- @param #REPORT self
 -- @return #boolean
-function REPORT:HasText() --R2.1
+function REPORT:HasText() -- R2.1
 
   return #self.Report > 0
 end
 
-
 --- Set indent of a REPORT.
 -- @param #REPORT self
 -- @param #number Indent
 -- @return #REPORT
-function REPORT:SetIndent( Indent ) --R2.1
+function REPORT:SetIndent( Indent ) -- R2.1
   self.Indent = Indent
   return self
 end
 
-
 --- Add a new line to a REPORT.
 -- @param #REPORT self
 -- @param #string Text
 -- @return #REPORT
 function REPORT:Add( Text )
-  self.Report[#self.Report+1] = Text
+  self.Report[#self.Report + 1] = Text
   return self
 end
 
@@ -76,17 +73,17 @@ end
 -- @param #string Separator (optional) The start of each report line can begin with an optional separator character. This can be a "-", or "#", or "*". You're free to choose what you find the best.
 -- @return #REPORT
 function REPORT:AddIndent( Text, Separator )
-  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 ) )
+  self.Report[#self.Report + 1] = ((Separator and Separator .. string.rep( " ", self.Indent - 1 )) or string.rep( " ", self.Indent )) .. Text:gsub( "\n", "\n" .. string.rep( " ", self.Indent ) )
   return self
 end
 
---- Produces the text of the report, taking into account an optional delimeter, which is \n by default.
+--- Produces the text of the report, taking into account an optional delimiter, which is \n by default.
 -- @param #REPORT self
 -- @param #string Delimiter (optional) A delimiter text.
 -- @return #string The report text.
 function REPORT:Text( Delimiter )
   Delimiter = Delimiter or "\n"
-  local ReportText = ( self.Title ~= "" and self.Title .. Delimiter or self.Title ) .. table.concat( self.Report, Delimiter ) or ""
+  local ReportText = (self.Title ~= "" and self.Title .. Delimiter or self.Title) .. table.concat( self.Report, Delimiter ) or ""
   return ReportText
 end
 

Moose Development/Moose/Core/ScheduleDispatcher.lua

@@ -17,7 +17,7 @@
 --   - When a SCHEDULER object is not attached to another object (that is, it's first :Schedule() parameter is nil), then the SCHEDULER object is _persistent_ within memory.
 --   - When a SCHEDULER object *is* attached to another object, then the SCHEDULER object is _not persistent_ within memory after a garbage collection!
 --
--- The none persistency of SCHEDULERS attached to objects is required to allow SCHEDULER objects to be garbage collectged, when the parent object is also desroyed or nillified and garbage collected.
+-- The non-persistency of SCHEDULERS attached to objects is required to allow SCHEDULER objects to be garbage collected when the parent object is destroyed, or set to nil and garbage collected.
 -- Even when there are pending timer scheduled functions to be executed for the SCHEDULER object,
 -- these will not be executed anymore when the SCHEDULER object has been destroyed.
 --
@@ -38,7 +38,7 @@
 -- @type SCHEDULEDISPATCHER
 -- @field #string ClassName Name of the class.
 -- @field #number CallID Call ID counter.
--- @field #table PersistentSchedulers Persistant schedulers.
+-- @field #table PersistentSchedulers Persistent schedulers.
 -- @field #table ObjectSchedulers Schedulers that only exist as long as the master object exists.
 -- @field #table Schedule Meta table setmetatable( {}, { __mode = "k" } ).
 -- @extends Core.Base#BASE
@@ -46,11 +46,11 @@
 --- The SCHEDULEDISPATCHER structure
 -- @type SCHEDULEDISPATCHER
 SCHEDULEDISPATCHER = {
-  ClassName            = "SCHEDULEDISPATCHER",
+  ClassName = "SCHEDULEDISPATCHER",
-  CallID               =   0,
+  CallID = 0,
-  PersistentSchedulers =  {},
+  PersistentSchedulers = {},
-  ObjectSchedulers     =  {},
+  ObjectSchedulers = {},
-  Schedule             = nil,
+  Schedule = nil,
 }
 
 --- Player data table holding all important parameters of each player.
@@ -58,7 +58,7 @@ SCHEDULEDISPATCHER = {
 -- @field #function Function The schedule function to be called.
 -- @field #table Arguments Schedule function arguments.
 -- @field #number Start Start time in seconds.
--- @field #number Repeat Repeat time intervall in seconds.
+-- @field #number Repeat Repeat time interval in seconds.
 -- @field #number Randomize Randomization factor [0,1].
 -- @field #number Stop Stop time in seconds.
 -- @field #number StartTime Time in seconds when the scheduler is created.
@@ -77,7 +77,7 @@ end
 
 --- Add a Schedule to the ScheduleDispatcher.
 -- The development of this method was really tidy.
--- It is constructed as such that a garbage collection is executed on the weak tables, when the Scheduler is nillified.
+-- It is constructed as such that a garbage collection is executed on the weak tables, when the Scheduler is set to nil.
 -- Nothing of this code should be modified without testing it thoroughly.
 -- @param #SCHEDULEDISPATCHER self
 -- @param Core.Scheduler#SCHEDULER Scheduler Scheduler object.
@@ -85,7 +85,7 @@ end
 -- @param #table ScheduleArguments Table of arguments passed to the ScheduleFunction.
 -- @param #number Start Start time in seconds.
 -- @param #number Repeat Repeat interval in seconds.
--- @param #number Randomize Radomization factor [0,1].
+-- @param #number Randomize Randomization factor [0,1].
 -- @param #number Stop Stop time in seconds.
 -- @param #number TraceLevel Trace level [0,3].
 -- @param Core.Fsm#FSM Fsm Finite state model.
@@ -97,9 +97,9 @@ function SCHEDULEDISPATCHER:AddSchedule( Scheduler, ScheduleFunction, ScheduleAr
   self.CallID = self.CallID + 1
 
   -- Create ID.
-  local CallID = self.CallID .. "#" .. ( Scheduler.MasterObject and Scheduler.MasterObject.GetClassNameAndID and Scheduler.MasterObject:GetClassNameAndID() or "" ) or ""
+  local CallID = self.CallID .. "#" .. (Scheduler.MasterObject and Scheduler.MasterObject.GetClassNameAndID and Scheduler.MasterObject:GetClassNameAndID() or "") or ""
 
-  self:T2(string.format("Adding schedule #%d CallID=%s", self.CallID, CallID))
+  self:T2( string.format( "Adding schedule #%d CallID=%s", self.CallID, CallID ) )
 
   -- Initialize PersistentSchedulers
   self.PersistentSchedulers = self.PersistentSchedulers or {}
@@ -109,25 +109,26 @@ function SCHEDULEDISPATCHER:AddSchedule( Scheduler, ScheduleFunction, ScheduleAr
   self.ObjectSchedulers = self.ObjectSchedulers or setmetatable( {}, { __mode = "v" } )
 
   if Scheduler.MasterObject then
+    --env.info("FF Object Scheduler")
     self.ObjectSchedulers[CallID] = Scheduler
-    self:F3( { CallID = CallID, ObjectScheduler = tostring(self.ObjectSchedulers[CallID]), MasterObject = tostring(Scheduler.MasterObject) } )
+    self:F3( { CallID = CallID, ObjectScheduler = tostring( self.ObjectSchedulers[CallID] ), MasterObject = tostring( Scheduler.MasterObject ) } )
   else
+    --env.info("FF Persistent Scheduler")
     self.PersistentSchedulers[CallID] = Scheduler
     self:F3( { CallID = CallID, PersistentScheduler = self.PersistentSchedulers[CallID] } )
   end
 
   self.Schedule = self.Schedule or setmetatable( {}, { __mode = "k" } )
   self.Schedule[Scheduler] = self.Schedule[Scheduler] or {}
-  self.Schedule[Scheduler][CallID] = {}  --#SCHEDULEDISPATCHER.ScheduleData
+  self.Schedule[Scheduler][CallID] = {} -- #SCHEDULEDISPATCHER.ScheduleData
   self.Schedule[Scheduler][CallID].Function = ScheduleFunction
   self.Schedule[Scheduler][CallID].Arguments = ScheduleArguments
   self.Schedule[Scheduler][CallID].StartTime = timer.getTime() + ( Start or 0 )
-  self.Schedule[Scheduler][CallID].Start = Start + 0.1
+  self.Schedule[Scheduler][CallID].Start = Start + 0.001
   self.Schedule[Scheduler][CallID].Repeat = Repeat or 0
   self.Schedule[Scheduler][CallID].Randomize = Randomize or 0
   self.Schedule[Scheduler][CallID].Stop = Stop
 
-  
   -- This section handles the tracing of the scheduled calls.
   -- Because these calls will be executed with a delay, we inspect the place where these scheduled calls are initiated.
   -- The Info structure contains the output of the debug.getinfo() calls, which inspects the call stack for the function name, line number and source name.
@@ -149,7 +150,7 @@ function SCHEDULEDISPATCHER:AddSchedule( Scheduler, ScheduleFunction, ScheduleAr
   -- Therefore, in the call stack, at the TraceLevel these functions are mentioned as "tail calls", and the Info.name field will be nil as a result.
   -- To obtain the correct function name for FSM object calls, the function is mentioned in the call stack at a higher stack level.
   -- So when function name stored in Info.name is nil, then I inspect the function name within the call stack one level higher.
-  -- So this little piece of code does its magic wonderfully, preformance overhead is neglectible, as scheduled calls don't happen that often.
+  -- So this little piece of code does its magic wonderfully, performance overhead is negligible, as scheduled calls don't happen that often.
 
   local Info = {}
 
@@ -181,24 +182,24 @@ function SCHEDULEDISPATCHER:AddSchedule( Scheduler, ScheduleFunction, ScheduleAr
       return errmsg
     end
 
-    -- Get object or persistant scheduler object.
+    -- Get object or persistent scheduler object.
-    local Scheduler = self.ObjectSchedulers[CallID]  --Core.Scheduler#SCHEDULER
+    local Scheduler = self.ObjectSchedulers[CallID] -- Core.Scheduler#SCHEDULER
     if not Scheduler then
       Scheduler = self.PersistentSchedulers[CallID]
     end
 
-    --self:T3( { Scheduler = Scheduler } )
+    -- self:T3( { Scheduler = Scheduler } )
 
     if Scheduler then
 
-      local MasterObject = tostring(Scheduler.MasterObject)
+      local MasterObject = tostring( Scheduler.MasterObject )
 
       -- Schedule object.
-      local Schedule = self.Schedule[Scheduler][CallID]  --#SCHEDULEDISPATCHER.ScheduleData
+      local Schedule = self.Schedule[Scheduler][CallID] -- #SCHEDULEDISPATCHER.ScheduleData
 
-      --self:T3( { Schedule = Schedule } )
+      -- self:T3( { Schedule = Schedule } )
 
-      local SchedulerObject = Scheduler.MasterObject --Scheduler.SchedulerObject Now is this the Maste or Scheduler object?
+      local SchedulerObject = Scheduler.MasterObject -- Scheduler.SchedulerObject Now is this the Master or Scheduler object?
       local ShowTrace       = Scheduler.ShowTrace
 
       local ScheduleFunction  = Schedule.Function
@@ -209,16 +210,16 @@ function SCHEDULEDISPATCHER:AddSchedule( Scheduler, ScheduleFunction, ScheduleAr
       local Stop              = Schedule.Stop or 0
       local ScheduleID        = Schedule.ScheduleID
 
-      
+      local Prefix = (Repeat == 0) and "--->" or "+++>"
-      local Prefix = ( Repeat == 0 ) and "--->" or "+++>"
 
       local Status, Result
-      --self:E( { SchedulerObject = SchedulerObject } )
+      -- self:E( { SchedulerObject = SchedulerObject } )
       if SchedulerObject then
         local function Timer()
           if ShowTrace then
             SchedulerObject:T( Prefix .. Name .. ":" .. Line .. " (" .. Source .. ")" )
           end
+          -- The master object is passed as first parameter. A few :Schedule() calls in MOOSE expect this currently. But in principle it should be removed.
           return ScheduleFunction( SchedulerObject, unpack( ScheduleArguments ) ) 
         end
         Status, Result = xpcall( Timer, ErrorHandler )
@@ -236,14 +237,13 @@ function SCHEDULEDISPATCHER:AddSchedule( Scheduler, ScheduleFunction, ScheduleAr
       local StartTime = Schedule.StartTime
 
       -- Debug info.
-      self:F3( { CallID=CallID, ScheduleID=ScheduleID, Master = MasterObject, CurrentTime = CurrentTime, StartTime = StartTime, Start = Start, Repeat = Repeat, Randomize = Randomize, Stop = Stop } )
+      self:F3( { CallID = CallID, ScheduleID = ScheduleID, Master = MasterObject, CurrentTime = CurrentTime, StartTime = StartTime, Start = Start, Repeat = Repeat, Randomize = Randomize, Stop = Stop } )
 
+      if Status and ((Result == nil) or (Result and Result ~= false)) then
 
-      if Status and (( Result == nil ) or ( Result and Result ~= false ) ) then
+        if Repeat ~= 0 and ((Stop == 0) or (Stop ~= 0 and CurrentTime <= StartTime + Stop)) then
-      
+          local ScheduleTime = CurrentTime + Repeat + math.random( -(Randomize * Repeat / 2), (Randomize * Repeat / 2) ) + 0.0001 -- Accuracy
-        if Repeat ~= 0 and ( ( Stop == 0 ) or ( Stop ~= 0 and CurrentTime <= StartTime + Stop ) ) then
+          -- self:T3( { Repeat = CallID, CurrentTime, ScheduleTime, ScheduleArguments } )
-          local ScheduleTime = CurrentTime + Repeat + math.random(- ( Randomize * Repeat / 2 ), ( Randomize * Repeat  / 2 )) + 0.0001  -- Accuracy
-          --self:T3( { Repeat = CallID, CurrentTime, ScheduleTime, ScheduleArguments } )
           return ScheduleTime -- returns the next time the function needs to be called.
         else
           self:Stop( Scheduler, CallID )
@@ -287,21 +287,21 @@ function SCHEDULEDISPATCHER:Start( Scheduler, CallID, Info )
 
   if CallID then
 
-    local Schedule = self.Schedule[Scheduler][CallID] --#SCHEDULEDISPATCHER.ScheduleData
+    local Schedule = self.Schedule[Scheduler][CallID] -- #SCHEDULEDISPATCHER.ScheduleData
 
     -- Only start when there is no ScheduleID defined!
     -- This prevents to "Start" the scheduler twice with the same CallID...
     if not Schedule.ScheduleID then
 
       -- Current time in seconds.
-      local Tnow=timer.getTime()
+      local Tnow = timer.getTime()
 
-      Schedule.StartTime = Tnow  -- Set the StartTime field to indicate when the scheduler started.
+      Schedule.StartTime = Tnow -- Set the StartTime field to indicate when the scheduler started.
 
       -- Start DCS schedule function https://wiki.hoggitworld.com/view/DCS_func_scheduleFunction
-      Schedule.ScheduleID = timer.scheduleFunction(Schedule.CallHandler, { CallID = CallID, Info = Info }, Tnow + Schedule.Start)
+      Schedule.ScheduleID = timer.scheduleFunction( Schedule.CallHandler, { CallID = CallID, Info = Info }, Tnow + Schedule.Start )
 
-      self:T(string.format("Starting scheduledispatcher Call ID=%s ==> Schedule ID=%s", tostring(CallID), tostring(Schedule.ScheduleID)))
+      self:T( string.format( "Starting SCHEDULEDISPATCHER Call ID=%s ==> Schedule ID=%s", tostring( CallID ), tostring( Schedule.ScheduleID ) ) )
     end
 
   else
@@ -317,26 +317,26 @@ end
 --- Stop dispatcher.
 -- @param #SCHEDULEDISPATCHER self
 -- @param Core.Scheduler#SCHEDULER Scheduler Scheduler object.
--- @param #table CallID Call ID.
+-- @param #string CallID (Optional) Scheduler Call ID. If nil, all pending schedules are stopped recursively.
 function SCHEDULEDISPATCHER:Stop( Scheduler, CallID )
   self:F2( { Stop = CallID, Scheduler = Scheduler } )
 
   if CallID then
 
-    local Schedule = self.Schedule[Scheduler][CallID] --#SCHEDULEDISPATCHER.ScheduleData
+    local Schedule = self.Schedule[Scheduler][CallID] -- #SCHEDULEDISPATCHER.ScheduleData
 
     -- Only stop when there is a ScheduleID defined for the CallID. So, when the scheduler was stopped before, do nothing.
     if Schedule.ScheduleID then
 
-      self:T(string.format("scheduledispatcher stopping scheduler CallID=%s, ScheduleID=%s", tostring(CallID), tostring(Schedule.ScheduleID)))
+      self:T( string.format( "SCHEDULEDISPATCHER stopping scheduler CallID=%s, ScheduleID=%s", tostring( CallID ), tostring( Schedule.ScheduleID ) ) )
 
       -- Remove schedule function https://wiki.hoggitworld.com/view/DCS_func_removeFunction
-      timer.removeFunction(Schedule.ScheduleID)
+      timer.removeFunction( Schedule.ScheduleID )
 
       Schedule.ScheduleID = nil
 
     else
-      self:T(string.format("Error no ScheduleID for CallID=%s", tostring(CallID)))
+      self:T( string.format( "Error no ScheduleID for CallID=%s", tostring( CallID ) ) )
     end
 
   else
@@ -359,7 +359,7 @@ function SCHEDULEDISPATCHER:Clear( Scheduler )
   end
 end
 
---- Shopw tracing info.
+--- Show tracing info.
 -- @param #SCHEDULEDISPATCHER self
 -- @param Core.Scheduler#SCHEDULER Scheduler Scheduler object.
 function SCHEDULEDISPATCHER:ShowTrace( Scheduler )

Moose Development/Moose/Core/Scheduler.lua

@@ -14,7 +14,7 @@
 --
 -- # Demo Missions
 -- 
--- ### [SCHEDULER Demo Missions source code](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/SCH%20-%20Scheduler)
+-- ### [SCHEDULER Demo Missions source code](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/SCH%20-%20Scheduler)
 -- 
 -- ### [SCHEDULER Demo Missions, only for beta testers](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/SCH%20-%20Scheduler)
 --
@@ -48,7 +48,6 @@
 -- @field #boolean ShowTrace Trace info if true.
 -- @extends Core.Base#BASE
 
-
 --- Creates and handles schedules over time, which allow to execute code at specific time intervals with randomization.
 --
 -- A SCHEDULER can manage **multiple** (repeating) schedules. Each planned or executing schedule has a unique **ScheduleID**.
@@ -79,7 +78,7 @@
 --
 -- ### Construct a SCHEDULER object without a volatile schedule, but volatile to the Object existence...
 --
---   * @{#SCHEDULER.New}( Object ): Setup a new SCHEDULER object, which is linked to the Object. When the Object is nillified or destroyed, the SCHEDULER object will also be destroyed and stopped after garbage collection.
+--   * @{#SCHEDULER.New}( Object ): Setup a new SCHEDULER object, which is linked to the Object. When the Object is set to nil or destroyed, the SCHEDULER object will also be destroyed and stopped after garbage collection.
 --
 --     ZoneObject = ZONE:New( "ZoneName" )
 --     MasterObject = SCHEDULER:New( ZoneObject )
@@ -149,13 +148,13 @@
 --     ZoneObject = ZONE:New( "ZoneName" )
 --     MasterObject = SCHEDULER:New( ZoneObject )
 --
--- Several parameters can be specified that influence the behaviour of a Schedule.
+-- Several parameters can be specified that influence the behavior of a Schedule.
 --
 -- ### A single schedule, immediately executed
 --
 --     SchedulerID = MasterObject:Schedule( ZoneObject, ScheduleFunction, {} )
 --
--- The above example schedules a new ScheduleFunction call to be executed asynchronously, within milleseconds ...
+-- The above example schedules a new ScheduleFunction call to be executed asynchronously, within milliseconds ...
 --
 -- ### A single schedule, planned over time
 --
@@ -193,10 +192,10 @@
 --
 -- @field #SCHEDULER
 SCHEDULER = {
-  ClassName       = "SCHEDULER",
+  ClassName = "SCHEDULER",
-  Schedules       = {},
+  Schedules = {},
-  MasterObject    = nil,
+  MasterObject = nil,
-  ShowTrace       = nil,
+  ShowTrace = nil,
 }
 
 --- SCHEDULER constructor.
@@ -235,10 +234,10 @@ end
 -- @param #number Start Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.
 -- @param #number Repeat Specifies the time interval in seconds when the scheduler will call the event function.
 -- @param #number RandomizeFactor Specifies a randomization factor between 0 and 1 to randomize the Repeat.
--- @param #number Stop Time interval in seconds after which the scheduler will be stoppe.
+-- @param #number Stop Time interval in seconds after which the scheduler will be stopped.
 -- @param #number TraceLevel Trace level [0,3]. Default 3.
 -- @param Core.Fsm#FSM Fsm Finite state model.
--- @return #table The ScheduleID of the planned schedule.
+-- @return #string The Schedule ID of the planned schedule.
 function SCHEDULER:Schedule( MasterObject, SchedulerFunction, SchedulerArguments, Start, Repeat, RandomizeFactor, Stop, TraceLevel, Fsm )
   self:F2( { Start, Repeat, RandomizeFactor, Stop } )
   self:T3( { SchedulerArguments } )
@@ -248,35 +247,34 @@ function SCHEDULER:Schedule( MasterObject, SchedulerFunction, SchedulerArguments
   if MasterObject and MasterObject.ClassName and MasterObject.ClassID then
     ObjectName = MasterObject.ClassName .. MasterObject.ClassID
   end
-  self:F3( { "Schedule :", ObjectName, tostring( MasterObject ),  Start, Repeat, RandomizeFactor, Stop } )
+  self:F3( { "Schedule :", ObjectName, tostring( MasterObject ), Start, Repeat, RandomizeFactor, Stop } )
 
   -- Set master object.
   self.MasterObject = MasterObject
 
   -- Add schedule.
-  local ScheduleID = _SCHEDULEDISPATCHER:AddSchedule( 
+  local ScheduleID = _SCHEDULEDISPATCHER:AddSchedule( self,
-    self, 
+                                                      SchedulerFunction,
-    SchedulerFunction,
+                                                      SchedulerArguments,
-    SchedulerArguments,
+                                                      Start,
-    Start,
+                                                      Repeat,
-    Repeat,
+                                                      RandomizeFactor,
-    RandomizeFactor,
+                                                      Stop,
-    Stop,
+                                                      TraceLevel or 3,
-    TraceLevel or 3,
+                                                      Fsm
-    Fsm
+                                                    )
-  )
 
-  self.Schedules[#self.Schedules+1] = ScheduleID
+  self.Schedules[#self.Schedules + 1] = ScheduleID
 
   return ScheduleID
 end
 
 --- (Re-)Starts the schedules or a specific schedule if a valid ScheduleID is provided.
 -- @param #SCHEDULER self
--- @param #string ScheduleID (Optional) The ScheduleID of the planned (repeating) schedule.
+-- @param #string ScheduleID (Optional) The Schedule ID of the planned (repeating) schedule.
 function SCHEDULER:Start( ScheduleID )
   self:F3( { ScheduleID } )
-  self:T(string.format("Starting scheduler ID=%s", tostring(ScheduleID)))
+  self:T( string.format( "Starting scheduler ID=%s", tostring( ScheduleID ) ) )
   _SCHEDULEDISPATCHER:Start( self, ScheduleID )
 end
 
@@ -285,7 +283,7 @@ end
 -- @param #string ScheduleID (Optional) The ScheduleID of the planned (repeating) schedule.
 function SCHEDULER:Stop( ScheduleID )
   self:F3( { ScheduleID } )
-  self:T(string.format("Stopping scheduler ID=%s", tostring(ScheduleID)))
+  self:T( string.format( "Stopping scheduler ID=%s", tostring( ScheduleID ) ) )
   _SCHEDULEDISPATCHER:Stop( self, ScheduleID )
 end
 
@@ -294,15 +292,15 @@ end
 -- @param #string ScheduleID (optional) The ScheduleID of the planned (repeating) schedule.
 function SCHEDULER:Remove( ScheduleID )
   self:F3( { ScheduleID } )
-  self:T(string.format("Removing scheduler ID=%s", tostring(ScheduleID)))
+  self:T( string.format( "Removing scheduler ID=%s", tostring( ScheduleID ) ) )
   _SCHEDULEDISPATCHER:RemoveSchedule( self, ScheduleID )
 end
 
 --- Clears all pending schedules.
 -- @param #SCHEDULER self
 function SCHEDULER:Clear()
-  self:F3( )
+  self:F3()
-  self:T(string.format("Clearing scheduler"))
+  self:T( string.format( "Clearing scheduler" ) )
   _SCHEDULEDISPATCHER:Clear( self )
 end
 

Moose Development/Moose/Core/Settings.lua

@@ -29,15 +29,14 @@
 -- @module Core.Settings
 -- @image Core_Settings.JPG
 
-
 --- @type SETTINGS
 -- @extends Core.Base#BASE
 
---- Takes care of various settings that influence the behaviour of certain functionalities and classes within the MOOSE framework.
+--- Takes care of various settings that influence the behavior 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.
+-- The SETTINGS class takes care of various settings that influence the behavior of certain functionalities and classes within the MOOSE framework.
 -- SETTINGS can work on 2 levels:
 --
 --   - **Default settings**: A running mission has **Default settings**.
@@ -59,7 +58,7 @@
 --
 -- 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.
+-- Note that the **Default settings** will only be used when a player has not chosen its own settings.
 --
 -- ## 2.2) Player settings menu
 --
@@ -69,7 +68,7 @@
 --
 -- ## 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**.
+-- Of course, it may be required 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.
@@ -94,8 +93,8 @@
 --
 --   - 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 DMS: Latitude 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.
+--   - A2G LL DDM: Latitude Longitude [Decimal Degrees Minutes](https://en.wikipedia.org/wiki/Decimal_degrees). The accuracy can also be adapted.
 --
 -- ### 3.1.2) A2G coordinates setting **menu**
 --
@@ -183,7 +182,7 @@
 -- 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.
+-- The Settings Menu will provide for each Message Type a selection of proposed durations from which can be chosen.
 -- 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!
 --
@@ -196,7 +195,7 @@
 --
 -- ## 3.5) **Era** of the battle
 --
--- The threat level metric is scaled according the era of the battle. A target that is AAA, will pose a much greather threat in WWII than on modern warfare.
+-- The threat level metric is scaled according the era of the battle. A target that is AAA, will pose a much greater threat in WWII than on modern warfare.
 -- Therefore, there are 4 era that are defined within the settings:
 --
 --   - **WWII** era: Use for warfare with equipment during the world war II time.
@@ -213,8 +212,8 @@
 SETTINGS = {
   ClassName = "SETTINGS",
   ShowPlayerMenu = true,
-  MenuShort      = false,
+  MenuShort = false,
-  MenuStatic     = false,
+  MenuStatic = false,
 }
 
 SETTINGS.__Enum = {}
@@ -231,11 +230,11 @@ SETTINGS.__Enum.Era = {
   Modern = 4,
 }
 
-
 do -- SETTINGS
 
   --- SETTINGS constructor.
   -- @param #SETTINGS self
+  -- @param #string PlayerName (Optional) Set settings for this player.
   -- @return #SETTINGS
   function SETTINGS:Set( PlayerName )
 
@@ -252,6 +251,7 @@ do -- SETTINGS
       self:SetMessageTime( MESSAGE.Type.Overview, 60 )
       self:SetMessageTime( MESSAGE.Type.Update, 15 )
       self:SetEraModern()
+      self:SetLocale("en")
       return self
     else
       local Settings = _DATABASE:GetPlayerSettings( PlayerName )
@@ -267,14 +267,14 @@ do -- SETTINGS
   -- Short text are better suited for, e.g., VR.
   -- @param #SETTINGS self
   -- @param #boolean onoff If *true* use short menu texts. If *false* long ones (default).
-  function SETTINGS:SetMenutextShort(onoff)
+  function SETTINGS:SetMenutextShort( onoff )
     _SETTINGS.MenuShort = onoff
   end
 
   --- Set menu to be static.
   -- @param #SETTINGS self
   -- @param #boolean onoff If *true* menu is static. If *false* menu will be updated after changes (default).
-  function SETTINGS:SetMenuStatic(onoff)
+  function SETTINGS:SetMenuStatic( onoff )
     _SETTINGS.MenuStatic = onoff
   end
 
@@ -284,11 +284,25 @@ do -- SETTINGS
     self.Metric = true
   end
   
+  --- Sets the SETTINGS default text locale.
+  -- @param #SETTINGS self
+  -- @param #string Locale
+  function SETTINGS:SetLocale(Locale)
+    self.Locale = Locale or "en"
+  end
+  
+  --- Gets the SETTINGS text locale.
+  -- @param #SETTINGS self
+  -- @return #string
+  function SETTINGS:GetLocale()
+    return self.Locale or _SETTINGS:GetLocale()
+  end
+  
   --- Gets if the SETTINGS is metric.
   -- @param #SETTINGS self
   -- @return #boolean true if metric.
   function SETTINGS:IsMetric()
-    return ( self.Metric ~= nil and self.Metric == true ) or ( self.Metric == nil and _SETTINGS:IsMetric() )
+    return (self.Metric ~= nil and self.Metric == true) or (self.Metric == nil and _SETTINGS:IsMetric())
   end
 
   --- Sets the SETTINGS imperial.
@@ -301,7 +315,7 @@ do -- SETTINGS
   -- @param #SETTINGS self
   -- @return #boolean true if imperial.
   function SETTINGS:IsImperial()
-    return ( self.Metric ~= nil and self.Metric == false ) or ( self.Metric == nil and _SETTINGS:IsMetric() )
+    return (self.Metric ~= nil and self.Metric == false) or (self.Metric == nil and _SETTINGS:IsImperial())
   end
 
   --- Sets the SETTINGS LL accuracy.
@@ -343,13 +357,12 @@ do -- SETTINGS
     self.MessageTypeTimings[MessageType] = MessageTime
   end
 
-
   --- Gets the SETTINGS Message Display Timing of a MessageType
   -- @param #SETTINGS self
   -- @param Core.Message#MESSAGE MessageType The type of the message.
   -- @return #number
   function SETTINGS:GetMessageTime( MessageType )
-    return ( self.MessageTypeTimings and self.MessageTypeTimings[MessageType] ) or _SETTINGS:GetMessageTime( MessageType )
+    return (self.MessageTypeTimings and self.MessageTypeTimings[MessageType]) or _SETTINGS:GetMessageTime( MessageType )
   end
 
   --- Sets A2G LL DMS
@@ -370,14 +383,14 @@ do -- SETTINGS
   -- @param #SETTINGS self
   -- @return #boolean true if LL DMS
   function SETTINGS:IsA2G_LL_DMS()
-    return ( self.A2GSystem and self.A2GSystem == "LL DMS" ) or ( not self.A2GSystem and _SETTINGS:IsA2G_LL_DMS() )
+    return (self.A2GSystem and self.A2GSystem == "LL DMS") or (not self.A2GSystem and _SETTINGS:IsA2G_LL_DMS())
   end
 
   --- Is LL DDM
   -- @param #SETTINGS self
   -- @return #boolean true if LL DDM
   function SETTINGS:IsA2G_LL_DDM()
-    return ( self.A2GSystem and self.A2GSystem == "LL DDM" ) or ( not self.A2GSystem and _SETTINGS:IsA2G_LL_DDM() )
+    return (self.A2GSystem and self.A2GSystem == "LL DDM") or (not self.A2GSystem and _SETTINGS:IsA2G_LL_DDM())
   end
 
   --- Sets A2G MGRS
@@ -391,7 +404,7 @@ do -- SETTINGS
   -- @param #SETTINGS self
   -- @return #boolean true if MGRS
   function SETTINGS:IsA2G_MGRS()
-    return ( self.A2GSystem and self.A2GSystem == "MGRS" ) or ( not self.A2GSystem and _SETTINGS:IsA2G_MGRS() )
+    return (self.A2GSystem and self.A2GSystem == "MGRS") or (not self.A2GSystem and _SETTINGS:IsA2G_MGRS())
   end
 
   --- Sets A2G BRA
@@ -405,7 +418,7 @@ do -- SETTINGS
   -- @param #SETTINGS self
   -- @return #boolean true if BRA
   function SETTINGS:IsA2G_BR()
-    return ( self.A2GSystem and self.A2GSystem == "BR" ) or ( not self.A2GSystem and _SETTINGS:IsA2G_BR() )
+    return (self.A2GSystem and self.A2GSystem == "BR") or (not self.A2GSystem and _SETTINGS:IsA2G_BR())
   end
 
   --- Sets A2A BRA
@@ -419,7 +432,7 @@ do -- SETTINGS
   -- @param #SETTINGS self
   -- @return #boolean true if BRA
   function SETTINGS:IsA2A_BRAA()
-    return ( 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
 
   --- Sets A2A BULLS
@@ -433,7 +446,7 @@ do -- SETTINGS
   -- @param #SETTINGS self
   -- @return #boolean true if BULLS
   function SETTINGS:IsA2A_BULLS()
-    return ( self.A2ASystem and self.A2ASystem == "BULLS" ) or ( not self.A2ASystem and _SETTINGS:IsA2A_BULLS() )
+    return (self.A2ASystem and self.A2ASystem == "BULLS") or (not self.A2ASystem and _SETTINGS:IsA2A_BULLS())
   end
 
   --- Sets A2A LL DMS
@@ -454,14 +467,14 @@ do -- SETTINGS
   -- @param #SETTINGS self
   -- @return #boolean true if LL DMS
   function SETTINGS:IsA2A_LL_DMS()
-    return ( self.A2ASystem and self.A2ASystem == "LL DMS" ) or ( not self.A2ASystem and _SETTINGS:IsA2A_LL_DMS() )
+    return (self.A2ASystem and self.A2ASystem == "LL DMS") or (not self.A2ASystem and _SETTINGS:IsA2A_LL_DMS())
   end
 
   --- Is LL DDM
   -- @param #SETTINGS self
   -- @return #boolean true if LL DDM
   function SETTINGS:IsA2A_LL_DDM()
-    return ( self.A2ASystem and self.A2ASystem == "LL DDM" ) or ( not self.A2ASystem and _SETTINGS:IsA2A_LL_DDM() )
+    return (self.A2ASystem and self.A2ASystem == "LL DDM") or (not self.A2ASystem and _SETTINGS:IsA2A_LL_DDM())
   end
 
   --- Sets A2A MGRS
@@ -475,7 +488,7 @@ do -- SETTINGS
   -- @param #SETTINGS self
   -- @return #boolean true if MGRS
   function SETTINGS:IsA2A_MGRS()
-    return ( self.A2ASystem and self.A2ASystem == "MGRS" ) or ( not self.A2ASystem and _SETTINGS:IsA2A_MGRS() )
+    return (self.A2ASystem and self.A2ASystem == "MGRS") or (not self.A2ASystem and _SETTINGS:IsA2A_MGRS())
   end
 
   --- @param #SETTINGS self
@@ -494,37 +507,37 @@ do -- SETTINGS
     -- A2G Coordinate System
     -------
 
-    local text="A2G Coordinate System"
+    local text = "A2G Coordinate System"
     if _SETTINGS.MenuShort then
-      text="A2G Coordinates"
+      text = "A2G Coordinates"
     end
     local A2GCoordinateMenu = MENU_GROUP:New( MenuGroup, text, SettingsMenu ):SetTime( MenuTime )
 
     -- Set LL DMS
     if not self:IsA2G_LL_DMS() then
-      local text="Lat/Lon Degree Min Sec (LL DMS)"
+      local text = "Lat/Lon Degree Min Sec (LL DMS)"
       if _SETTINGS.MenuShort then
-        text="LL DMS"
+        text = "LL DMS"
       end
       MENU_GROUP_COMMAND:New( MenuGroup, text, A2GCoordinateMenu, self.A2GMenuSystem, self, MenuGroup, RootMenu, "LL DMS" ):SetTime( MenuTime )
     end
 
     -- Set LL DDM
     if not self:IsA2G_LL_DDM() then
-      local text="Lat/Lon Degree Dec Min (LL DDM)"
+      local text = "Lat/Lon Degree Dec Min (LL DDM)"
       if _SETTINGS.MenuShort then
-        text="LL DDM"
+        text = "LL DDM"
       end
       MENU_GROUP_COMMAND:New( MenuGroup, "Lat/Lon Degree Dec Min (LL DDM)", A2GCoordinateMenu, self.A2GMenuSystem, self, MenuGroup, RootMenu, "LL DDM" ):SetTime( MenuTime )
     end
 
     -- Set LL DMS accuracy.
     if self:IsA2G_LL_DDM() then
-      local text1="LL DDM Accuracy 1"
+      local text1 = "LL DDM Accuracy 1"
-      local text2="LL DDM Accuracy 2"
+      local text2 = "LL DDM Accuracy 2"
-      local text3="LL DDM Accuracy 3"
+      local text3 = "LL DDM Accuracy 3"
       if _SETTINGS.MenuShort then
-        text1="LL DDM"
+        text1 = "LL DDM"
       end
       MENU_GROUP_COMMAND:New( MenuGroup, "LL DDM Accuracy 1", A2GCoordinateMenu, self.MenuLL_DDM_Accuracy, self, MenuGroup, RootMenu, 1 ):SetTime( MenuTime )
       MENU_GROUP_COMMAND:New( MenuGroup, "LL DDM Accuracy 2", A2GCoordinateMenu, self.MenuLL_DDM_Accuracy, self, MenuGroup, RootMenu, 2 ):SetTime( MenuTime )
@@ -533,18 +546,18 @@ do -- SETTINGS
 
     -- Set BR.
     if not self:IsA2G_BR() then
-      local text="Bearing, Range (BR)"
+      local text = "Bearing, Range (BR)"
       if _SETTINGS.MenuShort then
-        text="BR"
+        text = "BR"
       end
-      MENU_GROUP_COMMAND:New( MenuGroup, text , A2GCoordinateMenu, self.A2GMenuSystem, self, MenuGroup, RootMenu, "BR" ):SetTime( MenuTime )
+      MENU_GROUP_COMMAND:New( MenuGroup, text, A2GCoordinateMenu, self.A2GMenuSystem, self, MenuGroup, RootMenu, "BR" ):SetTime( MenuTime )
     end
 
     -- Set MGRS.
     if not self:IsA2G_MGRS() then
-      local text="Military Grid (MGRS)"
+      local text = "Military Grid (MGRS)"
       if _SETTINGS.MenuShort then
-        text="MGRS"
+        text = "MGRS"
       end
       MENU_GROUP_COMMAND:New( MenuGroup, text, A2GCoordinateMenu, self.A2GMenuSystem, self, MenuGroup, RootMenu, "MGRS" ):SetTime( MenuTime )
     end
@@ -562,24 +575,24 @@ do -- SETTINGS
     -- A2A Coordinate System
     -------
 
-    local text="A2A Coordinate System"
+    local text = "A2A Coordinate System"
     if _SETTINGS.MenuShort then
-      text="A2A Coordinates"
+      text = "A2A Coordinates"
     end
     local A2ACoordinateMenu = MENU_GROUP:New( MenuGroup, text, SettingsMenu ):SetTime( MenuTime )
 
     if not self:IsA2A_LL_DMS() then
-      local text="Lat/Lon Degree Min Sec (LL DMS)"
+      local text = "Lat/Lon Degree Min Sec (LL DMS)"
       if _SETTINGS.MenuShort then
-        text="LL DMS"
+        text = "LL DMS"
       end
       MENU_GROUP_COMMAND:New( MenuGroup, text, A2ACoordinateMenu, self.A2AMenuSystem, self, MenuGroup, RootMenu, "LL DMS" ):SetTime( MenuTime )
     end
 
     if not self:IsA2A_LL_DDM() then
-      local text="Lat/Lon Degree Dec Min (LL DDM)"
+      local text = "Lat/Lon Degree Dec Min (LL DDM)"
       if _SETTINGS.MenuShort then
-        text="LL DDM"
+        text = "LL DDM"
       end
       MENU_GROUP_COMMAND:New( MenuGroup, text, A2ACoordinateMenu, self.A2AMenuSystem, self, MenuGroup, RootMenu, "LL DDM" ):SetTime( MenuTime )
     end
@@ -592,25 +605,25 @@ do -- SETTINGS
     end
 
     if not self:IsA2A_BULLS() then
-      local text="Bullseye (BULLS)"
+      local text = "Bullseye (BULLS)"
       if _SETTINGS.MenuShort then
-        text="Bulls"
+        text = "Bulls"
       end
       MENU_GROUP_COMMAND:New( MenuGroup, text, A2ACoordinateMenu, self.A2AMenuSystem, self, MenuGroup, RootMenu, "BULLS" ):SetTime( MenuTime )
     end
 
     if not self:IsA2A_BRAA() then
-      local text="Bearing Range Altitude Aspect (BRAA)"
+      local text = "Bearing Range Altitude Aspect (BRAA)"
       if _SETTINGS.MenuShort then
-        text="BRAA"
+        text = "BRAA"
       end
       MENU_GROUP_COMMAND:New( MenuGroup, text, A2ACoordinateMenu, self.A2AMenuSystem, self, MenuGroup, RootMenu, "BRAA" ):SetTime( MenuTime )
     end
 
     if not self:IsA2A_MGRS() then
-      local text="Military Grid (MGRS)"
+      local text = "Military Grid (MGRS)"
       if _SETTINGS.MenuShort then
-        text="MGRS"
+        text = "MGRS"
       end
       MENU_GROUP_COMMAND:New( MenuGroup, text, A2ACoordinateMenu, self.A2AMenuSystem, self, MenuGroup, RootMenu, "MGRS" ):SetTime( MenuTime )
     end
@@ -623,31 +636,31 @@ do -- SETTINGS
       MENU_GROUP_COMMAND:New( MenuGroup, "MGRS Accuracy 5", A2ACoordinateMenu, self.MenuMGRS_Accuracy, self, MenuGroup, RootMenu, 5 ):SetTime( MenuTime )
     end
 
-    local text="Measures and Weights System"
+    local text = "Measures and Weights System"
     if _SETTINGS.MenuShort then
-      text="Unit System"
+      text = "Unit System"
     end
     local MetricsMenu = MENU_GROUP:New( MenuGroup, text, SettingsMenu ):SetTime( MenuTime )
 
     if self:IsMetric() then
-      local text="Imperial (Miles,Feet)"
+      local text = "Imperial (Miles,Feet)"
       if _SETTINGS.MenuShort then
-        text="Imperial"
+        text = "Imperial"
       end
       MENU_GROUP_COMMAND:New( MenuGroup, text, MetricsMenu, self.MenuMWSystem, self, MenuGroup, RootMenu, false ):SetTime( MenuTime )
     end
 
     if self:IsImperial() then
-      local text="Metric (Kilometers,Meters)"
+      local text = "Metric (Kilometers,Meters)"
       if _SETTINGS.MenuShort then
-        text="Metric"
+        text = "Metric"
       end
       MENU_GROUP_COMMAND:New( MenuGroup, text, MetricsMenu, self.MenuMWSystem, self, MenuGroup, RootMenu, true ):SetTime( MenuTime )
     end
 
-    local text="Messages and Reports"
+    local text = "Messages and Reports"
     if _SETTINGS.MenuShort then
-      text="Messages & Reports"
+      text = "Messages & Reports"
     end
     local MessagesMenu = MENU_GROUP:New( MenuGroup, text, SettingsMenu ):SetTime( MenuTime )
 
@@ -688,7 +701,6 @@ do -- SETTINGS
     MENU_GROUP_COMMAND:New( MenuGroup, "2 minutes", DetailedReportsMenu, self.MenuMessageTimingsSystem, self, MenuGroup, RootMenu, MESSAGE.Type.DetailedReportsMenu, 120 ):SetTime( MenuTime )
     MENU_GROUP_COMMAND:New( MenuGroup, "3 minutes", DetailedReportsMenu, self.MenuMessageTimingsSystem, self, MenuGroup, RootMenu, MESSAGE.Type.DetailedReportsMenu, 180 ):SetTime( MenuTime )
 
-
     SettingsMenu:Remove( MenuTime )
 
     return self
@@ -732,11 +744,11 @@ do -- SETTINGS
 
       self.PlayerMenu = PlayerMenu
 
-      self:I(string.format("Setting menu for player %s", tostring(PlayerName)))
+      self:I( string.format( "Setting menu for player %s", tostring( PlayerName ) ) )
 
       local submenu = MENU_GROUP:New( PlayerGroup, "LL Accuracy", PlayerMenu )
       MENU_GROUP_COMMAND:New( PlayerGroup, "LL 0 Decimals", submenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 0 )
-      MENU_GROUP_COMMAND:New( PlayerGroup, "LL 1 Decimal",  submenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 1 )
+      MENU_GROUP_COMMAND:New( PlayerGroup, "LL 1 Decimal", submenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 1 )
       MENU_GROUP_COMMAND:New( PlayerGroup, "LL 2 Decimals", submenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 2 )
       MENU_GROUP_COMMAND:New( PlayerGroup, "LL 3 Decimals", submenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 3 )
       MENU_GROUP_COMMAND:New( PlayerGroup, "LL 4 Decimals", submenu, self.MenuGroupLL_DDM_AccuracySystem, self, PlayerUnit, PlayerGroup, PlayerName, 4 )
@@ -753,40 +765,40 @@ do -- SETTINGS
       -- A2G Coordinate System
       ------
 
-      local text="A2G Coordinate System"
+      local text = "A2G Coordinate System"
       if _SETTINGS.MenuShort then
-        text="A2G Coordinates"
+        text = "A2G Coordinates"
       end
       local A2GCoordinateMenu = MENU_GROUP:New( PlayerGroup, text, PlayerMenu )
 
       if not self:IsA2G_LL_DMS() or _SETTINGS.MenuStatic then
-        local text="Lat/Lon Degree Min Sec (LL DMS)"
+        local text = "Lat/Lon Degree Min Sec (LL DMS)"
         if _SETTINGS.MenuShort then
-          text="A2G LL DMS"
+          text = "A2G LL DMS"
         end
         MENU_GROUP_COMMAND:New( PlayerGroup, text, A2GCoordinateMenu, self.MenuGroupA2GSystem, self, PlayerUnit, PlayerGroup, PlayerName, "LL DMS" )
       end
 
       if not self:IsA2G_LL_DDM() or _SETTINGS.MenuStatic then
-        local text="Lat/Lon Degree Dec Min (LL DDM)"
+        local text = "Lat/Lon Degree Dec Min (LL DDM)"
         if _SETTINGS.MenuShort then
-          text="A2G LL DDM"
+          text = "A2G LL DDM"
         end
         MENU_GROUP_COMMAND:New( PlayerGroup, text, A2GCoordinateMenu, self.MenuGroupA2GSystem, self, PlayerUnit, PlayerGroup, PlayerName, "LL DDM" )
       end
 
       if not self:IsA2G_BR() or _SETTINGS.MenuStatic then
-        local text="Bearing, Range (BR)"
+        local text = "Bearing, Range (BR)"
         if _SETTINGS.MenuShort then
-          text="A2G BR"
+          text = "A2G BR"
         end
         MENU_GROUP_COMMAND:New( PlayerGroup, text, A2GCoordinateMenu, self.MenuGroupA2GSystem, self, PlayerUnit, PlayerGroup, PlayerName, "BR" )
       end
 
       if not self:IsA2G_MGRS() or _SETTINGS.MenuStatic then
-        local text="Military Grid (MGRS)"
+        local text = "Military Grid (MGRS)"
         if _SETTINGS.MenuShort then
-          text="A2G MGRS"
+          text = "A2G MGRS"
         end
         MENU_GROUP_COMMAND:New( PlayerGroup, text, A2GCoordinateMenu, self.MenuGroupA2GSystem, self, PlayerUnit, PlayerGroup, PlayerName, "MGRS" )
       end
@@ -795,49 +807,48 @@ do -- SETTINGS
       -- A2A Coordinates Menu
       ------
 
-      local text="A2A Coordinate System"
+      local text = "A2A Coordinate System"
       if _SETTINGS.MenuShort then
-        text="A2A Coordinates"
+        text = "A2A Coordinates"
       end
       local A2ACoordinateMenu = MENU_GROUP:New( PlayerGroup, text, PlayerMenu )
 
-
       if not self:IsA2A_LL_DMS() or _SETTINGS.MenuStatic then
-        local text="Lat/Lon Degree Min Sec (LL DMS)"
+        local text = "Lat/Lon Degree Min Sec (LL DMS)"
         if _SETTINGS.MenuShort then
-          text="A2A LL DMS"
+          text = "A2A LL DMS"
         end
         MENU_GROUP_COMMAND:New( PlayerGroup, text, A2ACoordinateMenu, self.MenuGroupA2GSystem, self, PlayerUnit, PlayerGroup, PlayerName, "LL DMS" )
       end
 
       if not self:IsA2A_LL_DDM() or _SETTINGS.MenuStatic then
-        local text="Lat/Lon Degree Dec Min (LL DDM)"
+        local text = "Lat/Lon Degree Dec Min (LL DDM)"
         if _SETTINGS.MenuShort then
-          text="A2A LL DDM"
+          text = "A2A LL DDM"
         end
         MENU_GROUP_COMMAND:New( PlayerGroup, text, A2ACoordinateMenu, self.MenuGroupA2ASystem, self, PlayerUnit, PlayerGroup, PlayerName, "LL DDM" )
       end
 
       if not self:IsA2A_BULLS() or _SETTINGS.MenuStatic then
-        local text="Bullseye (BULLS)"
+        local text = "Bullseye (BULLS)"
         if _SETTINGS.MenuShort then
-          text="A2A BULLS"
+          text = "A2A BULLS"
         end
         MENU_GROUP_COMMAND:New( PlayerGroup, text, A2ACoordinateMenu, self.MenuGroupA2ASystem, self, PlayerUnit, PlayerGroup, PlayerName, "BULLS" )
       end
 
       if not self:IsA2A_BRAA() or _SETTINGS.MenuStatic then
-        local text="Bearing Range Altitude Aspect (BRAA)"
+        local text = "Bearing Range Altitude Aspect (BRAA)"
         if _SETTINGS.MenuShort then
-          text="A2A BRAA"
+          text = "A2A BRAA"
         end
         MENU_GROUP_COMMAND:New( PlayerGroup, text, A2ACoordinateMenu, self.MenuGroupA2ASystem, self, PlayerUnit, PlayerGroup, PlayerName, "BRAA" )
       end
 
       if not self:IsA2A_MGRS() or _SETTINGS.MenuStatic then
-        local text="Military Grid (MGRS)"
+        local text = "Military Grid (MGRS)"
         if _SETTINGS.MenuShort then
-          text="A2A MGRS"
+          text = "A2A MGRS"
         end
         MENU_GROUP_COMMAND:New( PlayerGroup, text, A2ACoordinateMenu, self.MenuGroupA2ASystem, self, PlayerUnit, PlayerGroup, PlayerName, "MGRS" )
       end
@@ -846,24 +857,24 @@ do -- SETTINGS
       -- Unit system
       ---
 
-      local text="Measures and Weights System"
+      local text = "Measures and Weights System"
       if _SETTINGS.MenuShort then
-        text="Unit System"
+        text = "Unit System"
       end
       local MetricsMenu = MENU_GROUP:New( PlayerGroup, text, PlayerMenu )
 
       if self:IsMetric() or _SETTINGS.MenuStatic then
-        local text="Imperial (Miles,Feet)"
+        local text = "Imperial (Miles,Feet)"
         if _SETTINGS.MenuShort then
-          text="Imperial"
+          text = "Imperial"
         end
         MENU_GROUP_COMMAND:New( PlayerGroup, text, MetricsMenu, self.MenuGroupMWSystem, self, PlayerUnit, PlayerGroup, PlayerName, false )
       end
 
       if self:IsImperial() or _SETTINGS.MenuStatic then
-        local text="Metric (Kilometers,Meters)"
+        local text = "Metric (Kilometers,Meters)"
         if _SETTINGS.MenuShort then
-          text="Metric"
+          text = "Metric"
         end
         MENU_GROUP_COMMAND:New( PlayerGroup, text, MetricsMenu, self.MenuGroupMWSystem, self, PlayerUnit, PlayerGroup, PlayerName, true )
       end
@@ -872,9 +883,9 @@ do -- SETTINGS
       -- Messages and Reports
       ---
 
-      local text="Messages and Reports"
+      local text = "Messages and Reports"
       if _SETTINGS.MenuShort then
-        text="Messages & Reports"
+        text = "Messages & Reports"
       end
       local MessagesMenu = MENU_GROUP:New( PlayerGroup, text, PlayerMenu )
 
@@ -934,39 +945,38 @@ do -- SETTINGS
     return self
   end
 
-
   --- @param #SETTINGS self
   function SETTINGS:A2GMenuSystem( MenuGroup, RootMenu, A2GSystem )
     self.A2GSystem = A2GSystem
-    MESSAGE:New( string.format("Settings: Default A2G coordinate system set to %s for all players!", A2GSystem ), 5 ):ToAll()
+    MESSAGE:New( string.format( "Settings: Default A2G coordinate system set to %s for all players!", A2GSystem ), 5 ):ToAll()
     self:SetSystemMenu( MenuGroup, RootMenu )
   end
 
   --- @param #SETTINGS self
   function SETTINGS:A2AMenuSystem( MenuGroup, RootMenu, A2ASystem )
     self.A2ASystem = A2ASystem
-    MESSAGE:New( string.format("Settings: Default A2A coordinate system set to %s for all players!", A2ASystem ), 5 ):ToAll()
+    MESSAGE:New( string.format( "Settings: Default A2A coordinate system set to %s for all players!", A2ASystem ), 5 ):ToAll()
     self:SetSystemMenu( MenuGroup, RootMenu )
   end
 
   --- @param #SETTINGS self
   function SETTINGS:MenuLL_DDM_Accuracy( MenuGroup, RootMenu, LL_Accuracy )
     self.LL_Accuracy = LL_Accuracy
-    MESSAGE:New( string.format("Settings: Default LL accuracy set to %s for all players!", LL_Accuracy ), 5 ):ToAll()
+    MESSAGE:New( string.format( "Settings: Default LL accuracy set to %s for all players!", LL_Accuracy ), 5 ):ToAll()
     self:SetSystemMenu( MenuGroup, RootMenu )
   end
 
   --- @param #SETTINGS self
   function SETTINGS:MenuMGRS_Accuracy( MenuGroup, RootMenu, MGRS_Accuracy )
     self.MGRS_Accuracy = MGRS_Accuracy
-    MESSAGE:New( string.format("Settings: Default MGRS accuracy set to %s for all players!", MGRS_Accuracy ), 5 ):ToAll()
+    MESSAGE:New( string.format( "Settings: Default MGRS accuracy set to %s for all players!", MGRS_Accuracy ), 5 ):ToAll()
     self:SetSystemMenu( MenuGroup, RootMenu )
   end
 
   --- @param #SETTINGS self
   function SETTINGS:MenuMWSystem( MenuGroup, RootMenu, MW )
     self.Metric = MW
-    MESSAGE:New( string.format("Settings: Default measurement format set to %s for all players!", MW and "Metric" or "Imperial" ), 5 ):ToAll()
+    MESSAGE:New( string.format( "Settings: Default measurement format set to %s for all players!", MW and "Metric" or "Imperial" ), 5 ):ToAll()
     self:SetSystemMenu( MenuGroup, RootMenu )
   end
 
@@ -979,12 +989,12 @@ do -- SETTINGS
   do
     --- @param #SETTINGS self
     function SETTINGS:MenuGroupA2GSystem( PlayerUnit, PlayerGroup, PlayerName, A2GSystem )
-      BASE:E( {self, PlayerUnit:GetName(), A2GSystem} )
+      BASE:E( { self, PlayerUnit:GetName(), A2GSystem } )
       self.A2GSystem = A2GSystem
       MESSAGE:New( string.format( "Settings: A2G format set to %s for player %s.", A2GSystem, PlayerName ), 5 ):ToGroup( PlayerGroup )
-      if _SETTINGS.MenuStatic==false then
+      if _SETTINGS.MenuStatic == false then
-        self:RemovePlayerMenu(PlayerUnit)
+        self:RemovePlayerMenu( PlayerUnit )
-        self:SetPlayerMenu(PlayerUnit)
+        self:SetPlayerMenu( PlayerUnit )
       end
     end
 
@@ -992,9 +1002,9 @@ do -- SETTINGS
     function SETTINGS:MenuGroupA2ASystem( PlayerUnit, PlayerGroup, PlayerName, A2ASystem )
       self.A2ASystem = A2ASystem
       MESSAGE:New( string.format( "Settings: A2A format set to %s for player %s.", A2ASystem, PlayerName ), 5 ):ToGroup( PlayerGroup )
-      if _SETTINGS.MenuStatic==false then
+      if _SETTINGS.MenuStatic == false then
-        self:RemovePlayerMenu(PlayerUnit)
+        self:RemovePlayerMenu( PlayerUnit )
-        self:SetPlayerMenu(PlayerUnit)
+        self:SetPlayerMenu( PlayerUnit )
       end
     end
 
@@ -1002,9 +1012,9 @@ do -- SETTINGS
     function SETTINGS:MenuGroupLL_DDM_AccuracySystem( PlayerUnit, PlayerGroup, PlayerName, LL_Accuracy )
       self.LL_Accuracy = LL_Accuracy
       MESSAGE:New( string.format( "Settings: LL format accuracy set to %d decimal places for player %s.", LL_Accuracy, PlayerName ), 5 ):ToGroup( PlayerGroup )
-      if _SETTINGS.MenuStatic==false then
+      if _SETTINGS.MenuStatic == false then
-        self:RemovePlayerMenu(PlayerUnit)
+        self:RemovePlayerMenu( PlayerUnit )
-        self:SetPlayerMenu(PlayerUnit)
+        self:SetPlayerMenu( PlayerUnit )
       end
     end
 
@@ -1012,9 +1022,9 @@ do -- SETTINGS
     function SETTINGS:MenuGroupMGRS_AccuracySystem( PlayerUnit, PlayerGroup, PlayerName, MGRS_Accuracy )
       self.MGRS_Accuracy = MGRS_Accuracy
       MESSAGE:New( string.format( "Settings: MGRS format accuracy set to %d for player %s.", MGRS_Accuracy, PlayerName ), 5 ):ToGroup( PlayerGroup )
-      if _SETTINGS.MenuStatic==false then
+      if _SETTINGS.MenuStatic == false then
-        self:RemovePlayerMenu(PlayerUnit)
+        self:RemovePlayerMenu( PlayerUnit )
-        self:SetPlayerMenu(PlayerUnit)
+        self:SetPlayerMenu( PlayerUnit )
       end
     end
 
@@ -1022,9 +1032,9 @@ do -- SETTINGS
     function SETTINGS:MenuGroupMWSystem( PlayerUnit, PlayerGroup, PlayerName, MW )
       self.Metric = MW
       MESSAGE:New( string.format( "Settings: Measurement format set to %s for player %s.", MW and "Metric" or "Imperial", PlayerName ), 5 ):ToGroup( PlayerGroup )
-      if _SETTINGS.MenuStatic==false then
+      if _SETTINGS.MenuStatic == false then
-        self:RemovePlayerMenu(PlayerUnit)
+        self:RemovePlayerMenu( PlayerUnit )
-        self:SetPlayerMenu(PlayerUnit)
+        self:SetPlayerMenu( PlayerUnit )
       end
     end
 
@@ -1054,7 +1064,6 @@ do -- SETTINGS
 
   end
 
-
   --- Configures the era of the mission to be Cold war.
   -- @param #SETTINGS self
   -- @return #SETTINGS self
@@ -1064,7 +1073,6 @@ do -- SETTINGS
 
   end
 
-
   --- Configures the era of the mission to be Modern war.
   -- @param #SETTINGS self
   -- @return #SETTINGS self
@@ -1074,7 +1082,4 @@ do -- SETTINGS
 
   end
 
-
-
-
 end

Moose Development/Moose/Core/SpawnStatic.lua

@@ -46,14 +46,14 @@
 -- @field #number InitOffsetAngle Link offset angle in degrees.
 -- @field #number InitStaticHeading Heading of the static.
 -- @field #string InitStaticLivery Livery for aircraft.
--- @field #string InitStaticShape Shape of teh static.
+-- @field #string InitStaticShape Shape of the static.
 -- @field #string InitStaticType Type of the static.
 -- @field #string InitStaticCategory Categrory of the static.
 -- @field #string InitStaticName Name of the static.
 -- @field Core.Point#COORDINATE InitStaticCoordinate Coordinate where to spawn the static.
--- @field #boolean InitDead Set static to be dead if true.
+-- @field #boolean InitStaticDead Set static to be dead if true.
--- @field #boolean InitCargo If true, static can act as cargo.
+-- @field #boolean InitStaticCargo If true, static can act as cargo.
--- @field #number InitCargoMass Mass of cargo in kg.
+-- @field #number InitStaticCargoMass Mass of cargo in kg.
 -- @extends Core.Base#BASE
 
 
@@ -138,24 +138,24 @@ SPAWNSTATIC = {
 -- @return #SPAWNSTATIC self
 function SPAWNSTATIC:NewFromStatic(SpawnTemplateName, SpawnCountryID)
 
-	local self = BASE:Inherit( self, BASE:New() ) -- #SPAWNSTATIC
+  local self = BASE:Inherit( self, BASE:New() ) -- #SPAWNSTATIC
   
-	local TemplateStatic, CoalitionID, CategoryID, CountryID = _DATABASE:GetStaticGroupTemplate(SpawnTemplateName)
+  local TemplateStatic, CoalitionID, CategoryID, CountryID = _DATABASE:GetStaticGroupTemplate(SpawnTemplateName)
   
-	if TemplateStatic then
+  if TemplateStatic then
-		self.SpawnTemplatePrefix = SpawnTemplateName
+    self.SpawnTemplatePrefix = SpawnTemplateName
-		self.TemplateStaticUnit  = UTILS.DeepCopy(TemplateStatic.units[1])
+    self.TemplateStaticUnit  = UTILS.DeepCopy(TemplateStatic.units[1])
-		self.CountryID           = SpawnCountryID or CountryID
+    self.CountryID           = SpawnCountryID or CountryID
-		self.CategoryID          = CategoryID
+    self.CategoryID          = CategoryID
-		self.CoalitionID         = CoalitionID
+    self.CoalitionID         = CoalitionID
-		self.SpawnIndex          = 0
+    self.SpawnIndex          = 0
-	else
+  else
-		error( "SPAWNSTATIC:New: There is no static declared in the mission editor with SpawnTemplatePrefix = '" .. tostring(SpawnTemplateName) .. "'" )
+    error( "SPAWNSTATIC:New: There is no static declared in the mission editor with SpawnTemplatePrefix = '" .. tostring(SpawnTemplateName) .. "'" )
-	end
+  end
 
   self:SetEventPriority( 5 )
 
-	return self
+  return self
 end
 
 --- Creates the main object to spawn a @{Static} given a template table.
@@ -260,7 +260,7 @@ end
 -- @param #number Mass Mass of the cargo in kg.
 -- @return #SPAWNSTATIC self
 function SPAWNSTATIC:InitCargoMass(Mass)
-  self.InitCargoMass=Mass
+  self.InitStaticCargoMass=Mass
   return self
 end
 
@@ -269,7 +269,16 @@ end
 -- @param #boolean IsCargo If true, this static can act as cargo.
 -- @return #SPAWNSTATIC self
 function SPAWNSTATIC:InitCargo(IsCargo)
-  self.InitCargo=IsCargo
+  self.InitStaticCargo=IsCargo
+  return self
+end
+
+--- Initialize as dead.
+-- @param #SPAWNSTATIC self
+-- @param #boolean IsCargo If true, this static is dead.
+-- @return #SPAWNSTATIC self
+function SPAWNSTATIC:InitDead(IsDead)
+  self.InitStaticDead=IsDead
   return self
 end
 
@@ -417,12 +426,16 @@ function SPAWNSTATIC:_SpawnStatic(Template, CountryID)
     Template.livery_id=self.InitStaticLivery
   end
   
-  if self.InitDead~=nil then
+  if self.InitStaticDead~=nil then
-    Template.dead=self.InitDead
+    Template.dead=self.InitStaticDead
   end
   
-  if self.InitCargo~=nil then
+  if self.InitStaticCargo~=nil then
-    Template.isCargo=self.InitCargo
+    Template.canCargo=self.InitStaticCargo
+  end
+  
+  if self.InitStaticCargoMass~=nil then
+    Template.mass=self.InitStaticCargoMass
   end
   
   if self.InitLinkUnit then
@@ -475,6 +488,8 @@ function SPAWNSTATIC:_SpawnStatic(Template, CountryID)
     -- ED's dirty way to spawn FARPS.
     Static=coalition.addGroup(CountryID, -1, TemplateGroup)
   else
+    self:T("Spawning Static")        
+    self:T2({Template=Template})  
     Static=coalition.addStaticObject(CountryID, Template)
   end
     

Moose Development/Moose/Core/TextAndSound.lua

@@ -0,0 +1,202 @@
+--- **Core** - TEXTANDSOUND (MOOSE gettext) system
+--
+-- ===
+-- 
+-- ## Main Features:
+--
+--    * A GetText for Moose
+--    * Build a set of localized text entries, alongside their sounds and subtitles
+--    * Aimed at class developers to offer localizable language support
+--
+-- ===
+--
+-- ## Example Missions:
+-- 
+-- Demo missions can be found on [github](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/).
+--       
+-- ===
+-- 
+-- ### Author: **applevangelist**
+-- ## Date: April 2022
+-- 
+-- ===
+-- 
+-- @module Core.TextAndSound
+-- @image MOOSE.JPG
+
+--- Text and Sound class.
+-- @type TEXTANDSOUND
+-- @field #string ClassName Name of this class.
+-- @field #string version Versioning.
+-- @field #string lid LID for log entries.
+-- @field #string locale Default locale of this object.
+-- @field #table entries Table of entries.
+-- @field #string textclass Name of the class the texts belong to.
+-- @extends Core.Base#BASE
+
+---
+--
+-- @field #TEXTANDSOUND
+TEXTANDSOUND = {
+  ClassName = "TEXTANDSOUND",
+  version = "0.0.1",
+  lid = "",
+  locale = "en",
+  entries = {},
+  textclass = "",
+}
+
+--- Text and Sound entry.
+-- @type TEXTANDSOUND.Entry
+-- @field #string Classname Name of the class this entry is for.
+-- @field #string Locale Locale of this entry, defaults to "en".
+-- @field #table Data The list of entries.
+
+--- Text and Sound data
+-- @type TEXTANDSOUND.Data
+-- @field #string ID ID of this entry for retrieval.
+-- @field #string Text Text of this entry.
+-- @field #string Soundfile (optional) Soundfile File name of the corresponding sound file.
+-- @field #number Soundlength (optional)  Length of the sound file in seconds.
+-- @field #string Subtitle (optional)  Subtitle for the sound file.
+
+--- Instantiate a new object
+-- @param #TEXTANDSOUND self
+-- @param #string ClassName Name of the class this instance is providing texts for.
+-- @param #string Defaultlocale (Optional) Default locale of this instance, defaults to "en". 
+-- @return #TEXTANDSOUND self
+function TEXTANDSOUND:New(ClassName,Defaultlocale)
+    -- Inherit everything from BASE class.
+  local self=BASE:Inherit(self, BASE:New())
+  -- Set some string id for output to DCS.log file.
+  self.lid=string.format("%s (%s) | ", self.ClassName, self.version)
+  self.locale = Defaultlocale or (_SETTINGS:GetLocale() or "en")
+  self.textclass = ClassName or "none"
+  self.entries = {}
+  local initentry = {} -- #TEXTANDSOUND.Entry
+  initentry.Classname = ClassName
+  initentry.Data = {}
+  initentry.Locale = self.locale
+  self.entries[self.locale] = initentry
+  self:I(self.lid .. "Instantiated.")
+  self:T({self.entries[self.locale]})
+  return self
+end
+
+--- Add an entry
+-- @param #TEXTANDSOUND self
+-- @param #string Locale Locale to set for this entry, e.g. "de".
+-- @param #string ID Unique(!) ID of this entry under this locale (i.e. use the same ID to get localized text for the entry in another language).
+-- @param #string Text Text for this entry.
+-- @param #string Soundfile (Optional) Sound file name for this entry.
+-- @param #number Soundlength (Optional) Length of the sound file in seconds.
+-- @param #string Subtitle (Optional) Subtitle to be used alongside the sound file.
+-- @return #TEXTANDSOUND self
+function TEXTANDSOUND:AddEntry(Locale,ID,Text,Soundfile,Soundlength,Subtitle)
+  self:T(self.lid .. "AddEntry")
+  local locale = Locale or self.locale
+  local dataentry = {} -- #TEXTANDSOUND.Data
+  dataentry.ID = ID or "1"
+  dataentry.Text = Text or "none"
+  dataentry.Soundfile = Soundfile
+  dataentry.Soundlength = Soundlength or 0
+  dataentry.Subtitle = Subtitle
+  if not self.entries[locale] then
+    local initentry = {} -- #TEXTANDSOUND.Entry
+    initentry.Classname = self.textclass -- class name entry
+    initentry.Data = {} -- data array
+    initentry.Locale = locale -- default locale
+    self.entries[locale] = initentry
+  end
+  self.entries[locale].Data[ID] = dataentry
+  self:T({self.entries[locale].Data})
+  return self
+end
+
+--- Get an entry
+-- @param #TEXTANDSOUND self
+-- @param #string ID The unique ID of the data to be retrieved.
+-- @param #string Locale (Optional) The locale of the text to be retrieved - defauls to default locale set with `New()`.
+-- @return #string Text Text or nil if not found and no fallback.
+-- @return #string Soundfile Filename or nil if not found and no fallback.
+-- @return #string Soundlength Length of the sound or 0 if not found and no fallback.
+-- @return #string Subtitle Text for subtitle or nil if not found and no fallback.
+function TEXTANDSOUND:GetEntry(ID,Locale)
+  self:T(self.lid .. "GetEntry")
+  local locale = Locale or self.locale
+  if not self.entries[locale] then
+    -- fall back to default "en"
+    locale = self.locale
+  end
+  local Text,Soundfile,Soundlength,Subtitle = nil, nil, 0, nil
+  if self.entries[locale] then
+    if self.entries[locale].Data then
+      local data = self.entries[locale].Data[ID] -- #TEXTANDSOUND.Data
+      if data then 
+        Text = data.Text
+        Soundfile = data.Soundfile
+        Soundlength = data.Soundlength
+        Subtitle = data.Subtitle
+      elseif self.entries[self.locale].Data[ID] then
+        -- no matching entry, try default
+        local data = self.entries[self.locale].Data[ID]
+        Text = data.Text
+        Soundfile = data.Soundfile
+        Soundlength = data.Soundlength
+        Subtitle = data.Subtitle
+      end
+    end
+  else
+    return nil, nil, 0, nil
+  end
+  return Text,Soundfile,Soundlength,Subtitle
+end
+
+--- Get the default locale of this object
+-- @param #TEXTANDSOUND self
+-- @return #string locale
+function TEXTANDSOUND:GetDefaultLocale()
+  self:T(self.lid .. "GetDefaultLocale")
+  return self.locale
+end
+
+--- Set default locale of this object
+-- @param #TEXTANDSOUND self
+-- @param #string locale
+-- @return #TEXTANDSOUND self 
+function TEXTANDSOUND:SetDefaultLocale(locale)
+  self:T(self.lid .. "SetDefaultLocale")
+  self.locale = locale or "en"
+  return self
+end
+
+--- Check if a locale exists
+-- @param #TEXTANDSOUND self
+-- @return #boolean outcome
+function TEXTANDSOUND:HasLocale(Locale)
+  self:T(self.lid .. "HasLocale")
+  return self.entries[Locale] and true or false
+end
+
+--- Flush all entries to the log
+-- @param #TEXTANDSOUND self
+-- @return #TEXTANDSOUND self
+function TEXTANDSOUND:FlushToLog()
+  self:I(self.lid .. "Flushing entries:")
+  local text = string.format("Textclass: %s | Default Locale: %s",self.textclass, self.locale)
+  for _,_entry in pairs(self.entries) do
+    local entry = _entry -- #TEXTANDSOUND.Entry
+    local text = string.format("Textclassname: %s | Locale: %s",entry.Classname, entry.Locale)
+    self:I(text)
+    for _ID,_data in pairs(entry.Data) do
+      local data = _data -- #TEXTANDSOUND.Data
+      local text = string.format("ID: %s\nText: %s\nSoundfile: %s With length: %d\nSubtitle: %s",tostring(_ID), data.Text or "none",data.Soundfile or "none",data.Soundlength or 0,data.Subtitle or "none")
+      self:I(text)
+    end
+  end
+  return self
+end
+
+----------------------------------------------------------------
+-- End TextAndSound
+----------------------------------------------------------------

Moose Development/Moose/Core/Timer.lua

@@ -34,8 +34,6 @@
 --
 -- ===
 --
--- ![Banner Image](..\Presentations\Timer\TIMER_Main.jpg)
---
 -- # The TIMER Concept
 -- 
 -- The TIMER class is the little sister of the @{Core.Scheduler#SCHEDULER} class. It does the same thing but is a bit easier to use and has less overhead. It should be sufficient in many cases.
@@ -107,19 +105,17 @@ TIMER = {
 --- Timer ID.
 _TIMERID=0
 
---- Timer data base.
---_TIMERDB={}
-
 --- TIMER class version.
 -- @field #string version
-TIMER.version="0.1.1"
+TIMER.version="0.1.2"
 
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 -- TODO list
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
--- TODO: A lot.
+-- TODO: Randomization.
--- TODO: Write docs.
+-- TODO: Pause/unpause.
+-- DONE: Write docs.
 
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 -- Constructor
@@ -156,9 +152,6 @@ function TIMER:New(Function, ...)
   -- Log id.
   self.lid=string.format("TIMER UID=%d | ", self.uid)
   
-  -- Add to DB.
-  --_TIMERDB[self.uid]=self
-  
   return self
 end
 
@@ -174,7 +167,7 @@ function TIMER:Start(Tstart, dT, Duration)
   local Tnow=timer.getTime()
 
   -- Start time in sec.
-  self.Tstart=Tstart and Tnow+Tstart or Tnow+0.001  -- one millisecond delay if Tstart=nil
+  self.Tstart=Tstart and Tnow+math.max(Tstart, 0.001) or Tnow+0.001  -- one millisecond delay if Tstart=nil
   
   -- Set time interval.
   self.dT=dT
@@ -220,9 +213,6 @@ function TIMER:Stop(Delay)
       -- Not running any more.
       self.isrunning=false
 
-      -- Remove DB entry.
-      --_TIMERDB[self.uid]=nil
-      
     end
     
   end
@@ -239,6 +229,15 @@ function TIMER:SetMaxFunctionCalls(Nmax)
   return self
 end
 
+--- Set time interval. Can also be set when the timer is already running and is applied after the next function call.
+-- @param #TIMER self
+-- @param #number dT Time interval in seconds.
+-- @return #TIMER self
+function TIMER:SetTimeInterval(dT)
+  self.dT=dT
+  return self
+end
+
 --- Check if the timer has been started and was not stopped.
 -- @param #TIMER self
 -- @return #boolean If `true`, the timer is running.

Moose Development/Moose/DCS.lua

@@ -295,6 +295,17 @@ do -- country
   -- @field QATAR
   -- @field OMAN
   -- @field UNITED_ARAB_EMIRATES
+  -- @field SOUTH_AFRICA
+  -- @field CUBA
+  -- @field PORTUGAL
+  -- @field GDR
+  -- @field LEBANON
+  -- @field CJTF_BLUE
+  -- @field CJTF_RED
+  -- @field UN_PEACEKEEPERS
+  -- @field Argentinia
+  -- @field Cyprus
+  -- @field Slovenia
 
   country = {} --#country
 
@@ -460,6 +471,22 @@ do -- Types
   --@field #boolean lateActivated
   --@field #boolean uncontrolled
 
+  --- DCS template data structure.
+  -- @type Template
+  -- @field #boolean uncontrolled Aircraft is uncontrolled.
+  -- @field #boolean lateActivation Group is late activated.
+  -- @field #number x 2D Position on x-axis in meters.
+  -- @field #number y 2D Position on y-axis in meters.
+  -- @field #table units Unit list.
+  -- 
+  
+  --- Unit data structure.
+  --@type Template.Unit
+  --@field #string name Name of the unit.
+  --@field #number x
+  --@field #number y
+  --@field #number alt
+
 end --
 
 
@@ -476,8 +503,9 @@ do -- Object
   -- @field UNIT
   -- @field WEAPON
   -- @field STATIC
-  -- @field SCENERY
   -- @field BASE
+  -- @field SCENERY
+  -- @field CARGO
   
   --- @type Object.Desc
   -- @extends #Desc
@@ -488,6 +516,10 @@ do -- Object
   -- @param #Object self
   -- @return #boolean
 
+  --- @function [parent=#Object] isActive
+  -- @param #Object self
+  -- @return #boolean
+  
   --- @function [parent=#Object] destroy
   -- @param #Object self
   
@@ -736,7 +768,66 @@ do -- Airbase
 
 end -- Airbase
 
+do -- Spot
 
+  --- [DCS Class Spot](https://wiki.hoggitworld.com/view/DCS_Class_Spot)
+  -- Represents a spot from laser or IR-pointer.
+  -- @type Spot 
+  -- @field #Spot.Category Category enum that stores spot categories. 
+  
+  --- Enum that stores spot categories. 
+  -- @type Spot.Category
+  -- @field #string INFRA_RED
+  -- @field #string LASER
+
+  
+  --- Creates a laser ray emanating from the given object to a point in 3d space.
+  -- @function [parent=#Spot] createLaser
+  -- @param DCS#Object Source The source object of the laser.
+  -- @param DCS#Vec3 LocalRef An optional 3D offset for the source.
+  -- @param DCS#Vec3 Vec3 Target coordinate where the ray is pointing at.
+  -- @param #number LaserCode Any 4 digit number between 1111 and 1788.
+  -- @return #Spot
+
+  --- Creates an infrared ray emanating from the given object to a point in 3d space. Can be seen with night vision goggles.
+  -- @function [parent=#Spot] createInfraRed
+  -- @param DCS#Object Source Source position of the IR ray.
+  -- @param DCS#Vec3 LocalRef An optional 3D offset for the source.
+  -- @param DCS#Vec3 Vec3 Target coordinate where the ray is pointing at.
+  -- @return #Spot
+
+  --- Returns a vec3 table of the x, y, and z coordinates for the position of the given object in 3D space. Coordinates are dependent on the position of the maps origin.
+  -- @function [parent=#Spot] getPoint
+  -- @param #Spot self
+  -- @return DCS#Vec3 Point in 3D, where the beam is pointing at.
+  
+  --- Sets the destination point from which the source of the spot is drawn toward.
+  -- @function [parent=#Spot] setPoint
+  -- @param #Spot self
+  -- @param DCS#Vec3 Vec3 Point in 3D, where the beam is pointing at.
+
+  --- Returns the number that is used to define the laser code for which laser designation can track.
+  -- @function [parent=#Spot] getCode
+  -- @param #Spot self
+  -- @return #number Code The laser code used.
+
+  --- Sets the number that is used to define the laser code for which laser designation can track.
+  -- @function [parent=#Spot] setCode
+  -- @param #Spot self
+  -- @param #number Code The laser code. Default value is 1688.
+  
+  --- Destroys the spot.
+  -- @function [parent=#Spot] destroy
+  -- @param #Spot self
+
+  --- Gets the category of the spot (laser or IR).
+  -- @function [parent=#Spot] getCategory
+  -- @param #Spot self
+  -- @return #string Category.
+
+  Spot = {} --#Spot
+
+end -- Spot
 
 do -- Controller
   --- Controller is an object that performs A.I.-routines. Other words controller is an instance of A.I.. Controller stores current main task, active enroute tasks and behavior options. Controller performs commands. Please, read DCS A-10C GUI Manual EN.pdf chapter "Task Planning for Unit Groups", page 91 to understand A.I. system of DCS:A-10C. 
@@ -1061,6 +1152,11 @@ do -- Unit
   -- @param #Unit self
   -- @return #Unit.Ammo
 
+  --- Returns the number of infantry that can be embark onto the aircraft. Only returns a value if run on airplanes or helicopters. Returns nil if run on ground or ship units.
+  -- @function [parent=#Unit] getDescentCapacity
+  -- @param #Unit self
+  -- @return #number Number of soldiers that embark.
+  
   --- Returns the unit sensors. 
   -- @function [parent=#Unit] getSensors
   -- @param #Unit self
@@ -1093,6 +1189,10 @@ do -- Unit
   -- @param #Unit self
   -- @return #Unit.Desc
   
+  --- GROUND - Switch on/off radar emissions
+  -- @function [parent=#Unit] enableEmission
+  -- @param #Unit self
+  -- @param #boolean switch
   
   Unit = {} --#Unit
 
@@ -1163,7 +1263,7 @@ do -- Group
   -- @param #Group self 
   -- @return #number
   
-  --- Returns initial size of the group. If some of the units will be destroyed, initial size of the group will not be changed. Initial size limits the unitNumber parameter for Group.getUnit() function.
+  --- Returns initial size of the group. If some of the units will be destroyed, initial size of the group will not be changed; Initial size limits the unitNumber parameter for Group.getUnit() function.
   -- @function [parent=#Group] getInitialSize
   -- @param #Group self 
   -- @return #number
@@ -1178,6 +1278,11 @@ do -- Group
   -- @param #Group self 
   -- @return #Controller
   
+    --- GROUND - Switch on/off radar emissions
+  -- @function [parent=#Group] enableEmission
+  -- @param #Group self
+  -- @param #boolean switch
+  
   Group = {} --#Group
 
 end -- Group
@@ -1269,7 +1374,9 @@ do -- AI
   --- @type AI.Option.Ground
   -- @field #AI.Option.Ground.id                    id
   -- @field #AI.Option.Ground.val                   val
-  
+  -- @field #AI.Option.Ground.mid                   mid
+  -- @field #AI.Option.Ground.mval                  mval
+  -- 
   --- @type AI.Option.Naval
   -- @field #AI.Option.Naval.id                     id
   -- @field #AI.Option.Naval.val                    val
@@ -1292,6 +1399,11 @@ do -- AI
   -- @field PROHIBIT_AG
   -- @field MISSILE_ATTACK
   -- @field PROHIBIT_WP_PASS_REPORT
+  -- @field OPTION_RADIO_USAGE_CONTACT
+  -- @field OPTION_RADIO_USAGE_ENGAGE
+  -- @field OPTION_RADIO_USAGE_KILL
+  -- @field JETT_TANKS_IF_EMPTY
+  -- @field FORCED_ATTACK
   
   --- @type AI.Option.Air.id.FORMATION
   -- @field LINE_ABREAST
@@ -1361,19 +1473,35 @@ do -- AI
   --- @type AI.Option.Ground.id
   -- @field NO_OPTION
   -- @field ROE @{#AI.Option.Ground.val.ROE}
+  -- @field FORMATION
   -- @field DISPERSE_ON_ATTACK true or false
   -- @field ALARM_STATE @{#AI.Option.Ground.val.ALARM_STATE}
   -- @field ENGAGE_AIR_WEAPONS
+  -- @field AC_ENGAGEMENT_RANGE_RESTRICTION
+  
+  --- @type AI.Option.Ground.mid -- Moose added
+  -- @field RESTRICT_AAA_MIN        27
+  -- @field RESTRICT_AAA_MAX        29
+  -- @field RESTRICT_TARGETS @{#AI.Option.Ground.mval.ENGAGE_TARGETS}  28
   
   --- @type AI.Option.Ground.val
   -- @field #AI.Option.Ground.val.ROE               ROE
   -- @field #AI.Option.Ground.val.ALARM_STATE       ALARM_STATE
+  -- @field #AI.Option.Ground.val.ENGAGE_TARGETS    RESTRICT_TARGETS
   
   --- @type AI.Option.Ground.val.ROE
   -- @field OPEN_FIRE
   -- @field RETURN_FIRE
   -- @field WEAPON_HOLD
   
+  --- @type AI.Option.Ground.mval -- Moose added
+  -- @field #AI.Option.Ground.mval.ENGAGE_TARGETS   ENGAGE_TARGETS
+  
+  --- @type AI.Option.Ground.mval.ENGAGE_TARGETS -- Moose added
+  -- @field ANY_TARGET -- 0
+  -- @field AIR_UNITS_ONLY -- 1
+  -- @field GROUND_UNITS_ONLY -- 2
+  
   --- @type AI.Option.Ground.val.ALARM_STATE
   -- @field AUTO
   -- @field GREEN

Moose Development/Moose/Functional/Artillery.lua

@@ -73,7 +73,7 @@
 -- @field Core.Point#COORDINATE RearmingPlaceCoord Coordinates of the rearming place. If the place is more than 100 m away from the ARTY group, the group will go there.
 -- @field #boolean RearmingArtyOnRoad If true, ARTY group will move to rearming place using mainly roads. Default false.
 -- @field Core.Point#COORDINATE InitialCoord Initial coordinates of the ARTY group.
--- @field #boolean report Arty group sends messages about their current state or target to its coaliton.
+-- @field #boolean report Arty group sends messages about their current state or target to its coalition.
 -- @field #table ammoshells Table holding names of the shell types which are included when counting the ammo. Default is {"weapons.shells"} which include most shells.
 -- @field #table ammorockets Table holding names of the rocket types which are included when counting the ammo. Default is {"weapons.nurs"} which includes most unguided rockets.
 -- @field #table ammomissiles Table holding names of the missile types which are included when counting the ammo. Default is {"weapons.missiles"} which includes some guided missiles.

Moose Development/Moose/Functional/Designate.lua

@@ -213,7 +213,7 @@ do -- DESIGNATE
   -- In order to prevent an overflow of designations due to many Detected Targets, there is a 
   -- Maximum Designations scope that is set in the DesignationObject.
   -- 
-  -- The method @{#DESIGNATE.SetMaximumDesignations}() will put a limit on the amount of designations put in scope of the DesignationObject.
+  -- The method @{#DESIGNATE.SetMaximumDesignations}() will put a limit on the amount of designations (target groups) put in scope of the DesignationObject.
   -- Using the menu system, the player can "forget" a designation, so that gradually a new designation can be put in scope when detected.
   -- 
   -- # 4. Laser codes
@@ -562,7 +562,8 @@ do -- DESIGNATE
   end
 
 
-  --- Set the maximum amount of designations.
+  --- Set the maximum amount of designations (target groups). This will put a limit on the amount of designations in scope.
+  -- Using the menu system, the player can "forget" a designation, so that gradually a new designation can be put in scope when detected.
   -- @param #DESIGNATE self
   -- @param #number MaximumDesignations
   -- @return #DESIGNATE
@@ -602,7 +603,7 @@ do -- DESIGNATE
   end
   
   
-  --- Set the maximum amount of markings FACs will do, per designated target group.
+  --- Set the maximum amount of markings FACs will do, per designated target group. This will limit the number of parallelly marked units of a target group.
   -- @param #DESIGNATE self
   -- @param #number MaximumMarkings Maximum markings FACs will do, per designated target group.
   -- @return #DESIGNATE
@@ -911,8 +912,8 @@ do -- DESIGNATE
           for DesignateIndex, Designating in pairs( self.Designating ) do
             local DetectedItem = DetectedItems[DesignateIndex]
             if DetectedItem then
-              local Report = self.Detection:DetectedItemReportSummary( DetectedItem, AttackGroup ):Text( ", " )
+              local Report = self.Detection:DetectedItemReportSummary( DetectedItem, AttackGroup, nil, true ):Text( ", " )
-              DetectedReport:Add( string.rep( "-", 140 ) )
+              DetectedReport:Add( string.rep( "-", 40 ) )
               DetectedReport:Add( " - " .. Report )
               if string.find( Designating, "L" ) then
                 DetectedReport:Add( " - " .. "Lasing Targets" )
@@ -1001,7 +1002,13 @@ do -- DESIGNATE
         local ID = self.Detection:GetDetectedItemID( DetectedItem )
         local MenuText = ID --.. ", " .. Coord:ToStringA2G( AttackGroup )
         
-        MenuText = string.format( "(%3s) %s", Designating, MenuText )
+        -- Use injected MenuName from TaskA2GDispatcher if using same Detection Object
+        if DetectedItem.DesignateMenuName then
+          MenuText = string.format( "(%3s) %s", Designating, DetectedItem.DesignateMenuName )
+        else
+          MenuText = string.format( "(%3s) %s", Designating, MenuText )
+        end
+        
         local DetectedMenu = MENU_GROUP_DELAYED:New( AttackGroup, MenuText, MenuDesignate ):SetTime( MenuTime ):SetTag( self.DesignateName )
         
         -- Build the Lasing menu.
@@ -1186,8 +1193,8 @@ do -- DESIGNATE
 
     local MarkingCount = 0
     local MarkedTypes = {}
-    local ReportTypes = REPORT:New()
+    --local ReportTypes = REPORT:New()
-    local ReportLaserCodes = REPORT:New()
+    --local ReportLaserCodes = REPORT:New()
     
     TargetSetUnit:Flush( self )
 
@@ -1237,7 +1244,7 @@ do -- DESIGNATE
               if not Recce then
     
                 self:F( "Lasing..." )
-                self.RecceSet:Flush( self)
+                --self.RecceSet:Flush( self)
 
                 for RecceGroupID, RecceGroup in pairs( self.RecceSet:GetSet() ) do
                   for UnitID, UnitData in pairs( RecceGroup:GetUnits() or {} ) do
@@ -1276,13 +1283,13 @@ do -- DESIGNATE
                           -- OK. We have assigned for the Recce a TargetUnit. We can exit the function.
                           MarkingCount = MarkingCount + 1
                           local TargetUnitType = TargetUnit:GetTypeName()
-                          --RecceUnit:MessageToSetGroup( "Marking " .. TargetUnit:GetTypeName() .. " with laser " .. RecceUnit:GetSpot().LaserCode .. " for " .. Duration .. "s.", 
+                          RecceUnit:MessageToSetGroup( "Marking " .. TargetUnit:GetTypeName() .. " with laser " .. RecceUnit:GetSpot().LaserCode .. " for " .. Duration .. "s.", 
-                          --                             5, self.AttackSet, DesignateName )
+                                                     10, self.AttackSet, DesignateName )
                           if not MarkedTypes[TargetUnitType] then
                             MarkedTypes[TargetUnitType] = true
-                            ReportTypes:Add(TargetUnitType)
+                            --ReportTypes:Add(TargetUnitType)
                           end
-                          ReportLaserCodes:Add(RecceUnit.LaserCode)
+                          --ReportLaserCodes:Add(RecceUnit.LaserCode)
                           return
                         end
                       else
@@ -1297,16 +1304,16 @@ do -- DESIGNATE
     
                         if Recce then
                           Recce:LaseOff()
-                          Recce:MessageToSetGroup( "Target " .. TargetUnit:GetTypeName() "out of LOS. Cancelling lase!", 5, self.AttackSet, self.DesignateName )
+                          Recce:MessageToSetGroup( "Target " .. TargetUnit:GetTypeName() "out of LOS. Cancelling lase!", 10, self.AttackSet, self.DesignateName )
                         end
                       else
                         --MarkingCount = MarkingCount + 1
                         local TargetUnitType = TargetUnit:GetTypeName()
                         if not MarkedTypes[TargetUnitType] then
                           MarkedTypes[TargetUnitType] = true
-                          ReportTypes:Add(TargetUnitType)
+                          --ReportTypes:Add(TargetUnitType)
                         end
-                        ReportLaserCodes:Add(RecceUnit.LaserCode)
+                        --ReportLaserCodes:Add(RecceUnit.LaserCode)
                       end  
                     end
                   end
@@ -1316,19 +1323,19 @@ do -- DESIGNATE
                 local TargetUnitType = TargetUnit:GetTypeName()
                 if not MarkedTypes[TargetUnitType] then
                   MarkedTypes[TargetUnitType] = true
-                  ReportTypes:Add(TargetUnitType)
+                  --ReportTypes:Add(TargetUnitType)
                 end
-                ReportLaserCodes:Add(Recce.LaserCode)
+                --ReportLaserCodes:Add(Recce.LaserCode)
-                --Recce:MessageToSetGroup( self.DesignateName .. ": Marking " .. TargetUnit:GetTypeName() .. " with laser " .. Recce.LaserCode .. ".", 5, self.AttackSet )
+                Recce:MessageToSetGroup( self.DesignateName .. ": Marking " .. TargetUnit:GetTypeName() .. " with laser " .. Recce.LaserCode .. ".", 10, self.AttackSet )
               end
             end
           end
         end
       )
 
-      local MarkedTypesText = ReportTypes:Text(', ')
+      --local MarkedTypesText = ReportTypes:Text(', ')
-      local MarkedLaserCodesText = ReportLaserCodes:Text(', ')
+      --local MarkedLaserCodesText = ReportLaserCodes:Text(', ')
-      self.CC:GetPositionable():MessageToSetGroup( "Marking " .. MarkingCount .. " x "  .. MarkedTypesText .. ", code " .. MarkedLaserCodesText .. ".", 5, self.AttackSet, self.DesignateName )
+      --self.CC:GetPositionable():MessageToSetGroup( "Marking " .. MarkingCount .. " x "  .. MarkedTypesText .. ", code " .. MarkedLaserCodesText .. ".", 5, self.AttackSet, self.DesignateName )
   
       self:__Lasing( -self.LaseDuration, Index, Duration, LaserCodeRequested )
       

Moose Development/Moose/Functional/Fox.lua

@@ -23,7 +23,6 @@
 -- @module Functional.FOX
 -- @image Functional_FOX.png
 
-
 --- FOX class.
 -- @type FOX
 -- @field #string ClassName Name of the class.
@@ -48,7 +47,6 @@
 -- @field #number dt05 Time step [sec] for missile position updates if distance to target > 5 km and < 10 km. Default 0.5 sec.
 -- @field #number dt01 Time step [sec] for missile position updates if distance to target > 1 km and < 5 km. Default 0.1 sec.
 -- @field #number dt00 Time step [sec] for missile position updates if distance to target < 1 km. Default 0.01 sec. 
--- @field #boolean 
 -- @extends Core.Fsm#FSM
 
 --- Fox 3!
@@ -794,7 +792,7 @@ function FOX:onafterMissileLaunch(From, Event, To, missile)
           local text=string.format("Missile launch detected! Distance %.1f NM, bearing %03d°.", UTILS.MetersToNM(distance), bearing)
           
           -- Say notching headings.
-          BASE:ScheduleOnce(5, FOX._SayNotchingHeadings, self, player, missile.weapon)
+          self:ScheduleOnce(5, FOX._SayNotchingHeadings, self, player, missile.weapon)
                     
           --TODO: ALERT or INFO depending on whether this is a direct target.
           --TODO: lauchalertall option.
@@ -1116,6 +1114,13 @@ end
 -- Event Functions
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
+--- FOX event handler for event birth.
+-- @param #FOX self
+-- @param Core.Event#EVENTDATA EventData
+function FOX:OnEventPlayerEnterAircraft(EventData)
+
+end
+
 --- FOX event handler for event birth.
 -- @param #FOX self
 -- @param Core.Event#EVENTDATA EventData
@@ -1157,7 +1162,7 @@ function FOX:OnEventBirth(EventData)
             
     -- Add F10 radio menu for player.
     if not self.menudisabled then
-      SCHEDULER:New(nil, self._AddF10Commands, {self,_unitName}, 0.1)
+      self:ScheduleOnce(0.1, FOX._AddF10Commands, self, _unitname)
     end
     
     -- Player data.
@@ -1707,8 +1712,8 @@ end
 --- Returns the unit of a player and the player name. If the unit does not belong to a player, nil is returned. 
 -- @param #FOX self
 -- @param DCS#Weapon weapon The weapon.
--- @return #number Notching heading right, i.e. missile heading +90<EFBFBD>
+-- @return #number Notching heading right, i.e. missile heading +90°.
--- @return #number Notching heading left, i.e. missile heading -90<EFBFBD>.
+-- @return #number Notching heading left, i.e. missile heading -90°.
 function FOX:_GetNotchingHeadings(weapon)
 
   if weapon then

Moose Development/Moose/Functional/MissileTrainer.lua

@@ -5,7 +5,7 @@
 -- ## 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 of missile launches, including detailed information of the units launching, including bearing, range
 --   * Provide alerts when a missile would have killed your aircraft.
 --   * Provide alerts when the missile self destructs.
 --   * Enable / Disable and Configure the Missile Trainer using the various menu options.

Moose Development/Moose/Functional/PseudoATC.lua

@@ -742,7 +742,7 @@ function PSEUDOATC:ReportWeather(GID, UID, position, location)
   local T=position:GetTemperature()
     
   -- Correct unit system.
-  local _T=string.format('%d°F', UTILS.CelciusToFarenheit(T))
+  local _T=string.format('%d°F', UTILS.CelsiusToFahrenheit(T))
   if settings:IsMetric() then
     _T=string.format('%d°C', T)
   end
@@ -949,11 +949,14 @@ function PSEUDOATC:LocalAirports(GID, UID)
     for _,airbase in pairs(airports) do
     
       local name=airbase:getName()
-      local q=AIRBASE:FindByName(name):GetCoordinate()
+      local a=AIRBASE:FindByName(name)
-      local d=q:Get2DDistance(pos)
+      if a then
+        local q=a:GetCoordinate()
+        local d=q:Get2DDistance(pos)
       
-      -- Add to table.
+        -- Add to table.
-      table.insert(self.group[GID].player[UID].airports, {distance=d, name=name})
+        table.insert(self.group[GID].player[UID].airports, {distance=d, name=name})
+      end
       
     end
   end
@@ -1041,6 +1044,3 @@ function PSEUDOATC:_myname(unitname)
   
   return string.format("%s (%s)", csign, pname)
 end
-
-
-

Moose Development/Moose/Functional/RAT.lua

@@ -69,7 +69,7 @@
 -- @field #string category Category of aircarft: "plane" or "heli".
 -- @field #number groupsize Number of aircraft in group.
 -- @field #string friendly Possible departure/destination airport: all=blue+red+neutral, same=spawn+neutral, spawnonly=spawn, blue=blue+neutral, blueonly=blue, red=red+neutral, redonly=red.
--- @field #table ctable Table with the valid coalitons from choice self.friendly.
+-- @field #table ctable Table with the valid coalitions from choice self.friendly.
 -- @field #table aircraft Table which holds the basic aircraft properties (speed, range, ...).
 -- @field #number Vcruisemax Max cruise speed in m/s (250 m/s = 900 km/h = 486 kt) set by user.
 -- @field #number Vclimb Default climb rate in ft/min.
@@ -348,7 +348,7 @@ RAT={
   category = nil,           -- Category of aircarft: "plane" or "heli".
   groupsize=nil,            -- Number of aircraft in the group.
   friendly = "same",        -- Possible departure/destination airport: same=spawn+neutral, spawnonly=spawn, blue=blue+neutral, blueonly=blue, red=red+neutral, redonly=red, neutral.
-  ctable = {},              -- Table with the valid coalitons from choice self.friendly.
+  ctable = {},              -- Table with the valid coalitions from choice self.friendly.
   aircraft = {},            -- Table which holds the basic aircraft properties (speed, range, ...).
   Vcruisemax=nil,           -- Max cruise speed in set by user.
   Vclimb=1500,              -- Default climb rate in ft/min.
@@ -657,7 +657,7 @@ end
 -- @param #RAT self
 -- @param #number naircraft (Optional) Number of aircraft to spawn. Default is one aircraft.
 -- @return #boolean True if spawning was successful or nil if nothing was spawned.
--- @usage yak:Spawn(5) will spawn five aircraft. By default aircraft will spawn at neutral and red airports if the template group is part of the red coaliton.
+-- @usage yak:Spawn(5) will spawn five aircraft. By default aircraft will spawn at neutral and red airports if the template group is part of the red coalition.
 function RAT:Spawn(naircraft)
 
   -- Make sure that this function is only been called once per RAT object.
@@ -1289,7 +1289,7 @@ end
 
 --- Include all airports which lie in a zone as possible destinations.
 -- @param #RAT self
--- @param Core.Zone#ZONE zone Zone in which the departure airports lie. Has to be a MOOSE zone.
+-- @param Core.Zone#ZONE zone Zone in which the destination airports lie. Has to be a MOOSE zone.
 -- @return #RAT RAT self object.
 function RAT:SetDestinationsFromZone(zone)
   self:F2(zone)
@@ -1305,7 +1305,7 @@ end
 
 --- Include all airports which lie in a zone as possible destinations.
 -- @param #RAT self
--- @param Core.Zone#ZONE zone Zone in which the destination airports lie. Has to be a MOOSE zone.
+-- @param Core.Zone#ZONE zone Zone in which the departure airports lie. Has to be a MOOSE zone.
 -- @return #RAT RAT self object.
 function RAT:SetDeparturesFromZone(zone)
   self:F2(zone)
@@ -2049,9 +2049,15 @@ function RAT:_InitAircraft(DCSgroup)
   --self.aircraft.descriptors=DCSdesc
 
   -- aircraft dimensions
-  self.aircraft.length=DCSdesc.box.max.x
+  if DCSdesc.box then
-  self.aircraft.height=DCSdesc.box.max.y
+    self.aircraft.length=DCSdesc.box.max.x
-  self.aircraft.width=DCSdesc.box.max.z
+    self.aircraft.height=DCSdesc.box.max.y
+    self.aircraft.width=DCSdesc.box.max.z
+  elseif DCStype == "Mirage-F1CE" then
+    self.aircraft.length=16
+    self.aircraft.height=5
+    self.aircraft.width=9
+  end
   self.aircraft.box=math.max(self.aircraft.length,self.aircraft.width)
 
   -- info message
@@ -5371,7 +5377,7 @@ function RAT:_ModifySpawnTemplate(waypoints, livery, spawnplace, departure, take
 
         if spawnonground then
 
-          -- Sh<EFBFBD>ps and FARPS seem to have a build in queue.
+          -- Ships and FARPS seem to have a build in queue.
           if spawnonship or spawnonfarp or spawnonrunway or automatic then
             self:T(RAT.id..string.format("RAT group %s spawning at farp, ship or runway %s.", self.alias, departure:GetName()))
 
@@ -5786,6 +5792,8 @@ end
 -- If desired, the @{#RATMANAGER} can be stopped by the @{#RATMANAGER.Stop}(stoptime) function. The parameter "stoptime" specifies the time delay in seconds after which the manager stops.
 -- When this happens, no new aircraft will be spawned and the population will eventually decrease to zero.
 --
+-- When you are using a time intervall like @{#RATMANAGER.dTspawn}(delay), @{#RATMANAGER} will ignore the amount set with @{#RATMANAGER.New}(). @{#RATMANAGER.dTspawn}(delay) will spawn infinite groups.
+--
 -- ## Example
 -- In this example, three different @{#RAT} objects are created (but not spawned manually). The @{#RATMANAGER} takes care that at least five aircraft of each type are alive and that the total number of aircraft
 -- spawned is 25. The @{#RATMANAGER} is started after 30 seconds and stopped after two hours.
@@ -6143,4 +6151,3 @@ function RATMANAGER:_RollDice(nrat,ntot,min,alive)
   -- Return number of groups to be spawned.
   return N
 end
-

Moose Development/Moose/Functional/Scoring.lua

@@ -67,7 +67,7 @@
 --
 --   * Upload scoring to a database or a BI tool to publish the scoring results to the player community.
 --   * Upload scoring in an (online) Excel like tool, using pivot tables and pivot charts to show mission results.
---   * Share scoring amoung players after the mission to discuss mission results.
+--   * Share scoring among players after the mission to discuss mission results.
 --
 -- Scores can be **reported**. **Menu options** are automatically added to **each player group** when a player joins a client slot or a CA unit.
 -- Use the radio menu F10 to consult the scores while running the mission.
@@ -88,7 +88,6 @@
 -- @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
@@ -99,7 +98,6 @@
 --
 --      local Scoring = SCORING:New( "Scoring File" )
 --
--- 
 -- # Set the destroy score or penalty scale:
 --
 -- Score scales can be set for scores granted when enemies or friendlies are destroyed.
@@ -147,11 +145,11 @@
 --
 -- # (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**.
+-- **This functionality is decommissioned until the DCS bug concerning Unit:destroy() not being functional in multi player for player units has been fixed by ED**.
 --
 -- When a player commits too much damage to friendlies, his penalty score will reach a certain level.
 -- 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.
+-- By default, the fratricide level is the default penalty multiplier * 2 for the penalty score.
 --
 -- # Penalty score when a player changes the coalition.
 --
@@ -190,8 +188,8 @@
 --
 --        --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.
+--        --Mission downloaded from server to client may contain potentially harmful lua code that may use these functions.
---        --You can remove the code below and make availble these functions at your own risk.
+--        --You can remove the code below and make available these functions at your own risk.
 --
 -- 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.
@@ -229,20 +227,18 @@ SCORING = {
   Players = {},
 }
 
-local _SCORINGCoalition =
+local _SCORINGCoalition = {
-  {
+  [1] = "Red",
-    [1] = "Red",
+  [2] = "Blue",
-    [2] = "Blue",
+}
-  }
 
-local _SCORINGCategory =
+local _SCORINGCategory = {
-  {
+  [Unit.Category.AIRPLANE] = "Plane",
-    [Unit.Category.AIRPLANE] = "Plane",
+  [Unit.Category.HELICOPTER] = "Helicopter",
-    [Unit.Category.HELICOPTER] = "Helicopter",
+  [Unit.Category.GROUND_UNIT] = "Vehicle",
-    [Unit.Category.GROUND_UNIT] = "Vehicle",
+  [Unit.Category.SHIP] = "Ship",
-    [Unit.Category.SHIP] = "Ship",
+  [Unit.Category.STRUCTURE] = "Structure",
-    [Unit.Category.STRUCTURE] = "Structure",
+}
-  }
 
 --- Creates a new SCORING object to administer the scoring achieved by players.
 -- @param #SCORING self
@@ -250,8 +246,8 @@ local _SCORINGCategory =
 -- @return #SCORING self
 -- @usage
 --
--- -- Define a new scoring object for the mission Gori Valley.
+--   -- Define a new scoring object for the mission Gori Valley.
--- ScoringObject = SCORING:New( "Gori Valley" )
+--   ScoringObject = SCORING:New( "Gori Valley" )
 --
 function SCORING:New( GameName )
 
@@ -264,7 +260,6 @@ function SCORING:New( GameName )
     error( "A game name must be given to register the scoring results" )
   end
 
-  
   -- Additional Object scores
   self.ScoringObjects = {}
 
@@ -284,9 +279,11 @@ function SCORING:New( GameName )
 
   -- Default fratricide penalty level (maximum penalty that can be assigned to a player before he gets kicked).
   self:SetFratricide( self.ScaleDestroyPenalty * 3 )
+  self.penaltyonfratricide = true
   
   -- Default penalty when a player changes coalition.
   self:SetCoalitionChangePenalty( self.ScaleDestroyPenalty )
+  self.penaltyoncoalitionchange = true
   
   self:SetDisplayMessagePrefix()
 
@@ -295,21 +292,18 @@ function SCORING:New( GameName )
   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, 
+  self.ScoringPlayerScan = BASE:ScheduleOnce( 1, function()
-    function()
+    for PlayerName, PlayerUnit in pairs( _DATABASE:GetPlayerUnits() ) do
-      for PlayerName, PlayerUnit in pairs( _DATABASE:GetPlayerUnits() ) do 
+      self:_AddPlayerFromUnit( PlayerUnit )
-        self:_AddPlayerFromUnit( PlayerUnit )
+      self:SetScoringMenu( PlayerUnit:GetGroup() )
-        self:SetScoringMenu( PlayerUnit:GetGroup() )
-      end
     end
-  )
+  end )
-  
 
   -- Create the CSV file.
   self:OpenCSV( GameName )
@@ -327,7 +321,6 @@ function SCORING:SetDisplayMessagePrefix( DisplayMessagePrefix )
   return self
 end
 
-
 --- Set the scale for scoring valid destroys (enemy destroys).
 -- A default calculated score is a value between 1 and 10.
 -- The scale magnifies the scores given to the players.
@@ -409,7 +402,6 @@ function SCORING:RemoveStaticScore( ScoreStatic )
   return self
 end
 
-
 --- Specify a special additional score for a @{Wrapper.Group}.
 -- @param #SCORING self
 -- @param Wrapper.Group#GROUP ScoreGroup The @{Wrapper.Group} for which each @{Wrapper.Unit} a Score is given.
@@ -462,7 +454,6 @@ function SCORING:RemoveZoneScore( ScoreZone )
   return self
 end
 
-
 --- Configure to send messages after a target has been hit.
 -- @param #SCORING self
 -- @param #boolean OnOff If true is given, the messages are sent.
@@ -569,10 +560,9 @@ function SCORING:IfMessagesToCoalition()
   return self.MessagesAudience == 2
 end
 
-
 --- When a player commits too much damage to friendlies, his penalty score will reach a certain level.
 -- Use this method to define the level when a player gets kicked.
--- By default, the fratricide level is the default penalty mutiplier * 2 for the penalty score.
+-- By default, the fratricide level is the default penalty multiplier * 2 for the penalty score.
 -- @param #SCORING self
 -- @param #number Fratricide The amount of maximum penalty that may be inflicted by a friendly player before he gets kicked. 
 -- @return #SCORING
@@ -582,6 +572,23 @@ function SCORING:SetFratricide( Fratricide )
   return self
 end
 
+--- Decide if fratricide is leading to penalties (true) or not (false)
+-- @param #SCORING self
+-- @param #boolean OnOff Switch for Fratricide
+-- @return #SCORING
+function SCORING:SwitchFratricide( OnOff )
+  self.penaltyonfratricide = OnOff
+  return self
+end
+
+--- Decide if a change of coalition is leading to penalties (true) or not (false)
+-- @param #SCORING self
+-- @param #boolean OnOff Switch for Coalition Changes.
+-- @return #SCORING
+function SCORING:SwitchTreason( OnOff )
+  self.penaltyoncoalitionchange = OnOff
+  return self
+end
 
 --- 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.
@@ -595,20 +602,18 @@ function SCORING:SetCoalitionChangePenalty( CoalitionChangePenalty )
   return self
 end
 
-
 --- Sets the scoring menu.
 -- @param #SCORING self
 -- @return #SCORING
 function SCORING:SetScoringMenu( ScoringGroup )
-    local Menu = MENU_GROUP:New( ScoringGroup, 'Scoring and Statistics' )
+  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 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 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 )
+  local ReportToAllSummary = MENU_GROUP_COMMAND:New( ScoringGroup, 'Summary report all players', Menu, SCORING.ReportScoreAllSummary, self, ScoringGroup )
-    self:SetState( ScoringGroup, "ScoringMenu", Menu )
+  self:SetState( ScoringGroup, "ScoringMenu", Menu )
   return self
 end
 
-
 --- Add a new player entering a Unit.
 -- @param #SCORING self
 -- @param Wrapper.Unit#UNIT UnitData
@@ -647,14 +652,15 @@ function SCORING:_AddPlayerFromUnit( UnitData )
     if not self.Players[PlayerName].UnitCoalition then
       self.Players[PlayerName].UnitCoalition = UnitCoalition
     else
-      if self.Players[PlayerName].UnitCoalition ~= UnitCoalition then
+      -- TODO: switch for coalition changes, make penalty alterable
-        self.Players[PlayerName].Penalty = self.Players[PlayerName].Penalty + 50
+      if self.Players[PlayerName].UnitCoalition ~= UnitCoalition and self.penaltyoncoalitionchange then
+        self.Players[PlayerName].Penalty = self.Players[PlayerName].Penalty + self.CoalitionChangePenalty or 50
         self.Players[PlayerName].PenaltyCoalition = self.Players[PlayerName].PenaltyCoalition + 1
         MESSAGE:NewType( self.DisplayMessagePrefix .. "Player '" .. PlayerName .. "' changed coalition from " .. _SCORINGCoalition[self.Players[PlayerName].UnitCoalition] .. " to " .. _SCORINGCoalition[UnitCoalition] ..
-          "(changed " .. self.Players[PlayerName].PenaltyCoalition .. " times the coalition). 50 Penalty points added.",
+          "(changed " .. self.Players[PlayerName].PenaltyCoalition .. " times the coalition). ".. self.CoalitionChangePenalty .."Penalty points added.",
           MESSAGE.Type.Information
         ):ToAll()
-        self:ScoreCSV( PlayerName, "", "COALITION_PENALTY",  1, -50, self.Players[PlayerName].UnitName, _SCORINGCoalition[self.Players[PlayerName].UnitCoalition], _SCORINGCategory[self.Players[PlayerName].UnitCategory], self.Players[PlayerName].UnitType,
+        self:ScoreCSV( PlayerName, "", "COALITION_PENALTY",  1, -1*self.CoalitionChangePenalty, self.Players[PlayerName].UnitName, _SCORINGCoalition[self.Players[PlayerName].UnitCoalition], _SCORINGCategory[self.Players[PlayerName].UnitCategory], self.Players[PlayerName].UnitType,
           UnitName, _SCORINGCoalition[UnitCoalition], _SCORINGCategory[UnitCategory], UnitData:GetTypeName() )
       end
     end
@@ -667,29 +673,25 @@ function SCORING:_AddPlayerFromUnit( UnitData )
     self.Players[PlayerName].ThreatLevel = UnitThreatLevel
     self.Players[PlayerName].ThreatType = UnitThreatType
     
-    -- TODO: DCS bug concerning Units with skill level client don't get destroyed in multi player. This logic is deactivated until this bug gets fixed.
+    -- TODO: make fratricide switchable
-    --[[
+    if self.Players[PlayerName].Penalty > self.Fratricide * 0.50 and self.penaltyonfratricide then
-    if self.Players[PlayerName].Penalty > self.Fratricide * 0.50 then
       if self.Players[PlayerName].PenaltyWarning < 1 then
         MESSAGE:NewType( self.DisplayMessagePrefix .. "Player '" .. PlayerName .. "': WARNING! If you continue to commit FRATRICIDE and have a PENALTY score higher than " .. self.Fratricide .. ", you will be COURT MARTIALED and DISMISSED from this mission! \nYour total penalty is: " .. self.Players[PlayerName].Penalty,
-          MESSAGE.Type.Information
+                         MESSAGE.Type.Information )
-        ):ToAll()
+               :ToAll()
         self.Players[PlayerName].PenaltyWarning = self.Players[PlayerName].PenaltyWarning + 1
       end
     end
 
-    if self.Players[PlayerName].Penalty > self.Fratricide then
+    if self.Players[PlayerName].Penalty > self.Fratricide and self.penaltyonfratricide then
       MESSAGE:NewType( self.DisplayMessagePrefix .. "Player '" .. PlayerName .. "' committed FRATRICIDE, he will be COURT MARTIALED and is DISMISSED from this mission!",
-        MESSAGE.Type.Information
+                       MESSAGE.Type.Information )
-      ):ToAll()
+             :ToAll()
       UnitData:GetGroup():Destroy()
     end
-    --]]
-
   end
 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.
@@ -712,14 +714,14 @@ function SCORING:AddGoalScorePlayer( PlayerName, GoalTag, Text, Score )
     PlayerData.Goals[GoalTag].Score = PlayerData.Goals[GoalTag].Score + Score
     PlayerData.Score = PlayerData.Score + Score
 
-    MESSAGE:NewType( self.DisplayMessagePrefix .. Text, MESSAGE.Type.Information ):ToAll()
+    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.
@@ -744,13 +746,14 @@ function SCORING:AddGoalScore( PlayerUnit, GoalTag, Text, Score )
     PlayerData.Goals[GoalTag].Score = PlayerData.Goals[GoalTag].Score + Score
     PlayerData.Score = PlayerData.Score + Score
 
-    MESSAGE:NewType( self.DisplayMessagePrefix .. Text, MESSAGE.Type.Information ):ToAll()
+    MESSAGE:NewType( self.DisplayMessagePrefix .. Text,
+                     MESSAGE.Type.Information )
+           :ToAll()
 
     self:ScoreCSV( PlayerName, "", "GOAL_" .. string.upper( GoalTag ), 1, Score, PlayerUnit:GetName() )
   end
 end
 
-
 --- Registers Scores the players completing a Mission Task.
 -- @param #SCORING self
 -- @param Tasking.Mission#MISSION Mission
@@ -780,7 +783,9 @@ 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 .. Mission:GetText() .. " : " .. Text .. " Score: " .. Score,
+                     MESSAGE.Type.Information )
+           :ToAll()
 
     self:ScoreCSV( PlayerName, "", "TASK_" .. MissionName:gsub( ' ', '_' ), 1, Score, PlayerUnit:GetName() )
   end
@@ -841,26 +846,24 @@ function SCORING:_AddMissionScore( Mission, Text, Score )
       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:GetText() .. ". " .. Score .. " mission score!",
-        Score .. " mission score!",
+                       MESSAGE.Type.Information )
-        MESSAGE.Type.Information ):ToAll()
+             :ToAll()
 
       self:ScoreCSV( PlayerName, "", "MISSION_" .. MissionName:gsub( ' ', '_' ), 1, Score )
     end
   end
 end
 
-
-
 --- Handles the OnPlayerEnterUnit event for the scoring.
 -- @param #SCORING self
 -- @param Core.Event#EVENTDATA Event
---function SCORING:OnEventPlayerEnterUnit( Event )
+-- function SCORING:OnEventPlayerEnterUnit( Event )
 --  if Event.IniUnit then
 --    self:_AddPlayerFromUnit( Event.IniUnit )
 --    self:SetScoringMenu( Event.IniGroup )
 --  end
---end
+-- end
 
 --- Handles the OnBirth event for the scoring.
 -- @param #SCORING self
@@ -886,12 +889,11 @@ function SCORING:OnEventPlayerLeaveUnit( Event )
     local Menu = self:GetState( Event.IniUnit:GetGroup(), "ScoringMenu" ) -- Core.Menu#MENU_GROUP
     if Menu then
       -- TODO: Check if this fixes #281.
-      --Menu:Remove()
+      -- Menu:Remove()
     end
   end
 end
 
-
 --- Handles the OnHit event for the scoring.
 -- @param #SCORING self
 -- @param Core.Event#EVENTDATA Event
@@ -936,9 +938,9 @@ function SCORING:_EventOnHit( Event )
     InitPlayerName = Event.IniPlayerName
 
     InitCoalition = Event.IniCoalition
-    --TODO: Workaround Client DCS Bug
+    -- TODO: Workaround Client DCS Bug
-    --InitCategory = InitUnit:getCategory()
+    -- InitCategory = InitUnit:getCategory()
-    --InitCategory = InitUnit:getDesc().category
+    -- InitCategory = InitUnit:getDesc().category
     InitCategory = Event.IniCategory
     InitType = Event.IniTypeName
 
@@ -946,10 +948,9 @@ function SCORING:_EventOnHit( Event )
     InitUnitCategory = _SCORINGCategory[InitCategory]
     InitUnitType = InitType
 
-    self:T( { InitUnitName, InitGroupName, InitPlayerName, InitCoalition, InitCategory, InitType , InitUnitCoalition, InitUnitCategory, InitUnitType } )
+    self:T( { InitUnitName, InitGroupName, InitPlayerName, InitCoalition, InitCategory, InitType, InitUnitCoalition, InitUnitCategory, InitUnitType } )
   end
 
-
   if Event.TgtDCSUnit then
 
     TargetUnit = Event.TgtDCSUnit
@@ -960,9 +961,9 @@ function SCORING:_EventOnHit( Event )
     TargetPlayerName = Event.TgtPlayerName
 
     TargetCoalition = Event.TgtCoalition
-    --TODO: Workaround Client DCS Bug
+    -- TODO: Workaround Client DCS Bug
-    --TargetCategory = TargetUnit:getCategory()
+    -- TargetCategory = TargetUnit:getCategory()
-    --TargetCategory = TargetUnit:getDesc().category
+    -- TargetCategory = TargetUnit:getDesc().category
     TargetCategory = Event.TgtCategory
     TargetType = Event.TgtTypeName
 
@@ -1023,23 +1024,17 @@ function SCORING:_EventOnHit( Event )
               PlayerHit.PenaltyHit = PlayerHit.PenaltyHit + 1
 
               if TargetPlayerName ~= nil then -- It is a player hitting another player ...
-                MESSAGE
+                MESSAGE:NewType( self.DisplayMessagePrefix .. "Player '" .. InitPlayerName .. "' hit friendly player '" .. TargetPlayerName .. "' " .. TargetUnitCategory .. " ( " .. TargetType .. " ) " .. PlayerHit.PenaltyHit .. " times. " ..
-                  :NewType( self.DisplayMessagePrefix .. "Player '" .. InitPlayerName .. "' hit friendly player '" .. TargetPlayerName .. "' " .. 
+                                 "Penalty: -" .. PlayerHit.Penalty .. ".  Score Total:" .. Player.Score - Player.Penalty,
-                        TargetUnitCategory .. " ( " .. TargetType .. " ) " .. PlayerHit.PenaltyHit .. " times. " .. 
+                                 MESSAGE.Type.Update )
-                        "Penalty: -" .. PlayerHit.Penalty .. ".  Score Total:" .. Player.Score - Player.Penalty,
+                       :ToAllIf( self:IfMessagesHit() and self:IfMessagesToAll() )
-                        MESSAGE.Type.Update
+                       :ToCoalitionIf( InitCoalition, self:IfMessagesHit() and self:IfMessagesToCoalition() )
-                      )
-                  :ToAllIf( self:IfMessagesHit() and self:IfMessagesToAll() )
-                  :ToCoalitionIf( InitCoalition, self:IfMessagesHit() and self:IfMessagesToCoalition() )
               else
-                MESSAGE
+                MESSAGE:NewType( self.DisplayMessagePrefix .. "Player '" .. InitPlayerName .. "' hit friendly target " .. TargetUnitCategory .. " ( " .. TargetType .. " ) " .. PlayerHit.PenaltyHit .. " times. " ..
-                  :NewType( self.DisplayMessagePrefix .. "Player '" .. InitPlayerName .. "' hit friendly target " .. 
+                                 "Penalty: -" .. PlayerHit.Penalty .. ".  Score Total:" .. Player.Score - Player.Penalty,
-                        TargetUnitCategory .. " ( " .. TargetType .. " ) " .. PlayerHit.PenaltyHit .. " times. " .. 
+                                 MESSAGE.Type.Update )
-                        "Penalty: -" .. PlayerHit.Penalty .. ".  Score Total:" .. Player.Score - Player.Penalty,
+                      :ToAllIf( self:IfMessagesHit() and self:IfMessagesToAll() )
-                        MESSAGE.Type.Update
+                      :ToCoalitionIf( InitCoalition, self:IfMessagesHit() and self:IfMessagesToCoalition() )
-                      )
-                  :ToAllIf( self:IfMessagesHit() and self:IfMessagesToAll() )
-                  :ToCoalitionIf( InitCoalition, self:IfMessagesHit() and self:IfMessagesToCoalition() )
               end
               self:ScoreCSV( InitPlayerName, TargetPlayerName, "HIT_PENALTY", 1, -10, InitUnitName, InitUnitCoalition, InitUnitCategory, InitUnitType, TargetUnitName, TargetUnitCoalition, TargetUnitCategory, TargetUnitType )
             else
@@ -1047,33 +1042,26 @@ function SCORING:_EventOnHit( Event )
               PlayerHit.Score = PlayerHit.Score + 1
               PlayerHit.ScoreHit = PlayerHit.ScoreHit + 1
               if TargetPlayerName ~= nil then -- It is a player hitting another player ...
-                MESSAGE
+                MESSAGE:NewType( self.DisplayMessagePrefix .. "Player '" .. InitPlayerName .. "' hit enemy player '" .. TargetPlayerName .. "' " .. TargetUnitCategory .. " ( " .. TargetType .. " ) " .. PlayerHit.ScoreHit .. " times. " ..
-                  :NewType( self.DisplayMessagePrefix .. "Player '" .. InitPlayerName .. "' hit enemy player '" .. TargetPlayerName .. "' "  .. 
+                                 "Score: " .. PlayerHit.Score .. ".  Score Total:" .. Player.Score - Player.Penalty,
-                        TargetUnitCategory .. " ( " .. TargetType .. " ) " .. PlayerHit.ScoreHit .. " times. " .. 
+                                 MESSAGE.Type.Update )
-                        "Score: " .. PlayerHit.Score .. ".  Score Total:" .. Player.Score - Player.Penalty,
+                       :ToAllIf( self:IfMessagesHit() and self:IfMessagesToAll() )
-                        MESSAGE.Type.Update
+                       :ToCoalitionIf( InitCoalition, self:IfMessagesHit() and self:IfMessagesToCoalition() )
-                      )
-                  :ToAllIf( self:IfMessagesHit() and self:IfMessagesToAll() )
-                  :ToCoalitionIf( InitCoalition, self:IfMessagesHit() and self:IfMessagesToCoalition() )
               else
-                MESSAGE
+                MESSAGE:NewType( self.DisplayMessagePrefix .. "Player '" .. InitPlayerName .. "' hit enemy target " .. TargetUnitCategory .. " ( " .. TargetType .. " ) " .. PlayerHit.ScoreHit .. " times. " ..
-                  :NewType( self.DisplayMessagePrefix .. "Player '" .. InitPlayerName .. "' hit enemy target " .. 
+                                 "Score: " .. PlayerHit.Score .. ".  Score Total:" .. Player.Score - Player.Penalty,
-                        TargetUnitCategory .. " ( " .. TargetType .. " ) " .. PlayerHit.ScoreHit .. " times. " .. 
+                                 MESSAGE.Type.Update )
-                        "Score: " .. PlayerHit.Score .. ".  Score Total:" .. Player.Score - Player.Penalty,
+                       :ToAllIf( self:IfMessagesHit() and self:IfMessagesToAll() )
-                        MESSAGE.Type.Update
+                       :ToCoalitionIf( InitCoalition, self:IfMessagesHit() and self:IfMessagesToCoalition() )
-                      )
-                  :ToAllIf( self:IfMessagesHit() and self:IfMessagesToAll() )
-                  :ToCoalitionIf( InitCoalition, self:IfMessagesHit() and self:IfMessagesToCoalition() )
               end
               self:ScoreCSV( InitPlayerName, TargetPlayerName, "HIT_SCORE", 1, 1, InitUnitName, InitUnitCoalition, InitUnitCategory, InitUnitType, TargetUnitName, TargetUnitCoalition, TargetUnitCategory, TargetUnitType )
             end
           else -- A scenery object was hit.
-            MESSAGE
+            MESSAGE:NewType( self.DisplayMessagePrefix .. "Player '" .. InitPlayerName .. "' hit scenery object.",
-              :NewType( self.DisplayMessagePrefix .. "Player '" .. InitPlayerName .. "' hit scenery object.",
+                             MESSAGE.Type.Update )
-                    MESSAGE.Type.Update
+                   :ToAllIf( self:IfMessagesHit() and self:IfMessagesToAll() )
-                  )
+                   :ToCoalitionIf( InitCoalition, self:IfMessagesHit() and self:IfMessagesToCoalition() )
-              :ToAllIf( self:IfMessagesHit() and self:IfMessagesToAll() )
+
-              :ToCoalitionIf( InitCoalition, self:IfMessagesHit() and self:IfMessagesToCoalition() )
             self:ScoreCSV( InitPlayerName, "", "HIT_SCORE", 1, 0, InitUnitName, InitUnitCoalition, InitUnitCategory, InitUnitType, TargetUnitName, "", "Scenery", TargetUnitType )
           end
         end
@@ -1125,9 +1113,9 @@ function SCORING:_EventOnHit( Event )
           if InitCoalition then -- A coalition object was hit, probably a static.
             if InitCoalition == TargetCoalition then
               -- TODO: Penalty according scale
-              Player.Penalty = Player.Penalty + 10
+              Player.Penalty = Player.Penalty + 10 --* self.ScaleDestroyPenalty
-              PlayerHit.Penalty = PlayerHit.Penalty + 10
+              PlayerHit.Penalty = PlayerHit.Penalty + 10 --* self.ScaleDestroyPenalty
-              PlayerHit.PenaltyHit = PlayerHit.PenaltyHit + 1
+              PlayerHit.PenaltyHit = PlayerHit.PenaltyHit + 1 * self.ScaleDestroyPenalty
       
               MESSAGE
                 :NewType( self.DisplayMessagePrefix .. "Player '" .. Event.WeaponPlayerName .. "' hit friendly target " .. 
@@ -1142,23 +1130,20 @@ function SCORING:_EventOnHit( Event )
               Player.Score = Player.Score + 1
               PlayerHit.Score = PlayerHit.Score + 1
               PlayerHit.ScoreHit = PlayerHit.ScoreHit + 1
-              MESSAGE
+              MESSAGE:NewType( self.DisplayMessagePrefix .. "Player '" .. Event.WeaponPlayerName .. "' hit enemy target " .. TargetUnitCategory .. " ( " .. TargetType .. " ) " ..
-                :NewType( self.DisplayMessagePrefix .. "Player '" .. Event.WeaponPlayerName .. "' hit enemy target " .. 
+                               "Score: +" .. PlayerHit.Score .. " = " .. Player.Score - Player.Penalty,
-                      TargetUnitCategory .. " ( " .. TargetType .. " ) " .. 
+                               MESSAGE.Type.Update )
-                      "Score: +" .. PlayerHit.Score .. " = " .. Player.Score - Player.Penalty,
+                     :ToAllIf( self:IfMessagesHit() and self:IfMessagesToAll() )
-                      MESSAGE.Type.Update
+                     :ToCoalitionIf( Event.WeaponCoalition, self:IfMessagesHit() and self:IfMessagesToCoalition() )
-                    )
+
-                :ToAllIf( self:IfMessagesHit() and self:IfMessagesToAll() )
-                :ToCoalitionIf( Event.WeaponCoalition, self:IfMessagesHit() and self:IfMessagesToCoalition() )
               self:ScoreCSV( Event.WeaponPlayerName, TargetPlayerName, "HIT_SCORE", 1, 1, Event.WeaponName, Event.WeaponCoalition, Event.WeaponCategory, Event.WeaponTypeName, TargetUnitName, TargetUnitCoalition, TargetUnitCategory, TargetUnitType )
             end
           else -- A scenery object was hit.
-            MESSAGE
+            MESSAGE:NewType( self.DisplayMessagePrefix .. "Player '" .. Event.WeaponPlayerName .. "' hit scenery object.",
-              :NewType( self.DisplayMessagePrefix .. "Player '" .. Event.WeaponPlayerName .. "' hit scenery object.",
+                             MESSAGE.Type.Update )
-                    MESSAGE.Type.Update
+                   :ToAllIf( self:IfMessagesHit() and self:IfMessagesToAll() )
-                  )
+                   :ToCoalitionIf( InitCoalition, self:IfMessagesHit() and self:IfMessagesToCoalition() )
-              :ToAllIf( self:IfMessagesHit() and self:IfMessagesToAll() )
+
-              :ToCoalitionIf( InitCoalition, self:IfMessagesHit() and self:IfMessagesToCoalition() )
             self:ScoreCSV( Event.WeaponPlayerName, "", "HIT_SCORE", 1, 0, Event.WeaponName, Event.WeaponCoalition, Event.WeaponCategory, Event.WeaponTypeName, TargetUnitName, "", "Scenery", TargetUnitType )
           end
         end
@@ -1194,8 +1179,8 @@ function SCORING:_EventOnDeadOrCrash( Event )
     TargetPlayerName = Event.IniPlayerName
 
     TargetCoalition = Event.IniCoalition
-    --TargetCategory = TargetUnit:getCategory()
+    -- TargetCategory = TargetUnit:getCategory()
-    --TargetCategory = TargetUnit:getDesc().category  -- Workaround
+    -- TargetCategory = TargetUnit:getDesc().category  -- Workaround
     TargetCategory = Event.IniCategory
     TargetType = Event.IniTypeName
 
@@ -1236,7 +1221,7 @@ function SCORING:_EventOnDeadOrCrash( Event )
         local TargetDestroy = Player.Destroy[TargetCategory][TargetType]
         TargetDestroy.Score = TargetDestroy.Score or 0
         TargetDestroy.ScoreDestroy = TargetDestroy.ScoreDestroy or 0
-        TargetDestroy.Penalty =  TargetDestroy.Penalty or 0
+        TargetDestroy.Penalty = TargetDestroy.Penalty or 0
         TargetDestroy.PenaltyDestroy = TargetDestroy.PenaltyDestroy or 0
 
         if TargetCoalition then
@@ -1244,81 +1229,69 @@ function SCORING:_EventOnDeadOrCrash( Event )
             local ThreatLevelTarget = TargetThreatLevel
             local ThreatTypeTarget = TargetThreatType
             local ThreatLevelPlayer = Player.ThreatLevel / 10 + 1
-            local ThreatPenalty = math.ceil( ( ThreatLevelTarget / ThreatLevelPlayer ) * self.ScaleDestroyPenalty / 10 )
+            local ThreatPenalty = math.ceil( (ThreatLevelTarget / ThreatLevelPlayer) * self.ScaleDestroyPenalty / 10 )
-            self:F( { ThreatLevel = ThreatPenalty, ThreatLevelTarget = ThreatLevelTarget, ThreatTypeTarget = ThreatTypeTarget, ThreatLevelPlayer = ThreatLevelPlayer  } )
+            self:F( { ThreatLevel = ThreatPenalty, ThreatLevelTarget = ThreatLevelTarget, ThreatTypeTarget = ThreatTypeTarget, ThreatLevelPlayer = ThreatLevelPlayer } )
 
             Player.Penalty = Player.Penalty + ThreatPenalty
             TargetDestroy.Penalty = TargetDestroy.Penalty + ThreatPenalty
             TargetDestroy.PenaltyDestroy = TargetDestroy.PenaltyDestroy + 1
 
             if Player.HitPlayers[TargetPlayerName] then -- A player destroyed another player
-              MESSAGE
+              MESSAGE:NewType( self.DisplayMessagePrefix .. "Player '" .. PlayerName .. "' destroyed friendly player '" .. TargetPlayerName .. "' " .. TargetUnitCategory .. " ( " .. ThreatTypeTarget .. " ) " ..
-                :NewType( self.DisplayMessagePrefix .. "Player '" .. PlayerName .. "' destroyed friendly player '" .. TargetPlayerName .. "' " .. 
+                               "Penalty: -" .. TargetDestroy.Penalty .. " = " .. Player.Score - Player.Penalty,
-                      TargetUnitCategory .. " ( " .. ThreatTypeTarget .. " ) " .. 
+                               MESSAGE.Type.Information )
-                      "Penalty: -" .. TargetDestroy.Penalty .. " = " .. Player.Score - Player.Penalty,
+                     :ToAllIf( self:IfMessagesDestroy() and self:IfMessagesToAll() )
-                      MESSAGE.Type.Information 
+                     :ToCoalitionIf( InitCoalition, self:IfMessagesDestroy() and self:IfMessagesToCoalition() )
-                    )
-                :ToAllIf( self:IfMessagesDestroy() and self:IfMessagesToAll() )
-                :ToCoalitionIf( InitCoalition, self:IfMessagesDestroy() and self:IfMessagesToCoalition() )
             else
-              MESSAGE
+              MESSAGE:NewType( self.DisplayMessagePrefix .. "Player '" .. PlayerName .. "' destroyed friendly target " .. TargetUnitCategory .. " ( " .. ThreatTypeTarget .. " ) " ..
-                :NewType( self.DisplayMessagePrefix .. "Player '" .. PlayerName .. "' destroyed friendly target " .. 
+                               "Penalty: -" .. TargetDestroy.Penalty .. " = " .. Player.Score - Player.Penalty,
-                      TargetUnitCategory .. " ( " .. ThreatTypeTarget .. " ) " .. 
+                               MESSAGE.Type.Information )
-                      "Penalty: -" .. TargetDestroy.Penalty .. " = " .. Player.Score - Player.Penalty,
+                     :ToAllIf( self:IfMessagesDestroy() and self:IfMessagesToAll() )
-                      MESSAGE.Type.Information 
+                     :ToCoalitionIf( InitCoalition, self:IfMessagesDestroy() and self:IfMessagesToCoalition() )
-                    )
-                :ToAllIf( self:IfMessagesDestroy() and self:IfMessagesToAll() )
-                :ToCoalitionIf( InitCoalition, self:IfMessagesDestroy() and self:IfMessagesToCoalition() )
             end
 
-            Destroyed = true
             self:ScoreCSV( PlayerName, TargetPlayerName, "DESTROY_PENALTY", 1, ThreatPenalty, InitUnitName, InitUnitCoalition, InitUnitCategory, InitUnitType, TargetUnitName, TargetUnitCoalition, TargetUnitCategory, TargetUnitType )
+            Destroyed = true
           else
 
             local ThreatLevelTarget = TargetThreatLevel
             local ThreatTypeTarget = TargetThreatType
             local ThreatLevelPlayer = Player.ThreatLevel / 10 + 1
-            local ThreatScore = math.ceil( ( ThreatLevelTarget / ThreatLevelPlayer )  * self.ScaleDestroyScore / 10 )
+            local ThreatScore = math.ceil( (ThreatLevelTarget / ThreatLevelPlayer) * self.ScaleDestroyScore / 10 )
 
-            self:F( { ThreatLevel = ThreatScore, ThreatLevelTarget = ThreatLevelTarget, ThreatTypeTarget = ThreatTypeTarget, ThreatLevelPlayer = ThreatLevelPlayer  } )
+            self:F( { ThreatLevel = ThreatScore, ThreatLevelTarget = ThreatLevelTarget, ThreatTypeTarget = ThreatTypeTarget, ThreatLevelPlayer = ThreatLevelPlayer } )
 
             Player.Score = Player.Score + ThreatScore
             TargetDestroy.Score = TargetDestroy.Score + ThreatScore
             TargetDestroy.ScoreDestroy = TargetDestroy.ScoreDestroy + 1
             if Player.HitPlayers[TargetPlayerName] then -- A player destroyed another player
-              MESSAGE
+              MESSAGE:NewType( self.DisplayMessagePrefix .. "Player '" .. PlayerName .. "' destroyed enemy player '" .. TargetPlayerName .. "' " .. TargetUnitCategory .. " ( " .. ThreatTypeTarget .. " ) " ..
-                :NewType( self.DisplayMessagePrefix .. "Player '" .. PlayerName .. "' destroyed enemy player '" .. TargetPlayerName .. "' " .. 
+                               "Score: +" .. TargetDestroy.Score .. " = " .. Player.Score - Player.Penalty,
-                      TargetUnitCategory .. " ( " .. ThreatTypeTarget .. " ) " .. 
+                               MESSAGE.Type.Information )
-                      "Score: +" .. TargetDestroy.Score .. " = " .. Player.Score - Player.Penalty,
+                     :ToAllIf( self:IfMessagesDestroy() and self:IfMessagesToAll() )
-                      MESSAGE.Type.Information 
+                     :ToCoalitionIf( InitCoalition, self:IfMessagesDestroy() and self:IfMessagesToCoalition() )
-                    )
-                :ToAllIf( self:IfMessagesDestroy() and self:IfMessagesToAll() )
-                :ToCoalitionIf( InitCoalition, self:IfMessagesDestroy() and self:IfMessagesToCoalition() )
             else
-              MESSAGE
+              MESSAGE:NewType( self.DisplayMessagePrefix .. "Player '" .. PlayerName .. "' destroyed enemy " .. TargetUnitCategory .. " ( " .. ThreatTypeTarget .. " ) " ..
-                :NewType( self.DisplayMessagePrefix .. "Player '" .. PlayerName .. "' destroyed enemy " .. 
+                               "Score: +" .. TargetDestroy.Score .. " = " .. Player.Score - Player.Penalty,
-                      TargetUnitCategory .. " ( " .. ThreatTypeTarget .. " ) " .. 
+                               MESSAGE.Type.Information )
-                      "Score: +" .. TargetDestroy.Score .. " = " .. Player.Score - Player.Penalty,
+                     :ToAllIf( self:IfMessagesDestroy() and self:IfMessagesToAll() )
-                      MESSAGE.Type.Information 
+                     :ToCoalitionIf( InitCoalition, self:IfMessagesDestroy() and self:IfMessagesToCoalition() )
-                    )
-                :ToAllIf( self:IfMessagesDestroy() and self:IfMessagesToAll() )
-                :ToCoalitionIf( InitCoalition, self:IfMessagesDestroy() and self:IfMessagesToCoalition() )
             end
-            Destroyed = true
+
             self:ScoreCSV( PlayerName, TargetPlayerName, "DESTROY_SCORE", 1, ThreatScore, InitUnitName, InitUnitCoalition, InitUnitCategory, InitUnitType, TargetUnitName, TargetUnitCoalition, TargetUnitCategory, TargetUnitType )
+            Destroyed = true
 
             local UnitName = TargetUnit:GetName()
             local Score = self.ScoringObjects[UnitName]
             if Score then
               Player.Score = Player.Score + Score
               TargetDestroy.Score = TargetDestroy.Score + Score
-              MESSAGE
+              MESSAGE:NewType( self.DisplayMessagePrefix .. "Special target '" .. TargetUnitCategory .. " ( " .. ThreatTypeTarget .. " ) " .. " destroyed! " ..
-                :NewType( self.DisplayMessagePrefix .. "Special target '" .. TargetUnitCategory .. " ( " .. ThreatTypeTarget .. " ) " .. " destroyed! " .. 
+                               "Player '" .. PlayerName .. "' receives an extra " .. Score .. " points! Total: " .. Player.Score - Player.Penalty,
-                      "Player '" .. PlayerName .. "' receives an extra " .. Score .. " points! Total: " .. Player.Score - Player.Penalty,
+                               MESSAGE.Type.Information )
-                      MESSAGE.Type.Information 
+                     :ToAllIf( self:IfMessagesScore() and self:IfMessagesToAll() )
-                    )
+                     :ToCoalitionIf( InitCoalition, self:IfMessagesScore() and self:IfMessagesToCoalition() )
-                :ToAllIf( self:IfMessagesScore() and self:IfMessagesToAll() )
+
-                :ToCoalitionIf( InitCoalition, self:IfMessagesScore() and self:IfMessagesToCoalition() )
               self:ScoreCSV( PlayerName, TargetPlayerName, "DESTROY_SCORE", 1, Score, InitUnitName, InitUnitCoalition, InitUnitCategory, InitUnitType, TargetUnitName, TargetUnitCoalition, TargetUnitCategory, TargetUnitType )
               Destroyed = true
             end
@@ -1331,13 +1304,12 @@ function SCORING:_EventOnDeadOrCrash( Event )
               if ScoreZone:IsVec2InZone( TargetUnit:GetVec2() ) then
                 Player.Score = Player.Score + Score
                 TargetDestroy.Score = TargetDestroy.Score + Score
-                MESSAGE
+                MESSAGE:NewType( self.DisplayMessagePrefix .. "Target destroyed in zone '" .. ScoreZone:GetName() .. "'." ..
-                  :NewType( self.DisplayMessagePrefix .. "Target destroyed in zone '" .. ScoreZone:GetName() .. "'." .. 
+                                 "Player '" .. PlayerName .. "' receives an extra " .. Score .. " points! " .. "Total: " .. Player.Score - Player.Penalty,
-                        "Player '" .. PlayerName .. "' receives an extra " .. Score .. " points! " .. 
+                                 MESSAGE.Type.Information )
-                        "Total: " .. Player.Score - Player.Penalty,
+                       :ToAllIf( self:IfMessagesZone() and self:IfMessagesToAll() )
-                        MESSAGE.Type.Information )
+                       :ToCoalitionIf( InitCoalition, self:IfMessagesZone() and self:IfMessagesToCoalition() )
-                  :ToAllIf( self:IfMessagesZone() and self:IfMessagesToAll() )
+
-                  :ToCoalitionIf( InitCoalition, self:IfMessagesZone() and self:IfMessagesToCoalition() )
                 self:ScoreCSV( PlayerName, TargetPlayerName, "DESTROY_SCORE", 1, Score, InitUnitName, InitUnitCoalition, InitUnitCategory, InitUnitType, TargetUnitName, TargetUnitCoalition, TargetUnitCategory, TargetUnitType )
                 Destroyed = true
               end
@@ -1347,22 +1319,20 @@ 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:F( { ScoringZone = ScoreZoneData } )
             local ScoreZone = ScoreZoneData.ScoreZone -- Core.Zone#ZONE_BASE
             local Score = ScoreZoneData.Score
             if ScoreZone:IsVec2InZone( TargetUnit:GetVec2() ) then
               Player.Score = Player.Score + Score
               TargetDestroy.Score = TargetDestroy.Score + Score
-              MESSAGE
+              MESSAGE:NewType( self.DisplayMessagePrefix .. "Scenery destroyed in zone '" .. ScoreZone:GetName() .. "'." ..
-                :NewType( self.DisplayMessagePrefix .. "Scenery destroyed in zone '" .. ScoreZone:GetName() .. "'." .. 
+                               "Player '" .. PlayerName .. "' receives an extra " .. Score .. " points! " .. "Total: " .. Player.Score - Player.Penalty,
-                      "Player '" .. PlayerName .. "' receives an extra " .. Score .. " points! " .. 
+                               MESSAGE.Type.Information )
-                      "Total: " .. Player.Score - Player.Penalty, 
+                     :ToAllIf( self:IfMessagesZone() and self:IfMessagesToAll() )
-                      MESSAGE.Type.Information 
+                     :ToCoalitionIf( InitCoalition, self:IfMessagesZone() and self:IfMessagesToCoalition() )
-                    )
+
-                :ToAllIf( self:IfMessagesZone() and self:IfMessagesToAll() )
-                :ToCoalitionIf( InitCoalition, self:IfMessagesZone() and self:IfMessagesToCoalition() )
-              Destroyed = true
               self:ScoreCSV( PlayerName, "", "DESTROY_SCORE", 1, Score, InitUnitName, InitUnitCoalition, InitUnitCategory, InitUnitType, TargetUnitName, "", "Scenery", TargetUnitType )
+              Destroyed = true
             end
           end
         end
@@ -1378,7 +1348,6 @@ function SCORING:_EventOnDeadOrCrash( Event )
   end
 end
 
-
 --- Produce detailed report of player hit scores.
 -- @param #SCORING self
 -- @param #string PlayerName The name of the player.
@@ -1420,7 +1389,7 @@ function SCORING:ReportDetailedPlayerHits( PlayerName )
         PlayerScore = PlayerScore + Score
         PlayerPenalty = PlayerPenalty + Penalty
       else
-       --ScoreMessageHits = ScoreMessageHits .. string.format( "%s:%d  ", string.format(CategoryName, 1, 1), 0 )
+        -- ScoreMessageHits = ScoreMessageHits .. string.format( "%s:%d  ", string.format(CategoryName, 1, 1), 0 )
       end
     end
     if ScoreMessageHits ~= "" then
@@ -1431,7 +1400,6 @@ function SCORING:ReportDetailedPlayerHits( PlayerName )
   return ScoreMessage, PlayerScore, PlayerPenalty
 end
 
-
 --- Produce detailed report of player destroy scores.
 -- @param #SCORING self
 -- @param #string PlayerName The name of the player.
@@ -1478,7 +1446,7 @@ function SCORING:ReportDetailedPlayerDestroys( PlayerName )
         PlayerScore = PlayerScore + Score
         PlayerPenalty = PlayerPenalty + Penalty
       else
-        --ScoreMessageDestroys = ScoreMessageDestroys .. string.format( "%s:%d  ", string.format(CategoryName, 1, 1), 0 )
+        -- ScoreMessageDestroys = ScoreMessageDestroys .. string.format( "%s:%d  ", string.format(CategoryName, 1, 1), 0 )
       end
     end
     if ScoreMessageDestroys ~= "" then
@@ -1597,7 +1565,6 @@ function SCORING:ReportDetailedPlayerMissions( PlayerName )
   return ScoreMessage, PlayerScore, PlayerPenalty
 end
 
-
 --- Report Group Score Summary
 -- @param #SCORING self
 -- @param Wrapper.Group#GROUP PlayerGroup The player group.
@@ -1637,13 +1604,12 @@ function SCORING:ReportScoreGroupSummary( PlayerGroup )
       local PlayerScore = ScoreHits + ScoreDestroys + ScoreCoalitionChanges + ScoreGoals + ScoreMissions
       local PlayerPenalty = PenaltyHits + PenaltyDestroys + PenaltyCoalitionChanges + PenaltyGoals + PenaltyMissions
 
-      PlayerMessage = 
+      PlayerMessage = string.format( "Player '%s' Score = %d ( %d Score, -%d Penalties )",
-        string.format( "Player '%s' Score = %d ( %d Score, -%d Penalties )", 
+                                     PlayerName,
-                       PlayerName, 
+                                     PlayerScore - PlayerPenalty,
-                       PlayerScore - PlayerPenalty, 
+                                     PlayerScore,
-                       PlayerScore, 
+                                     PlayerPenalty
-                       PlayerPenalty
+                                    )
-                     )
       MESSAGE:NewType( PlayerMessage, MESSAGE.Type.Detailed ):ToGroup( PlayerGroup )
     end
   end
@@ -1687,7 +1653,7 @@ function SCORING:ReportScoreGroupDetailed( PlayerGroup )
       self:F( { ReportMissions, ScoreMissions, PenaltyMissions } )
 
       local PlayerScore = ScoreHits + ScoreDestroys + ScoreCoalitionChanges + ScoreGoals + ScoreMissions
-      local PlayerPenalty = PenaltyHits + PenaltyDestroys + PenaltyCoalitionChanges + ScoreGoals + PenaltyMissions
+      local PlayerPenalty = PenaltyHits + PenaltyDestroys + PenaltyCoalitionChanges + PenaltyGoals + PenaltyMissions
   
       PlayerMessage = 
         string.format( "Player '%s' Score = %d ( %d Score, -%d Penalties )%s%s%s%s%s", 
@@ -1743,7 +1709,7 @@ function SCORING:ReportScoreAllSummary( PlayerGroup )
       self:F( { ReportMissions, ScoreMissions, PenaltyMissions } )
 
       local PlayerScore = ScoreHits + ScoreDestroys + ScoreCoalitionChanges + ScoreGoals + ScoreMissions
-      local PlayerPenalty = PenaltyHits + PenaltyDestroys + PenaltyCoalitionChanges + ScoreGoals + PenaltyMissions
+      local PlayerPenalty = PenaltyHits + PenaltyDestroys + PenaltyCoalitionChanges + PenaltyGoals + PenaltyMissions
   
       PlayerMessage = 
         string.format( "Player '%s' Score = %d ( %d Score, -%d Penalties )", 
@@ -1758,17 +1724,16 @@ function SCORING:ReportScoreAllSummary( PlayerGroup )
 
 end
 
-
+function SCORING:SecondsToClock( sSeconds )
-function SCORING:SecondsToClock(sSeconds)
   local nSeconds = sSeconds
   if nSeconds == 0 then
-    --return nil;
+    -- return nil;
     return "00:00:00";
   else
-    nHours = string.format("%02.f", math.floor(nSeconds/3600));
+    nHours = string.format( "%02.f", math.floor( nSeconds / 3600 ) );
-    nMins = string.format("%02.f", math.floor(nSeconds/60 - (nHours*60)));
+    nMins = string.format( "%02.f", math.floor( nSeconds / 60 - (nHours * 60) ) );
-    nSecs = string.format("%02.f", math.floor(nSeconds - nHours*3600 - nMins *60));
+    nSecs = string.format( "%02.f", math.floor( nSeconds - nHours * 3600 - nMins * 60 ) );
-    return nHours..":"..nMins..":"..nSecs
+    return nHours .. ":" .. nMins .. ":" .. nSecs
   end
 end
 
@@ -1793,9 +1758,9 @@ function SCORING:OpenCSV( ScoringCSV )
         error( "Error: Cannot open CSV file in " .. lfs.writedir() )
       end
 
-      self.CSVFile:write( '"GameName","RunTime","Time","PlayerName","TargetPlayerName","ScoreType","PlayerUnitCoaltion","PlayerUnitCategory","PlayerUnitType","PlayerUnitName","TargetUnitCoalition","TargetUnitCategory","TargetUnitType","TargetUnitName","Times","Score"\n' )
+      self.CSVFile:write( '"GameName","RunTime","Time","PlayerName","TargetPlayerName","ScoreType","PlayerUnitCoalition","PlayerUnitCategory","PlayerUnitType","PlayerUnitName","TargetUnitCoalition","TargetUnitCategory","TargetUnitType","TargetUnitName","Times","Score"\n' )
 
-      self.RunTime = os.date("%y-%m-%d_%H-%M-%S")
+      self.RunTime = os.date( "%y-%m-%d_%H-%M-%S" )
     else
       error( "A string containing the CSV file name must be given." )
     end
@@ -1805,7 +1770,6 @@ function SCORING:OpenCSV( ScoringCSV )
   return self
 end
 
-
 --- Registers a score for a player.
 -- @param #SCORING self
 -- @param #string PlayerName The name of the player.
@@ -1823,7 +1787,7 @@ end
 -- @param #string TargetUnitType The type of the target unit.
 -- @return #SCORING self
 function SCORING:ScoreCSV( PlayerName, TargetPlayerName, ScoreType, ScoreTimes, ScoreAmount, PlayerUnitName, PlayerUnitCoalition, PlayerUnitCategory, PlayerUnitType, TargetUnitName, TargetUnitCoalition, TargetUnitCategory, TargetUnitType )
-  --write statistic information to file
+  -- write statistic information to file
   local ScoreTime = self:SecondsToClock( timer.getTime() )
   PlayerName = PlayerName:gsub( '"', '_' )
 
@@ -1835,7 +1799,7 @@ function SCORING:ScoreCSV( PlayerName, TargetPlayerName, ScoreType, ScoreTimes,
 
     if PlayerUnit then
       if not PlayerUnitCategory then
-        --PlayerUnitCategory = SCORINGCategory[PlayerUnit:getCategory()]
+        -- PlayerUnitCategory = SCORINGCategory[PlayerUnit:getCategory()]
         PlayerUnitCategory = _SCORINGCategory[PlayerUnit:getDesc().category]
       end
 
@@ -1888,7 +1852,6 @@ function SCORING:ScoreCSV( PlayerName, TargetPlayerName, ScoreType, ScoreTimes,
   end
 end
 
-
 function SCORING:CloseCSV()
   if lfs and io and os then
     self.CSVFile:close()

Moose Development/Moose/Functional/Sead.lua

@@ -6,6 +6,8 @@
 --
 --   * 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.
+--   * SEAD calculates the time it takes for a HARM to reach the target - and will attempt to minimize the shut-down time.
+--   * Detection and evasion of shots has a random component based on the skill level of the SAM groups.
 --
 -- ===
 --
@@ -17,19 +19,24 @@
 --
 -- ### Authors: **FlightControl**, **applevangelist**
 --
--- Last Update: Dec 2020
+-- Last Update: Feb 2022
 --
 -- ===
 --
 -- @module Functional.Sead
 -- @image SEAD.JPG
 
---- @type SEAD
+---
+-- @type SEAD
 -- @extends Core.Base#BASE
 
 --- Make SAM sites execute evasive and defensive behaviour when being fired upon.
 --
 -- This class is very easy to use. Just setup a SEAD object by using @{#SEAD.New}() and SAMs will evade and take defensive action when being fired upon.
+-- Once a HARM attack is detected, SEAD will shut down the radars of the attacked SAM site and take evasive action by moving the SAM
+-- vehicles around (*if* they are drivable, that is). There's a component of randomness in detection and evasion, which is based on the
+-- skill set of the SAM set (the higher the skill, the more likely). When a missile is fired from far away, the SAM will stay active for a 
+-- period of time to stay defensive, before it takes evasive actions.
 -- 
 -- # Constructor:
 --
@@ -39,52 +46,114 @@
 --
 -- @field #SEAD
 SEAD = {
-	ClassName = "SEAD", 
+  ClassName = "SEAD",
-	TargetSkill = {
+  TargetSkill = {
-		Average   = { Evade = 30, DelayOn = { 40, 60 } } ,
+    Average   = { Evade = 30, DelayOn = { 40, 60 } } ,
-		Good      = { Evade = 20, DelayOn = { 30, 50 } } ,
+    Good      = { Evade = 20, DelayOn = { 30, 50 } } ,
-		High      = { Evade = 15, DelayOn = { 20, 40 } } ,
+    High      = { Evade = 15, DelayOn = { 20, 40 } } ,
-		Excellent = { Evade = 10, DelayOn = { 10, 30 } } 
+    Excellent = { Evade = 10, DelayOn = { 10, 30 } }
-	}, 
+  },
-	SEADGroupPrefixes = {},
+  SEADGroupPrefixes = {},
-	SuppressedGroups = {},
+  SuppressedGroups = {},
-	EngagementRange = 75 --  default 75% engagement range Feature Request #1355
+  EngagementRange = 75, --  default 75% engagement range Feature Request #1355
+  Padding = 10,
+  CallBack = nil,
+  UseCallBack = false,
+  debug = false,
 }
 
+  --- Missile enumerators
+  -- @field Harms
+  SEAD.Harms = {
+  ["AGM_88"] = "AGM_88",
+  ["AGM_45"] = "AGM_45",
+  ["AGM_122"] = "AGM_122",
+  ["AGM_84"] = "AGM_84",
+  ["AGM_45"] = "AGM_45",
+  ["ALARM"] = "ALARM",
+  ["LD-10"] = "LD-10",
+  ["X_58"] = "X_58",
+  ["X_28"] = "X_28",
+  ["X_25"] = "X_25",
+  ["X_31"] = "X_31",
+  ["Kh25"] = "Kh25",
+  ["BGM_109"] = "BGM_109",
+  ["AGM_154"] = "AGM_154",
+  ["HY-2"] = "HY-2",
+  }
+
+  --- Missile enumerators - from DCS ME and Wikipedia
+  -- @field HarmData
+  SEAD.HarmData = {
+  -- km and mach
+  ["AGM_88"] = { 150, 3},
+  ["AGM_45"] = { 12, 2},
+  ["AGM_122"] = { 16.5, 2.3},
+  ["AGM_84"] = { 280, 0.8},
+  ["ALARM"] = { 45, 2},
+  ["LD-10"] = { 60, 4},
+  ["X_58"] = { 70, 4},
+  ["X_28"] = { 80, 2.5},
+  ["X_25"] = { 25, 0.76},
+  ["X_31"] = {150, 3},
+  ["Kh25"] = {25, 0.8},
+  ["BGM_109"] = {460, 0.705}, --in-game ~465kn
+  ["AGM_154"] = {130, 0.61},
+  ["HY-2"] = {90,1},
+  }
+
 --- Creates the main object which is handling defensive actions for SA sites or moving SA vehicles.
 -- When an anti radiation missile is fired (KH-58, KH-31P, KH-31A, KH-25MPU, HARM missiles), the SA will shut down their radars and will take evasive actions...
 -- Chances are big that the missile will miss.
--- @param table{string,...}|string SEADGroupPrefixes which is a table of Prefixes of the SA Groups in the DCS mission editor on which evasive actions need to be taken.
+-- @param #SEAD self
--- @return SEAD
+-- @param #table SEADGroupPrefixes Table of #string entries or single #string, which is a table of Prefixes of the SA Groups in the DCS mission editor on which evasive actions need to be taken.
+-- @param #number Padding (Optional) Extra number of seconds to add to radar switch-back-on time
+-- @return #SEAD self
 -- @usage
 -- -- CCCP SEAD Defenses
 -- -- Defends the Russian SA installations from SEAD attacks.
 -- SEAD_RU_SAM_Defenses = SEAD:New( { 'RU SA-6 Kub', 'RU SA-6 Defenses', 'RU MI-26 Troops', 'RU Attack Gori' } )
-function SEAD:New( SEADGroupPrefixes )
+function SEAD:New( SEADGroupPrefixes, Padding )
 
-	local self = BASE:Inherit( self, BASE:New() )
+  local self = BASE:Inherit( self, FSM:New() )
-	self:F( SEADGroupPrefixes )
+  self:T( SEADGroupPrefixes )
 
-	if type( SEADGroupPrefixes ) == 'table' then
+  if type( SEADGroupPrefixes ) == 'table' then
-		for SEADGroupPrefixID, SEADGroupPrefix in pairs( SEADGroupPrefixes ) do
+    for SEADGroupPrefixID, SEADGroupPrefix in pairs( SEADGroupPrefixes ) do
-			self.SEADGroupPrefixes[SEADGroupPrefix] = SEADGroupPrefix
+      self.SEADGroupPrefixes[SEADGroupPrefix] = SEADGroupPrefix
-		end
+    end
-	else
+  else
-		self.SEADGroupPrefixes[SEADGroupPrefixes] = SEADGroupPrefixes
+    self.SEADGroupPrefixes[SEADGroupPrefixes] = SEADGroupPrefixes
-	end
+  end
 
-	self:HandleEvent( EVENTS.Shot )
+  local padding = Padding or 10
-	self:I("*** SEAD - Started Version 0.2.2")
+  if padding < 10 then padding = 10 end
-	return self
+  self.Padding = padding
+  self.UseEmissionsOnOff = true
+  
+  self.debug = false
+  
+  self.CallBack = nil
+  self.UseCallBack = false
+    
+  self:HandleEvent( EVENTS.Shot, self.HandleEventShot )
+  
+  -- Start State.
+  self:SetStartState("Running")
+  self:AddTransition("*",             "ManageEvasion",                "*")
+  self:AddTransition("*",             "CalculateHitZone",             "*")
+  
+  self:I("*** SEAD - Started Version 0.4.3")
+  return self
 end
 
---- Update the active SEAD Set
+--- Update the active SEAD Set (while running)
 -- @param #SEAD self
 -- @param #table SEADGroupPrefixes The prefixes to add, note: can also be a single #string
 -- @return #SEAD self
 function SEAD:UpdateSet( SEADGroupPrefixes )
 
-  self:F( SEADGroupPrefixes )
+  self:T( SEADGroupPrefixes )
 
   if type( SEADGroupPrefixes ) == 'table' then
     for SEADGroupPrefixID, SEADGroupPrefix in pairs( SEADGroupPrefixes ) do
@@ -99,10 +168,10 @@ end
 
 --- Sets the engagement range of the SAMs. Defaults to 75% to make it more deadly. Feature Request #1355
 -- @param #SEAD self
--- @param #number range Set the engagement range in percent, e.g. 50
+-- @param #number range Set the engagement range in percent, e.g. 55 (default 75)
--- @return self
+-- @return #SEAD self
 function SEAD:SetEngagementRange(range)
-  self:F( { range } )
+  self:T( { range } )
   range = range or 75
   if range < 0 or range > 100 then
     range = 75
@@ -112,110 +181,340 @@ function SEAD:SetEngagementRange(range)
   return self
 end
 
---- Detects if an SA site was shot with an anti radiation missile. In this case, take evasive actions based on the skill level set within the ME.
+--- Set the padding in seconds, which extends the radar off time calculated by SEAD
--- @see SEAD
+-- @param #SEAD self
--- @param #SEAD
+-- @param #number Padding Extra number of seconds to add for the switch-on (default 10 seconds)
--- @param Core.Event#EVENTDATA EventData
+-- @return #SEAD self
-function SEAD:OnEventShot( EventData )
+function SEAD:SetPadding(Padding)
-	self:T( { EventData } )
+  self:T( { Padding } )
-
+  local padding = Padding or 10
-	local SEADUnit = EventData.IniDCSUnit
+  if padding < 10 then padding = 10 end
-	local SEADUnitName = EventData.IniDCSUnitName
+  self.Padding = padding
-	local SEADWeapon = EventData.Weapon -- Identify the weapon fired
+  return self
-	local SEADWeaponName = EventData.WeaponName	-- return weapon type
+end
-
+
-	self:T( "*** SEAD - Missile Launched = " .. SEADWeaponName)
+--- Set SEAD to use emissions on/off in addition to alarm state.
-	self:T({ SEADWeapon })
+-- @param #SEAD self
-	
+-- @param #boolean Switch True for on, false for off.
-	--check for SEAD missiles
+-- @return #SEAD self
-  if SEADWeaponName == "weapons.missiles.X_58" --Kh-58U anti-radiation missiles fired
+function SEAD:SwitchEmissions(Switch)
-    or 
+  self:T({Switch})
-    SEADWeaponName == "weapons.missiles.Kh25MP_PRGS1VP" --Kh-25MP anti-radiation missiles fired
+  self.UseEmissionsOnOff = Switch
-    or
+  return self
-    SEADWeaponName == "weapons.missiles.X_25MP" --Kh-25MPU anti-radiation missiles fired
+end
-    or
+
-    SEADWeaponName == "weapons.missiles.X_28" --Kh-28 anti-radiation missiles fired
+--- Add an object to call back when going evasive.
-    or
+-- @param #SEAD self
-    SEADWeaponName == "weapons.missiles.X_31P" --Kh-31P anti-radiation missiles fired
+-- @param #table Object The object to call. Needs to have object functions as follows:
-    or
+-- `:SeadSuppressionPlanned(Group, Name, SuppressionStartTime, SuppressionEndTime)` 
-    SEADWeaponName == "weapons.missiles.AGM_45A" --AGM-45A anti-radiation missiles fired
+-- `:SeadSuppressionStart(Group, Name)`, 
-    or
+-- `:SeadSuppressionEnd(Group, Name)`, 
-    SEADWeaponName == "weapons.missiles.AGM_45" --AGM-45B anti-radiation missiles fired
+-- @return #SEAD self
-    or
+function SEAD:AddCallBack(Object)
-    SEADWeaponName == "weapons.missiles.AGM_88" --AGM-88C anti-radiation missiles fired
+  self:T({Class=Object.ClassName})
-    or
+  self.CallBack = Object
-    SEADWeaponName == "weapons.missiles.AGM_122" --AGM-122 Sidearm anti-radiation missiles fired
+  self.UseCallBack = true
-    or
+  return self
-    SEADWeaponName == "weapons.missiles.LD-10" --LD-10 anti-radiation missiles fired
+end
-    or
+
-    SEADWeaponName == "weapons.missiles.ALARM" --ALARM anti-radiation missiles fired
+--- (Internal) Check if a known HARM was fired
-    or
+-- @param #SEAD self
-    SEADWeaponName == "weapons.missiles.AGM_84E" --AGM84 anti-radiation missiles fired
+-- @param #string WeaponName
-    or
+-- @return #boolean Returns true for a match
-    SEADWeaponName == "weapons.missiles.AGM_84A" --AGM84 anti-radiation missiles fired
+-- @return #string name Name of hit in table
-    or
+function SEAD:_CheckHarms(WeaponName)
-    SEADWeaponName == "weapons.missiles.AGM_84H" --AGM84 anti-radiation missiles fired
+  self:T( { WeaponName } )
-    then
+  local hit = false
-	
+  local name = ""
-		local _evade = math.random (1,100) -- random number for chance of evading action
+    for _,_name in pairs (SEAD.Harms) do
-		local _targetMim = EventData.Weapon:getTarget() -- Identify target
+      if string.find(WeaponName,_name,1,true) then
-		local _targetMimname = Unit.getName(_targetMim) -- Unit name
+        hit = true
-		local _targetMimgroup = Unit.getGroup(Weapon.getTarget(SEADWeapon)) --targeted grouo
+        name = _name
-		local _targetMimgroupName = _targetMimgroup:getName() -- group name
+        break
-		local _targetskill =  _DATABASE.Templates.Units[_targetMimname].Template.skill
+      end
-		self:T( self.SEADGroupPrefixes )
+    end
-		self:T( _targetMimgroupName )
+  return hit, name
-		-- see if we are shot at
+end
-		local SEADGroupFound = false
+
-		for SEADGroupPrefixID, SEADGroupPrefix in pairs( self.SEADGroupPrefixes ) do
+--- (Internal) Return distance in meters between two coordinates or -1 on error.
-			if string.find( _targetMimgroupName, SEADGroupPrefix, 1, true ) then
+-- @param #SEAD self
-				SEADGroupFound = true
+-- @param Core.Point#COORDINATE _point1 Coordinate one
-				self:T( '*** SEAD - Group Found' )
+-- @param Core.Point#COORDINATE _point2 Coordinate two
-				break
+-- @return #number Distance in meters
-			end
+function SEAD:_GetDistance(_point1, _point2)
-		end		
+  self:T("_GetDistance")
-		if SEADGroupFound == true then -- yes we are being attacked
+  if _point1 and _point2 then
-			if _targetskill == "Random" then -- when skill is random, choose a skill
+    local distance1 = _point1:Get2DDistance(_point2)
-				local Skills = { "Average", "Good", "High", "Excellent" }
+    local distance2 = _point1:DistanceFromPointVec2(_point2)
-				_targetskill = Skills[ math.random(1,4) ]
+    --self:T({dist1=distance1, dist2=distance2})
-			end
+    if distance1 and type(distance1) == "number" then
-			self:T( _targetskill )
+      return distance1
-			if self.TargetSkill[_targetskill] then
+    elseif distance2 and type(distance2) == "number" then
-				if (_evade > self.TargetSkill[_targetskill].Evade) then
+      return distance2
-				
+    else
-					self:T( string.format("*** SEAD - Evading, target skill  " ..string.format(_targetskill)) )
+      self:E("*****Cannot calculate distance!")
-				
+      self:E({_point1,_point2})
-					local _targetMimgroup = Unit.getGroup(Weapon.getTarget(SEADWeapon))
+      return -1
-					local _targetMimcont= _targetMimgroup:getController()
+    end
-					
+  else
-					routines.groupRandomDistSelf(_targetMimgroup,300,'Diamond',250,20) -- move randomly
+    self:E("******Cannot calculate distance!")
-					
+    self:E({_point1,_point2})
-					--tracker ID table to switch groups off and on again
+    return -1
-					local id = { 
+  end
-					groupName = _targetMimgroup,
+end
-					ctrl = _targetMimcont
+
-					}
+--- (Internal) Calculate hit zone of an AGM-88
-
+-- @param #SEAD self
-					local function SuppressionEnd(id) --switch group back on
+-- @param #table SEADWeapon DCS.Weapon object
-					 local range = self.EngagementRange -- Feature Request #1355
+-- @param Core.Point#COORDINATE pos0 Position of the plane when it fired
-					  self:T(string.format("*** SEAD - Engagement Range is %d", range))
+-- @param #number height Height when the missile was fired
-						id.ctrl:setOption(AI.Option.Ground.id.ALARM_STATE,AI.Option.Ground.val.ALARM_STATE.RED)
+-- @param Wrapper.Group#GROUP SEADGroup Attacker group
-						id.ctrl:setOption(AI.Option.Ground.id.AC_ENGAGEMENT_RANGE_RESTRICTION,range) --Feature Request #1355
+-- @param #string SEADWeaponName Weapon Name
-						self.SuppressedGroups[id.groupName] = nil  --delete group id from table when done
+-- @return #SEAD self 
-					end
+function SEAD:onafterCalculateHitZone(From,Event,To,SEADWeapon,pos0,height,SEADGroup,SEADWeaponName)
-					-- randomize switch-on time
+  self:T("**** Calculating hit zone for " .. (SEADWeaponName or "None"))
-					local delay = math.random(self.TargetSkill[_targetskill].DelayOn[1], self.TargetSkill[_targetskill].DelayOn[2])
+  if SEADWeapon and SEADWeapon:isExist() then
-					local SuppressionEndTime = timer.getTime() + delay
+    --local pos = SEADWeapon:getPoint()
-					--create entry
+    
-					if self.SuppressedGroups[id.groupName] == nil then  --no timer entry for this group yet
+    -- postion and height
-						self.SuppressedGroups[id.groupName] = {
+    local position = SEADWeapon:getPosition()
-							SuppressionEndTime = delay
+    local mheight = height
-						  }
+    -- heading
-						Controller.setOption(_targetMimcont, AI.Option.Ground.id.ALARM_STATE,AI.Option.Ground.val.ALARM_STATE.GREEN)
+    local wph = math.atan2(position.x.z, position.x.x)      
-						timer.scheduleFunction(SuppressionEnd, id, SuppressionEndTime)	--Schedule the SuppressionEnd() function
+    if wph < 0 then
-					end
+      wph=wph+2*math.pi
-				end
+    end   
-			end
+    wph=math.deg(wph)
-		end
+    
-	end
+    -- velocity
+    local wpndata = SEAD.HarmData["AGM_88"]
+    if string.find(SEADWeaponName,"154",1) then
+      wpndata = SEAD.HarmData["AGM_154"]
+    end
+    local mveloc = math.floor(wpndata[2] * 340.29)
+    local c1 = (2*mheight*9.81)/(mveloc^2)
+    local c2 = (mveloc^2) / 9.81
+    local Ropt = c2 * math.sqrt(c1+1) 
+    if height <= 5000 then
+      Ropt = Ropt * 0.72
+    elseif height <= 7500 then
+      Ropt = Ropt * 0.82  
+    elseif height <= 10000 then
+      Ropt = Ropt * 0.87
+    elseif height <= 12500 then
+      Ropt = Ropt * 0.98
+    end
+    
+    -- look at a couple of zones across the trajectory
+    for n=1,3 do
+      local dist = Ropt - ((n-1)*20000)
+      local predpos= pos0:Translate(dist,wph)
+      if predpos then
+  
+        local targetzone = ZONE_RADIUS:New("Target Zone",predpos:GetVec2(),20000)
+        
+        if self.debug then
+          predpos:MarkToAll(string.format("height=%dm | heading=%d | velocity=%ddeg | Ropt=%dm",mheight,wph,mveloc,Ropt),false)
+          targetzone:DrawZone(coalition.side.BLUE,{0,0,1},0.2,nil,nil,3,true)
+        end  
+        
+        local seadset = SET_GROUP:New():FilterPrefixes(self.SEADGroupPrefixes):FilterZones({targetzone}):FilterOnce()
+        local tgtcoord = targetzone:GetRandomPointVec2()
+        --if tgtcoord and tgtcoord.ClassName == "COORDINATE" then
+          --local tgtgrp = seadset:FindNearestGroupFromPointVec2(tgtcoord)
+          local tgtgrp = seadset:GetRandom()
+          local _targetgroup = nil
+          local _targetgroupname = "none"
+          local _targetskill = "Random"
+          if tgtgrp and tgtgrp:IsAlive() then
+            _targetgroup = tgtgrp
+            _targetgroupname = tgtgrp:GetName() -- group name
+            _targetskill = tgtgrp:GetUnit(1):GetSkill()
+            self:T("*** Found Target = ".. _targetgroupname)
+            self:ManageEvasion(_targetskill,_targetgroup,pos0,"AGM_88",SEADGroup, 20)
+          end
+        --end
+      end
+    end     
+  end
+  return self
+end
+
+--- (Internal) Handle Evasion
+-- @param #SEAD self
+-- @param #string _targetskill
+-- @param Wrapper.Group#GROUP _targetgroup
+-- @param Core.Point#COORDINATE SEADPlanePos
+-- @param #string SEADWeaponName
+-- @param Wrapper.Group#GROUP SEADGroup Attacker Group
+-- @param #number timeoffset Offset for tti calc
+-- @return #SEAD self 
+function SEAD:onafterManageEvasion(From,Event,To,_targetskill,_targetgroup,SEADPlanePos,SEADWeaponName,SEADGroup,timeoffset)
+  local timeoffset = timeoffset  or 0
+  if _targetskill == "Random" then -- when skill is random, choose a skill
+    local Skills = { "Average", "Good", "High", "Excellent" }
+    _targetskill = Skills[ math.random(1,4) ]
+  end
+  --self:T( _targetskill )
+  if self.TargetSkill[_targetskill] then
+    local _evade = math.random (1,100) -- random number for chance of evading action
+    if (_evade > self.TargetSkill[_targetskill].Evade) then
+      self:T("*** SEAD - Evading")
+      -- calculate distance of attacker
+      local _targetpos = _targetgroup:GetCoordinate()
+      local _distance = self:_GetDistance(SEADPlanePos, _targetpos)
+      -- weapon speed
+      local hit, data = self:_CheckHarms(SEADWeaponName)
+      local wpnspeed = 666 -- ;)
+      local reach = 10
+      if hit then
+        local wpndata = SEAD.HarmData[data]
+        reach = wpndata[1] * 1,1
+        local mach = wpndata[2]
+        wpnspeed = math.floor(mach * 340.29)
+      end
+      -- time to impact
+      local _tti = math.floor(_distance / wpnspeed) - timeoffset -- estimated impact time
+      if _distance > 0 then
+        _distance = math.floor(_distance / 1000) -- km
+      else
+        _distance = 0
+      end
+  
+      self:T( string.format("*** SEAD - target skill %s, distance %dkm, reach %dkm, tti %dsec", _targetskill, _distance,reach,_tti ))
+  
+      if reach >= _distance then
+        self:T("*** SEAD - Shot in Reach")
+  
+        local function SuppressionStart(args)
+          self:T(string.format("*** SEAD - %s Radar Off & Relocating",args[2]))
+          local grp = args[1] -- Wrapper.Group#GROUP
+          local name = args[2] -- #string Group Name
+          local attacker = args[3] -- Wrapper.Group#GROUP
+          if self.UseEmissionsOnOff then
+            grp:EnableEmission(false)
+          end
+          grp:OptionAlarmStateGreen() -- needed else we cannot move around
+          grp:RelocateGroundRandomInRadius(20,300,false,false,"Diamond")
+          if self.UseCallBack then
+            local object = self.CallBack
+            object:SeadSuppressionStart(grp,name,attacker)
+          end
+        end
+  
+        local function SuppressionStop(args)
+          self:T(string.format("*** SEAD - %s Radar On",args[2]))
+          local grp = args[1]  -- Wrapper.Group#GROUP
+          local name = args[2] -- #string Group Nam
+          if self.UseEmissionsOnOff then
+            grp:EnableEmission(true)
+          end
+          grp:OptionAlarmStateRed()
+          grp:OptionEngageRange(self.EngagementRange)
+          self.SuppressedGroups[name] = false
+          if self.UseCallBack then
+            local object = self.CallBack
+            object:SeadSuppressionEnd(grp,name)
+          end
+        end
+  
+        -- randomize switch-on time
+        local delay = math.random(self.TargetSkill[_targetskill].DelayOn[1], self.TargetSkill[_targetskill].DelayOn[2])
+        if delay > _tti then delay = delay / 2 end -- speed up
+        if _tti > 600 then delay =  _tti - 90 end -- shot from afar, 600 is default shorad ontime
+  
+        local SuppressionStartTime = timer.getTime() + delay
+        local SuppressionEndTime = timer.getTime() + _tti + self.Padding
+        local _targetgroupname = _targetgroup:GetName()
+        if not self.SuppressedGroups[_targetgroupname] then
+          self:T(string.format("*** SEAD - %s | Parameters TTI %ds | Switch-Off in %ds",_targetgroupname,_tti,delay))
+          timer.scheduleFunction(SuppressionStart,{_targetgroup,_targetgroupname, SEADGroup},SuppressionStartTime)
+          timer.scheduleFunction(SuppressionStop,{_targetgroup,_targetgroupname},SuppressionEndTime)
+          self.SuppressedGroups[_targetgroupname] = true
+          if self.UseCallBack then
+            local object = self.CallBack
+            object:SeadSuppressionPlanned(_targetgroup,_targetgroupname,SuppressionStartTime,SuppressionEndTime, SEADGroup)
+          end
+        end
+  
+      end
+    end
+  end
+  return self
+end
+
+--- (Internal) Detects if an SAM site was shot with an anti radiation missile. In this case, take evasive actions based on the skill level set within the ME.
+-- @param #SEAD self
+-- @param Core.Event#EVENTDATA EventData
+-- @return #SEAD self
+function SEAD:HandleEventShot( EventData )
+  self:T( { EventData.id } )
+  local SEADPlane = EventData.IniUnit -- Wrapper.Unit#UNIT
+  local SEADGroup = EventData.IniGroup -- Wrapper.Group#GROUP
+  local SEADPlanePos = SEADPlane:GetCoordinate() -- Core.Point#COORDINATE
+  local SEADUnit = EventData.IniDCSUnit
+  local SEADUnitName = EventData.IniDCSUnitName
+  local SEADWeapon = EventData.Weapon -- Identify the weapon fired
+  local SEADWeaponName = EventData.WeaponName -- return weapon type
+
+  self:T( "*** SEAD - Missile Launched = " .. SEADWeaponName)
+  --self:T({ SEADWeapon })
+
+  if self:_CheckHarms(SEADWeaponName) then
+    self:T( '*** SEAD - Weapon Match' )
+    local _targetskill = "Random"
+    local _targetgroupname = "none"
+    local _target = EventData.Weapon:getTarget() -- Identify target
+    if not _target or self.debug  then -- AGM-88 or 154 w/o target data
+      self:E("***** SEAD - No target data for " .. (SEADWeaponName or "None"))
+      if string.find(SEADWeaponName,"AGM_88",1,true) or string.find(SEADWeaponName,"AGM_154",1,true) then
+        self:I("**** Tracking AGM-88/154 with no target data.")
+        local pos0 = SEADPlane:GetCoordinate()
+        local fheight = SEADPlane:GetHeight()
+        self:__CalculateHitZone(20,SEADWeapon,pos0,fheight,SEADGroup,SEADWeaponName)
+      end
+      return self
+    end
+    local targetcat = _target:getCategory() -- Identify category
+    local _targetUnit = nil -- Wrapper.Unit#UNIT
+    local _targetgroup = nil -- Wrapper.Group#GROUP
+    self:T(string.format("*** Targetcat = %d",targetcat))
+    if targetcat == Object.Category.UNIT then -- UNIT
+      self:T("*** Target Category UNIT")
+      _targetUnit = UNIT:Find(_target) -- Wrapper.Unit#UNIT
+      if _targetUnit and _targetUnit:IsAlive() then
+        _targetgroup = _targetUnit:GetGroup()
+        _targetgroupname = _targetgroup:GetName() -- group name
+        local _targetUnitName = _targetUnit:GetName()
+        _targetUnit:GetSkill()
+        _targetskill = _targetUnit:GetSkill()
+      end
+    elseif targetcat == Object.Category.STATIC then
+      self:T("*** Target Category STATIC")
+      local seadset = SET_GROUP:New():FilterPrefixes(self.SEADGroupPrefixes):FilterOnce()
+      local targetpoint = _target:getPoint() or {x=0,y=0,z=0}
+      local tgtcoord = COORDINATE:NewFromVec3(targetpoint)
+      local tgtgrp = seadset:FindNearestGroupFromPointVec2(tgtcoord)
+      if tgtgrp and tgtgrp:IsAlive() then
+        _targetgroup = tgtgrp
+        _targetgroupname = tgtgrp:GetName() -- group name
+        _targetskill = tgtgrp:GetUnit(1):GetSkill()
+        self:T("*** Found Target = ".. _targetgroupname)
+      end
+    end
+    -- see if we are shot at
+    local SEADGroupFound = false
+    for SEADGroupPrefixID, SEADGroupPrefix in pairs( self.SEADGroupPrefixes ) do
+      self:T("Target = ".. _targetgroupname .. " | Prefix = " .. SEADGroupPrefix )
+      if string.find( _targetgroupname, SEADGroupPrefix,1,true ) then
+        SEADGroupFound = true
+        self:T( '*** SEAD - Group Match Found' )
+        break
+      end
+    end
+    if SEADGroupFound == true then -- yes we are being attacked
+      self:ManageEvasion(_targetskill,_targetgroup,SEADPlanePos,SEADWeaponName,SEADGroup)
+    end
+  end
+  return self
 end

Moose Development/Moose/Functional/Shorad.lua

@@ -0,0 +1,667 @@
+--- **Functional** -- Short Range Air Defense System
+-- 
+-- ===
+-- 
+-- **SHORAD** - Short Range Air Defense System
+-- Controls a network of short range air/missile defense groups.
+-- 
+-- ===
+-- 
+-- ## Missions:
+--
+-- ### [SHORAD - Short Range Air Defense](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/SRD%20-%20SHORAD%20Defense)
+-- 
+-- ===
+-- 
+-- ### Author : **applevangelist **
+-- 
+-- @module Functional.Shorad
+-- @image Functional.Shorad.jpg
+--
+-- Date: Nov 2021
+
+-------------------------------------------------------------------------
+--- **SHORAD** class, extends Core.Base#BASE
+-- @type SHORAD
+-- @field #string ClassName
+-- @field #string name Name of this Shorad
+-- @field #boolean debug Set the debug state
+-- @field #string Prefixes String to be used to build the @{#Core.Set#SET_GROUP} 
+-- @field #number Radius Shorad defense radius in meters
+-- @field Core.Set#SET_GROUP Groupset The set of Shorad groups
+-- @field Core.Set#SET_GROUP Samset The set of SAM groups to defend
+-- @field #string Coalition The coalition of this Shorad
+-- @field #number ActiveTimer How long a Shorad stays active after wake-up in seconds
+-- @field #table ActiveGroups Table for the timer function
+-- @field #string lid The log ID for the dcs.log
+-- @field #boolean DefendHarms Default true, intercept incoming HARMS
+-- @field #boolean DefendMavs Default true, intercept incoming AG-Missiles
+-- @field #number DefenseLowProb Default 70, minimum detection limit
+-- @field #number DefenseHighProb Default 90, maximim detection limit
+-- @field #boolean UseEmOnOff Decide if we are using Emission on/off (default) or AlarmState red/green.
+-- @extends Core.Base#BASE
+
+
+--- *Good friends are worth defending.* Mr Tushman, Wonder (the Movie) 
+-- 
+-- Simple Class for a more intelligent Short Range Air Defense System
+-- 
+-- #SHORAD
+-- Moose derived missile intercepting short range defense system.
+-- Protects a network of SAM sites. Uses events to switch on the defense groups closest to the enemy.
+-- Easily integrated with @{Functional.Mantis#MANTIS} to complete the defensive system setup.
+--
+-- ## Usage
+--
+-- Set up a #SET_GROUP for the SAM sites to be protected:  
+-- 
+--        `local SamSet = SET_GROUP:New():FilterPrefixes("Red SAM"):FilterCoalitions("red"):FilterStart()`   
+--    
+-- By default, SHORAD will defense against both HARMs and AG-Missiles with short to medium range. The default defense probability is 70-90%.
+-- When a missile is detected, SHORAD will activate defense groups in the given radius around the target for 10 minutes. It will *not* react to friendly fire.    
+--        
+-- ### Start a new SHORAD system, parameters are:
+--   
+--  * Name: Name of this SHORAD.  
+--  * ShoradPrefix: Filter for the Shorad #SET_GROUP.  
+--  * Samset: The #SET_GROUP of SAM sites to defend.  
+--  * Radius: Defense radius in meters. 
+--  * ActiveTimer: Determines how many seconds the systems stay on red alert after wake-up call.  
+--  * Coalition: Coalition, i.e. "blue", "red", or "neutral".* 
+--    
+--        `myshorad = SHORAD:New("RedShorad", "Red SHORAD", SamSet, 25000, 600, "red")`       
+--
+-- ## Customize options   
+--  
+--  * SHORAD:SwitchDebug(debug)
+--  * SHORAD:SwitchHARMDefense(onoff)
+--  * SHORAD:SwitchAGMDefense(onoff)
+--  * SHORAD:SetDefenseLimits(low,high)
+--  * SHORAD:SetActiveTimer(seconds)
+--  * SHORAD:SetDefenseRadius(meters)
+--
+-- @field #SHORAD
+SHORAD = {
+  ClassName = "SHORAD",
+  name = "MyShorad",
+  debug = false,
+  Prefixes = "",
+  Radius = 20000,
+  Groupset = nil,
+  Samset = nil,
+  Coalition = nil,
+  ActiveTimer = 600, --stay on 10 mins
+  ActiveGroups = {},
+  lid = "",
+  DefendHarms = true,
+  DefendMavs = true,
+  DefenseLowProb = 70,
+  DefenseHighProb = 90,
+  UseEmOnOff = false,  
+}
+
+-----------------------------------------------------------------------
+-- SHORAD System
+-----------------------------------------------------------------------
+
+do
+  -- TODO Complete list?
+  --- Missile enumerators
+  -- @field Harms
+  SHORAD.Harms = {
+  ["AGM_88"] = "AGM_88",
+  ["AGM_45"] = "AGM_45",
+  ["AGM_122"] = "AGM_122",
+  ["AGM_84"] = "AGM_84",
+  ["AGM_45"] = "AGM_45",
+  ["ALARM"] = "ALARM",
+  ["LD-10"] = "LD-10",
+  ["X_58"] = "X_58",
+  ["X_28"] = "X_28",
+  ["X_25"] = "X_25",
+  ["X_31"] = "X_31",
+  ["Kh25"] = "Kh25",
+  }
+  
+  --- TODO complete list?
+  -- @field Mavs
+  SHORAD.Mavs = {
+  ["AGM"] = "AGM",
+  ["C-701"] = "C-701",
+  ["Kh25"] = "Kh25",
+  ["Kh29"] = "Kh29",
+  ["Kh31"] = "Kh31",
+  ["Kh66"] = "Kh66",
+  --["BGM_109"] = "BGM_109",
+  }
+  
+  --- Instantiates a new SHORAD object
+  -- @param #SHORAD self
+  -- @param #string Name Name of this SHORAD
+  -- @param #string ShoradPrefix Filter for the Shorad #SET_GROUP
+  -- @param Core.Set#SET_GROUP Samset The #SET_GROUP of SAM sites to defend
+  -- @param #number Radius Defense radius in meters, used to switch on SHORAD groups **within** this radius
+  -- @param #number ActiveTimer Determines how many seconds the systems stay on red alert after wake-up call
+  -- @param #string Coalition Coalition, i.e. "blue", "red", or "neutral"
+  -- @param #boolean UseEmOnOff Use Emissions On/Off rather than Alarm State Red/Green (default: use Emissions switch)
+  -- @retunr #SHORAD self
+  function SHORAD:New(Name, ShoradPrefix, Samset, Radius, ActiveTimer, Coalition, UseEmOnOff) 
+    local self = BASE:Inherit( self, FSM:New() )
+    self:T({Name, ShoradPrefix, Samset, Radius, ActiveTimer, Coalition})
+    
+    local GroupSet = SET_GROUP:New():FilterPrefixes(ShoradPrefix):FilterCoalitions(Coalition):FilterCategoryGround():FilterStart()
+
+    self.name = Name or "MyShorad"
+    self.Prefixes = ShoradPrefix or "SAM SHORAD"
+    self.Radius = Radius or 20000
+    self.Coalition = Coalition or "blue"
+    self.Samset = Samset or GroupSet
+    self.ActiveTimer = ActiveTimer or 600
+    self.ActiveGroups = {}
+    self.Groupset = GroupSet
+    self.DefendHarms = true
+    self.DefendMavs = true
+    self.DefenseLowProb = 70 -- probability to detect a missile shot, low margin
+    self.DefenseHighProb = 90  -- probability to detect a missile shot, high margin
+    self.UseEmOnOff = UseEmOnOff or false -- Decide if we are using Emission on/off (default) or AlarmState red/green
+    self:I("*** SHORAD - Started Version 0.3.1")
+    -- Set the string id for output to DCS.log file.
+    self.lid=string.format("SHORAD %s | ", self.name)
+    self:_InitState()
+    self:HandleEvent(EVENTS.Shot, self.HandleEventShot)
+    
+    -- Start State.
+    self:SetStartState("Running")
+    self:AddTransition("*",             "WakeUpShorad",                 "*")
+    self:AddTransition("*",             "CalculateHitZone",             "*")
+    
+    return self
+  end
+  
+  --- Initially set all groups to alarm state GREEN
+  -- @param #SHORAD self
+  function SHORAD:_InitState()
+    self:T(self.lid .. " _InitState")
+    local table = {}
+    local set = self.Groupset
+    self:T({set = set})
+    local aliveset = set:GetAliveSet() --#table
+    for _,_group in pairs (aliveset) do
+     if self.UseEmOnOff then
+      --_group:SetAIOff()
+      _group:EnableEmission(false)
+      _group:OptionAlarmStateRed() --Wrapper.Group#GROUP
+     else
+      _group:OptionAlarmStateGreen() --Wrapper.Group#GROUP
+     end
+     _group:OptionDisperseOnAttack(30)
+    end
+    -- gather entropy
+    for i=1,100 do
+      math.random()
+    end
+    return self
+  end
+  
+  --- Switch debug state on
+  -- @param #SHORAD self
+  -- @param #boolean debug Switch debug on (true) or off (false)
+  function SHORAD:SwitchDebug(onoff)
+    self:T( { onoff } )
+    if onoff then
+      self:SwitchDebugOn()
+    else
+      self.SwitchDebugOff()
+    end
+    return self
+  end
+  
+  --- Switch debug state on
+  -- @param #SHORAD self
+  function SHORAD:SwitchDebugOn()
+     self.debug = true
+     --tracing
+     BASE:TraceOn()
+     BASE:TraceClass("SHORAD")
+     return self
+  end
+  
+  --- Switch debug state off
+  -- @param #SHORAD self
+  function SHORAD:SwitchDebugOff()
+    self.debug = false
+    BASE:TraceOff()
+    return self
+  end
+  
+  --- Switch defense for HARMs
+  -- @param #SHORAD self
+  -- @param #boolean onoff
+  function SHORAD:SwitchHARMDefense(onoff)
+    self:T( { onoff } )
+    local onoff = onoff or true
+    self.DefendHarms = onoff
+    return self
+  end
+  
+  --- Switch defense for AGMs
+  -- @param #SHORAD self
+  -- @param #boolean onoff
+  function SHORAD:SwitchAGMDefense(onoff)
+    self:T( { onoff } )
+    local onoff = onoff or true
+    self.DefendMavs = onoff
+    return self
+  end
+  
+  --- Set defense probability limits
+  -- @param #SHORAD self
+  -- @param #number low Minimum detection limit, integer 1-100
+  -- @param #number high Maximum detection limit integer 1-100
+  function SHORAD:SetDefenseLimits(low,high)
+    self:T( { low, high } )
+    local low = low or 70
+    local high = high or 90
+    if (low < 0) or (low > 100) or (low > high) then
+      low = 70
+    end
+    if (high < 0) or (high > 100) or (high < low ) then
+      high = 90
+    end
+    self.DefenseLowProb = low
+    self.DefenseHighProb = high
+    return self
+  end
+  
+  --- Set the number of seconds a SHORAD site will stay active
+  -- @param #SHORAD self
+  -- @param #number seconds Number of seconds systems stay active
+  function SHORAD:SetActiveTimer(seconds)
+    self:T(self.lid .. " SetActiveTimer")
+    local timer = seconds or 600
+    if timer < 0 then
+      timer = 600
+    end
+    self.ActiveTimer = timer
+    return self
+  end
+
+  --- Set the number of meters for the SHORAD defense zone
+  -- @param #SHORAD self
+  -- @param #number meters Radius of the defense search zone in meters. #SHORADs in this range around a targeted group will go active 
+  function SHORAD:SetDefenseRadius(meters)
+  self:T(self.lid .. " SetDefenseRadius")
+    local radius = meters or 20000
+    if radius < 0 then
+      radius = 20000
+    end
+    self.Radius = radius
+    return self
+  end
+  
+  --- Set using Emission on/off instead of changing alarm state
+  -- @param #SHORAD self
+  -- @param #boolean switch Decide if we are changing alarm state or AI state
+  function SHORAD:SetUsingEmOnOff(switch)
+  self:T(self.lid .. " SetUsingEmOnOff")
+    self.UseEmOnOff = switch or false
+    return self
+  end
+  
+  --- Check if a HARM was fired
+  -- @param #SHORAD self
+  -- @param #string WeaponName
+  -- @return #boolean Returns true for a match
+  function SHORAD:_CheckHarms(WeaponName)
+    self:T(self.lid .. " _CheckHarms")
+    self:T( { WeaponName } )
+    local hit = false
+    if self.DefendHarms then
+      for _,_name in pairs (SHORAD.Harms) do
+        if string.find(WeaponName,_name,1,true) then hit = true end
+      end
+    end
+    return hit
+  end
+  
+  --- Check if an AGM was fired
+  -- @param #SHORAD self
+  -- @param #string WeaponName
+  -- @return #boolean Returns true for a match
+  function SHORAD:_CheckMavs(WeaponName)
+    self:T(self.lid .. " _CheckMavs")
+    self:T( { WeaponName } )
+    local hit = false
+    if self.DefendMavs then
+      for _,_name in pairs (SHORAD.Mavs) do
+        if string.find(WeaponName,_name,1,true) then hit = true end
+      end
+    end
+    return hit
+  end
+  
+  --- Check the coalition of the attacker
+  -- @param #SHORAD self
+  -- @param #string Coalition name
+  -- @return #boolean Returns false for a match
+  function SHORAD:_CheckCoalition(Coalition)
+    self:T(self.lid .. " _CheckCoalition")
+    local owncoalition = self.Coalition
+    local othercoalition = ""
+    if Coalition == 0 then 
+      othercoalition = "neutral"
+    elseif Coalition == 1 then
+      othercoalition = "red"
+    else
+      othercoalition = "blue"
+    end
+    self:T({owncoalition = owncoalition, othercoalition = othercoalition})
+    if owncoalition ~= othercoalition then
+      return true
+    else
+      return false
+    end
+  end
+  
+  --- Check if the missile is aimed at a SHORAD
+  -- @param #SHORAD self
+  -- @param #string TargetGroupName Name of the target group
+  -- @return #boolean Returns true for a match, else false
+  function SHORAD:_CheckShotAtShorad(TargetGroupName)
+    self:T(self.lid .. " _CheckShotAtShorad")
+    local tgtgrp = TargetGroupName
+    local shorad = self.Groupset
+    local shoradset = shorad:GetAliveSet() --#table
+    local returnname = false
+    for _,_groups in pairs (shoradset) do
+      local groupname = _groups:GetName()
+      if string.find(groupname, tgtgrp, 1, true) then
+        returnname = true
+        --_groups:RelocateGroundRandomInRadius(7,100,false,false) -- be a bit evasive
+      end
+    end
+    return returnname  
+  end
+  
+  --- Check if the missile is aimed at a SAM site
+  -- @param #SHORAD self
+  -- @param #string TargetGroupName Name of the target group
+  -- @return #boolean Returns true for a match, else false
+  function SHORAD:_CheckShotAtSams(TargetGroupName)
+    self:T(self.lid .. " _CheckShotAtSams")
+    local tgtgrp = TargetGroupName
+    local shorad = self.Samset
+    --local shoradset = shorad:GetAliveSet() --#table
+    local shoradset = shorad:GetSet() --#table
+    local returnname = false
+    for _,_groups in pairs (shoradset) do
+      local groupname = _groups:GetName()
+      if string.find(groupname, tgtgrp, 1, true) then
+        returnname = true
+      end
+    end
+    return returnname
+  end
+  
+  --- Calculate if the missile shot is detected
+  -- @param #SHORAD self
+  -- @return #boolean Returns true for a detection, else false
+  function SHORAD:_ShotIsDetected()
+    self:T(self.lid .. " _ShotIsDetected")
+    if self.debug then return true end
+    local IsDetected = false
+    local DetectionProb = math.random(self.DefenseLowProb, self.DefenseHighProb)  -- reference value
+    local ActualDetection = math.random(1,100) -- value for this shot
+    if ActualDetection <= DetectionProb then
+      IsDetected = true
+    end
+    return IsDetected
+  end
+  
+  --- Wake up #SHORADs in a zone with diameter Radius for ActiveTimer seconds
+  -- @param #SHORAD self
+  -- @param #string TargetGroup Name of the target group used to build the #ZONE
+  -- @param #number Radius Radius of the #ZONE
+  -- @param #number ActiveTimer Number of seconds to stay active
+  -- @param #number TargetCat (optional) Category, i.e. Object.Category.UNIT or Object.Category.STATIC
+  -- @usage Use this function to integrate with other systems, example   
+  -- 
+  -- local SamSet = SET_GROUP:New():FilterPrefixes("Blue SAM"):FilterCoalitions("blue"):FilterStart()
+  -- myshorad = SHORAD:New("BlueShorad", "Blue SHORAD", SamSet, 22000, 600, "blue")
+  -- myshorad:SwitchDebug(true)
+  -- mymantis = MANTIS:New("BlueMantis","Blue SAM","Blue EWR",nil,"blue",false,"Blue Awacs")
+  -- mymantis:AddShorad(myshorad,720)
+  -- mymantis:Start()
+  function SHORAD:onafterWakeUpShorad(From, Event, To, TargetGroup, Radius, ActiveTimer, TargetCat)
+    self:T(self.lid .. " WakeUpShorad")
+    self:T({TargetGroup, Radius, ActiveTimer, TargetCat})
+    local targetcat = TargetCat or Object.Category.UNIT
+    local targetgroup = TargetGroup
+    local targetvec2 = nil
+    if targetcat == Object.Category.UNIT then
+      targetvec2 = GROUP:FindByName(targetgroup):GetVec2()
+    elseif targetcat == Object.Category.STATIC then
+      targetvec2 = STATIC:FindByName(targetgroup,false):GetVec2()
+    else
+      local samset = self.Samset
+      local sam = samset:GetRandom()
+      targetvec2 = sam:GetVec2()
+    end
+    local targetzone = ZONE_RADIUS:New("Shorad",targetvec2,Radius)  -- create a defense zone to check
+    local groupset = self.Groupset --Core.Set#SET_GROUP
+    local shoradset = groupset:GetAliveSet() --#table
+    -- local function to switch off shorad again
+    local function SleepShorad(group)
+      local groupname = group:GetName()
+      self.ActiveGroups[groupname] = nil
+      if self.UseEmOnOff then
+        group:EnableEmission(false)
+        --group:SetAIOff()
+      else
+        group:OptionAlarmStateGreen()
+      end
+      local text = string.format("Sleeping SHORAD %s", group:GetName())
+      self:T(text)
+      local m = MESSAGE:New(text,10,"SHORAD"):ToAllIf(self.debug)
+    end
+    -- go through set and find the one(s) to activate
+    for _,_group in pairs (shoradset) do
+      if _group:IsAnyInZone(targetzone) then
+        local text = string.format("Waking up SHORAD %s", _group:GetName())
+        self:T(text)
+        local m = MESSAGE:New(text,10,"SHORAD"):ToAllIf(self.debug)
+        if self.UseEmOnOff then
+          --_group:SetAIOn()
+          _group:EnableEmission(true)
+        end
+        _group:OptionAlarmStateRed()
+        local groupname = _group:GetName()
+        if self.ActiveGroups[groupname] == nil then -- no timer yet for this group
+          self.ActiveGroups[groupname] = { Timing = ActiveTimer }
+          local endtime = timer.getTime() + (ActiveTimer * math.random(75,100) / 100 ) -- randomize wakeup a bit
+          timer.scheduleFunction(SleepShorad, _group, endtime)
+        end
+      end
+    end
+    return self
+  end
+  
+--- (Internal) Calculate hit zone of an AGM-88
+-- @param #SHORAD self
+-- @param #table SEADWeapon DCS.Weapon object
+-- @param Core.Point#COORDINATE pos0 Position of the plane when it fired
+-- @param #number height Height when the missile was fired
+-- @param Wrapper.Group#GROUP SEADGroup Attacker group
+-- @return #SHORAD self 
+function SHORAD:onafterCalculateHitZone(From,Event,To,SEADWeapon,pos0,height,SEADGroup)
+  self:T("**** Calculating hit zone")
+  if SEADWeapon and SEADWeapon:isExist() then
+    --local pos = SEADWeapon:getPoint()
+    
+    -- postion and height
+    local position = SEADWeapon:getPosition()
+    local mheight = height
+    -- heading
+    local wph = math.atan2(position.x.z, position.x.x)      
+    if wph < 0 then
+      wph=wph+2*math.pi
+    end   
+    wph=math.deg(wph)
+    
+    -- velocity
+    local wpndata = SEAD.HarmData["AGM_88"]
+    local mveloc = math.floor(wpndata[2] * 340.29)
+    local c1 = (2*mheight*9.81)/(mveloc^2)
+    local c2 = (mveloc^2) / 9.81
+    local Ropt = c2 * math.sqrt(c1+1) 
+    if height <= 5000 then
+      Ropt = Ropt * 0.72
+    elseif height <= 7500 then
+      Ropt = Ropt * 0.82  
+    elseif height <= 10000 then
+      Ropt = Ropt * 0.87
+    elseif height <= 12500 then
+      Ropt = Ropt * 0.98
+    end
+    
+    -- look at a couple of zones across the trajectory
+    for n=1,3 do
+      local dist = Ropt - ((n-1)*20000)
+      local predpos= pos0:Translate(dist,wph)
+      if predpos then
+  
+        local targetzone = ZONE_RADIUS:New("Target Zone",predpos:GetVec2(),20000)
+        
+        if self.debug then
+          predpos:MarkToAll(string.format("height=%dm | heading=%d | velocity=%ddeg | Ropt=%dm",mheight,wph,mveloc,Ropt),false)
+          targetzone:DrawZone(coalition.side.BLUE,{0,0,1},0.2,nil,nil,3,true)
+        end  
+        
+        local seadset = self.Groupset
+        local tgtcoord = targetzone:GetRandomPointVec2()
+        local tgtgrp = seadset:FindNearestGroupFromPointVec2(tgtcoord)
+        local _targetgroup = nil
+        local _targetgroupname = "none"
+        local _targetskill = "Random"
+        if tgtgrp and tgtgrp:IsAlive() then
+          _targetgroup = tgtgrp
+          _targetgroupname = tgtgrp:GetName() -- group name
+          _targetskill = tgtgrp:GetUnit(1):GetSkill()
+          self:T("*** Found Target = ".. _targetgroupname)
+          self:WakeUpShorad(_targetgroupname, self.Radius, self.ActiveTimer, Object.Category.UNIT)
+        end
+      end
+    end     
+  end
+  return self
+end
+  
+  --- Main function - work on the EventData
+  -- @param #SHORAD self
+  -- @param Core.Event#EVENTDATA EventData The event details table data set
+  function SHORAD:HandleEventShot( EventData )
+    self:T( { EventData } )
+    self:T(self.lid .. " HandleEventShot")
+    --local ShootingUnit = EventData.IniDCSUnit
+    --local ShootingUnitName = EventData.IniDCSUnitName
+    local ShootingWeapon = EventData.Weapon -- Identify the weapon fired
+    local ShootingWeaponName = EventData.WeaponName -- return weapon type
+    -- get firing coalition
+    local weaponcoalition = EventData.IniGroup:GetCoalition()
+    -- get detection probability
+    if self:_CheckCoalition(weaponcoalition) then --avoid overhead on friendly fire
+      local IsDetected = self:_ShotIsDetected()
+      -- convert to text
+      local DetectedText = "false"
+      if IsDetected then 
+        DetectedText = "true"
+      end
+      local text = string.format("%s Missile Launched = %s | Detected probability state is %s", self.lid, ShootingWeaponName, DetectedText)
+      self:T( text )
+      local m = MESSAGE:New(text,10,"Info"):ToAllIf(self.debug)
+      --
+      if (self:_CheckHarms(ShootingWeaponName) or self:_CheckMavs(ShootingWeaponName)) and IsDetected then
+        -- get target data
+        local targetdata = EventData.Weapon:getTarget() -- Identify target
+        -- Is there target data?
+        if not targetdata or self.debug then 
+          if string.find(ShootingWeaponName,"AGM_88",1,true) then
+            self:I("**** Tracking AGM-88 with no target data.")
+            local pos0 = EventData.IniUnit:GetCoordinate()
+            local fheight = EventData.IniUnit:GetHeight()
+            self:__CalculateHitZone(20,ShootingWeapon,pos0,fheight,EventData.IniGroup)
+          end  
+          return self
+        end
+        
+        local targetcat = targetdata:getCategory() -- Identify category
+        self:T(string.format("Target Category (3=STATIC, 1=UNIT)= %s",tostring(targetcat)))
+        self:T({targetdata})
+        local targetunit = nil
+        if targetcat == Object.Category.UNIT then -- UNIT
+          targetunit = UNIT:Find(targetdata)
+        elseif targetcat == Object.Category.STATIC then  -- STATIC
+          --self:T("Static Target Data")
+          --self:T({targetdata:isExist()})
+          --self:T({targetdata:getPoint()})
+          local tgtcoord = COORDINATE:NewFromVec3(targetdata:getPoint())
+          --tgtcoord:MarkToAll("Missile Target",true)
+          
+          local tgtgrp1 = self.Samset:FindNearestGroupFromPointVec2(tgtcoord)
+          local tgtcoord1 = tgtgrp1:GetCoordinate()
+          --tgtcoord1:MarkToAll("Close target SAM",true)
+          
+          local tgtgrp2 = self.Groupset:FindNearestGroupFromPointVec2(tgtcoord)
+          local tgtcoord2 = tgtgrp2:GetCoordinate()
+          --tgtcoord2:MarkToAll("Close target SHORAD",true)
+          
+          local dist1 = tgtcoord:Get2DDistance(tgtcoord1)
+          local dist2 = tgtcoord:Get2DDistance(tgtcoord2)
+          
+          if dist1 < dist2 then
+            targetunit = tgtgrp1
+            targetcat = Object.Category.UNIT
+          else
+            targetunit = tgtgrp2
+            targetcat = Object.Category.UNIT
+          end
+        end   
+        --local targetunitname = Unit.getName(targetdata) -- Unit name
+        if targetunit and targetunit:IsAlive() then
+          local targetunitname = targetunit:GetName()
+          --local targetgroup = Unit.getGroup(Weapon.getTarget(ShootingWeapon)) --targeted group
+          local targetgroup = nil
+          local targetgroupname = "none"
+          if targetcat == Object.Category.UNIT then
+            if targetunit.ClassName == "UNIT" then
+              targetgroup = targetunit:GetGroup()
+            elseif targetunit.ClassName == "GROUP" then
+              targetgroup = targetunit
+            end
+            targetgroupname = targetgroup:GetName() -- group name
+          elseif targetcat == Object.Category.STATIC then
+            targetgroup = targetunit
+            targetgroupname = targetunitname
+          end
+          local text = string.format("%s Missile Target = %s", self.lid, tostring(targetgroupname))
+          self:T( text )
+          local m = MESSAGE:New(text,10,"Info"):ToAllIf(self.debug)
+          -- check if we or a SAM site are the target 
+          --local TargetGroup = EventData.TgtGroup -- Wrapper.Group#GROUP
+          local shotatus = self:_CheckShotAtShorad(targetgroupname) --#boolean
+          local shotatsams = self:_CheckShotAtSams(targetgroupname) --#boolean
+          -- if being shot at, find closest SHORADs to activate
+          if shotatsams or shotatus then
+            self:T({shotatsams=shotatsams,shotatus=shotatus})
+            self:WakeUpShorad(targetgroupname, self.Radius, self.ActiveTimer, targetcat)
+          end
+        end  
+      end
+    end
+    return self
+  end 
+--
+end
+-----------------------------------------------------------------------
+-- SHORAD end
+-----------------------------------------------------------------------

Moose Development/Moose/Functional/ZoneCaptureCoalition.lua

@@ -715,20 +715,21 @@ do -- ZONE_CAPTURE_COALITION
   
       local UnitHit = EventData.TgtUnit
       
+      if UnitHit.ClassName ~= "SCENERY" then
       -- Check if unit is inside the capture zone and that it is of the defending coalition.
-      if UnitHit and UnitHit:IsInZone(self) and UnitHit:GetCoalition()==self.Coalition then
+          if UnitHit and UnitHit:IsInZone(self) and UnitHit:GetCoalition()==self.Coalition then
           
-        -- Update last hit time.
+            -- Update last hit time.
-        self.HitTimeLast=timer.getTime()
+            self.HitTimeLast=timer.getTime()
             
-        -- Only trigger attacked event if not already in state "Attacked".
+            -- Only trigger attacked event if not already in state "Attacked".
-        if self:GetState()~="Attacked" then
+            if self:GetState()~="Attacked" then
-          self:F2("Hit ==> Attack")
+              self:F2("Hit ==> Attack")
-          self:Attack()
+              self:Attack()
-        end
+            end
             
+          end
       end
-
     end
   
   end
@@ -803,7 +804,7 @@ do -- ZONE_CAPTURE_COALITION
     return IsEmpty
   end
 
-  --- Check if zone is "Guarded", i.e. only one (the defending) coaliton is present inside the zone.
+  --- Check if zone is "Guarded", i.e. only one (the defending) coalition is present inside the zone.
   -- @param #ZONE_CAPTURE_COALITION self
   -- @return #boolean self:IsAllInZoneOfCoalition( self.Coalition )
   function ZONE_CAPTURE_COALITION:IsGuarded()
@@ -825,7 +826,7 @@ do -- ZONE_CAPTURE_COALITION
     return IsCaptured
   end
   
-  --- Check if zone is "Attacked", i.e. another coaliton entered the zone.
+  --- Check if zone is "Attacked", i.e. another coalition entered the zone.
   -- @param #ZONE_CAPTURE_COALITION self
   -- @return #boolean self:IsSomeInZoneOfCoalition( self.Coalition )
   function ZONE_CAPTURE_COALITION:IsAttacked()
@@ -890,12 +891,14 @@ do -- ZONE_CAPTURE_COALITION
     end
     
     -- Status text.
-    local text=string.format("CAPTURE ZONE %s: Owner=%s (Previous=%s): #blue=%d, #red=%d, Status %s", self:GetZoneName(), self:GetCoalitionName(), UTILS.GetCoalitionName(self:GetPreviousCoalition()), nBlue, nRed, State)
+    if false then
-    local NewState = self:GetState()
+      local text=string.format("CAPTURE ZONE %s: Owner=%s (Previous=%s): #blue=%d, #red=%d, Status %s", self:GetZoneName(), self:GetCoalitionName(), UTILS.GetCoalitionName(self:GetPreviousCoalition()), nBlue, nRed, State)
-    if NewState~=State then
+      local NewState = self:GetState()
-      text=text..string.format(" --> %s", NewState)
+      if NewState~=State then
+        text=text..string.format(" --> %s", NewState)
+      end
+      self:I(text)
     end
-    self:I(text)
 
   end
 
@@ -903,7 +906,6 @@ do -- ZONE_CAPTURE_COALITION
 -- Misc Functions
 -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
-  
   --- Update Mark on F10 map.
   -- @param #ZONE_CAPTURE_COALITION self
   function ZONE_CAPTURE_COALITION:Mark()
@@ -922,7 +924,7 @@ do -- ZONE_CAPTURE_COALITION
         Coord:RemoveMark(self.MarkBlue)
       end
 
-      -- Create new marks for each coaliton.
+      -- Create new marks for each coalition.
       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 )

Moose Development/Moose/Functional/ZoneGoalCoalition.lua

@@ -24,7 +24,6 @@ do -- ZoneGoal
   -- @field #table ObjectCategories Table of object categories that are able to hold a zone. Default is UNITS and STATICS.
   -- @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.
   --
@@ -42,10 +41,10 @@ do -- ZoneGoal
   --
   -- @field #ZONE_GOAL_COALITION
   ZONE_GOAL_COALITION = {
-    ClassName        = "ZONE_GOAL_COALITION",
+    ClassName = "ZONE_GOAL_COALITION",
-    Coalition        = nil,
+    Coalition = nil,
-    PreviousCoaliton = nil,
+    PreviousCoalition = nil,
-    UnitCategories   = nil,
+    UnitCategories = nil,
     ObjectCategories = nil,
   }
 
@@ -61,31 +60,30 @@ do -- ZoneGoal
   function ZONE_GOAL_COALITION:New( Zone, Coalition, UnitCategories )
 
     if not Zone then
-      BASE:E("ERROR: No Zone specified in ZONE_GOAL_COALITON!")
+      BASE:E( "ERROR: No Zone specified in ZONE_GOAL_COALITION!" )
       return nil
     end
 
     -- Inherit ZONE_GOAL.
     local self = BASE:Inherit( self, ZONE_GOAL:New( Zone ) ) -- #ZONE_GOAL_COALITION
-    self:F( { Zone = Zone, Coalition  = Coalition  } )
+    self:F( { Zone = Zone, Coalition = Coalition } )
 
     -- Set initial owner.
-    self:SetCoalition( Coalition or coalition.side.NEUTRAL)
+    self:SetCoalition( Coalition or coalition.side.NEUTRAL )
 
     -- Set default unit and object categories for the zone scan.
-    self:SetUnitCategories(UnitCategories)
+    self:SetUnitCategories( UnitCategories )
     self:SetObjectCategories()
 
     return self
   end
 
-
   --- Set the owning coalition of the zone.
   -- @param #ZONE_GOAL_COALITION self
   -- @param DCSCoalition.DCSCoalition#coalition Coalition The coalition ID, e.g. *coalition.side.RED*.
   -- @return #ZONE_GOAL_COALITION
   function ZONE_GOAL_COALITION:SetCoalition( Coalition )
-    self.PreviousCoalition=self.Coalition or Coalition
+    self.PreviousCoalition = self.Coalition or Coalition
     self.Coalition = Coalition
     return self
   end
@@ -96,11 +94,11 @@ do -- ZoneGoal
   -- @return #ZONE_GOAL_COALITION
   function ZONE_GOAL_COALITION:SetUnitCategories( UnitCategories )
 
-    if UnitCategories and type(UnitCategories)~="table" then
+    if UnitCategories and type( UnitCategories ) ~= "table" then
-      UnitCategories={UnitCategories}
+      UnitCategories = { UnitCategories }
     end
 
-    self.UnitCategories=UnitCategories or {Unit.Category.GROUND_UNIT}
+    self.UnitCategories = UnitCategories or { Unit.Category.GROUND_UNIT }
 
     return self
   end
@@ -111,11 +109,11 @@ do -- ZoneGoal
   -- @return #ZONE_GOAL_COALITION
   function ZONE_GOAL_COALITION:SetObjectCategories( ObjectCategories )
 
-    if ObjectCategories and type(ObjectCategories)~="table" then
+    if ObjectCategories and type( ObjectCategories ) ~= "table" then
-      ObjectCategories={ObjectCategories}
+      ObjectCategories = { ObjectCategories }
     end
 
-    self.ObjectCategories=ObjectCategories or {Object.Category.UNIT, Object.Category.STATIC}
+    self.ObjectCategories = ObjectCategories or { Object.Category.UNIT, Object.Category.STATIC }
 
     return self
   end
@@ -127,22 +125,20 @@ do -- ZoneGoal
     return self.Coalition
   end
 
-  --- Get the previous coaliton, i.e. the one owning the zone before the current one. 
+  --- Get the previous coalition, i.e. the one owning the zone before the current one. 
   -- @param #ZONE_GOAL_COALITION self
   -- @return DCSCoalition.DCSCoalition#coalition Coalition.
   function ZONE_GOAL_COALITION:GetPreviousCoalition()
     return self.PreviousCoalition
   end
 
-  
   --- Get the owning coalition name of the zone.
   -- @param #ZONE_GOAL_COALITION self
   -- @return #string Coalition name.
   function ZONE_GOAL_COALITION:GetCoalitionName()
-    return UTILS.GetCoalitionName(self.Coalition)
+    return UTILS.GetCoalitionName( self.Coalition )
   end
 
-
   --- Check status Coalition ownership.
   -- @param #ZONE_GOAL_COALITION self
   -- @return #ZONE_GOAL_COALITION
@@ -152,8 +148,8 @@ do -- ZoneGoal
     local State = self:GetState()
 
     -- Debug text.
-    local text=string.format("Zone state=%s, Owner=%s, Scanning...", State, self:GetCoalitionName())
+    local text = string.format( "Zone state=%s, Owner=%s, Scanning...", State, self:GetCoalitionName() )
-    self:F(text)
+    self:F( text )
 
     -- Scan zone.
     self:Scan( self.ObjectCategories, self.UnitCategories )

Moose Development/Moose/Globals.lua

@@ -1,5 +1,4 @@
--- The order of the declarations is important here. Don't touch it.
+--- GLOBALS: 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
@@ -10,9 +9,38 @@ _SCHEDULEDISPATCHER = SCHEDULEDISPATCHER:New() -- Core.ScheduleDispatcher#SCHEDU
 --- Declare the main database object, which is used internally by the MOOSE classes.
 _DATABASE = DATABASE:New() -- Core.Database#DATABASE
 
+--- Settings
 _SETTINGS = SETTINGS:Set()
 _SETTINGS:SetPlayerMenuOn()
 
+--- Register cargos.
 _DATABASE:_RegisterCargos()
-_DATABASE:_RegisterZones()
 
+--- Register zones.
+_DATABASE:_RegisterZones()
+_DATABASE:_RegisterAirbases()
+
+--- Check if os etc is available.
+BASE:I("Checking de-sanitization of os, io and lfs:")
+local __na=false
+if os then
+  BASE:I("- os available")
+else
+  BASE:I("- os NOT available! Some functions may not work.")
+  __na=true
+end
+if io then
+  BASE:I("- io available")
+else
+  BASE:I("- io NOT available! Some functions may not work.")
+  __na=true  
+end
+if lfs then
+  BASE:I("- lfs available")
+else
+  BASE:I("- lfs NOT available! Some functions may not work.")
+  __na=true  
+end
+if __na then
+  BASE:I("Check <DCS install folder>/Scripts/MissionScripting.lua and comment out the lines with sanitizeModule(''). Use at your own risk!)")
+end

Moose Development/Moose/Modules.lua

@@ -2,10 +2,16 @@ __Moose.Include( 'Scripts/Moose/Utilities/Enums.lua' )
 __Moose.Include( 'Scripts/Moose/Utilities/Routines.lua' )
 __Moose.Include( 'Scripts/Moose/Utilities/Utils.lua' )
 __Moose.Include( 'Scripts/Moose/Utilities/Profiler.lua' )
+__Moose.Include( 'Scripts/Moose/Utilities/Templates.lua' )
+__Moose.Include( 'Scripts/Moose/Utilities/STTS.lua' )
+__Moose.Include( 'Scripts/Moose/Utilities/FiFo.lua' )
+__Moose.Include( 'Scripts/Moose/Utilities/Socket.lua' )
 
 __Moose.Include( 'Scripts/Moose/Core/Base.lua' )
+__Moose.Include( 'Scripts/Moose/Core/Astar.lua' )
+__Moose.Include( 'Scripts/Moose/Core/Beacon.lua' )
+__Moose.Include( 'Scripts/Moose/Core/Condition.lua' )
 __Moose.Include( 'Scripts/Moose/Core/UserFlag.lua' )
-__Moose.Include( 'Scripts/Moose/Core/UserSound.lua' )
 __Moose.Include( 'Scripts/Moose/Core/Report.lua' )
 __Moose.Include( 'Scripts/Moose/Core/Scheduler.lua' )
 __Moose.Include( 'Scripts/Moose/Core/ScheduleDispatcher.lua' )
@@ -20,14 +26,13 @@ __Moose.Include( 'Scripts/Moose/Core/Point.lua' )
 __Moose.Include( 'Scripts/Moose/Core/Velocity.lua' )
 __Moose.Include( 'Scripts/Moose/Core/Message.lua' )
 __Moose.Include( 'Scripts/Moose/Core/Fsm.lua' )
-__Moose.Include( 'Scripts/Moose/Core/Radio.lua' )
-__Moose.Include( 'Scripts/Moose/Core/RadioQueue.lua' )
-__Moose.Include( 'Scripts/Moose/Core/RadioSpeech.lua' )
 __Moose.Include( 'Scripts/Moose/Core/Spawn.lua' )
 __Moose.Include( 'Scripts/Moose/Core/SpawnStatic.lua' )
 __Moose.Include( 'Scripts/Moose/Core/Timer.lua' )
 __Moose.Include( 'Scripts/Moose/Core/Goal.lua' )
 __Moose.Include( 'Scripts/Moose/Core/Spot.lua' )
+__Moose.Include( 'Scripts/Moose/Core/MarkerOps_Base.lua' )
+__Moose.Include( 'Scripts/Moose/Core/TextAndSound.lua' )
 
 __Moose.Include( 'Scripts/Moose/Wrapper/Object.lua' )
 __Moose.Include( 'Scripts/Moose/Wrapper/Identifiable.lua' )
@@ -68,11 +73,14 @@ __Moose.Include( 'Scripts/Moose/Functional/PseudoATC.lua' )
 __Moose.Include( 'Scripts/Moose/Functional/Warehouse.lua' )
 __Moose.Include( 'Scripts/Moose/Functional/Fox.lua' )
 __Moose.Include( 'Scripts/Moose/Functional/Mantis.lua' )
+__Moose.Include( 'Scripts/Moose/Functional/Shorad.lua' )
 
 __Moose.Include( 'Scripts/Moose/Ops/Airboss.lua' )
 __Moose.Include( 'Scripts/Moose/Ops/RecoveryTanker.lua' )
 __Moose.Include( 'Scripts/Moose/Ops/RescueHelo.lua' )
 __Moose.Include( 'Scripts/Moose/Ops/ATIS.lua' )
+__Moose.Include( 'Scripts/Moose/Ops/CTLD.lua' )
+__Moose.Include( 'Scripts/Moose/Ops/CSAR.lua' )
 
 __Moose.Include( 'Scripts/Moose/AI/AI_Balancer.lua' )
 __Moose.Include( 'Scripts/Moose/AI/AI_Air.lua' )
@@ -111,6 +119,13 @@ __Moose.Include( 'Scripts/Moose/Actions/Act_Route.lua' )
 __Moose.Include( 'Scripts/Moose/Actions/Act_Account.lua' )
 __Moose.Include( 'Scripts/Moose/Actions/Act_Assist.lua' )
 
+__Moose.Include( 'Scripts/Moose/Sound/UserSound.lua' )
+__Moose.Include( 'Scripts/Moose/Sound/SoundOutput.lua' )
+__Moose.Include( 'Scripts/Moose/Sound/Radio.lua' )
+__Moose.Include( 'Scripts/Moose/Sound/RadioQueue.lua' )
+__Moose.Include( 'Scripts/Moose/Sound/RadioSpeech.lua' )
+__Moose.Include( 'Scripts/Moose/Sound/SRS.lua' )
+
 __Moose.Include( 'Scripts/Moose/Tasking/CommandCenter.lua' )
 __Moose.Include( 'Scripts/Moose/Tasking/Mission.lua' )
 __Moose.Include( 'Scripts/Moose/Tasking/Task.lua' )

Moose Development/Moose/Ops/RecoveryTanker.lua

@@ -31,7 +31,7 @@
 -- @field #string tankergroupname Name of the late activated tanker template group.
 -- @field Wrapper.Group#GROUP tanker Tanker group.
 -- @field Wrapper.Airbase#AIRBASE airbase The home airbase object of the tanker. Normally the aircraft carrier.
--- @field Core.Radio#BEACON beacon Tanker TACAN beacon.
+-- @field Core.Beacon#BEACON beacon Tanker TACAN beacon.
 -- @field #number TACANchannel TACAN channel. Default 1.
 -- @field #string TACANmode TACAN mode, i.e. "X" or "Y". Default "Y". Use only "Y" for AA TACAN stations!
 -- @field #string TACANmorse TACAN morse code. Three letters identifying the TACAN station. Default "TKR".
@@ -784,10 +784,11 @@ end
 -- @param #RECOVERYTANKER self
 -- @param #number channel TACAN channel. Default 1.
 -- @param #string morse TACAN morse code identifier. Three letters. Default "TKR".
+-- @param #string mode TACAN mode, which can be either "Y" (default) or "X".
 -- @return #RECOVERYTANKER self
-function RECOVERYTANKER:SetTACAN(channel, morse)
+function RECOVERYTANKER:SetTACAN(channel, morse, mode)
   self.TACANchannel=channel or 1
-  self.TACANmode="Y"
+  self.TACANmode=mode or "Y"
   self.TACANmorse=morse or "TKR"
   self.TACANon=true
   return self
@@ -1625,7 +1626,6 @@ function RECOVERYTANKER:_ActivateTACAN(delay)
   if delay and delay>0 then
   
     -- Schedule TACAN activation.
-    --SCHEDULER:New(nil, self._ActivateTACAN, {self}, delay)
     self:ScheduleOnce(delay, RECOVERYTANKER._ActivateTACAN, self)
     
   else

Moose Development/Moose/Ops/RescueHelo.lua

@@ -802,7 +802,7 @@ function RESCUEHELO:_OnEventCrashOrEject(EventData)
       -- Debug.
       local text=string.format("Unit %s crashed or ejected.", unitname)
       MESSAGE:New(text, 10, "DEBUG"):ToAllIf(self.Debug)
-      self:I(self.lid..text)
+      self:T(self.lid..text)
 
       -- Get coordinate of unit.      
       local coord=unit:GetCoordinate()

Moose Development/Moose/Sound/Radio.lua

@@ -0,0 +1,394 @@
+--- **Sound** - Radio transmissions.
+--
+-- ===
+--
+-- ## Features:
+--
+--   * Provide radio functionality to broadcast radio transmissions.
+--
+-- What are radio communications in DCS?
+--
+--   * Radio transmissions consist of **sound files** that are broadcasted on a specific **frequency** (e.g. 115MHz) and **modulation** (e.g. AM),
+--   * They can be **subtitled** for a specific **duration**, the **power** in Watts of the transmiter's antenna can be set, and the transmission can be **looped**.
+--
+-- How to supply DCS my own Sound Files?
+--
+--   * Your sound files need to be encoded in **.ogg** or .wav,
+--   * Your sound files should be **as tiny as possible**. It is suggested you encode in .ogg with low bitrate and sampling settings,
+--   * They need to be added in .\l10n\DEFAULT\ in you .miz file (wich can be decompressed like a .zip file),
+--   * For simplicity sake, you can **let DCS' Mission Editor add the file** itself, by creating a new Trigger with the action "Sound to Country", and choosing your sound file and a country you don't use in your mission.
+--
+-- Due to weird DCS quirks, **radio communications behave differently** if sent by a @{Wrapper.Unit#UNIT} or a @{Wrapper.Group#GROUP} or by any other @{Wrapper.Positionable#POSITIONABLE}
+--
+--   * If the transmitter is a @{Wrapper.Unit#UNIT} or a @{Wrapper.Group#GROUP}, DCS will set the power of the transmission automatically,
+--   * If the transmitter is any other @{Wrapper.Positionable#POSITIONABLE}, the transmisison can't be subtitled or looped.
+--
+-- Note that obviously, the **frequency** and the **modulation** of the transmission are important only if the players are piloting an **Advanced System Modelling** enabled aircraft,
+-- like the A10C or the Mirage 2000C. They will **hear the transmission** if they are tuned on the **right frequency and modulation** (and if they are close enough - more on that below).
+-- If an FC3 aircraft is used, it will **hear every communication, whatever the frequency and the modulation** is set to. The same is true for TACAN beacons. If your aircraft isn't compatible,
+-- you won't hear/be able to use the TACAN beacon informations.
+--
+-- ===
+--
+-- ### Authors: Hugues "Grey_Echo" Bousquet, funkyfranky
+--
+-- @module Sound.Radio
+-- @image Core_Radio.JPG
+
+
+--- *It's not true I had nothing on, I had the radio on.* -- Marilyn Monroe
+--
+-- # 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,
+--   * 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}
+--
+--   * @{#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 transmitter is a @{Wrapper.Unit#UNIT} or a @{Wrapper.Group#GROUP}
+--
+--   * @{#RADIO.SetSubtitle}() : Set both the subtitle and its duration,
+--   * @{#RADIO.NewUnitTransmission}() : Shortcut to set all the relevant parameters in one method call
+--
+-- Additional Methods to set relevant parameters if the transmitter is any other @{Wrapper.Positionable#POSITIONABLE}
+--
+--   * @{#RADIO.SetPower}() : Sets the power of the antenna in Watts
+--   * @{#RADIO.NewGenericTransmission}() : Shortcut to set all the relevant parameters in one method call
+--
+-- What is this power thing?
+--
+--   * If your transmission is sent by a @{Wrapper.Positionable#POSITIONABLE} other than a @{Wrapper.Unit#UNIT} or a @{Wrapper.Group#GROUP}, you can set the power of the antenna,
+--   * Otherwise, DCS sets it automatically, depending on what's available on your Unit,
+--   * If the player gets **too far** from the transmitter, or if the antenna is **too weak**, the transmission will **fade** and **become noisyer**,
+--   * This an automated DCS calculation you have no say on,
+--   * For reference, a standard VOR station has a 100 W antenna, a standard AA TACAN has a 120 W antenna, and civilian ATC's antenna usually range between 300 and 500 W,
+--   * Note that if the transmission has a subtitle, it will be readable, regardless of the quality of the transmission.
+--
+-- @type RADIO
+-- @field Wrapper.Controllable#CONTROLLABLE Positionable The @{#CONTROLLABLE} that will transmit the radio calls.
+-- @field #string FileName Name of the sound file played.
+-- @field #number Frequency Frequency of the transmission in Hz.
+-- @field #number Modulation Modulation of the transmission (either radio.modulation.AM or radio.modulation.FM).
+-- @field #string Subtitle Subtitle of the transmission.
+-- @field #number SubtitleDuration Duration of the Subtitle in seconds.
+-- @field #number Power Power of the antenna is Watts.
+-- @field #boolean Loop Transmission is repeated (default true).
+-- @field #string alias Name of the radio transmitter.
+-- @extends Core.Base#BASE
+RADIO = {
+  ClassName        = "RADIO",
+  FileName         = "",
+  Frequency        = 0,
+  Modulation       = radio.modulation.AM,
+  Subtitle         = "",
+  SubtitleDuration = 0,
+  Power            = 100,
+  Loop             = false,
+  alias            = nil,
+}
+
+--- Create a new RADIO Object. This doesn't broadcast a transmission, though, use @{#RADIO.Broadcast} to actually broadcast.
+-- If you want to create a RADIO, you probably should use @{Wrapper.Positionable#POSITIONABLE.GetRadio}() instead.
+-- @param #RADIO self
+-- @param Wrapper.Positionable#POSITIONABLE Positionable The @{Positionable} that will receive radio capabilities.
+-- @return #RADIO The RADIO object or #nil if Positionable is invalid.
+function RADIO:New(Positionable)
+
+  -- Inherit base
+  local self = BASE:Inherit( self, BASE:New() ) -- Core.Radio#RADIO
+  self:F(Positionable)
+
+  if Positionable:GetPointVec2() then -- It's stupid, but the only way I found to make sure positionable is valid
+    self.Positionable = Positionable
+    return self
+  end
+
+  self:E({error="The passed positionable is invalid, no RADIO created!", positionable=Positionable})
+  return nil
+end
+
+--- Set alias of the transmitter.
+-- @param #RADIO self
+-- @param #string alias Name of the radio transmitter.
+-- @return #RADIO self
+function RADIO:SetAlias(alias)
+  self.alias=tostring(alias)
+  return self
+end
+
+--- Get alias of the transmitter.
+-- @param #RADIO self
+-- @return #string Name of the transmitter.
+function RADIO:GetAlias()
+  return tostring(self.alias)
+end
+
+--- Set the file name for the radio transmission.
+-- @param #RADIO self
+-- @param #string FileName File name of the sound file (i.e. "Noise.ogg")
+-- @return #RADIO self
+function RADIO:SetFileName(FileName)
+  self:F2(FileName)
+
+  if type(FileName) == "string" then
+
+    if FileName:find(".ogg") or FileName:find(".wav") then
+      if not FileName:find("l10n/DEFAULT/") then
+        FileName = "l10n/DEFAULT/" .. FileName
+      end
+
+      self.FileName = FileName
+      return self
+    end
+  end
+
+  self:E({"File name invalid. Maybe something wrong with the extension?", FileName})
+  return self
+end
+
+--- Set the frequency for the radio transmission.
+-- If the transmitting positionable is a unit or group, this also set the command "SetFrequency" with the defined frequency and modulation.
+-- @param #RADIO self
+-- @param #number Frequency Frequency in MHz.
+-- @return #RADIO self
+function RADIO:SetFrequency(Frequency)
+  self:F2(Frequency)
+
+  if type(Frequency) == "number" then
+
+    -- If frequency is in range
+    --if (Frequency >= 30 and Frequency <= 87.995) or (Frequency >= 108 and Frequency <= 173.995) or (Frequency >= 225 and Frequency <= 399.975) then
+
+      -- Convert frequency from MHz to Hz
+      self.Frequency = Frequency * 1000000
+
+      -- If the RADIO is attached to a UNIT or a GROUP, we need to send the DCS Command "SetFrequency" to change the UNIT or GROUP frequency
+      if self.Positionable.ClassName == "UNIT" or self.Positionable.ClassName == "GROUP" then
+
+        local commandSetFrequency={
+          id = "SetFrequency",
+          params = {
+            frequency  = self.Frequency,
+            modulation = self.Modulation,
+          }
+        }
+
+        self:T2(commandSetFrequency)
+        self.Positionable:SetCommand(commandSetFrequency)
+      end
+
+      return self
+    --end
+  end
+
+  self:E({"Frequency is not a number. Frequency unchanged.", Frequency})
+  return self
+end
+
+--- Set AM or FM modulation of the radio transmitter.
+-- @param #RADIO self
+-- @param #number Modulation Modulation is either radio.modulation.AM or radio.modulation.FM.
+-- @return #RADIO self
+function RADIO:SetModulation(Modulation)
+  self:F2(Modulation)
+  if type(Modulation) == "number" then
+    if Modulation == radio.modulation.AM or Modulation == radio.modulation.FM then --TODO Maybe make this future proof if ED decides to add an other modulation ?
+      self.Modulation = Modulation
+      return self
+    end
+  end
+  self:E({"Modulation is invalid. Use DCS's enum radio.modulation. Modulation unchanged.", self.Modulation})
+  return self
+end
+
+--- Check validity of the power passed and sets RADIO.Power
+-- @param #RADIO self
+-- @param #number Power Power in W.
+-- @return #RADIO self
+function RADIO:SetPower(Power)
+  self:F2(Power)
+
+  if type(Power) == "number" then
+    self.Power = math.floor(math.abs(Power)) --TODO Find what is the maximum power allowed by DCS and limit power to that
+  else
+    self:E({"Power is invalid. Power unchanged.", self.Power})
+  end
+
+  return self
+end
+
+--- Set message looping on or off.
+-- @param #RADIO self
+-- @param #boolean Loop If true, message is repeated indefinitely.
+-- @return #RADIO self
+function RADIO:SetLoop(Loop)
+  self:F2(Loop)
+  if type(Loop) == "boolean" then
+    self.Loop = Loop
+    return self
+  end
+  self:E({"Loop is invalid. Loop unchanged.", self.Loop})
+  return self
+end
+
+--- Check validity of the subtitle and the subtitleDuration  passed and sets RADIO.subtitle and RADIO.subtitleDuration
+-- Both parameters are mandatory, since it wouldn't make much sense to change the Subtitle and not its duration
+-- @param #RADIO self
+-- @param #string Subtitle
+-- @param #number SubtitleDuration in s
+-- @return #RADIO self
+-- @usage
+-- -- create the broadcaster and attaches it a RADIO
+-- local MyUnit = UNIT:FindByName("MyUnit")
+-- local MyUnitRadio = MyUnit:GetRadio()
+--
+-- -- add a subtitle for the next transmission, which will be up for 10s
+-- MyUnitRadio:SetSubtitle("My Subtitle, 10)
+function RADIO:SetSubtitle(Subtitle, SubtitleDuration)
+  self:F2({Subtitle, SubtitleDuration})
+  if type(Subtitle) == "string" then
+    self.Subtitle = Subtitle
+  else
+    self.Subtitle = ""
+    self:E({"Subtitle is invalid. Subtitle reset.", self.Subtitle})
+  end
+  if type(SubtitleDuration) == "number" then
+    self.SubtitleDuration = SubtitleDuration
+  else
+    self.SubtitleDuration = 0
+    self:E({"SubtitleDuration is invalid. SubtitleDuration reset.", self.SubtitleDuration})
+  end
+  return self
+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 anything but a UNIT or a GROUP,
+-- but it will work with a UNIT or a GROUP anyway.
+-- Only the #RADIO and the Filename are mandatory
+-- @param #RADIO self
+-- @param #string FileName Name of the sound file that will be transmitted.
+-- @param #number Frequency Frequency in MHz.
+-- @param #number Modulation Modulation of frequency, which is either radio.modulation.AM or radio.modulation.FM.
+-- @param #number Power Power in W.
+-- @return #RADIO self
+function RADIO:NewGenericTransmission(FileName, Frequency, Modulation, Power, Loop)
+  self:F({FileName, Frequency, Modulation, Power})
+
+  self:SetFileName(FileName)
+  if Frequency then self:SetFrequency(Frequency) end
+  if Modulation then self:SetModulation(Modulation) end
+  if Power then self:SetPower(Power) end
+  if Loop then self:SetLoop(Loop) end
+
+  return self
+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}.
+-- Only the RADIO and the Filename are mandatory.
+-- @param #RADIO self
+-- @param #string FileName Name of sound file.
+-- @param #string Subtitle Subtitle to be displayed with sound file.
+-- @param #number SubtitleDuration Duration of subtitle display in seconds.
+-- @param #number Frequency Frequency in MHz.
+-- @param #number Modulation Modulation which can be either radio.modulation.AM or radio.modulation.FM
+-- @param #boolean Loop If true, loop message.
+-- @return #RADIO self
+function RADIO:NewUnitTransmission(FileName, Subtitle, SubtitleDuration, Frequency, Modulation, Loop)
+  self:F({FileName, Subtitle, SubtitleDuration, Frequency, Modulation, Loop})
+
+  -- Set file name.
+  self:SetFileName(FileName)
+
+  -- Set modulation AM/FM.
+  if Modulation then
+    self:SetModulation(Modulation)
+  end
+
+  -- Set frequency.
+  if Frequency then
+    self:SetFrequency(Frequency)
+  end
+
+  -- Set subtitle.
+  if Subtitle then
+    self:SetSubtitle(Subtitle, SubtitleDuration or 0)
+  end
+
+  -- Set Looping.
+  if Loop then
+    self:SetLoop(Loop)
+  end
+
+  return self
+end
+
+--- Broadcast the transmission.
+-- * The Radio has to be populated with the new transmission before broadcasting.
+-- * Please use RADIO setters or either @{#RADIO.NewGenericTransmission} or @{#RADIO.NewUnitTransmission}
+-- * This class is in fact pretty smart, it determines the right DCS function to use depending on the type of POSITIONABLE
+-- * 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
+-- * If your POSITIONABLE is a UNIT or a GROUP, the Power is ignored.
+-- * If your POSITIONABLE is not a UNIT or a GROUP, the Subtitle, SubtitleDuration are ignored
+-- @param #RADIO self
+-- @param #boolean viatrigger Use trigger.action.radioTransmission() in any case, i.e. also for UNITS and GROUPS.
+-- @return #RADIO self
+function RADIO:Broadcast(viatrigger)
+  self:F({viatrigger=viatrigger})
+
+  -- If the POSITIONABLE is actually a UNIT or a GROUP, use the more complicated DCS command system.
+  if (self.Positionable.ClassName=="UNIT" or self.Positionable.ClassName=="GROUP") and (not viatrigger) then
+    self:T("Broadcasting from a UNIT or a GROUP")
+
+    local commandTransmitMessage={
+      id = "TransmitMessage",
+      params = {
+        file = self.FileName,
+        duration = self.SubtitleDuration,
+        subtitle = self.Subtitle,
+        loop = self.Loop,
+      }}
+
+    self:T3(commandTransmitMessage)
+    self.Positionable:SetCommand(commandTransmitMessage)
+  else
+    -- If the POSITIONABLE is anything else, we revert to the general singleton function
+    -- I need to give it a unique name, so that the transmission can be stopped later. I use the class ID
+    self:T("Broadcasting from a POSITIONABLE")
+    trigger.action.radioTransmission(self.FileName, self.Positionable:GetPositionVec3(), self.Modulation, self.Loop, self.Frequency, self.Power, tostring(self.ID))
+  end
+
+  return self
+end
+
+
+
+--- Stops a transmission
+-- This function is especially usefull to stop the broadcast of looped transmissions
+-- @param #RADIO self
+-- @return #RADIO self
+function RADIO:StopBroadcast()
+  self:F()
+  -- If the POSITIONABLE is a UNIT or a GROUP, stop the transmission with the DCS "StopTransmission" command
+  if self.Positionable.ClassName == "UNIT" or self.Positionable.ClassName == "GROUP" then
+
+    local commandStopTransmission={id="StopTransmission", params={}}
+
+    self.Positionable:SetCommand(commandStopTransmission)
+  else
+    -- Else, we use the appropriate singleton funciton
+    trigger.action.stopRadioTransmission(tostring(self.ID))
+  end
+  return self
+end

Moose Development/Moose/Sound/RadioQueue.lua

@@ -1,20 +1,24 @@
---- **Core** - Queues Radio Transmissions.
+--- **Sound** - Queues Radio Transmissions.
 -- 
 -- ===
 -- 
 -- ## Features:
 -- 
---   * Managed Radio Transmissions.
+--   * Manage Radio Transmissions
 --
 -- ===
 --
 -- ### Authors: funkyfranky
 --
--- @module Core.RadioQueue
+-- @module Sound.RadioQueue
 -- @image Core_Radio.JPG
 
 --- Manages radio transmissions.
 -- 
+-- The main goal of the RADIOQUEUE class is to string together multiple sound files to play a complete sentence.
+-- The underlying problem is that radio transmissions in DCS are not queued but played "on top" of each other.
+-- Therefore, to achive the goal, it is vital to know the precise duration how long it takes to play the sound file.
+-- 
 -- @type RADIOQUEUE
 -- @field #string ClassName Name of the class "RADIOQUEUE".
 -- @field #boolean Debugmode Debug mode. More info.
@@ -35,6 +39,7 @@
 -- @field #table numbers Table of number transmission parameters.
 -- @field #boolean checking Scheduler is checking the radio queue. 
 -- @field #boolean schedonce Call ScheduleOnce instead of normal scheduler.
+-- @field Sound.SRS#MSRS msrs Moose SRS class.
 -- @extends Core.Base#BASE
 RADIOQUEUE = {
   ClassName   = "RADIOQUEUE",
@@ -69,12 +74,14 @@ RADIOQUEUE = {
 -- @field #boolean isplaying If true, transmission is currently playing.
 -- @field #number Tplay Mission time (abs) in seconds when the transmission should be played.
 -- @field #number interval Interval in seconds before next transmission.
+-- @field Sound.SoundOutput#SOUNDFILE soundfile Sound file object to play via SRS.
+-- @field Sound.SoundOutput#SOUNDTEXT soundtext Sound TTS object to play via SRS.
 
 
 --- Create a new RADIOQUEUE object for a given radio frequency/modulation.
 -- @param #RADIOQUEUE self
 -- @param #number frequency The radio frequency in MHz.
--- @param #number modulation (Optional) The radio modulation. Default radio.modulation.AM.
+-- @param #number modulation (Optional) The radio modulation. Default `radio.modulation.AM` (=0).
 -- @param #string alias (Optional) Name of the radio queue.
 -- @return #RADIOQUEUE self The RADIOQUEUE object.
 function RADIOQUEUE:New(frequency, modulation, alias)
@@ -125,9 +132,9 @@ function RADIOQUEUE:Start(delay, dt)
 
   -- Start Scheduler.
   if self.schedonce then
-    self:_CheckRadioQueueDelayed(delay)
+    self:_CheckRadioQueueDelayed(self.delay)
   else
-    self.RQid=self.scheduler:Schedule(nil, RADIOQUEUE._CheckRadioQueue, {self}, delay, dt)
+    self.RQid=self.scheduler:Schedule(nil, RADIOQUEUE._CheckRadioQueue, {self}, self.delay, self.dt)
   end
   
   return self
@@ -170,6 +177,17 @@ function RADIOQUEUE:SetRadioPower(power)
   return self
 end
 
+--- Set SRS.
+-- @param #RADIOQUEUE self
+-- @param #string PathToSRS Path to SRS.
+-- @param #number Port SRS port. Default 5002.
+-- @return #RADIOQUEUE self The RADIOQUEUE object.
+function RADIOQUEUE:SetSRS(PathToSRS, Port)
+  self.msrs=MSRS:New(PathToSRS, self.frequency/1000000, self.modulation)
+  self.msrs:SetPort(Port)
+  return self
+end
+
 --- Set parameters of a digit.
 -- @param #RADIOQUEUE self
 -- @param #number digit The digit 0-9.
@@ -202,7 +220,7 @@ end
 --- Add a transmission to the radio queue.
 -- @param #RADIOQUEUE self
 -- @param #RADIOQUEUE.Transmission transmission The transmission data table. 
--- @return #RADIOQUEUE self The RADIOQUEUE object.
+-- @return #RADIOQUEUE self
 function RADIOQUEUE:AddTransmission(transmission)
   self:F({transmission=transmission})
   
@@ -221,7 +239,7 @@ function RADIOQUEUE:AddTransmission(transmission)
   return self
 end
 
---- Add a transmission to the radio queue.
+--- Create a new transmission and add it to the radio queue.
 -- @param #RADIOQUEUE self
 -- @param #string filename Name of the sound file. Usually an ogg or wav file type.
 -- @param #number duration Duration in seconds the file lasts.
@@ -230,7 +248,7 @@ end
 -- @param #number interval Interval in seconds after the last transmission finished.
 -- @param #string subtitle Subtitle of the transmission.
 -- @param #number subduration Duration [sec] of the subtitle being displayed. Default 5 sec.
--- @return #RADIOQUEUE self The RADIOQUEUE object.
+-- @return #RADIOQUEUE.Transmission Radio transmission table.
 function RADIOQUEUE:NewTransmission(filename, duration, path, tstart, interval, subtitle, subduration)
 
   -- Sanity checks.
@@ -269,9 +287,36 @@ function RADIOQUEUE:NewTransmission(filename, duration, path, tstart, interval,
   -- Add transmission to queue.  
   self:AddTransmission(transmission)
   
+  return transmission
+end
+
+--- Add a SOUNDFILE to the radio queue.
+-- @param #RADIOQUEUE self
+-- @param Sound.SoundOutput#SOUNDFILE soundfile Sound file object to be added.
+-- @param #number tstart Start time (abs) seconds. Default now.
+-- @param #number interval Interval in seconds after the last transmission finished.
+-- @return #RADIOQUEUE self
+function RADIOQUEUE:AddSoundFile(soundfile, tstart, interval)
+  --env.info(string.format("FF add soundfile: name=%s%s", soundfile:GetPath(), soundfile:GetFileName()))
+  local transmission=self:NewTransmission(soundfile:GetFileName(), soundfile.duration, soundfile:GetPath(), tstart, interval, soundfile.subtitle, soundfile.subduration)
+  transmission.soundfile=soundfile
   return self
 end
 
+--- Add a SOUNDTEXT to the radio queue.
+-- @param #RADIOQUEUE self
+-- @param Sound.SoundOutput#SOUNDTEXT soundtext Text-to-speech text.
+-- @param #number tstart Start time (abs) seconds. Default now.
+-- @param #number interval Interval in seconds after the last transmission finished.
+-- @return #RADIOQUEUE self
+function RADIOQUEUE:AddSoundText(soundtext, tstart, interval)
+
+  local transmission=self:NewTransmission("SoundText.ogg", soundtext.duration, nil, tstart, interval, soundtext.subtitle, soundtext.subduration)
+  transmission.soundtext=soundtext
+  return self
+end
+
+
 --- Convert a number (as string) into a radio transmission.
 -- E.g. for board number or headings.
 -- @param #RADIOQUEUE self
@@ -281,18 +326,8 @@ end
 -- @return #number Duration of the call in seconds.
 function RADIOQUEUE:Number2Transmission(number, delay, interval)
   
-  --- Split string into characters.
-  local function _split(str)
-    local chars={}
-    for i=1,#str do
-      local c=str:sub(i,i)
-      table.insert(chars, c)
-    end
-    return chars
-  end
-  
   -- Split string into characters.
-  local numbers=_split(number)
+  local numbers=UTILS.GetCharacters(number)
 
   local wait=0    
   for i=1,#numbers do
@@ -325,6 +360,11 @@ end
 -- @param #RADIOQUEUE.Transmission transmission The transmission.
 function RADIOQUEUE:Broadcast(transmission)
 
+  if ((transmission.soundfile and transmission.soundfile.useSRS) or transmission.soundtext) and self.msrs then
+    self:_BroadcastSRS(transmission)
+    return
+  end
+
   -- Get unit sending the transmission.
   local sender=self:_GetRadioSender()
   
@@ -416,6 +456,19 @@ function RADIOQUEUE:Broadcast(transmission)
   end
 end
 
+--- Broadcast radio message.
+-- @param #RADIOQUEUE self
+-- @param #RADIOQUEUE.Transmission transmission The transmission.
+function RADIOQUEUE:_BroadcastSRS(transmission)
+
+  if transmission.soundfile and transmission.soundfile.useSRS then
+    self.msrs:PlaySoundFile(transmission.soundfile)
+  elseif transmission.soundtext then
+    self.msrs:PlaySoundText(transmission.soundtext)
+  end
+
+end
+
 --- Start checking the radio queue.
 -- @param #RADIOQUEUE self
 -- @param #number delay Delay in seconds before checking.
@@ -547,7 +600,7 @@ function RADIOQUEUE:_GetRadioSender()
   return nil
 end
 
---- Get unit from which we want to transmit a radio message. This has to be an aircraft for subtitles to work.
+--- Get unit from which we want to transmit a radio message. This has to be an aircraft or ground unit for subtitles to work.
 -- @param #RADIOQUEUE self
 -- @return DCS#Vec3 Vector 3D.
 function RADIOQUEUE:_GetRadioSenderCoord()

Moose Development/Moose/Sound/RadioSpeech.lua

@@ -11,7 +11,7 @@
 --
 -- ### Authors: FlightControl
 --
--- @module Core.RadioSpeech
+-- @module Sound.RadioSpeech
 -- @image Core_Radio.JPG
 
 --- Makes the radio speak.
@@ -162,12 +162,12 @@ RADIOSPEECH.Vocabulary.RU = {
   ["8000"] = { "8000", 0.92 },
   ["9000"] = { "9000", 0.87 },
 
-  ["степени"] = { "degrees", 0.5 },
+  ["градусы"] = { "degrees", 0.5 },
-  ["километров"] = { "kilometers", 0.65 },
+  ["километры"] = { "kilometers", 0.65 },
   ["km"] = { "kilometers", 0.65 },
-  ["миль"] = { "miles", 0.45 },
+  ["мили"] = { "miles", 0.45 },
   ["mi"] = { "miles", 0.45 },
-  ["метры"] = { "meters", 0.41 },
+  ["метров"] = { "meters", 0.41 },
   ["m"] = { "meters", 0.41 },
   ["ноги"] = { "feet", 0.37 },
 
@@ -175,20 +175,20 @@ RADIOSPEECH.Vocabulary.RU = {
   ["bra"] = { "bra", 0.3 },
 
 
-  ["возвращаясь на базу"] = { "returning_to_base", 1.40 },
+  ["возвращение на базу"] = { "returning_to_base", 1.40 },
   ["на пути к наземной цели"] = { "on_route_to_ground_target", 1.45 },
-  ["перехват самолетов"] = { "intercepting_bogeys", 1.22 },
+  ["перехват боги"] = { "intercepting_bogeys", 1.22 },
   ["поражение наземной цели"] = { "engaging_ground_target", 1.53 },
-  ["захватывающие самолеты"] = { "engaging_bogeys", 1.68 },
+  ["привлечение болотных птиц"] = { "engaging_bogeys", 1.68 },
-  ["колеса вверх"] = { "wheels_up", 0.92 },
+  ["колёса вверх..."] = { "wheels_up", 0.92 },
   ["посадка на базу"] = { "landing at base", 1.04 },
-  ["патрулирующий"] = { "patrolling", 0.96 },
+  ["патрулирование"] = { "patrolling", 0.96 },
 
-  ["за"] = { "for", 0.27 },
+  ["для"] = { "for", 0.27 },
   ["и"] = { "and", 0.17 },
-  ["в"] = { "at", 0.19 },
+  ["на сайте"] = { "at", 0.19 },
-  ["dot"] = { "dot", 0.51 },
+  ["точка"] = { "dot", 0.51 },
-  ["defender"] = { "defender", 0.45 },
+  ["защитник"] = { "defender", 0.45 },
 }
 
 --- Create a new RADIOSPEECH object for a given radio frequency/modulation.

Moose Development/Moose/Sound/SoundOutput.lua

@@ -0,0 +1,412 @@
+--- **Sound** - Sound output classes.
+--
+-- ===
+-- 
+-- ## Features:
+-- 
+--   * Create a SOUNDFILE object (mp3 or ogg) to be played via DCS or SRS transmissions
+--   * Create a SOUNDTEXT object for text-to-speech output vis SRS Simple-Text-To-Speech (STTS)
+-- 
+-- ===
+-- 
+-- ### Author: **funkyfranky**
+-- 
+-- ===
+-- 
+-- There are two classes, SOUNDFILE and SOUNDTEXT, defined in this section that deal with playing
+-- sound files or arbitrary text (via SRS Simple-Text-To-Speech), respectively.
+-- 
+-- The SOUNDFILE and SOUNDTEXT objects can be defined and used in other MOOSE classes.
+-- 
+-- 
+-- @module Sound.SoundOutput
+-- @image Sound_SoundOutput.png
+
+do -- Sound Base
+
+  --- @type SOUNDBASE
+  -- @field #string ClassName Name of the class.
+  -- @extends Core.Base#BASE
+
+
+  --- Basic sound output inherited by other classes suche as SOUNDFILE and SOUNDTEXT.
+  -- 
+  -- This class is **not** meant to be used by "ordinary" users.
+  -- 
+  -- @field #SOUNDBASE
+  SOUNDBASE={
+    ClassName   = "SOUNDBASE",
+  }
+  
+  --- Constructor to create a new SOUNDBASE object.
+  -- @param #SOUNDBASE self
+  -- @return #SOUNDBASE self
+  function SOUNDBASE:New()
+  
+    -- Inherit BASE.
+    local self=BASE:Inherit(self, BASE:New()) -- #SOUNDBASE
+
+    
+
+    return self
+  end
+  
+  --- Function returns estimated speech time in seconds.
+  -- Assumptions for time calc: 100 Words per min, avarage of 5 letters for english word so
+  -- 
+  --   * 5 chars * 100wpm = 500 characters per min = 8.3 chars per second
+  --   
+  -- So lengh of msg / 8.3 = number of seconds needed to read it. rounded down to 8 chars per sec map function:
+  -- 
+  -- * (x - in_min) * (out_max - out_min) / (in_max - in_min) + out_min
+  -- 
+  -- @param #string Text The text string to analyze.
+  -- @param #number Speed Speed factor. Default 1.
+  -- @param #boolean isGoogle If true, google text-to-speech is used.
+  function SOUNDBASE:GetSpeechTime(length,speed,isGoogle)
+  
+    local maxRateRatio = 3 
+  
+    speed = speed or 1.0
+    isGoogle = isGoogle or false
+  
+    local speedFactor = 1.0
+    if isGoogle then
+        speedFactor = speed
+    else
+        if speed ~= 0 then
+            speedFactor = math.abs(speed) * (maxRateRatio - 1) / 10 + 1
+        end
+        if speed < 0 then
+            speedFactor = 1/speedFactor
+        end
+    end
+  
+    -- Words per minute.
+    local wpm = math.ceil(100 * speedFactor)
+    
+    -- Characters per second.
+    local cps = math.floor((wpm * 5)/60)
+  
+    if type(length) == "string" then
+        length = string.len(length)
+    end
+  
+    return math.ceil(length/cps)
+  end  
+  
+end
+
+
+do -- Sound File
+
+  --- @type SOUNDFILE
+  -- @field #string ClassName Name of the class
+  -- @field #string filename Name of the flag.
+  -- @field #string path Directory path, where the sound file is located. This includes the final slash "/".
+  -- @field #string duration Duration of the sound file in seconds.
+  -- @field #string subtitle Subtitle of the transmission.
+  -- @field #number subduration Duration in seconds how long the subtitle is displayed.
+  -- @field #boolean useSRS If true, sound file is played via SRS. Sound file needs to be on local disk not inside the miz file!
+  -- @extends Core.Base#BASE
+
+
+  --- Sound files used by other classes.
+  -- 
+  -- # The SOUNDFILE Concept
+  --   
+  -- A SOUNDFILE object hold the important properties that are necessary to play the sound file, e.g. its file name, path, duration.
+  -- 
+  -- It can be created with the @{#SOUNDFILE.New}(*FileName*, *Path*, *Duration*) function:
+  -- 
+  --     local soundfile=SOUNDFILE:New("My Soundfile.ogg", "Sound File/", 3.5)
+  -- 
+  -- ## SRS
+  -- 
+  -- If sound files are supposed to be played via SRS, you need to use the @{#SOUNDFILE.SetPlayWithSRS}() function.
+  -- 
+  -- # Location/Path
+  -- 
+  -- ## DCS
+  -- 
+  -- DCS can only play sound files that are located inside the mission (.miz) file. In particular, DCS cannot make use of files that are stored on
+  -- your hard drive.
+  -- 
+  -- The default location where sound files are stored in DCS is the directory "l10n/DEFAULT/". This is where sound files are placed, if they are
+  -- added via the mission editor (TRIGGERS-->ACTIONS-->SOUND TO ALL). Note however, that sound files which are not added with a trigger command,
+  -- will be deleted each time the mission is saved! Therefore, this directory is not ideal to be used especially if many sound files are to
+  -- be included since for each file a trigger action needs to be created. Which is cumbersome, to say the least.
+  -- 
+  -- The recommended way is to create a new folder inside the mission (.miz) file (a miz file is essentially zip file and can be opened, e.g., with 7-Zip)
+  -- and to place the sound files in there. Sound files in these folders are not wiped out by DCS on the next save.
+  -- 
+  -- ## SRS
+  -- 
+  -- SRS sound files need to be located on your local drive (not inside the miz). Therefore, you need to specify the full path.
+  -- 
+  -- @field #SOUNDFILE
+  SOUNDFILE={
+    ClassName   = "SOUNDFILE",
+    filename    =  nil,
+    path        = "l10n/DEFAULT/",
+    duration    =    3,
+    subtitle    =   nil,
+    subduration =   0,
+    useSRS      = false,
+  }
+  
+  --- Constructor to create a new SOUNDFILE object.
+  -- @param #SOUNDFILE self
+  -- @param #string FileName The name of the sound file, e.g. "Hello World.ogg".
+  -- @param #string Path The path of the directory, where the sound file is located. Default is "l10n/DEFAULT/" within the miz file.
+  -- @param #number Duration Duration in seconds, how long it takes to play the sound file. Default is 3 seconds.
+  -- @return #SOUNDFILE self
+  function SOUNDFILE:New(FileName, Path, Duration)
+  
+    -- Inherit BASE.
+    local self=BASE:Inherit(self, BASE:New()) -- #SOUNDFILE
+
+    -- Set file name.
+    self:SetFileName(FileName)
+    
+    -- Set path.
+    self:SetPath(Path)
+    
+    -- Set duration.
+    self:SetDuration(Duration)
+    
+    -- Debug info:
+    self:T(string.format("New SOUNDFILE: file name=%s, path=%s", self.filename, self.path))
+
+    return self
+  end
+  
+  --- Set path, where the sound file is located.
+  -- @param #SOUNDFILE self
+  -- @param #string Path Path to the directory, where the sound file is located. In case this is nil, it defaults to the DCS mission temp directory.
+  -- @return #SOUNDFILE self
+  function SOUNDFILE:SetPath(Path)
+    
+    -- Init path.
+    self.path=Path or "l10n/DEFAULT/"
+    
+    if not Path and self.useSRS then -- use path to mission temp dir
+      self.path = os.getenv('TMP') .. "\\DCS\\Mission\\l10n\\DEFAULT"
+    end    
+    
+    -- Remove (back)slashes.
+    local nmax=1000 ; local n=1
+    while (self.path:sub(-1)=="/" or self.path:sub(-1)==[[\]]) and n<=nmax do
+      self.path=self.path:sub(1,#self.path-1)
+      n=n+1
+    end
+    
+    -- Append slash.
+    self.path=self.path.."/"
+          
+    return self
+  end  
+
+  --- Get path of the directory, where the sound file is located.
+  -- @param #SOUNDFILE self
+  -- @return #string Path.
+  function SOUNDFILE:GetPath()
+    local path=self.path or "l10n/DEFAULT/"
+    return path
+  end
+
+  --- Set sound file name. This must be a .ogg or .mp3 file!
+  -- @param #SOUNDFILE self
+  -- @param #string FileName Name of the file. Default is "Hello World.mp3".
+  -- @return #SOUNDFILE self
+  function SOUNDFILE:SetFileName(FileName)
+    --TODO: check that sound file is really .ogg or .mp3
+    self.filename=FileName or "Hello World.mp3"
+    return self
+  end
+
+  --- Get the sound file name.
+  -- @param #SOUNDFILE self
+  -- @return #string Name of the soud file. This does *not* include its path.
+  function SOUNDFILE:GetFileName()    
+    return self.filename
+  end
+
+
+  --- Set duration how long it takes to play the sound file.
+  -- @param #SOUNDFILE self
+  -- @param #string Duration Duration in seconds. Default 3 seconds.
+  -- @return #SOUNDFILE self
+  function SOUNDFILE:SetDuration(Duration)
+    self.duration=Duration or 3
+    return self
+  end  
+
+  --- Get duration how long the sound file takes to play.
+  -- @param #SOUNDFILE self
+  -- @return #number Duration in seconds.
+  function SOUNDFILE:GetDuration()
+    return self.duration or 3
+  end
+
+  --- Get the complete sound file name inlcuding its path.
+  -- @param #SOUNDFILE self
+  -- @return #string Name of the sound file.
+  function SOUNDFILE:GetName()
+    local path=self:GetPath()
+    local filename=self:GetFileName()
+    local name=string.format("%s%s", path, filename)
+    return name
+  end
+  
+  --- Set whether sound files should be played via SRS.
+  -- @param #SOUNDFILE self
+  -- @param #boolean Switch If true or nil, use SRS. If false, use DCS transmission.
+  -- @return #SOUNDFILE self
+  function SOUNDFILE:SetPlayWithSRS(Switch)
+    if Switch==true or Switch==nil then
+      self.useSRS=true
+    else
+      self.useSRS=false
+    end
+    return self
+  end  
+  
+end
+
+do -- Text-To-Speech
+
+  --- @type SOUNDTEXT
+  -- @field #string ClassName Name of the class
+  -- @field #string text Text to speak.
+  -- @field #number duration Duration in seconds.
+  -- @field #string gender Gender: "male", "female".
+  -- @field #string culture Culture, e.g. "en-GB".
+  -- @field #string voice Specific voice to use. Overrules `gender` and `culture` settings.
+  -- @extends Core.Base#BASE
+
+
+  --- Text-to-speech objects for other classes.
+  -- 
+  -- # The SOUNDTEXT Concept
+  -- 
+  -- A SOUNDTEXT object holds all necessary information to play a general text via SRS Simple-Text-To-Speech.
+  -- 
+  -- It can be created with the @{#SOUNDTEXT.New}(*Text*, *Duration*) function.
+  --   
+  --   * @{#SOUNDTEXT.New}(*Text, Duration*): Creates a new SOUNDTEXT object.
+  --
+  -- # Options
+  -- 
+  -- ## Gender
+  -- 
+  -- You can choose a gender ("male" or "femal") with the @{#SOUNDTEXT.SetGender}(*Gender*) function.
+  -- Note that the gender voice needs to be installed on your windows machine for the used culture (see below).
+  -- 
+  -- ## Culture
+  -- 
+  -- You can choose a "culture" (accent) with the @{#SOUNDTEXT.SetCulture}(*Culture*) function, where the default (SRS) culture is "en-GB".
+  -- 
+  -- Other examples for culture are: "en-US" (US accent), "de-DE" (German), "it-IT" (Italian), "ru-RU" (Russian), "zh-CN" (Chinese).
+  -- 
+  -- Note that the chosen culture needs to be installed on your windows machine. 
+  --
+  -- ## Specific Voice
+  -- 
+  -- You can use a specific voice for the transmission with the @{SOUNDTEXT.SetVoice}(*VoiceName*) function. Here are some examples
+  --
+  -- * Name: Microsoft Hazel Desktop, Culture: en-GB,  Gender: Female, Age: Adult, Desc: Microsoft Hazel Desktop - English (Great Britain)
+  -- * Name: Microsoft David Desktop, Culture: en-US,  Gender: Male, Age: Adult, Desc: Microsoft David Desktop - English (United States)
+  -- * Name: Microsoft Zira Desktop, Culture: en-US,  Gender: Female, Age: Adult, Desc: Microsoft Zira Desktop - English (United States)
+  -- * Name: Microsoft Hedda Desktop, Culture: de-DE,  Gender: Female, Age: Adult, Desc: Microsoft Hedda Desktop - German
+  -- * Name: Microsoft Helena Desktop, Culture: es-ES,  Gender: Female, Age: Adult, Desc: Microsoft Helena Desktop - Spanish (Spain)
+  -- * Name: Microsoft Hortense Desktop, Culture: fr-FR,  Gender: Female, Age: Adult, Desc: Microsoft Hortense Desktop - French
+  -- * Name: Microsoft Elsa Desktop, Culture: it-IT,  Gender: Female, Age: Adult, Desc: Microsoft Elsa Desktop - Italian (Italy)
+  -- * Name: Microsoft Irina Desktop, Culture: ru-RU,  Gender: Female, Age: Adult, Desc: Microsoft Irina Desktop - Russian
+  -- * Name: Microsoft Huihui Desktop, Culture: zh-CN,  Gender: Female, Age: Adult, Desc: Microsoft Huihui Desktop - Chinese (Simplified)
+  -- 
+  -- Note that this must be installed on your windos machine. Also note that this overrides any culture and gender settings.
+  -- 
+  -- @field #SOUNDTEXT
+  SOUNDTEXT={
+    ClassName   = "SOUNDTEXT",
+  }
+  
+  --- Constructor to create a new SOUNDTEXT object.
+  -- @param #SOUNDTEXT self
+  -- @param #string Text The text to speak.
+  -- @param #number Duration Duration in seconds, how long it takes to play the text. Default is 3 seconds.
+  -- @return #SOUNDTEXT self
+  function SOUNDTEXT:New(Text, Duration)
+  
+    -- Inherit BASE.
+    local self=BASE:Inherit(self, BASE:New()) -- #SOUNDTEXT
+
+    self:SetText(Text)
+    self:SetDuration(Duration or STTS.getSpeechTime(Text))
+    --self:SetGender()
+    --self:SetCulture()
+    
+    -- Debug info:
+    self:T(string.format("New SOUNDTEXT: text=%s, duration=%.1f sec", self.text, self.duration))
+
+    return self
+  end
+  
+  --- Set text.
+  -- @param #SOUNDTEXT self
+  -- @param #string Text Text to speak. Default "Hello World!".
+  -- @return #SOUNDTEXT self
+  function SOUNDTEXT:SetText(Text)
+    
+    self.text=Text or "Hello World!"
+                  
+    return self
+  end
+  
+  --- Set duration, how long it takes to speak the text.
+  -- @param #SOUNDTEXT self
+  -- @param #number Duration Duration in seconds. Default 3 seconds.
+  -- @return #SOUNDTEXT self
+  function SOUNDTEXT:SetDuration(Duration)
+    
+    self.duration=Duration or 3
+                  
+    return self
+  end    
+  
+  --- Set gender.
+  -- @param #SOUNDTEXT self
+  -- @param #string Gender Gender: "male" or "female" (default).
+  -- @return #SOUNDTEXT self
+  function SOUNDTEXT:SetGender(Gender)
+    
+    self.gender=Gender or "female"
+                  
+    return self
+  end
+  
+  --- Set TTS culture - local for the voice.
+  -- @param #SOUNDTEXT self
+  -- @param #string Culture TTS culture. Default "en-GB".
+  -- @return #SOUNDTEXT self
+  function SOUNDTEXT:SetCulture(Culture)
+    
+    self.culture=Culture or "en-GB"
+                  
+    return self
+  end    
+  
+  --- Set to use a specific voice name.
+  -- See the list from `DCS-SR-ExternalAudio.exe --help` or if using google see [google voices](https://cloud.google.com/text-to-speech/docs/voices).
+  -- @param #SOUNDTEXT self
+  -- @param #string VoiceName Voice name. Note that this will overrule `Gender` and `Culture`.
+  -- @return #SOUNDTEXT self
+  function SOUNDTEXT:SetVoice(VoiceName)
+    
+    self.voice=VoiceName
+                  
+    return self
+  end
+  
+end

Moose Development/Moose/Sound/UserSound.lua

@@ -1,4 +1,4 @@
---- **Core** - Manage user sound.
+--- **Sound** - Manage user sound.
 --
 -- ===
 -- 
@@ -16,7 +16,7 @@
 -- 
 -- ===
 -- 
--- @module Core.UserSound
+-- @module Sound.UserSound
 -- @image Core_Usersound.JPG
 
 do -- UserSound
@@ -40,7 +40,7 @@ do -- UserSound
   -- @param #USERSOUND self
   -- @param #string UserSoundFileName The filename of the usersound.
   -- @return #USERSOUND
-  function USERSOUND:New( UserSoundFileName ) --R2.3
+  function USERSOUND:New( UserSoundFileName ) 
   
     local self = BASE:Inherit( self, BASE:New() ) -- #USERSOUND
 
@@ -58,7 +58,7 @@ do -- UserSound
   --   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
+  function USERSOUND:SetFileName( UserSoundFileName ) 
     
     self.UserSoundFileName = UserSoundFileName
 
@@ -75,7 +75,7 @@ do -- UserSound
   --   local BlueVictory = USERSOUND:New( "BlueVictory.ogg" )
   --   BlueVictory:ToAll() -- Play the sound that Blue has won.
   --   
-  function USERSOUND:ToAll() --R2.3
+  function USERSOUND:ToAll() 
     
     trigger.action.outSound( self.UserSoundFileName )
     
@@ -91,7 +91,7 @@ do -- UserSound
   --   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
+  function USERSOUND:ToCoalition( Coalition ) 
     
     trigger.action.outSoundForCoalition(Coalition, self.UserSoundFileName )
     
@@ -107,7 +107,7 @@ do -- UserSound
   --   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
+  function USERSOUND:ToCountry( Country ) 
     
     trigger.action.outSoundForCountry( Country, self.UserSoundFileName )
     
@@ -123,9 +123,9 @@ do -- UserSound
   -- @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.
+  --   BlueVictory:ToGroup( PlayerGroup ) -- Play the victory sound to the player group.
   --   
-  function USERSOUND:ToGroup( Group, Delay ) --R2.3
+  function USERSOUND:ToGroup( Group, Delay ) 
   
     Delay=Delay or 0
     if Delay>0 then
@@ -137,4 +137,26 @@ do -- UserSound
     return self
   end  
   
+    --- Play the usersound to the given @{Wrapper.Unit}.
+  -- @param #USERSOUND self
+  -- @param Wrapper.Unit#UNIT Unit The @{Wrapper.Unit} to play the usersound to.
+  -- @param #number Delay (Optional) Delay in seconds, before the sound is played. Default 0.
+  -- @return #USERSOUND The usersound instance.
+  -- @usage
+  --   local BlueVictory = USERSOUND:New( "BlueVictory.ogg" )
+  --   local PlayerUnit = UNIT:FindByName( "PlayerUnit" ) -- Search for the active unit named "PlayerUnit", a human player.
+  --   BlueVictory:ToUnit( PlayerUnit ) -- Play the victory sound to the player unit.
+  --   
+  function USERSOUND:ToUnit( Unit, Delay ) 
+  
+    Delay=Delay or 0
+    if Delay>0 then
+      SCHEDULER:New(nil, USERSOUND.ToUnit,{self, Unit}, Delay)      
+    else
+      trigger.action.outSoundForUnit( Unit:GetID(), self.UserSoundFileName )
+    end
+    
+    return self
+  end 
+
 end

Moose Development/Moose/Tasking/CommandCenter.lua

@@ -202,6 +202,7 @@ function COMMANDCENTER:New( CommandCenterPositionable, CommandCenterName )
   self:SetAutoAcceptTasks( true )
   self:SetAutoAssignMethod( COMMANDCENTER.AutoAssignMethods.Distance )
   self:SetFlashStatus( false )
+  self:SetMessageDuration(10)
   
   self:HandleEvent( EVENTS.Birth,
     --- @param #COMMANDCENTER self
@@ -215,7 +216,7 @@ function COMMANDCENTER:New( CommandCenterPositionable, CommandCenterName )
           local MenuReporting = MENU_GROUP:New( EventGroup, "Missions Reports", CommandCenterMenu )
           local MenuMissionsSummary = MENU_GROUP_COMMAND:New( EventGroup, "Missions Status Report", MenuReporting, self.ReportSummary, self, EventGroup )
           local MenuMissionsDetails = MENU_GROUP_COMMAND:New( EventGroup, "Missions Players Report", MenuReporting, self.ReportMissionsPlayers, self, EventGroup )
-          self:ReportSummary( EventGroup )
+          --self:ReportSummary( EventGroup )
           local PlayerUnit = EventData.IniUnit
           for MissionID, Mission in pairs( self:GetMissions() ) do
             local Mission = Mission -- Tasking.Mission#MISSION
@@ -559,9 +560,11 @@ function COMMANDCENTER:SetAutoAssignTasks( AutoAssign )
   self.AutoAssignTasks = AutoAssign or false
   
   if self.AutoAssignTasks == true then
-    self:ScheduleRepeat( 10, 30, 0, nil, self.AssignTasks, self )
+    self.autoAssignTasksScheduleID=self:ScheduleRepeat( 10, 30, 0, nil, self.AssignTasks, self )
   else
-    self:ScheduleStop( self.AssignTasks )
+    self:ScheduleStop()
+    -- FF this is not the schedule ID
+    --self:ScheduleStop( self.AssignTasks )
   end
   
 end
@@ -682,7 +685,7 @@ end
 -- @param #string Message The message text.
 function COMMANDCENTER:MessageToAll( Message )
 
-    self:GetPositionable():MessageToAll( Message, 20, self:GetName() )
+    self:GetPositionable():MessageToAll( Message, self.MessageDuration, self:GetName() )
 
 end
 
@@ -692,7 +695,7 @@ end
 -- @param Wrapper.Group#GROUP MessageGroup The group to receive the message.
 function COMMANDCENTER:MessageToGroup( Message, MessageGroup )
 
-  self:GetPositionable():MessageToGroup( Message, 15, MessageGroup, self:GetShortText() )
+  self:GetPositionable():MessageToGroup( Message, self.MessageDuration, MessageGroup, self:GetShortText() )
 
 end
 
@@ -715,7 +718,7 @@ 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, self.MessageDuration, CCCoalition, self:GetShortText() )
 
 end
 
@@ -795,9 +798,18 @@ end
 
 --- Let the command center flash a report of the status of the subscribed task to a group.
 -- @param #COMMANDCENTER self
+-- @param Flash #boolean
 function COMMANDCENTER:SetFlashStatus( Flash )
   self:F()
 
-  self.FlashStatus = Flash or true
+  self.FlashStatus = Flash and true
-
+end
+
+--- Duration a command center message is shown.
+-- @param #COMMANDCENTER self
+-- @param seconds #number
+function COMMANDCENTER:SetMessageDuration(seconds)
+  self:F()
+
+  self.MessageDuration = 10 or seconds
 end

Moose Development/Moose/Tasking/Mission.lua

@@ -132,7 +132,7 @@ MISSION = {
 -- @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 DCS#coalition.side MissionCoalition Side of the coalition, i.e. and enumerator @{#DCS.coalition.side} corresponding to RED, BLUE or NEUTRAL.
 -- @return #MISSION self
 function MISSION:New( CommandCenter, MissionName, MissionPriority, MissionBriefing, MissionCoalition )
 

Moose Development/Moose/Tasking/Task.lua

@@ -82,7 +82,7 @@
 -- 
 -- ![Mission](../Tasking/Report_Statistics_Progress.JPG)
 -- 
--- A statistic report on the progress of the mission. Each task achievement will increase the %-tage to 100% as a goal to complete the task.
+-- A statistic report on the progress of the mission. Each task achievement will increase the % to 100% as a goal to complete the task.
 -- 
 -- ## 1.3) Join a Task.
 -- 

Moose Development/Moose/Tasking/Task_A2A.lua

@@ -38,7 +38,7 @@ do -- TASK_A2A
   --
   -- @field #TASK_A2A
   TASK_A2A = {
-    ClassName = "TASK_A2A",
+    ClassName = "TASK_A2A"
   }
 
   --- Instantiates a new TASK_A2A.
@@ -60,29 +60,27 @@ do -- TASK_A2A
 
     local Fsm = self:GetUnitProcess()
 
-
     Fsm:AddTransition( "Assigned", "RouteToRendezVous", "RoutingToRendezVous" )
-    Fsm:AddProcess   ( "RoutingToRendezVous", "RouteToRendezVousPoint", ACT_ROUTE_POINT:New(), { Arrived = "ArriveAtRendezVous" } )
+    Fsm:AddProcess( "RoutingToRendezVous", "RouteToRendezVousPoint", ACT_ROUTE_POINT:New(), { Arrived = "ArriveAtRendezVous" } )
-    Fsm:AddProcess   ( "RoutingToRendezVous", "RouteToRendezVousZone", ACT_ROUTE_ZONE:New(), { Arrived = "ArriveAtRendezVous" } )
+    Fsm:AddProcess( "RoutingToRendezVous", "RouteToRendezVousZone", ACT_ROUTE_ZONE:New(), { Arrived = "ArriveAtRendezVous" } )
 
     Fsm:AddTransition( { "Arrived", "RoutingToRendezVous" }, "ArriveAtRendezVous", "ArrivedAtRendezVous" )
 
     Fsm:AddTransition( { "ArrivedAtRendezVous", "HoldingAtRendezVous" }, "Engage", "Engaging" )
     Fsm:AddTransition( { "ArrivedAtRendezVous", "HoldingAtRendezVous" }, "HoldAtRendezVous", "HoldingAtRendezVous" )
 
-    Fsm:AddProcess   ( "Engaging", "Account", ACT_ACCOUNT_DEADS:New(), {} )
+    Fsm:AddProcess( "Engaging", "Account", ACT_ACCOUNT_DEADS:New(), {} )
     Fsm:AddTransition( "Engaging", "RouteToTarget", "Engaging" )
     Fsm:AddProcess( "Engaging", "RouteToTargetZone", ACT_ROUTE_ZONE:New(), {} )
     Fsm:AddProcess( "Engaging", "RouteToTargetPoint", ACT_ROUTE_POINT:New(), {} )
     Fsm:AddTransition( "Engaging", "RouteToTargets", "Engaging" )
 
---    Fsm:AddTransition( "Accounted", "DestroyedAll", "Accounted" )
+    -- Fsm:AddTransition( "Accounted", "DestroyedAll", "Accounted" )
---    Fsm:AddTransition( "Accounted", "Success", "Success" )
+    -- Fsm:AddTransition( "Accounted", "Success", "Success" )
     Fsm:AddTransition( "Rejected", "Reject", "Aborted" )
     Fsm:AddTransition( "Failed", "Fail", "Failed" )
 
-
+    -- @param #FSM_PROCESS self
-    ---- @param #FSM_PROCESS self
     -- @param Wrapper.Unit#UNIT TaskUnit
     -- @param #TASK_CARGO Task
     function Fsm:OnLeaveAssigned( TaskUnit, Task )
@@ -128,7 +126,7 @@ do -- TASK_A2A
     function Fsm:onafterEngage( TaskUnit, Task )
       self:F( { self } )
       self:__Account( 0.1 )
-      self:__RouteToTarget(0.1 )
+      self:__RouteToTarget( 0.1 )
       self:__RouteToTargets( -10 )
     end
 
@@ -177,8 +175,6 @@ do -- TASK_A2A
     self.TargetSetUnit = TargetSetUnit
   end
 
-
-  
   --- @param #TASK_A2A self
   function TASK_A2A:GetPlannedMenuText()
     return self:GetStateString() .. " - " .. self:GetTaskName() .. " ( " .. self.TargetSetUnit:GetUnitTypesText() .. " )"
@@ -188,7 +184,7 @@ do -- TASK_A2A
   -- @param Core.Point#COORDINATE RendezVousCoordinate The Coordinate object referencing to the 2D point where the RendezVous point is located on the map.
   -- @param #number RendezVousRange The RendezVousRange that defines when the player is considered to have arrived at the RendezVous point.
   -- @param Wrapper.Unit#UNIT TaskUnit
-  function TASK_A2A:SetRendezVousCoordinate( RendezVousCoordinate, RendezVousRange, TaskUnit  )
+  function TASK_A2A:SetRendezVousCoordinate( RendezVousCoordinate, RendezVousRange, TaskUnit )
 
     local ProcessUnit = self:GetUnitProcess( TaskUnit )
 
@@ -209,8 +205,6 @@ do -- TASK_A2A
     return ActRouteRendezVous:GetCoordinate(), ActRouteRendezVous:GetRange()
   end
 
-  
-  
   --- @param #TASK_A2A self
   -- @param Core.Zone#ZONE_BASE RendezVousZone The Zone object where the RendezVous is located on the map.
   -- @param Wrapper.Unit#UNIT TaskUnit
@@ -244,7 +238,6 @@ do -- TASK_A2A
     ActRouteTarget:SetCoordinate( TargetCoordinate )
   end
 
-
   --- @param #TASK_A2A self
   -- @param Wrapper.Unit#UNIT TaskUnit
   -- @return Core.Point#COORDINATE The Coordinate object where the Target is located on the map.
@@ -256,7 +249,6 @@ do -- TASK_A2A
     return ActRouteTarget:GetCoordinate()
   end
 
-
   --- @param #TASK_A2A self
   -- @param Core.Zone#ZONE_BASE TargetZone The Zone object where the Target is located on the map.
   -- @param Wrapper.Unit#UNIT TaskUnit
@@ -268,7 +260,6 @@ do -- TASK_A2A
     ActRouteTarget:SetZone( TargetZone, Altitude, Heading )
   end
 
-
   --- @param #TASK_A2A self
   -- @param Wrapper.Unit#UNIT TaskUnit
   -- @return Core.Zone#ZONE_BASE The Zone object where the Target is located on the map.
@@ -293,7 +284,7 @@ do -- TASK_A2A
   --- Return the relative distance to the target vicinity from the player, in order to sort the targets in the reports per distance from the threats.
   -- @param #TASK_A2A self
   function TASK_A2A:ReportOrder( ReportGroup )
-	self:UpdateTaskInfo( self.DetectedItem )
+    self:UpdateTaskInfo( self.DetectedItem )
 
     local Coordinate = self.TaskInfo:GetData( "Coordinate" )
     local Distance = ReportGroup:GetCoordinate():Get2DDistance( Coordinate )
@@ -301,7 +292,6 @@ do -- TASK_A2A
     return Distance
   end
 
-  
   --- This method checks every 10 seconds if the goal has been reached of the task.
   -- @param #TASK_A2A self
   function TASK_A2A:onafterGoal( TaskUnit, From, Event, To )
@@ -314,7 +304,6 @@ do -- TASK_A2A
     self:__Goal( -10 )
   end
 
-
   --- @param #TASK_A2A self
   function TASK_A2A:UpdateTaskInfo( DetectedItem )
 
@@ -360,7 +349,7 @@ do -- TASK_A2A
   -- @param Wrapper.Group#GROUP TaskGroup The player group.
   function TASK_A2A:GetAutoAssignPriority( AutoAssignMethod, CommandCenter, TaskGroup )
 
-    if     AutoAssignMethod == COMMANDCENTER.AutoAssignMethods.Random then
+    if AutoAssignMethod == COMMANDCENTER.AutoAssignMethods.Random then
       return math.random( 1, 9 )
     elseif AutoAssignMethod == COMMANDCENTER.AutoAssignMethods.Distance then
       local Coordinate = self.TaskInfo:GetData( "Coordinate" )
@@ -375,7 +364,6 @@ do -- TASK_A2A
 
 end
 
-
 do -- TASK_A2A_INTERCEPT
 
   --- The TASK_A2A_INTERCEPT class
@@ -384,7 +372,7 @@ do -- TASK_A2A_INTERCEPT
   -- @extends Tasking.Task#TASK
 
   --- Defines an intercept task for a human player to be executed.
-  -- When enemy planes need to be intercepted by human players, use this task type to urgen the players to get out there!
+  -- When enemy planes need to be intercepted by human players, use this task type to urge the players to get out there!
   --
   -- The TASK_A2A_INTERCEPT is used by the @{Tasking.Task_A2A_Dispatcher#TASK_A2A_DISPATCHER} to automatically create intercept tasks
   -- based on detected airborne enemy targets intruding friendly airspace.
@@ -394,11 +382,9 @@ do -- TASK_A2A_INTERCEPT
   --
   -- @field #TASK_A2A_INTERCEPT
   TASK_A2A_INTERCEPT = {
-    ClassName = "TASK_A2A_INTERCEPT",
+    ClassName = "TASK_A2A_INTERCEPT"
   }
 
-
-
   --- Instantiates a new TASK_A2A_INTERCEPT.
   -- @param #TASK_A2A_INTERCEPT self
   -- @param Tasking.Mission#MISSION Mission
@@ -413,15 +399,12 @@ do -- TASK_A2A_INTERCEPT
 
     Mission:AddTask( self )
 
-    self:SetBriefing( 
+    self:SetBriefing( TaskBriefing or "Intercept incoming intruders.\n" )
-      TaskBriefing or 
-      "Intercept incoming intruders.\n"
-    )
 
     return self
   end
 
-  --- Set a score when a target in scope of the A2A attack, has been destroyed .
+  --- Set a score when a target in scope of the A2A attack, has been destroyed.
   -- @param #TASK_A2A_INTERCEPT self
   -- @param #string PlayerName The name of the player.
   -- @param #number Score The score in points to be granted when task process has been achieved.
@@ -469,10 +452,8 @@ do -- TASK_A2A_INTERCEPT
     return self
   end
 
-
 end
 
-
 do -- TASK_A2A_SWEEP
 
   --- The TASK_A2A_SWEEP class
@@ -493,11 +474,9 @@ do -- TASK_A2A_SWEEP
   --
   -- @field #TASK_A2A_SWEEP
   TASK_A2A_SWEEP = {
-    ClassName = "TASK_A2A_SWEEP",
+    ClassName = "TASK_A2A_SWEEP"
   }
 
-
-
   --- Instantiates a new TASK_A2A_SWEEP.
   -- @param #TASK_A2A_SWEEP self
   -- @param Tasking.Mission#MISSION Mission
@@ -512,10 +491,7 @@ do -- TASK_A2A_SWEEP
 
     Mission:AddTask( self )
 
-    self:SetBriefing( 
+    self:SetBriefing( TaskBriefing or "Perform a fighter sweep. Incoming intruders were detected and could be hiding at the location.\n" )
-      TaskBriefing or 
-      "Perform a fighter sweep. Incoming intruders were detected and could be hiding at the location.\n"
-    )
 
     return self
   end
@@ -531,7 +507,7 @@ do -- TASK_A2A_SWEEP
     self:__Goal( -10 )
   end
 
-  --- Set a score when a target in scope of the A2A attack, has been destroyed .
+  --- Set a score when a target in scope of the A2A attack, has been destroyed.
   -- @param #TASK_A2A_SWEEP self
   -- @param #string PlayerName The name of the player.
   -- @param #number Score The score in points to be granted when task process has been achieved.
@@ -581,7 +557,6 @@ do -- TASK_A2A_SWEEP
 
 end
 
-
 do -- TASK_A2A_ENGAGE
 
   --- The TASK_A2A_ENGAGE class
@@ -600,11 +575,9 @@ do -- TASK_A2A_ENGAGE
   --
   -- @field #TASK_A2A_ENGAGE
   TASK_A2A_ENGAGE = {
-    ClassName = "TASK_A2A_ENGAGE",
+    ClassName = "TASK_A2A_ENGAGE"
   }
 
-
-
   --- Instantiates a new TASK_A2A_ENGAGE.
   -- @param #TASK_A2A_ENGAGE self
   -- @param Tasking.Mission#MISSION Mission
@@ -619,10 +592,7 @@ do -- TASK_A2A_ENGAGE
 
     Mission:AddTask( self )
 
-    self:SetBriefing( 
+    self:SetBriefing( TaskBriefing or "Bogeys are nearby! Players close by are ordered to ENGAGE the intruders!\n" )
-      TaskBriefing or 
-      "Bogeys are nearby! Players close by are ordered to ENGAGE the intruders!\n"
-    )
 
     return self
   end

Moose Development/Moose/Tasking/Task_A2A_Dispatcher.lua

@@ -108,7 +108,7 @@ do -- TASK_A2A_DISPATCHER
   -- The above example creates a SET_GROUP instance, and stores this in the variable (object) **EWRSet**.
   -- **EWRSet** is then being configured to filter all active groups with a group name starting with **EWR** to be included in the Set.
   -- **EWRSet** is then being ordered to start the dynamic filtering. Note that any destroy or new spawn of a group with the above names will be removed or added to the Set.
-  -- Then a new **EWRDetection** object is created from the class DETECTION_AREAS. A grouping radius of 6000 is choosen, which is 6km.
+  -- Then a new **EWRDetection** object is created from the class DETECTION_AREAS. A grouping radius of 6000 is chosen, which is 6 km.
   -- The **EWRDetection** object is then passed to the @{#TASK_A2A_DISPATCHER.New}() method to indicate the EWR network configuration and setup the A2A tasking and detection mechanism.
   --
   -- ### 2. Define the detected **target grouping radius**:
@@ -185,7 +185,6 @@ do -- TASK_A2A_DISPATCHER
     SweepZones = {},
   }
 
-  
   --- TASK_A2A_DISPATCHER constructor.
   -- @param #TASK_A2A_DISPATCHER self
   -- @param Tasking.Mission#MISSION Mission The mission for which the task dispatching is done.
@@ -208,7 +207,6 @@ do -- TASK_A2A_DISPATCHER
 
     self:AddTransition( "Started", "Assign", "Started" )
 
-    
     --- OnAfter Transition Handler for Event Assign.
     -- @function [parent=#TASK_A2A_DISPATCHER] OnAfterAssign
     -- @param #TASK_A2A_DISPATCHER self
@@ -224,7 +222,6 @@ do -- TASK_A2A_DISPATCHER
     return self
   end
 
-
   --- Define the radius to when an ENGAGE task will be generated for any nearby by airborne friendlies, which are executing cap or returning from an intercept mission.
   -- So, if there is a target area detected and reported,
   -- then any friendlies that are airborne near this target area,
@@ -257,7 +254,7 @@ do -- TASK_A2A_DISPATCHER
   -- @param #TASK_A2A_DISPATCHER self
   -- @param #boolean onoff Set messages on (true) or off (false)
   function TASK_A2A_DISPATCHER:SetSendMessages( onoff )
-      self.FlashNewTask = onoff
+    self.FlashNewTask = onoff
   end
 
   --- Creates an INTERCEPT task when there are targets for it.
@@ -286,7 +283,6 @@ do -- TASK_A2A_DISPATCHER
     return nil
   end
 
-  
   --- Creates an SWEEP task when there are targets for it.
   -- @param #TASK_A2A_DISPATCHER self
   -- @param Functional.Detection#DETECTION_BASE.DetectedItem DetectedItem
@@ -296,8 +292,7 @@ do -- TASK_A2A_DISPATCHER
     self:F( { DetectedItem.ItemID } )
 
     local DetectedSet = DetectedItem.Set
-    local DetectedZone = DetectedItem.Zone
+    local DetectedZone = DetectedItem.Zone -- TODO: This seems unused, remove?
-
 
     if DetectedItem.IsDetected == false then
 
@@ -312,7 +307,6 @@ do -- TASK_A2A_DISPATCHER
     return nil
   end
 
-  
   --- Creates an ENGAGE task when there are human friendlies airborne near the targets.
   -- @param #TASK_A2A_DISPATCHER self
   -- @param Functional.Detection#DETECTION_BASE.DetectedItem DetectedItem
@@ -322,11 +316,10 @@ do -- TASK_A2A_DISPATCHER
     self:F( { DetectedItem.ItemID } )
 
     local DetectedSet = DetectedItem.Set
-    local DetectedZone = DetectedItem.Zone
+    local DetectedZone = DetectedItem.Zone -- TODO: This seems unused, remove?
 
     local PlayersCount, PlayersReport = self:GetPlayerFriendliesNearBy( DetectedItem )
 
-    
     -- Only allow ENGAGE when there are Players near the zone, and when the Area has detected items since the last run in a 60 seconds time zone.
     if PlayersCount > 0 and DetectedItem.IsDetected == true then
 
@@ -341,9 +334,6 @@ do -- TASK_A2A_DISPATCHER
     return nil
   end
 
-
-
-  
   --- Evaluates the removal of the Task from the Mission.
   -- Can only occur when the DetectedItem is Changed AND the state of the Task is "Planned".
   -- @param #TASK_A2A_DISPATCHER self
@@ -388,8 +378,8 @@ do -- TASK_A2A_DISPATCHER
         end
 
         local DetectedSet = DetectedItem.Set -- Core.Set#SET_UNIT
-        --DetectedSet:Flush( self )
+        -- DetectedSet:Flush( self )
-        --self:F( { DetectedSetCount = DetectedSet:Count() } )
+        -- self:F( { DetectedSetCount = DetectedSet:Count() } )
         if DetectedSet:Count() == 0 then
           Remove = true
         end
@@ -423,7 +413,7 @@ do -- TASK_A2A_DISPATCHER
           local FriendlyUnitThreatLevel = FriendlyUnit:GetThreatLevel()
           FriendliesCount = FriendliesCount + 1
           local FriendlyType = FriendlyUnit:GetTypeName()
-          FriendlyTypes[FriendlyType] = FriendlyTypes[FriendlyType] and ( FriendlyTypes[FriendlyType] + 1 ) or 1
+          FriendlyTypes[FriendlyType] = FriendlyTypes[FriendlyType] and (FriendlyTypes[FriendlyType] + 1) or 1
           if DetectedTreatLevel < FriendlyUnitThreatLevel + 2 then
           end
         end
@@ -431,19 +421,18 @@ do -- TASK_A2A_DISPATCHER
 
     end
 
-    --self:F( { FriendliesCount = FriendliesCount } )
+    -- self:F( { FriendliesCount = FriendliesCount } )
 
     local FriendlyTypesReport = REPORT:New()
 
     if FriendliesCount > 0 then
       for FriendlyType, FriendlyTypeCount in pairs( FriendlyTypes ) do
-        FriendlyTypesReport:Add( string.format("%d of %s", FriendlyTypeCount, FriendlyType ) )
+        FriendlyTypesReport:Add( string.format( "%d of %s", FriendlyTypeCount, FriendlyType ) )
       end
     else
       FriendlyTypesReport:Add( "-" )
     end
 
-    
     return FriendliesCount, FriendlyTypesReport
   end
 
@@ -464,7 +453,7 @@ do -- TASK_A2A_DISPATCHER
       for PlayerUnitName, PlayerUnitData in pairs( PlayersNearBy ) do
         local PlayerUnit = PlayerUnitData -- Wrapper.Unit#UNIT
         local PlayerName = PlayerUnit:GetPlayerName()
-        --self:F( { PlayerName = PlayerName, PlayerUnit = PlayerUnit } )
+        -- self:F( { PlayerName = PlayerName, PlayerUnit = PlayerUnit } )
         if PlayerUnit:IsAirPlane() and PlayerName ~= nil then
           local FriendlyUnitThreatLevel = PlayerUnit:GetThreatLevel()
           PlayersCount = PlayersCount + 1
@@ -481,13 +470,12 @@ do -- TASK_A2A_DISPATCHER
 
     if PlayersCount > 0 then
       for PlayerName, PlayerType in pairs( PlayerTypes ) do
-        PlayerTypesReport:Add( string.format('"%s" in %s', PlayerName, PlayerType ) )
+        PlayerTypesReport:Add( string.format( '"%s" in %s', PlayerName, PlayerType ) )
       end
     else
       PlayerTypesReport:Add( "-" )
     end
 
-    
     return PlayersCount, PlayerTypesReport
   end
 
@@ -496,7 +484,6 @@ do -- TASK_A2A_DISPATCHER
     self.Tasks[TaskIndex] = nil
   end
 
-
   --- Assigns tasks in relation to the detected items to the @{Core.Set#SET_GROUP}.
   -- @param #TASK_A2A_DISPATCHER self
   -- @param Functional.Detection#DETECTION_BASE Detection The detection created by the @{Functional.Detection#DETECTION_BASE} derived object.
@@ -536,8 +523,8 @@ do -- TASK_A2A_DISPATCHER
         local DetectedSet = DetectedItem.Set -- Core.Set#SET_UNIT
         local DetectedCount = DetectedSet:Count()
         local DetectedZone = DetectedItem.Zone
-        --self:F( { "Targets in DetectedItem", DetectedItem.ItemID, DetectedSet:Count(), tostring( DetectedItem ) } )
+        -- self:F( { "Targets in DetectedItem", DetectedItem.ItemID, DetectedSet:Count(), tostring( DetectedItem ) } )
-        --DetectedSet:Flush( self )
+        -- DetectedSet:Flush( self )
 
         local DetectedID = DetectedItem.ID
         local TaskIndex = DetectedItem.Index
@@ -593,7 +580,7 @@ do -- TASK_A2A_DISPATCHER
 
             TaskReport:Add( Task:GetName() )
           else
-            self:F("This should not happen")
+            self:F( "This should not happen" )
           end
 
         end
@@ -612,10 +599,10 @@ do -- TASK_A2A_DISPATCHER
       -- TODO set menus using the HQ coordinator
       Mission:GetCommandCenter():SetMenu()
 
-      local TaskText = TaskReport:Text(", ")
+      local TaskText = TaskReport:Text( ", " )
 
       for TaskGroupID, TaskGroup in pairs( self.SetGroup:GetSet() ) do
-        if ( not Mission:IsGroupAssigned(TaskGroup) ) and TaskText ~= "" and (self.FlashNewTask) then
+        if (not Mission:IsGroupAssigned( TaskGroup )) and TaskText ~= "" and (self.FlashNewTask) then
           Mission:GetCommandCenter():MessageToGroup( string.format( "%s has tasks %s. Subscribe to a task using the radio menu.", Mission:GetShortText(), TaskText ), TaskGroup )
         end
       end

Moose Development/Moose/Tasking/Task_A2G.lua

@@ -38,7 +38,7 @@ do -- TASK_A2G
   --
   -- @field #TASK_A2G
   TASK_A2G = {
-    ClassName = "TASK_A2G",
+    ClassName = "TASK_A2G"
   }
 
   --- Instantiates a new TASK_A2G.
@@ -61,27 +61,25 @@ do -- TASK_A2G
     local Fsm = self:GetUnitProcess()
 
     Fsm:AddTransition( "Assigned", "RouteToRendezVous", "RoutingToRendezVous" )
-    Fsm:AddProcess   ( "RoutingToRendezVous", "RouteToRendezVousPoint", ACT_ROUTE_POINT:New(), { Arrived = "ArriveAtRendezVous" } )
+    Fsm:AddProcess( "RoutingToRendezVous", "RouteToRendezVousPoint", ACT_ROUTE_POINT:New(), { Arrived = "ArriveAtRendezVous" } )
-    Fsm:AddProcess   ( "RoutingToRendezVous", "RouteToRendezVousZone", ACT_ROUTE_ZONE:New(), { Arrived = "ArriveAtRendezVous" } )
+    Fsm:AddProcess( "RoutingToRendezVous", "RouteToRendezVousZone", ACT_ROUTE_ZONE:New(), { Arrived = "ArriveAtRendezVous" } )
 
     Fsm:AddTransition( { "Arrived", "RoutingToRendezVous" }, "ArriveAtRendezVous", "ArrivedAtRendezVous" )
 
     Fsm:AddTransition( { "ArrivedAtRendezVous", "HoldingAtRendezVous" }, "Engage", "Engaging" )
     Fsm:AddTransition( { "ArrivedAtRendezVous", "HoldingAtRendezVous" }, "HoldAtRendezVous", "HoldingAtRendezVous" )
 
-    Fsm:AddProcess   ( "Engaging", "Account", ACT_ACCOUNT_DEADS:New(), {} )
+    Fsm:AddProcess( "Engaging", "Account", ACT_ACCOUNT_DEADS:New(), {} )
     Fsm:AddTransition( "Engaging", "RouteToTarget", "Engaging" )
     Fsm:AddProcess( "Engaging", "RouteToTargetZone", ACT_ROUTE_ZONE:New(), {} )
     Fsm:AddProcess( "Engaging", "RouteToTargetPoint", ACT_ROUTE_POINT:New(), {} )
     Fsm:AddTransition( "Engaging", "RouteToTargets", "Engaging" )
 
-    --Fsm:AddTransition( "Accounted", "DestroyedAll", "Accounted" )
+    -- Fsm:AddTransition( "Accounted", "DestroyedAll", "Accounted" )
-    --Fsm:AddTransition( "Accounted", "Success", "Success" )
+    -- Fsm:AddTransition( "Accounted", "Success", "Success" )
     Fsm:AddTransition( "Rejected", "Reject", "Aborted" )
     Fsm:AddTransition( "Failed", "Fail", "Failed" )
 
-
-
     --- Test
     -- @param #FSM_PROCESS self
     -- @param Wrapper.Unit#UNIT TaskUnit
@@ -130,7 +128,7 @@ do -- TASK_A2G
     function Fsm:onafterEngage( TaskUnit, Task )
       self:F( { self } )
       self:__Account( 0.1 )
-      self:__RouteToTarget(0.1 )
+      self:__RouteToTarget( 0.1 )
       self:__RouteToTargets( -10 )
     end
 
@@ -179,8 +177,6 @@ do -- TASK_A2G
     self.TargetSetUnit = TargetSetUnit
   end
 
-
-  
   --- @param #TASK_A2G self
   function TASK_A2G:GetPlannedMenuText()
     return self:GetStateString() .. " - " .. self:GetTaskName() .. " ( " .. self.TargetSetUnit:GetUnitTypesText() .. " )"
@@ -190,7 +186,7 @@ do -- TASK_A2G
   -- @param Core.Point#COORDINATE RendezVousCoordinate The Coordinate object referencing to the 2D point where the RendezVous point is located on the map.
   -- @param #number RendezVousRange The RendezVousRange that defines when the player is considered to have arrived at the RendezVous point.
   -- @param Wrapper.Unit#UNIT TaskUnit
-  function TASK_A2G:SetRendezVousCoordinate( RendezVousCoordinate, RendezVousRange, TaskUnit  )
+  function TASK_A2G:SetRendezVousCoordinate( RendezVousCoordinate, RendezVousRange, TaskUnit )
 
     local ProcessUnit = self:GetUnitProcess( TaskUnit )
 
@@ -211,8 +207,6 @@ do -- TASK_A2G
     return ActRouteRendezVous:GetCoordinate(), ActRouteRendezVous:GetRange()
   end
 
-  
-  
   --- @param #TASK_A2G self
   -- @param Core.Zone#ZONE_BASE RendezVousZone The Zone object where the RendezVous is located on the map.
   -- @param Wrapper.Unit#UNIT TaskUnit
@@ -246,7 +240,6 @@ do -- TASK_A2G
     ActRouteTarget:SetCoordinate( TargetCoordinate )
   end
 
-
   --- @param #TASK_A2G self
   -- @param Wrapper.Unit#UNIT TaskUnit
   -- @return Core.Point#COORDINATE The Coordinate object where the Target is located on the map.
@@ -258,7 +251,6 @@ do -- TASK_A2G
     return ActRouteTarget:GetCoordinate()
   end
 
-
   --- @param #TASK_A2G self
   -- @param Core.Zone#ZONE_BASE TargetZone The Zone object where the Target is located on the map.
   -- @param Wrapper.Unit#UNIT TaskUnit
@@ -270,7 +262,6 @@ do -- TASK_A2G
     ActRouteTarget:SetZone( TargetZone )
   end
 
-
   --- @param #TASK_A2G self
   -- @param Wrapper.Unit#UNIT TaskUnit
   -- @return Core.Zone#ZONE_BASE The Zone object where the Target is located on the map.
@@ -295,7 +286,7 @@ do -- TASK_A2G
   --- Return the relative distance to the target vicinity from the player, in order to sort the targets in the reports per distance from the threats.
   -- @param #TASK_A2G self
   function TASK_A2G:ReportOrder( ReportGroup )
-	self:UpdateTaskInfo( self.DetectedItem )
+    self:UpdateTaskInfo( self.DetectedItem )
 
     local Coordinate = self.TaskInfo:GetData( "Coordinate" )
     local Distance = ReportGroup:GetCoordinate():Get2DDistance( Coordinate )
@@ -303,7 +294,6 @@ do -- TASK_A2G
     return Distance
   end
 
-  
   --- This method checks every 10 seconds if the goal has been reached of the task.
   -- @param #TASK_A2G self
   function TASK_A2G:onafterGoal( TaskUnit, From, Event, To )
@@ -365,12 +355,12 @@ do -- TASK_A2G
   -- @param Wrapper.Group#GROUP TaskGroup The player group.
   function TASK_A2G:GetAutoAssignPriority( AutoAssignMethod, CommandCenter, TaskGroup )
 
-    if     AutoAssignMethod == COMMANDCENTER.AutoAssignMethods.Random then
+    if AutoAssignMethod == COMMANDCENTER.AutoAssignMethods.Random then
       return math.random( 1, 9 )
     elseif AutoAssignMethod == COMMANDCENTER.AutoAssignMethods.Distance then
       local Coordinate = self.TaskInfo:GetData( "Coordinate" )
       local Distance = Coordinate:Get2DDistance( CommandCenter:GetPositionable():GetCoordinate() )
-      self:F({Distance=Distance})
+      self:F( { Distance = Distance } )
       return math.floor( Distance )
     elseif AutoAssignMethod == COMMANDCENTER.AutoAssignMethods.Priority then
       return 1
@@ -381,7 +371,6 @@ do -- TASK_A2G
 
 end
 
-
 do -- TASK_A2G_SEAD
 
   --- The TASK_A2G_SEAD class
@@ -397,7 +386,7 @@ do -- TASK_A2G_SEAD
   -- 
   -- @field #TASK_A2G_SEAD
   TASK_A2G_SEAD = {
-    ClassName = "TASK_A2G_SEAD",
+    ClassName = "TASK_A2G_SEAD"
   }
 
   --- Instantiates a new TASK_A2G_SEAD.
@@ -408,16 +397,13 @@ do -- TASK_A2G_SEAD
   -- @param Core.Set#SET_UNIT TargetSetUnit 
   -- @param #string TaskBriefing The briefing of the task.
   -- @return #TASK_A2G_SEAD self
-  function TASK_A2G_SEAD:New( Mission, SetGroup, TaskName, TargetSetUnit, TaskBriefing)
+  function TASK_A2G_SEAD:New( Mission, SetGroup, TaskName, TargetSetUnit, TaskBriefing )
     local self = BASE:Inherit( self, TASK_A2G:New( Mission, SetGroup, TaskName, TargetSetUnit, "SEAD", TaskBriefing ) ) -- #TASK_A2G_SEAD
     self:F()
 
     Mission:AddTask( self )
 
-    self:SetBriefing( 
+    self:SetBriefing( TaskBriefing or "Execute a Suppression of Enemy Air Defenses." )
-      TaskBriefing or 
-      "Execute a Suppression of Enemy Air Defenses." 
-    )
 
     return self
   end
@@ -470,7 +456,6 @@ do -- TASK_A2G_SEAD
     return self
   end
 
-
 end
 
 do -- TASK_A2G_BAI
@@ -488,9 +473,7 @@ do -- TASK_A2G_BAI
   -- based on detected enemy ground targets.
   -- 
   -- @field #TASK_A2G_BAI
-  TASK_A2G_BAI = {
+  TASK_A2G_BAI = { ClassName = "TASK_A2G_BAI" }
-    ClassName = "TASK_A2G_BAI",
-  }
 
   --- Instantiates a new TASK_A2G_BAI.
   -- @param #TASK_A2G_BAI self
@@ -506,10 +489,7 @@ do -- TASK_A2G_BAI
 
     Mission:AddTask( self )
 
-    self:SetBriefing( 
+    self:SetBriefing( TaskBriefing or "Execute a Battlefield Air Interdiction of a group of enemy targets." )
-      TaskBriefing or 
-      "Execute a Battlefield Air Interdiction of a group of enemy targets."
-    )
 
     return self
   end
@@ -564,9 +544,6 @@ do -- TASK_A2G_BAI
 
 end
 
-
-
-
 do -- TASK_A2G_CAS
 
   --- The TASK_A2G_CAS class
@@ -581,9 +558,7 @@ do -- TASK_A2G_CAS
   -- based on detected enemy ground targets.
   -- 
   -- @field #TASK_A2G_CAS
-  TASK_A2G_CAS = {
+  TASK_A2G_CAS = { ClassName = "TASK_A2G_CAS" }
-    ClassName = "TASK_A2G_CAS",
-  }
 
   --- Instantiates a new TASK_A2G_CAS.
   -- @param #TASK_A2G_CAS self
@@ -599,17 +574,11 @@ do -- TASK_A2G_CAS
 
     Mission:AddTask( self )
 
-    self:SetBriefing( 
+    self:SetBriefing( TaskBriefing or ( "Execute a Close Air Support for a group of enemy targets. " .. "Beware of friendlies at the vicinity! " ) )
-      TaskBriefing or 
-      "Execute a Close Air Support for a group of enemy targets. " ..
-      "Beware of friendlies at the vicinity! "
-    )
-
 
     return self
   end
 
-
   --- Set a score when a target in scope of the A2G attack, has been destroyed .
   -- @param #TASK_A2G_CAS self
   -- @param #string PlayerName The name of the player.
@@ -658,5 +627,4 @@ do -- TASK_A2G_CAS
     return self
   end
 
-
 end

Moose Development/Moose/Tasking/Task_A2G_Dispatcher.lua

@@ -6,11 +6,12 @@
 --   * Dynamically change the tasks as the tactical situation evolves during the mission.
 --   * Dynamically assign (CAS) Close Air Support tasks for human players.
 --   * Dynamically assign (BAI) Battlefield Air Interdiction tasks for human players.
---   * Dynamically assign (SEAD) Supression of Enemy Air Defense tasks for human players to eliminate G2A missile threats.
+--   * Dynamically assign (SEAD) Suppression of Enemy Air Defense tasks for human players to eliminate G2A missile threats.
 --   * Define and use an EWR (Early Warning Radar) network.
 --   * Define different ranges to engage upon intruders.
 --   * Keep task achievements.
---   * Score task achievements.-- 
+--   * Score task achievements.
+--
 -- ===
 --
 -- ### Author: **FlightControl**
@@ -122,7 +123,7 @@ do -- TASK_A2G_DISPATCHER
   --      F1. Command Center [Lima]
   --        F1. Mission "Overlord (High)"
   --
-  -- Command Center [Gori] is controlling Mission "Alpha", "Beta", "Gamma".  Alpha is the Primary mission, Beta the Secondary and there is a Tacical mission Gamma.
+  -- Command Center [Gori] is controlling Mission "Alpha", "Beta", "Gamma".  Alpha is the Primary mission, Beta the Secondary and there is a Tactical mission Gamma.
   -- Command Center [Lima] is controlling Missions "Overlord", which needs to be executed with High priority.
   --
   -- ## 1.1. Mission Menu (Under the Command Center Menu)
@@ -196,7 +197,7 @@ do -- TASK_A2G_DISPATCHER
   --
   -- The Mission Reports Menu is a sub menu, that provides options to retrieve further information on the current Mission:
   --
-  --   - **Report Mission Progress**: Shows the progress of the current Mission. Each Task has a %-tage of completion.
+  --   - **Report Mission Progress**: Shows the progress of the current Mission. Each Task has a % of completion.
   --   - **Report Players per Task**: Show which players are engaged on which Task within the Mission.
   --
   -- For CC |Gori|, Mission "Alpha", the Mission Reports menu structure could look like this:
@@ -264,7 +265,6 @@ do -- TASK_A2G_DISPATCHER
   --
   -- **The F5. Assigned Task __TaskName__ allows the player to control the current Assigned Task and take further actions.**
   --
-  -- 
   -- ## 1.3. Join Planned Task Menu
   --
   -- The Join Planned Task Menu contains the different Planned A2G Tasks **in a structured Menu Hierarchy**.
@@ -388,7 +388,7 @@ do -- TASK_A2G_DISPATCHER
   --   - A @{Mission} object. Each task belongs to a Mission.
   --   - A @{Detection} object. There are several detection grouping methods to choose from.
   --   - A @{Task_A2G_Dispatcher} object. The master A2G task dispatcher.
-  --   - A @{Set} of @{Wrapper.Group} objects that will detect the emeny, the RecceSet. This is attached to the @{Detection} object.
+  --   - A @{Set} of @{Wrapper.Group} objects that will detect the enemy, the RecceSet. This is attached to the @{Detection} object.
   --   - A @{Set} ob @{Wrapper.Group} objects that will attack the enemy, the AttackSet. This is attached to the @{Task_A2G_Dispatcher} object.
   --
   -- Below an example mission declaration that is defines a Task A2G Dispatcher object.
@@ -425,7 +425,7 @@ do -- TASK_A2G_DISPATCHER
   --
   --     -- Now we have everything to setup the main A2G TaskDispatcher.
   --     TaskDispatcher = TASK_A2G_DISPATCHER
-  --       :New( Mission, AttackSet, DetectionAreas ) -- We assign the TaskDispatcher under Mission. The AttackSet will engage the enemy and will recieve the dispatched Tasks. The DetectionAreas will report any detected enemies to the TaskDispatcher.
+  --       :New( Mission, AttackSet, DetectionAreas ) -- We assign the TaskDispatcher under Mission. The AttackSet will engage the enemy and will receive the dispatched Tasks. The DetectionAreas will report any detected enemies to the TaskDispatcher.
   --
   --
   --
@@ -434,10 +434,9 @@ do -- TASK_A2G_DISPATCHER
     ClassName = "TASK_A2G_DISPATCHER",
     Mission = nil,
     Detection = nil,
-    Tasks = {},
+    Tasks = {}
   }
 
-  
   --- TASK_A2G_DISPATCHER constructor.
   -- @param #TASK_A2G_DISPATCHER self
   -- @param Tasking.Mission#MISSION Mission The mission for which the task dispatching is done.
@@ -451,7 +450,7 @@ do -- TASK_A2G_DISPATCHER
 
     self.Detection = Detection
     self.Mission = Mission
-    self.FlashNewTask = true --set to false to suppress flash messages
+    self.FlashNewTask = true -- set to false to suppress flash messages
 
     self.Detection:FilterCategories( { Unit.Category.GROUND_UNIT } )
 
@@ -472,11 +471,11 @@ do -- TASK_A2G_DISPATCHER
     return self
   end
 
-    --- Set flashing player messages on or off
+  --- Set flashing player messages on or off
   -- @param #TASK_A2G_DISPATCHER self
   -- @param #boolean onoff Set messages on (true) or off (false)
   function TASK_A2G_DISPATCHER:SetSendMessages( onoff )
-      self.FlashNewTask = onoff
+    self.FlashNewTask = onoff
   end
 
   --- Creates a SEAD task when there are targets for it.
@@ -518,7 +517,6 @@ do -- TASK_A2G_DISPATCHER
     local DetectedSet = DetectedItem.Set
     local DetectedZone = DetectedItem.Zone
 
-
     -- Determine if the set has ground units.
     -- There should be ground unit friendlies nearby. Airborne units are valid friendlies types.
     -- And there shouldn't be any radar.
@@ -550,7 +548,6 @@ do -- TASK_A2G_DISPATCHER
     local DetectedSet = DetectedItem.Set
     local DetectedZone = DetectedItem.Zone
 
-
     -- Determine if the set has ground units.
     -- There shouldn't be any ground unit friendlies nearby.
     -- And there shouldn't be any radar.
@@ -571,7 +568,6 @@ do -- TASK_A2G_DISPATCHER
     return nil
   end
 
-  
   function TASK_A2G_DISPATCHER:RemoveTask( TaskIndex )
     self.Mission:RemoveTask( self.Tasks[TaskIndex] )
     self.Tasks[TaskIndex] = nil
@@ -588,8 +584,8 @@ do -- TASK_A2G_DISPATCHER
   function TASK_A2G_DISPATCHER:EvaluateRemoveTask( Mission, Task, TaskIndex, DetectedItemChanged )
 
     if Task then
-      if ( Task:IsStatePlanned() and DetectedItemChanged == true ) or Task:IsStateCancelled() then
+      if (Task:IsStatePlanned() and DetectedItemChanged == true) or Task:IsStateCancelled() then
-        --self:F( "Removing Tasking: " .. Task:GetTaskName() )
+        -- self:F( "Removing Tasking: " .. Task:GetTaskName() )
         self:RemoveTask( TaskIndex )
       end
     end
@@ -597,7 +593,6 @@ do -- TASK_A2G_DISPATCHER
     return Task
   end
 
-
   --- Assigns tasks in relation to the detected items to the @{Core.Set#SET_GROUP}.
   -- @param #TASK_A2G_DISPATCHER self
   -- @param Functional.Detection#DETECTION_BASE Detection The detection created by the @{Functional.Detection#DETECTION_BASE} derived object.
@@ -638,8 +633,8 @@ do -- TASK_A2G_DISPATCHER
         local DetectedItem = DetectedItem -- Functional.Detection#DETECTION_BASE.DetectedItem
         local DetectedSet = DetectedItem.Set -- Core.Set#SET_UNIT
         local DetectedZone = DetectedItem.Zone
-        --self:F( { "Targets in DetectedItem", DetectedItem.ItemID, DetectedSet:Count(), tostring( DetectedItem ) } )
+        -- self:F( { "Targets in DetectedItem", DetectedItem.ItemID, DetectedSet:Count(), tostring( DetectedItem ) } )
-        --DetectedSet:Flush( self )
+        -- DetectedSet:Flush( self )
 
         local DetectedItemID = DetectedItem.ID
         local TaskIndex = DetectedItem.Index
@@ -660,7 +655,7 @@ do -- TASK_A2G_DISPATCHER
                   Task:SetTargetSetUnit( TargetSetUnit )
                   Task:SetDetection( Detection, DetectedItem )
                   Task:UpdateTaskInfo( DetectedItem )
-                  TargetsReport:Add( Detection:GetChangeText( DetectedItem )  )
+                  TargetsReport:Add( Detection:GetChangeText( DetectedItem ) )
                 else
                   Task:Cancel()
                 end
@@ -694,8 +689,8 @@ do -- TASK_A2G_DISPATCHER
 
               -- Now we send to each group the changes, if any.
               for TaskGroupID, TaskGroup in pairs( self.SetGroup:GetSet() ) do
-                local TargetsText = TargetsReport:Text(", ")
+                local TargetsText = TargetsReport:Text( ", " )
-                if ( Mission:IsGroupAssigned(TaskGroup) ) and TargetsText ~= "" and self.FlashNewTask then
+                if (Mission:IsGroupAssigned( TaskGroup )) and TargetsText ~= "" and self.FlashNewTask then
                   Mission:GetCommandCenter():MessageToGroup( string.format( "Task %s has change of targets:\n %s", Task:GetName(), TargetsText ), TaskGroup )
                 end
               end
@@ -753,6 +748,7 @@ do -- TASK_A2G_DISPATCHER
           local TargetSetUnit = self:EvaluateSEAD( DetectedItem ) -- Returns a SetUnit if there are targets to be SEADed...
           if TargetSetUnit then
             Task = TASK_A2G_SEAD:New( Mission, self.SetGroup, string.format( "SEAD.%03d", DetectedItemID ), TargetSetUnit )
+            DetectedItem.DesignateMenuName = string.format( "SEAD.%03d", DetectedItemID ) -- inject a name for DESIGNATE, if using same DETECTION object
             Task:SetDetection( Detection, DetectedItem )
           end
 
@@ -761,6 +757,7 @@ do -- TASK_A2G_DISPATCHER
             local TargetSetUnit = self:EvaluateCAS( DetectedItem ) -- Returns a SetUnit if there are targets to be CASed...
             if TargetSetUnit then
               Task = TASK_A2G_CAS:New( Mission, self.SetGroup, string.format( "CAS.%03d", DetectedItemID ), TargetSetUnit )
+              DetectedItem.DesignateMenuName = string.format( "CAS.%03d", DetectedItemID ) -- inject a name for DESIGNATE, if using same DETECTION object
               Task:SetDetection( Detection, DetectedItem )
             end
 
@@ -769,6 +766,7 @@ do -- TASK_A2G_DISPATCHER
               local TargetSetUnit = self:EvaluateBAI( DetectedItem, self.Mission:GetCommandCenter():GetPositionable():GetCoalition() ) -- Returns a SetUnit if there are targets to be BAIed...
               if TargetSetUnit then
                 Task = TASK_A2G_BAI:New( Mission, self.SetGroup, string.format( "BAI.%03d", DetectedItemID ), TargetSetUnit )
+                DetectedItem.DesignateMenuName = string.format( "BAI.%03d", DetectedItemID ) -- inject a name for DESIGNATE, if using same DETECTION object
                 Task:SetDetection( Detection, DetectedItem )
               end
             end
@@ -797,14 +795,12 @@ do -- TASK_A2G_DISPATCHER
               self:Aborted( Task )
             end
 
-    
             TaskReport:Add( Task:GetName() )
           else
-            self:F("This should not happen")
+            self:F( "This should not happen" )
           end
         end
 
-  
         -- OK, so the tasking has been done, now delete the changes reported for the area.
         Detection:AcceptChanges( DetectedItem )
       end
@@ -812,9 +808,9 @@ do -- TASK_A2G_DISPATCHER
       -- TODO set menus using the HQ coordinator
       Mission:GetCommandCenter():SetMenu()
 
-      local TaskText = TaskReport:Text(", ")
+      local TaskText = TaskReport:Text( ", " )
       for TaskGroupID, TaskGroup in pairs( self.SetGroup:GetSet() ) do
-        if ( not Mission:IsGroupAssigned(TaskGroup) ) and TaskText ~= "" and self.FlashNewTask then
+        if (not Mission:IsGroupAssigned( TaskGroup )) and TaskText ~= "" and self.FlashNewTask then
           Mission:GetCommandCenter():MessageToGroup( string.format( "%s has tasks %s. Subscribe to a task using the radio menu.", Mission:GetShortText(), TaskText ), TaskGroup )
         end
       end

Moose Development/Moose/Tasking/Task_Cargo_Dispatcher.lua

@@ -683,6 +683,7 @@ do -- TASK_CARGO_DISPATCHER
   -- If no TaskPrefix is given, then "Transport" will be used as the prefix. 
   -- @param Core.SetCargo#SET_CARGO SetCargo The SetCargo to be transported.
   -- @param #string Briefing The briefing of the task transport to be shown to the player.
+  -- @param #boolean Silent If true don't send a message that a new task is available.
   -- @return Tasking.Task_Cargo_Transport#TASK_CARGO_TRANSPORT
   -- @usage
   -- 
@@ -705,10 +706,12 @@ do -- TASK_CARGO_DISPATCHER
   --  -- Here we set a TransportDeployZone. We use the WorkplaceTask as the reference, and provide a ZONE object.
   --  TaskDispatcher:SetTransportDeployZone( WorkplaceTask, ZONE:New( "Workplace" ) )
   --  
-  function TASK_CARGO_DISPATCHER:AddTransportTask( TaskPrefix, SetCargo, Briefing )
+  function TASK_CARGO_DISPATCHER:AddTransportTask( TaskPrefix, SetCargo, Briefing, Silent )
 
     self.TransportCount = self.TransportCount + 1
     
+    local verbose = Silent or false
+    
     local TaskName = string.format( ( TaskPrefix or "Transport" ) .. ".%03d", self.TransportCount )
     
     self.Transport[TaskName] = {} 
@@ -717,7 +720,7 @@ do -- TASK_CARGO_DISPATCHER
     self.Transport[TaskName].Task = nil
     self.Transport[TaskName].TaskPrefix = TaskPrefix
     
-    self:ManageTasks()
+    self:ManageTasks(verbose)
     
     return self.Transport[TaskName] and self.Transport[TaskName].Task
   end
@@ -785,10 +788,11 @@ do -- TASK_CARGO_DISPATCHER
 
   --- Assigns tasks to the @{Core.Set#SET_GROUP}.
   -- @param #TASK_CARGO_DISPATCHER self
+  -- @param #boolean Silent Announce new task (nil/false) or not (true).
   -- @return #boolean Return true if you want the task assigning to continue... false will cancel the loop.
-  function TASK_CARGO_DISPATCHER:ManageTasks()
+  function TASK_CARGO_DISPATCHER:ManageTasks(Silent)
     self:F()
-  
+    local verbose = Silent and true
     local AreaMsg = {}
     local TaskMsg = {}
     local ChangeMsg = {}
@@ -897,7 +901,7 @@ do -- TASK_CARGO_DISPATCHER
       local TaskText = TaskReport:Text(", ")
       
       for TaskGroupID, TaskGroup in pairs( self.SetGroup:GetSet() ) do
-        if ( not Mission:IsGroupAssigned(TaskGroup) ) and TaskText ~= "" then
+        if ( not Mission:IsGroupAssigned(TaskGroup) ) and TaskText ~= "" and not verbose then
           Mission:GetCommandCenter():MessageToGroup( string.format( "%s has tasks %s. Subscribe to a task using the radio menu.", Mission:GetShortText(), TaskText ), TaskGroup )
         end
       end

Moose Development/Moose/Tasking/Task_Cargo_Transport.lua

@@ -2,7 +2,7 @@
 -- 
 -- **Specific features:**
 -- 
---   * Creates a task to transport @{Cargo.Cargo} to and between deployment zones.
+--   * Creates a task to transport #Cargo.Cargo to and between deployment zones.
 --   * Derived from the TASK_CARGO class, which is derived from the TASK class.
 --   * Orchestrate the task flow, so go from Planned to Assigned to Success, Failed or Cancelled.
 --   * Co-operation tasking, so a player joins a group of players executing the same task.
@@ -44,7 +44,7 @@
 --
 -- ===
 -- 
--- Please read through the @{Tasking.Task_Cargo} process to understand the mechanisms of tasking and cargo tasking and handling.
+-- Please read through the #Tasking.Task_Cargo process to understand the mechanisms of tasking and cargo tasking and handling.
 -- 
 -- Enjoy!
 -- FC
@@ -57,7 +57,7 @@
 
 do -- TASK_CARGO_TRANSPORT
 
-  --- @type TASK_CARGO_TRANSPORT
+  -- @type TASK_CARGO_TRANSPORT
   -- @extends Tasking.Task_CARGO#TASK_CARGO
 
   --- Orchestrates the task for players to transport cargo to or between deployment zones.
@@ -76,7 +76,7 @@ do -- TASK_CARGO_TRANSPORT
   -- 
   -- ## 1.1) Create a command center.
   -- 
-  -- First you need to create a command center using the @{Tasking.CommandCenter#COMMANDCENTER.New}() constructor.
+  -- First you need to create a command center using the Tasking.CommandCenter#COMMANDCENTER.New constructor.
   -- 
   --     local CommandCenter = COMMANDCENTER
   --        :New( HQ, "Lima" ) -- Create the CommandCenter.
@@ -85,7 +85,7 @@ do -- TASK_CARGO_TRANSPORT
   -- 
   -- Tasks work in a mission, which groups these tasks to achieve a joint mission goal.
   -- A command center can govern multiple missions.
-  -- Create a new mission, using the @{Tasking.Mission#MISSION.New}() constructor.
+  -- Create a new mission, using the Tasking.Mission#MISSION.New constructor.
   -- 
   --     -- Declare the Mission for the Command Center.
   --     local Mission = MISSION
@@ -99,7 +99,7 @@ do -- TASK_CARGO_TRANSPORT
   -- ## 1.3) Create the transport cargo task.
   -- 
   -- So, now that we have a command center and a mission, we now create the transport task.
-  -- We create the transport task using the @{#TASK_CARGO_TRANSPORT.New}() constructor.
+  -- We create the transport task using the #TASK_CARGO_TRANSPORT.New constructor.
   -- 
   -- Because a transport task will not generate the cargo itself, you'll need to create it first.
   -- The cargo in this case will be the downed pilot!
@@ -118,7 +118,7 @@ do -- TASK_CARGO_TRANSPORT
   --     -- The cargoset "CargoSet" will embed all defined cargo of type "Pilots" (prefix) into its set.
   --     local CargoGroup = CARGO_GROUP:New( PilotGroup, "Cargo", "Engineer Team 1", 500 )
   -- 
-  -- What is also needed, is to have a set of @{Core.Group}s defined that contains the clients of the players.
+  -- What is also needed, is to have a set of Core.Groups defined that contains the clients of the players.
   -- 
   --     -- Allocate the Transport, which are the helicopter to retrieve the pilot, that can be manned by players.
   --     local GroupSet = SET_GROUP:New():FilterPrefixes( "Transport" ):FilterStart()
@@ -139,48 +139,48 @@ do -- TASK_CARGO_TRANSPORT
   -- By doing this, cargo transport tasking will become a dynamic experience.
   -- 
   -- 
-  -- # 2) Create a task using the @{Tasking.Task_Cargo_Dispatcher} module.
+  -- # 2) Create a task using the Tasking.Task_Cargo_Dispatcher module.
   -- 
-  -- Actually, it is better to **GENERATE** these tasks using the @{Tasking.Task_Cargo_Dispatcher} module.
+  -- Actually, it is better to **GENERATE** these tasks using the Tasking.Task_Cargo_Dispatcher module.
-  -- Using the dispatcher module, transport tasks can be created much more easy.
+  -- Using the dispatcher module, transport tasks can be created easier.
   -- 
   -- Find below an example how to use the TASK_CARGO_DISPATCHER class:
   -- 
   -- 
-  --    -- Find the HQ group.
+  --        -- Find the HQ group.
-  --    HQ = GROUP:FindByName( "HQ", "Bravo" )
+  --        HQ = GROUP:FindByName( "HQ", "Bravo" )
   --    
-  --    -- Create the command center with the name "Lima".
+  --        -- Create the command center with the name "Lima".
-  --    CommandCenter = COMMANDCENTER
+  --        CommandCenter = COMMANDCENTER
-  --      :New( HQ, "Lima" )
+  --          :New( HQ, "Lima" )
   --    
-  --    -- Create the mission, for the command center, with the name "Operation Cargo Fun", a "Tactical" mission, with the mission briefing "Transport Cargo", for the BLUE coalition.
+  --        -- Create the mission, for the command center, with the name "Operation Cargo Fun", a "Tactical" mission, with the mission briefing "Transport Cargo", for the BLUE coalition.
-  --    Mission = MISSION
+  --        Mission = MISSION
-  --      :New( CommandCenter, "Operation Cargo Fun", "Tactical", "Transport Cargo", coalition.side.BLUE )
+  --          :New( CommandCenter, "Operation Cargo Fun", "Tactical", "Transport Cargo", coalition.side.BLUE )
   --    
-  --    -- Create the SET of GROUPs containing clients (players) that will transport the cargo.
+  --        -- Create the SET of GROUPs containing clients (players) that will transport the cargo.
-  --    -- These are have a name that start with "Transport" and are of the "blue" coalition.
+  --        -- These are have a name that start with "Transport" and are of the "blue" coalition.
-  --    TransportGroups = SET_GROUP:New():FilterCoalitions( "blue" ):FilterPrefixes( "Transport" ):FilterStart()
+  --        TransportGroups = SET_GROUP:New():FilterCoalitions( "blue" ):FilterPrefixes( "Transport" ):FilterStart()
   --    
   --    
-  --    -- Here we create the TASK_CARGO_DISPATCHER object! This is where we assign the dispatcher to generate tasks in the Mission for the TransportGroups.
+  --        -- Here we create the TASK_CARGO_DISPATCHER object! This is where we assign the dispatcher to generate tasks in the Mission for the TransportGroups.
-  --    TaskDispatcher = TASK_CARGO_DISPATCHER:New( Mission, TransportGroups )
+  --        TaskDispatcher = TASK_CARGO_DISPATCHER:New( Mission, TransportGroups )
   --    
   --    
-  --    -- Here we declare the SET of CARGOs called "Workmaterials".
+  --        -- Here we declare the SET of CARGOs called "Workmaterials".
-  --    local CargoSetWorkmaterials = SET_CARGO:New():FilterTypes( "Workmaterials" ):FilterStart()
+  --        local CargoSetWorkmaterials = SET_CARGO:New():FilterTypes( "Workmaterials" ):FilterStart()
   --    
-  --    -- Here we declare (add) CARGO_GROUP objects of various types, that are filtered and added in the CargoSetworkmaterials cargo set.
+  --        -- Here we declare (add) CARGO_GROUP objects of various types, that are filtered and added in the CargoSetworkmaterials cargo set.
-  --    -- These cargo objects have the type "Workmaterials" which is exactly the type of cargo the CargoSetworkmaterials is filtering on.
+  --        -- These cargo objects have the type "Workmaterials" which is exactly the type of cargo the CargoSetworkmaterials is filtering on.
-  --    local EngineerCargoGroup = CARGO_GROUP:New( GROUP:FindByName( "Engineers" ), "Workmaterials", "Engineers", 250 )
+  --        local EngineerCargoGroup = CARGO_GROUP:New( GROUP:FindByName( "Engineers" ), "Workmaterials", "Engineers", 250 )
-  --    local ConcreteCargo = CARGO_SLINGLOAD:New( STATIC:FindByName( "Concrete" ), "Workmaterials", "Concrete", 150, 50 )
+  --        local ConcreteCargo = CARGO_SLINGLOAD:New( STATIC:FindByName( "Concrete" ), "Workmaterials", "Concrete", 150, 50 )
-  --    local CrateCargo = CARGO_CRATE:New( STATIC:FindByName( "Crate" ), "Workmaterials", "Crate", 150, 50 )
+  --        local CrateCargo = CARGO_CRATE:New( STATIC:FindByName( "Crate" ), "Workmaterials", "Crate", 150, 50 )
-  --    local EnginesCargo = CARGO_CRATE:New( STATIC:FindByName( "Engines" ), "Workmaterials", "Engines", 150, 50 )
+  --        local EnginesCargo = CARGO_CRATE:New( STATIC:FindByName( "Engines" ), "Workmaterials", "Engines", 150, 50 )
-  --    local MetalCargo = CARGO_CRATE:New( STATIC:FindByName( "Metal" ), "Workmaterials", "Metal", 150, 50 )
+  --        local MetalCargo = CARGO_CRATE:New( STATIC:FindByName( "Metal" ), "Workmaterials", "Metal", 150, 50 )
   --    
-  --    -- And here we create a new WorkplaceTask, using the :AddTransportTask method of the TaskDispatcher.
+  --          -- And here we create a new WorkplaceTask, using the :AddTransportTask method of the TaskDispatcher.
-  --    local WorkplaceTask = TaskDispatcher:AddTransportTask( "Build a Workplace", CargoSetWorkmaterials, "Transport the workers, engineers and the equipment near the Workplace." )
+  --          local WorkplaceTask = TaskDispatcher:AddTransportTask( "Build a Workplace", CargoSetWorkmaterials, "Transport the workers, engineers and the equipment near the Workplace." )
-  --    TaskDispatcher:SetTransportDeployZone( WorkplaceTask, ZONE:New( "Workplace" ) )
+  --          TaskDispatcher:SetTransportDeployZone( WorkplaceTask, ZONE:New( "Workplace" ) )
   -- 
   -- # 3) Handle cargo task events.
   -- 
@@ -189,7 +189,7 @@ do -- TASK_CARGO_TRANSPORT
   -- In order to properly capture the events and avoid mistakes using the documentation, it is advised that you execute the following actions:
   -- 
   --   * **Copy / Paste** the code section into your script.
-  --   * **Change** the CLASS literal to the task object name you have in your script.
+  --   * **Change** the "myclass" literal to the task object name you have in your script.
   --   * Within the function, you can now **write your own code**!
   --   * **IntelliSense** will recognize the type of the variables provided by the function. Note: the From, Event and To variables can be safely ignored, 
   --     but you need to declare them as they are automatically provided by the event handling system of MOOSE.
@@ -210,14 +210,13 @@ do -- TASK_CARGO_TRANSPORT
   -- If you want to code your own event handler, use this code fragment to tailor the event when a player carrier has picked up a cargo object in the CarrierGroup.
   -- You can use this event handler to post messages to players, or provide status updates etc.
   -- 
-  --      --- CargoPickedUp event handler OnAfter for CLASS.
+  --      --- CargoPickedUp event handler OnAfter for "myclass".
-  --      -- @param #CLASS self
   --      -- @param #string From A string that contains the "*from state name*" when the event was triggered.
   --      -- @param #string Event A string that contains the "*event name*" when the event was triggered.
   --      -- @param #string To A string that contains the "*to state name*" when the event was triggered.
   --      -- @param Wrapper.Unit#UNIT TaskUnit The unit (client) of the player that has picked up the cargo.
   --      -- @param Cargo.Cargo#CARGO Cargo The cargo object that has been picked up. Note that this can be a CARGO_GROUP, CARGO_CRATE or CARGO_SLINGLOAD object!
-  --      function CLASS:OnAfterCargoPickedUp( From, Event, To, TaskUnit, Cargo )
+  --      function myclass:OnAfterCargoPickedUp( From, Event, To, TaskUnit, Cargo )
   --      
   --        -- Write here your own code.
   --      
@@ -240,15 +239,14 @@ do -- TASK_CARGO_TRANSPORT
   -- You can use this event handler to post messages to players, or provide status updates etc.
   -- 
   -- 
-  --      --- CargoDeployed event handler OnAfter for CLASS.
+  --      --- CargoDeployed event handler OnAfter foR "myclass".
-  --      -- @param #CLASS self
   --      -- @param #string From A string that contains the "*from state name*" when the event was triggered.
   --      -- @param #string Event A string that contains the "*event name*" when the event was triggered.
   --      -- @param #string To A string that contains the "*to state name*" when the event was triggered.
   --      -- @param Wrapper.Unit#UNIT TaskUnit The unit (client) of the player that has deployed the cargo.
   --      -- @param Cargo.Cargo#CARGO Cargo The cargo object that has been deployed. Note that this can be a CARGO_GROUP, CARGO_CRATE or CARGO_SLINGLOAD object!
   --      -- @param Core.Zone#ZONE DeployZone The zone wherein the cargo is deployed. This can be any zone type, like a ZONE, ZONE_GROUP, ZONE_AIRBASE.
-  --      function CLASS:OnAfterCargoDeployed( From, Event, To, TaskUnit, Cargo, DeployZone )
+  --      function myclass:OnAfterCargoDeployed( From, Event, To, TaskUnit, Cargo, DeployZone )
   --      
   --        -- Write here your own code.
   --      

Moose Development/Moose/Utilities/Enums.lua

@@ -11,7 +11,7 @@
 -- 
 -- DCS itself provides a lot of enumerators for various things. See [Enumerators](https://wiki.hoggitworld.com/view/Category:Enumerators) on Hoggit.
 -- 
--- Other Moose classe also have enumerators. For example, the AIRBASE class has enumerators for airbase names.
+-- Other Moose classes also have enumerators. For example, the AIRBASE class has enumerators for airbase names.
 -- 
 -- @module ENUMS
 -- @image MOOSE.JPG
@@ -126,6 +126,8 @@ ENUMS.WeaponFlag={
   AnyMissile           =  268402688, -- AnyASM + AnyAAM   
   --- Guns
   Cannons              =  805306368, -- GUN_POD + BuiltInCannon
+  --- Torpedo
+  Torpedo              = 4294967296,
   ---
   -- Even More Genral  
   Auto                 = 3221225470, -- Any Weapon (AnyBomb + AnyRocket + AnyMissile + Cannons)
@@ -136,6 +138,93 @@ ENUMS.WeaponFlag={
   AnyGuided            =  268402702, -- Any Guided Weapon   
 }
 
+--- Weapon types by category. See the [Weapon Flag](https://wiki.hoggitworld.com/view/DCS_enum_weapon_flag) enumerator on hoggit wiki.
+-- @type ENUMS.WeaponType
+-- @field #table Bomb Bombs.
+-- @field #table Rocket Rocket.
+-- @field #table Gun Guns.
+-- @field #table Missile Missiles.
+-- @field #table AAM Air-to-Air missiles.
+-- @field #table Torpedo Torpedos.
+-- @field #table Any Combinations.
+ENUMS.WeaponType={}
+ENUMS.WeaponType.Bomb={
+  -- Bombs
+  LGB                  =          2,
+  TvGB                 =          4,
+  SNSGB                =          8,
+  HEBomb               =         16,
+  Penetrator           =         32,
+  NapalmBomb           =         64,
+  FAEBomb              =        128,
+  ClusterBomb          =        256,
+  Dispencer            =        512,
+  CandleBomb           =       1024,
+  ParachuteBomb        = 2147483648,
+  -- Combinations
+  GuidedBomb           =         14, -- (LGB + TvGB + SNSGB)
+  AnyUnguidedBomb      = 2147485680, -- (HeBomb + Penetrator + NapalmBomb + FAEBomb + ClusterBomb + Dispencer + CandleBomb + ParachuteBomb)
+  AnyBomb              = 2147485694, -- (GuidedBomb + AnyUnguidedBomb)  
+}
+ENUMS.WeaponType.Rocket={
+  -- Rockets
+  LightRocket          =       2048,
+  MarkerRocket         =       4096,
+  CandleRocket         =       8192,
+  HeavyRocket          =      16384,
+  -- Combinations
+  AnyRocket            =      30720, -- LightRocket + MarkerRocket + CandleRocket + HeavyRocket
+}
+ENUMS.WeaponType.Gun={
+  -- Guns
+  GunPod               =  268435456,
+  BuiltInCannon        =  536870912,
+  -- Combinations
+  Cannons              =  805306368, -- GUN_POD + BuiltInCannon
+}
+ENUMS.WeaponType.Missile={
+  -- Missiles
+  AntiRadarMissile     =      32768,
+  AntiShipMissile      =      65536,
+  AntiTankMissile      =     131072,
+  FireAndForgetASM     =     262144,
+  LaserASM             =     524288,
+  TeleASM              =    1048576,
+  CruiseMissile        =    2097152,
+  AntiRadarMissile2    = 1073741824,
+  -- Combinations
+  GuidedASM            =    1572864, -- (LaserASM + TeleASM)
+  TacticalASM          =    1835008, -- (GuidedASM + FireAndForgetASM)
+  AnyASM               =    4161536, -- (AntiRadarMissile + AntiShipMissile + AntiTankMissile + FireAndForgetASM + GuidedASM + CruiseMissile)
+  AnyASM2              = 1077903360, -- 4161536+1073741824,
+  AnyAutonomousMissile =   36012032, -- IR_AAM + AntiRadarMissile + AntiShipMissile + FireAndForgetASM + CruiseMissile
+  AnyMissile           =  268402688, -- AnyASM + AnyAAM       
+}
+ENUMS.WeaponType.AAM={
+  -- Air-To-Air Missiles
+  SRAM                 =    4194304,
+  MRAAM                =    8388608, 
+  LRAAM                =   16777216,
+  IR_AAM               =   33554432,
+  SAR_AAM              =   67108864,
+  AR_AAM               =  134217728,
+  -- Combinations
+  AnyAAM               =  264241152, -- IR_AAM + SAR_AAM + AR_AAM + SRAAM + MRAAM + LRAAM
+}
+ENUMS.WeaponType.Torpedo={
+  -- Torpedo
+  Torpedo              = 4294967296,
+}
+ENUMS.WeaponType.Any={
+  -- General combinations  
+  Weapon               = 3221225470, -- Any Weapon (AnyBomb + AnyRocket + AnyMissile + Cannons)
+  AG                   = 2956984318, -- Any Air-To-Ground Weapon
+  AA                   =  264241152, -- Any Air-To-Air Weapon
+  Unguided             = 2952822768, -- Any Unguided Weapon
+  Guided               =  268402702, -- Any Guided Weapon   
+}
+
+
 --- Mission tasks.
 -- @type ENUMS.MissionTask
 -- @field #string NOTHING No special task. Group can perform the minimal tasks: Orbit, Refuelling, Follow and Aerobatics.
@@ -311,3 +400,162 @@ ENUMS.Morse.N8="- - - * *"
 ENUMS.Morse.N9="- - - - *"
 ENUMS.Morse.N0="- - - - -"
 ENUMS.Morse[" "]=" "
+
+--- ISO (639-1) 2-letter Language Codes. See the [Wikipedia](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).
+-- 
+-- @type ENUMS.ISOLang
+ENUMS.ISOLang = 
+{
+  Arabic    = 'AR',
+  Chinese   = 'ZH',
+  English   = 'EN',
+  French    = 'FR',
+  German    = 'DE',
+  Russian   = 'RU',
+  Spanish   = 'ES',
+  Japanese  = 'JA',
+  Italian   = 'IT',
+}
+
+--- Phonetic Alphabet (NATO). See the [Wikipedia](https://en.wikipedia.org/wiki/NATO_phonetic_alphabet).
+-- 
+-- @type ENUMS.Phonetic
+ENUMS.Phonetic =
+{
+  A = 'Alpha',
+  B = 'Bravo',
+  C = 'Charlie',
+  D = 'Delta',
+  E = 'Echo',
+  F = 'Foxtrot',
+  G = 'Golf',
+  H = 'Hotel',
+  I = 'India',
+  J = 'Juliett',
+  K = 'Kilo',
+  L = 'Lima',
+  M = 'Mike',
+  N = 'November',
+  O = 'Oscar',
+  P = 'Papa',
+  Q = 'Quebec',
+  R = 'Romeo',
+  S = 'Sierra',
+  T = 'Tango',
+  U = 'Uniform',
+  V = 'Victor',
+  W = 'Whiskey',
+  X = 'Xray',
+  Y = 'Yankee',
+  Z = 'Zulu',
+}
+
+--- Reporting Names (NATO). See the [Wikipedia](https://en.wikipedia.org/wiki/List_of_NATO_reporting_names_for_fighter_aircraft).
+-- DCS known aircraft types
+-- 
+-- @type ENUMS.ReportingName
+ENUMS.ReportingName =
+{
+  NATO = {
+    -- Fighters
+    Dragon = "JF-17", -- China, correctly Fierce Dragon, Thunder for PAC
+    Fagot = "MiG-15",
+    Farmer = "MiG-19", -- Shenyang J-6 and Mikoyan-Gurevich MiG-19
+    Felon = "Su-57",
+    Fencer = "Su-24",
+    Fishbed = "MiG-21",
+    Fitter = "Su-17", -- Sukhoi Su-7 and Su-17/Su-20/Su-22
+    Flogger = "MiG-23",  --and MiG-27
+    Flogger_D = "MiG-27",  --and MiG-23
+    Flagon = "Su-15",
+    Foxbat = "MiG-25",
+    Fulcrum = "MiG-29",
+    Foxhound = "MiG-31",
+    Flanker = "Su-27", -- Sukhoi Su-27/Su-30/Su-33/Su-35/Su-37 and Shenyang J-11/J-15/J-16
+    Flanker_C = "Su-30",
+    Flanker_E = "Su-35",
+    Flanker_F = "Su-37",
+    Flanker_L = "J-11A",
+    Firebird = "J-10",
+    Sea_Flanker = "Su-33",
+    Fullback = "Su-34", -- also Su-32
+    Frogfoot = "Su-25",
+    Tomcat = "F-14", -- Iran
+    Mirage = "Mirage", -- various non-NATO
+    Codling = "Yak-40",
+    Maya = "L-39",
+    -- Fighters US/NATO
+    Warthog = "A-10",
+    --Mosquito = "A-20",
+    Skyhawk = "A-4E",
+    Viggen = "AJS37",
+    Harrier = "AV-8B",
+    Spirit = "B-2",
+    Aviojet = "C-101",
+    Nighthawk = "F-117A",
+    Eagle = "F-15C",
+    Mudhen = "F-15E",
+    Viper = "F-16",
+    Phantom = "F-4E",
+    Tiger = "F-5", -- was thinkg to name this MiG-25 ;)
+    Sabre = "F-86",
+    Hornet = "A-18", -- avoiding the slash
+    Hawk = "Hawk",
+    Albatros = "L-39",
+    Goshawk = "T-45",
+    Starfighter = "F-104",
+    Tornado = "Tornado",
+    -- Transport / Bomber / Others
+    Atlas = "A400",
+    Lancer = "B1-B",
+    Stratofortress = "B-52H",
+    Hercules = "C-130", 
+    Super_Hercules = "Hercules",
+    Globemaster = "C-17",
+    Greyhound = "C-2A",
+    Galaxy = "C-5",
+    Hawkeye = "E-2D",
+    Sentry = "E-3A",
+    Stratotanker = "KC-135",
+    Extender = "KC-10",
+    Orion = "P-3C",
+    Viking = "S-3B",
+    Osprey = "V-22",
+    -- Bomber Rus
+    Badger = "H6-J",
+    Bear_J = "Tu-142", -- also Tu-95
+    Bear = "Tu-95", -- also Tu-142
+    Blinder = "Tu-22",
+    Blackjack = "Tu-160",
+    -- AIC / Transport / Other
+    Clank = "An-30",
+    Curl = "An-26",
+    Candid = "IL-76",
+    Midas = "IL-78",
+    Mainstay = "A-50", 
+    Mainring = "KJ-2000", -- A-50 China
+    Yak = "Yak-52",
+    -- Helos
+    Helix = "Ka-27",
+    Shark = "Ka-50",
+    Hind = "Mi-24",
+    Halo = "Mi-26",
+    Hip = "Mi-8",
+    Havoc = "Mi-28",
+    Gazelle = "SA342",
+    -- Helos US
+    Huey = "UH-1H",
+    Cobra = "AH-1",
+    Apache = "AH-64",
+    Chinook = "CH-47",
+    Sea_Stallion = "CH-53",
+    Kiowa = "OH-58",
+    Seahawk = "SH-60",
+    Blackhawk = "UH-60",
+    Sea_King = "S-61",
+    -- Drones
+    UCAV = "WingLoong",
+    Reaper = "MQ-9",
+    Predator = "MQ-1A",
+  }
+}

Moose Development/Moose/Utilities/FiFo.lua

@@ -0,0 +1,773 @@
+---  **UTILS** - ClassicFiFo Stack.
+--
+-- ===
+--
+-- ## Main Features:
+--
+--    * Build a simple multi-purpose FiFo (First-In, First-Out) stack for generic data.
+--    * [Wikipedia](https://en.wikipedia.org/wiki/FIFO_(computing_and_electronics)
+--
+-- ===
+--
+-- ### Author: **applevangelist**
+-- @module Utils.FiFo
+-- @image MOOSE.JPG
+
+-- Date: April 2022
+
+do
+--- FIFO class.
+-- @type FIFO
+-- @field #string ClassName Name of the class.
+-- @field #string lid Class id string for output to DCS log file.
+-- @field #string version Version of FiFo.
+-- @field #number counter Counter.
+-- @field #number pointer Pointer.
+-- @field #table stackbypointer Stack by pointer.
+-- @field #table stackbyid Stack by ID.
+-- @extends Core.Base#BASE
+
+---
+-- @type FIFO.IDEntry
+-- @field #number pointer
+-- @field #table data
+-- @field #table uniqueID
+
+---
+-- @field #FIFO
+FIFO = {
+  ClassName = "FIFO",
+  lid = "",
+  version = "0.0.5",
+  counter = 0,
+  pointer = 0,
+  stackbypointer = {},
+  stackbyid = {}
+}
+
+--- Instantiate a new FIFO Stack.
+-- @param #FIFO self
+-- @return #FIFO self
+function FIFO:New()
+  -- Inherit everything from BASE class.
+  local self=BASE:Inherit(self, BASE:New()) --#FIFO
+  self.pointer = 0
+  self.counter = 0
+  self.stackbypointer = {}
+  self.stackbyid = {}
+  self.uniquecounter = 0
+  -- Set some string id for output to DCS.log file.
+  self.lid=string.format("%s (%s) | ", "FiFo", self.version)
+  self:T(self.lid .."Created.") 
+  return self
+end
+
+--- Empty FIFO Stack.
+-- @param #FIFO self
+-- @return #FIFO self
+function FIFO:Clear()
+  self:T(self.lid.."Clear")
+  self.pointer = 0
+  self.counter = 0
+  self.stackbypointer = nil
+  self.stackbyid = nil
+  self.stackbypointer = {}
+  self.stackbyid = {}
+  self.uniquecounter = 0
+  return self
+end
+
+--- FIFO Push Object to Stack.
+-- @param #FIFO self
+-- @param #table Object
+-- @param #string UniqueID (optional) - will default to current pointer + 1. Note - if you intend to use `FIFO:GetIDStackSorted()` keep the UniqueID numerical!
+-- @return #FIFO self
+function FIFO:Push(Object,UniqueID)
+  self:T(self.lid.."Push")
+  self:T({Object,UniqueID})
+  self.pointer = self.pointer + 1 
+  self.counter = self.counter + 1
+  local uniID = UniqueID
+  if not UniqueID then
+    self.uniquecounter = self.uniquecounter + 1
+    uniID = self.uniquecounter
+  end
+  self.stackbyid[uniID] = { pointer = self.pointer, data = Object, uniqueID = uniID }
+  self.stackbypointer[self.pointer] = { pointer = self.pointer, data = Object, uniqueID = uniID }
+  return self
+end
+
+--- FIFO Pull Object from Stack.
+-- @param #FIFO self
+-- @return #table Object or nil if stack is empty
+function FIFO:Pull()
+  self:T(self.lid.."Pull")
+  if self.counter == 0 then return nil end
+  --local object = self.stackbypointer[self.pointer].data
+  --self.stackbypointer[self.pointer] = nil
+  local object = self.stackbypointer[1].data
+  self.stackbypointer[1] = nil
+  self.counter = self.counter - 1
+  --self.pointer = self.pointer - 1
+  self:Flatten()
+  return object
+end
+
+--- FIFO Pull Object from Stack by Pointer
+-- @param #FIFO self
+-- @param #number Pointer
+-- @return #table Object or nil if stack is empty
+function FIFO:PullByPointer(Pointer)
+  self:T(self.lid.."PullByPointer " .. tostring(Pointer))
+  if self.counter == 0 then return nil end
+  local object = self.stackbypointer[Pointer] -- #FIFO.IDEntry
+  self.stackbypointer[Pointer] = nil
+  if object then self.stackbyid[object.uniqueID] = nil end
+  self.counter = self.counter - 1
+  self:Flatten()
+  if object then
+    return object.data
+  else
+    return nil
+  end
+end
+
+
+--- FIFO Read, not Pull, Object from Stack by Pointer
+-- @param #FIFO self
+-- @param #number Pointer
+-- @return #table Object or nil if stack is empty or pointer does not exist
+function FIFO:ReadByPointer(Pointer)
+  self:T(self.lid.."ReadByPointer " .. tostring(Pointer))
+  if self.counter == 0 or not Pointer or not self.stackbypointer[Pointer]  then return nil end
+  local object = self.stackbypointer[Pointer] -- #FIFO.IDEntry
+  if object then
+    return object.data
+  else
+    return nil
+  end
+end
+
+--- FIFO Read, not Pull, Object from Stack by UniqueID
+-- @param #FIFO self
+-- @param #number UniqueID
+-- @return #table Object data or nil if stack is empty or ID does not exist
+function FIFO:ReadByID(UniqueID)
+  self:T(self.lid.."ReadByID " .. tostring(UniqueID))
+  if self.counter == 0 or not UniqueID or not self.stackbyid[UniqueID]  then return nil end
+  local object = self.stackbyid[UniqueID] -- #FIFO.IDEntry
+  if object then
+    return object.data
+  else
+    return nil
+  end
+end
+
+--- FIFO Pull Object from Stack by UniqueID
+-- @param #FIFO self
+-- @param #tableUniqueID
+-- @return #table Object or nil if stack is empty
+function FIFO:PullByID(UniqueID)
+  self:T(self.lid.."PullByID " .. tostring(UniqueID))
+  if self.counter == 0 then return nil end
+  local object = self.stackbyid[UniqueID] -- #FIFO.IDEntry
+  --self.stackbyid[UniqueID] = nil
+  if object then
+    return self:PullByPointer(object.pointer)
+  else
+    return nil
+  end
+end
+
+--- FIFO Housekeeping
+-- @param #FIFO self
+-- @return #FIFO self
+function FIFO:Flatten()
+  self:T(self.lid.."Flatten")
+  -- rebuild stacks
+  local pointerstack = {}
+  local idstack = {}
+  local counter = 0
+  for _ID,_entry in pairs(self.stackbypointer) do
+    counter = counter + 1
+    pointerstack[counter] = { pointer = counter, data = _entry.data, uniqueID = _entry.uniqueID}
+  end
+  for _ID,_entry in pairs(pointerstack) do
+      idstack[_entry.uniqueID] = { pointer = _entry.pointer , data = _entry.data, uniqueID = _entry.uniqueID}
+  end
+  self.stackbypointer = nil
+  self.stackbypointer = pointerstack
+  self.stackbyid = nil
+  self.stackbyid = idstack
+  self.counter = counter
+  self.pointer = counter
+  return self
+end
+
+--- FIFO Check Stack is empty
+-- @param #FIFO self
+-- @return #boolean empty
+function FIFO:IsEmpty()
+  self:T(self.lid.."IsEmpty")
+  return self.counter == 0 and true or false
+end
+
+--- FIFO Get stack size
+-- @param #FIFO self
+-- @return #number size
+function FIFO:GetSize()
+  self:T(self.lid.."GetSize")
+  return self.counter
+end
+
+--- FIFO Get stack size
+-- @param #FIFO self
+-- @return #number size
+function FIFO:Count()
+  self:T(self.lid.."Count")
+  return self.counter
+end
+
+--- FIFO Check Stack is NOT empty
+-- @param #FIFO self
+-- @return #boolean notempty
+function FIFO:IsNotEmpty()
+  self:T(self.lid.."IsNotEmpty")
+  return not self:IsEmpty()
+end
+
+--- FIFO Get the data stack by pointer
+-- @param #FIFO self
+-- @return #table Table of #FIFO.IDEntry entries
+function FIFO:GetPointerStack()
+  self:T(self.lid.."GetPointerStack")
+  return self.stackbypointer
+end
+
+--- FIFO Check if a certain UniqeID exists
+-- @param #FIFO self
+-- @return #boolean exists
+function FIFO:HasUniqueID(UniqueID)
+  self:T(self.lid.."HasUniqueID")
+  if self.stackbyid[UniqueID] ~= nil then
+    return true
+  else
+    return false
+  end
+end
+
+--- FIFO Get the data stack by UniqueID
+-- @param #FIFO self
+-- @return #table Table of #FIFO.IDEntry entries
+function FIFO:GetIDStack()
+  self:T(self.lid.."GetIDStack")
+  return self.stackbyid
+end
+
+--- FIFO Get table of UniqueIDs sorted smallest to largest
+-- @param #FIFO self
+-- @return #table Table with index [1] to [n] of UniqueID entries
+function FIFO:GetIDStackSorted()
+  self:T(self.lid.."GetIDStackSorted")
+  
+  local stack = self:GetIDStack()
+  local idstack = {}
+  for _id,_entry in pairs(stack) do
+    idstack[#idstack+1] = _id
+    
+    self:T({"pre",_id})
+  end
+  
+  local function sortID(a, b)
+      return a < b
+  end
+  
+  table.sort(idstack)
+ 
+  return idstack
+end
+
+--- FIFO Get table of data entries
+-- @param #FIFO self
+-- @return #table Raw table indexed [1] to [n] of object entries - might be empty!
+function FIFO:GetDataTable()
+  self:T(self.lid.."GetDataTable")
+  local datatable = {}
+  for _,_entry in pairs(self.stackbypointer) do
+    datatable[#datatable+1] = _entry.data
+  end
+  return datatable
+end
+
+--- FIFO Get sorted table of data entries by UniqueIDs (must be numerical UniqueIDs only!)
+-- @param #FIFO self
+-- @return #table Table indexed [1] to [n] of sorted object entries - might be empty!
+function FIFO:GetSortedDataTable()
+  self:T(self.lid.."GetSortedDataTable")
+  local datatable = {}
+  local idtablesorted = self:GetIDStackSorted()
+  for _,_entry in pairs(idtablesorted) do
+    datatable[#datatable+1] = self:ReadByID(_entry)
+  end
+  return datatable
+end
+
+--- Iterate the FIFO and call an iterator function for the given FIFO data, providing the object for each element of the stack and optional parameters.
+-- @param #FIFO self
+-- @param #function IteratorFunction The function that will be called.
+-- @param #table Arg (Optional) Further Arguments of the IteratorFunction.
+-- @param #function Function (Optional) A function returning a #boolean true/false. Only if true, the IteratorFunction is called.
+-- @param #table FunctionArguments (Optional) Function arguments.
+-- @return #FIFO self
+function FIFO:ForEach( IteratorFunction, Arg, Function, FunctionArguments )
+  self:T(self.lid.."ForEach")
+
+  local Set = self:GetPointerStack() or {}
+  Arg = Arg or {}
+
+  local function CoRoutine()
+    local Count = 0
+    for ObjectID, ObjectData in pairs( Set ) do
+      local Object = ObjectData.data
+        self:T( {Object} )
+        if Function then
+          if Function( unpack( FunctionArguments or {} ), Object ) == true then
+            IteratorFunction( Object, unpack( Arg ) )
+          end
+        else
+          IteratorFunction( Object, unpack( Arg ) )
+        end
+        Count = Count + 1
+    end
+    return true
+  end
+
+  local co = CoRoutine
+
+  local function Schedule()
+
+    local status, res = co()
+    self:T( { status, res } )
+
+    if status == false then
+      error( res )
+    end
+    if res == false then
+      return true -- resume next time the loop
+    end
+
+    return false
+  end
+
+  Schedule()
+
+  return self
+end
+   
+--- FIFO Print stacks to dcs.log
+-- @param #FIFO self
+-- @return #FIFO self
+function FIFO:Flush()
+  self:T(self.lid.."FiFo Flush")
+  self:I("FIFO Flushing Stack by Pointer")
+  for _id,_data in pairs (self.stackbypointer) do
+    local data = _data -- #FIFO.IDEntry
+    self:I(string.format("Pointer: %s | Entry: Number = %s Data = %s UniqueID = %s",tostring(_id),tostring(data.pointer),tostring(data.data),tostring(data.uniqueID)))
+  end
+  self:I("FIFO Flushing Stack by ID")
+  for _id,_data in pairs (self.stackbyid) do
+    local data = _data -- #FIFO.IDEntry
+    self:I(string.format("ID: %s | Entry: Number = %s Data = %s UniqueID = %s",tostring(_id),tostring(data.pointer),tostring(data.data),tostring(data.uniqueID)))
+  end
+  self:I("Counter = " .. self.counter)
+  self:I("Pointer = ".. self.pointer)
+  return self
+end
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- End FIFO
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+end
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- LIFO
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+do
+--- **UTILS** - LiFo Stack.
+--
+-- **Main Features:**
+--
+--    * Build a simple multi-purpose LiFo (Last-In, First-Out) stack for generic data.
+--
+-- ===
+--
+-- ### Author: **applevangelist**
+
+--- LIFO class.
+-- @type LIFO
+-- @field #string ClassName Name of the class.
+-- @field #string lid Class id string for output to DCS log file.
+-- @field #string version Version of LiFo
+-- @field #number counter
+-- @field #number pointer
+-- @field #table stackbypointer
+-- @field #table stackbyid
+-- @extends Core.Base#BASE
+
+---
+-- @type LIFO.IDEntry
+-- @field #number pointer
+-- @field #table data
+-- @field #table uniqueID
+
+---
+-- @field #LIFO
+LIFO = {
+  ClassName = "LIFO",
+  lid = "",
+  version = "0.0.5",
+  counter = 0,
+  pointer = 0,
+  stackbypointer = {},
+  stackbyid = {}
+}
+
+--- Instantiate a new LIFO Stack
+-- @param #LIFO self
+-- @return #LIFO self
+function LIFO:New()
+  -- Inherit everything from BASE class.
+  local self=BASE:Inherit(self, BASE:New())
+  self.pointer = 0
+  self.counter = 0
+  self.uniquecounter = 0
+  self.stackbypointer = {}
+  self.stackbyid = {}
+  -- Set some string id for output to DCS.log file.
+  self.lid=string.format("%s (%s) | ", "LiFo", self.version)
+  self:T(self.lid .."Created.") 
+  return self
+end
+
+--- Empty LIFO Stack
+-- @param #LIFO self
+-- @return #LIFO self
+function LIFO:Clear()
+  self:T(self.lid.."Clear")
+  self.pointer = 0
+  self.counter = 0
+  self.stackbypointer = nil
+  self.stackbyid = nil
+  self.stackbypointer = {}
+  self.stackbyid = {}
+  self.uniquecounter = 0
+  return self
+end
+
+--- LIFO Push Object to Stack
+-- @param #LIFO self
+-- @param #table Object
+-- @param #string UniqueID (optional) - will default to current pointer + 1
+-- @return #LIFO self
+function LIFO:Push(Object,UniqueID)
+  self:T(self.lid.."Push")
+  self:T({Object,UniqueID})
+  self.pointer = self.pointer + 1 
+  self.counter = self.counter + 1
+  local uniID = UniqueID
+  if not UniqueID then
+    self.uniquecounter = self.uniquecounter + 1
+    uniID = self.uniquecounter
+  end
+  self.stackbyid[uniID] = { pointer = self.pointer, data = Object, uniqueID = uniID }
+  self.stackbypointer[self.pointer] = { pointer = self.pointer, data = Object, uniqueID = uniID }
+  return self
+end
+
+--- LIFO Pull Object from Stack
+-- @param #LIFO self
+-- @return #table Object or nil if stack is empty
+function LIFO:Pull()
+  self:T(self.lid.."Pull")
+  if self.counter == 0 then return nil end
+  local object = self.stackbypointer[self.pointer].data
+  self.stackbypointer[self.pointer] = nil
+  --local object = self.stackbypointer[1].data
+  --self.stackbypointer[1] = nil
+  self.counter = self.counter - 1
+  self.pointer = self.pointer - 1
+  self:Flatten()
+  return object
+end
+
+--- LIFO Pull Object from Stack by Pointer
+-- @param #LIFO self
+-- @param #number Pointer
+-- @return #table Object or nil if stack is empty
+function LIFO:PullByPointer(Pointer)
+  self:T(self.lid.."PullByPointer " .. tostring(Pointer))
+  if self.counter == 0 then return nil end
+  local object = self.stackbypointer[Pointer] -- #FIFO.IDEntry
+  self.stackbypointer[Pointer] = nil
+  if object then self.stackbyid[object.uniqueID] = nil end
+  self.counter = self.counter - 1
+  self:Flatten()
+  if object then
+    return object.data
+  else
+    return nil
+  end
+end
+
+--- LIFO Read, not Pull, Object from Stack by Pointer
+-- @param #LIFO self
+-- @param #number Pointer
+-- @return #table Object or nil if stack is empty or pointer does not exist
+function LIFO:ReadByPointer(Pointer)
+  self:T(self.lid.."ReadByPointer " .. tostring(Pointer))
+  if self.counter == 0 or not Pointer or not self.stackbypointer[Pointer]  then return nil end
+  local object = self.stackbypointer[Pointer] -- #LIFO.IDEntry
+  if object then
+    return object.data
+  else
+    return nil
+  end
+end
+
+--- LIFO Read, not Pull, Object from Stack by UniqueID
+-- @param #LIFO self
+-- @param #number UniqueID
+-- @return #table Object or nil if stack is empty or ID does not exist
+function LIFO:ReadByID(UniqueID)
+  self:T(self.lid.."ReadByID " .. tostring(UniqueID))
+  if self.counter == 0 or not UniqueID or not self.stackbyid[UniqueID]  then return nil end
+  local object = self.stackbyid[UniqueID] -- #LIFO.IDEntry
+  if object then
+    return object.data
+  else
+    return nil
+  end
+end
+
+--- LIFO Pull Object from Stack by UniqueID
+-- @param #LIFO self
+-- @param #tableUniqueID
+-- @return #table Object or nil if stack is empty
+function LIFO:PullByID(UniqueID)
+  self:T(self.lid.."PullByID " .. tostring(UniqueID))
+  if self.counter == 0 then return nil end
+  local object = self.stackbyid[UniqueID] -- #LIFO.IDEntry
+  --self.stackbyid[UniqueID] = nil
+  if object then
+    return self:PullByPointer(object.pointer)
+  else
+    return nil
+  end
+end
+
+--- LIFO Housekeeping
+-- @param #LIFO self
+-- @return #LIFO self
+function LIFO:Flatten()
+  self:T(self.lid.."Flatten")
+  -- rebuild stacks
+  local pointerstack = {}
+  local idstack = {}
+  local counter = 0
+  for _ID,_entry in pairs(self.stackbypointer) do
+    counter = counter + 1
+    pointerstack[counter] = { pointer = counter, data = _entry.data, uniqueID = _entry.uniqueID}
+  end
+  for _ID,_entry in pairs(pointerstack) do
+      idstack[_entry.uniqueID] = { pointer = _entry.pointer , data = _entry.data, uniqueID = _entry.uniqueID}
+  end
+  self.stackbypointer = nil
+  self.stackbypointer = pointerstack
+  self.stackbyid = nil
+  self.stackbyid = idstack
+  self.counter = counter
+  self.pointer = counter
+  return self
+end
+
+--- LIFO Check Stack is empty
+-- @param #LIFO self
+-- @return #boolean empty
+function LIFO:IsEmpty()
+  self:T(self.lid.."IsEmpty")
+  return self.counter == 0 and true or false
+end
+
+--- LIFO Get stack size
+-- @param #LIFO self
+-- @return #number size
+function LIFO:GetSize()
+  self:T(self.lid.."GetSize")
+  return self.counter
+end
+
+--- LIFO Get stack size
+-- @param #LIFO self
+-- @return #number size
+function LIFO:Count()
+  self:T(self.lid.."Count")
+  return self.counter
+end
+
+--- LIFO Check Stack is NOT empty
+-- @param #LIFO self
+-- @return #boolean notempty
+function LIFO:IsNotEmpty()
+  self:T(self.lid.."IsNotEmpty")
+  return not self:IsEmpty()
+end
+
+--- LIFO Get the data stack by pointer
+-- @param #LIFO self
+-- @return #table Table of #LIFO.IDEntry entries
+function LIFO:GetPointerStack()
+  self:T(self.lid.."GetPointerStack")
+  return self.stackbypointer
+end
+
+--- LIFO Get the data stack by UniqueID
+-- @param #LIFO self
+-- @return #table Table of #LIFO.IDEntry entries
+function LIFO:GetIDStack()
+  self:T(self.lid.."GetIDStack")
+  return self.stackbyid
+end
+
+--- LIFO Get table of UniqueIDs sorted smallest to largest
+-- @param #LIFO self
+-- @return #table Table of #LIFO.IDEntry entries
+function LIFO:GetIDStackSorted()
+  self:T(self.lid.."GetIDStackSorted")
+  
+  local stack = self:GetIDStack()
+  local idstack = {}
+  for _id,_entry in pairs(stack) do
+    idstack[#idstack+1] = _id
+    
+    self:T({"pre",_id})
+  end
+  
+  local function sortID(a, b)
+      return a < b
+  end
+  
+  table.sort(idstack)
+ 
+  return idstack
+end
+
+--- LIFO Check if a certain UniqeID exists
+-- @param #LIFO self
+-- @return #boolean exists
+function LIFO:HasUniqueID(UniqueID)
+  self:T(self.lid.."HasUniqueID")
+  return  self.stackbyid[UniqueID] and true or false
+end
+
+--- LIFO Print stacks to dcs.log
+-- @param #LIFO self
+-- @return #LIFO self
+function LIFO:Flush()
+  self:T(self.lid.."FiFo Flush")
+  self:I("LIFO Flushing Stack by Pointer")
+  for _id,_data in pairs (self.stackbypointer) do
+    local data = _data -- #LIFO.IDEntry
+    self:I(string.format("Pointer: %s | Entry: Number = %s Data = %s UniqueID = %s",tostring(_id),tostring(data.pointer),tostring(data.data),tostring(data.uniqueID)))
+  end
+  self:I("LIFO Flushing Stack by ID")
+  for _id,_data in pairs (self.stackbyid) do
+    local data = _data -- #LIFO.IDEntry
+    self:I(string.format("ID: %s | Entry: Number = %s Data = %s UniqueID = %s",tostring(_id),tostring(data.pointer),tostring(data.data),tostring(data.uniqueID)))
+  end
+  self:I("Counter = " .. self.counter)
+  self:I("Pointer = ".. self.pointer)
+  return self
+end
+
+--- LIFO Get table of data entries
+-- @param #LIFO self
+-- @return #table Raw table indexed [1] to [n] of object entries - might be empty!
+function LIFO:GetDataTable()
+  self:T(self.lid.."GetDataTable")
+  local datatable = {}
+  for _,_entry in pairs(self.stackbypointer) do
+    datatable[#datatable+1] = _entry.data
+  end
+  return datatable
+end
+
+--- LIFO Get sorted table of data entries by UniqueIDs (must be numerical UniqueIDs only!)
+-- @param #LIFO self
+-- @return #table Table indexed [1] to [n] of sorted object entries - might be empty!
+function LIFO:GetSortedDataTable()
+  self:T(self.lid.."GetSortedDataTable")
+  local datatable = {}
+  local idtablesorted = self:GetIDStackSorted()
+  for _,_entry in pairs(idtablesorted) do
+    datatable[#datatable+1] = self:ReadByID(_entry)
+  end
+  return datatable
+end
+
+--- Iterate the LIFO and call an iterator function for the given LIFO data, providing the object for each element of the stack and optional parameters.
+-- @param #LIFO self
+-- @param #function IteratorFunction The function that will be called.
+-- @param #table Arg (Optional) Further Arguments of the IteratorFunction.
+-- @param #function Function (Optional) A function returning a #boolean true/false. Only if true, the IteratorFunction is called.
+-- @param #table FunctionArguments (Optional) Function arguments.
+-- @return #LIFO self
+function LIFO:ForEach( IteratorFunction, Arg, Function, FunctionArguments )
+  self:T(self.lid.."ForEach")
+
+  local Set = self:GetPointerStack() or {}
+  Arg = Arg or {}
+
+  local function CoRoutine()
+    local Count = 0
+    for ObjectID, ObjectData in pairs( Set ) do
+      local Object = ObjectData.data
+        self:T( {Object} )
+        if Function then
+          if Function( unpack( FunctionArguments or {} ), Object ) == true then
+            IteratorFunction( Object, unpack( Arg ) )
+          end
+        else
+          IteratorFunction( Object, unpack( Arg ) )
+        end
+        Count = Count + 1
+    end
+    return true
+  end
+
+  local co = CoRoutine
+
+  local function Schedule()
+
+    local status, res = co()
+    self:T( { status, res } )
+
+    if status == false then
+      error( res )
+    end
+    if res == false then
+      return true -- resume next time the loop
+    end
+
+    return false
+  end
+
+  Schedule()
+
+  return self
+end
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- End LIFO
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+end

Moose Development/Moose/Utilities/Profiler.lua

@@ -7,8 +7,7 @@
 -- ### Author: **TAW CougarNL**, *funkyfranky*
 --
 -- @module Utilities.PROFILER
--- @image MOOSE.JPG
+-- @image Utils_Profiler.jpg
-
 
 --- PROFILER class.
 -- @type PROFILER
@@ -26,7 +25,7 @@
 -- @field #string fileNamePrefix Output file name prefix, e.g. "MooseProfiler".
 -- @field #string fileNameSuffix Output file name prefix, e.g. "txt"
 
---- *The emperor counsels simplicity. First principles. Of each particular thing, ask: What is it in itself, in its own constitution? What is its causal nature? *
+--- *The emperor counsels simplicity.* *First principles. Of each particular thing, ask: What is it in itself, in its own constitution? What is its causal nature?*
 --
 -- ===
 --
@@ -39,7 +38,19 @@
 --
 -- # Prerequisites
 --
--- The modules **os** and **lfs** need to be desanizied.
+-- The modules **os**, **io** and **lfs** need to be desanizied. Comment out the lines
+--
+--     --sanitizeModule('os')
+--     --sanitizeModule('io')
+--     --sanitizeModule('lfs')
+--
+-- in your *"DCS World OpenBeta/Scripts/MissionScripting.lua"* file.
+--
+-- But be aware that these changes can make you system vulnerable to attacks.
+--
+-- # Disclaimer
+--
+-- **Profiling itself is CPU expensive!** Don't use this when you want to fly or host a mission.
 --
 --
 -- # Start
@@ -117,13 +128,13 @@ PROFILER = {
 --- Start profiler.
 -- @param #number Delay Delay in seconds before profiler is stated. Default is immediately.
 -- @param #number Duration Duration in (game) seconds before the profiler is stopped. Default is when mission ends.
-function PROFILER.Start(Delay, Duration)
+function PROFILER.Start( Delay, Duration )
 
   -- Check if os, io and lfs are available.
-  local go=true
+  local go = true
   if not os then
-    env.error("ERROR: Profiler needs os to be desanitized!")
+    env.error( "ERROR: Profiler needs os to be de-sanitized!" )
-    go=false
+    go = false
   end
   if not io then
     env.error("ERROR: Profiler needs io to be desanitized!")
@@ -137,8 +148,8 @@ function PROFILER.Start(Delay, Duration)
     return
   end
 
-  if Delay and Delay>0 then
+  if Delay and Delay > 0 then
-    BASE:ScheduleOnce(Delay, PROFILER.Start, 0, Duration)
+    BASE:ScheduleOnce( Delay, PROFILER.Start, 0, Duration )
   else
 
     -- Set start time.
@@ -149,11 +160,11 @@ function PROFILER.Start(Delay, Duration)
     world.addEventHandler(PROFILER.eventHandler)
 
     -- Info in log.
-    env.info('############################   Profiler Started   ############################')
+    env.info( '############################   Profiler Started   ############################' )
     if Duration then
-      env.info(string.format("- Will be running for %d seconds", Duration))
+      env.info( string.format( "- Will be running for %d seconds", Duration ) )
     else
-      env.info(string.format("- Will be stopped when mission ends"))
+      env.info( string.format( "- Will be stopped when mission ends" ) )
     end
     env.info(string.format("- Calls per second threshold %.3f/sec", PROFILER.ThreshCPS))
     env.info(string.format("- Total function time threshold %.3f sec", PROFILER.ThreshTtot))
@@ -171,7 +182,7 @@ function PROFILER.Start(Delay, Duration)
 
     -- Auto stop profiler.
     if Duration then
-      PROFILER.Stop(Duration)
+      PROFILER.Stop( Duration )
     end
 
   end
@@ -180,6 +191,14 @@ end
 
 --- Stop profiler.
 -- @param #number Delay Delay before stop in seconds.
+function PROFILER.Stop( Delay )
+
+  if Delay and Delay > 0 then
+
+    BASE:ScheduleOnce( Delay, PROFILER.Stop )
+  end
+end
+
 function PROFILER.Stop(Delay)
 
   if Delay and Delay>0 then
@@ -206,8 +225,8 @@ function PROFILER.Stop(Delay)
 end
 
 --- Event handler.
-function PROFILER.eventHandler:onEvent(event)
+function PROFILER.eventHandler:onEvent( event )
-  if event.id==world.event.S_EVENT_MISSION_END then
+  if event.id == world.event.S_EVENT_MISSION_END then
     PROFILER.Stop()
   end
 end
@@ -234,7 +253,7 @@ function PROFILER.hook(event)
       end
 
     else
-      PROFILER.Counters[f]=PROFILER.Counters[f]+1
+      PROFILER.Counters[f] = PROFILER.Counters[f] + 1
     end
 
     if PROFILER.fTime[f]==nil then
@@ -262,7 +281,7 @@ end
 -- @return #string Source file name.
 -- @return #string Line number.
 -- @return #number Function time in seconds.
-function PROFILER.getData(func)
+function PROFILER.getData( func )
 
   local n=PROFILER.dInfo[func]
 
@@ -276,15 +295,15 @@ end
 --- Write text to log file.
 -- @param #function f The file.
 -- @param #string txt The text.
-function PROFILER._flog(f, txt)
+function PROFILER._flog( f, txt )
-  f:write(txt.."\r\n")
+  f:write( txt .. "\r\n" )
 end
 
 --- Show table.
 -- @param #table data Data table.
 -- @param #function f The file.
 -- @param #number runTimeGame Game run time in seconds.
-function PROFILER.showTable(data, f, runTimeGame)
+function PROFILER.showTable( data, f, runTimeGame )
 
   -- Loop over data.
   for i=1, #data do
@@ -310,11 +329,11 @@ end
 --- Print csv file.
 -- @param #table data Data table.
 -- @param #number runTimeGame Game run time in seconds.
-function PROFILER.printCSV(data, runTimeGame)
+function PROFILER.printCSV( data, runTimeGame )
 
   -- Output file.
-  local file=PROFILER.getfilename("csv")
+  local file = PROFILER.getfilename( "csv" )
-  local g=io.open(file, 'w')
+  local g = io.open( file, 'w' )
 
   -- Header.
   local text="Function,Total Calls,Calls per Sec,Total Time,Total in %,Sec per Call,Source File;Line Number,"
@@ -325,7 +344,7 @@ function PROFILER.printCSV(data, runTimeGame)
     local t=data[i] --#PROFILER.Data
 
     -- Calls per second.
-    local cps=t.count/runTimeGame
+    local cps = t.count / runTimeGame
 
     -- Output
     local txt=string.format("%s,%d,%.1f,%.3f,%.3f,%.3f,%s,%s,", t.func, t.count, cps, t.tm, t.tm/runTimeGame*100, t.tm/t.count, tostring(t.src), tostring(t.line))
@@ -337,7 +356,6 @@ function PROFILER.printCSV(data, runTimeGame)
   g:close()
 end
 
-
 --- Write info to output file.
 -- @param #string ext Extension.
 -- @return #string File name.
@@ -353,11 +371,11 @@ function PROFILER.getfilename(ext)
     return file
   end
 
-  for i=1,999 do
+  for i = 1, 999 do
 
-    local file=string.format("%s%s-%03d.%s", dir,PROFILER.fileNamePrefix, i, ext)
+    local file = string.format( "%s%s-%03d.%s", dir, PROFILER.fileNamePrefix, i, ext )
 
-    if not UTILS.FileExists(file) then
+    if not UTILS.FileExists( file ) then
       return file
     end
 
@@ -368,7 +386,7 @@ end
 --- Write info to output file.
 -- @param #number runTimeGame Game time in seconds.
 -- @param #number runTimeOS OS time in seconds.
-function PROFILER.showInfo(runTimeGame, runTimeOS)
+function PROFILER.showInfo( runTimeGame, runTimeOS )
 
   -- Output file.
   local file=PROFILER.getfilename(PROFILER.fileNameSuffix)
@@ -406,16 +424,16 @@ function PROFILER.showInfo(runTimeGame, runTimeOS)
       } --#PROFILER.Data
 
       -- Collect special cases. Somehow, e.g. "_copy" appears multiple times so we try to gather all data.
-      if s=="_copy" then
+      if s == "_copy" then
-        if tcopy==nil then
+        if tcopy == nil then
-          tcopy=T
+          tcopy = T
         else
-          tcopy.count=tcopy.count+T.count
+          tcopy.count = tcopy.count + T.count
-          tcopy.tm=tcopy.tm+T.tm
+          tcopy.tm = tcopy.tm + T.tm
         end
-      elseif s=="_Serialize" then
+      elseif s == "_Serialize" then
-        if tserialize==nil then
+        if tserialize == nil then
-          tserialize=T
+          tserialize = T
         else
           tserialize.count=tserialize.count+T.count
           tserialize.tm=tserialize.tm+T.tm
@@ -435,7 +453,7 @@ function PROFILER.showInfo(runTimeGame, runTimeOS)
           tpairs.tm=tpairs.tm+T.tm
         end
       else
-        table.insert(t, T)
+        table.insert( t, T )
       end
 
       -- Total function time.
@@ -450,13 +468,13 @@ function PROFILER.showInfo(runTimeGame, runTimeOS)
 
   -- Add special cases.
   if tcopy then
-    table.insert(t, tcopy)
+    table.insert( t, tcopy )
   end
   if tserialize then
     table.insert(t, tserialize)
   end
   if tforgen then
-    table.insert(t, tforgen)
+    table.insert( t, tforgen )
   end
   if tpairs then
     table.insert(t, tpairs)
@@ -526,14 +544,13 @@ function PROFILER.showInfo(runTimeGame, runTimeOS)
   PROFILER.showTable(t, f, runTimeGame)
 
   -- Closing.
-  PROFILER._flog(f,"")
+  PROFILER._flog( f, "" )
-  PROFILER._flog(f,"************************************************************************************************************************")
+  PROFILER._flog( f, "************************************************************************************************************************" )
-  PROFILER._flog(f,"************************************************************************************************************************")
+  PROFILER._flog( f, "************************************************************************************************************************" )
-  PROFILER._flog(f,"************************************************************************************************************************")
+  PROFILER._flog( f, "************************************************************************************************************************" )
   -- Close file.
   f:close()
 
   -- Print csv file.
-  PROFILER.printCSV(t, runTimeGame)
+  PROFILER.printCSV( t, runTimeGame )
 end
-

Moose Development/Moose/Utilities/STTS.lua

@@ -0,0 +1,259 @@
+--- **Utilities**  DCS Simple Text-To-Speech (STTS).
+--
+--
+-- @module Utils.STTS
+-- @image MOOSE.JPG
+
+--- [DCS Enum world](https://wiki.hoggitworld.com/view/DCS_enum_world)
+-- @type STTS
+-- @field #string DIRECTORY Path of the SRS directory.
+
+--- Simple Text-To-Speech
+--
+-- Version 0.4 - Compatible with SRS version 1.9.6.0+
+--
+-- # DCS Modification Required
+--
+-- You will need to edit MissionScripting.lua in DCS World/Scripts/MissionScripting.lua and remove the sanitization.
+-- To do this remove all the code below the comment - the line starts "local function sanitizeModule(name)"
+-- Do this without DCS running to allow mission scripts to use os functions.
+--
+-- *You WILL HAVE TO REAPPLY AFTER EVERY DCS UPDATE*
+--
+-- # USAGE:
+--
+-- Add this script into the mission as a DO SCRIPT or DO SCRIPT FROM FILE to initialize it
+-- Make sure to edit the STTS.SRS_PORT and STTS.DIRECTORY to the correct values before adding to the mission.
+-- Then its as simple as calling the correct function in LUA as a DO SCRIPT or in your own scripts.
+--
+-- Example calls:
+--
+--     STTS.TextToSpeech("Hello DCS WORLD","251","AM","1.0","SRS",2)
+--
+-- Arguments in order are:
+--
+--  * Message to say, make sure not to use a newline (\n) !
+--  * Frequency in MHz
+--  * Modulation - AM/FM
+--  * Volume - 1.0 max, 0.5 half
+--  * Name of the transmitter - ATC, RockFM etc
+--  * Coalition - 0 spectator, 1 red 2 blue
+--  * OPTIONAL - Vec3 Point i.e Unit.getByName("A UNIT"):getPoint() - needs Vec3 for Height! OR null if not needed
+--  * OPTIONAL - Speed -10 to +10
+--  * OPTIONAL - Gender male, female or neuter
+--  * OPTIONAL - Culture - en-US, en-GB etc
+--  * OPTIONAL - Voice - a specific voice by name. Run DCS-SR-ExternalAudio.exe with --help to get the ones you can use on the command line
+--  * OPTIONAL - Google TTS - Switch to Google Text To Speech - Requires STTS.GOOGLE_CREDENTIALS path and Google project setup correctly
+--
+--
+-- ## Example
+--
+-- This example will say the words "Hello DCS WORLD" on 251 MHz AM at maximum volume with a client called SRS and to the Blue coalition only
+--
+--     STTS.TextToSpeech("Hello DCS WORLD","251","AM","1.0","SRS",2,null,-5,"male","en-GB")
+--
+-- ## Example
+--
+-- This example will say the words "Hello DCS WORLD" on 251 MHz AM at maximum volume with a client called SRS and to the Blue coalition only centered on the position of the Unit called "A UNIT"
+--
+--     STTS.TextToSpeech("Hello DCS WORLD","251","AM","1.0","SRS",2,Unit.getByName("A UNIT"):getPoint(),-5,"male","en-GB")
+--
+-- Arguments in order are:
+--
+--  * FULL path to the MP3 OR OGG to play
+--  * Frequency in MHz - to use multiple separate with a comma - Number of frequencies MUST match number of Modulations
+--  * Modulation - AM/FM - to use multiple
+--  * Volume - 1.0 max, 0.5 half
+--  * Name of the transmitter - ATC, RockFM etc
+--  * Coalition - 0 spectator, 1 red 2 blue
+--
+-- ## Example
+--
+-- This will play that MP3 on 255MHz AM & 31 FM at half volume with a client called "Multiple" and to Spectators only
+--
+--     STTS.PlayMP3("C:\\Users\\Ciaran\\Downloads\\PR-Music.mp3","255,31","AM,FM","0.5","Multiple",0)
+--
+-- @field #STTS
+STTS = {
+  ClassName = "STTS",
+  DIRECTORY = "",
+  SRS_PORT = 5002,
+  GOOGLE_CREDENTIALS = "C:\\Users\\Ciaran\\Downloads\\googletts.json",
+  EXECUTABLE = "DCS-SR-ExternalAudio.exe"
+}
+
+--- FULL Path to the FOLDER containing DCS-SR-ExternalAudio.exe - EDIT TO CORRECT FOLDER
+STTS.DIRECTORY = "D:/DCS/_SRS"
+
+--- LOCAL SRS PORT - DEFAULT IS 5002
+STTS.SRS_PORT = 5002
+
+--- Google credentials file
+STTS.GOOGLE_CREDENTIALS = "C:\\Users\\Ciaran\\Downloads\\googletts.json"
+
+--- DON'T CHANGE THIS UNLESS YOU KNOW WHAT YOU'RE DOING
+STTS.EXECUTABLE = "DCS-SR-ExternalAudio.exe"
+
+--- Function for UUID.
+function STTS.uuid()
+  local random = math.random
+  local template = 'yxxx-xxxxxxxxxxxx'
+  return string.gsub( template, '[xy]', function( c )
+    local v = (c == 'x') and random( 0, 0xf ) or random( 8, 0xb )
+    return string.format( '%x', v )
+  end )
+end
+
+--- Round a number.
+-- @param #number x Number.
+-- @param #number n Precision.
+function STTS.round( x, n )
+  n = math.pow( 10, n or 0 )
+  x = x * n
+  if x >= 0 then
+    x = math.floor( x + 0.5 )
+  else
+    x = math.ceil( x - 0.5 )
+  end
+  return x / n
+end
+
+--- Function returns estimated speech time in seconds.
+-- Assumptions for time calc: 100 Words per min, average of 5 letters for english word so
+--
+--   * 5 chars * 100wpm = 500 characters per min = 8.3 chars per second
+--
+-- So length of msg / 8.3 = number of seconds needed to read it. rounded down to 8 chars per sec map function:
+--
+-- * (x - in_min) * (out_max - out_min) / (in_max - in_min) + out_min
+-- 
+-- @param #number length can also be passed as #string
+-- @param #number speed Defaults to 1.0
+-- @param #boolean isGoogle We're using Google TTS
+function STTS.getSpeechTime(length,speed,isGoogle)
+
+  local maxRateRatio = 3
+
+  speed = speed or 1.0
+  isGoogle = isGoogle or false
+
+  local speedFactor = 1.0
+  if isGoogle then
+    speedFactor = speed
+  else
+    if speed ~= 0 then
+      speedFactor = math.abs( speed ) * (maxRateRatio - 1) / 10 + 1
+    end
+    if speed < 0 then
+      speedFactor = 1 / speedFactor
+    end
+  end
+
+  local wpm = math.ceil( 100 * speedFactor )
+  local cps = math.floor( (wpm * 5) / 60 )
+
+  if type( length ) == "string" then
+    length = string.len( length )
+  end
+
+  return length/cps --math.ceil(length/cps)
+end
+
+--- Text to speech function.
+function STTS.TextToSpeech( message, freqs, modulations, volume, name, coalition, point, speed, gender, culture, voice, googleTTS )
+  if os == nil or io == nil then
+    env.info( "[DCS-STTS] LUA modules os or io are sanitized. skipping. " )
+    return
+  end
+
+  speed = speed or 1
+  gender = gender or "female"
+  culture = culture or ""
+  voice = voice or ""
+  coalition = coalition or "0"
+  name = name or "ROBOT"
+  volume = 1
+  speed = 1
+
+  message = message:gsub( "\"", "\\\"" )
+
+  local cmd = string.format( "start /min \"\" /d \"%s\" /b \"%s\" -f %s -m %s -c %s -p %s -n \"%s\" -h", STTS.DIRECTORY, STTS.EXECUTABLE, freqs or "305", modulations or "AM", coalition, STTS.SRS_PORT, name )
+
+  if voice ~= "" then
+    cmd = cmd .. string.format( " -V \"%s\"", voice )
+  else
+
+    if culture ~= "" then
+      cmd = cmd .. string.format( " -l %s", culture )
+    end
+
+    if gender ~= "" then
+      cmd = cmd .. string.format( " -g %s", gender )
+    end
+  end
+
+  if googleTTS == true then
+    cmd = cmd .. string.format( " -G \"%s\"", STTS.GOOGLE_CREDENTIALS )
+  end
+
+  if speed ~= 1 then
+    cmd = cmd .. string.format( " -s %s", speed )
+  end
+
+  if volume ~= 1.0 then
+    cmd = cmd .. string.format( " -v %s", volume )
+  end
+
+  if point and type( point ) == "table" and point.x then
+    local lat, lon, alt = coord.LOtoLL( point )
+
+    lat = STTS.round( lat, 4 )
+    lon = STTS.round( lon, 4 )
+    alt = math.floor( alt )
+
+    cmd = cmd .. string.format( " -L %s -O %s -A %s", lat, lon, alt )
+  end
+
+  cmd = cmd .. string.format( " -t \"%s\"", message )
+
+  if string.len( cmd ) > 255 then
+    local filename = os.getenv( 'TMP' ) .. "\\DCS_STTS-" .. STTS.uuid() .. ".bat"
+    local script = io.open( filename, "w+" )
+    script:write( cmd .. " && exit" )
+    script:close()
+    cmd = string.format( "\"%s\"", filename )
+    timer.scheduleFunction( os.remove, filename, timer.getTime() + 1 )
+  end
+
+  if string.len( cmd ) > 255 then
+    env.info( "[DCS-STTS] - cmd string too long" )
+    env.info( "[DCS-STTS] TextToSpeech Command :\n" .. cmd .. "\n" )
+  end
+  os.execute( cmd )
+
+  return STTS.getSpeechTime( message, speed, googleTTS )
+end
+
+--- Play mp3 function.
+-- @param #string pathToMP3 Path to the sound file.
+-- @param #string freqs Frequencies, e.g. "305, 256".
+-- @param #string modulations Modulations, e.g. "AM, FM".
+-- @param #string volume Volume, e.g. "0.5".
+function STTS.PlayMP3( pathToMP3, freqs, modulations, volume, name, coalition, point )
+
+  local cmd = string.format( "start \"\" /d \"%s\" /b /min \"%s\" -i \"%s\" -f %s -m %s -c %s -p %s -n \"%s\" -v %s -h", STTS.DIRECTORY, STTS.EXECUTABLE, pathToMP3, freqs or "305", modulations or "AM", coalition or "0", STTS.SRS_PORT, name or "ROBOT", volume or "1" )
+
+  if point and type( point ) == "table" and point.x then
+    local lat, lon, alt = coord.LOtoLL( point )
+
+    lat = STTS.round( lat, 4 )
+    lon = STTS.round( lon, 4 )
+    alt = math.floor( alt )
+
+    cmd = cmd .. string.format( " -L %s -O %s -A %s", lat, lon, alt )
+  end
+
+  env.info( "[DCS-STTS] MP3/OGG Command :\n" .. cmd .. "\n" )
+  os.execute( cmd )
+
+end

Moose Development/Moose/Utilities/Socket.lua

@@ -0,0 +1,152 @@
+--- **Utilities** - Socket.
+--
+-- **Main Features:**
+--
+--    * Creates UDP Sockets
+--    * Send messages to Discord
+--    * Compatible with [FunkMan](https://github.com/funkyfranky/FunkMan)
+--    * Compatible with [DCSServerBot](https://github.com/Special-K-s-Flightsim-Bots/DCSServerBot)
+--
+-- ===
+--
+-- ### Author: **funkyfranky**
+-- @module Utilities.Socket
+-- @image Utilities_Socket.png
+
+
+--- SOCKET class.
+-- @type SOCKET
+-- @field #string ClassName Name of the class.
+-- @field #number verbose Verbosity level.
+-- @field #string lid Class id string for output to DCS log file.
+-- @field #table socket The socket.
+-- @field #number port The port.
+-- @field #string host The host.
+-- @field #table json JSON.
+-- @extends Core.Fsm#FSM
+
+--- **At times I feel like a socket that remembers its tooth.** -- Saul Bellow
+--
+-- ===
+--
+-- # The SOCKET Concept
+-- 
+-- Create a UDP socket server. It enables you to send messages to discord servers via discord bots.
+-- 
+-- **Note** that you have to **de-sanitize** `require` and `package` in your `MissionScripting.lua` file, which is in your `DCS/Scripts` folder.
+--
+--
+-- @field #SOCKET
+SOCKET = {
+  ClassName      = "SOCKET",
+  verbose        =     0,
+  lid            =   nil,
+}
+
+--- Data type. This is the keyword the socket listener uses.
+-- @field #string TEXT Plain text.
+-- @field #string BOMBRESULT Range bombing.
+-- @field #string STRAFERESULT Range strafeing result.
+-- @field #string LSOGRADE Airboss LSO grade.
+SOCKET.DataType={
+  TEXT="moose_text",
+  BOMBRESULT="moose_bomb_result",
+  STRAFERESULT="moose_strafe_result",
+  LSOGRADE="moose_lso_grade",
+}
+
+
+--- SOCKET class version.
+-- @field #string version
+SOCKET.version="0.1.0"
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- TODO list
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+-- TODO: A lot!
+-- TODO: Messages as spoiler.
+-- TODO: Send images?
+
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+-- Constructor
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+--- Create a new SOCKET object.
+-- @param #SOCKET self
+-- @param #number Port UDP port. Default `10042`.
+-- @param #string Host Host. Default `"127.0.0.1"`.
+-- @return #SOCKET self
+function SOCKET:New(Port, Host)
+
+  -- Inherit everything from FSM class.
+  local self=BASE:Inherit(self, FSM:New()) --#SOCKET
+  
+  package.path  = package.path..";.\\LuaSocket\\?.lua;"
+  package.cpath = package.cpath..";.\\LuaSocket\\?.dll;"
+  
+  self.socket = require("socket")
+  
+  self.port=Port or 10042
+  self.host=Host or "127.0.0.1"
+  
+  self.json=loadfile("Scripts\\JSON.lua")()
+  
+  self.UDPSendSocket=self.socket.udp()
+  self.UDPSendSocket:settimeout(0)
+
+  return self
+end
+
+--- Set port.
+-- @param #SOCKET self
+-- @param #number Port Port. Default 10042.
+-- @return #SOCKET self
+function SOCKET:SetPort(Port)
+  self.port=Port or 10042
+end
+
+--- Set host.
+-- @param #SOCKET self
+-- @param #string Host Host. Default `"127.0.0.1"`.
+-- @return #SOCKET self
+function SOCKET:SetHost(Host)
+  self.host=Host or "127.0.0.1"
+end
+
+
+--- Send a table.
+-- @param #SOCKET self
+-- @param #table Table Table to send.
+-- @return #SOCKET self
+function SOCKET:SendTable(Table)
+
+  local json= self.json:encode(Table)
+  
+  -- Debug info.
+  self:T("Json table:")
+  self:T(json)
+  
+  -- Send data.
+  self.socket.try(self.UDPSendSocket:sendto(json, self.host, self.port))
+
+  return self
+end
+
+--- Send a text message.
+-- @param #SOCKET self
+-- @param #string Text Test message.
+-- @return #SOCKET self
+function SOCKET:SendText(Text)
+
+  local message={}
+  
+  message.command = SOCKET.DataType.TEXT
+  message.text = Text  
+
+  self:SendTable(message)
+
+  return self
+end
+
+