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

# Conflicts: # Moose Development/Moose/AI/AI_A2A_Dispatcher.lua # Moose Development/Moose/AI/AI_Balancer.lua # Moose Development/Moose/AI/AI_Cargo_Dispatcher.lua
2025-08-15 10:47:21 +00:00 · 2024-01-03 18:15:58 +01:00
parent e5fbaeafcd db6dc7b77e
commit 8910311c5c
38 changed files with 132 additions and 90 deletions
--- a/Development/Moose/AI/AI_A2A_Dispatcher.lua
+++ b/Development/Moose/AI/AI_A2A_Dispatcher.lua
@@ -23,7 +23,7 @@
 --
 -- ## Missions:
 --
-- [AID-A2A - AI A2A Dispatching](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AID%20-%20AI%20Dispatching/AID-A2A%20-%20AI%20A2A%20Dispatching)
+-- [AID-A2A - AI A2A Dispatching](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AI/AI_A2A_Dispatcher)
 --
 -- ===
 --
@@ -310,7 +310,7 @@ do -- AI_A2A_DISPATCHER
  -- Use the method @{#AI_A2A_DISPATCHER.SetEngageRadius}() to set a specific Engage Radius.
  -- **The Engage Radius is defined for ALL squadrons which are operational.**
  --
-  -- Demonstration Mission: [AID-019 - AI_A2A - Engage Range Test](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AID%20-%20AI%20Dispatching/AID-A2A%20-%20AI%20A2A%20Dispatching/AID-A2A-019%20-%20Engage%20Range%20Test)
+  -- Demonstration Mission: [AID-019 - AI_A2A - Engage Range Test](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AI/AI_A2A_Dispatcher/AID-A2A-019%20-%20Engage%20Range%20Test)
  --
  -- In this example an Engage Radius is set to various values.
  --
@@ -333,7 +333,7 @@ do -- AI_A2A_DISPATCHER
  -- Use the method @{#AI_A2A_DISPATCHER.SetGciRadius}() to set a specific controlled ground intercept radius.
  -- **The Ground Controlled Intercept radius is defined for ALL squadrons which are operational.**
  --
-  -- Demonstration Mission: [AID-013 - AI_A2A - Intercept Test](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AID%20-%20AI%20Dispatching/AID-A2A%20-%20AI%20A2A%20Dispatching/AID-A2A-013%20-%20Intercept%20Test)
+  -- Demonstration Mission: [AID-013 - AI_A2A - Intercept Test](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AI/AI_A2A_Dispatcher/AID-A2A-013%20-%20Intercept%20Test)
  --
  -- In these examples, the Gci Radius is set to various values:
  --
@@ -366,7 +366,7 @@ do -- AI_A2A_DISPATCHER
  -- it makes it easier sometimes for the mission maker to envisage where the red and blue territories roughly are.
  -- In a hot war the borders are effectively defined by the ground based radar coverage of a coalition.
  --
-  -- Demonstration Mission: [AID-009 - AI_A2A - Border Test](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AID%20-%20AI%20Dispatching/AID-A2A%20-%20AI%20A2A%20Dispatching/AID-A2A-009%20-%20Border%20Test)
+  -- Demonstration Mission: [AID-009 - AI_A2A - Border Test](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AI/AI_A2A_Dispatcher/AID-A2A-009%20-%20Border%20Test)
  --
  -- In this example a border is set for the CCCP A2A dispatcher:
  --
@@ -1233,7 +1233,7 @@ do -- AI_A2A_DISPATCHER
  --
  -- **Use the method @{#AI_A2A_DISPATCHER.SetEngageRadius}() to modify the default Engage Radius for ALL squadrons.**
  --
-  -- Demonstration Mission: [AID-019 - AI_A2A - Engage Range Test](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AID%20-%20AI%20Dispatching/AID-A2A%20-%20AI%20A2A%20Dispatching/AID-A2A-019%20-%20Engage%20Range%20Test)
+  -- Demonstration Mission: [AID-019 - AI_A2A - Engage Range Test](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AI/AI_A2A_Dispatcher/AID-A2A-019%20-%20Engage%20Range%20Test)
  --
  -- @param #AI_A2A_DISPATCHER self
  -- @param #number EngageRadius (Optional, Default = 100000) The radius to report friendlies near the target.
@@ -1283,7 +1283,7 @@ do -- AI_A2A_DISPATCHER
  -- Use the method @{#AI_A2A_DISPATCHER.SetGciRadius}() to set a specific controlled ground intercept radius.
  -- **The Ground Controlled Intercept radius is defined for ALL squadrons which are operational.**
  --
-  -- Demonstration Mission: [AID-013 - AI_A2A - Intercept Test](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AID%20-%20AI%20Dispatching/AID-A2A%20-%20AI%20A2A%20Dispatching/AID-A2A-013%20-%20Intercept%20Test)
+  -- Demonstration Mission: [AID-013 - AI_A2A - Intercept Test](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AI/AI_A2A_Dispatcher/AID-A2A-013%20-%20Intercept%20Test)
  --
  -- @param #AI_A2A_DISPATCHER self
  -- @param #number GciRadius (Optional, Default = 200000) The radius to ground control intercept detected targets from the nearest airbase.
@@ -3257,6 +3257,7 @@ do -- AI_A2A_DISPATCHER
            end
          end

+          --- AI_A2A_Fsm:onafterHome
          -- @param #AI_A2A_DISPATCHER self
          function AI_A2A_Fsm:onafterHome( Defender, From, Event, To, Action )
            if Defender and Defender:IsAlive() then
@@ -3505,6 +3506,7 @@ do -- AI_A2A_DISPATCHER
                    Dispatcher:ClearDefenderTaskTarget( DefenderGroup )
                  end

+                  --- function Fsm:onafterLostControl
                  -- @param #AI_A2A_DISPATCHER self
                  function Fsm:onafterLostControl( Defender, From, Event, To )
                    self:F( { "GCI LostControl", Defender:GetName() } )
@@ -3518,6 +3520,7 @@ do -- AI_A2A_DISPATCHER
                    end
                  end

+                  --- function Fsm:onafterHome
                  -- @param #AI_A2A_DISPATCHER self
                  function Fsm:onafterHome( DefenderGroup, From, Event, To, Action )
                    self:F( { "GCI Home", DefenderGroup:GetName() } )
@@ -3959,7 +3962,7 @@ do
  --
  -- # Demo Missions
  --
-  -- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AID%20-%20AI%20Dispatching/AID-A2A%20-%20AI%20A2A%20Dispatching)
+  -- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AI/AI_A2A_Dispatcher)
  --
  -- ===
  --
--- a/Development/Moose/AI/AI_A2G_Dispatcher.lua
+++ b/Development/Moose/AI/AI_A2G_Dispatcher.lua
@@ -24,7 +24,7 @@
 -- 
 -- ## Missions:
 -- 
-- [AID-A2G - AI A2G Dispatching](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AID%20-%20AI%20Dispatching/AID-A2G%20-%20AI%20A2G%20Dispatching)
+-- [AID-A2G - AI A2G Dispatching](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AI/AI_A2G_Dispatcher)
 -- 
 -- ===
 -- 
--- a/Development/Moose/AI/AI_Air_Dispatcher.lua
+++ b/Development/Moose/AI/AI_Air_Dispatcher.lua
@@ -24,7 +24,7 @@
 -- 
 -- ## Missions:
 -- 
-- [AID-AIR - AI AIR Dispatching](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AID%20-%20AI%20Dispatching)
+-- [AI_A2A_Dispatcher](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AI/AI_A2A_Dispatcher)
 -- 
 -- ===
 -- 
--- a/Development/Moose/AI/AI_BAI.lua
+++ b/Development/Moose/AI/AI_BAI.lua
@@ -11,7 +11,7 @@
 --
 -- ===
 -- 
-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/BAI%20-%20Battlefield%20Air%20Interdiction)
+-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AI/AI_BAI)
 -- 
 -- ===
 -- 
--- a/Development/Moose/AI/AI_Balancer.lua
+++ b/Development/Moose/AI/AI_Balancer.lua
@@ -9,7 +9,7 @@
 -- 
 -- ===
 -- 
-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AIB%20-%20AI%20Balancing)
+-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AI/AI_Balancer)
 -- 
 -- ===
 -- 
@@ -168,6 +168,7 @@ function AI_BALANCER:ReturnToHomeAirbase( ReturnThresholdRange )
  self.ReturnThresholdRange = ReturnThresholdRange
 end

+--- AI_BALANCER:onenterSpawning
 -- @param #AI_BALANCER self
 -- @param Core.Set#SET_GROUP SetGroup
 -- @param #string ClientName
@@ -190,6 +191,7 @@ function AI_BALANCER:onenterSpawning( SetGroup, From, Event, To, ClientName )
  end
 end

+--- AI_BALANCER:onenterDestroying
 -- @param #AI_BALANCER self
 -- @param Core.Set#SET_GROUP SetGroup
 -- @param Wrapper.Group#GROUP AIGroup
@@ -233,7 +235,7 @@ function AI_BALANCER:onenterReturning( SetGroup, From, Event, To, AIGroup )

 end

-
+--- AI_BALANCER:onenterMonitoring
 -- @param #AI_BALANCER self
 function AI_BALANCER:onenterMonitoring( SetGroup )

@@ -241,6 +243,7 @@ function AI_BALANCER:onenterMonitoring( SetGroup )
  --self.SetClient:Flush()

  self.SetClient:ForEachClient(
+    --- SetClient:ForEachClient
    -- @param Wrapper.Client#CLIENT Client
    function( Client )
      self:T3(Client.ClientName)
@@ -264,6 +267,7 @@ function AI_BALANCER:onenterMonitoring( SetGroup )
            self:T2( RangeZone )
            
            _DATABASE:ForEachPlayerUnit(
+              --- Nameless function
              -- @param Wrapper.Unit#UNIT RangeTestUnit
              function( RangeTestUnit, RangeZone, AIGroup, PlayerInRange )
                self:T2( { PlayerInRange, RangeTestUnit.UnitName, RangeZone.ZoneName } )
@@ -276,6 +280,7 @@ function AI_BALANCER:onenterMonitoring( SetGroup )
                end
              end,
              
+              --- Nameless function
              -- @param Core.Zone#ZONE_RADIUS RangeZone
              -- @param Wrapper.Group#GROUP AIGroup
              function( RangeZone, AIGroup, PlayerInRange )
@@ -307,6 +312,3 @@ function AI_BALANCER:onenterMonitoring( SetGroup )
  
  self:__Monitor( 10 )
 end
-
-
-
--- a/Development/Moose/AI/AI_CAP.lua
+++ b/Development/Moose/AI/AI_CAP.lua
@@ -9,7 +9,7 @@
 --
 -- ===
 -- 
-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/CAP%20-%20Combat%20Air%20Patrol)
+-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AI/AI_CAP)
 -- 
 -- ===
 -- 
--- a/Development/Moose/AI/AI_CAS.lua
+++ b/Development/Moose/AI/AI_CAS.lua
@@ -11,7 +11,7 @@
 --
 -- ===
 -- 
-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/CAS%20-%20Close%20Air%20Support)
+-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AI/AI_CAS)
 -- 
 -- ===
 -- 
--- a/Development/Moose/AI/AI_Cargo_Dispatcher.lua
+++ b/Development/Moose/AI/AI_Cargo_Dispatcher.lua
@@ -18,7 +18,7 @@
 -- 
 -- Test missions can be located on the main GITHUB site.
 -- 
-- [FlightControl-Master/MOOSE_MISSIONS/AID - AI Dispatching/AID-CGO - AI Cargo Dispatching/](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/AID%20-%20AI%20Dispatching/AID-CGO%20-%20AI%20Cargo%20Dispatching)
+-- [FlightControl-Master/MOOSE_MISSIONS/AID - AI Dispatching/AID-CGO - AI Cargo Dispatching/](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AI/AI_Cargo_Dispatcher)
 -- 
 -- ===
 -- 
@@ -572,7 +572,7 @@
 -- A home zone can be specified to where the Carriers will move when there isn't any cargo left for pickup.
 -- Use @{#AI_CARGO_DISPATCHER.SetHomeZone}() to specify the home zone.
 -- 
-- If no home zone is specified, the carriers will wait near the deploy zone for a new pickup command.   
+-- If no home zone is specified, the carriers will wait near the deploy zone for a new pickup command.
 -- 
 -- ===
 --   
@@ -583,9 +583,11 @@ AI_CARGO_DISPATCHER = {
  PickupCargo = {}
 }

-- @field #list 
+--- List of AI_Cargo
+-- @field #list
 AI_CARGO_DISPATCHER.AI_Cargo = {}

+--- List of PickupCargo
 -- @field #list
 AI_CARGO_DISPATCHER.PickupCargo = {}

--- a/Development/Moose/AI/AI_Escort.lua
+++ b/Development/Moose/AI/AI_Escort.lua
@@ -19,7 +19,7 @@
 -- 
 -- ## Missions:
 -- 
-- [ESC - Escorting](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/ESC%20-%20Escorting)
+-- [ESC - Escorting](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AI/AI_Escort)
 -- 
 -- ===
 -- 
--- a/Development/Moose/AI/AI_Escort_Request.lua
+++ b/Development/Moose/AI/AI_Escort_Request.lua
@@ -19,7 +19,7 @@
 -- 
 -- ## Missions:
 -- 
-- [ESC - Escorting](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/ESC%20-%20Escorting)
+-- [ESC - Escorting](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AI/AI_Escort)
 -- 
 -- ===
 -- 
--- a/Development/Moose/AI/AI_Formation.lua
+++ b/Development/Moose/AI/AI_Formation.lua
@@ -7,13 +7,13 @@
 --   * Assign a group leader that will guide the large formation path.
 -- 
 -- ===
-- 
-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/FOR%20-%20AI%20Group%20Formation)
-- 
-- ===
-- 
-- ### [YouTube Playlist](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl0bFIJ9jIdYM22uaWmIN4oz)
-- 
+--
+-- ## Additional Material:
+--
+-- * **Demo Missions:** [GitHub](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AI/AI_Formation)
+-- * **YouTube videos:** [Playlist](https://www.youtube.com/playlist?list=PL7ZUrU4zZUl0bFIJ9jIdYM22uaWmIN4oz)
+-- * **Guides:** None
+--
 -- ===
 -- 
 -- ### Author: **FlightControl**
--- a/Development/Moose/AI/AI_Patrol.lua
+++ b/Development/Moose/AI/AI_Patrol.lua
@@ -16,7 +16,7 @@
 --   
 -- ===
 -- 
-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/PAT%20-%20Patrolling)
+-- ### [Demo Missions](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/AI/AI_Patrol)
 -- 
 -- ===
 --