Merge branch 'master' into develop

Moose Development/Moose/Functional/Sead.lua

@@ -1,26 +1,26 @@
 --- **Functional** -- Make SAM sites execute evasive and defensive behaviour when being fired upon.
--- 
+--
 -- ===
--- 
+--
 -- ## Features:
--- 
+--
 --   * 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.
--- 
+--
 -- ===
--- 
+--
 -- ## Missions:
--- 
+--
 -- [SEV - SEAD Evasion](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/SEV%20-%20SEAD%20Evasion)
--- 
+--
 -- ===
--- 
+--
 -- ### Authors: **FlightControl**, **applevangelist**
--- 
+--
 -- Last Update: Feb 2021
--- 
+--
 -- ===
--- 
+--
 -- @module Functional.Sead
 -- @image SEAD.JPG
 
@@ -28,24 +28,24 @@
 -- @extends Core.Base#BASE
 
 --- 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.
--- 
+--
 -- # Constructor:
--- 
+--
 -- Use the @{#SEAD.New}() constructor to create a new SEAD object.
--- 
+--
 --       SEAD_RU_SAM_Defenses = SEAD:New( { 'RU SA-6 Kub', 'RU SA-6 Defenses', 'RU MI-26 Troops', 'RU Attack Gori' } )
--- 
+--
 -- @field #SEAD
 SEAD = {
-	ClassName = "SEAD", 
+	ClassName = "SEAD",
 	TargetSkill = {
 		Average   = { Evade = 30, DelayOn = { 40, 60 } } ,
 		Good      = { Evade = 20, DelayOn = { 30, 50 } } ,
 		High      = { Evade = 15, DelayOn = { 20, 40 } } ,
-		Excellent = { Evade = 10, DelayOn = { 10, 30 } } 
+		Excellent = { Evade = 10, DelayOn = { 10, 30 } }
-	}, 
+	},
 	SEADGroupPrefixes = {},
 	SuppressedGroups = {},
 	EngagementRange = 75 --  default 75% engagement range Feature Request #1355
@@ -84,7 +84,7 @@ SEAD = {
   ["X_31"] = "X_31",
   ["Kh25"] = "Kh25",
   }
-  
+
 --- Creates the main object which is handling defensive actions for SA sites or moving SA vehicles.
 -- When an anti radiation missile is fired (KH-58, KH-31P, KH-31A, KH-25MPU, HARM missiles), the SA will shut down their radars and will take evasive actions...
 -- Chances are big that the missile will miss.
@@ -99,7 +99,7 @@ function SEAD:New( SEADGroupPrefixes )
 
 	local self = BASE:Inherit( self, BASE:New() )
 	self:F( SEADGroupPrefixes )
-	
+
 	if type( SEADGroupPrefixes ) == 'table' then
 		for SEADGroupPrefixID, SEADGroupPrefix in pairs( SEADGroupPrefixes ) do
 			self.SEADGroupPrefixes[SEADGroupPrefix] = SEADGroupPrefix
@@ -107,7 +107,7 @@ function SEAD:New( SEADGroupPrefixes )
 	else
 		self.SEADGroupPrefixes[SEADGroupPrefixes] = SEADGroupPrefixes
 	end
-	
+
 	self:HandleEvent( EVENTS.Shot )
 	self:I("*** SEAD - Started Version 0.2.7")
 	return self
@@ -120,7 +120,7 @@ end
 function SEAD:UpdateSet( SEADGroupPrefixes )
 
   self:F( SEADGroupPrefixes )
-  
+
   if type( SEADGroupPrefixes ) == 'table' then
     for SEADGroupPrefixID, SEADGroupPrefix in pairs( SEADGroupPrefixes ) do
       self.SEADGroupPrefixes[SEADGroupPrefix] = SEADGroupPrefix
@@ -174,10 +174,10 @@ function SEAD:OnEventShot( EventData )
 
 	self:T( "*** SEAD - Missile Launched = " .. SEADWeaponName)
 	self:T({ SEADWeapon })
-	
+
 	--[[check for SEAD missiles
   if SEADWeaponName == "weapons.missiles.X_58" --Kh-58U anti-radiation missiles fired
-    or 
+    or
     SEADWeaponName == "weapons.missiles.Kh25MP_PRGS1VP" --Kh-25MP anti-radiation missiles fired
     or
     SEADWeaponName == "weapons.missiles.X_25MP" --Kh-25MPU anti-radiation missiles fired
@@ -225,7 +225,7 @@ function SEAD:OnEventShot( EventData )
 				self:T( '*** SEAD - Group Found' )
 				break
 			end
-		end		
+		end
 		if SEADGroupFound == true then -- yes we are being attacked
 			if _targetskill == "Random" then -- when skill is random, choose a skill
 				local Skills = { "Average", "Good", "High", "Excellent" }
@@ -234,16 +234,16 @@ function SEAD:OnEventShot( EventData )
 			self:T( _targetskill )
 			if self.TargetSkill[_targetskill] then
 				if (_evade > self.TargetSkill[_targetskill].Evade) then
-				
+
 					self:T( string.format("*** SEAD - Evading, target skill  " ..string.format(_targetskill)) )
-				
+
 					local _targetMimgroup = Unit.getGroup(Weapon.getTarget(SEADWeapon))
 					local _targetMimcont= _targetMimgroup:getController()
-					
+
 					routines.groupRandomDistSelf(_targetMimgroup,300,'Diamond',250,20) -- move randomly
-					
+
 					--tracker ID table to switch groups off and on again
-					local id = { 
+					local id = {
 					groupName = _targetMimgroup,
 					ctrl = _targetMimcont
 					}
@@ -252,7 +252,7 @@ function SEAD:OnEventShot( EventData )
 					 local range = self.EngagementRange -- Feature Request #1355
 					  self:T(string.format("*** SEAD - Engagement Range is %d", range))
 						id.ctrl:setOption(AI.Option.Ground.id.ALARM_STATE,AI.Option.Ground.val.ALARM_STATE.RED)
-						id.groupName:enableEmission(true)
+						--id.groupName:enableEmission(true)
 						id.ctrl:setOption(AI.Option.Ground.id.AC_ENGAGEMENT_RANGE_RESTRICTION,range) --Feature Request #1355
 						self.SuppressedGroups[id.groupName] = nil  --delete group id from table when done
 					end
@@ -264,8 +264,8 @@ function SEAD:OnEventShot( EventData )
 						self.SuppressedGroups[id.groupName] = {
 							SuppressionEndTime = delay
 						  }
-						--Controller.setOption(_targetMimcont, AI.Option.Ground.id.ALARM_STATE,AI.Option.Ground.val.ALARM_STATE.GREEN)
+						Controller.setOption(_targetMimcont, AI.Option.Ground.id.ALARM_STATE,AI.Option.Ground.val.ALARM_STATE.GREEN)
-						_targetMimgroup:enableEmission(false)
+						--_targetMimgroup:enableEmission(false)
 						timer.scheduleFunction(SuppressionEnd, id, SuppressionEndTime)	--Schedule the SuppressionEnd() function
 					end
 				end

Moose Development/Moose/Functional/Shorad.lua

@@ -1,20 +1,20 @@
 --- **Functional** -- Short Range Air Defense System
--- 
+--
 -- ===
--- 
+--
 -- **SHORAD** - Short Range Air Defense System
 -- Controls a network of short range air/missile defense groups.
--- 
+--
 -- ===
--- 
+--
 -- ## Missions:
 --
 -- ### [SHORAD - Short Range Air Defense](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master/SRD%20-%20SHORAD%20Defense)
--- 
+--
 -- ===
--- 
+--
 -- ### Author : **applevangelist **
--- 
+--
 -- @module Functional.Shorad
 -- @image Functional.Shorad.jpg
 --
@@ -26,7 +26,7 @@
 -- @field #string ClassName
 -- @field #string name Name of this Shorad
 -- @field #boolean debug Set the debug state
--- @field #string Prefixes String to be used to build the @{#Core.Set#SET_GROUP} 
+-- @field #string Prefixes String to be used to build the @{#Core.Set#SET_GROUP}
 -- @field #number Radius Shorad defense radius in meters
 -- @field Core.Set#SET_GROUP Groupset The set of Shorad groups
 -- @field Core.Set#SET_GROUP Samset The set of SAM groups to defend
@@ -41,10 +41,10 @@
 -- @field #boolean UseEmOnOff Decide if we are using Emission on/off (default) or AlarmState red/green.
 -- @extends Core.Base#BASE
 
---- *Good friends are worth defending.* Mr Tushman, Wonder (the Movie) 
+--- *Good friends are worth defending.* Mr Tushman, Wonder (the Movie)
--- 
+--
 -- Simple Class for a more intelligent Short Range Air Defense System
--- 
+--
 -- #SHORAD
 -- Moose derived missile intercepting short range defense system.
 -- Protects a network of SAM sites. Uses events to switch on the defense groups closest to the enemy.
@@ -52,26 +52,26 @@
 --
 -- ## Usage
 --
--- Set up a #SET_GROUP for the SAM sites to be protected:  
+-- Set up a #SET_GROUP for the SAM sites to be protected:
--- 
+--
---        `local SamSet = SET_GROUP:New():FilterPrefixes("Red SAM"):FilterCoalitions("red"):FilterStart()`   
+--        `local SamSet = SET_GROUP:New():FilterPrefixes("Red SAM"):FilterCoalitions("red"):FilterStart()`
---    
+--
--- By default, SHORAD will defense against both HARMs and AG-Missiles with short to medium range. The default defense probability is 70-90%.
+-- By default, SHORAD will defense against both HARMs and AG-Missiles with short to medium range. The default defense probability is 70-90%.
--- When a missile is detected, SHORAD will activate defense groups in the given radius around the target for 10 minutes. It will *not* react to friendly fire.    
+-- When a missile is detected, SHORAD will activate defense groups in the given radius around the target for 10 minutes. It will *not* react to friendly fire.
---        
+--
--- ### Start a new SHORAD system, parameters are:
+-- ### Start a new SHORAD system, parameters are:
---   
+--
---  * Name: Name of this SHORAD.  
+--  * Name: Name of this SHORAD.
---  * ShoradPrefix: Filter for the Shorad #SET_GROUP.  
+--  * ShoradPrefix: Filter for the Shorad #SET_GROUP.
---  * Samset: The #SET_GROUP of SAM sites to defend.  
+--  * Samset: The #SET_GROUP of SAM sites to defend.
---  * Radius: Defense radius in meters. 
+--  * Radius: Defense radius in meters.
---  * ActiveTimer: Determines how many seconds the systems stay on red alert after wake-up call.  
+--  * ActiveTimer: Determines how many seconds the systems stay on red alert after wake-up call.
---  * Coalition: Coalition, i.e. "blue", "red", or "neutral".* 
+--  * Coalition: Coalition, i.e. "blue", "red", or "neutral".*
---    
+--
---        `myshorad = SHORAD:New("RedShorad", "Red SHORAD", SamSet, 25000, 600, "red")`       
+--        `myshorad = SHORAD:New("RedShorad", "Red SHORAD", SamSet, 25000, 600, "red")`
+--
+-- ## Customize options
 --
--- ## Customize options   
---  
 --  * SHORAD:SwitchDebug(debug)
 --  * SHORAD:SwitchHARMDefense(onoff)
 --  * SHORAD:SwitchAGMDefense(onoff)
@@ -96,7 +96,7 @@ SHORAD = {
   DefendMavs = true,
   DefenseLowProb = 70,
   DefenseHighProb = 90,
-  UseEmOnOff = true,  
+  UseEmOnOff = false,
 }
 
 -----------------------------------------------------------------------
@@ -137,7 +137,7 @@ do
   ["X_31"] = "X_31",
   ["Kh25"] = "Kh25",
   }
-  
+
   --- TODO complete list?
   -- @field Mavs
   SHORAD.Mavs = {
@@ -148,7 +148,7 @@ do
   ["Kh31"] = "Kh31",
   ["Kh66"] = "Kh66",
   }
-  
+
   --- Instantiates a new SHORAD object
   -- @param #SHORAD self
   -- @param #string Name Name of this SHORAD
@@ -157,10 +157,10 @@ do
   -- @param #number Radius Defense radius in meters, used to switch on groups
   -- @param #number ActiveTimer Determines how many seconds the systems stay on red alert after wake-up call
   -- @param #string Coalition Coalition, i.e. "blue", "red", or "neutral"
-  function SHORAD:New(Name, ShoradPrefix, Samset, Radius, ActiveTimer, Coalition) 
+  function SHORAD:New(Name, ShoradPrefix, Samset, Radius, ActiveTimer, Coalition)
     local self = BASE:Inherit( self, BASE:New() )
     self:F({Name, ShoradPrefix, Samset, Radius, ActiveTimer, Coalition})
-    
+
     local GroupSet = SET_GROUP:New():FilterPrefixes(ShoradPrefix):FilterCoalitions(Coalition):FilterCategoryGround():FilterStart()
 
     self.name = Name or "MyShorad"
@@ -176,14 +176,14 @@ do
     self.DefendMavs = true
     self.DefenseLowProb = 70 -- probability to detect a missile shot, low margin
     self.DefenseHighProb = 90  -- probability to detect a missile shot, high margin
-    self.UseEmOnOff = true -- Decide if we are using Emission on/off (default) or AlarmState red/green
+    self.UseEmOnOff = false -- Decide if we are using Emission on/off (default) or AlarmState red/green
     self:I("*** SHORAD - Started Version 0.2.1")
     -- Set the string id for output to DCS.log file.
     self.lid=string.format("SHORAD %s | ", self.name)
     self:_InitState()
     return self
   end
-  
+
   --- Initially set all groups to alarm state GREEN
   -- @param #SHORAD self
   function SHORAD:_InitState()
@@ -204,7 +204,7 @@ do
       math.random()
     end
   end
-  
+
   --- Switch debug state
   -- @param #SHORAD self
   -- @param #boolean debug Switch debug on (true) or off (false)
@@ -221,7 +221,7 @@ do
       BASE:TraceOff()
     end
   end
-  
+
   --- Switch defense for HARMs
   -- @param #SHORAD self
   -- @param #boolean onoff
@@ -230,7 +230,7 @@ do
     local onoff = onoff or true
     self.DefendHarms = onoff
   end
-  
+
   --- Switch defense for AGMs
   -- @param #SHORAD self
   -- @param #boolean onoff
@@ -239,7 +239,7 @@ do
     local onoff = onoff or true
     self.DefendMavs = onoff
   end
-  
+
   --- Set defense probability limits
   -- @param #SHORAD self
   -- @param #number low Minimum detection limit, integer 1-100
@@ -257,7 +257,7 @@ do
     self.DefenseLowProb = low
     self.DefenseHighProb = high
   end
-  
+
   --- Set the number of seconds a SHORAD site will stay active
   -- @param #SHORAD self
   -- @param #number seconds Number of seconds systems stay active
@@ -271,7 +271,7 @@ do
 
   --- Set the number of meters for the SHORAD defense zone
   -- @param #SHORAD self
-  -- @param #number meters Radius of the defense search zone in meters. #SHORADs in this range around a targeted group will go active 
+  -- @param #number meters Radius of the defense search zone in meters. #SHORADs in this range around a targeted group will go active
   function SHORAD:SetDefenseRadius(meters)
     local radius = meters or 20000
     if radius < 0 then
@@ -279,14 +279,14 @@ do
     end
     self.Radius = radius
   end
-  
+
   --- Set using Emission on/off instead of changing alarm state
   -- @param #SHORAD self
   -- @param #boolean switch Decide if we are changing alarm state or AI state
   function SHORAD:SetUsingEmOnOff(switch)
     self.UseEmOnOff = switch or false
   end
-  
+
   --- Check if a HARM was fired
   -- @param #SHORAD self
   -- @param #string WeaponName
@@ -301,7 +301,7 @@ do
     end
     return hit
   end
-  
+
   --- Check if an AGM was fired
   -- @param #SHORAD self
   -- @param #string WeaponName
@@ -316,7 +316,7 @@ do
     end
     return hit
   end
-  
+
   --- Check the coalition of the attacker
   -- @param #SHORAD self
   -- @param #string Coalition name
@@ -324,7 +324,7 @@ do
   function SHORAD:_CheckCoalition(Coalition)
     local owncoalition = self.Coalition
     local othercoalition = ""
-    if Coalition == 0 then 
+    if Coalition == 0 then
       othercoalition = "neutral"
     elseif Coalition == 1 then
       othercoalition = "red"
@@ -338,7 +338,7 @@ do
       return false
     end
   end
-  
+
   --- Check if the missile is aimed at a SHORAD
   -- @param #SHORAD self
   -- @param #string TargetGroupName Name of the target group
@@ -354,9 +354,9 @@ do
         returnname = true
       end
     end
-    return returnname  
+    return returnname
   end
-  
+
   --- Check if the missile is aimed at a SAM site
   -- @param #SHORAD self
   -- @param #string TargetGroupName Name of the target group
@@ -374,7 +374,7 @@ do
     end
     return returnname
   end
-  
+
   --- Calculate if the missile shot is detected
   -- @param #SHORAD self
   -- @return #boolean Returns true for a detection, else false
@@ -387,14 +387,14 @@ do
     end
     return IsDetected
   end
-  
+
   --- Wake up #SHORADs in a zone with diameter Radius for ActiveTimer seconds
   -- @param #SHORAD self
   -- @param #string TargetGroup Name of the target group used to build the #ZONE
   -- @param #number Radius Radius of the #ZONE
   -- @param #number ActiveTimer Number of seconds to stay active
-  -- @usage Use this function to integrate with other systems, example   
+  -- @usage Use this function to integrate with other systems, example
-  -- 
+  --
   -- local SamSet = SET_GROUP:New():FilterPrefixes("Blue SAM"):FilterCoalitions("blue"):FilterStart()
   -- myshorad = SHORAD:New("BlueShorad", "Blue SHORAD", SamSet, 22000, 600, "blue")
   -- myshorad:SwitchDebug(true)
@@ -441,13 +441,13 @@ do
       end
     end
   end
-  
+
   --- Main function - work on the EventData
   -- @param #SHORAD self
   -- @param Core.Event#EVENTDATA EventData The event details table data set
   function SHORAD:OnEventShot( EventData )
     self:F( { EventData } )
-  
+
     --local ShootingUnit = EventData.IniDCSUnit
     --local ShootingUnitName = EventData.IniDCSUnitName
     local ShootingWeapon = EventData.Weapon -- Identify the weapon fired
@@ -459,7 +459,7 @@ do
       local IsDetected = self:_ShotIsDetected()
       -- convert to text
       local DetectedText = "false"
-      if IsDetected then 
+      if IsDetected then
         DetectedText = "true"
       end
       local text = string.format("%s Missile Launched = %s | Detected probability state is %s", self.lid, ShootingWeaponName, DetectedText)
@@ -479,7 +479,7 @@ do
           local text = string.format("%s Missile Target = %s", self.lid, tostring(targetgroupname))
           self:T( text )
           local m = MESSAGE:New(text,10,"Info"):ToAllIf(self.debug)
-          -- check if we or a SAM site are the target 
+          -- check if we or a SAM site are the target
           --local TargetGroup = EventData.TgtGroup -- Wrapper.Group#GROUP
           local shotatus = self:_CheckShotAtShorad(targetgroupname) --#boolean
           local shotatsams = self:_CheckShotAtSams(targetgroupname) --#boolean
@@ -488,10 +488,10 @@ do
             self:T({shotatsams=shotatsams,shotatus=shotatus})
             self:WakeUpShorad(targetgroupname, self.Radius, self.ActiveTimer)
           end
-        end  
+        end
       end
     end
-  end 
+  end
 --
 end
 -----------------------------------------------------------------------