isaacscript-common 15.3.1 → 15.3.2

package/dist/index.d.ts

@@ -10690,7 +10690,7 @@ declare class ModdedElementSets extends Feature {
 }
 
 /**
- * Helper class for mods that wants to represent their individual features as classes. Extend your
+ * Helper class for mods that want to represent their individual features as classes. Extend your
  * mod features from this class in order to enable the `@Callback` and `@CustomCallback` decorators
  * that automatically subscribe to callbacks.
  *
@@ -10715,6 +10715,9 @@ declare class ModdedElementSets extends Feature {
  * }
  * ```
  *
+ * When instantiating a feature class, you must pass your upgraded mod as the first argument to the
+ * constructor.
+ *
  * In almost all cases, you will want the callback functions to be immediately subscribed after
  * instantiating the class. However, if this is not the case, you can pass `false` as the optional
  * second argument to the constructor.
@@ -12440,6 +12443,7 @@ export declare function round(num: float, numDecimalPlaces?: number): float;
 export declare function runDeepCopyTests(): void;
 
 declare class RunInNFrames extends Feature {
+    vConditionalFunc: () => boolean;
     private postUpdate;
     private postRender;
     /**
@@ -12677,6 +12681,8 @@ declare class SaveDataManager extends Feature {
      * manage them for you. (See below for an example.)
      *
      * In order to use this function, you must upgrade your mod with `ISCFeature.SAVE_DATA_MANAGER`.
+     * (Upgrade your mod before registering any of your own callbacks so that the save data manager
+     * will run before any of your code does.)
      *
      * 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
@@ -12733,10 +12739,6 @@ declare class SaveDataManager extends Feature {
      * supported. For the specific things that are supported, see the documentation for the `deepCopy`
      * helper function.
      *
-     * 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

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 15.3.1
+isaacscript-common 15.3.2
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -30390,6 +30390,7 @@ __TS__ClassExtends(RunInNFrames, Feature)
 function RunInNFrames.prototype.____constructor(self)
     Feature.prototype.____constructor(self)
     self.v = {run = {queuedGameFunctionTuples = {}, queuedRenderFunctionTuples = {}, intervalGameFunctionTuples = {}, intervalRenderFunctionTuples = {}}}
+    self.vConditionalFunc = function() return false end
     self.postUpdate = function()
         local gameFrameCount = game:GetFrameCount()
         checkExecuteQueuedFunctions(nil, gameFrameCount, self.v.run.queuedGameFunctionTuples)

package/dist/src/classes/ModFeature.d.ts

@@ -2,7 +2,7 @@ import { ModUpgradedBase } from "./ModUpgradedBase";
 export declare const ADD_CALLBACK_ARGS_KEY = "__addCallbackArgs";
 export declare const ADD_CALLBACK_CUSTOM_ARGS_KEY = "__addCallbackCustomArgs";
 /**
- * Helper class for mods that wants to represent their individual features as classes. Extend your
+ * Helper class for mods that want to represent their individual features as classes. Extend your
  * mod features from this class in order to enable the `@Callback` and `@CustomCallback` decorators
  * that automatically subscribe to callbacks.
  *
@@ -27,6 +27,9 @@ export declare const ADD_CALLBACK_CUSTOM_ARGS_KEY = "__addCallbackCustomArgs";
  * }
  * ```
  *
+ * When instantiating a feature class, you must pass your upgraded mod as the first argument to the
+ * constructor.
+ *
  * In almost all cases, you will want the callback functions to be immediately subscribed after
  * instantiating the class. However, if this is not the case, you can pass `false` as the optional
  * second argument to the constructor.

package/dist/src/classes/ModFeature.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ModFeature.d.ts","sourceRoot":"","sources":["../../../src/classes/ModFeature.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,eAAO,MAAM,qBAAqB,sBAAsB,CAAC;AACzD,eAAO,MAAM,4BAA4B,4BAA4B,CAAC;AAatE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,qBAAa,UAAU;IACrB,OAAO,CAAC,GAAG,CAAkB;IAC7B,OAAO,CAAC,WAAW,CAAS;gBAEhB,GAAG,EAAE,eAAe,EAAE,IAAI,UAAO;IAQ7C;;;;;OAKG;IACI,IAAI,CAAC,IAAI,UAAO,GAAG,IAAI;IAqB9B;;;;;;OAMG;IACI,MAAM,IAAI,IAAI;CAGtB"}
+{"version":3,"file":"ModFeature.d.ts","sourceRoot":"","sources":["../../../src/classes/ModFeature.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,eAAO,MAAM,qBAAqB,sBAAsB,CAAC;AACzD,eAAO,MAAM,4BAA4B,4BAA4B,CAAC;AAatE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AAEH,qBAAa,UAAU;IACrB,OAAO,CAAC,GAAG,CAAkB;IAC7B,OAAO,CAAC,WAAW,CAAS;gBAEhB,GAAG,EAAE,eAAe,EAAE,IAAI,UAAO;IAQ7C;;;;;OAKG;IACI,IAAI,CAAC,IAAI,UAAO,GAAG,IAAI;IAqB9B;;;;;;OAMG;IACI,MAAM,IAAI,IAAI;CAGtB"}

package/dist/src/classes/ModFeature.lua

@@ -143,7 +143,7 @@ ____exports.ADD_CALLBACK_ARGS_KEY = "__addCallbackArgs"
 ____exports.ADD_CALLBACK_CUSTOM_ARGS_KEY = "__addCallbackCustomArgs"
 WRAPPED_CALLBACK_METHODS_KEY = "__wrappedCallbackMethods"
 WRAPPED_CUSTOM_CALLBACK_METHODS_KEY = "__wrappedCustomCallbacksMethods"
---- Helper class for mods that wants to represent their individual features as classes. Extend your
+--- Helper class for mods that want to represent their individual features as classes. Extend your
 -- mod features from this class in order to enable the `@Callback` and `@CustomCallback` decorators
 -- that automatically subscribe to callbacks.
 -- 
@@ -168,6 +168,9 @@ WRAPPED_CUSTOM_CALLBACK_METHODS_KEY = "__wrappedCustomCallbacksMethods"
 -- }
 -- ```
 -- 
+-- When instantiating a feature class, you must pass your upgraded mod as the first argument to the
+-- constructor.
+-- 
 -- In almost all cases, you will want the callback functions to be immediately subscribed after
 -- instantiating the class. However, if this is not the case, you can pass `false` as the optional
 -- second argument to the constructor.

package/dist/src/classes/features/other/RunInNFrames.d.ts

@@ -1,6 +1,7 @@
 import { PlayerType } from "isaac-typescript-definitions";
 import { Feature } from "../../private/Feature";
 export declare class RunInNFrames extends Feature {
+    vConditionalFunc: () => boolean;
     private postUpdate;
     private postRender;
     /**

package/dist/src/classes/features/other/RunInNFrames.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RunInNFrames.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/RunInNFrames.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAKvE,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAgBhD,qBAAa,YAAa,SAAQ,OAAO;IAuBvC,OAAO,CAAC,UAAU,CAWhB;IAGF,OAAO,CAAC,UAAU,CAWhB;IAEF;;;;;;;;OAQG;IAEI,sBAAsB,CAAC,SAAS,CAAC,EAAE,UAAU,GAAG,IAAI;IAM3D;;;;;;;;;;;OAWG;IAEI,gBAAgB,CAAC,IAAI,EAAE,MAAM,IAAI,EAAE,UAAU,EAAE,GAAG,GAAG,IAAI;IAOhE;;;;;;;;;;;OAWG;IAEI,kBAAkB,CAAC,IAAI,EAAE,MAAM,IAAI,EAAE,YAAY,EAAE,GAAG,GAAG,IAAI;IAOpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IAEI,gBAAgB,CAAC,IAAI,EAAE,MAAM,IAAI,GAAG,IAAI;IAI/C;;;;;;;;;OASG;IAEI,kBAAkB,CAAC,IAAI,EAAE,MAAM,IAAI,GAAG,IAAI;IAIjD;;;;;;;;;;;;;;;;;OAiBG;IAEI,qBAAqB,CAC1B,IAAI,EAAE,MAAM,OAAO,EACnB,UAAU,EAAE,GAAG,EACf,cAAc,EAAE,OAAO,GACtB,IAAI;IAWP;;;;;;;;;;;;;;;;;OAiBG;IAEI,uBAAuB,CAC5B,IAAI,EAAE,MAAM,OAAO,EACnB,YAAY,EAAE,GAAG,EACjB,cAAc,EAAE,OAAO,GACtB,IAAI;CAcR"}
+{"version":3,"file":"RunInNFrames.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/RunInNFrames.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAKvE,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAgBhD,qBAAa,YAAa,SAAQ,OAAO;IAavB,gBAAgB,QAAO,OAAO,CAAU;IAaxD,OAAO,CAAC,UAAU,CAWhB;IAGF,OAAO,CAAC,UAAU,CAWhB;IAEF;;;;;;;;OAQG;IAEI,sBAAsB,CAAC,SAAS,CAAC,EAAE,UAAU,GAAG,IAAI;IAM3D;;;;;;;;;;;OAWG;IAEI,gBAAgB,CAAC,IAAI,EAAE,MAAM,IAAI,EAAE,UAAU,EAAE,GAAG,GAAG,IAAI;IAOhE;;;;;;;;;;;OAWG;IAEI,kBAAkB,CAAC,IAAI,EAAE,MAAM,IAAI,EAAE,YAAY,EAAE,GAAG,GAAG,IAAI;IAOpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IAEI,gBAAgB,CAAC,IAAI,EAAE,MAAM,IAAI,GAAG,IAAI;IAI/C;;;;;;;;;OASG;IAEI,kBAAkB,CAAC,IAAI,EAAE,MAAM,IAAI,GAAG,IAAI;IAIjD;;;;;;;;;;;;;;;;;OAiBG;IAEI,qBAAqB,CAC1B,IAAI,EAAE,MAAM,OAAO,EACnB,UAAU,EAAE,GAAG,EACf,cAAc,EAAE,OAAO,GACtB,IAAI;IAWP;;;;;;;;;;;;;;;;;OAiBG;IAEI,uBAAuB,CAC5B,IAAI,EAAE,MAAM,OAAO,EACnB,YAAY,EAAE,GAAG,EACjB,cAAc,EAAE,OAAO,GACtB,IAAI;CAcR"}

package/dist/src/classes/features/other/RunInNFrames.lua

@@ -59,6 +59,7 @@ __TS__ClassExtends(RunInNFrames, Feature)
 function RunInNFrames.prototype.____constructor(self)
     Feature.prototype.____constructor(self)
     self.v = {run = {queuedGameFunctionTuples = {}, queuedRenderFunctionTuples = {}, intervalGameFunctionTuples = {}, intervalRenderFunctionTuples = {}}}
+    self.vConditionalFunc = function() return false end
     self.postUpdate = function()
         local gameFrameCount = game:GetFrameCount()
         checkExecuteQueuedFunctions(nil, gameFrameCount, self.v.run.queuedGameFunctionTuples)

package/dist/src/classes/features/other/SaveDataManager.d.ts

@@ -54,6 +54,8 @@ export declare class SaveDataManager extends Feature {
      * manage them for you. (See below for an example.)
      *
      * In order to use this function, you must upgrade your mod with `ISCFeature.SAVE_DATA_MANAGER`.
+     * (Upgrade your mod before registering any of your own callbacks so that the save data manager
+     * will run before any of your code does.)
      *
      * 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
@@ -110,10 +112,6 @@ export declare class SaveDataManager extends Feature {
      * supported. For the specific things that are supported, see the documentation for the `deepCopy`
      * helper function.
      *
-     * 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

package/dist/src/classes/features/other/SaveDataManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SaveDataManager.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/SaveDataManager.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAMzD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACnD,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAsBhD,qBAAa,eAAgB,SAAQ,OAAO;IAC1C;;;OAGG;IACH,OAAO,CAAC,GAAG,CAAM;IAEjB;;;;OAIG;IACH,OAAO,CAAC,WAAW,CAAkC;IAErD;;;OAGG;IACH,OAAO,CAAC,mBAAmB,CAAkC;IAE7D;;;OAGG;IACH,OAAO,CAAC,0BAA0B,CAAuC;IAEzE;;;;;;OAMG;IACH,OAAO,CAAC,2BAA2B,CAAkC;IAErE;;;OAGG;IACH,OAAO,CAAC,iBAAiB,CAAkC;IAG3D,OAAO,CAAC,mBAAmB,CAAS;IACpC,OAAO,CAAC,qCAAqC,CAAS;IAyBtD,OAAO,CAAC,2BAA2B,CAUjC;IAGF,OAAO,CAAC,cAAc,CA0BpB;IAGF,OAAO,CAAC,WAAW,CAUjB;IAGF,OAAO,CAAC,YAAY,CAYlB;IAGF,OAAO,CAAC,gBAAgB,CAuBtB;IAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmGG;IACI,eAAe,CAAC,UAAU,EAAE,GAAG,EAAE,KAAK,EAC3C,GAAG,EAAE,MAAM,EAAE,qEAAqE;IAClF,CAAC,EAAE,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE,KAAK,CAAC,EACnC,eAAe,CAAC,EAAE,MAAM,OAAO,GAC9B,IAAI;IACA,eAAe,CACpB,GAAG,EAAE,MAAM,EAAE,kEAAkE;IAC/E,CAAC,EAAE,QAAQ,EACX,eAAe,EAAE,KAAK,GACrB,IAAI;IAkDP;;OAEG;IACH,OAAO,CAAC,gCAAgC;IAgBxC;;;;;;;;;OASG;IAEI,mBAAmB,IAAI,IAAI;IAIlC;;;;;;OAMG;IAEI,mBAAmB,IAAI,IAAI;IAIlC;;;;;;;OAOG;IAEI,wBAAwB,IAAI,IAAI;IAIvC;;;;;;;;;;;OAWG;IAEI,4BAA4B,CAAC,GAAG,WAAW,EAAE,QAAQ,EAAE,GAAG,IAAI;IAcrE;;;;;OAKG;IAEI,qBAAqB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAoB/C;;;;;;;;;;;;;;;;;;;;;OAqBG;IAEI,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,cAAc,EAAE,WAAW,GAAG,IAAI;CAqB5E"}
+{"version":3,"file":"SaveDataManager.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/SaveDataManager.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAMzD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACnD,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAsBhD,qBAAa,eAAgB,SAAQ,OAAO;IAC1C;;;OAGG;IACH,OAAO,CAAC,GAAG,CAAM;IAEjB;;;;OAIG;IACH,OAAO,CAAC,WAAW,CAAkC;IAErD;;;OAGG;IACH,OAAO,CAAC,mBAAmB,CAAkC;IAE7D;;;OAGG;IACH,OAAO,CAAC,0BAA0B,CAAuC;IAEzE;;;;;;OAMG;IACH,OAAO,CAAC,2BAA2B,CAAkC;IAErE;;;OAGG;IACH,OAAO,CAAC,iBAAiB,CAAkC;IAG3D,OAAO,CAAC,mBAAmB,CAAS;IACpC,OAAO,CAAC,qCAAqC,CAAS;IAyBtD,OAAO,CAAC,2BAA2B,CAUjC;IAGF,OAAO,CAAC,cAAc,CA0BpB;IAGF,OAAO,CAAC,WAAW,CAUjB;IAGF,OAAO,CAAC,YAAY,CAYlB;IAGF,OAAO,CAAC,gBAAgB,CAuBtB;IAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiGG;IACI,eAAe,CAAC,UAAU,EAAE,GAAG,EAAE,KAAK,EAC3C,GAAG,EAAE,MAAM,EAAE,qEAAqE;IAClF,CAAC,EAAE,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE,KAAK,CAAC,EACnC,eAAe,CAAC,EAAE,MAAM,OAAO,GAC9B,IAAI;IACA,eAAe,CACpB,GAAG,EAAE,MAAM,EAAE,kEAAkE;IAC/E,CAAC,EAAE,QAAQ,EACX,eAAe,EAAE,KAAK,GACrB,IAAI;IAkDP;;OAEG;IACH,OAAO,CAAC,gCAAgC;IAgBxC;;;;;;;;;OASG;IAEI,mBAAmB,IAAI,IAAI;IAIlC;;;;;;OAMG;IAEI,mBAAmB,IAAI,IAAI;IAIlC;;;;;;;OAOG;IAEI,wBAAwB,IAAI,IAAI;IAIvC;;;;;;;;;;;OAWG;IAEI,4BAA4B,CAAC,GAAG,WAAW,EAAE,QAAQ,EAAE,GAAG,IAAI;IAcrE;;;;;OAKG;IAEI,qBAAqB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAoB/C;;;;;;;;;;;;;;;;;;;;;OAqBG;IAEI,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,cAAc,EAAE,WAAW,GAAG,IAAI;CAqB5E"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "15.3.1",
+  "version": "15.3.2",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",

package/src/classes/ModFeature.ts

@@ -26,7 +26,7 @@ type ModFeatureConstructor = TSTLClassMetatable["constructor"] & {
 };
 
 /**
- * Helper class for mods that wants to represent their individual features as classes. Extend your
+ * Helper class for mods that want to represent their individual features as classes. Extend your
  * mod features from this class in order to enable the `@Callback` and `@CustomCallback` decorators
  * that automatically subscribe to callbacks.
  *
@@ -51,6 +51,9 @@ type ModFeatureConstructor = TSTLClassMetatable["constructor"] & {
  * }
  * ```
  *
+ * When instantiating a feature class, you must pass your upgraded mod as the first argument to the
+ * constructor.
+ *
  * In almost all cases, you will want the callback functions to be immediately subscribed after
  * instantiating the class. However, if this is not the case, you can pass `false` as the optional
  * second argument to the constructor.

package/src/classes/features/other/RunInNFrames.ts

@@ -31,6 +31,9 @@ export class RunInNFrames extends Feature {
     },
   };
 
+  // eslint-disable-next-line class-methods-use-this
+  public override vConditionalFunc = (): boolean => false;
+
   /** @internal */
   constructor() {
     super();

package/src/classes/features/other/SaveDataManager.ts

@@ -210,6 +210,8 @@ export class SaveDataManager extends Feature {
    * manage them for you. (See below for an example.)
    *
    * In order to use this function, you must upgrade your mod with `ISCFeature.SAVE_DATA_MANAGER`.
+   * (Upgrade your mod before registering any of your own callbacks so that the save data manager
+   * will run before any of your code does.)
    *
    * 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
@@ -266,10 +268,6 @@ export class SaveDataManager extends Feature {
    * supported. For the specific things that are supported, see the documentation for the `deepCopy`
    * helper function.
    *
-   * 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