Greatly simplified save slot implementation - bumping minor version number to 0.10.0

Author: nickpettit

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [0.10.0] - 2025-08-06
+Have you ever had a great idea, only to have a much (much) simpler version of that idea immediately after making a new release of your open source project?
+
+This reverts several of the changes made in the release 0.9.0, simplifying the SaveManager API and achieving save slots with a simpler approach.
+- Previous changes to SaveManager methods - Save(), Load(), Erase(), and Delete() - that required a save slot parameter have been reverted. The FileHandler will now use the SaveManager.SaveSlotIndex in the GetPartialPath() method and use a save slot if the value is greater than -1.
+- SaveManager now stores a static int representing the current save slot, called SaveManager.SaveSlotIndex. Setting this to a value will use the save slot on that index, while -1 will ignore save slots. 
+- Registering a Saveable that has already been registered will now only emit a warning rather than an error.
+
 ## [0.9.0] - 2025-08-06
 - **Breaking Change**: Added support for save slots! The SaveManager now requires a save slot parameter for all methods that interact with save data. This allows for multiple save files to be managed simultaneously, such as for different runs or user profiles.
 - **Breaking Change**: LoadDefaults() is a new method that replaces the previous Load() method signature that would allow for a boolean to ignore save data.

Runtime/FileHandler.cs

@@ -63,16 +63,14 @@ protected virtual void ValidatePath(string pathOrFilename)
         /// </code>
         /// </summary>
         /// <param name="pathOrFilename">The path or filename of the file that will be combined with the persistent data path.</param>
-        /// <param name="saveSlotIndex">The save slot index to use. Passing in anything below 0 will not
-        /// use a slot, which can be good for things like settings files or for projects that don't use save slots.</param>
-        protected string GetPartialPath(string pathOrFilename, int saveSlotIndex = -1)
+        protected string GetPartialPath(string pathOrFilename)
         {
             ValidatePath(pathOrFilename);
 
             string path = $"{pathOrFilename}{FilenameSuffix}{FileExtension}";
 
-            if (saveSlotIndex > -1)
-                return Path.Combine($"slot{saveSlotIndex}", path);
+            if (SaveManager.SaveSlotIndex > -1)
+                return Path.Combine($"slot{SaveManager.SaveSlotIndex}", path);
 
             return path;
         }
@@ -85,10 +83,8 @@ protected string GetPartialPath(string pathOrFilename, int saveSlotIndex = -1)
         /// </code>
         /// </summary>
         /// <param name="pathOrFilename">The path or filename of the file that will be combined with the persistent data path.</param>
-        /// <param name="saveSlotIndex">The save slot index to use. Passing in anything below 0 will not
-        /// use a slot, which can be good for things like settings files or for projects that don't use save slots.</param>
-        protected virtual string GetFullPath(string pathOrFilename, int saveSlotIndex = -1)
-            => Path.Combine(m_persistentDataPath, GetPartialPath(pathOrFilename, saveSlotIndex));
+        protected virtual string GetFullPath(string pathOrFilename)
+            => Path.Combine(m_persistentDataPath, GetPartialPath(pathOrFilename));
 
         /// <summary>
         /// Returns true if a file exists at the given path or filename.
@@ -98,11 +94,9 @@ protected virtual string GetFullPath(string pathOrFilename, int saveSlotIndex =
         /// </code>
         /// </summary>
         /// <param name="pathOrFilename">The path or filename of the file to check.</param>
-        /// <param name="saveSlotIndex">The save slot index to use. Passing in anything below 0 will not
-        /// use a slot, which can be good for things like settings files or for projects that don't use save slots.</param>
         /// <returns>True if the file exists; otherwise, false.</returns>
-        public virtual bool Exists(string pathOrFilename, int saveSlotIndex = -1)
-            => File.Exists(GetFullPath(pathOrFilename, saveSlotIndex));
+        public virtual bool Exists(string pathOrFilename)
+            => File.Exists(GetFullPath(pathOrFilename));
 
         /// <summary>
         /// Writes the given content to a file at the given path or filename.
@@ -114,11 +108,9 @@ public virtual bool Exists(string pathOrFilename, int saveSlotIndex = -1)
         /// <param name="pathOrFilename">The path or filename of the file to write.</param>
         /// <param name="content">The string to write to the file.</param>
         /// <param name="cancellationToken">The cancellation token should be the same one from the calling MonoBehaviour.</param>
-        /// <param name="saveSlotIndex">The save slot index to use. Passing in anything below 0 will not
-        /// use a slot, which can be good for things like settings files or for projects that don't use save slots.</param>
-        public virtual async Task WriteFile(string pathOrFilename, string content, CancellationToken cancellationToken, int saveSlotIndex = -1)
+        public virtual async Task WriteFile(string pathOrFilename, string content, CancellationToken cancellationToken)
         {
-            string fullPath = GetFullPath(pathOrFilename, saveSlotIndex);
+            string fullPath = GetFullPath(pathOrFilename);
 
             // Get the directory path from the full file path
             string directoryPath = Path.GetDirectoryName(fullPath);
@@ -139,10 +131,8 @@ public virtual async Task WriteFile(string pathOrFilename, string content, Cance
         /// </summary>
         /// <param name="pathOrFilename">The path or filename of the file to write.</param>
         /// <param name="content">The string to write to the file.</param>
-        /// <param name="saveSlotIndex">The save slot index to use. Passing in anything below 0 will not
-        /// use a slot, which can be good for things like settings files or for projects that don't use save slots.</param>
-        public virtual async Task WriteFile(string pathOrFilename, string content, int saveSlotIndex = -1)
-            => await WriteFile(pathOrFilename, content, CancellationToken.None, saveSlotIndex);
+        public virtual async Task WriteFile(string pathOrFilename, string content)
+            => await WriteFile(pathOrFilename, content, CancellationToken.None);
 
         /// <summary>
         /// Returns the contents of a file at the given path or filename.
@@ -153,28 +143,26 @@ public virtual async Task WriteFile(string pathOrFilename, string content, int s
         /// </summary>
         /// <param name="pathOrFilename">The path or filename of the file to read.</param>
         /// <param name="cancellationToken">The cancellation token should be the same one from the calling MonoBehaviour.</param>
-        /// <param name="saveSlotIndex">The save slot index to use. Passing in anything below 0 will not
-        /// use a slot, which can be good for things like settings files or for projects that don't use save slots.</param>
-        public virtual async Task<string> ReadFile(string pathOrFilename, CancellationToken cancellationToken, int saveSlotIndex = -1)
+        public virtual async Task<string> ReadFile(string pathOrFilename, CancellationToken cancellationToken)
         {
             try
             {
-                string fullPath = GetFullPath(pathOrFilename, saveSlotIndex);
+                string fullPath = GetFullPath(pathOrFilename);
 
                 // If the file does not exist, return an empty string and log a warning.
-                if (!Exists(pathOrFilename, saveSlotIndex))
+                if (!Exists(pathOrFilename))
                 {
                     Debug.LogWarning($"FileHandler: File does not exist at path \"{fullPath}\". This may be expected if the file has not been created yet.");
                     return string.Empty;
                 }
 
-                string fileContent = await File.ReadAllTextAsync(GetFullPath(pathOrFilename, saveSlotIndex), cancellationToken).ConfigureAwait(false);
+                string fileContent = await File.ReadAllTextAsync(GetFullPath(pathOrFilename), cancellationToken).ConfigureAwait(false);
 
                 // If the file is empty, return an empty string and log a warning.
                 if (string.IsNullOrEmpty(fileContent))
                 {
-                    if (saveSlotIndex > -1)
-                        Debug.LogWarning($"FileHandler: The file \"{pathOrFilename}\" in slot index {saveSlotIndex} was empty. This may be expected if the file has been erased.");
+                    if (SaveManager.SaveSlotIndex > -1)
+                        Debug.LogWarning($"FileHandler: The file \"{pathOrFilename}\" in slot index {SaveManager.SaveSlotIndex} was empty. This may be expected if the file has been erased.");
                     else
                         Debug.LogWarning($"FileHandler: The file \"{pathOrFilename}\" was empty. This may be expected if the file has been erased.");
 
@@ -203,10 +191,8 @@ public virtual async Task<string> ReadFile(string pathOrFilename, CancellationTo
         /// </code>
         /// </summary>
         /// <param name="pathOrFilename">The path or filename of the file to read.</param>
-        /// <param name="saveSlotIndex">The save slot index to use. Passing in anything below 0 will not
-        /// use a slot, which can be good for things like settings files or for projects that don't use save slots.</param>
-        public virtual async Task<string> ReadFile(string pathOrFilename, int saveSlotIndex = -1)
-            => await ReadFile(pathOrFilename, CancellationToken.None, saveSlotIndex);
+        public virtual async Task<string> ReadFile(string pathOrFilename)
+            => await ReadFile(pathOrFilename, CancellationToken.None);
 
         /// <summary>
         /// Erases a file at the given path or filename. The file will still exist on disk, but it will be empty.
@@ -218,10 +204,8 @@ public virtual async Task<string> ReadFile(string pathOrFilename, int saveSlotIn
         /// </summary>
         /// <param name="pathOrFilename">The path or filename of the file to erase.</param>
         /// <param name="cancellationToken">The cancellation token should be the same one from the calling MonoBehaviour.</param>
-        /// <param name="saveSlotIndex">The save slot index to use. Passing in anything below 0 will not
-        /// use a slot, which can be good for things like settings files or for projects that don't use save slots.</param>
-        public virtual async Task Erase(string pathOrFilename, CancellationToken cancellationToken, int saveSlotIndex = -1)
-            => await WriteFile(pathOrFilename, string.Empty, cancellationToken, saveSlotIndex);
+        public virtual async Task Erase(string pathOrFilename, CancellationToken cancellationToken)
+            => await WriteFile(pathOrFilename, string.Empty, cancellationToken);
 
         /// <summary>
         /// Erases a file at the given path or filename. The file will still exist on disk, but it will be empty.
@@ -232,10 +216,8 @@ public virtual async Task Erase(string pathOrFilename, CancellationToken cancell
         /// </code>
         /// </summary>
         /// <param name="pathOrFilename">The path or filename of the file to erase.</param>
-        /// <param name="saveSlotIndex">The save slot index to use. Passing in anything below 0 will not
-        /// use a slot, which can be good for things like settings files or for projects that don't use save slots.</param>
-        public virtual async Task Erase(string pathOrFilename, int saveSlotIndex = -1)
-            => await Erase(pathOrFilename, CancellationToken.None, saveSlotIndex);
+        public virtual async Task Erase(string pathOrFilename)
+            => await Erase(pathOrFilename, CancellationToken.None);
 
         /// <summary>
         /// Deletes a file at the given path or filename. This will remove the file from disk.
@@ -247,11 +229,9 @@ public virtual async Task Erase(string pathOrFilename, int saveSlotIndex = -1)
         /// </summary>
         /// <param name="pathOrFilename">The path or filename of the file to delete.</param>
         /// <param name="cancellationToken">The cancellation token should be the same one from the calling MonoBehaviour.</param>
-        /// <param name="saveSlotIndex">The save slot index to use. Passing in anything below 0 will not
-        /// use a slot, which can be good for things like settings files or for projects that don't use save slots.</param>
-        public virtual async Task Delete(string pathOrFilename, CancellationToken cancellationToken, int saveSlotIndex = -1)
+        public virtual async Task Delete(string pathOrFilename, CancellationToken cancellationToken)
         {
-            string fullPath = GetFullPath(pathOrFilename, saveSlotIndex);
+            string fullPath = GetFullPath(pathOrFilename);
             if (File.Exists(fullPath))
                 await Task.Run(() => File.Delete(fullPath), cancellationToken).ConfigureAwait(false);
         }
@@ -265,9 +245,7 @@ public virtual async Task Delete(string pathOrFilename, CancellationToken cancel
         /// </code>
         /// </summary>
         /// <param name="pathOrFilename">The path or filename of the file to delete.</param>
-        /// <param name="saveSlotIndex">The save slot index to use. Passing in anything below 0 will not
-        /// use a slot, which can be good for things like settings files or for projects that don't use save slots.</param>
-        public virtual async Task Delete(string pathOrFilename, int saveSlotIndex = -1)
-            => await Delete(pathOrFilename, CancellationToken.None, saveSlotIndex);
+        public virtual async Task Delete(string pathOrFilename)
+            => await Delete(pathOrFilename, CancellationToken.None);
     }
 }