GROUP / customizes, TTS Callsigns

Added function to get customized TTS friendly callsigns from the GROUP

Moose Development/Moose/Wrapper/Group.lua

@@ -2767,94 +2767,82 @@ function GROUP:GetHighestThreat()
   return nil, nil
 end
 
---do -- Smoke
+--- Get TTS friendly, optionally customized callsign mainly for **player groups**. A customized callsign is taken from the #GROUP name, after an optional '#' sign, e.g. "Aerial 1-1#Ghostrider" resulting in "Ghostrider 9", or, 
+-- if that isn't available, from the playername, as set in the mission editor main screen, after an optional '|' sign (actually, more of a personal call sign), e.g. "Apple|Moose" results in "Moose 9 1". Options see below.
+-- @param #GROUP self
+-- @param #boolean ShortCallsign Return a shortened customized callsign, i.e. "Ghostrider 9" and not "Ghostrider 9 1"
+-- @param #boolean (Player only) Keepnumber Return customized callsign, incl optional numbers at the end, e.g. "Aerial 1-1#Ghostrider 109" results in "Ghostrider 109", if you want to e.g. use historical US Navy Callsigns
+-- @param #table CallsignTranslations with DCS callsigns as keys and replacements as values
+-- @return #string Callsign
+-- @usage
+--            -- Set Custom CAP Flight Callsigns for use with TTS
+--            mygroup:GetCustomCallSign(true,false,{
+--              Devil = 'Bengal',
+--              Snake = 'Winder',
+--              Colt = 'Camelot',
+--              Enfield = 'Victory',
+--              Uzi = 'Evil Eye'
+--            })
 --
------ Signal a flare at the position of the GROUP.
----- @param #GROUP self
----- @param Utilities.Utils#FLARECOLOR FlareColor
---function GROUP:Flare( FlareColor )
---  self:F2()
---  trigger.action.signalFlare( self:GetVec3(), FlareColor , 0 )
---end
+-- results in this outcome if the group has Callsign "Enfield 9 1" on the 1st #UNIT of the group:
 --
------ Signal a white flare at the position of the GROUP.
----- @param #GROUP self
---function GROUP:FlareWhite()
---  self:F2()
---  trigger.action.signalFlare( self:GetVec3(), trigger.flareColor.White , 0 )
---end
+--   		'Victory 9'
 --
------ Signal a yellow flare at the position of the GROUP.
----- @param #GROUP self
---function GROUP:FlareYellow()
---  self:F2()
---  trigger.action.signalFlare( self:GetVec3(), trigger.flareColor.Yellow , 0 )
---end
---
------ Signal a green flare at the position of the GROUP.
----- @param #GROUP self
---function GROUP:FlareGreen()
---  self:F2()
---  trigger.action.signalFlare( self:GetVec3(), trigger.flareColor.Green , 0 )
---end
---
------ Signal a red flare at the position of the GROUP.
----- @param #GROUP self
---function GROUP:FlareRed()
---  self:F2()
---  local Vec3 = self:GetVec3()
---  if Vec3 then
---    trigger.action.signalFlare( Vec3, trigger.flareColor.Red, 0 )
---  end
---end
---
------ Smoke the GROUP.
----- @param #GROUP self
---function GROUP:Smoke( SmokeColor, Range )
---  self:F2()
---  if Range then
---    trigger.action.smoke( self:GetRandomVec3( Range ), SmokeColor )
---  else
---    trigger.action.smoke( self:GetVec3(), SmokeColor )
---  end
---  
---end
---
------ Smoke the GROUP Green.
----- @param #GROUP self
---function GROUP:SmokeGreen()
---  self:F2()
---  trigger.action.smoke( self:GetVec3(), trigger.smokeColor.Green )
---end
---
------ Smoke the GROUP Red.
----- @param #GROUP self
---function GROUP:SmokeRed()
---  self:F2()
---  trigger.action.smoke( self:GetVec3(), trigger.smokeColor.Red )
---end
---
------ Smoke the GROUP White.
----- @param #GROUP self
---function GROUP:SmokeWhite()
---  self:F2()
---  trigger.action.smoke( self:GetVec3(), trigger.smokeColor.White )
---end
---
------ Smoke the GROUP Orange.
----- @param #GROUP self
---function GROUP:SmokeOrange()
---  self:F2()
---  trigger.action.smoke( self:GetVec3(), trigger.smokeColor.Orange )
---end
---
------ Smoke the GROUP Blue.
----- @param #GROUP self
---function GROUP:SmokeBlue()
---  self:F2()
---  trigger.action.smoke( self:GetVec3(), trigger.smokeColor.Blue )
---end
---
---
---
---end
+-- 
+function GROUP:GetCustomCallSign(ShortCallsign,Keepnumber,CallsignTranslations)
+  self:T("GetCustomCallSign")
+
+  local callsign = "Ghost 1"
+  if self:IsAlive() then
+	local IsPlayer = self:IsPlayer()
+    local shortcallsign = self:GetCallsign() or "unknown91" -- e.g.Uzi91, but we want Uzi 9 1
+    local callsignroot = string.match(shortcallsign, '(%a+)') -- Uzi
+    self:T("CallSign = " .. callsignroot)
+    local groupname = self:GetName()
+    local callnumber = string.match(shortcallsign, "(%d+)$" ) or "91" -- 91
+    local callnumbermajor = string.char(string.byte(callnumber,1)) -- 9
+    local callnumberminor = string.char(string.byte(callnumber,2)) -- 1
+    local personalized = false
+    if IsPlayer and string.find(groupname,"#") then
+      -- personalized flight name in group naming
+	  if Keepnumber then
+		shortcallsign = string.match(groupname,"#(.+)") -- Ghostrider 219
+	  else
+		shortcallsign = string.match(groupname,"#([%a]+)") -- Ghostrider
+	  end
+      personalized = true
+    elseif IsPlayer and string.find(self:GetPlayerName(),"|") then
+      -- personalized flight name in group naming
+      shortcallsign = string.match(Group:GetPlayerName(),"|([%a]+)") -- Ghostrider
+      personalized = true
+    end
+	
+    if (not personalized) and CallsignTranslations and CallsignTranslations[callsignroot] then
+      callsignroot = CallsignTranslations[callsignroot]
+    end
+	
+	if personalized then
+		-- player personalized callsign
+		if Keepnumber then
+			return shortcallsign -- Ghostrider 219
+		elseif ShortCallsign then
+			callsign = shortcallsign.." "..callnumbermajor -- Ghostrider 9
+		else
+			callsign = shortcallsign.." "..callnumbermajor.." "..callnumberminor -- Ghostrider 9 1
+		end
+		return callsign
+	end
+	
+	-- AI or not personalized
+	if ShortCallsign then
+	  callsign = callsignroot.." "..callnumbermajor -- Uzi/Victory 9
+	else
+	  callsign = callsignroot.." "..callnumbermajor.." "..callnumberminor -- Uzi/Victory 9 1
+	end
+
+    self:T("Generated Callsign = " .. callsign)
+  end
+  
+  return callsign
+end
+