Core/Conversations: Dropped time fields and calculate them using db2 data

Port From (https://github.com/TrinityCore/TrinityCore/commit/94b14e4f6355a7bab8004dcc2ecadadbc52833de)

Source/Framework/Constants/SharedConst.cs

@@ -400,6 +400,22 @@ namespace Framework.Constants
             return locale < Locale.Total && locale != Locale.None;
         }
 
+        public static CascLocaleBit[] WowLocaleToCascLocaleBit =
+        {
+            CascLocaleBit.enUS,
+            CascLocaleBit.koKR,
+            CascLocaleBit.frFR,
+            CascLocaleBit.deDE,
+            CascLocaleBit.zhCN,
+            CascLocaleBit.zhTW,
+            CascLocaleBit.esES,
+            CascLocaleBit.esMX,
+            CascLocaleBit.ruRU,
+            CascLocaleBit.None,
+            CascLocaleBit.ptBR,
+            CascLocaleBit.itIT
+        };
+
         public static long GetMaskForRace(Race raceId)
         {
             return raceId < Race.Max && raceBits[(int)raceId] >= 0 && raceBits[(int)raceId] < 64 ? (1 << raceBits[(int)raceId]) : 0;
@@ -423,6 +439,27 @@ namespace Framework.Constants
         Total = 12
     }
 
+    public enum CascLocaleBit
+    {
+        None = 0,
+        enUS = 1,
+        koKR = 2,
+        Reserved = 3,
+        frFR = 4,
+        deDE = 5,
+        zhCN = 6,
+        esES = 7,
+        zhTW = 8,
+        enGB = 9,
+        enCN = 10,
+        enTW = 11,
+        esMX = 12,
+        ruRU = 13,
+        ptBR = 14,
+        itIT = 15,
+        ptPT = 16
+    }
+
     public enum ComparisionType
     {
         EQ = 0,

Source/Framework/Database/Databases/HotfixDatabase.cs

@@ -191,6 +191,9 @@ namespace Framework.Database
                 "SoundEntriesID1, SoundEntriesID2, EmoteID1, EmoteID2, EmoteID3, EmoteDelay1, EmoteDelay2, EmoteDelay3 FROM broadcast_text");
             PrepareStatement(HotfixStatements.SEL_BROADCAST_TEXT_LOCALE, "SELECT ID, Text_lang, Text1_lang FROM broadcast_text_locale WHERE locale = ?");
 
+            // BroadcastTextDuration.db2
+            PrepareStatement(HotfixStatements.SEL_BROADCAST_TEXT_DURATION, "SELECT ID, BroadcastTextID, Locale, Duration FROM broadcast_text_duration");
+
             // CfgRegions.db2
             PrepareStatement(HotfixStatements.SEL_CFG_REGIONS, "SELECT ID, Tag, RegionID, Raidorigin, RegionGroupMask, ChallengeOrigin FROM cfg_regions");
 
@@ -1301,6 +1304,8 @@ namespace Framework.Database
         SEL_BROADCAST_TEXT,
         SEL_BROADCAST_TEXT_LOCALE,
 
+        SEL_BROADCAST_TEXT_DURATION,
+
         SEL_CFG_REGIONS,
 
         SEL_CHAR_TITLES,

Source/Game/DataStorage/CliDB.cs

@@ -93,6 +93,7 @@ namespace Game.DataStorage
             BattlePetSpeciesStateStorage = ReadDB2<BattlePetSpeciesStateRecord>("BattlePetSpeciesState.db2", HotfixStatements.SEL_BATTLE_PET_SPECIES_STATE);
             BattlemasterListStorage = ReadDB2<BattlemasterListRecord>("BattlemasterList.db2", HotfixStatements.SEL_BATTLEMASTER_LIST, HotfixStatements.SEL_BATTLEMASTER_LIST_LOCALE);
             BroadcastTextStorage = ReadDB2<BroadcastTextRecord>("BroadcastText.db2", HotfixStatements.SEL_BROADCAST_TEXT, HotfixStatements.SEL_BROADCAST_TEXT_LOCALE);
+            BroadcastTextDurationStorage = ReadDB2<BroadcastTextDurationRecord>("BroadcastTextDuration.db2", HotfixStatements.SEL_BROADCAST_TEXT_DURATION);
             CfgRegionsStorage = ReadDB2<Cfg_RegionsRecord>("Cfg_Regions.db2", HotfixStatements.SEL_CFG_REGIONS);
             CharTitlesStorage = ReadDB2<CharTitlesRecord>("CharTitles.db2", HotfixStatements.SEL_CHAR_TITLES, HotfixStatements.SEL_CHAR_TITLES_LOCALE);
             CharacterLoadoutStorage = ReadDB2<CharacterLoadoutRecord>("CharacterLoadout.db2", HotfixStatements.SEL_CHARACTER_LOADOUT);
@@ -466,6 +467,7 @@ namespace Game.DataStorage
         public static DB6Storage<BattlePetSpeciesStateRecord> BattlePetSpeciesStateStorage;
         public static DB6Storage<BattlemasterListRecord> BattlemasterListStorage;
         public static DB6Storage<BroadcastTextRecord> BroadcastTextStorage;
+        public static DB6Storage<BroadcastTextDurationRecord> BroadcastTextDurationStorage;
         public static DB6Storage<Cfg_RegionsRecord> CfgRegionsStorage;
         public static DB6Storage<CharTitlesRecord> CharTitlesStorage;
         public static DB6Storage<CharacterLoadoutRecord> CharacterLoadoutStorage;

Source/Game/DataStorage/ConversationDataStorage.cs

@@ -35,7 +35,7 @@ namespace Game.DataStorage
             Dictionary<uint, ConversationActor[]> actorsByConversation = new();
             Dictionary<uint, ulong[]> actorGuidsByConversation = new();
 
-            SQLResult lineTemplates = DB.World.Query("SELECT Id, StartTime, UiCameraID, ActorIdx, Flags FROM conversation_line_template");
+            SQLResult lineTemplates = DB.World.Query("SELECT Id, UiCameraID, ActorIdx, Flags FROM conversation_line_template");
             if (!lineTemplates.IsEmpty())
             {
                 uint oldMSTime = Time.GetMSTime();
@@ -52,10 +52,9 @@ namespace Game.DataStorage
 
                     ConversationLineTemplate conversationLine = new();
                     conversationLine.Id = id;
-                    conversationLine.StartTime = lineTemplates.Read<uint>(1);
+                    conversationLine.UiCameraID = lineTemplates.Read<uint>(1);
-                    conversationLine.UiCameraID = lineTemplates.Read<uint>(2);
+                    conversationLine.ActorIdx = lineTemplates.Read<byte>(2);
-                    conversationLine.ActorIdx = lineTemplates.Read<byte>(3);
+                    conversationLine.Flags = lineTemplates.Read<byte>(3);
-                    conversationLine.Flags = lineTemplates.Read<byte>(4);
 
                     _conversationLineTemplateStorage[id] = conversationLine;
                 }
@@ -140,7 +139,7 @@ namespace Game.DataStorage
                 Log.outInfo(LogFilter.ServerLoading, "Loaded 0 Conversation actors. DB table `conversation_actors` is empty.");
             }
 
-            SQLResult templateResult = DB.World.Query("SELECT Id, FirstLineId, LastLineEndTime, TextureKitId, ScriptName FROM conversation_template");
+            SQLResult templateResult = DB.World.Query("SELECT Id, FirstLineId, TextureKitId, ScriptName FROM conversation_template");
             if (!templateResult.IsEmpty())
             {
                 uint oldMSTime = Time.GetMSTime();
@@ -150,8 +149,7 @@ namespace Game.DataStorage
                     ConversationTemplate conversationTemplate = new();
                     conversationTemplate.Id = templateResult.Read<uint>(0);
                     conversationTemplate.FirstLineId = templateResult.Read<uint>(1);
-                    conversationTemplate.LastLineEndTime = templateResult.Read<uint>(2);
+                    conversationTemplate.TextureKitId = templateResult.Read<uint>(2);
-                    conversationTemplate.TextureKitId = templateResult.Read<uint>(3);
                     conversationTemplate.ScriptId = Global.ObjectMgr.GetScriptId(templateResult.Read<string>(3));
 
                     conversationTemplate.Actors = actorsByConversation.TryGetValue(conversationTemplate.Id, out var actors) ? actors.ToList() : null;
@@ -211,7 +209,6 @@ namespace Game.DataStorage
     public class ConversationLineTemplate
     {
         public uint Id;          // Link to ConversationLine.db2
-        public uint StartTime;   // Time in ms after conversation creation the line is displayed
         public uint UiCameraID;  // Link to UiCamera.db2
         public byte ActorIdx;    // Index from conversation_actors
         public byte Flags;
@@ -222,7 +219,6 @@ namespace Game.DataStorage
     {
         public uint Id;
         public uint FirstLineId;     // Link to ConversationLine.db2
-        public uint LastLineEndTime; // Time in ms after conversation creation the last line fades out
         public uint TextureKitId;    // Background texture
         public uint ScriptId;
 

Source/Game/DataStorage/DB2Manager.cs

@@ -123,6 +123,10 @@ namespace Game.DataStorage
                 }
             }
 
+            foreach (var broadcastTextDuration in BroadcastTextDurationStorage.Values)
+                _broadcastTextDurations[(broadcastTextDuration.BroadcastTextID, (CascLocaleBit)broadcastTextDuration.Locale)] = broadcastTextDuration.Duration;
+
+
             foreach (var uiDisplay in ChrClassUIDisplayStorage.Values)
             {
                 Cypher.Assert(uiDisplay.ChrClassesID < (byte)Class.Max);
@@ -943,6 +947,11 @@ namespace Game.DataStorage
             return broadcastText.Text[SharedConst.DefaultLocale];
         }
 
+        public int GetBroadcastTextDuration(int broadcastTextId, Locale locale = Locale.enUS)
+        {
+            return _broadcastTextDurations.LookupByKey((broadcastTextId, SharedConst.WowLocaleToCascLocaleBit[(int)locale]));
+        }
+        
         public ChrClassUIDisplayRecord GetUiDisplayForClass(Class unitClass)
         {
             Cypher.Assert(unitClass < Class.Max);
@@ -2306,6 +2315,7 @@ namespace Game.DataStorage
         MultiMap<uint, AzeritePowerSetMemberRecord> _azeritePowers = new();
         Dictionary<(uint azeriteUnlockSetId, ItemContext itemContext), byte[]> _azeriteTierUnlockLevels = new();
         Dictionary<(uint itemId, ItemContext itemContext), AzeriteUnlockMappingRecord> _azeriteUnlockMappings = new();
+        Dictionary<(int broadcastTextId, CascLocaleBit cascLocaleBit), int> _broadcastTextDurations = new();
         ChrClassUIDisplayRecord[] _uiDisplayByClass = new ChrClassUIDisplayRecord[(int)Class.Max];
         uint[][] _powersByClass = new uint[(int)Class.Max][];
         MultiMap<uint, ChrCustomizationChoiceRecord> _chrCustomizationChoicesByOption = new();

Source/Game/DataStorage/Structs/B_Records.cs

@@ -121,4 +121,12 @@ namespace Game.DataStorage
         public ushort[] EmoteID = new ushort[3];
         public ushort[] EmoteDelay = new ushort[3];
     }
+
+    public sealed class BroadcastTextDurationRecord
+    {
+        public uint Id;
+        public int BroadcastTextID;
+        public int Locale;
+        public int Duration;
+    }
 }

Source/Game/Entities/Conversation.cs

@@ -18,9 +18,11 @@
 using Framework.Constants;
 using Game.DataStorage;
 using Game.Maps;
-using Game.Spells;
-using System.Collections.Generic;
 using Game.Networking;
+using Game.Spells;
+using System;
+using System.Collections.Generic;
+using System.Linq;
 
 namespace Game.Entities
 {
@@ -28,8 +30,6 @@ namespace Game.Entities
     {
         public Conversation() : base(false)
         {
-            _duration = 0;
-
             ObjectTypeMask |= TypeMask.Conversation;
             ObjectTypeId = TypeId.Conversation;
 
@@ -61,9 +61,9 @@ namespace Game.Entities
 
         public override void Update(uint diff)
         {
-            if (GetDuration() > diff)
+            if (GetDuration() > TimeSpan.FromMilliseconds(diff))
             {
-                _duration -= diff;
+                _duration -= TimeSpan.FromMilliseconds(diff);
                 DoWithSuppressingObjectUpdates(() =>
                 {
                     // Only sent in CreateObject
@@ -121,8 +121,6 @@ namespace Game.Entities
             SetEntry(conversationEntry);
             SetObjectScale(1.0f);
 
-            SetUpdateFieldValue(m_values.ModifyValue(m_conversationData).ModifyValue(m_conversationData.LastLineEndTime), conversationTemplate.LastLineEndTime);
-            _duration = conversationTemplate.LastLineEndTime + 10 * Time.InMilliseconds;
             _textureKitId = conversationTemplate.TextureKitId;
 
             if (conversationTemplate.Actors != null)
@@ -171,16 +169,38 @@ namespace Game.Entities
 
                 ConversationLine lineField = new();
                 lineField.ConversationLineID = line.Id;
-                lineField.StartTime = line.StartTime;
                 lineField.UiCameraID = line.UiCameraID;
                 lineField.ActorIndex = line.ActorIdx;
                 lineField.Flags = line.Flags;
 
+                ConversationLineRecord convoLine = CliDB.ConversationLineStorage.LookupByKey(line.Id); // never null for conversationTemplate->Lines
+
+                for (Locale locale = Locale.enUS; locale < Locale.Total; locale = locale + 1)
+                {
+                    if (locale == Locale.None)
+                        continue;
+
+                    _lineStartTimes[(locale, line.Id)] = _lastLineEndTimes[(int)locale];
+                    if (locale == Locale.enUS)
+                        lineField.StartTime = (uint)_lastLineEndTimes[(int)locale].TotalMilliseconds;
+
+                    int broadcastTextDuration = Global.DB2Mgr.GetBroadcastTextDuration((int)convoLine.BroadcastTextID, locale);
+                    if (broadcastTextDuration != 0)
+                        _lastLineEndTimes[(int)locale] += TimeSpan.FromMilliseconds(broadcastTextDuration);
+
+                    _lastLineEndTimes[(int)locale] += TimeSpan.FromMilliseconds(convoLine.AdditionalDuration);
+                }
+
                 lines.Add(lineField);
             }
 
+            _duration = _lastLineEndTimes.Max();
+            SetUpdateFieldValue(m_values.ModifyValue(m_conversationData).ModifyValue(m_conversationData.LastLineEndTime), (uint)_duration.TotalMilliseconds);
             SetUpdateFieldValue(m_values.ModifyValue(m_conversationData).ModifyValue(m_conversationData.Lines), lines);
 
+            // conversations are despawned 5-20s after LastLineEndTime
+            _duration += TimeSpan.FromSeconds(10);
+
             Global.ScriptMgr.OnConversationCreate(this, creator);
 
             // All actors need to be set
@@ -207,6 +227,16 @@ namespace Game.Entities
             SetUpdateFieldValue(ref actorField.Type, ConversationActorType.WorldObjectActor);
         }
 
+        public TimeSpan GetLineStartTime(Locale locale, int lineId)
+        {
+            return _lineStartTimes.LookupByKey((locale, lineId));
+        }
+
+        public TimeSpan GetLastLineEndTime(Locale locale)
+        {
+            return _lastLineEndTimes[(int)locale];
+        }
+
         public uint GetScriptId()
         {
             return Global.ConversationDataStorage.GetConversationTemplate(GetEntry()).ScriptId;
@@ -274,7 +304,7 @@ namespace Game.Entities
             base.ClearUpdateMask(remove);
         }
 
-        uint GetDuration() { return _duration; }
+        TimeSpan GetDuration() { return _duration; }
         public uint GetTextureKitId() { return _textureKitId; }
 
         public ObjectGuid GetCreatorGuid() { return _creatorGuid; }
@@ -291,7 +321,10 @@ namespace Game.Entities
 
         Position _stationaryPosition = new();
         ObjectGuid _creatorGuid;
-        uint _duration;
+        TimeSpan _duration;
         uint _textureKitId;
+
+        Dictionary<(Locale locale, uint lineId), TimeSpan> _lineStartTimes = new();
+        TimeSpan[] _lastLineEndTimes = new TimeSpan[(int)Locale.Total];
     }
 }

Source/Game/Entities/Object/Update/UpdateFields.cs

@@ -5622,7 +5622,7 @@ namespace Game.Entities
         public void WriteCreate(WorldPacket data, Conversation owner, Player receiver)
         {
             data.WriteUInt32(ConversationLineID);
-            data.WriteUInt32(StartTime);
+            data.WriteUInt32(GetViewerStartTime(this, owner, receiver));
             data.WriteUInt32(UiCameraID);
             data.WriteUInt8(ActorIndex);
             data.WriteUInt8(Flags);
@@ -5632,12 +5632,24 @@ namespace Game.Entities
         public void WriteUpdate(WorldPacket data, bool ignoreChangesMask, Conversation owner, Player receiver)
         {
             data.WriteUInt32(ConversationLineID);
-            data.WriteUInt32(StartTime);
+            data.WriteUInt32(GetViewerStartTime(this, owner, receiver));
             data.WriteUInt32(UiCameraID);
             data.WriteUInt8(ActorIndex);
             data.WriteUInt8(Flags);
             data.WriteUInt8(ChatType);
         }
+
+        public uint GetViewerStartTime(ConversationLine conversationLine, Conversation conversation, Player receiver)
+        {
+            uint startTime = conversationLine.StartTime;
+            Locale locale = receiver.GetSession().GetSessionDbLocaleIndex();
+
+            TimeSpan localizedStartTime = conversation.GetLineStartTime(locale, (int)conversationLine.ConversationLineID);
+            if (localizedStartTime != TimeSpan.Zero)
+                startTime = (uint)localizedStartTime.TotalMilliseconds;
+
+            return startTime;
+        }
     }
 
     public class ConversationActorField
@@ -5685,7 +5697,7 @@ namespace Game.Entities
         public void WriteCreate(WorldPacket data, UpdateFieldFlag fieldVisibilityFlags, Conversation owner, Player receiver)
         {
             data.WriteInt32(((List<ConversationLine>)Lines).Count);
-            data.WriteUInt32(LastLineEndTime);
+            data.WriteUInt32(GetViewerLastLineEndTime(this, owner, receiver));
             data.WriteUInt32(Progress);
             for (int i = 0; i < ((List<ConversationLine>)Lines).Count; ++i)
             {
@@ -5751,7 +5763,7 @@ namespace Game.Entities
                 }
                 if (_changesMask[4])
                 {
-                    data.WriteUInt32(LastLineEndTime);
+                    data.WriteUInt32(GetViewerLastLineEndTime(this, owner, receiver));
                 }
                 if (_changesMask[5])
                 {
@@ -5770,5 +5782,11 @@ namespace Game.Entities
             ClearChangesMask(Progress);
             _changesMask.ResetAll();
         }
+
+        public uint GetViewerLastLineEndTime(ConversationData conversationLineData, Conversation conversation, Player receiver)
+        {
+            Locale locale = receiver.GetSession().GetSessionDbLocaleIndex();
+            return (uint)conversation.GetLastLineEndTime(locale).TotalMilliseconds;
+        }
     }
 }

sql/updates/hotfixes/master/2021_10_26_00_hotfixes.sql

@@ -0,0 +1,15 @@
+--
+-- Table structure for table `broadcast_text_duration`
+--
+DROP TABLE IF EXISTS `broadcast_text_duration`;
+/*!40101 SET @saved_cs_client     = @@character_set_client */;
+/*!50503 SET character_set_client = utf8mb4 */;
+CREATE TABLE `broadcast_text_duration` (
+  `ID` int(10) unsigned NOT NULL DEFAULT '0',
+  `BroadcastTextID` int(11) NOT NULL DEFAULT '0',
+  `Locale` int(11) NOT NULL DEFAULT '0',
+  `Duration` int(11) NOT NULL DEFAULT '0',
+  `VerifiedBuild` int(11) NOT NULL DEFAULT '0',
+  PRIMARY KEY (`ID`,`VerifiedBuild`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
+/*!40101 SET character_set_client = @saved_cs_client */;

sql/updates/world/master/2021_10_26_00_world.sql

@@ -0,0 +1,3 @@
+-- 
+ALTER TABLE `conversation_line_template` DROP `StartTime`;
+ALTER TABLE `conversation_template` DROP `LastLineEndTime`;