Core/Scenarios: Attempt to restore scenario state from completed encounter info

Port From (https://github.com/TrinityCore/TrinityCore/commit/1e99011edf5e74ef51a7b6f84ca0529e5dbf2492)

Source/Framework/Database/Databases/CharacterDatabase.cs

@@ -737,11 +737,6 @@ namespace Framework.Database
             PrepareStatement(CharStatements.UPD_BLACKMARKET_AUCTIONS, "UPDATE blackmarket_auctions SET currentBid = ?, time = ?, numBids = ?, bidder = ? WHERE marketId = ?");
             PrepareStatement(CharStatements.INS_BLACKMARKET_AUCTIONS, "INSERT INTO blackmarket_auctions (marketId, currentBid, time, numBids, bidder) VALUES (?, ?, ?, ? ,?)");
 
-            // Scenario
-            PrepareStatement(CharStatements.SEL_SCENARIO_INSTANCE_CRITERIA_FOR_INSTANCE, "SELECT criteria, counter, date FROM instance_scenario_progress WHERE id = ?");
-            PrepareStatement(CharStatements.DEL_SCENARIO_INSTANCE_CRITERIA, "DELETE FROM instance_scenario_progress WHERE id = ? AND criteria = ?");
-            PrepareStatement(CharStatements.INS_SCENARIO_INSTANCE_CRITERIA, "INSERT INTO instance_scenario_progress (id, criteria, counter, date) VALUES (?, ?, ?, ?)");
-
             // Spell Location
             PrepareStatement(CharStatements.SEL_CHARACTER_AURA_STORED_LOCATIONS, "SELECT Spell, MapId, PositionX, PositionY, PositionZ, Orientation FROM character_aura_stored_location WHERE Guid = ?");
             PrepareStatement(CharStatements.DEL_CHARACTER_AURA_STORED_LOCATIONS_BY_GUID, "DELETE FROM character_aura_stored_location WHERE Guid = ?");
@@ -1347,10 +1342,6 @@ namespace Framework.Database
         UPD_BLACKMARKET_AUCTIONS,
         INS_BLACKMARKET_AUCTIONS,
 
-        SEL_SCENARIO_INSTANCE_CRITERIA_FOR_INSTANCE,
-        DEL_SCENARIO_INSTANCE_CRITERIA,
-        INS_SCENARIO_INSTANCE_CRITERIA,
-
         SEL_CHARACTER_AURA_STORED_LOCATIONS,
         DEL_CHARACTER_AURA_STORED_LOCATIONS_BY_GUID,
         DEL_CHARACTER_AURA_STORED_LOCATION,

Source/Game/Maps/Instances/InstanceScript.cs

@@ -39,13 +39,6 @@ namespace Game.Maps
             _instanceSpawnGroups = Global.ObjectMgr.GetInstanceSpawnGroupsForMap(map.GetId());
         }
 
-        public void SaveToDB()
-        {
-            InstanceScenario scenario = instance.GetInstanceScenario();
-            if (scenario != null)
-                scenario.SaveToDB();
-        }
-
         public virtual bool IsEncounterInProgress()
         {
             foreach (var boss in bosses.Values)
@@ -416,7 +409,6 @@ namespace Game.Maps
                     }
 
                     bossInfo.state = state;
-                    SaveToDB();
                     if (dungeonEncounter != null)
                         instance.UpdateInstanceLock(new UpdateBossStateSaveDataEvent(dungeonEncounter, id, state));
                 }
@@ -695,7 +687,7 @@ namespace Game.Maps
             return false;
         }
 
-        bool IsEncounterCompleted(uint dungeonEncounterId)
+        public bool IsEncounterCompleted(uint dungeonEncounterId)
         {
             for (uint i = 0; i < bosses.Count; ++i)
                 for (var j = 0; j < bosses[i].DungeonEncounters.Length; ++j)

Source/Game/Scenarios/InstanceScenario.cs

@@ -28,138 +28,87 @@ namespace Game.Scenarios
 {
     public class InstanceScenario : Scenario
     {
-        public InstanceScenario(Map map, ScenarioData scenarioData) : base(scenarioData)
+        public InstanceScenario(InstanceMap map, ScenarioData scenarioData) : base(scenarioData)
         {
             _map = map;
 
             //ASSERT(_map);
-            LoadInstanceData(_map.GetInstanceId());
+            LoadInstanceData();
 
             var players = map.GetPlayers();
             foreach (var player in players)
                 SendScenarioState(player);
         }
 
-        public void SaveToDB()
+        void LoadInstanceData()
         {
-            if (_criteriaProgress.Empty())
+            InstanceScript instanceScript = _map.GetInstanceScript();
+            if (instanceScript == null)
                 return;
 
-            DifficultyRecord difficultyEntry = CliDB.DifficultyStorage.LookupByKey(_map.GetDifficultyID());
+            List<CriteriaTree> criteriaTrees = new();
-            if (difficultyEntry == null || difficultyEntry.Flags.HasAnyFlag(DifficultyFlags.ChallengeMode)) // Map should have some sort of "CanSave" boolean that returns whether or not the map is savable. (Challenge modes cannot be saved for example)
-                return;
 
-            uint id = _map.GetInstanceId();
+            var killCreatureCriteria = Global.CriteriaMgr.GetScenarioCriteriaByTypeAndScenario(CriteriaType.KillCreature, _data.Entry.Id);
-            if (id == 0)
+            if (!killCreatureCriteria.Empty())
             {
-                Log.outDebug(LogFilter.Scenario, "Scenario.SaveToDB: Can not save scenario progress without an instance save. Map.GetInstanceId() did not return an instance save.");
+                var spawnGroups = Global.ObjectMgr.GetInstanceSpawnGroupsForMap(_map.GetId());
-                return;
+                if (spawnGroups != null)
+                {
+                    Dictionary<uint, ulong> despawnedCreatureCountsById = new();
+                    foreach (InstanceSpawnGroupInfo spawnGroup in spawnGroups)
+                    {
+                        if (instanceScript.GetBossState(spawnGroup.BossStateId) != EncounterState.Done)
+                            continue;
+
+                        bool isDespawned = ((1 << (int)EncounterState.Done) & spawnGroup.BossStates) == 0 || spawnGroup.Flags.HasFlag(InstanceSpawnGroupFlags.BlockSpawn);
+                        if (isDespawned)
+                        {
+                            foreach (var spawn in Global.ObjectMgr.GetSpawnMetadataForGroup(spawnGroup.SpawnGroupId))
+                            {
+                                SpawnData spawnData = spawn.ToSpawnData();
+                                if (spawnData != null)
+                                    ++despawnedCreatureCountsById[spawnData.Id];
+                            }
+                        }
+                    }
+
+                    foreach (Criteria criteria in killCreatureCriteria)
+                    {
+                        // count creatures in despawned spawn groups
+                        ulong progress = despawnedCreatureCountsById.LookupByKey(criteria.Entry.Asset);
+                        if (progress != 0)
+                        {
+                            SetCriteriaProgress(criteria, progress, null, ProgressType.Set);
+                            var trees = Global.CriteriaMgr.GetCriteriaTreesByCriteria(criteria.Id);
+                            if (trees != null)
+                                foreach (CriteriaTree tree in trees)
+                                    criteriaTrees.Add(tree);
+                        }
+                    }
+                }
             }
 
-            SQLTransaction trans = new();
+            foreach (Criteria criteria in Global.CriteriaMgr.GetScenarioCriteriaByTypeAndScenario(CriteriaType.DefeatDungeonEncounter, _data.Entry.Id))
-            foreach (var iter in _criteriaProgress)
             {
-                if (!iter.Value.Changed)
+                if (!instanceScript.IsEncounterCompleted(criteria.Entry.Asset))
                     continue;
 
-                Criteria criteria = Global.CriteriaMgr.GetCriteria(iter.Key);
+                SetCriteriaProgress(criteria, 1, null, ProgressType.Set);
-                switch (criteria.Entry.Type)
+                var trees = Global.CriteriaMgr.GetCriteriaTreesByCriteria(criteria.Id);
-                {
+                if (trees != null)
-                    // Blizzard only appears to store creature kills and dungeon encounters
+                    foreach (CriteriaTree tree in trees)
-                    case CriteriaType.KillCreature:
+                        criteriaTrees.Add(tree);
-                    case CriteriaType.DefeatDungeonEncounter:
-                        break;
-                    default:
-                        continue;
-                }
-
-                if (iter.Value.Counter != 0)
-                {
-                    PreparedStatement stmt = DB.Characters.GetPreparedStatement(CharStatements.DEL_SCENARIO_INSTANCE_CRITERIA);
-                    stmt.AddValue(0, id);
-                    stmt.AddValue(1, iter.Key);
-                    trans.Append(stmt);
-
-                    stmt = DB.Characters.GetPreparedStatement(CharStatements.INS_SCENARIO_INSTANCE_CRITERIA);
-                    stmt.AddValue(0, id);
-                    stmt.AddValue(1, iter.Key);
-                    stmt.AddValue(2, iter.Value.Counter);
-                    stmt.AddValue(3, iter.Value.Date);
-                    trans.Append(stmt);
-                }
-
-                iter.Value.Changed = false;
             }
 
-            DB.Characters.CommitTransaction(trans);
+            foreach (CriteriaTree tree in criteriaTrees)
-        }
-
-        void LoadInstanceData(uint instanceId)
-        {
-            PreparedStatement stmt = DB.Characters.GetPreparedStatement(CharStatements.SEL_SCENARIO_INSTANCE_CRITERIA_FOR_INSTANCE);
-            stmt.AddValue(0, instanceId);
-
-            SQLResult result = DB.Characters.Query(stmt);
-            if (!result.IsEmpty())
             {
-                SQLTransaction trans = new();
+                ScenarioStepRecord step = tree.ScenarioStep;
-                long now = GameTime.GetGameTime();
+                if (step == null)
+                    continue;
 
-                List<CriteriaTree> criteriaTrees = new();
-                do
-                {
-                    uint id = result.Read<uint>(0);
-                    ulong counter = result.Read<ulong>(1);
-                    long date = result.Read<long>(2);
 
-                    Criteria criteria = Global.CriteriaMgr.GetCriteria(id);
+                if (IsCompletedCriteriaTree(tree))
-                    if (criteria == null)
+                    SetStepState(step, ScenarioStepState.Done);
-                    {
-                        // Removing non-existing criteria data for all instances
-                        Log.outError(LogFilter.Scenario, "Removing scenario criteria {0} data from the table `instance_scenario_progress`.", id);
-
-                        stmt = DB.Characters.GetPreparedStatement(CharStatements.DEL_SCENARIO_INSTANCE_CRITERIA);
-                        stmt.AddValue(0, instanceId);
-                        stmt.AddValue(1, id);
-                        trans.Append(stmt);
-                        continue;
-                    }
-
-                    if (criteria.Entry.StartTimer != 0 && (date + criteria.Entry.StartTimer) < now)
-                        continue;
-
-                    switch (criteria.Entry.Type)
-                    {
-                        // Blizzard appears to only stores creatures killed progress for unknown reasons. Either technical shortcoming or intentional
-                        case CriteriaType.KillCreature:
-                        case CriteriaType.DefeatDungeonEncounter:
-                            break;
-                        default:
-                            continue;
-                    }
-
-                    SetCriteriaProgress(criteria, counter, null, ProgressType.Set);
-
-                    List<CriteriaTree> trees = Global.CriteriaMgr.GetCriteriaTreesByCriteria(criteria.Id);
-                    if (trees != null)
-                    {
-                        foreach (CriteriaTree tree in trees)
-                            criteriaTrees.Add(tree);
-                    }
-                }
-                while (result.NextRow());
-
-                DB.Characters.CommitTransaction(trans);
-
-                foreach (CriteriaTree tree in criteriaTrees)
-                {
-                    ScenarioStepRecord step = tree.ScenarioStep;
-                    if (step == null)
-                        continue;
-
-                    if (IsCompletedCriteriaTree(tree))
-                        SetStepState(step, ScenarioStepState.Done);
-                }
             }
         }
 
@@ -179,6 +128,6 @@ namespace Game.Scenarios
             _map.SendToPlayers(data);
         }
 
-        Map _map;
+        InstanceMap _map;
     }
 }

Source/Game/Scenarios/Scenario.cs

@@ -369,7 +369,7 @@ namespace Game.Scenarios
         public override void SendAllData(Player receiver) { }
 
         List<ObjectGuid> _players = new();
-        ScenarioData _data;
+        protected ScenarioData _data;
         ScenarioStepRecord _currentstep;
         Dictionary<ScenarioStepRecord, ScenarioStepState> _stepStates = new();
     }

Source/Game/Scenarios/ScenarioManager.cs

@@ -28,7 +28,7 @@ namespace Game.Scenarios
     {
         ScenarioManager() { }
 
-        public InstanceScenario CreateInstanceScenario(Map map, int team)
+        public InstanceScenario CreateInstanceScenario(InstanceMap map, int team)
         {
             var dbData = _scenarioDBData.LookupByKey(Tuple.Create(map.GetId(), (byte)map.GetDifficultyID()));
             // No scenario registered for this map and difficulty in the database