Session rework

Source/Client/AsyncTime/AsyncTimeComp.cs

@@ -18,19 +18,13 @@ public class AsyncTimeComp : IExposable, ITickable
     {
         public static Map tickingMap;
         public static Map executingCmdMap;
-        public static List<PauseLockDelegate> pauseLocks = new();
 
         public float TickRateMultiplier(TimeSpeed speed)
         {
             var comp = map.MpComp();
 
-            var enforcePause = comp.transporterLoading != null ||
-                comp.caravanForming != null ||
-                comp.ritualSession != null ||
-                comp.mapDialogs.Any() ||
-                Multiplayer.WorldComp.AnyTradeSessionsOnMap(map) ||
-                Multiplayer.WorldComp.splitSession != null ||
-                pauseLocks.Any(x => x(map));
+            var enforcePause = comp.sessionManager.IsAnySessionCurrentlyPausing(map) ||
+                Multiplayer.WorldComp.sessionManager.IsAnySessionCurrentlyPausing(map);
 
             if (enforcePause)
                 return 0f;
@@ -113,7 +107,7 @@ public void Tick()
                 tickListRare.Tick();
                 tickListLong.Tick();
 
-                TickMapTrading();
+                TickMapSessions();
 
                 storyteller.StorytellerTick();
                 storyWatcher.StoryWatcherTick();
@@ -139,18 +133,9 @@ public void Tick()
             }
         }
 
-        public void TickMapTrading()
+        public void TickMapSessions()
         {
-            var trading = Multiplayer.WorldComp.trading;
-
-            for (int i = trading.Count - 1; i >= 0; i--)
-            {
-                var session = trading[i];
-                if (session.playerNegotiator.Map != map) continue;
-
-                if (session.ShouldCancel())
-                    Multiplayer.WorldComp.RemoveTradeSession(session);
-            }
+            map.MpComp().sessionManager.TickSessions();
         }
 
         // These are normally called in Map.MapUpdate() and react to changes in the game state even when the game is paused (not ticking)

Source/Client/AsyncTime/AsyncWorldTimeComp.cs

@@ -27,8 +27,7 @@ public float TickRateMultiplier(TimeSpeed speed)
     {
         if (Multiplayer.GameComp.asyncTime)
         {
-            var enforcePause = Multiplayer.WorldComp.splitSession != null ||
-                               AsyncTimeComp.pauseLocks.Any(x => x(null));
+            var enforcePause = Multiplayer.WorldComp.sessionManager.IsAnySessionCurrentlyPausing(null);
 
             if (enforcePause)
                 return 0f;
@@ -104,7 +103,7 @@ public void Tick()
         {
             Find.TickManager.DoSingleTick();
             worldTicks++;
-            Multiplayer.WorldComp.TickWorldTrading();
+            Multiplayer.WorldComp.TickWorldSessions();
 
             if (ModsConfig.BiotechActive)
             {

Source/Client/AsyncTime/TimeControlUI.cs

@@ -358,58 +358,9 @@ static void DrawWindowShortcuts(Rect button, Color bgColor, List<FloatMenuOption
 
     static List<FloatMenuOption> GetBlockingWindowOptions(ColonistBar.Entry entry, ITickable tickable)
     {
-        List<FloatMenuOption> options = new List<FloatMenuOption>();
-        var split = Multiplayer.WorldComp.splitSession;
-
-        if (split != null && split.Caravan.pawns.Contains(entry.pawn))
-        {
-            options.Add(new FloatMenuOption("MpCaravanSplittingSession".Translate(), () =>
-            {
-                SwitchToMapOrWorld(entry.map);
-                CameraJumper.TryJumpAndSelect(entry.pawn);
-                Multiplayer.WorldComp.splitSession.OpenWindow();
-            }));
-        }
-
-        if (Multiplayer.WorldComp.trading.FirstOrDefault(t => t.playerNegotiator?.Map == entry.map) is { } trade)
-        {
-            options.Add(new FloatMenuOption("MpTradingSession".Translate(), () =>
-            {
-                SwitchToMapOrWorld(entry.map);
-                CameraJumper.TryJumpAndSelect(trade.playerNegotiator);
-                Find.WindowStack.Add(new TradingWindow()
-                    { selectedTab = Multiplayer.WorldComp.trading.IndexOf(trade) });
-            }));
-        }
-
-        if (entry.map?.MpComp().transporterLoading != null)
-        {
-            options.Add(new FloatMenuOption("MpTransportLoadingSession".Translate(), () =>
-            {
-                SwitchToMapOrWorld(entry.map);
-                entry.map.MpComp().transporterLoading.OpenWindow();
-            }));
-        }
-
-        if (entry.map?.MpComp().caravanForming != null)
-        {
-            options.Add(new FloatMenuOption("MpCaravanFormingSession".Translate(), () =>
-            {
-                SwitchToMapOrWorld(entry.map);
-                entry.map.MpComp().caravanForming.OpenWindow();
-            }));
-        }
-
-        if (entry.map?.MpComp().ritualSession != null)
-        {
-            options.Add(new FloatMenuOption("MpRitualSession".Translate(), () =>
-            {
-                SwitchToMapOrWorld(entry.map);
-                entry.map.MpComp().ritualSession.OpenWindow();
-            }));
-        }
-
-        return options;
+        return Multiplayer.WorldComp.sessionManager.AllSessions
+            .ConcatIfNotNull(entry.map?.MpComp().sessionManager.AllSessions)
+            .Select(s => s.GetBlockingWindowOptions(entry)).Where(fmo => fmo != null).ToList();
     }
 
     static void SwitchToMapOrWorld(Map map)

Source/Client/Comp/Game/MultiplayerGameComp.cs

@@ -17,6 +17,7 @@ public class MultiplayerGameComp : IExposable, IHasSessionData
         public PauseOnLetter pauseOnLetter;
         public TimeControl timeControl;
         public Dictionary<int, PlayerData> playerData = new(); // player id to player data
+        public int nextSessionId;
 
         public string idBlockBase64;
 
@@ -32,6 +33,7 @@ public void ExposeData()
             Scribe_Values.Look(ref logDesyncTraces, "logDesyncTraces");
             Scribe_Values.Look(ref pauseOnLetter, "pauseOnLetter");
             Scribe_Values.Look(ref timeControl, "timeControl");
+            Scribe_Values.Look(ref nextSessionId, "nextSessionId");
 
             // Store for back-compat conversion in GameExposeComponentsPatch
             if (Scribe.mode == LoadSaveMode.LoadingVars)

Source/Client/Comp/Map/MultiplayerMapComp.cs

@@ -22,9 +22,7 @@ public class MultiplayerMapComp : IExposable, IHasSessionData
         public SortedDictionary<int, FactionMapData> factionData = new();
         public SortedDictionary<int, CustomFactionMapData> customFactionData = new();
 
-        public CaravanFormingSession caravanForming;
-        public TransporterLoading transporterLoading;
-        public RitualSession ritualSession;
+        public SessionManager sessionManager;
         public List<PersistentDialog> mapDialogs = new();
         public int autosaveCounter;
 
@@ -34,26 +32,54 @@ public class MultiplayerMapComp : IExposable, IHasSessionData
         public MultiplayerMapComp(Map map)
         {
             this.map = map;
+            sessionManager = new(map);
         }
 
         public CaravanFormingSession CreateCaravanFormingSession(bool reform, Action onClosed, bool mapAboutToBeRemoved, IntVec3? meetingSpot = null)
         {
+            var caravanForming = sessionManager.GetFirstOfType<CaravanFormingSession>();
             if (caravanForming == null)
+            {
                 caravanForming = new CaravanFormingSession(map, reform, onClosed, mapAboutToBeRemoved, meetingSpot);
+                if (!sessionManager.AddSession(caravanForming))
+                {
+                    // Shouldn't happen if the session doesn't exist already, show an error just in case
+                    Log.Error($"Failed trying to created a session of type {nameof(CaravanFormingSession)} - prior session did not exist and creating session failed.");
+                    return null;
+                }
+            }
             return caravanForming;
         }
 
         public TransporterLoading CreateTransporterLoadingSession(List<CompTransporter> transporters)
         {
+            var transporterLoading = sessionManager.GetFirstOfType<TransporterLoading>();
             if (transporterLoading == null)
+            {
                 transporterLoading = new TransporterLoading(map, transporters);
+                if (!sessionManager.AddSession(transporterLoading))
+                {
+                    // Shouldn't happen if the session doesn't exist already, show an error just in case
+                    Log.Error($"Failed trying to created a session of type {nameof(TransporterLoading)} - prior session did not exist and creating session failed.");
+                    return null;
+                }
+            }
             return transporterLoading;
         }
 
         public RitualSession CreateRitualSession(RitualData data)
         {
+            var ritualSession = sessionManager.GetFirstOfType<RitualSession>();
             if (ritualSession == null)
+            {
                 ritualSession = new RitualSession(map, data);
+                if (!sessionManager.AddSession(ritualSession))
+                {
+                    // Shouldn't happen if the session doesn't exist already, show an error just in case
+                    Log.Error($"Failed trying to created a session of type {nameof(RitualSession)} - prior session did not exist and creating session failed.");
+                    return null;
+                }
+            }
             return ritualSession;
         }
 
@@ -115,8 +141,7 @@ public void ExposeData()
                 Scribe_Values.Look(ref isPlayerHome, "isPlayerHome", false, true);
             }
 
-            Scribe_Deep.Look(ref caravanForming, "caravanFormingSession", map);
-            Scribe_Deep.Look(ref transporterLoading, "transporterLoading", map);
+            sessionManager.ExposeSessions();
 
             Scribe_Collections.Look(ref mapDialogs, "mapDialogs", LookMode.Deep, map);
             if (Scribe.mode == LoadSaveMode.LoadingVars && mapDialogs == null)
@@ -164,21 +189,14 @@ public void WriteSessionData(ByteWriter writer)
         {
             writer.WriteInt32(autosaveCounter);
 
-            writer.WriteBool(ritualSession != null);
-            ritualSession?.Write(writer);
+            sessionManager.WriteSemiPersistent(writer);
         }
 
         public void ReadSessionData(ByteReader reader)
         {
             autosaveCounter = reader.ReadInt32();
 
-            var hasRitual = reader.ReadBool();
-            if (hasRitual)
-            {
-                var session = new RitualSession(map);
-                session.Read(reader);
-                ritualSession = session;
-            }
+            sessionManager.ReadSemiPersistent(reader);
         }
 
         public int GetFactionId(ZoneManager zoneManager)
@@ -215,13 +233,9 @@ static void Prefix()
             if (Multiplayer.Client == null) return;
 
             // Trading window on resume save
-            if (Multiplayer.WorldComp.trading.NullOrEmpty()) return;
-
+            if (!Multiplayer.WorldComp.trading.NullOrEmpty()) return;
             // playerNegotiator == null can only happen during loading? Is this a resuming check?
-            if (Multiplayer.WorldComp.trading.FirstOrDefault(t => t.playerNegotiator == null) is { } trade)
-            {
-                trade.OpenWindow();
-            }
+            Multiplayer.WorldComp.trading.FirstOrDefault(t => t.playerNegotiator == null)?.OpenWindow();
         }
     }
 

Source/Client/Comp/World/MultiplayerWorldComp.cs

@@ -5,19 +5,20 @@
 using Verse;
 using Multiplayer.Client.Persistent;
 using Multiplayer.Client.Saving;
+using Multiplayer.Common;
 
 namespace Multiplayer.Client;
 
-public class MultiplayerWorldComp
+public class MultiplayerWorldComp : IHasSemiPersistentData
 {
     // SortedDictionary to ensure determinism
     public SortedDictionary<int, FactionWorldData> factionData = new();
 
     public World world;
 
     public TileTemperaturesComp uiTemperatures;
-    public List<MpTradeSession> trading = new();
-    public CaravanSplittingSession splitSession;
+    public List<MpTradeSession> trading = new(); // Should only be modified from MpTradeSession in PostAdd/Remove and ExposeData
+    public SessionManager sessionManager = new(null);
 
     public Faction spectatorFaction;
 
@@ -34,11 +35,10 @@
     {
         ExposeFactionData();
 
-        Scribe_Collections.Look(ref trading, "tradingSessions", LookMode.Deep);
-
-        if (Scribe.mode == LoadSaveMode.PostLoadInit)
-            if (trading.RemoveAll(t => t.trader == null || t.playerNegotiator == null) > 0)
-                Log.Message("Some trading sessions had null entries");
+        sessionManager.ExposeSessions();
+        // Ensure a pause lock session exists if there's any pause locks registered
+        if (!PauseLockSession.pauseLocks.NullOrEmpty())
+            sessionManager.AddSession(new PauseLockSession(null));
 
         DoBackCompat();
     }
@@ -116,23 +116,25 @@
         }
     }
 
-    public void TickWorldTrading()
+    public void WriteSemiPersistent(ByteWriter writer)
     {
-        for (int i = trading.Count - 1; i >= 0; i--)
-        {
-            var session = trading[i];
-            if (session.playerNegotiator.Spawned) continue;
+        sessionManager.WriteSemiPersistent(writer);
+    }
 
-            if (session.ShouldCancel())
-                RemoveTradeSession(session);
-        }
+    public void ReadSemiPersistent(ByteReader data)
+    {
+        sessionManager.ReadSemiPersistent(data);
+    }
+
+    public void TickWorldSessions()
+    {
+        sessionManager.TickSessions();
     }
 
     public void RemoveTradeSession(MpTradeSession session)
     {
-        int index = trading.IndexOf(session);
-        trading.Remove(session);
-        Find.WindowStack?.WindowOfType<TradingWindow>()?.Notify_RemovedSession(index);
+        // Cleanup and removal from `trading` field is handled in PostRemoveSession
+        sessionManager.RemoveSession(session);
     }
 
     public void SetFaction(Faction faction)

Source/Client/Experimental/ISessionManager.cs

@@ -0,0 +1,50 @@
+using System.Collections.Generic;
+using Multiplayer.Client.Persistent;
+using Verse;
+
+namespace Multiplayer.Client.Experimental;
+
+public interface ISessionManager
+{
+    IReadOnlyList<Session> AllSessions { get; }
+    IReadOnlyList<ExposableSession> ExposableSessions { get; }
+    IReadOnlyList<SemiPersistentSession> SemiPersistentSessions { get; }
+    IReadOnlyList<ITickingSession> TickingSessions { get; }
+    bool AnySessionActive { get; }
+
+    /// <summary>
+    /// Adds a new session to the list of active sessions.
+    /// </summary>
+    /// <param name="session">The session to try to add to active sessions.</param>
+    /// <returns><see langword="true"/> if the session was added to active ones, <see langword="false"/> if there was a conflict between sessions.</returns>
+    bool AddSession(Session session);
+
+    /// <summary>
+    /// Tries to get a conflicting session (through the use of <see cref="ISessionWithCreationRestrictions"/>) or, if there was none, returns the input <paramref name="session"/>.
+    /// </summary>
+    /// <param name="session">The session to try to add to active sessions.</param>
+    /// <returns>A session that was conflicting with the input one, or the input itself if there were no conflicts. It may be of a different type than the input.</returns>
+    Session GetOrAddSessionAnyConflict(Session session);
+
+    /// <summary>
+    /// Tries to get a conflicting session (through the use of <see cref="ISessionWithCreationRestrictions"/>) or, if there was none, returns the input <paramref name="session"/>.
+    /// </summary>
+    /// <param name="session">The session to try to add to active sessions.</param>
+    /// <returns>A session that was conflicting with the input one if it's the same type (<c>other is T</c>), null if it's a different type, or the input itself if there were no conflicts.</returns>
+    T GetOrAddSession<T>(T session) where T : Session;
+
+    /// <summary>
+    /// Tries to remove a session from active ones.
+    /// </summary>
+    /// <param name="session">The session to try to remove from the active sessions.</param>
+    /// <returns><see langword="true"/> if successfully removed from <see cref="AllSessions"/>. Doesn't correspond to if it was successfully removed from other lists of sessions.</returns>
+    bool RemoveSession(Session session);
+
+    T GetFirstOfType<T>() where T : Session;
+
+    T GetFirstWithId<T>(int id) where T : Session;
+
+    Session GetFirstWithId(int id);
+
+    bool IsAnySessionCurrentlyPausing(Map map); // Is it necessary for the API?
+}