feature: Add some convenience methods for player state management

Author: kirre-bylund

Runtime/Client/LootLockerStateData.cs

@@ -310,6 +310,29 @@ public static List<string> ClearAllSavedStates()
             return removedULIDs;
         }
 
+        public static List<string> ClearAllSavedStatesExceptForPlayer(string playerULID)
+        {
+            List<string> removedULIDs = new List<string>();
+            LoadMetaDataFromPlayerPrefsIfNeeded();
+            if (ActiveMetaData == null)
+            {
+                return removedULIDs;
+            }
+
+            List<string> ulidsToRemove = new List<string>(ActiveMetaData.SavedPlayerStateULIDs);
+            foreach (string ULID in ulidsToRemove)
+            {
+                if (!ULID.Equals(playerULID, StringComparison.OrdinalIgnoreCase))
+                {
+                    if (ClearSavedStateForPlayerWithULID(ULID))
+                    {
+                        removedULIDs.Add(ULID);
+                    }
+                }
+            }
+            return removedULIDs;
+        }
+
         public static void SetPlayerULIDToInactive(string playerULID)
         {
             if (string.IsNullOrEmpty(playerULID) || !ActivePlayerData.ContainsKey(playerULID))
@@ -320,6 +343,25 @@ public static void SetPlayerULIDToInactive(string playerULID)
             ActivePlayerData.Remove(playerULID);
         }
 
+        public static void SetAllPlayersToInactive()
+        {
+            ActivePlayerData.Clear();
+        }
+
+        public static void SetAllPlayersToInactiveExceptForPlayer(string playerULID)
+        {
+            if (string.IsNullOrEmpty(playerULID))
+            {
+                return;
+            }
+
+            var keysToRemove = ActivePlayerData.Keys.Where(key => !key.Equals(playerULID, StringComparison.OrdinalIgnoreCase)).ToList();
+            foreach (string key in keysToRemove)
+            {
+                ActivePlayerData.Remove(key);
+            }
+        }
+
         public static List<string> GetActivePlayerULIDs()
         {
             return ActivePlayerData.Keys.ToList();

Runtime/Game/LootLockerSDKManager.cs

@@ -151,6 +151,27 @@ public static void SetPlayerUlidToInactive(string playerUlid)
             LootLockerStateData.SetPlayerULIDToInactive(playerUlid);
         }
 
+        /// <summary>
+        /// Make the state for all currently active players to be "inactive".
+        /// 
+        /// This will not delete the state, but it will remove all players from the list of active players.
+        /// </summary>
+        public static void SetAllPlayersToInactive()
+        {
+            LootLockerStateData.SetAllPlayersToInactive();
+        }
+
+        /// <summary>
+        /// Make the state for all currently active players except the specified player to be "inactive".
+        /// 
+        /// This will not delete the state, but it will remove all players except the specified one from the list of active players.
+        /// </summary>
+        /// <param name="playerUlid">The ULID of the player to keep active.</param>
+        public static void SetAllPlayersToInactiveExceptForPlayer(string playerUlid)
+        {
+            LootLockerStateData.SetAllPlayersToInactiveExceptForPlayer(playerUlid);
+        }
+
         /// <summary>
         /// Get a list of player ULIDs that there is a stored state for.
         /// This includes both active and inactive players.
@@ -213,6 +234,17 @@ public static void ClearAllPlayerCaches()
             LootLockerStateData.ClearAllSavedStates();
         }
 
+        /// <summary>
+        /// Remove all stored state information except for the specified player (players will need to re-authenticate).
+        /// This will clear all player states except for the specified player.
+        /// If the specified player is the default player, it will remain as the default player.
+        /// </summary>
+        /// <param name="playerUlid">The ULID of the player to save the cache for.</param>
+        public static void ClearAllPlayerCachesExceptForPlayer(string playerUlid)
+        {
+            LootLockerStateData.ClearAllSavedStatesExceptForPlayer(playerUlid);
+        }
+
         #endregion
 
         #region Authentication