From 0c36de0c7eeb021a0a8e2d9405e9cbd57b10b4d3 Mon Sep 17 00:00:00 2001
From: Jon Manning <jon@secretlab.com.au>
Date: Wed, 15 Nov 2023 11:08:20 +1100
Subject: [PATCH] Update parameter name and comments for save/load methods

---
 Runtime/DialogueRunner.cs | 45 ++++++++++++++++++++++++++-------------
 1 file changed, 30 insertions(+), 15 deletions(-)

diff --git a/Runtime/DialogueRunner.cs b/Runtime/DialogueRunner.cs
index d5137d9e..a14457bf 100644
--- a/Runtime/DialogueRunner.cs
+++ b/Runtime/DialogueRunner.cs
@@ -1391,21 +1391,28 @@ public bool LoadStateFromPlayerPrefs(string SaveKey = "YarnBasicSave")
         }
 
         /// <summary>
-        /// Loads all variables from the requested file in persistent storage into the Dialogue Runner's variable storage.
+        /// Loads all variables from the requested file in persistent storage
+        /// into the Dialogue Runner's variable storage.
         /// </summary>
         /// <remarks>
         /// <para>
-        /// This method loads the file <paramref name="SaveFile"/> from the persistent data storage and attempts to read it as JSON. This is then deserialised and loaded into the <see cref="VariableStorage"/>.
+        /// This method loads the file <paramref name="saveFileName"/> from the
+        /// persistent data storage and attempts to read it as JSON. This is
+        /// then deserialised and loaded into the <see cref="VariableStorage"/>.
         /// </para>
         /// <para>
-        /// The loaded information can be stored via the <see cref="SaveStateToPersistentStorage"/> method.
+        /// The loaded information can be stored via the <see
+        /// cref="SaveStateToPersistentStorage"/> method.
         /// </para>
         /// </remarks>
-        /// <param name="SaveFile">the name the save file should have on disc, including any file extension</param>
-        /// <returns><see langword="true"/> if the variables were successfully loaded from the player preferences; <see langword="false"/> otherwise.</returns>
-        public bool LoadStateFromPersistentStorage(string SaveFile)
+        /// <param name="saveFileName">the name the save file should have on
+        /// disc, including any file extension</param>
+        /// <returns><see langword="true"/> if the variables were successfully
+        /// loaded from the player preferences; <see langword="false"/>
+        /// otherwise.</returns>
+        public bool LoadStateFromPersistentStorage(string saveFileName)
         {
-            var path = System.IO.Path.Combine(Application.persistentDataPath, SaveFile);
+            var path = System.IO.Path.Combine(Application.persistentDataPath, saveFileName);
 
             try
             {
@@ -1450,23 +1457,31 @@ public void SaveStateToPlayerPrefs(string SaveKey = "YarnBasicSave")
         }
 
         /// <summary>
-        /// Saves all variables from variable storage into the persistent storage.
+        /// Saves all variables from variable storage into the persistent
+        /// storage.
         /// </summary>
         /// <remarks>
         /// <para>
-        /// This method attempts to writes the contents of <see cref="VariableStorage"/> as a JSON file and saves it to the persistent data storage under the file name <paramref name="SaveFile"/>.
-        /// The saved information can be loaded via the <see cref="LoadStateFromPersistentStorage"/> method.
+        /// This method attempts to writes the contents of <see
+        /// cref="VariableStorage"/> as a JSON file and saves it to the
+        /// persistent data storage under the file name <paramref
+        /// name="saveFileName"/>. The saved information can be loaded via the
+        /// <see cref="LoadStateFromPersistentStorage"/> method.
         /// </para>
         /// <para>
-        /// If <paramref name="SaveFile"/> already exists it will be overwritten, not appended.
+        /// If <paramref name="saveFileName"/> already exists, it will be
+        /// overwritten, not appended.
         /// </para>
         /// </remarks>
-        /// <param name="SaveFile">the name the save file should have on disc, including any file extension</param>
-        /// <returns><see langword="true"/> if the variables were successfully written into the player preferences; <see langword="false"/> otherwise.</returns>
-        public bool SaveStateToPersistentStorage(string SaveFile)
+        /// <param name="saveFileName">the name the save file should have on
+        /// disc, including any file extension</param>
+        /// <returns><see langword="true"/> if the variables were successfully
+        /// written into the player preferences; <see langword="false"/>
+        /// otherwise.</returns>
+        public bool SaveStateToPersistentStorage(string saveFileName)
         {
             var data = SerializeAllVariablesToJSON();
-            var path = System.IO.Path.Combine(Application.persistentDataPath, SaveFile);
+            var path = System.IO.Path.Combine(Application.persistentDataPath, saveFileName);
 
             try
             {