isaacscript-common 1.2.7 → 1.2.8

package/dist/features/saveDataManager/exports.d.ts

@@ -50,12 +50,17 @@ import { SaveData } from "../../types/SaveData";
  * }
  * ```
  *
- * - Save data is loaded from disk in the MC_POST_PLAYER_INIT callback
- * (i.e. the first callback that can possibly run).
+ * - Save data is loaded from disk in the MC_POST_PLAYER_INIT callback (i.e. the first callback that
+ * can possibly run).
  * - Save data is recorded to disk in the MC_PRE_GAME_EXIT callback.
  *
  * Note that before using the save data manager, you must call the [[`upgradeMod`]] function.
  *
+ * If you want the save data manager to load data before the MC_POST_PLAYER_INIT callback (i.e. in
+ * the main menu), then you should explicitly call the [[`saveDataManagerLoad`]] function. (The save
+ * data manager cannot do this on its own because it cannot know when your mod features are finished
+ * initializing.)
+ *
  * Finally, some features may have variables that need to be automatically reset per run/level, but
  * not saved to disk on game exit. (For example, if they contain functions or other non-serializable
  * data.) For these cases, set a special key of "dontSave" alongside "run", "level", and so forth.
@@ -65,8 +70,8 @@ import { SaveData } from "../../types/SaveData";
  * @param saveData An object that corresponds to the `SaveData` interface. The object is
  * conventionally called "v" for brevity (which is short for "local variables").
  * @param conditionalFunc An optional function to run upon saving this key to disk. If the function
- * is false, the key will not be written to disk. This allows mod features to avoid cluttering the
- * "save#.dat" file with unnecessary keys.
+ * returns false, the key will not be written to disk. This allows mod features to avoid cluttering
+ * the "save#.dat" file with unnecessary keys.
  */
 export declare function saveDataManager(key: string, saveData: SaveData, conditionalFunc?: () => boolean): void;
 /**
@@ -75,6 +80,14 @@ export declare function saveDataManager(key: string, saveData: SaveData, conditi
  * of its variables to disk immediately.
  */
 export declare function saveDataManagerSave(): void;
+/**
+ * The save data manager will automatically load variables from disk at the appropriate times (i.e.
+ * when a new run is started). Use this function to explicitly force the save data manager to load
+ * all of its variables from disk immediately.
+ *
+ * Note that doing this will overwrite current data, which can potentially result in lost state.
+ */
+export declare function saveDataManagerLoad(): void;
 /**
  * Sets the global variable of "g" equal to all of the save data variables for this mod.
  * Sets the global variable of "gd" equal to all of the save data default variables for this mod.

package/dist/features/saveDataManager/exports.lua

@@ -10,6 +10,7 @@ local deepCopy = ____deepCopy.deepCopy
 local SerializationType = ____deepCopy.SerializationType
 local ____main = require("features.saveDataManager.main")
 local FEATURE_NAME = ____main.FEATURE_NAME
+local forceSaveDataManagerLoad = ____main.forceSaveDataManagerLoad
 local forceSaveDataManagerSave = ____main.forceSaveDataManagerSave
 local isSaveDataManagerInitialized = ____main.isSaveDataManagerInitialized
 local ____maps = require("features.saveDataManager.maps")
@@ -48,6 +49,13 @@ function ____exports.saveDataManagerSave(self)
     end
     forceSaveDataManagerSave(nil)
 end
+function ____exports.saveDataManagerLoad(self)
+    if not isSaveDataManagerInitialized(nil) then
+        local msg = getUpgradeErrorMsg(nil, FEATURE_NAME)
+        error(msg)
+    end
+    forceSaveDataManagerLoad(nil)
+end
 function ____exports.saveDataManagerSetGlobal(self)
     g = saveDataMap
     gd = saveDataDefaultsMap

package/dist/features/saveDataManager/main.lua

@@ -109,4 +109,10 @@ function ____exports.forceSaveDataManagerSave(self)
     end
     saveToDisk(nil, mod, saveDataMap, saveDataConditionalFuncMap)
 end
+function ____exports.forceSaveDataManagerLoad(self)
+    if mod == nil then
+        return
+    end
+    loadFromDisk(nil, mod, saveDataMap)
+end
 return ____exports

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.2.7",
+  "version": "1.2.8",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -26,7 +26,7 @@
   ],
   "devDependencies": {
     "@zamiell/typescript-to-lua": "^1.4.0",
-    "isaac-typescript-definitions": "^1.0.335",
+    "isaac-typescript-definitions": "^1.0.336",
     "isaacscript-lint": "^1.0.79",
     "isaacscript-tsconfig": "^1.1.8",
     "typedoc": "^0.22.11",