isaacscript-common 19.1.1 → 20.0.0

package/dist/index.d.ts

@@ -11294,26 +11294,31 @@ declare class ModdedElementSets extends Feature {
 export declare class ModFeature {
     private mod;
     /**
-     * An optional function that allows for conditional callback execution. If specified, any class
+     * An optional method that allows for conditional callback execution. If specified, any class
      * method that is annotated with a `@Callback` or `@CallbackCustom` decorator will only be fired
      * if the executed conditional function returns true.
      *
      * This property is used to easily turn entire mod features on and off (rather than repeating
      * conditional logic and early returning at the beginning of every callback function).
      *
-     * By default, this is set to null. Override this property in your class if you need to use it.
+     * Since the specific information for the firing callback is passed as arguments into the
+     * conditional method, you can also write logic that would only apply to a specific type of
+     * callback.
+     *
+     * By default, this is set to null, which means that all callback methods will fire
+     * unconditionally. Override this property in your class if you need to use it.
      *
      * The function has the following signature:
      *
      * ```ts
-     * (
-     *   vanilla: boolean, // Whether or not this is a vanilla or custom callback.
-     *   modCallback: ModCallback | ModCallbackCustom,
-     *   ...callbackArgs: unknown[]
+     * <T extends boolean>(
+     *   vanilla: T, // Whether or not this is a vanilla or custom callback.
+     *   modCallback: T extends true ? ModCallback : ModCallbackCustom,
+     *   ...callbackArgs: unknown[] // This would be e.g. `pickup: EntityPickup` for the `POST_PICKUP_INIT` callback.
      * ) => boolean;
      * ```
      */
-    protected callbackConditionalFunc: ((vanilla: boolean, modCallback: ModCallback | ModCallbackCustom, ...callbackArgs: unknown[]) => boolean) | null;
+    protected shouldCallbackMethodsFire: (<T extends boolean>(vanilla: T, modCallback: T extends true ? ModCallback : ModCallbackCustom, ...callbackArgs: unknown[]) => boolean) | null;
     /**
      * Whether or not the feature has registered its callbacks yet (and submitted its variables to the
      * save data manager, if any).

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 19.1.1
+isaacscript-common 20.0.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -49510,7 +49510,7 @@ function initDecoratedCallbacks(self, modFeature, constructor, tstlClassName, va
 end
 function addCallback(self, modFeature, modFeatureConstructor, mod, modCallback, callback, parameters, vanilla)
     local function wrappedCallback(____, ...)
-        local conditionalFunc = modFeature.callbackConditionalFunc
+        local conditionalFunc = modFeature.shouldCallbackMethodsFire
         if conditionalFunc ~= nil then
             local shouldRun = conditionalFunc(nil, vanilla, modCallback, ...)
             if not shouldRun then
@@ -49605,7 +49605,7 @@ function ModFeature.prototype.____constructor(self, mod, init)
     if init == nil then
         init = true
     end
-    self.callbackConditionalFunc = nil
+    self.shouldCallbackMethodsFire = nil
     self.initialized = false
     self.mod = mod
     if init then

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

@@ -39,26 +39,31 @@ export declare const MOD_FEATURE_CUSTOM_CALLBACKS_KEY = "__customCallbacks";
 export declare class ModFeature {
     private mod;
     /**
-     * An optional function that allows for conditional callback execution. If specified, any class
+     * An optional method that allows for conditional callback execution. If specified, any class
      * method that is annotated with a `@Callback` or `@CallbackCustom` decorator will only be fired
      * if the executed conditional function returns true.
      *
      * This property is used to easily turn entire mod features on and off (rather than repeating
      * conditional logic and early returning at the beginning of every callback function).
      *
-     * By default, this is set to null. Override this property in your class if you need to use it.
+     * Since the specific information for the firing callback is passed as arguments into the
+     * conditional method, you can also write logic that would only apply to a specific type of
+     * callback.
+     *
+     * By default, this is set to null, which means that all callback methods will fire
+     * unconditionally. Override this property in your class if you need to use it.
      *
      * The function has the following signature:
      *
      * ```ts
-     * (
-     *   vanilla: boolean, // Whether or not this is a vanilla or custom callback.
-     *   modCallback: ModCallback | ModCallbackCustom,
-     *   ...callbackArgs: unknown[]
+     * <T extends boolean>(
+     *   vanilla: T, // Whether or not this is a vanilla or custom callback.
+     *   modCallback: T extends true ? ModCallback : ModCallbackCustom,
+     *   ...callbackArgs: unknown[] // This would be e.g. `pickup: EntityPickup` for the `POST_PICKUP_INIT` callback.
      * ) => boolean;
      * ```
      */
-    protected callbackConditionalFunc: ((vanilla: boolean, modCallback: ModCallback | ModCallbackCustom, ...callbackArgs: unknown[]) => boolean) | null;
+    protected shouldCallbackMethodsFire: (<T extends boolean>(vanilla: T, modCallback: T extends true ? ModCallback : ModCallbackCustom, ...callbackArgs: unknown[]) => boolean) | null;
     /**
      * Whether or not the feature has registered its callbacks yet (and submitted its variables to the
      * save data manager, if any).

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

@@ -1 +1 @@
-{"version":3,"file":"ModFeature.d.ts","sourceRoot":"","sources":["../../../src/classes/ModFeature.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAS/D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,eAAO,MAAM,yBAAyB,gBAAgB,CAAC;AACvD,eAAO,MAAM,gCAAgC,sBAAsB,CAAC;AAyBpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AAEH,qBAAa,UAAU;IACrB,OAAO,CAAC,GAAG,CAAkB;IAE7B;;;;;;;;;;;;;;;;;;;OAmBG;IACH,SAAS,CAAC,uBAAuB,EAC7B,CAAC,CACC,OAAO,EAAE,OAAO,EAChB,WAAW,EAAE,WAAW,GAAG,iBAAiB,EAC5C,GAAG,YAAY,EAAE,OAAO,EAAE,KACvB,OAAO,CAAC,GACb,IAAI,CAAQ;IAEhB;;;;;;OAMG;IACI,WAAW,UAAS;gBAEf,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":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAS/D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,eAAO,MAAM,yBAAyB,gBAAgB,CAAC;AACvD,eAAO,MAAM,gCAAgC,sBAAsB,CAAC;AAyBpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AAEH,qBAAa,UAAU;IACrB,OAAO,CAAC,GAAG,CAAkB;IAE7B;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,SAAS,CAAC,yBAAyB,EAC/B,CAAC,CAAC,CAAC,SAAS,OAAO,EACjB,OAAO,EAAE,CAAC,EACV,WAAW,EAAE,CAAC,SAAS,IAAI,GAAG,WAAW,GAAG,iBAAiB,EAC7D,GAAG,YAAY,EAAE,OAAO,EAAE,KACvB,OAAO,CAAC,GACb,IAAI,CAAQ;IAEhB;;;;;;OAMG;IACI,WAAW,UAAS;gBAEf,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

@@ -64,7 +64,7 @@ function initDecoratedCallbacks(self, modFeature, constructor, tstlClassName, va
 end
 function addCallback(self, modFeature, modFeatureConstructor, mod, modCallback, callback, parameters, vanilla)
     local function wrappedCallback(____, ...)
-        local conditionalFunc = modFeature.callbackConditionalFunc
+        local conditionalFunc = modFeature.shouldCallbackMethodsFire
         if conditionalFunc ~= nil then
             local shouldRun = conditionalFunc(nil, vanilla, modCallback, ...)
             if not shouldRun then
@@ -190,7 +190,7 @@ function ModFeature.prototype.____constructor(self, mod, init)
     if init == nil then
         init = true
     end
-    self.callbackConditionalFunc = nil
+    self.shouldCallbackMethodsFire = nil
     self.initialized = false
     self.mod = mod
     if init then

package/package.json

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

package/src/classes/ModFeature.ts

@@ -74,29 +74,34 @@ export class ModFeature {
   private mod: ModUpgradedBase;
 
   /**
-   * An optional function that allows for conditional callback execution. If specified, any class
+   * An optional method that allows for conditional callback execution. If specified, any class
    * method that is annotated with a `@Callback` or `@CallbackCustom` decorator will only be fired
    * if the executed conditional function returns true.
    *
    * This property is used to easily turn entire mod features on and off (rather than repeating
    * conditional logic and early returning at the beginning of every callback function).
    *
-   * By default, this is set to null. Override this property in your class if you need to use it.
+   * Since the specific information for the firing callback is passed as arguments into the
+   * conditional method, you can also write logic that would only apply to a specific type of
+   * callback.
+   *
+   * By default, this is set to null, which means that all callback methods will fire
+   * unconditionally. Override this property in your class if you need to use it.
    *
    * The function has the following signature:
    *
    * ```ts
-   * (
-   *   vanilla: boolean, // Whether or not this is a vanilla or custom callback.
-   *   modCallback: ModCallback | ModCallbackCustom,
-   *   ...callbackArgs: unknown[]
+   * <T extends boolean>(
+   *   vanilla: T, // Whether or not this is a vanilla or custom callback.
+   *   modCallback: T extends true ? ModCallback : ModCallbackCustom,
+   *   ...callbackArgs: unknown[] // This would be e.g. `pickup: EntityPickup` for the `POST_PICKUP_INIT` callback.
    * ) => boolean;
    * ```
    */
-  protected callbackConditionalFunc:
-    | ((
-        vanilla: boolean,
-        modCallback: ModCallback | ModCallbackCustom,
+  protected shouldCallbackMethodsFire:
+    | (<T extends boolean>(
+        vanilla: T,
+        modCallback: T extends true ? ModCallback : ModCallbackCustom,
         ...callbackArgs: unknown[]
       ) => boolean)
     | null = null;
@@ -250,7 +255,7 @@ function addCallback(
   // first argument. (Otherwise, the method will not be able to properly access `this`.
   const wrappedCallback = (...callbackArgs: unknown[]) => {
     // eslint-disable-next-line @typescript-eslint/dot-notation
-    const conditionalFunc = modFeature["callbackConditionalFunc"];
+    const conditionalFunc = modFeature["shouldCallbackMethodsFire"];
     if (conditionalFunc !== null) {
       const shouldRun = conditionalFunc(vanilla, modCallback, ...callbackArgs);
       if (!shouldRun) {