Moved ZoneGoal and ZoneGoalCoalition from Core to Functional

Moose Development/Moose/Functional/ZoneCaptureCoalition.lua

@@ -1,4 +1,4 @@
---- **Core** -- Base class that models processes to capture a Zone for a Coalition, guarded by another Coalition.
+--- **Functional** -- Base class that models processes to capture a Zone for a Coalition, guarded by another Coalition.
 --
 -- ====
 -- 
@@ -15,7 +15,7 @@
 do -- ZoneGoal
 
   --- @type ZONE_CAPTURE_COALITION
-  -- @extends Core.ZoneGoalCoalition#ZONE_GOAL_COALITION
+  -- @extends Functional.ZoneGoalCoalition#ZONE_GOAL_COALITION
 
 
   --- # ZONE_CAPTURE_COALITION class, extends @{ZoneGoalCoalition#ZONE_GOAL_COALITION}

Moose Development/Moose/Functional/ZoneGoal.lua

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

Moose Development/Moose/Functional/ZoneGoalCoalition.lua

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