SEAD - align to dev changes, allow callback on SEAD events

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,7 +19,7 @@
 --
 -- ### Authors: **FlightControl**, **applevangelist**
 --
--- Last Update: Aug 2021
+-- Last Update: Nov 2021
 --
 -- ===
 --
@@ -31,6 +33,10 @@
 --- 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:
 --
@@ -51,6 +57,8 @@ SEAD = {
   SuppressedGroups = {},
   EngagementRange = 75, --  default 75% engagement range Feature Request #1355
   Padding = 10,
+  CallBack = nil,
+  UseCallBack = false,
 }
 
   --- Missile enumerators
@@ -93,7 +101,7 @@ SEAD = {
 -- @param #SEAD self
 -- @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
+-- @return #SEAD self
 -- @usage
 -- -- CCCP SEAD Defenses
 -- -- Defends the Russian SA installations from SEAD attacks.
@@ -114,14 +122,18 @@ function SEAD:New( SEADGroupPrefixes, Padding )
   local padding = Padding or 10
   if padding < 10 then padding = 10 end
   self.Padding = padding
+  self.UseEmissionsOnOff = false
+  
+  self.CallBack = nil
+  self.UseCallBack = false
   
   self:HandleEvent( EVENTS.Shot, self.HandleEventShot )
 
-  self:I("*** SEAD - Started Version 0.3.1")
+  self:I("*** SEAD - Started Version 0.3.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
@@ -142,8 +154,8 @@ 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:T( { range } )
   range = range or 75
@@ -157,7 +169,8 @@ end
 
 --- Set the padding in seconds, which extends the radar off time calculated by SEAD
 -- @param #SEAD self
--- @param #number Padding Extra number of seconds to add for the switch-on
+-- @param #number Padding Extra number of seconds to add for the switch-on (default 10 seconds)
+-- @return #SEAD self
 function SEAD:SetPadding(Padding)
   self:T( { Padding } )
   local padding = Padding or 10
@@ -166,56 +179,80 @@ function SEAD:SetPadding(Padding)
   return self
 end
 
-  --- Check if a known HARM was fired
+--- Set SEAD to use emissions on/off in addition to alarm state.
-  -- @param #SEAD self
+-- @param #SEAD self
-  -- @param #string WeaponName
+-- @param #boolean Switch True for on, false for off.
-  -- @return #boolean Returns true for a match
+-- @return #SEAD self
-  -- @return #string name Name of hit in table
+function SEAD:SwitchEmissions(Switch)
-  function SEAD:_CheckHarms(WeaponName)
+  self:T({Switch})
-    self:T( { WeaponName } )
+  self.UseEmissionsOnOff = Switch
-    local hit = false
+  return self
-    local name = ""
+end
-      for _,_name in pairs (SEAD.Harms) do
-        if string.find(WeaponName,_name,1) then 
-          hit = true
-          name = _name 
-          break
-        end
-      end
-    return hit, name
-  end
 
-  --- (Internal) Return distance in meters between two coordinates or -1 on error.
+--- Add an object to call back when going evasive.
-  -- @param #SEAD self
+-- @param #SEAD self
-  -- @param Core.Point#COORDINATE _point1 Coordinate one
+-- @param #table Object The object to call. Needs to have object functions as follows:
-  -- @param Core.Point#COORDINATE _point2 Coordinate two
+-- `:SeadSuppressionPlanned(Group, Name, SuppressionStartTime, SuppressionEndTime)` 
-  -- @return #number Distance in meters
+-- `:SeadSuppressionStart(Group, Name)`, 
-  function SEAD:_GetDistance(_point1, _point2)
+-- `:SeadSuppressionEnd(Group, Name)`, 
-    self:T("_GetDistance")
+-- @return #SEAD self
-    if _point1 and _point2 then
+function SEAD:AddCallBack(Object)
-      local distance1 = _point1:Get2DDistance(_point2)
+  self:T({Class=Object.ClassName})
-      local distance2 = _point1:DistanceFromPointVec2(_point2)
+  self.CallBack = Object
-      --self:T({dist1=distance1, dist2=distance2})
+  self.UseCallBack = true
-      if distance1 and type(distance1) == "number" then
+  return self
-        return distance1
+end
-      elseif distance2 and type(distance2) == "number" then
+
-        return distance2
+--- (Internal) Check if a known HARM was fired
-      else
+-- @param #SEAD self
-        self:E("*****Cannot calculate distance!")
+-- @param #string WeaponName
-        self:E({_point1,_point2})
+-- @return #boolean Returns true for a match
-        return -1
+-- @return #string name Name of hit in table
+function SEAD:_CheckHarms(WeaponName)
+  self:T( { WeaponName } )
+  local hit = false
+  local name = ""
+    for _,_name in pairs (SEAD.Harms) do
+      if string.find(WeaponName,_name,1) then
+        hit = true
+        name = _name
+        break
       end
+    end
+  return hit, name
+end
+
+--- (Internal) Return distance in meters between two coordinates or -1 on error.
+-- @param #SEAD self
+-- @param Core.Point#COORDINATE _point1 Coordinate one
+-- @param Core.Point#COORDINATE _point2 Coordinate two
+-- @return #number Distance in meters
+function SEAD:_GetDistance(_point1, _point2)
+  self:T("_GetDistance")
+  if _point1 and _point2 then
+    local distance1 = _point1:Get2DDistance(_point2)
+    local distance2 = _point1:DistanceFromPointVec2(_point2)
+    --self:T({dist1=distance1, dist2=distance2})
+    if distance1 and type(distance1) == "number" then
+      return distance1
+    elseif distance2 and type(distance2) == "number" then
+      return distance2
     else
-      self:E("******Cannot calculate distance!")
+      self:E("*****Cannot calculate distance!")
       self:E({_point1,_point2})
       return -1
     end
+  else
+    self:E("******Cannot calculate distance!")
+    self:E({_point1,_point2})
+    return -1
   end
+end
 
---- 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.
+--- (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.
--- @see SEAD
+-- @param #SEAD self
--- @param #SEAD
 -- @param Core.Event#EVENTDATA EventData
+-- @return #SEAD self
 function SEAD:HandleEventShot( EventData )
   self:T( { EventData.id } )
   local SEADPlane = EventData.IniUnit -- Wrapper.Unit#UNIT
@@ -245,7 +282,7 @@ function SEAD:HandleEventShot( EventData )
     -- see if we are shot at
     local SEADGroupFound = false
     for SEADGroupPrefixID, SEADGroupPrefix in pairs( self.SEADGroupPrefixes ) do
-      self:T( SEADGroupPrefix )
+      self:T( _targetgroupname, SEADGroupPrefix )
       if string.find( _targetgroupname, SEADGroupPrefix, 1, true ) then
         SEADGroupFound = true
         self:T( '*** SEAD - Group Match Found' )
@@ -291,16 +328,32 @@ function SEAD:HandleEventShot( EventData )
             local function SuppressionStart(args)
               self:T(string.format("*** SEAD - %s Radar Off & Relocating",args[2]))
               local grp = args[1] -- Wrapper.Group#GROUP
-              grp:OptionAlarmStateGreen()
+              local name = args[2] -- #string Group Name 
+              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)
+              end
             end
 
             local function SuppressionStop(args)
               self:T(string.format("*** SEAD - %s Radar On",args[2]))
               local grp = args[1]  -- Wrapper.Group#GROUP
-              grp:OptionAlarmStateRed()
+              local name = args[2] -- #string Group Nam
+              if self.UseEmissionsOnOff then
+                grp:EnableEmission(true)
+              end
+              grp:OptionAlarmStateAuto()
               grp:OptionEngageRange(self.EngagementRange)
-              self.SuppressedGroups[args[2]] = false
+              self.SuppressedGroups[name] = false
+              if self.UseCallBack then
+                local object = self.CallBack
+                object:SeadSuppressionEnd(grp,name)
+              end
             end
 
             -- randomize switch-on time
@@ -316,6 +369,10 @@ function SEAD:HandleEventShot( EventData )
               timer.scheduleFunction(SuppressionStart,{_targetgroup,_targetgroupname},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)
+              end
             end
 
           end
@@ -323,4 +380,5 @@ function SEAD:HandleEventShot( EventData )
       end
     end
   end
+  return self
 end