Merge branch 'develop' into FF/Develop

Moose Development/Moose/AI/AI_A2A_Dispatcher.lua

@@ -1,5 +1,24 @@
 --- **AI** - (R2.2) - Manages the process of an automatic A2A defense system based on an EWR network targets and coordinating CAP and GCI.
 -- 
+-- 
+-- Features:
+-- 
+--    * Setup quickly an A2A defense system for a coalition.
+--    * Setup (CAP) Control Air Patrols at defined zones to enhance your A2A defenses.
+--    * Setup (GCI) Ground Control Intercept at defined airbases to enhance your A2A defenses.
+--    * Define and use an EWR (Early Warning Radar) network.
+--    * Define squadrons at airbases.
+--    * Enable airbases for A2A defenses.
+--    * Add different plane types to different squadrons.
+--    * Add multiple squadrons to different airbases.
+--    * Define different ranges to engage upon intruders.
+--    * Establish an automatic in air refuel process for CAP using refuel tankers.
+--    * Setup default settings for all squadrons and A2A defenses.
+--    * Setup specific settings for specific squadrons.
+--    * Quickly setup an A2A defense system using @{#AI_A2A_GCICAP}.
+--    * Setup a more advanced defense system using @{#AI_A2A_DISPATCHER}.
+-- 
+-- 
 -- # QUICK START GUIDE
 -- 
 -- There are basically two classes available to model an A2A defense system.

Moose Development/Moose/AI/AI_BAI.lua

@@ -1,4 +1,13 @@
---- **AI** -- (R2.1) - Manages the independent process of Battlefield Air Interdiction (bombing) for airplanes.
+--- **AI** -- Peform Battlefield Area Interdiction (BAI) within an engagement zone.
+--
+-- **Features:**
+-- 
+--   * Hold and standby within a patrol zone.
+--   * Engage upon command the assigned targets within an engagement zone.
+--   * Loop the zone until all targets are eliminated.
+--   * Trigger different events upon the results achieved.
+--   * After combat, return to the patrol zone and hold.
+--   * RTB when commanded or after out of fuel.
 --
 -- ===
 -- 

Moose Development/Moose/AI/AI_Balancer.lua

@@ -1,4 +1,11 @@
---- **AI** -- (2.1) - Balance player slots with AI to create an engaging simulation environment, independent of the amount of players. 
+--- **AI** -- Balance player slots with AI to create an engaging simulation environment, independent of the amount of players. 
+-- 
+-- **Features:**
+-- 
+--   * Automatically spawn AI as a replacement of free player slots for a coalition.
+--   * Make the AI to perform tasks.
+--   * Define a maximum amount of AI to be active at the same time.
+--   * Configure the behaviour of AI when a human joins a slot for which an AI is active.
 -- 
 -- ===
 -- 

Moose Development/Moose/AI/AI_CAP.lua

@@ -1,4 +1,12 @@
---- **AI** -- (R2.1) - Manages the independent process of Combat Air Patrol (CAP) for airplanes.
+--- **AI** -- Perform Combat Air Patrolling (CAP) for airplanes.
+--
+-- **Features:**
+-- 
+--   * Patrol AI airplanes within a given zone.
+--   * Trigger detected events when enemy airplanes are detected.
+--   * Manage a fuel treshold to RTB on time.
+--   * Engage the enemy when detected.
+-- 
 --
 -- ===
 -- 
@@ -31,7 +39,7 @@
 -- @extends AI.AI_Patrol#AI_PATROL_ZONE
 
 
--- Implements the core functions to patrol a @{Zone} by an AI @{Wrapper.Controllable} or @{Wrapper.Group} 
+--- Implements the core functions to patrol a @{Zone} by an AI @{Wrapper.Controllable} or @{Wrapper.Group} 
 -- and automatically engage any airborne enemies that are within a certain range or within a certain zone.
 -- 
 -- ![Process](..\Presentations\AI_CAP\Dia3.JPG)

Moose Development/Moose/AI/AI_CAS.lua

@@ -1,4 +1,13 @@
---- **AI** -- (R2.1) - Manages the independent process of Close Air Support for airplanes.
+--- **AI** -- Perform Close Air Support (CAS) near friendlies.
+--
+-- **Features:**
+-- 
+--   * Hold and standby within a patrol zone.
+--   * Engage upon command the enemies within an engagement zone.
+--   * Loop the zone until all enemies are eliminated.
+--   * Trigger different events upon the results achieved.
+--   * After combat, return to the patrol zone and hold.
+--   * RTB when commanded or after fuel.
 --
 -- ===
 -- 

Moose Development/Moose/AI/AI_Cargo_Dispatcher_APC.lua

@@ -1,5 +1,17 @@
---- **AI** -- (R2.4) - Models the intelligent transportation of infantry and other cargo using APCs.
+--- **AI** -- Models the intelligent transportation of infantry and other cargo using APCs.
 --
+-- **Features:**
+-- 
+--   * Quickly transport cargo to various deploy zones using ground vehicles (APCs, trucks ...).
+--   * Various @{Cargo.Cargo#CARGO} types can be transported. These are infantry groups and crates.
+--   * Define a list of deploy zones of various types to transport the cargo to.
+--   * The vehicles follow the roads to ensure the fastest possible cargo transportation over the ground.
+--   * Multiple vehicles can transport multiple cargo as one vehicle group.
+--   * Multiple vehicle groups can be enabled as one collaborating transportation process.
+--   * Infantry loaded as cargo, will unboard in case enemies are nearby and will help defending the vehicles.
+--   * Different ranges can be setup for enemy defenses.
+--   * Different options can be setup to tweak the cargo transporation behaviour.
+--  
 -- ===
 -- 
 -- ### Author: **FlightControl**
@@ -79,7 +91,7 @@ AI_CARGO_DISPATCHER_APC = {
 -- @param Core.Set#SET_GROUP SetAPC The collection of APC @{Wrapper.Group}s.
 -- @param Core.Set#SET_CARGO SetCargo The collection of @{Cargo} derived objects.
 -- @param Core.Set#SET_ZONE SetDeployZone The collection of deploy @{Zone}s, which are used to where the cargo will be deployed by the APCs. 
--- @param #number CombatRadius The cargo will be unloaded from the APC and engage the enemy if the enemy is within CombatRadius range. The radius is in meters, the default value is 500 meters.
+-- @param DCS#Distance CombatRadius The cargo will be unloaded from the APC and engage the enemy if the enemy is within CombatRadius range. The radius is in meters, the default value is 500 meters.
 -- @return #AI_CARGO_DISPATCHER_APC
 -- @usage
 -- 
@@ -89,9 +101,9 @@ AI_CARGO_DISPATCHER_APC = {
 -- SetDeployZone = SET_ZONE:New():FilterPrefixes( "Deploy" ):FilterStart()
 -- AICargoDispatcher = AI_CARGO_DISPATCHER_APC:New( SetAPC, SetCargo, SetDeployZone, 500 )
 -- 
-function AI_CARGO_DISPATCHER_APC:New( SetAPC, SetCargo, SetDeployZones, CombatRadius )
+function AI_CARGO_DISPATCHER_APC:New( SetAPC, SetCargo, SetDeployZone, CombatRadius )
 
-  local self = BASE:Inherit( self, AI_CARGO_DISPATCHER:New( SetAPC, SetCargo, SetDeployZones ) ) -- #AI_CARGO_DISPATCHER_APC
+  local self = BASE:Inherit( self, AI_CARGO_DISPATCHER:New( SetAPC, SetCargo, SetDeployZone ) ) -- #AI_CARGO_DISPATCHER_APC
 
   self.CombatRadius = CombatRadius or 500
 

Moose Development/Moose/AI/AI_Cargo_Dispatcher_Helicopter.lua

@@ -1,4 +1,4 @@
---- **AI** -- (R2.4) - Models the intelligent transportation of infantry and other cargo using Helicopters.
+--- **AI** -- Models the intelligent transportation of infantry and other cargo using Helicopters.
 --
 -- The @{#AI_CARGO_DISPATCHER_HELICOPTER} classes implements the dynamic dispatching of cargo transportation tasks for helicopters.
 --

Moose Development/Moose/AI/AI_Cargo_Helicopter.lua

@@ -254,7 +254,7 @@ function AI_CARGO_HELICOPTER:onafterQueue( Helicopter, From, Event, To, Coordina
     
     local Distance = Coordinate:DistanceFromPointVec2( Helicopter:GetCoordinate() )
     
-    if Distance > 500 then
+    if Distance > 2000 then
       self:__Queue( -10, Coordinate )
     else
     
@@ -348,7 +348,7 @@ function AI_CARGO_HELICOPTER:onafterOrbit( Helicopter, From, Event, To, Coordina
       Route[#Route+1] = WaypointTo
       
       local Tasks = {}
-      Tasks[#Tasks+1] = Helicopter:TaskOrbitCircle( math.random( 30, 80 ), 0, CoordinateTo:GetRandomCoordinateInRadius( 800, 500 ) )
+      Tasks[#Tasks+1] = Helicopter:TaskOrbitCircle( math.random( 30, 80 ), 150, CoordinateTo:GetRandomCoordinateInRadius( 800, 500 ) )
       Route[#Route].task = Helicopter:TaskCombo( Tasks )
   
       Route[#Route+1] = WaypointTo
@@ -641,7 +641,7 @@ function AI_CARGO_HELICOPTER:onafterDeploy( Helicopter, From, Event, To, Coordin
     local Tasks = {}
     
     Tasks[#Tasks+1] = Helicopter:TaskFunction( "AI_CARGO_HELICOPTER._Deploy", self, Coordinate )
-    Tasks[#Tasks+1] = Helicopter:TaskOrbitCircle( math.random( 30, 100 ), 0, CoordinateTo:GetRandomCoordinateInRadius( 800, 500 ) )
+    Tasks[#Tasks+1] = Helicopter:TaskOrbitCircle( math.random( 30, 100 ), 150, CoordinateTo:GetRandomCoordinateInRadius( 800, 500 ) )
     
     --Tasks[#Tasks+1] = Helicopter:TaskLandAtVec2( CoordinateTo:GetVec2() )
     Route[#Route].task = Helicopter:TaskCombo( Tasks )

Moose Development/Moose/AI/AI_Formation.lua

@@ -1,31 +1,11 @@
---- **AI** -- (R2.2) - Build large airborne formations of aircraft.
+--- **AI** -- Build large airborne formations of aircraft.
 -- 
--- ===
+-- **Features:**
+--
+--   * Build in-air formations consisting of more than 40 aircraft as one group.
+--   * Build different formation types.
+--   * Assign a group leader that will guide the large formation path.
 -- 
--- AI_FORMATION makes AI @{Wrapper.Group}s fly in formation of various compositions.
--- The AI_FORMATION class models formations in a different manner than the internal DCS formation logic!!!
--- The purpose of the class is to:
--- 
---   * Make formation building a process that can be managed while in flight, rather than a task.
---   * Human players can guide formations, consisting of larget planes.
---   * Build large formations (like a large bomber field).
---   * Form formations that DCS does not support off the shelve.
--- 
--- A few remarks:
--- 
---   * Depending on the type of plane, the change in direction by the leader may result in the formation getting disentangled while in flight and needs to be rebuild.
---   * Formations are vulnerable to collissions, but is depending on the type of plane, the distance between the planes and the speed and angle executed by the leader.
---   * Formations may take a while to build up.
--- 
--- As a result, the AI_FORMATION is not perfect, but is very useful to:
--- 
---   * Model large formations when flying straight line.
---   * Make humans guide a large formation, when the planes are wide from each other.
--- 
--- There are the following types of classes defined:
--- 
---   * @{#AI_FORMATION}: Create a formation from several @{GROUP}s.
---   
 -- ===
 -- 
 -- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/FOR%20-%20Formation)

Moose Development/Moose/AI/AI_Patrol.lua

@@ -1,4 +1,10 @@
---- **AI** -- (R2.1) - Manages the independent process of Air Patrol for airplanes.
+--- **AI** -- Perform Air Patrolling for airplanes.
+-- 
+-- **Features:**
+-- 
+--   * Patrol AI airplanes within a given zone.
+--   * Trigger detected events when enemy airplanes are detected.
+--   * Manage a fuel treshold to RTB on time.
 -- 
 -- ===
 -- 

Moose Development/Moose/Tasking/CommandCenter.lua

@@ -1,5 +1,12 @@
---- **Tasking** -- A COMMANDCENTER is the owner of multiple missions within MOOSE. 
--- A COMMANDCENTER governs multiple missions, the tasking and the reporting.
+--- **Tasking** -- A command center governs multiple missions, and takes care of the reporting and communications.
+-- 
+-- **Features:**
+-- 
+--   * Govern multiple missions.
+--   * Communicate to coalitions, groups.
+--   * Assign tasks.
+--   * Manage the menus.
+--   * Manage reference zones.
 -- 
 -- ===
 --  

Moose Development/Moose/Tasking/Mission.lua

@@ -1,4 +1,12 @@
---- **Tasking** -- A MISSION is the main owner of a Mission orchestration within MOOSE.
+--- **Tasking** -- A mission models a goal to be achieved through the execution and completion of tasks by human players.
+-- 
+-- **Features:**
+-- 
+--   * A mission has a goal to be achieved, through the execution and completion of tasks of different categories by human players.
+--   * A mission manages these tasks.
+--   * A mission has a state, that indicates the fase of the mission.
+--   * A mission has a menu structure, that facilitates mission reports and tasking menus.
+--   * A mission can assign a task to a player.
 -- 
 -- ===
 -- 

Moose Development/Moose/Tasking/Task_A2A_Dispatcher.lua

@@ -1,7 +1,17 @@
---- **Tasking** - The TASK_A2A_DISPATCHER creates and manages player TASK_A2A tasks based on detected targets.
+--- **Tasking** - Dynamically allocates A2A tasks to human players, based on detected airborne targets through an EWR network.
 -- 
--- Implement the dynamic dispatching of tasks upon groups of detected units determined a @{Set} of EWR installation groups.
+-- **Features:**
 -- 
+--   * Dynamically assign tasks to human players based on detected targets.
+--   * Dynamically change the tasks as the tactical situation evolves during the mission.
+--   * Dynamically assign (CAP) Control Air Patrols tasks for human players to perform CAP.
+--   * Dynamically assign (GCI) Ground Control Intercept tasks for human players to perform GCI.
+--   * Dynamically assign Engage tasks for human players to engage on close-by airborne bogeys.
+--   * Define and use an EWR (Early Warning Radar) network.
+--   * Define different ranges to engage upon intruders.
+--   * Keep task achievements.
+--   * Score task achievements.
+--   
 -- ===
 -- 
 -- ### Author: **FlightControl**

Moose Development/Moose/Tasking/Task_A2G_Dispatcher.lua

@@ -1,5 +1,16 @@
---- **Tasking** - The TASK\_A2G\_DISPATCHER dispatches A2G Tasks to Players based on enemy location detection.
+--- **Tasking** -- Dynamically allocates A2G tasks to human players, based on detected ground targets through reconnaissance. 
 -- 
+-- **Features:**
+-- 
+--   * Dynamically assign tasks to human players based on detected targets.
+--   * 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.
+--   * Define and use an EWR (Early Warning Radar) network.
+--   * Define different ranges to engage upon intruders.
+--   * Keep task achievements.
+--   * Score task achievements.-- 
 -- ===
 -- 
 -- ### Author: **FlightControl**