New AI_CARGO_DISPATCHER_APC

Moose Development/Moose/AI/AI_Cargo_Dispatcher_APC.lua

@@ -0,0 +1,158 @@
+--- **AI** -- (R2.4) - Models the intelligent transportation of infantry and other cargo.
+--
+-- ===
+-- 
+-- ### Author: **FlightControl**
+-- 
+-- ===       
+--
+-- @module AI_Cargo_Dispatcher
+
+--- @type AI_CARGO_DISPATCHER_APC
+-- @extends Core.Fsm#FSM_CONTROLLABLE
+
+
+--- # AI\_CARGO\_DISPATCHER\_APC class, extends @{Core.Base#BASE}
+-- 
+-- ===
+-- 
+-- AI\_CARGO\_DISPATCHER\_APC brings a dynamic cargo handling capability for AI groups.
+-- 
+-- Armoured Personnel APCs (APC), Trucks, Jeeps and other carrier equipment can be mobilized to intelligently transport infantry and other cargo within the simulation.
+-- The AI\_CARGO\_DISPATCHER\_APC module uses the @{Cargo} capabilities within the MOOSE framework.
+-- CARGO derived objects must be declared within the mission to make the AI\_CARGO\_DISPATCHER\_APC object recognize the cargo.
+-- Please consult the @{Cargo} module for more information. 
+-- 
+-- 
+-- 
+-- @field #AI_CARGO_DISPATCHER_APC
+AI_CARGO_DISPATCHER_APC = {
+  ClassName = "AI_CARGO_DISPATCHER_APC",
+  SetAPC = nil,
+  SetDeployZones = nil,
+  AI_CARGO_APC = {}
+}
+
+--- @type AI_CARGO_DISPATCHER_APC.AI_CARGO_APC
+-- @map <Wrapper.Group#GROUP, AI.AI_Cargo_APC#AI_CARGO_APC>
+
+--- @field #AI_CARGO_DISPATCHER_APC.AI_CARGO_APC 
+AI_CARGO_DISPATCHER_APC.AICargoAPC = {}
+
+--- Creates a new AI_CARGO_DISPATCHER_APC object.
+-- @param #AI_CARGO_DISPATCHER_APC self
+-- @param Core.Set#SET_GROUP SetAPC
+-- @param Core.Set#SET_CARGO SetCargo
+-- @param Core.Set#SET_ZONE SetDeployZone
+-- @return #AI_CARGO_DISPATCHER_APC
+-- @usage
+-- 
+-- -- Create a new cargo dispatcher
+-- SetAPC = SET_GROUP:New():FilterPrefixes( "APC" ):FilterStart()
+-- SetCargo = SET_CARGO:New():FilterTypes( "Infantry" ):FilterStart()
+-- SetDeployZone = SET_ZONE:New():FilterPrefixes( "Deploy" ):FilterStart()
+-- AICargoDispatcher = AI_CARGO_DISPATCHER_APC:New( SetAPC, SetCargo )
+-- 
+function AI_CARGO_DISPATCHER_APC:New( SetAPC, SetCargo, SetDeployZones )
+
+  local self = BASE:Inherit( self, FSM:New() ) -- #AI_CARGO_DISPATCHER_APC
+
+  self.SetAPC = SetAPC -- Core.Set#SET_GROUP
+  self.SetCargo = SetCargo -- Core.Set#SET_CARGO
+  self.SetDeployZones = SetDeployZones -- Core.Set#SET_ZONE
+
+  self:SetStartState( "APC" ) 
+  
+  self:AddTransition( "*", "Monitor", "*" )
+
+  self:AddTransition( "*", "Pickup", "*" )
+  self:AddTransition( "*", "Loading", "*" )
+  self:AddTransition( "*", "Loaded", "*" )
+
+  self:AddTransition( "*", "Deploy", "*" )
+  self:AddTransition( "*", "Unloading", "*" )
+  self:AddTransition( "*", "Unloaded", "*" )
+  
+  self.PickupTimeInterval = 120
+  self.DeployRadiusInner = 200
+  self.DeployRadiusOuter = 500
+  
+  return self
+end
+
+
+--- The Start trigger event, which actually takes action at the specified time interval.
+-- @param #AI_CARGO_DISPATCHER_APC self
+-- @param Wrapper.Group#GROUP APC
+-- @return #AI_CARGO_DISPATCHER_APC
+function AI_CARGO_DISPATCHER_APC:onafterMonitor()
+
+  for APCGroupName, APC in pairs( self.SetAPC:GetSet() ) do
+    local APC = APC -- Wrapper.Group#GROUP
+    local AICargoAPC = self.AICargoAPC[APC]
+    if not AICargoAPC then
+      -- ok, so this APC does not have yet an AI_CARGO_APC object...
+      -- let's create one and also declare the Loaded and UnLoaded handlers.
+      self.AICargoAPC[APC] = AI_CARGO_APC:New( APC, self.SetCargo, self.CombatRadius )
+      AICargoAPC = self.AICargoAPC[APC]
+      
+      function AICargoAPC.OnAfterPickup( AICargoAPC, APC )
+        self.AICargoAPC = AICargoAPC
+        self:Pickup( APC )
+      end
+      
+      function AICargoAPC.OnAfterLoad( AICargoAPC, APC )
+        self.AICargoAPC = AICargoAPC
+        self:Load( APC )
+      end
+
+      function AICargoAPC.OnAfterLoaded( AICargoAPC, APC )
+        self.AICargoAPC = AICargoAPC
+        self:Loaded( APC )
+      end
+
+      function AICargoAPC.OnAfterDeploy( AICargoAPC, APC )
+        self.AICargoAPC = AICargoAPC
+        self:Deploy( APC )
+      end      
+
+      function AICargoAPC.OnAfterUnload( AICargoAPC, APC )
+        self.AICargoAPC = AICargoAPC
+        self:Unload( APC )
+      end      
+
+      function AICargoAPC.OnAfterUnloaded( AICargoAPC, APC )
+        self.AICargoAPC = AICargoAPC
+        self:Unloaded( APC )
+      end      
+    end
+
+    -- The Pickup sequence ...
+    -- Check if this APC need to go and Pickup something...
+    if not AICargoAPC:IsTransporting() == true then
+      -- ok, so there is a free APC
+      -- now find the first cargo that is Unloaded
+      local FirstCargoUnloaded = self.SetCargo:FirstCargoUnLoaded()
+      if FirstCargoUnloaded then
+        AICargoAPC:Pickup( FirstCargoUnloaded:GetCoordinate() )
+        break
+      end
+    end
+  end
+
+  return self
+end
+
+
+
+--- Make a APC run for a cargo deploy action after the cargo has been loaded, by default.
+-- @param #AI_CARGO_DISPATCHER_APC self
+-- @param Wrapper.Group#GROUP APC
+-- @return #AI_CARGO_DISPATCHER_APC
+function AI_CARGO_DISPATCHER_APC:OnAfterLoaded( APC )
+
+  self:Deploy( self.SetDeployZones:GetRandomZone():GetCoordinate():GetRandomCoordinateInRadius( self.DeployRadiusInner, self.DeployRadiusOuter ) )
+
+  return self
+end
+