Update 0.9, multifaction (rwmt#399)

- Protocol 34 - Multifaction: new hosting option, faction creation screen, set faction context in more places, refactor code related to factions - Remove id blocks - Track getting unique ids in desync traces - Log stack traces in Sync command write log - Use my UI layout helper (Layouter.cs) from Prepatcher - Only set faction context when necessary (should slightly improve performance) - Move Native and DeferredStackTracingImpl to Common - Reorganize project dependencies (they previously doubled as artifact output control) - Move conversion to singleplayer into its own file - Split player cursor and location ping code - Remove HotSwappableAttribute - Fix applying the mod list with "Fix and restart" - Fix issues with desync tracing and latest Harmony - Fix desyncs related to autosaving and battle log - Fix exception when not including all arguments in SyncMethod exposeParameters - Fix clicking on files in save list sometimes not working
SokyranTheDragon · Oct 18, 2023 · 768cfcd · 768cfcd
1 parent a4efdf7
commit 768cfcd
Show file tree

Hide file tree

Showing 140 changed files with 3,206 additions and 1,819 deletions.
diff --git a/.gitignore b/.gitignore
@@ -270,4 +270,6 @@ __pycache__/
 /Multiplayer
 Multiplayer*.zip
 
-!Source/Client/Debug/
+!Source/Client/Debug/
+
+/Source/mpdb
diff --git a/Source/Client/AsyncTime/AsyncTimeComp.cs b/Source/Client/AsyncTime/AsyncTimeComp.cs
@@ -7,6 +7,7 @@
 using Multiplayer.API;
 using Verse;
 using Multiplayer.Client.Comp;
+using Multiplayer.Client.Factions;
 using Multiplayer.Client.Patches;
 using Multiplayer.Client.Saving;
 using Multiplayer.Client.Util;
@@ -67,7 +68,7 @@ public void SetDesiredTimeSpeed(TimeSpeed speed)
 
         public float TimeToTickThrough { get; set; }
 
-        public Queue<ScheduledCommand> Cmds { get => cmds; }
+        public Queue<ScheduledCommand> Cmds => cmds;
 
         public int TickableId => map.uniqueID;
 
@@ -148,10 +149,7 @@ public void TickMapTrading()
                 if (session.playerNegotiator.Map != map) continue;
 
                 if (session.ShouldCancel())
-                {
                     Multiplayer.WorldComp.RemoveTradeSession(session);
-                    continue;
-                }
             }
         }
 
@@ -183,9 +181,6 @@ public void PreContext()
             Current.Game.storyteller = storyteller;
             Current.Game.storyWatcher = storyWatcher;
 
-            //UniqueIdsPatch.CurrentBlock = map.MpComp().mapIdBlock;
-            UniqueIdsPatch.CurrentBlock = Multiplayer.GlobalIdBlock;
-
             Rand.PushState();
             Rand.StateCompressed = randState;
 
@@ -195,8 +190,6 @@ public void PreContext()
 
         public void PostContext()
         {
-            UniqueIdsPatch.CurrentBlock = null;
-
             Current.Game.storyteller = prevStoryteller;
             Current.Game.storyWatcher = prevStoryWatcher;
 
@@ -276,11 +269,6 @@ public void ExecuteCmd(ScheduledCommand cmd)
                     MpDebugTools.HandleCmd(data);
                 }
 
-                if (cmdType == CommandType.CreateMapFactionData)
-                {
-                    HandleMapFactionData(cmd, data);
-                }
-
                 if (cmdType == CommandType.MapTimeSpeed && Multiplayer.GameComp.asyncTime)
                 {
                     TimeSpeed speed = (TimeSpeed)data.ReadByte();
@@ -289,19 +277,9 @@ public void ExecuteCmd(ScheduledCommand cmd)
                     MpLog.Debug("Set map time speed " + speed);
                 }
 
-                if (cmdType == CommandType.MapIdBlock)
-                {
-                    IdBlock block = IdBlock.Deserialize(data);
-
-                    if (map != null)
-                    {
-                        //map.MpComp().mapIdBlock = block;
-                    }
-                }
-
                 if (cmdType == CommandType.Designator)
                 {
-                    HandleDesignator(cmd, data);
+                    HandleDesignator(data);
                 }
 
                 UpdateManagers();
@@ -357,28 +335,11 @@ private static void TrySetCurrentMap(Map map)
             }
         }
 
-        private void HandleMapFactionData(ScheduledCommand cmd, ByteReader data)
-        {
-            int factionId = data.ReadInt32();
-
-            Faction faction = Find.FactionManager.GetById(factionId);
-            MultiplayerMapComp comp = map.MpComp();
-
-            if (!comp.factionData.ContainsKey(factionId))
-            {
-                BeforeMapGeneration.InitNewMapFactionData(map, faction);
-                MpLog.Log($"New map faction data for {faction.GetUniqueLoadID()}");
-            }
-        }
-
-        private void HandleDesignator(ScheduledCommand command, ByteReader data)
+        private void HandleDesignator(ByteReader data)
         {
-            var mode = SyncSerialization.ReadSync<DesignatorMode>(data);
-            var designator = SyncSerialization.ReadSync<Designator>(data);
-
             Container<Area>? prevArea = null;
 
-            bool SetState(Designator designator, ByteReader data)
+            bool SetState(Designator designator)
             {
                 if (designator is Designator_AreaAllowed)
                 {
@@ -415,9 +376,12 @@ void RestoreState()
                 DesignatorInstall_SetThingToInstall.thingToInstall = null;
             }
 
+            var mode = SyncSerialization.ReadSync<DesignatorMode>(data);
+            var designator = SyncSerialization.ReadSync<Designator>(data);
+
             try
             {
-                if (!SetState(designator, data)) return;
+                if (!SetState(designator)) return;
 
                 if (mode == DesignatorMode.SingleCell)
                 {
@@ -454,9 +418,8 @@ private void CacheNothingHappening()
             nothingHappeningCached = true;
             var list = map.mapPawns.SpawnedPawnsInFaction(Faction.OfPlayer);
 
-            for (int j = 0; j < list.Count; j++)
+            foreach (var pawn in list)
             {
-                Pawn pawn = list[j];
                 if (pawn.HostFaction == null && pawn.RaceProps.Humanlike && pawn.Awake())
                     nothingHappeningCached = false;
             }

diff --git a/Source/Client/AsyncTime/AsyncWorldTimeComp.cs b/Source/Client/AsyncTime/AsyncWorldTimeComp.cs
@@ -4,7 +4,7 @@
 using HarmonyLib;
 using Multiplayer.Client.Comp;
 using Multiplayer.Client.Desyncs;
-using Multiplayer.Client.Patches;
+using Multiplayer.Client.Factions;
 using Multiplayer.Client.Saving;
 using Multiplayer.Client.Util;
 using Multiplayer.Common;
@@ -45,10 +45,12 @@ public float TickRateMultiplier(TimeSpeed speed)
         };
     }
 
-    // Run at the speed of the fastest map
-    public TimeSpeed DesiredTimeSpeed => Find.Maps.Select(m => m.AsyncTime())
+    // Run at the speed of the fastest map or at chosen speed if there are no maps
+    public TimeSpeed DesiredTimeSpeed => !Find.Maps.Any() ?
+        timeSpeedInt :
+        Find.Maps.Select(m => m.AsyncTime())
         .Where(a => a.ActualRateMultiplier(a.DesiredTimeSpeed) != 0f)
-        .Max(a => a?.DesiredTimeSpeed) ?? timeSpeedInt;
+        .Max(a => a?.DesiredTimeSpeed) ?? TimeSpeed.Paused;
 
     public void SetDesiredTimeSpeed(TimeSpeed speed)
     {
@@ -137,16 +139,20 @@ public void Tick()
     public void PreContext()
     {
         Find.TickManager.CurTimeSpeed = DesiredTimeSpeed;
-        UniqueIdsPatch.CurrentBlock = Multiplayer.GlobalIdBlock;
         Rand.PushState();
         Rand.StateCompressed = randState;
+
+        if (Multiplayer.GameComp.multifaction)
+            FactionExtensions.PushFaction(null, Multiplayer.WorldComp.spectatorFaction);
     }
 
     public void PostContext()
     {
+        if (Multiplayer.GameComp.multifaction)
+            FactionExtensions.PopFaction();
+
         randState = Rand.StateCompressed;
         Rand.PopState();
-        UniqueIdsPatch.CurrentBlock = null;
     }
 
     public void ExecuteCmd(ScheduledCommand cmd)
@@ -159,7 +165,7 @@ public void ExecuteCmd(ScheduledCommand cmd)
         TickPatch.currentExecutingCmdIssuedBySelf = cmd.issuedBySelf && !TickPatch.Simulating;
 
         PreContext();
-        Extensions.PushFaction(null, cmd.GetFaction());
+        FactionExtensions.PushFaction(null, cmd.GetFaction());
 
         bool prevDevMode = Prefs.data.devMode;
         var prevGodMode = DebugSettings.godMode;
@@ -195,14 +201,9 @@ public void ExecuteCmd(ScheduledCommand cmd)
                 SetTimeEverywhere(TimeSpeed.Paused);
             }
 
-            if (cmdType == CommandType.SetupFaction)
-            {
-                HandleSetupFaction(cmd, data);
-            }
-
             if (cmdType == CommandType.CreateJoinPoint)
             {
-                LongEventHandler.QueueLongEvent(CreateJoinPoint, "MpCreatingJoinPoint", false, null);
+                LongEventHandler.QueueLongEvent(CreateJoinPointAndSendIfHost, "MpCreatingJoinPoint", false, null);
             }
 
             if (cmdType == CommandType.InitPlayerData)
@@ -224,7 +225,7 @@ public void ExecuteCmd(ScheduledCommand cmd)
             MpLog.Debug($"rand calls {DeferredStackTracing.randCalls - randCalls1}");
             MpLog.Debug("rand state " + Rand.StateCompressed);
 
-            Extensions.PopFaction();
+            FactionExtensions.PopFaction();
             PostContext();
             TickPatch.currentExecutingCmdIssuedBySelf = false;
             executingCmdWorld = false;
@@ -236,9 +237,9 @@ public void ExecuteCmd(ScheduledCommand cmd)
         }
     }
 
-    private static void CreateJoinPoint()
+    private static void CreateJoinPointAndSendIfHost()
     {
-        Multiplayer.session.dataSnapshot = SaveLoad.CreateGameDataSnapshot(SaveLoad.SaveAndReload());
+        Multiplayer.session.dataSnapshot = SaveLoad.CreateGameDataSnapshot(SaveLoad.SaveAndReload(), Multiplayer.GameComp.multifaction);
 
         if (!TickPatch.Simulating && !Multiplayer.IsReplay &&
             (Multiplayer.LocalServer != null || Multiplayer.arbiterInstance))
@@ -288,34 +289,6 @@ private void HandleTimeVote(ScheduledCommand cmd, ByteReader data)
             tickable.SetDesiredTimeSpeed(Multiplayer.GameComp.GetLowestTimeVote(tickableId));
     }
 
-    private void HandleSetupFaction(ScheduledCommand command, ByteReader data)
-    {
-        int factionId = data.ReadInt32();
-        Faction faction = Find.FactionManager.GetById(factionId);
-
-        if (faction == null)
-        {
-            faction = new Faction
-            {
-                loadID = factionId,
-                def = FactionDefOf.PlayerColony,
-                Name = "Multiplayer faction",
-            };
-
-            Find.FactionManager.Add(faction);
-
-            foreach (Faction current in Find.FactionManager.AllFactionsListForReading)
-            {
-                if (current == faction) continue;
-                current.TryMakeInitialRelationsWith(faction);
-            }
-
-            Multiplayer.WorldComp.factionData[factionId] = FactionWorldData.New(factionId);
-
-            MpLog.Log($"New faction {faction.GetUniqueLoadID()}");
-        }
-    }
-
     public void FinalizeInit()
     {
         Multiplayer.game.SetThingMakerSeed((int)(randState >> 32));

diff --git a/Source/Client/AsyncTime/StorytellerPatches.cs b/Source/Client/AsyncTime/StorytellerPatches.cs
@@ -1,5 +1,4 @@
-using System;
-using System.Collections.Generic;
+using System.Collections.Generic;
 using System.Linq;
 using System.Reflection;
 using HarmonyLib;

diff --git a/Source/Client/Comp/Game/MultiplayerGameComp.cs b/Source/Client/Comp/Game/MultiplayerGameComp.cs
@@ -11,38 +11,31 @@ namespace Multiplayer.Client.Comp
     public class MultiplayerGameComp : IExposable, IHasSemiPersistentData
     {
         public bool asyncTime;
+        public bool multifaction;
         public bool debugMode;
         public bool logDesyncTraces;
         public PauseOnLetter pauseOnLetter;
         public TimeControl timeControl;
         public Dictionary<int, PlayerData> playerData = new(); // player id to player data
 
-        public IdBlock globalIdBlock = new(int.MaxValue / 2, 1_000_000_000);
+        public string idBlockBase64;
 
         public bool IsLowestWins => timeControl == TimeControl.LowestWins;
 
         public PlayerData LocalPlayerDataOrNull => playerData.GetValueOrDefault(Multiplayer.session.playerId);
 
-        public MultiplayerGameComp(Game game)
-        {
-        }
-
         public void ExposeData()
         {
             Scribe_Values.Look(ref asyncTime, "asyncTime", true, true);
+            Scribe_Values.Look(ref multifaction, "multifaction", false, true);
             Scribe_Values.Look(ref debugMode, "debugMode");
             Scribe_Values.Look(ref logDesyncTraces, "logDesyncTraces");
             Scribe_Values.Look(ref pauseOnLetter, "pauseOnLetter");
             Scribe_Values.Look(ref timeControl, "timeControl");
 
-            Scribe_Custom.LookIdBlock(ref globalIdBlock, "globalIdBlock");
-
-            if (globalIdBlock == null)
-            {
-                // todo globalIdBlock was previously in WorldComp, this is a quick hack to make old saves compatible
-                Log.Warning("Global id block was null, fixing...");
-                globalIdBlock = new IdBlock(int.MaxValue / 2, 1_000_000_000);
-            }
+            // Store for back-compat conversion in GameExposeComponentsPatch
+            if (Scribe.mode == LoadSaveMode.LoadingVars)
+                Scribe_Values.Look(ref idBlockBase64, "globalIdBlock");
         }
 
         public void WriteSemiPersistent(ByteWriter writer)

diff --git a/Source/Client/Comp/Map/ExposeActor.cs b/Source/Client/Comp/Map/ExposeActor.cs
@@ -21,7 +21,7 @@ public void ExposeData()
     // This depends on the fact that the implementation of HashSet RimWorld currently uses
     // "preserves" insertion order (as long as elements are only added and not removed
     // [which is the case for Scribe managers])
-    public static void Register(Action action)
+    public static void OnPostInit(Action action)
     {
         if (Scribe.mode == LoadSaveMode.LoadingVars)
             Scribe.loader.initer.RegisterForPostLoadInit(new ExposeActor(action));

diff --git a/Source/Client/Comp/Map/FactionMapData.cs b/Source/Client/Comp/Map/FactionMapData.cs
@@ -1,3 +1,4 @@
+using Multiplayer.Client.Factions;
 using RimWorld;
 using Verse;
 
@@ -46,14 +47,14 @@ private FactionMapData(int factionId, Map map) : this(map)
 
     public void ExposeData()
     {
-        ExposeActor.Register(() => map.PushFaction(factionId));
+        ExposeActor.OnPostInit(() => map.PushFaction(factionId));
 
         Scribe_Values.Look(ref factionId, "factionId");
         Scribe_Deep.Look(ref designationManager, "designationManager", map);
         Scribe_Deep.Look(ref areaManager, "areaManager", map);
         Scribe_Deep.Look(ref zoneManager, "zoneManager", map);
 
-        ExposeActor.Register(() => map.PopFaction());
+        ExposeActor.OnPostInit(() => map.PopFaction());
     }
 
     public static FactionMapData New(int factionId, Map map)