Support for UNIT and GROUP in RADIO:SetTransmission() + indentation

Moose Development/Moose/Core/Radio.lua

@@ -1,17 +1,17 @@
 --- This module contains the MESSAGE class.
--- 
+--
 -- 1) @{Radio#RADIO} class, extends @{Base#BASE}
 -- =================================================
 -- Radio system to manage radio communications
--- Radio transmissions consist of sound files that are broadcasted on a specific channel and modulation 
+-- Radio transmissions consist of sound files that are broadcasted on a specific channel and modulation
 -- If sent by a UNIT or a GROUP, Radio communications can be subtitled for a specific amount of time
--- 
+--
 -- 1.1) RADIO construction methods
 -- -------------------------------
 -- RADIO is created with @{Radio#RADIO.New}. This doesn't broadcast a transmission, but only create a RADIO object
 -- It should only be used internally. To create a RADIO object, please use @{Positionable#POSITIONABLE.GetRadio}
 -- To actually broadcast your transmission, you need to use @{Radio#RADIO.Broadcast}
---   
+--
 -- @module Radio
 -- @author Grey-Echo
 
@@ -19,15 +19,15 @@
 -- @type RADIO
 -- @extends Core.Base#BASE
 RADIO = {
-    ClassName = "RADIO",
+  ClassName = "RADIO",
-    Positionable,
+  Positionable,
-    FileName = "",
+  FileName = "",
-    Frequency = 0,
+  Frequency = 0,
-    Modulation = radio.modulation.AM,
+  Modulation = radio.modulation.AM,
-    Subtitle = "",
+  Subtitle = "",
-    SubtitleDuration = 0,
+  SubtitleDuration = 0,
-    Power = 100,
+  Power = 100,
-    Loop = 0,   
+  Loop = 0,
 }
 
 --- Create a new RADIO Object. This doesn't broadcast a transmission, though, use @{#RADIO.Broadcast} to actually broadcast
@@ -37,15 +37,15 @@ RADIO = {
 -- @usage
 -- -- If you want to create a RADIO, you probably should use @{Wrapper.Positionable#POSITIONABLE.GetRadio} instead
 function RADIO:New(positionable)
-    local self = BASE:Inherit( self, BASE:New() )
+  local self = BASE:Inherit( self, BASE:New() )
-    self:F(positionable)
+  self:F(positionable)
-    if positionable:GetPointVec2() ~= nil then -- It's stupid, but the only way I found to make sure positionable is valid
+  if positionable:GetPointVec2() ~= nil then -- It's stupid, but the only way I found to make sure positionable is valid
-      self.Positionable = positionable
+    self.Positionable = positionable
-      return self
+    return self
-    else
+  else
-      self:E({"The passed positionable is invalid, no RADIO created", positionable})
+    self:E({"The passed positionable is invalid, no RADIO created", positionable})
-      return nil
+    return nil
-    end
+  end
 end
 
 --- Check validity of the filename passed and sets RADIO.FileName
@@ -58,9 +58,9 @@ function RADIO:SetFileName(filename)
   if type(filename) == "string" then
     if filename:find(".ogg") ~= nil or filename:find(".wav") ~= nil then
       if filename:find("l10n/DEFAULT/") == nil then
-       filename = "l10n/DEFAULT/" .. filename
+        filename = "l10n/DEFAULT/" .. filename
-       self.FileName = filename
+        self.FileName = filename
-       return self
+        return self
       end
     end
   end
@@ -76,8 +76,19 @@ end
 function RADIO:SetFrequency(frequency)
   self:F(frequency)
   if type(frequency) == "number" then
-    if (frequency >= 30 and frequency < 88) or (frequency >= 108 and frequency < 152) or (frequency >= 225 and frequency < 400) then 
+    -- If frequency is in range
+    if (frequency >= 30 and frequency < 88) or (frequency >= 108 and frequency < 152) or (frequency >= 225 and frequency < 400) then
       self.Frequency = frequency * 1000 -- Coversion in Hz
+      -- If the RADIO is attached to a UNIT or a GROUP, we need to send the DCS Command "SetFrequency" to change the UNIT or GROUP frequency
+      if self.Positionable.ClassName == "UNIT" or self.Positionable.ClassName == "GROUP" then
+        self.Positionable:GetDCSObject():getController():setCommand({
+          id = "SetFrequency",
+          params = {
+            frequency = self.Frequency,
+            modulation = self.Modulation,
+          }
+        })
+      end
       return self
     end
   end
@@ -93,11 +104,11 @@ end
 function RADIO:SetModulation(modulation)
   self:F(modulation)
   if type(modulation) == "number" then
-      if modulation == radio.modulation.AM or modulation == radio.modulation.FM then --TODO Maybe make this future proof if ED decides to add an other modulation ?
+    if modulation == radio.modulation.AM or modulation == radio.modulation.FM then --TODO Maybe make this future proof if ED decides to add an other modulation ?
-        self.Modulation = modulation
+      self.Modulation = modulation
-        return self
+      return self
-      end
+    end
-  end 
+  end
   self:E({"Modulation is invalid. Use DCS's enum radio.modulation. Modulation unchanged.", self.Modulation})
   return self
 end
@@ -111,9 +122,9 @@ function RADIO:SetPower(power)
   self:F(power)
   if type(power) == "number" then
     if math.floor(math.abs(power)) == power then
-       self.Power = power --TODO Find what is the maximum power allowed by DCS and limit power to that
+      self.Power = power --TODO Find what is the maximum power allowed by DCS and limit power to that
-       return self
+      return self
-     end
+    end
   end
   self:E({"Power is invalid. Power unchanged.", self.Power})
   return self
@@ -127,8 +138,8 @@ end
 function RADIO:SetLoop(loop)
   self:F(loop)
   if type(loop) == "boolean" then
-      self.Loop = loop
+    self.Loop = loop
-      return self
+    return self
   end
   self:E({"Loop is invalid. Loop unchanged.", self.Loop})
   return self
@@ -147,7 +158,7 @@ function RADIO:SetSubtitle(subtitle, subtitleDuration)
     self.Subtitle = subtitle
   else
     self.Subtitle = ""
-    self:E({"Subtitle is invalid. Subtitle reset.", self.Subtitle}) 
+    self:E({"Subtitle is invalid. Subtitle reset.", self.Subtitle})
   end
   if type(subtitleDuration) == "number" then
     if math.floor(math.abs(subtitleDuration)) == subtitleDuration then
@@ -170,9 +181,9 @@ end
 -- -- but it will work with a UNIT or a GROUP anyway
 -- -- Only the RADIO and the Filename are mandatory
 function RADIO:NewGenericTransmission(...)
-    self:F(arg)
+  self:F(arg)
-    
+
-    return self
+  return self
 end
 
 
@@ -188,13 +199,13 @@ end
 -- @usage
 -- -- In this function the data is especially relevant if the broadcaster is a UNIT or a GROUP,
 -- -- but it will work for any POSITIONABLE
--- -- Only the RADIO and the Filename are mandatory 
+-- -- Only the RADIO and the Filename are mandatory
 -- -- Loop : O is no loop, 1 is loop
 -- -- @TODO : Verify the type of passed args and throw errors when necessary
 function RADIO:NewUnitTransmission(...)
-    self:F(arg)
+  self:F(arg)
-    
+
-    return self
+  return self
 end
 
 --- Actually Broadcast the transmission
@@ -206,35 +217,23 @@ end
 -- -- If the POSITIONABLE is a UNIT or a GROUP, we use the "TransmitMessage" Command
 -- -- In both case, you need to tell the class the name of the file to play with either @{Radio#RADIO.NewTransmission} or @{Radio#RADIO.NewTransmissionUnit}
 -- -- If your POSITIONABLE is a UNIT or a GROUP, the Power is ignored.
--- -- If your POSITIONABLE is not a UNIT or a GROUP, the Subtitle, SubtitleDuration and Loop are ignored 
+-- -- If your POSITIONABLE is not a UNIT or a GROUP, the Subtitle, SubtitleDuration and Loop are ignored
-function RADIO:Broadcast() 
+function RADIO:Broadcast()
-    self:F()
+  self:F()
-    -- If the POSITIONABLE is actually a Unit or a Group, use the more complicated DCS function
+  -- If the POSITIONABLE is actually a Unit or a Group, use the more complicated DCS function
-    if self.Positionable.ClassName == "UNIT" or self.Positionable.ClassName == "GROUP" then
+  if self.Positionable.ClassName == "UNIT" or self.Positionable.ClassName == "GROUP" then
-        -- If the user didn't change the frequency, he wants to use the on defined in the Mission Editor.
+    self.Positionable:GetDCSObject():getController():setCommand({
-        -- Else we set the frequency of the UNIT or the GROUP in DCS
+      id = "TransmitMessage",
-        if self.Frequency ~= 0 then
+      params = {
-            self.Positionable:GetDCSObject():getController():setCommand({ 
+        file = self.FileName,
-                id = "SetFrequency", 
+        duration = self.SubtitleDuration,
-                params = { 
+        subtitle = self.Subtitle,
-                    frequency = self.Frequency, 
+        loop = self.Loop,
-                    modulation = self.Modulation,
+      }
-                    }
+    })
-                })
+  else
-        end
+    -- If the POSITIONABLE is anything else, we revert to the general function
-            
+    trigger.action.radioTransmission(self.FileName, self.Positionable:GetPositionVec3(), self.Modulation, false, self.Frequency, self.Power)
-        self.Positionable:GetDCSObject():getController():setCommand({ 
+  end
-            id = "TransmitMessage", 
+  return self
-            params = {
-                file = self.FileName,
-                duration = self.SubtitleDuration,
-                subtitle = self.Subtitle,
-                loop = self.Loop,
-                } 
-            })
-    else
-        -- If the POSITIONABLE is anything else, we revert to the general function
-        trigger.action.radioTransmission(self.FileName, self.Positionable:GetPositionVec3(), self.Modulation, false, self.Frequency, self.Power)
-    end
-    return self
 end