Rename semi-persistent data -> session data

Fix faction chooser overlapping world terrain information
Fix desyncs when there are more than 2 player factions
Fix desyncs related to quest generation

Source/Client/AsyncTime/AsyncTimeComp.cs

@@ -173,9 +173,11 @@ public void PreContext()
         {
             if (Multiplayer.GameComp.multifaction)
             {
-                map.PushFaction(map.ParentFaction is { IsPlayer: true }
+                map.PushFaction(
+                    map.ParentFaction is { IsPlayer: true }
                     ? map.ParentFaction
-                    : Multiplayer.WorldComp.spectatorFaction);
+                    : Multiplayer.WorldComp.spectatorFaction,
+                    force: true);
             }
 
             prevTime = TimeSnapshot.GetAndSetFromMap(map);

Source/Client/AsyncTime/AsyncWorldTimeComp.cs

@@ -143,13 +143,21 @@ public void PreContext()
         Rand.StateCompressed = randState;
 
         if (Multiplayer.GameComp.multifaction)
-            FactionExtensions.PushFaction(null, Multiplayer.WorldComp.spectatorFaction);
+        {
+            FactionExtensions.PushFaction(null, Multiplayer.WorldComp.spectatorFaction, force: true);
+            foreach (var map in Find.Maps)
+                map.MpComp().SetFaction(Multiplayer.WorldComp.spectatorFaction);
+        }
     }
 
     public void PostContext()
     {
         if (Multiplayer.GameComp.multifaction)
-            FactionExtensions.PopFaction();
+        {
+            var f = FactionExtensions.PopFaction();
+            foreach (var map in Find.Maps)
+                map.MpComp().SetFaction(f);
+        }
 
         randState = Rand.StateCompressed;
         Rand.PopState();

Source/Client/Comp/Game/MultiplayerGameComp.cs

@@ -8,7 +8,7 @@
 
 namespace Multiplayer.Client.Comp
 {
-    public class MultiplayerGameComp : IExposable, IHasSemiPersistentData
+    public class MultiplayerGameComp : IExposable, IHasSessionData
     {
         public bool asyncTime;
         public bool multifaction;
@@ -38,12 +38,12 @@ public void ExposeData()
                 Scribe_Values.Look(ref idBlockBase64, "globalIdBlock");
         }
 
-        public void WriteSemiPersistent(ByteWriter writer)
+        public void WriteSessionData(ByteWriter writer)
         {
             SyncSerialization.WriteSync(writer, playerData);
         }
 
-        public void ReadSemiPersistent(ByteReader reader)
+        public void ReadSessionData(ByteReader reader)
         {
             playerData = SyncSerialization.ReadSync<Dictionary<int, PlayerData>>(reader);
             DebugSettings.godMode = LocalPlayerDataOrNull?.godMode ?? false;

Source/Client/Comp/Map/MultiplayerMapComp.cs

@@ -12,14 +12,15 @@
 
 namespace Multiplayer.Client
 {
-    public class MultiplayerMapComp : IExposable, IHasSemiPersistentData
+    public class MultiplayerMapComp : IExposable, IHasSessionData
     {
         public static bool tickingFactions;
 
         public Map map;
 
-        public Dictionary<int, FactionMapData> factionData = new();
-        public Dictionary<int, CustomFactionMapData> customFactionData = new();
+        // SortedDictionary to ensure determinism
+        public SortedDictionary<int, FactionMapData> factionData = new();
+        public SortedDictionary<int, CustomFactionMapData> customFactionData = new();
 
         public CaravanFormingSession caravanForming;
         public TransporterLoading transporterLoading;
@@ -131,10 +132,10 @@ private void ExposeFactionData()
         {
             if (Scribe.mode == LoadSaveMode.Saving)
             {
-                int currentFactionId =GetFactionId(map.zoneManager);
+                int currentFactionId = GetFactionId(map.zoneManager);
                 Scribe_Custom.LookValue(currentFactionId, "currentFactionId");
 
-                var savedFactionData = new Dictionary<int, FactionMapData>(factionData);
+                var savedFactionData = new SortedDictionary<int, FactionMapData>(factionData);
                 savedFactionData.Remove(currentFactionId);
                 Scribe_Custom.LookValueDeep(ref savedFactionData, "factionMapData", map);
             }
@@ -144,8 +145,7 @@ private void ExposeFactionData()
                 Scribe_Values.Look(ref currentFactionId, "currentFactionId");
 
                 Scribe_Custom.LookValueDeep(ref factionData, "factionMapData", map);
-                if (factionData == null)
-                    factionData = new Dictionary<int, FactionMapData>();
+                factionData ??= new SortedDictionary<int, FactionMapData>();
             }
 
             if (Scribe.mode == LoadSaveMode.LoadingVars)
@@ -157,18 +157,18 @@ private void ExposeFactionData()
         private void ExposeCustomFactionData()
         {
             Scribe_Custom.LookValueDeep(ref customFactionData, "customFactionMapData", map);
-            customFactionData ??= new Dictionary<int, CustomFactionMapData>();
+            customFactionData ??= new SortedDictionary<int, CustomFactionMapData>();
         }
 
-        public void WriteSemiPersistent(ByteWriter writer)
+        public void WriteSessionData(ByteWriter writer)
         {
             writer.WriteInt32(autosaveCounter);
 
             writer.WriteBool(ritualSession != null);
             ritualSession?.Write(writer);
         }
 
-        public void ReadSemiPersistent(ByteReader reader)
+        public void ReadSessionData(ByteReader reader)
         {
             autosaveCounter = reader.ReadInt32();
 

Source/Client/Comp/World/MultiplayerWorldComp.cs

@@ -10,7 +10,8 @@ namespace Multiplayer.Client;
 
 public class MultiplayerWorldComp
 {
-    public Dictionary<int, FactionWorldData> factionData = new();
+    // SortedDictionary to ensure determinism
+    public SortedDictionary<int, FactionWorldData> factionData = new();
 
     public World world;
 
@@ -33,7 +34,6 @@ public void ExposeData()
     {
         ExposeFactionData();
 
-        Scribe_References.Look(ref spectatorFaction, "spectatorFaction");
         Scribe_Collections.Look(ref trading, "tradingSessions", LookMode.Deep);
 
         if (Scribe.mode == LoadSaveMode.PostLoadInit)
@@ -82,28 +82,31 @@ void RemoveOpponentFaction()
 
     private void ExposeFactionData()
     {
+        Scribe_References.Look(ref spectatorFaction, "spectatorFaction");
+
         if (Scribe.mode == LoadSaveMode.Saving)
         {
             int currentFactionId = GetFactionId(Find.ResearchManager);
             Scribe_Custom.LookValue(currentFactionId, "currentFactionId");
 
-            var savedFactionData = new Dictionary<int, FactionWorldData>(factionData);
+            var savedFactionData = new SortedDictionary<int, FactionWorldData>(factionData);
             savedFactionData.Remove(currentFactionId);
 
-            Scribe_Collections.Look(ref savedFactionData, "factionData", LookMode.Value, LookMode.Deep);
+            Scribe_Custom.LookValueDeep(ref savedFactionData, "factionData");
         }
         else
         {
             // The faction whose data is currently set
             Scribe_Values.Look(ref currentFactionId, "currentFactionId");
 
-            Scribe_Collections.Look(ref factionData, "factionData", LookMode.Value, LookMode.Deep);
-            factionData ??= new Dictionary<int, FactionWorldData>();
+            Scribe_Custom.LookValueDeep(ref factionData, "factionData");
+            factionData ??= new SortedDictionary<int, FactionWorldData>();
         }
 
         if (Scribe.mode == LoadSaveMode.LoadingVars && Multiplayer.session != null && Multiplayer.game != null)
         {
-            Multiplayer.game.myFactionLoading = Find.FactionManager.GetById(Multiplayer.session.myFactionId);
+            Multiplayer.game.myFactionLoading =
+                Find.FactionManager.GetById(Multiplayer.session.myFactionId) ?? spectatorFaction;
         }
 
         if (Scribe.mode == LoadSaveMode.LoadingVars)

Source/Client/Debug/DebugActions.cs

@@ -201,12 +201,6 @@ static void MultiplayerMethodCallLogger(MethodBase __originalMethod)
             Debug.Log(__originalMethod.FullDescription());
         }
 
-        [DebugAction(MultiplayerCategory, allowedGameStates = AllowedGameStates.Playing)]
-        static void Add1000TicksToTime()
-        {
-            Find.TickManager.ticksGameInt += 1000;
-        }
-
 #if DEBUG
 
         [DebugOutput]

Source/Client/Desyncs/DeferredStackTracing.cs

@@ -2,8 +2,10 @@
 using System.Reflection;
 using HarmonyLib;
 using Multiplayer.Client.Patches;
+using Multiplayer.Common;
 using RimWorld;
 using Verse;
+using Verse.AI;
 
 namespace Multiplayer.Client.Desyncs
 {
@@ -19,7 +21,6 @@ static IEnumerable<MethodBase> TargetMethods()
         {
             yield return AccessTools.PropertyGetter(typeof(Rand), nameof(Rand.Value));
             yield return AccessTools.PropertyGetter(typeof(Rand), nameof(Rand.Int));
-            //yield return AccessTools.Method(typeof(Thing), nameof(Thing.DeSpawn));
         }
 
         public static int acc;
@@ -57,6 +58,45 @@ public static bool ShouldAddStackTraceForDesyncLog()
         }
     }
 
+    [HarmonyPatch(typeof(UniqueIDsManager), nameof(UniqueIDsManager.GetNextID))]
+    public static class UniqueIdsPatch
+    {
+        static void Postfix()
+        {
+            DeferredStackTracing.Postfix();
+        }
+    }
+
+    [HarmonyPatch(typeof(Thing), nameof(Thing.SpawnSetup))]
+    public static class ThingSpawnPatch
+    {
+        static void Postfix(Thing __instance)
+        {
+            if (__instance.def.HasThingIDNumber)
+                DeferredStackTracing.Postfix();
+        }
+    }
+
+    [HarmonyPatch(typeof(Thing), nameof(Thing.DeSpawn))]
+    public static class ThingDeSpawnPatch
+    {
+        static void Postfix(Thing __instance)
+        {
+            if (__instance.def.HasThingIDNumber)
+                DeferredStackTracing.Postfix();
+        }
+    }
+
+    [HarmonyPatch(typeof(Pawn_JobTracker), nameof(Pawn_JobTracker.EndCurrentJob))]
+    public static class EndCurrentJobPatch
+    {
+        static void Prefix(Pawn_JobTracker __instance)
+        {
+            if (MpVersion.IsDebug && __instance.curJob != null && DeferredStackTracing.ShouldAddStackTraceForDesyncLog())
+                Multiplayer.game.sync.TryAddInfoForDesyncLog($"EndCurrentJob for {__instance.pawn}: {__instance.curJob}", "");
+        }
+    }
+
     [HarmonyPatch(typeof(WildAnimalSpawner), nameof(WildAnimalSpawner.WildAnimalSpawnerTick))]
     static class WildAnimalSpawnerTickTraceIgnore
     {

Source/Client/Desyncs/SyncCoordinator.cs

@@ -190,7 +190,8 @@ public void TryAddMapRandomState(int map, ulong state)
         /// <summary>
         /// Logs an item to aid in desync debugging.
         /// </summary>
-        /// <param name="info">Information to be logged</param>
+        /// <param name="info1">Information to be logged</param>
+        /// <param name="info2">Information to be logged</param>
         public void TryAddInfoForDesyncLog(string info1, string info2)
         {
             if (!ShouldCollect) return;

Source/Client/Factions/FactionContext.cs

@@ -8,9 +8,9 @@ public static class FactionContext
     {
         public static Stack<Faction> stack = new();
 
-        public static Faction Push(Faction newFaction)
+        public static Faction Push(Faction newFaction, bool force = false)
         {
-            if (newFaction == null || Find.FactionManager.ofPlayer == newFaction || !newFaction.def.isPlayer)
+            if (newFaction == null || !force && Find.FactionManager.ofPlayer == newFaction || !newFaction.def.isPlayer)
             {
                 stack.Push(null);
                 return null;