Experimental Misc. quest sync w/ server option, default off (#799)

* Quest Sync update: Include miscellaneous tasks and more side tasks

* Add missing header so IDE can find definitions used in the file.
Didn't affect compilation.

* Misc quest sync usability / debuggability
Builds on PR #788. Adds a server flag, default false, to enable miscellaneous quest syncing. Adds logging to misc. quest sync & communications so we can figure out what went wrong if it doesn't work.

Update fixes formatting of GameIds in logs so they actually work.

* Fix GCC (linux) compilation complaint.

GCC doesn't like the string-splice with __FUNCTION__, but it works everywhere else. I think clang-format wrapped the line on me and this is a quick patch to test that.

* Remove string splice that doesn't work with GCC

* Review comments

* Separate commit for this longstanding bugfix so it can be cherry-picked into its own PR

* Resolve some PR comments refining which quests are non-syncable.
Restore original location of "inparty" check, there were side effects.
Tweakfix IsNonSyncableQuest
Symplified logic.

* constexpr way to get std::array<T, size> size.

Co-authored-by: Daniil <[email protected]>

---------

Co-authored-by: otsffs <[email protected]>
Co-authored-by: Daniil <[email protected]>

Author: 3 people

Code/client/Services/Generic/QuestService.cpp

@@ -63,9 +63,24 @@ BSTEventResult QuestService::OnEvent(const TESQuestStartStopEvent* apEvent, cons
     {
         if (IsNonSyncableQuest(pQuest))
             return BSTEventResult::kOk;
-
+     
+        if (pQuest->type == TESQuest::Type::None || pQuest->type == TESQuest::Type::Miscellaneous)
+        {
+            // Perhaps redundant, but necessary. We need the logging and
+            // the lambda coming up is queued and runs later
+            GameId Id;
+            auto& modSys = m_world.GetModSystem();
+            if (modSys.GetServerModId(pQuest->formID, Id))
+            {
+                spdlog::info(__FUNCTION__ ": queuing type none/misc quest gameId {:X} questStage {} questStatus {} questType {} formId {:X} name {}",
+                             Id.LogFormat(),  pQuest->currentStage, pQuest->IsStopped() ? RequestQuestUpdate::Stopped : RequestQuestUpdate::Started,
+                             static_cast<std::underlying_type_t<TESQuest::Type>>(pQuest->type), 
+                             pQuest->formID, pQuest->fullName.value.AsAscii());
+            }
+        }
+        
         m_world.GetRunner().Queue(
-            [&, formId = pQuest->formID, stageId = pQuest->currentStage, stopped = pQuest->IsStopped()]()
+            [&, formId = pQuest->formID, stageId = pQuest->currentStage, stopped = pQuest->IsStopped(), type = pQuest->type]()
             {
                 GameId Id;
                 auto& modSys = m_world.GetModSystem();
@@ -75,6 +90,7 @@ BSTEventResult QuestService::OnEvent(const TESQuestStartStopEvent* apEvent, cons
                     update.Id = Id;
                     update.Stage = stageId;
                     update.Status = stopped ? RequestQuestUpdate::Stopped : RequestQuestUpdate::Started;
+                    update.ClientQuestType = static_cast<std::underlying_type_t<TESQuest::Type>>(type); 
 
                     m_world.GetTransport().Send(update);
                 }
@@ -97,8 +113,24 @@ BSTEventResult QuestService::OnEvent(const TESQuestStageEvent* apEvent, const Ev
         if (IsNonSyncableQuest(pQuest))
             return BSTEventResult::kOk;
 
+        if (pQuest->type == TESQuest::Type::None || pQuest->type == TESQuest::Type::Miscellaneous)
+        {
+            // Perhaps redundant, but necessary. We need the logging and
+            // the lambda coming up is queued and runs later
+            GameId Id;
+            auto& modSys = m_world.GetModSystem();
+            if (modSys.GetServerModId(pQuest->formID, Id))
+            {
+                spdlog::info(__FUNCTION__ ": queuing type none/misc quest gameId {:X} questStage {} questStatus {} questType {} formId {:X} name {}",
+                             Id.LogFormat(), pQuest->currentStage,
+                             RequestQuestUpdate::StageUpdate,
+                             static_cast<std::underlying_type_t<TESQuest::Type>>(pQuest->type),
+                             pQuest->formID, pQuest->fullName.value.AsAscii());
+            }
+        }
+
         m_world.GetRunner().Queue(
-            [&, formId = apEvent->formId, stageId = apEvent->stageId]()
+            [&, formId = apEvent->formId, stageId = apEvent->stageId, type = pQuest->type]()
             {
                 GameId Id;
                 auto& modSys = m_world.GetModSystem();
@@ -108,6 +140,7 @@ BSTEventResult QuestService::OnEvent(const TESQuestStageEvent* apEvent, const Ev
                     update.Id = Id;
                     update.Stage = stageId;
                     update.Status = RequestQuestUpdate::StageUpdate;
+                    update.ClientQuestType = static_cast<std::underlying_type_t<TESQuest::Type>>(type);
 
                     m_world.GetTransport().Send(update);
                 }
@@ -128,6 +161,13 @@ void QuestService::OnQuestUpdate(const NotifyQuestUpdate& aUpdate) noexcept
         return;
     }
 
+    if (pQuest->type == TESQuest::Type::None || pQuest->type == TESQuest::Type::Miscellaneous)
+    {
+        spdlog::info(__FUNCTION__ ": receiving type none/misc quest update gameId {:X} questStage {} questStatus {} questType {} formId {:X} name {}",
+                     aUpdate.Id.LogFormat(), aUpdate.Stage, aUpdate.Status,
+                     aUpdate.ClientQuestType, formId, pQuest->fullName.value.AsAscii());
+    }
+
     bool bResult = false;
     switch (aUpdate.Status)
     {
@@ -168,12 +208,21 @@ bool QuestService::StopQuest(uint32_t aformId)
     return false;
 }
 
+static constexpr std::array kNonSyncableQuestIds = std::to_array<uint32_t>({
+    0x2BA16,   // Werewolf transformation quest
+    0x20071D0, // Vampire transformation quest
+    0x3AC44,   // MS13BleakFallsBarrowLeverScene
+    // 0xFE014801,  // Unknown dynamic ID, kept as note, maybe lookup correct ID this game?
+    0xF2593 // Skill experience quest
+});
+
 bool QuestService::IsNonSyncableQuest(TESQuest* apQuest)
 {
-    // non story quests are "blocked" and not synced
-    auto& stages = apQuest->stages;
-    return apQuest->type == TESQuest::Type::None // internal event
-           || apQuest->type == TESQuest::Type::Miscellaneous || stages.Empty();
+    // Quests with no quest stages are never synced. Most TESQues::Type:: quests should
+    // be synced, including Type::None and Type::Miscellaneous, but there are a few
+    // known exceptions that should be excluded that are in the table.
+    return    apQuest->stages.Empty() 
+           || std::find(kNonSyncableQuestIds.begin(), kNonSyncableQuestIds.end(), apQuest->formID) != kNonSyncableQuestIds.end();
 }
 
 void QuestService::DebugDumpQuests()

Code/encoding/Messages/NotifyQuestUpdate.cpp

@@ -7,6 +7,7 @@ void NotifyQuestUpdate::SerializeRaw(TiltedPhoques::Buffer::Writer& aWriter) con
     Id.Serialize(aWriter);
     aWriter.WriteBits(Stage, 16);
     aWriter.WriteBits(Status, 8);
+    aWriter.WriteBits(ClientQuestType, 8);
 }
 
 void NotifyQuestUpdate::DeserializeRaw(TiltedPhoques::Buffer::Reader& aReader) noexcept
@@ -20,4 +21,7 @@ void NotifyQuestUpdate::DeserializeRaw(TiltedPhoques::Buffer::Reader& aReader) n
 
     aReader.ReadBits(tmp, 8);
     Status = tmp & 0xFF;
+
+    aReader.ReadBits(tmp, 8);
+    ClientQuestType = tmp & 0xFF;
 }

Code/encoding/Messages/NotifyQuestUpdate.h

@@ -15,7 +15,7 @@ struct NotifyQuestUpdate final : ServerMessage
     void SerializeRaw(TiltedPhoques::Buffer::Writer& aWriter) const noexcept override;
     void DeserializeRaw(TiltedPhoques::Buffer::Reader& aReader) noexcept override;
 
-    bool operator==(const NotifyQuestUpdate& acRhs) const noexcept { return GetOpcode() == acRhs.GetOpcode() && Id == acRhs.Id && Stage == acRhs.Stage && Status == acRhs.Status; }
+    bool operator==(const NotifyQuestUpdate& acRhs) const noexcept { return GetOpcode() == acRhs.GetOpcode() && Id == acRhs.Id && Stage == acRhs.Stage && Status == acRhs.Status && ClientQuestType == acRhs.ClientQuestType; }
 
     enum StatusCode : uint8_t
     {
@@ -27,4 +27,5 @@ struct NotifyQuestUpdate final : ServerMessage
     GameId Id;
     uint16_t Stage;
     uint8_t Status;
+    uint8_t ClientQuestType;
 };

Code/encoding/Messages/RequestQuestUpdate.cpp

@@ -7,6 +7,7 @@ void RequestQuestUpdate::SerializeRaw(TiltedPhoques::Buffer::Writer& aWriter) co
     Id.Serialize(aWriter);
     aWriter.WriteBits(Stage, 16);
     aWriter.WriteBits(Status, 8);
+    aWriter.WriteBits(ClientQuestType, 8);
 }
 
 void RequestQuestUpdate::DeserializeRaw(TiltedPhoques::Buffer::Reader& aReader) noexcept
@@ -20,4 +21,7 @@ void RequestQuestUpdate::DeserializeRaw(TiltedPhoques::Buffer::Reader& aReader)
 
     aReader.ReadBits(tmp, 8);
     Status = tmp & 0xFF;
+
+    aReader.ReadBits(tmp, 8);
+    ClientQuestType = tmp & 0xFF;
 }

Code/encoding/Messages/RequestQuestUpdate.h

@@ -15,7 +15,7 @@ struct RequestQuestUpdate final : ClientMessage
     void SerializeRaw(TiltedPhoques::Buffer::Writer& aWriter) const noexcept override;
     void DeserializeRaw(TiltedPhoques::Buffer::Reader& aReader) noexcept override;
 
-    bool operator==(const RequestQuestUpdate& acRhs) const noexcept { return GetOpcode() == acRhs.GetOpcode() && Id == acRhs.Id && Stage == acRhs.Stage && Status == acRhs.Status; }
+    bool operator==(const RequestQuestUpdate& acRhs) const noexcept { return GetOpcode() == acRhs.GetOpcode() && Id == acRhs.Id && Stage == acRhs.Stage && Status == acRhs.Status && ClientQuestType == acRhs.ClientQuestType; }
 
     enum StatusCode : uint8_t
     {
@@ -27,4 +27,5 @@ struct RequestQuestUpdate final : ClientMessage
     GameId Id;
     uint16_t Stage;
     uint8_t Status;
+    uint8_t ClientQuestType;
 };

Code/encoding/Structs/GameId.h

@@ -15,6 +15,7 @@ struct GameId
 
     void Serialize(TiltedPhoques::Buffer::Writer& aWriter) const noexcept;
     void Deserialize(TiltedPhoques::Buffer::Reader& aReader) noexcept;
+    inline uint64_t LogFormat() const noexcept { return static_cast<uint64_t>(ModId) << 32 | BaseId; }
 
     uint32_t BaseId;
     uint32_t ModId;

Code/server/Services/CharacterService.cpp

@@ -40,6 +40,7 @@
 #include <Messages/NotifyActorTeleport.h>
 #include <Messages/NotifyRelinquishControl.h>
 
+#include <Setting.h>
 namespace
 {
 Console::Setting bEnableXpSync{"Gameplay:bEnableXpSync", "Syncs combat XP within the party", true};

Code/server/Services/InventoryService.cpp

@@ -11,6 +11,7 @@
 #include <Messages/NotifyEquipmentChanges.h>
 #include <Messages/DrawWeaponRequest.h>
 
+#include <Setting.h>
 namespace
 {
 Console::Setting bEnableItemDrops{"Gameplay:bEnableItemDrops", "(Experimental) Syncs dropped items by players", false};

Code/server/Services/PartyService.cpp

@@ -19,6 +19,7 @@
 #include <Messages/PartyKickRequest.h>
 #include <Messages/NotifyPlayerJoined.h>
 
+#include <Setting.h>
 namespace
 {
 Console::Setting bAutoPartyJoin{"Gameplay:bAutoPartyJoin", "Join parties automatically, as long as there is only one party in the server", true};
@@ -149,7 +150,7 @@ void PartyService::OnPartyChangeLeader(const PacketEvent<PartyChangeLeaderReques
 
     if (!pNewLeader)
     {
-        spdlog::error("[PartyService]: Player {} does not exist¨. Cannot change paty leader", message.PartyMemberPlayerId);
+        spdlog::error("[PartyService]: Player {} does not exist. Cannot change party leader", message.PartyMemberPlayerId);
         return;
     }
 

Code/server/Services/PlayerService.cpp

@@ -18,6 +18,7 @@
 #include <Messages/NotifyPlayerLevel.h>
 #include <Messages/NotifyPlayerCellChanged.h>
 
+#include <Setting.h>
 namespace
 {
 Console::Setting fGoldLossFactor{"Gameplay:fGoldLossFactor", "Factor of the amount of gold lost on death", 0.0f};