Merge pull request #14 from coryleach/dev

Get/Load from StreamingAssets

Author: coryleach

README.md

@@ -1,10 +1,9 @@
-<h1 align="center">Gameframe.SaveLoad 👋</h1>
-<p>
-  <img alt="Version" src="https://img.shields.io/badge/version-1.0.7-blue.svg?cacheSeconds=2592000" />
-  <a href="https://twitter.com/Cory Leach">
-    <img alt="Twitter: coryleach" src="https://img.shields.io/twitter/follow/coryleach.svg?style=social" target="_blank" />
-  </a>
+<p align="center">
+<img align="center" src="https://raw.githubusercontent.com/coryleach/UnityPackages/master/Documentation/GameframeFace.gif" />
 </p>
+<h1 align="center">Gameframe.SaveLoad 👋</h1>
+
+<!-- BADGE-START -<!-- BADGE-END -->
 
 Serialization helper utility that supports save, load and encryption.
 
@@ -13,15 +12,15 @@ Serialization helper utility that supports save, load and encryption.
 #### Using UnityPackageManager (for Unity 2019.3 or later)
 Open the package manager window (menu: Window > Package Manager)<br/>
 Select "Add package from git URL...", fill in the pop-up with the following link:<br/>
-https://github.com/coryleach/UnitySaveLoad.git#1.0.7<br/>
+https://github.com/coryleach/UnitySaveLoad.git#1.0.8<br/>
 
 #### Using UnityPackageManager (for Unity 2019.1 or later)
 
 Find the manifest.json file in the Packages folder of your project and edit it to look like this:
 ```js
 {
   "dependencies": {
-    "com.gameframe.saveload": "https://github.com/coryleach/UnitySaveLoad.git#1.0.7",
+    "com.gameframe.saveload": "https://github.com/coryleach/UnitySaveLoad.git#1.0.8",
     ...
   },
 }
@@ -83,13 +82,13 @@ In player settings add the string 'JSON_DOT_NET' to Scripting Define Symbols.
 
 👤 **Cory Leach**
 
-* Twitter: [@coryleach](https://twitter.com/coryleach)
+* Mastodon: [@coryleach@mastodon.gamedev.place](https://mastodon.gamedev.place/@coryleach)
 * Github: [@coryleach](https://github.com/coryleach)
 
 
 ## Show your support
-
 Give a ⭐️ if this project helped you!
 
+
 ***
 _This README was generated with ❤️ by [Gameframe.Packages](https://github.com/coryleach/unitypackages)_

Runtime/SaveLoadManager.cs

@@ -77,15 +77,34 @@ public void Save(object obj, string filename, string folder = null)
         /// Gets the list of save files that have been created
         /// </summary>
         /// <param name="folder">sub folder</param>
-        /// <param name="extension">include only files with this extension</param>
+        /// <param name="extension"></param>
+        /// <param name="streamingAssets">Will use Application.streamingAssetsPath as base path if true otherwise Application.persistentDataPath</param>
         /// <returns>list of file names (excludes the path)</returns>
-        public string[] GetFiles(string folder = null, string extension = null)
+        public string[] GetFiles(string folder = null, string extension = null, bool streamingAssets = false)
         {
             if (string.IsNullOrEmpty(folder))
             {
                 folder = defaultFolder;
             }
-            return SaveLoadUtility.GetSavedFiles(folder,baseFolder, extension);
+            return SaveLoadUtility.GetSavedFiles(folder,baseFolder, extension, streamingAssets);
+        }
+
+        /// <summary>
+        /// Gets the list of save files that have been created
+        /// </summary>
+        /// <param name="list">list to be populated with file names</param>
+        /// <param name="folder">sub folder</param>
+        /// <param name="extension"></param>
+        /// <param name="streamingAssets">Will use Application.streamingAssetsPath as base path if true otherwise Application.persistentDataPath</param>
+        /// <returns>list of file names (excludes the path)</returns>
+        public void GetFiles(List<string> list, string folder = null, string extension = null, bool streamingAssets = false)
+        {
+            if (string.IsNullOrEmpty(folder))
+            {
+                folder = defaultFolder;
+            }
+
+            SaveLoadUtility.GetSavedFiles(list, folder,baseFolder, extension, streamingAssets);
         }
 
         /// <summary>
@@ -126,11 +145,12 @@ public T Copy<T>(T obj)
         /// </summary>
         /// <param name="filename">Name of file to load from</param>
         /// <param name="folder">Name of folder containing the file</param>
+        /// <param name="streamingAssets">Load file from streaming assets</param>
         /// <typeparam name="T">Type of object to be loaded from file</typeparam>
         /// <returns>Instance of object loaded from file</returns>
-        public T Load<T>(string filename, string folder = null)
+        public T Load<T>(string filename, string folder = null, bool streamingAssets = false)
         {
-            return (T)Load(typeof(T), filename, folder);
+            return (T)Load(typeof(T), filename, folder, streamingAssets);
         }
 
         /// <summary>
@@ -139,15 +159,16 @@ public T Load<T>(string filename, string folder = null)
         /// <param name="type">Type of object to be loaded</param>
         /// <param name="filename">Name of file to load object from</param>
         /// <param name="folder">Name of folder containing the file to be loaded</param>
+        /// <param name="streamingAssets">Load file from streaming assets</param>
         /// <returns>Instance of object to be loaded. Null if file did not exist.</returns>
-        public object Load(Type type, string filename, string folder = null)
+        public object Load(Type type, string filename, string folder = null, bool streamingAssets = false)
         {
             if (string.IsNullOrEmpty(folder))
             {
                 folder = defaultFolder;
             }
             var saveLoadMethod = GetSaveLoadMethod(saveMethod);
-            return SaveLoadUtility.Load(type, saveLoadMethod,filename,folder, baseFolder);
+            return SaveLoadUtility.Load(type, saveLoadMethod,filename,folder, baseFolder, streamingAssets);
         }
 
         /// <summary>

Runtime/SaveLoadUtility.cs

@@ -11,9 +11,9 @@ public static class SaveLoadUtility
         private const string DefaultFolderName = "SaveLoad";
         private const string DefaultBaseFolderPath = "GameData";
 
-        public static string GetSavePath(string folderName = null, string baseFolderPath = null)
+        public static string GetSavePath(string folderName = null, string baseFolderPath = null, bool streamingAssets = false)
         {
-            return GetRuntimeSavePath(folderName, baseFolderPath);
+            return !streamingAssets ? GetRuntimeSavePath(folderName, baseFolderPath) : GetStreamingAssetsSavePath(folderName, baseFolderPath);
         }
 
         public static string GetRuntimeSavePath(string folderName = null, string baseFolderPath = null)
@@ -29,7 +29,24 @@ public static string GetRuntimeSavePath(string folderName = null, string baseFol
             }
 
             var savePath = $"{Application.persistentDataPath}/{baseFolderPath}/";
-            savePath = savePath + folderName + "/";
+            savePath = $"{savePath}{folderName}/";
+            return savePath;
+        }
+
+        public static string GetStreamingAssetsSavePath(string folderName = null, string baseFolderPath = null)
+        {
+            if (string.IsNullOrEmpty(folderName))
+            {
+                folderName = DefaultFolderName;
+            }
+
+            if (string.IsNullOrEmpty(baseFolderPath))
+            {
+                baseFolderPath = DefaultBaseFolderPath;
+            }
+
+            var savePath = $"{Application.streamingAssetsPath}/{baseFolderPath}/";
+            savePath = $"{savePath}{folderName}/";
             return savePath;
         }
 
@@ -77,10 +94,11 @@ public static void Save(object saveObject, ISerializationMethod serializationMet
         /// <param name="filename"></param>
         /// <param name="folderName"></param>
         /// <param name="baseFolderPath"></param>
+        /// <param name="streamingAssets"></param>
         /// <returns></returns>
-        public static object Load(System.Type objectType, ISerializationMethod serializationMethod, string filename, string folderName = null, string baseFolderPath = null)
+        public static object Load(System.Type objectType, ISerializationMethod serializationMethod, string filename, string folderName = null, string baseFolderPath = null, bool streamingAssets = false)
         {
-            var savePath = GetSavePath(folderName, baseFolderPath);
+            var savePath = GetSavePath(folderName, baseFolderPath, streamingAssets);
             var saveFilename = savePath + GetSaveFileName(filename);
 
             object returnObject = null;
@@ -104,11 +122,12 @@ public static object Load(System.Type objectType, ISerializationMethod serializa
         /// </summary>
         /// <param name="folderName">folder containing the save files</param>
         /// <param name="baseFolderPath">base path to the folder</param>
-        /// <param name="extension">include only files with the specified extension</param>
+        /// <param name="extension">include only files with this extension</param>
+        /// <param name="streamingAssets">Will use Application.streamingAssetsPath as base path if true otherwise Application.persistentDataPath</param>
         /// <returns>list of file names</returns>
-        public static IEnumerable<string> EnumerateSavedFiles(string folderName = null, string baseFolderPath = null, string extension = null)
+        public static IEnumerable<string> EnumerateSavedFiles(string folderName = null, string baseFolderPath = null, string extension = null, bool streamingAssets = false)
         {
-            var savePath = GetSavePath(folderName,baseFolderPath);
+            var savePath = GetSavePath(folderName,baseFolderPath,streamingAssets);
 
             //If directory does not exist we're done
             if (!Directory.Exists(savePath))
@@ -126,13 +145,29 @@ public static IEnumerable<string> EnumerateSavedFiles(string folderName = null,
         /// <summary>
         /// Creates an array list of save files in the given folder and path
         /// </summary>
-        /// <param name="folderName">folder containing the save files</param>
-        /// <param name="baseFolderPath">base path to the folder</param>
+        /// <param name="folderName"></param>
+        /// <param name="baseFolderPath"></param>
+        /// <param name="extension">include only files with this extension</param>
+        /// <param name="streamingAssets">Will use Application.streamingAssetsPath as base path if true otherwise Application.persistentDataPath</param>
+        /// <returns>Array of file names</returns>
+        public static string[] GetSavedFiles(string folderName = null, string baseFolderPath = null, string extension = null, bool streamingAssets = false)
+        {
+            return EnumerateSavedFiles(folderName, baseFolderPath, extension, streamingAssets).ToArray();
+        }
+
+        /// <summary>
+        /// Populates a given array with a list of save files in the given folder and path
+        /// </summary>
+        /// <param name="list">list to be populated with file names</param>
+        /// <param name="folderName"></param>
+        /// <param name="baseFolderPath"></param>
         /// <param name="extension">include only files with this extension</param>
+        /// <param name="streamingAssets">Will use Application.streamingAssetsPath as base path if true otherwise Application.persistentDataPath</param>
         /// <returns>Array of file names</returns>
-        public static string[] GetSavedFiles(string folderName = null, string baseFolderPath = null, string extension = null)
+        public static void GetSavedFiles(List<string> list, string folderName = null, string baseFolderPath = null, string extension = null, bool streamingAssets = false)
         {
-            return EnumerateSavedFiles(folderName, baseFolderPath, extension).ToArray();
+            list.Clear();
+            list.AddRange(EnumerateSavedFiles(folderName, baseFolderPath, extension, streamingAssets));
         }
 
         /// <summary>

Tests/Editor/SaveLoadUtilityTests.cs

@@ -83,7 +83,7 @@ public void CanGetFiles()
             SaveLoadUtility.Save(testSave,serializationMethod,filename,folder);
 
             var files = SaveLoadUtility.GetSavedFiles(folder);
-            Assert.IsTrue(files.Length == 1);
+            Assert.IsTrue(files.Length == 1,$"Total Save Files: {files.Length} Expected 1");
 
             //Files should contain a list of names that exactly match the file name used
             //omits the path of the file

package.json

@@ -1,7 +1,7 @@
 {
   "name": "com.gameframe.saveload",
   "displayName": "Gameframe.SaveLoad",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "description": "Serialization helper utility that supports save, load and encryption.",
   "keywords": [],
   "author": {