isaacscript-common 6.6.1-dev.2 → 6.6.1

package/features/saveDataManager/exports.js

@@ -1,183 +0,0 @@
-import { SerializationType } from "../../enums/SerializationType";
-import { errorIfFeaturesNotInitialized } from "../../featuresInitialized";
-import { deepCopy } from "../../functions/deepCopy";
-import { isString } from "../../functions/types";
-import { forceSaveDataManagerLoad, forceSaveDataManagerSave, restoreDefaultSaveData, } from "./main";
-import { saveDataConditionalFuncMap, saveDataDefaultsMap, saveDataMap, } from "./maps";
-import { SAVE_DATA_MANAGER_FEATURE_NAME } from "./saveDataManagerConstants";
-/**
- * This is the entry point to the save data manager, a system which provides two major features:
- *
- * 1. automatic resetting of variables on a new run, on a new level, or on a new room (as desired)
- * 2. automatic saving and loading of all tracked data to the "save#.dat" file
- *
- * You feed this function with an anonymous object containing your variables, and then it will
- * automatically manage them for you. (See below for an example.)
- *
- * The save data manager is meant to be called once for each feature of your mod. In other words,
- * you should not put all of the data for your mod on the same object. Instead, scope your variables
- * locally to a single file that contains a mod feature, and then call this function to register
- * them. For example:
- *
- * ```ts
- * // in file: feature1.ts
- * import { saveDataManager } from "isaacscript-common";
- *
- * // Declare local variables for this file or feature.
- * const v = {
- *   // These variables are never reset; manage them yourself at will.
- *   persistent: {
- *     foo1: 0,
- *   },
- *
- *   // These variables are reset at the beginning of every run.
- *   run: {
- *     foo2: 0,
- *   },
- *
- *   // These variables are reset at the beginning of every level.
- *   level: {
- *     foo3: 0,
- *   },
- *
- *   // These variables are reset at the beginning of every room.
- *   room: {
- *     foo4: 0,
- *   },
- * };
- * // Every child object is optional; only create the ones that you need.
- *
- * // Register the variables with the save data manager. (We need to provide a string key that
- * // matches the name of this file.)
- * function feature1Init() {
- *   saveDataManager("feature1", v);
- * }
- *
- * // Elsewhere in the file, use your variables.
- * function feature1Function() {
- *   if (v.run.foo1 > 0) {
- *     // Insert code here.
- *   }
- * }
- * ```
- *
- * - Save data is loaded from disk in the `POST_PLAYER_INIT` callback (i.e. the first callback that
- *   can possibly run).
- * - Save data is recorded to disk in the `PRE_GAME_EXIT` callback.
- *
- * Note that before using the save data manager, you must call the `upgradeMod` function. (Upgrade
- * your mod before registering any of your own callbacks so that the save data manager will run
- * before any of your code does.)
- *
- * If you want the save data manager to load data before the `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 the second argument to `() => false`.
- *
- * @param key The name of the file or feature that is submitting data to be managed by the save data
- *            manager. The save data manager will throw an error if the key is already registered.
- * @param v An object that corresponds to the `SaveData` interface. The object is conventionally
- *          called "v" for brevity. ("v" is short for "local variables").
- * @param conditionalFunc An optional function to run upon saving this key to disk. For example,
- *                        this allows features to only save data to disk if the feature is enabled.
- *                        Specify a value of `() => false` to completely disable saving this feature
- *                        to disk. Disabling saving to disk is useful if you are using data that is
- *                        not serializable. Alternatively, it could be useful if you want to use the
- *                        save data manager to automatically reset variables on run/level/room, but
- *                        not clutter the the "save#.dat" file with unnecessary keys.
- */
-export function saveDataManager(key, v, conditionalFunc) {
-    errorIfFeaturesNotInitialized(SAVE_DATA_MANAGER_FEATURE_NAME);
-    if (!isString(key)) {
-        error(`The ${SAVE_DATA_MANAGER_FEATURE_NAME} requires that keys are strings. You tried to use a key of type: ${typeof key}`);
-    }
-    if (saveDataMap.has(key)) {
-        error(`The ${SAVE_DATA_MANAGER_FEATURE_NAME} is already managing save data for a key of: ${key}`);
-    }
-    // Add the new save data to the map.
-    saveDataMap.set(key, v);
-    // If the only key in the save data is "room", then we don't have to worry about saving this data
-    // to disk (because the room would be reloaded upon resuming a continued run).
-    const saveDataKeys = Object.keys(v);
-    if (saveDataKeys.length === 1 && saveDataKeys[0] === "room") {
-        conditionalFunc = () => false;
-    }
-    // Make a copy of the initial save data so that we can use it to restore the default values later
-    // on.
-    const saveDataTable = v;
-    const saveDataCopy = deepCopy(saveDataTable, SerializationType.NONE, key);
-    saveDataDefaultsMap.set(key, saveDataCopy);
-    // Store the conditional function for later, if present.
-    if (conditionalFunc !== undefined) {
-        saveDataConditionalFuncMap.set(key, conditionalFunc);
-    }
-}
-/**
- * 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.
- *
- * Obviously, doing this will overwrite the current data, so using this function can potentially
- * result in lost state.
- */
-export function saveDataManagerLoad() {
-    errorIfFeaturesNotInitialized(SAVE_DATA_MANAGER_FEATURE_NAME);
-    forceSaveDataManagerLoad();
-}
-/**
- * The save data manager will automatically save variables to disk at the appropriate times (i.e.
- * when the run is exited). Use this function to explicitly force the save data manager to write all
- * of its variables to disk immediately.
- */
-export function saveDataManagerSave() {
-    errorIfFeaturesNotInitialized(SAVE_DATA_MANAGER_FEATURE_NAME);
-    forceSaveDataManagerSave();
-}
-/**
- * - 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.
- *
- * This can make debugging easier, as you can access the variables from the game's debug console.
- * e.g. `l print(g.feature1.foo)`
- */
-export function saveDataManagerSetGlobal() {
-    errorIfFeaturesNotInitialized(SAVE_DATA_MANAGER_FEATURE_NAME);
-    g = saveDataMap; // eslint-disable-line @typescript-eslint/no-unused-vars
-    gd = saveDataDefaultsMap; // eslint-disable-line @typescript-eslint/no-unused-vars
-}
-/**
- * The save data manager will automatically reset variables at the appropriate times (i.e. when a
- * player enters a new room). Use this function to explicitly force the save data manager to reset a
- * specific variable group.
- *
- * For example:
- *
- * ```ts
- * const v = {
- *   room: {
- *     foo: 123,
- *   },
- * };
- *
- * saveDataManager("file1", v);
- *
- * // Then, later on, to explicit reset all of the "room" variables:
- * saveDataManagerReset("file1", "room");
- * ```
- */
-export function saveDataManagerReset(key, childObjectKey) {
-    errorIfFeaturesNotInitialized(SAVE_DATA_MANAGER_FEATURE_NAME);
-    if (!isString(key)) {
-        error(`The ${SAVE_DATA_MANAGER_FEATURE_NAME} requires that keys are strings. You tried to use a key of type: ${typeof key}`);
-    }
-    const saveData = saveDataMap.get(key);
-    if (saveData === undefined) {
-        error(`The ${SAVE_DATA_MANAGER_FEATURE_NAME} is not managing save data for a key of: ${key}`);
-    }
-    restoreDefaultSaveData(key, saveData, childObjectKey);
-}
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZXhwb3J0cy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uL3BhY2thZ2VzL2lzYWFjc2NyaXB0LWNvbW1vbi9zcmMvZmVhdHVyZXMvc2F2ZURhdGFNYW5hZ2VyL2V4cG9ydHMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQ0EsT0FBTyxFQUFFLGlCQUFpQixFQUFFLE1BQU0sK0JBQStCLENBQUM7QUFDbEUsT0FBTyxFQUFFLDZCQUE2QixFQUFFLE1BQU0sMkJBQTJCLENBQUM7QUFDMUUsT0FBTyxFQUFFLFFBQVEsRUFBRSxNQUFNLDBCQUEwQixDQUFDO0FBQ3BELE9BQU8sRUFBRSxRQUFRLEVBQUUsTUFBTSx1QkFBdUIsQ0FBQztBQUVqRCxPQUFPLEVBQ0wsd0JBQXdCLEVBQ3hCLHdCQUF3QixFQUN4QixzQkFBc0IsR0FDdkIsTUFBTSxRQUFRLENBQUM7QUFDaEIsT0FBTyxFQUNMLDBCQUEwQixFQUMxQixtQkFBbUIsRUFDbkIsV0FBVyxHQUNaLE1BQU0sUUFBUSxDQUFDO0FBQ2hCLE9BQU8sRUFBRSw4QkFBOEIsRUFBRSxNQUFNLDRCQUE0QixDQUFDO0FBRTVFOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7R0FvRkc7QUFDSCxNQUFNLFVBQVUsZUFBZSxDQUM3QixHQUFXLEVBQ1gsQ0FBVyxFQUNYLGVBQStCO0lBRS9CLDZCQUE2QixDQUFDLDhCQUE4QixDQUFDLENBQUM7SUFFOUQsSUFBSSxDQUFDLFFBQVEsQ0FBQyxHQUFHLENBQUMsRUFBRTtRQUNsQixLQUFLLENBQ0gsT0FBTyw4QkFBOEIsb0VBQW9FLE9BQU8sR0FBRyxFQUFFLENBQ3RILENBQUM7S0FDSDtJQUVELElBQUksV0FBVyxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsRUFBRTtRQUN4QixLQUFLLENBQ0gsT0FBTyw4QkFBOEIsZ0RBQWdELEdBQUcsRUFBRSxDQUMzRixDQUFDO0tBQ0g7SUFFRCxvQ0FBb0M7SUFDcEMsV0FBVyxDQUFDLEdBQUcsQ0FBQyxHQUFHLEVBQUUsQ0FBQyxDQUFDLENBQUM7SUFFeEIsaUdBQWlHO0lBQ2pHLDhFQUE4RTtJQUM5RSxNQUFNLFlBQVksR0FBRyxNQUFNLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBQ3BDLElBQUksWUFBWSxDQUFDLE1BQU0sS0FBSyxDQUFDLElBQUksWUFBWSxDQUFDLENBQUMsQ0FBQyxLQUFLLE1BQU0sRUFBRTtRQUMzRCxlQUFlLEdBQUcsR0FBRyxFQUFFLENBQUMsS0FBSyxDQUFDO0tBQy9CO0lBRUQsaUdBQWlHO0lBQ2pHLE1BQU07SUFDTixNQUFNLGFBQWEsR0FBRyxDQUFpQyxDQUFDO0lBQ3hELE1BQU0sWUFBWSxHQUFHLFFBQVEsQ0FDM0IsYUFBYSxFQUNiLGlCQUFpQixDQUFDLElBQUksRUFDdEIsR0FBRyxDQUNRLENBQUM7SUFDZCxtQkFBbUIsQ0FBQyxHQUFHLENBQUMsR0FBRyxFQUFFLFlBQVksQ0FBQyxDQUFDO0lBRTNDLHdEQUF3RDtJQUN4RCxJQUFJLGVBQWUsS0FBSyxTQUFTLEVBQUU7UUFDakMsMEJBQTBCLENBQUMsR0FBRyxDQUFDLEdBQUcsRUFBRSxlQUFlLENBQUMsQ0FBQztLQUN0RDtBQUNILENBQUM7QUFFRDs7Ozs7OztHQU9HO0FBQ0gsTUFBTSxVQUFVLG1CQUFtQjtJQUNqQyw2QkFBNkIsQ0FBQyw4QkFBOEIsQ0FBQyxDQUFDO0lBQzlELHdCQUF3QixFQUFFLENBQUM7QUFDN0IsQ0FBQztBQUVEOzs7O0dBSUc7QUFDSCxNQUFNLFVBQVUsbUJBQW1CO0lBQ2pDLDZCQUE2QixDQUFDLDhCQUE4QixDQUFDLENBQUM7SUFDOUQsd0JBQXdCLEVBQUUsQ0FBQztBQUM3QixDQUFDO0FBS0Q7Ozs7OztHQU1HO0FBQ0gsTUFBTSxVQUFVLHdCQUF3QjtJQUN0Qyw2QkFBNkIsQ0FBQyw4QkFBOEIsQ0FBQyxDQUFDO0lBRTlELENBQUMsR0FBRyxXQUFXLENBQUMsQ0FBQyx3REFBd0Q7SUFDekUsRUFBRSxHQUFHLG1CQUFtQixDQUFDLENBQUMsd0RBQXdEO0FBQ3BGLENBQUM7QUFFRDs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQW1CRztBQUNILE1BQU0sVUFBVSxvQkFBb0IsQ0FDbEMsR0FBVyxFQUNYLGNBQXNCO0lBRXRCLDZCQUE2QixDQUFDLDhCQUE4QixDQUFDLENBQUM7SUFFOUQsSUFBSSxDQUFDLFFBQVEsQ0FBQyxHQUFHLENBQUMsRUFBRTtRQUNsQixLQUFLLENBQ0gsT0FBTyw4QkFBOEIsb0VBQW9FLE9BQU8sR0FBRyxFQUFFLENBQ3RILENBQUM7S0FDSDtJQUVELE1BQU0sUUFBUSxHQUFHLFdBQVcsQ0FBQyxHQUFHLENBQUMsR0FBRyxDQUF3QyxDQUFDO0lBQzdFLElBQUksUUFBUSxLQUFLLFNBQVMsRUFBRTtRQUMxQixLQUFLLENBQ0gsT0FBTyw4QkFBOEIsNENBQTRDLEdBQUcsRUFBRSxDQUN2RixDQUFDO0tBQ0g7SUFFRCxzQkFBc0IsQ0FBQyxHQUFHLEVBQUUsUUFBUSxFQUFFLGNBQTZCLENBQUMsQ0FBQztBQUN2RSxDQUFDIn0=

package/features/saveDataManager/exports.lua

@@ -1,185 +0,0 @@
-local ____lualib = require("lualib_bundle")
-local Map = ____lualib.Map
-local __TS__TypeOf = ____lualib.__TS__TypeOf
-local __TS__ObjectKeys = ____lualib.__TS__ObjectKeys
-local ____exports = {}
-local ____SerializationType = require("enums.SerializationType")
-local SerializationType = ____SerializationType.SerializationType
-local ____featuresInitialized = require("featuresInitialized")
-local errorIfFeaturesNotInitialized = ____featuresInitialized.errorIfFeaturesNotInitialized
-local ____deepCopy = require("functions.deepCopy")
-local deepCopy = ____deepCopy.deepCopy
-local ____types = require("functions.types")
-local isString = ____types.isString
-local ____main = require("features.saveDataManager.main")
-local forceSaveDataManagerLoad = ____main.forceSaveDataManagerLoad
-local forceSaveDataManagerSave = ____main.forceSaveDataManagerSave
-local restoreDefaultSaveData = ____main.restoreDefaultSaveData
-local ____maps = require("features.saveDataManager.maps")
-local saveDataConditionalFuncMap = ____maps.saveDataConditionalFuncMap
-local saveDataDefaultsMap = ____maps.saveDataDefaultsMap
-local saveDataMap = ____maps.saveDataMap
-local ____saveDataManagerConstants = require("features.saveDataManager.saveDataManagerConstants")
-local SAVE_DATA_MANAGER_FEATURE_NAME = ____saveDataManagerConstants.SAVE_DATA_MANAGER_FEATURE_NAME
---- This is the entry point to the save data manager, a system which provides two major features:
--- 
--- 1. automatic resetting of variables on a new run, on a new level, or on a new room (as desired)
--- 2. automatic saving and loading of all tracked data to the "save#.dat" file
--- 
--- You feed this function with an anonymous object containing your variables, and then it will
--- automatically manage them for you. (See below for an example.)
--- 
--- The save data manager is meant to be called once for each feature of your mod. In other words,
--- you should not put all of the data for your mod on the same object. Instead, scope your variables
--- locally to a single file that contains a mod feature, and then call this function to register
--- them. For example:
--- 
--- ```ts
--- // in file: feature1.ts
--- import { saveDataManager } from "isaacscript-common";
--- 
--- // Declare local variables for this file or feature.
--- const v = {
---   // These variables are never reset; manage them yourself at will.
---   persistent: {
---     foo1: 0,
---   },
--- 
---   // These variables are reset at the beginning of every run.
---   run: {
---     foo2: 0,
---   },
--- 
---   // These variables are reset at the beginning of every level.
---   level: {
---     foo3: 0,
---   },
--- 
---   // These variables are reset at the beginning of every room.
---   room: {
---     foo4: 0,
---   },
--- };
--- // Every child object is optional; only create the ones that you need.
--- 
--- // Register the variables with the save data manager. (We need to provide a string key that
--- // matches the name of this file.)
--- function feature1Init() {
---   saveDataManager("feature1", v);
--- }
--- 
--- // Elsewhere in the file, use your variables.
--- function feature1Function() {
---   if (v.run.foo1 > 0) {
---     // Insert code here.
---   }
--- }
--- ```
--- 
--- - Save data is loaded from disk in the `POST_PLAYER_INIT` callback (i.e. the first callback that
---   can possibly run).
--- - Save data is recorded to disk in the `PRE_GAME_EXIT` callback.
--- 
--- Note that before using the save data manager, you must call the `upgradeMod` function. (Upgrade
--- your mod before registering any of your own callbacks so that the save data manager will run
--- before any of your code does.)
--- 
--- If you want the save data manager to load data before the `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 the second argument to `() => false`.
--- 
--- @param key The name of the file or feature that is submitting data to be managed by the save data
--- manager. The save data manager will throw an error if the key is already registered.
--- @param v An object that corresponds to the `SaveData` interface. The object is conventionally
--- called "v" for brevity. ("v" is short for "local variables").
--- @param conditionalFunc An optional function to run upon saving this key to disk. For example,
--- this allows features to only save data to disk if the feature is enabled.
--- Specify a value of `() => false` to completely disable saving this feature
--- to disk. Disabling saving to disk is useful if you are using data that is
--- not serializable. Alternatively, it could be useful if you want to use the
--- save data manager to automatically reset variables on run/level/room, but
--- not clutter the the "save#.dat" file with unnecessary keys.
-function ____exports.saveDataManager(self, key, v, conditionalFunc)
-    errorIfFeaturesNotInitialized(nil, SAVE_DATA_MANAGER_FEATURE_NAME)
-    if not isString(nil, key) then
-        error((("The " .. SAVE_DATA_MANAGER_FEATURE_NAME) .. " requires that keys are strings. You tried to use a key of type: ") .. __TS__TypeOf(key))
-    end
-    if saveDataMap[key] ~= nil then
-        error((("The " .. SAVE_DATA_MANAGER_FEATURE_NAME) .. " is already managing save data for a key of: ") .. key)
-    end
-    saveDataMap[key] = v
-    local saveDataKeys = __TS__ObjectKeys(v)
-    if #saveDataKeys == 1 and saveDataKeys[1] == "room" then
-        conditionalFunc = function() return false end
-    end
-    local saveDataTable = v
-    local saveDataCopy = deepCopy(nil, saveDataTable, SerializationType.NONE, key)
-    saveDataDefaultsMap[key] = saveDataCopy
-    if conditionalFunc ~= nil then
-        saveDataConditionalFuncMap:set(key, conditionalFunc)
-    end
-end
---- 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.
--- 
--- Obviously, doing this will overwrite the current data, so using this function can potentially
--- result in lost state.
-function ____exports.saveDataManagerLoad(self)
-    errorIfFeaturesNotInitialized(nil, SAVE_DATA_MANAGER_FEATURE_NAME)
-    forceSaveDataManagerLoad(nil)
-end
---- The save data manager will automatically save variables to disk at the appropriate times (i.e.
--- when the run is exited). Use this function to explicitly force the save data manager to write all
--- of its variables to disk immediately.
-function ____exports.saveDataManagerSave(self)
-    errorIfFeaturesNotInitialized(nil, SAVE_DATA_MANAGER_FEATURE_NAME)
-    forceSaveDataManagerSave(nil)
-end
---- - 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.
--- 
--- This can make debugging easier, as you can access the variables from the game's debug console.
--- e.g. `l print(g.feature1.foo)`
-function ____exports.saveDataManagerSetGlobal(self)
-    errorIfFeaturesNotInitialized(nil, SAVE_DATA_MANAGER_FEATURE_NAME)
-    g = saveDataMap
-    gd = saveDataDefaultsMap
-end
---- The save data manager will automatically reset variables at the appropriate times (i.e. when a
--- player enters a new room). Use this function to explicitly force the save data manager to reset a
--- specific variable group.
--- 
--- For example:
--- 
--- ```ts
--- const v = {
---   room: {
---     foo: 123,
---   },
--- };
--- 
--- saveDataManager("file1", v);
--- 
--- // Then, later on, to explicit reset all of the "room" variables:
--- saveDataManagerReset("file1", "room");
--- ```
-function ____exports.saveDataManagerReset(self, key, childObjectKey)
-    errorIfFeaturesNotInitialized(nil, SAVE_DATA_MANAGER_FEATURE_NAME)
-    if not isString(nil, key) then
-        error((("The " .. SAVE_DATA_MANAGER_FEATURE_NAME) .. " requires that keys are strings. You tried to use a key of type: ") .. __TS__TypeOf(key))
-    end
-    local saveData = saveDataMap[key]
-    if saveData == nil then
-        error((("The " .. SAVE_DATA_MANAGER_FEATURE_NAME) .. " is not managing save data for a key of: ") .. key)
-    end
-    restoreDefaultSaveData(nil, key, saveData, childObjectKey)
-end
-return ____exports
-
---# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uL3BhY2thZ2VzL2lzYWFjc2NyaXB0LWNvbW1vbi9zcmMvZmVhdHVyZXMvc2F2ZURhdGFNYW5hZ2VyL2V4cG9ydHMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFDQSw4QkFBa0M7QUFBekI7QUFDVCxnQ0FBOEM7QUFBckM7QUFDVCxxQkFBeUI7QUFBaEI7QUFDVCxrQkFBeUI7QUFBaEI7QUFFVCxpQkFJTztBQUhMO0FBQ0E7QUFDQTtBQUVGLGlCQUlPO0FBSEw7QUFDQTtBQUNBO0FBRUYscUNBQStDO0FBQXRDOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUF1RlQsMkNBQ0UsS0FDQSxHQUNBO0lBRUEsbUNBQThCO1dBRXpCLGNBQVM7UUFDWixRQUNFLFVBQU8sbUNBQThCLHdFQUFvRSxhQUFPOztPQUloSCxZQUFnQjtRQUNsQixRQUNFLFVBQU8sbUNBQThCLG9EQUFnRDs7QUFLekYsZ0JBQWdCLE9BQUs7QUFJZix5QkFBZSxpQkFBWTtPQUM3QixpQkFBd0IsTUFBSyxhQUFhLE1BQU87QUFDbkQsMEJBQWtCLFdBQU0sWUFBTjs7QUFLZCwwQkFBZ0I7QUFDaEIseUJBQWUsY0FDbkIsZUFDQSx3QkFDQTtBQUVGLHdCQUF3QixPQUFLO09BR3pCO1FBQ0YsMkJBQTJCLElBQUksS0FBSzs7QUF6Q3hDOzs7Ozs7O0FBcURBO0lBQ0UsbUNBQThCO0lBQzlCO0FBRkY7Ozs7QUFVQTtJQUNFLG1DQUE4QjtJQUM5QjtBQUZGOzs7Ozs7QUFlQTtJQUNFLG1DQUE4QjtBQUU5QixRQUFJO0FBQ0osU0FBSztBQUpQOzs7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBMkJBLGdEQUNFLEtBQ0E7SUFFQSxtQ0FBOEI7V0FFekIsY0FBUztRQUNaLFFBQ0UsVUFBTyxtQ0FBOEIsd0VBQW9FLGFBQU87O0FBSTlHLHFCQUFXLFlBQWdCO09BQzdCO1FBQ0YsUUFDRSxVQUFPLG1DQUE4QixnREFBNEM7O0lBSXJGLDRCQUF1QixLQUFLLFVBQVU7QUFuQnhDIiwiZmlsZSI6ImV4cG9ydHMubHVhIiwic291cmNlUm9vdCI6IiJ9

package/features/saveDataManager/load.d.ts

@@ -1,4 +0,0 @@
-/// <reference types="isaac-typescript-definitions" />
-/// <reference types="typescript-to-lua/language-extensions" />
-import { SaveData } from "../../interfaces/SaveData";
-export declare function loadFromDisk(mod: Mod, oldSaveData: LuaTable<string, SaveData>): void;

package/features/saveDataManager/load.js

@@ -1,69 +0,0 @@
-import { jsonDecode } from "../../functions/jsonHelpers";
-import { log, logError } from "../../functions/log";
-import { iterateTableInOrder } from "../../functions/table";
-import { isString, isTable } from "../../functions/types";
-import { merge } from "./merge";
-import { SAVE_DATA_MANAGER_DEBUG, SAVE_DATA_MANAGER_FEATURE_NAME, } from "./saveDataManagerConstants";
-const DEFAULT_MOD_DATA = "{}";
-export function loadFromDisk(mod, oldSaveData) {
-    if (!mod.HasData()) {
-        // There is no "save#.dat" file for this save slot.
-        return;
-    }
-    // First, read the "save#.dat" file into a Lua table.
-    const jsonString = readSaveDatFile(mod);
-    const newSaveData = jsonDecode(jsonString);
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-    if (SAVE_DATA_MANAGER_DEBUG) {
-        log('Converted data from the "save#.dat" to a Lua table.');
-    }
-    // Second, iterate over all the fields of the new table.)
-    iterateTableInOrder(newSaveData, (key, value) => {
-        // All elements of loaded save data should have keys that are strings equal to the name of the
-        // subscriber/feature. Ignore elements with other types of keys.
-        if (!isString(key)) {
-            return;
-        }
-        // All elements of loaded save data should be tables that contain fields corresponding to the
-        // SaveData interface. Ignore elements that are not tables.
-        if (!isTable(value)) {
-            return;
-        }
-        // Ignore elements that represent subscriptions that no longer exist in the current save data.
-        const oldSaveDataForSubscriber = oldSaveData.get(key);
-        // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-        if (oldSaveDataForSubscriber === undefined) {
-            return;
-        }
-        // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-        if (SAVE_DATA_MANAGER_DEBUG) {
-            log(`Merging in stored data for feature: ${key}`);
-        }
-        // We do not want to blow away the child tables of the existing map, because save data could
-        // contain out-of-date fields. Instead, merge it one field at a time in a recursive way (and
-        // convert Lua tables back to TypeScriptToLua Maps, if necessary).
-        merge(oldSaveDataForSubscriber, value, key);
-    }, SAVE_DATA_MANAGER_DEBUG);
-    log(`The ${SAVE_DATA_MANAGER_FEATURE_NAME} loaded data from the "save#.dat" file.`);
-}
-function readSaveDatFile(mod) {
-    const renderFrameCount = Isaac.GetFrameCount();
-    const [ok, jsonStringOrErrMsg] = pcall(tryLoadModData, mod);
-    if (!ok) {
-        logError(`Failed to read from the "save#.dat" file on render frame ${renderFrameCount}: ${jsonStringOrErrMsg}`);
-        return DEFAULT_MOD_DATA;
-    }
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-    if (jsonStringOrErrMsg === undefined) {
-        return DEFAULT_MOD_DATA;
-    }
-    const jsonStringTrimmed = jsonStringOrErrMsg.trim();
-    if (jsonStringTrimmed === "") {
-        return DEFAULT_MOD_DATA;
-    }
-    return jsonStringTrimmed;
-}
-function tryLoadModData(mod) {
-    return mod.LoadData();
-}
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibG9hZC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uL3BhY2thZ2VzL2lzYWFjc2NyaXB0LWNvbW1vbi9zcmMvZmVhdHVyZXMvc2F2ZURhdGFNYW5hZ2VyL2xvYWQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLFVBQVUsRUFBRSxNQUFNLDZCQUE2QixDQUFDO0FBQ3pELE9BQU8sRUFBRSxHQUFHLEVBQUUsUUFBUSxFQUFFLE1BQU0scUJBQXFCLENBQUM7QUFDcEQsT0FBTyxFQUFFLG1CQUFtQixFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFDNUQsT0FBTyxFQUFFLFFBQVEsRUFBRSxPQUFPLEVBQUUsTUFBTSx1QkFBdUIsQ0FBQztBQUUxRCxPQUFPLEVBQUUsS0FBSyxFQUFFLE1BQU0sU0FBUyxDQUFDO0FBQ2hDLE9BQU8sRUFDTCx1QkFBdUIsRUFDdkIsOEJBQThCLEdBQy9CLE1BQU0sNEJBQTRCLENBQUM7QUFFcEMsTUFBTSxnQkFBZ0IsR0FBRyxJQUFJLENBQUM7QUFFOUIsTUFBTSxVQUFVLFlBQVksQ0FDMUIsR0FBUSxFQUNSLFdBQXVDO0lBRXZDLElBQUksQ0FBQyxHQUFHLENBQUMsT0FBTyxFQUFFLEVBQUU7UUFDbEIsbURBQW1EO1FBQ25ELE9BQU87S0FDUjtJQUVELHFEQUFxRDtJQUNyRCxNQUFNLFVBQVUsR0FBRyxlQUFlLENBQUMsR0FBRyxDQUFDLENBQUM7SUFDeEMsTUFBTSxXQUFXLEdBQUcsVUFBVSxDQUFDLFVBQVUsQ0FBQyxDQUFDO0lBRTNDLHVFQUF1RTtJQUN2RSxJQUFJLHVCQUF1QixFQUFFO1FBQzNCLEdBQUcsQ0FBQyxxREFBcUQsQ0FBQyxDQUFDO0tBQzVEO0lBRUQseURBQXlEO0lBQ3pELG1CQUFtQixDQUNqQixXQUFXLEVBQ1gsQ0FBQyxHQUFHLEVBQUUsS0FBSyxFQUFFLEVBQUU7UUFDYiw4RkFBOEY7UUFDOUYsZ0VBQWdFO1FBQ2hFLElBQUksQ0FBQyxRQUFRLENBQUMsR0FBRyxDQUFDLEVBQUU7WUFDbEIsT0FBTztTQUNSO1FBRUQsNkZBQTZGO1FBQzdGLDJEQUEyRDtRQUMzRCxJQUFJLENBQUMsT0FBTyxDQUFDLEtBQUssQ0FBQyxFQUFFO1lBQ25CLE9BQU87U0FDUjtRQUVELDhGQUE4RjtRQUM5RixNQUFNLHdCQUF3QixHQUFHLFdBQVcsQ0FBQyxHQUFHLENBQUMsR0FBRyxDQUFDLENBQUM7UUFDdEQsdUVBQXVFO1FBQ3ZFLElBQUksd0JBQXdCLEtBQUssU0FBUyxFQUFFO1lBQzFDLE9BQU87U0FDUjtRQUVELHVFQUF1RTtRQUN2RSxJQUFJLHVCQUF1QixFQUFFO1lBQzNCLEdBQUcsQ0FBQyx1Q0FBdUMsR0FBRyxFQUFFLENBQUMsQ0FBQztTQUNuRDtRQUVELDRGQUE0RjtRQUM1Riw0RkFBNEY7UUFDNUYsa0VBQWtFO1FBQ2xFLEtBQUssQ0FBQyx3QkFBb0MsRUFBRSxLQUFLLEVBQUUsR0FBRyxDQUFDLENBQUM7SUFDMUQsQ0FBQyxFQUNELHVCQUF1QixDQUN4QixDQUFDO0lBRUYsR0FBRyxDQUNELE9BQU8sOEJBQThCLHlDQUF5QyxDQUMvRSxDQUFDO0FBQ0osQ0FBQztBQUVELFNBQVMsZUFBZSxDQUFDLEdBQVE7SUFDL0IsTUFBTSxnQkFBZ0IsR0FBRyxLQUFLLENBQUMsYUFBYSxFQUFFLENBQUM7SUFFL0MsTUFBTSxDQUFDLEVBQUUsRUFBRSxrQkFBa0IsQ0FBQyxHQUFHLEtBQUssQ0FBQyxjQUFjLEVBQUUsR0FBRyxDQUFDLENBQUM7SUFDNUQsSUFBSSxDQUFDLEVBQUUsRUFBRTtRQUNQLFFBQVEsQ0FDTiw0REFBNEQsZ0JBQWdCLEtBQUssa0JBQWtCLEVBQUUsQ0FDdEcsQ0FBQztRQUNGLE9BQU8sZ0JBQWdCLENBQUM7S0FDekI7SUFFRCx1RUFBdUU7SUFDdkUsSUFBSSxrQkFBa0IsS0FBSyxTQUFTLEVBQUU7UUFDcEMsT0FBTyxnQkFBZ0IsQ0FBQztLQUN6QjtJQUVELE1BQU0saUJBQWlCLEdBQUcsa0JBQWtCLENBQUMsSUFBSSxFQUFFLENBQUM7SUFDcEQsSUFBSSxpQkFBaUIsS0FBSyxFQUFFLEVBQUU7UUFDNUIsT0FBTyxnQkFBZ0IsQ0FBQztLQUN6QjtJQUVELE9BQU8saUJBQWlCLENBQUM7QUFDM0IsQ0FBQztBQUVELFNBQVMsY0FBYyxDQUFhLEdBQVE7SUFDMUMsT0FBTyxHQUFHLENBQUMsUUFBUSxFQUFFLENBQUM7QUFDeEIsQ0FBQyJ9

package/features/saveDataManager/load.lua

@@ -1,74 +0,0 @@
-local ____lualib = require("lualib_bundle")
-local __TS__StringTrim = ____lualib.__TS__StringTrim
-local ____exports = {}
-local readSaveDatFile, tryLoadModData, DEFAULT_MOD_DATA
-local ____jsonHelpers = require("functions.jsonHelpers")
-local jsonDecode = ____jsonHelpers.jsonDecode
-local ____log = require("functions.log")
-local log = ____log.log
-local logError = ____log.logError
-local ____table = require("functions.table")
-local iterateTableInOrder = ____table.iterateTableInOrder
-local ____types = require("functions.types")
-local isString = ____types.isString
-local isTable = ____types.isTable
-local ____merge = require("features.saveDataManager.merge")
-local merge = ____merge.merge
-local ____saveDataManagerConstants = require("features.saveDataManager.saveDataManagerConstants")
-local SAVE_DATA_MANAGER_DEBUG = ____saveDataManagerConstants.SAVE_DATA_MANAGER_DEBUG
-local SAVE_DATA_MANAGER_FEATURE_NAME = ____saveDataManagerConstants.SAVE_DATA_MANAGER_FEATURE_NAME
-function readSaveDatFile(self, mod)
-    local renderFrameCount = Isaac.GetFrameCount()
-    local ok, jsonStringOrErrMsg = pcall(tryLoadModData, mod)
-    if not ok then
-        logError((("Failed to read from the \"save#.dat\" file on render frame " .. tostring(renderFrameCount)) .. ": ") .. jsonStringOrErrMsg)
-        return DEFAULT_MOD_DATA
-    end
-    if jsonStringOrErrMsg == nil then
-        return DEFAULT_MOD_DATA
-    end
-    local jsonStringTrimmed = __TS__StringTrim(jsonStringOrErrMsg)
-    if jsonStringTrimmed == "" then
-        return DEFAULT_MOD_DATA
-    end
-    return jsonStringTrimmed
-end
-function tryLoadModData(mod)
-    return mod:LoadData()
-end
-DEFAULT_MOD_DATA = "{}"
-function ____exports.loadFromDisk(self, mod, oldSaveData)
-    if not mod:HasData() then
-        return
-    end
-    local jsonString = readSaveDatFile(nil, mod)
-    local newSaveData = jsonDecode(nil, jsonString)
-    if SAVE_DATA_MANAGER_DEBUG then
-        log("Converted data from the \"save#.dat\" to a Lua table.")
-    end
-    iterateTableInOrder(
-        nil,
-        newSaveData,
-        function(____, key, value)
-            if not isString(nil, key) then
-                return
-            end
-            if not isTable(nil, value) then
-                return
-            end
-            local oldSaveDataForSubscriber = oldSaveData[key]
-            if oldSaveDataForSubscriber == nil then
-                return
-            end
-            if SAVE_DATA_MANAGER_DEBUG then
-                log("Merging in stored data for feature: " .. key)
-            end
-            merge(nil, oldSaveDataForSubscriber, value, key)
-        end,
-        SAVE_DATA_MANAGER_DEBUG
-    )
-    log(("The " .. SAVE_DATA_MANAGER_FEATURE_NAME) .. " loaded data from the \"save#.dat\" file.")
-end
-return ____exports
-
---# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uL3BhY2thZ2VzL2lzYWFjc2NyaXB0LWNvbW1vbi9zcmMvZmVhdHVyZXMvc2F2ZURhdGFNYW5hZ2VyL2xvYWQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O01Bd0VTLGlCQXdCQSxnQkFyRkg7QUFYTix3QkFBMkI7QUFBbEI7QUFDVCxnQkFBOEI7QUFBckI7QUFBSztBQUNkLGtCQUFvQztBQUEzQjtBQUNULGtCQUFrQztBQUF6QjtBQUFVO0FBRW5CLGtCQUFzQjtBQUFiO0FBQ1QscUNBR087QUFGTDtBQUNBO0FBZ0VGLFNBQVMsc0JBQWdCO0FBQ2pCLDZCQUFtQjtBQUVRLFVBQTFCLElBQUkscUJBQXNCLE1BQU0sZ0JBQWdCO1dBQ2xEO1FBQ0gsV0FDRSwwRUFBNEQsc0JBQWdCLFNBQUs7QUFFbkYsZUFBTzs7T0FJTDtBQUNGLGVBQU87O0FBR0gsOEJBQW9CO09BQ3RCLHFCQUFzQjtBQUN4QixlQUFPOztBQUdULFdBQU87O0FBR1QsU0FBUyxlQUEyQjtBQUNsQyxXQUFPLElBQUk7O0FBdEZQLG1CQUFtQjtBQUV6Qix3Q0FDRSxLQUNBO1dBRUssSUFBSTtBQUVQOztBQUlJLHVCQUFhLHFCQUFnQjtBQUM3Qix3QkFBYyxnQkFBVztPQUczQjtRQUNGLElBQUk7O0lBSU47O1FBQ0U7UUFDQSxlQUFDLEtBQUs7bUJBR0MsY0FBUztBQUNaOzttQkFLRyxhQUFRO0FBQ1g7O0FBSUksNkNBQTJCLFlBQWdCO2VBRTdDO0FBQ0Y7O2VBSUU7Z0JBQ0YsSUFBSSwwQ0FBdUM7O1lBTTdDLFdBQU0sMEJBQXNDLE9BQU87UUE1QnJEO1FBOEJBOztJQUdGLEtBQ0UsVUFBTyxtQ0FBOEI7QUF2RHpDIiwiZmlsZSI6ImxvYWQubHVhIiwic291cmNlUm9vdCI6IiJ9

package/features/saveDataManager/main.d.ts

@@ -1,3 +0,0 @@
-import { SaveDataKey } from "../../enums/private/SaveDataKey";
-import { SaveData } from "../../interfaces/SaveData";
-export declare function restoreDefaultSaveData(subscriberName: string, saveData: SaveData, saveDataKey: SaveDataKey): void;