isaacscript-common 2.0.28 → 2.0.31

package/dist/callbacks/subscriptions/postPickupCollect.d.ts

@@ -1,5 +1,4 @@
-import { PickupVariant } from "isaac-typescript-definitions";
-export declare type PostPickupCollectRegisterParameters = [
-    callback: (pickup: EntityPickup, player: EntityPlayer) => void,
-    pickupVariant?: PickupVariant
-];
+/// <reference types="isaac-typescript-definitions" />
+export declare type PostPickupCollectRegisterParameters = PickupRegisterParameters<[
+    player: EntityPlayer
+], void>;

package/dist/callbacks/subscriptions/postPickupInitLate.d.ts

@@ -1,5 +1,3 @@
-import { PickupVariant } from "isaac-typescript-definitions";
-export declare type PostPickupInitLateRegisterParameters = [
-    callback: (pickup: EntityPickup) => void,
-    pickupVariant?: PickupVariant
-];
+/// <reference types="isaac-typescript-definitions" />
+export declare type PostPickupInitLateRegisterParameters = PickupRegisterParameters<[
+], void>;

package/dist/callbacks/subscriptions/postPickupStateChanged.d.ts

@@ -1,5 +1,5 @@
-import { PickupVariant } from "isaac-typescript-definitions";
-export declare type PostPickupStateChangedRegisterParameters = [
-    callback: (pickup: EntityPickup, previousState: int, currentState: int) => void,
-    pickupVariant?: PickupVariant
-];
+/// <reference types="isaac-typescript-definitions" />
+export declare type PostPickupStateChangedRegisterParameters = PickupRegisterParameters<[
+    previousState: int,
+    currentState: int
+], void>;

package/dist/classes/DefaultMap.d.ts

@@ -1,6 +1,6 @@
-declare type FactoryFunction<V, A extends unknown[]> = (...extraArgs: A) => V;
-declare type FirstArg<K, V, A extends unknown[]> = Iterable<[K, V]> | V | FactoryFunction<V, A>;
-declare type SecondArg<V, A extends unknown[]> = V | FactoryFunction<V, A>;
+declare type FactoryFunction<V, Args extends unknown[]> = (...extraArgs: Args) => V;
+declare type FirstArg<K, V, Args extends unknown[]> = Iterable<[K, V]> | V | FactoryFunction<V, Args>;
+declare type SecondArg<V, Args extends unknown[]> = V | FactoryFunction<V, Args>;
 /**
  * An extended Map with some new methods:
  *
@@ -48,28 +48,28 @@ declare type SecondArg<V, A extends unknown[]> = V | FactoryFunction<V, A>;
  * const defaultMapWithExtraArgs = new DefaultMap<string, string, [arg: boolean]>(factoryFunction);
  * ```
  */
-export declare class DefaultMap<K, V, A extends unknown[] = []> extends Map<K, V> {
+export declare class DefaultMap<K, V, Args extends unknown[] = []> extends Map<K, V> {
     private defaultValue;
     private defaultValueFactory;
     /**
      * See the DefaultMap documentation:
      * https://isaacscript.github.io/isaacscript-common/classes/types_DefaultMap.DefaultMap.html
      */
-    constructor(iterableOrDefaultValueOrDefaultValueFactory: FirstArg<K, V, A>, defaultValueOrDefaultValueFactory?: SecondArg<V, A>);
+    constructor(iterableOrDefaultValueOrDefaultValueFactory: FirstArg<K, V, Args>, defaultValueOrDefaultValueFactory?: SecondArg<V, Args>);
     /**
      * If the key exists, this will return the same thing as the `get` method. Otherwise, it will set
      * a default value to the key, and then return the default value.
      */
-    getAndSetDefault(key: K, ...extraArgs: A): V;
+    getAndSetDefault(key: K, ...extraArgs: Args): V;
     /**
      * Returns the default value to be used for a new key. (If a factory function was provided during
      * instantiation, this will execute the factory function.)
      */
-    getDefaultValue(...extraArgs: A): V;
+    getDefaultValue(...extraArgs: Args): V;
     /**
      * Helper method for cloning the map. Returns either the default value or a reference to the
      * factory function.
      */
-    getConstructorArg(): V | FactoryFunction<V, A>;
+    getConstructorArg(): V | FactoryFunction<V, Args>;
 }
 export {};

package/dist/enums/private/SaveDataKey.d.ts

@@ -0,0 +1,7 @@
+export declare enum SaveDataKey {
+    PERSISTENT = "persistent",
+    RUN = "run",
+    LEVEL = "level",
+    ROOM = "room"
+}
+export declare const RESETTABLE_SAVE_DATA_KEYS: ReadonlySet<SaveDataKey>;

package/dist/enums/private/SaveDataKey.lua

@@ -0,0 +1,11 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local ____exports = {}
+____exports.SaveDataKey = {}
+____exports.SaveDataKey.PERSISTENT = "persistent"
+____exports.SaveDataKey.RUN = "run"
+____exports.SaveDataKey.LEVEL = "level"
+____exports.SaveDataKey.ROOM = "room"
+____exports.RESETTABLE_SAVE_DATA_KEYS = __TS__New(Set, {____exports.SaveDataKey.RUN, ____exports.SaveDataKey.LEVEL, ____exports.SaveDataKey.ROOM})
+return ____exports

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

@@ -105,3 +105,24 @@ export declare function saveDataManagerSave(): void;
  * e.g. `l print(g.feature1.foo)`
  */
 export declare function saveDataManagerSetGlobal(): void;
+/**
+ * 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:
+ *
+ * ```
+ * const v = {
+ *   room: {
+ *     foo: 123,
+ *   },
+ * };
+ *
+ * saveDataManager("file1", v);
+ *
+ * // Then, later on, to explicit reset all of the "room" variables:
+ * saveDataManagerReset("file1", "room");
+ * ```
+ */
+export declare function saveDataManagerReset(key: string, childObjectKey: string): void;

package/dist/features/saveDataManager/exports.lua

@@ -13,6 +13,7 @@ local SAVE_DATA_MANAGER_FEATURE_NAME = ____constants.SAVE_DATA_MANAGER_FEATURE_N
 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
@@ -50,4 +51,16 @@ function ____exports.saveDataManagerSetGlobal(self)
     g = saveDataMap
     gd = saveDataDefaultsMap
 end
+function ____exports.saveDataManagerReset(self, key, childObjectKey)
+    errorIfFeaturesNotInitialized(nil, SAVE_DATA_MANAGER_FEATURE_NAME)
+    local keyType = type(key)
+    if keyType ~= "string" then
+        error((("The " .. SAVE_DATA_MANAGER_FEATURE_NAME) .. " requires that keys are strings. You tried to use a key of type: ") .. keyType)
+    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

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

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

package/dist/features/saveDataManager/main.lua

@@ -8,8 +8,9 @@ local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
 local ____ModCallbackCustom = require("enums.ModCallbackCustom")
 local ModCallbackCustom = ____ModCallbackCustom.ModCallbackCustom
-local ____SaveDataKeys = require("enums.private.SaveDataKeys")
-local SaveDataKeys = ____SaveDataKeys.SaveDataKeys
+local ____SaveDataKey = require("enums.private.SaveDataKey")
+local RESETTABLE_SAVE_DATA_KEYS = ____SaveDataKey.RESETTABLE_SAVE_DATA_KEYS
+local SaveDataKey = ____SaveDataKey.SaveDataKey
 local ____SerializationType = require("enums.SerializationType")
 local SerializationType = ____SerializationType.SerializationType
 local ____deepCopy = require("functions.deepCopy")
@@ -52,41 +53,41 @@ function preGameExit(self)
     loadedDataOnThisRun = false
 end
 function postNewLevel(self)
-    restoreDefaults(nil, SaveDataKeys.LEVEL)
+    restoreDefaults(nil, SaveDataKey.LEVEL)
 end
 function postNewRoomEarly(self)
-    restoreDefaults(nil, SaveDataKeys.ROOM)
+    restoreDefaults(nil, SaveDataKey.ROOM)
 end
 function restoreDefaultsAll(self)
-    restoreDefaults(nil, SaveDataKeys.RUN)
-    restoreDefaults(nil, SaveDataKeys.LEVEL)
-    restoreDefaults(nil, SaveDataKeys.ROOM)
+    restoreDefaults(nil, SaveDataKey.RUN)
+    restoreDefaults(nil, SaveDataKey.LEVEL)
+    restoreDefaults(nil, SaveDataKey.ROOM)
 end
-function restoreDefaults(self, childTableName)
-    if childTableName ~= SaveDataKeys.RUN and childTableName ~= SaveDataKeys.LEVEL and childTableName ~= SaveDataKeys.ROOM then
-        error("Unknown child table name of: " .. childTableName)
-    end
+function restoreDefaults(self, saveDataKey)
     for subscriberName, saveData in pairs(saveDataMap) do
-        do
-            local childTable = saveData[childTableName]
-            if childTable == nil then
-                goto __continue14
-            end
-            local saveDataDefaults = saveDataDefaultsMap[subscriberName]
-            if saveDataDefaults == nil then
-                logError("Failed to find the default copy of the save data for subscriber: " .. subscriberName)
-                goto __continue14
-            end
-            local childTableDefaults = saveDataDefaults[childTableName]
-            if childTableDefaults == nil then
-                logError(((("Failed to find the default copy of the child table \"" .. childTableName) .. "\" for subscriber \"") .. subscriberName) .. "\". This error usually means that your save data is out of date. You can try purging all of your save data by deleting the following directory: C:\\Program Files (x86)\\Steam\\steamapps\\common\\The Binding of Isaac Rebirth\\data")
-                goto __continue14
-            end
-            local childTableDefaultsCopy = deepCopy(nil, childTableDefaults, SerializationType.NONE, (subscriberName .. " --> ") .. childTableName)
-            clearAndCopyAllElements(nil, childTable, childTableDefaultsCopy)
-        end
-        ::__continue14::
+        ____exports.restoreDefaultSaveData(nil, subscriberName, saveData, saveDataKey)
+    end
+end
+function ____exports.restoreDefaultSaveData(self, subscriberName, saveData, saveDataKey)
+    if not RESETTABLE_SAVE_DATA_KEYS:has(saveDataKey) then
+        error("Unknown save data key name of: " .. saveDataKey)
+    end
+    local childTable = saveData[saveDataKey]
+    if childTable == nil then
+        return
+    end
+    local saveDataDefaults = saveDataDefaultsMap[subscriberName]
+    if saveDataDefaults == nil then
+        logError("Failed to find the default copy of the save data for subscriber: " .. subscriberName)
+        return
+    end
+    local childTableDefaults = saveDataDefaults[saveDataKey]
+    if childTableDefaults == nil then
+        logError(((("Failed to find the default copy of the child table \"" .. saveDataKey) .. "\" for subscriber \"") .. subscriberName) .. "\". This error usually means that your save data is out of date. You can try purging all of your save data by deleting the following directory: C:\\Program Files (x86)\\Steam\\steamapps\\common\\The Binding of Isaac Rebirth\\data")
+        return
     end
+    local childTableDefaultsCopy = deepCopy(nil, childTableDefaults, SerializationType.NONE, (subscriberName .. " --> ") .. saveDataKey)
+    clearAndCopyAllElements(nil, childTable, childTableDefaultsCopy)
 end
 function clearAndCopyAllElements(self, oldTable, newTable)
     clearTable(nil, oldTable)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "2.0.28",
+  "version": "2.0.31",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -25,7 +25,7 @@
     "dist/**/*.d.ts"
   ],
   "dependencies": {
-    "isaac-typescript-definitions": "^2.0.45"
+    "isaac-typescript-definitions": "^2.0.48"
   },
   "devDependencies": {
     "isaacscript-lint": "^1.0.159",