isaacscript-common 18.3.2 → 18.4.0

package/dist/index.d.ts

@@ -1320,6 +1320,8 @@ declare class CollectibleItemPoolType extends Feature {
 export declare function collectibleSpriteEquals(sprite1: Sprite, sprite2: Sprite): boolean;
 
 /**
+ * Equal to `Color(1, 1, 1)`.
+ *
  * This is a safe version of the `Color.Default` constant. (Other mods can mutate `Color.Default`,
  * so it is not safe to use.)
  *
@@ -11230,8 +11232,18 @@ export declare class ModFeature {
      * 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.
+     *
+     * The function has the following signature:
+     *
+     * ```ts
+     * (
+     *   vanilla: boolean, // Whether or not this is a vanilla or custom callback.
+     *   modCallback: ModCallback | ModCallbackCustom,
+     *   ...callbackArgs: unknown[]
+     * ) => boolean;
+     * ```
      */
-    protected callbackConditionalFunc: (() => boolean) | null;
+    protected callbackConditionalFunc: ((vanilla: boolean, modCallback: 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).
@@ -14941,6 +14953,8 @@ export declare function validateInterfaceMatchesEnum<T extends Record<Enum, unkn
 export declare function vectorEquals(vector1: Vector, vector2: Vector): boolean;
 
 /**
+ * Equal to `Vector(1, 1)`.
+ *
  * This is a safe version of the `Vector.One` constant. (Other mods can mutate `Vector.One`, so it
  * is not safe to use.)
  */
@@ -14952,6 +14966,8 @@ export declare function vectorToDirection(vector: Vector): Direction;
 export declare function vectorToString(vector: Vector, round?: boolean): string;
 
 /**
+ * Equal to `Vector(0, 0)`.
+ *
  * This is a safe version of the `Vector.Zero` constant. (Other mods can mutate `Vector.Zero`, so it
  * is not safe to use.)
  */

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 18.3.2
+isaacscript-common 18.4.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -49377,7 +49377,7 @@ function addCallback(self, modFeature, modFeatureConstructor, mod, modCallback,
     local function wrappedCallback(____, ...)
         local conditionalFunc = modFeature.callbackConditionalFunc
         if conditionalFunc ~= nil then
-            local shouldRun = conditionalFunc(nil)
+            local shouldRun = conditionalFunc(nil, vanilla, modCallback, ...)
             if not shouldRun then
                 return nil
             end

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

@@ -1,3 +1,5 @@
+import { ModCallback } from "isaac-typescript-definitions";
+import { ModCallbackCustom } from "../enums/ModCallbackCustom";
 import { ModUpgradedBase } from "./ModUpgradedBase";
 export declare const MOD_FEATURE_CALLBACKS_KEY = "__callbacks";
 export declare const MOD_FEATURE_CUSTOM_CALLBACKS_KEY = "__customCallbacks";
@@ -45,8 +47,18 @@ export declare class ModFeature {
      * 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.
+     *
+     * The function has the following signature:
+     *
+     * ```ts
+     * (
+     *   vanilla: boolean, // Whether or not this is a vanilla or custom callback.
+     *   modCallback: ModCallback | ModCallbackCustom,
+     *   ...callbackArgs: unknown[]
+     * ) => boolean;
+     * ```
      */
-    protected callbackConditionalFunc: (() => boolean) | null;
+    protected callbackConditionalFunc: ((vanilla: boolean, modCallback: 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":"AAUA,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;;;;;;;;;OASG;IACH,SAAS,CAAC,uBAAuB,EAAE,CAAC,MAAM,OAAO,CAAC,GAAG,IAAI,CAAQ;IAEjE;;;;;;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;;;;;;;;;;;;;;;;;;;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"}

package/dist/src/classes/ModFeature.lua

@@ -66,7 +66,7 @@ function addCallback(self, modFeature, modFeatureConstructor, mod, modCallback,
     local function wrappedCallback(____, ...)
         local conditionalFunc = modFeature.callbackConditionalFunc
         if conditionalFunc ~= nil then
-            local shouldRun = conditionalFunc(nil)
+            local shouldRun = conditionalFunc(nil, vanilla, modCallback, ...)
             if not shouldRun then
                 return nil
             end

package/dist/src/core/constants.d.ts

@@ -133,16 +133,22 @@ export declare const TELEPORTER_ACTIVATION_DISTANCE: number;
  */
 export declare const UI_HEART_WIDTH = 12;
 /**
+ * Equal to `Vector(1, 1)`.
+ *
  * This is a safe version of the `Vector.One` constant. (Other mods can mutate `Vector.One`, so it
  * is not safe to use.)
  */
 export declare const VectorOne: Readonly<Vector>;
 /**
+ * Equal to `Vector(0, 0)`.
+ *
  * This is a safe version of the `Vector.Zero` constant. (Other mods can mutate `Vector.Zero`, so it
  * is not safe to use.)
  */
 export declare const VectorZero: Readonly<Vector>;
 /**
+ * Equal to `Color(1, 1, 1)`.
+ *
  * This is a safe version of the `Color.Default` constant. (Other mods can mutate `Color.Default`,
  * so it is not safe to use.)
  *

package/dist/src/core/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/core/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,kBAAkB,EAClB,YAAY,EAEb,MAAM,8BAA8B,CAAC;AAMtC;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB;;;;EAI7B,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,iCAAiC,SAAS,CAAC;AAExD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,4CAA4C,CAAC;AAE7E,mEAAmE;AACnE,eAAO,MAAM,kBAAkB,KAAK,CAAC;AAErC,iGAAiG;AACjG,eAAO,MAAM,wBAAwB,KAAK,CAAC;AAE3C,eAAO,MAAM,sBAAsB,wBAAwB,CAAC;AAE5D,gGAAgG;AAChG,eAAO,MAAM,qBAAqB,KAAK,CAAC;AAExC,eAAO,MAAM,qBAAqB,MAAM,CAAC;AAEzC,eAAO,MAAM,kBAAkB,KAAK,CAAC;AAErC;;;;GAIG;AACH,eAAO,MAAM,gCAAgC,KAAK,CAAC;AAEnD;;;GAGG;AACH,eAAO,MAAM,cAAc,iBAAiB,CAAC;AAE7C;;;;;;GAMG;AAEH,eAAO,MAAM,+BAA+B,wDAAmC,CAAC;AAEhF,2EAA2E;AAC3E,eAAO,MAAM,sBAAsB,KAAK,CAAC;AAEzC,2EAA2E;AAC3E,eAAO,MAAM,sBAAsB,QAA8B,CAAC;AAElE,wFAAwF;AACxF,eAAO,MAAM,gCAAgC,yBAK3C,CAAC;AAEH,8EAA8E;AAC9E,eAAO,MAAM,wBAAwB,KAAK,CAAC;AAE3C,8EAA8E;AAC9E,eAAO,MAAM,wBAAwB,QAAgC,CAAC;AAEtE,eAAO,MAAM,6BAA6B,KAAK,CAAC;AAEhD;;;GAGG;AACH,eAAO,MAAM,wBAAwB,KAAK,CAAC;AAE3C;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,KAAK,CAAC;AAEvC;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,MAAM,CAAC;AAExC;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,KAAK,CAAC;AAEpC,6DAA6D;AAC7D,eAAO,MAAM,cAAc,IAAI,CAAC;AAEhC,iFAAiF;AACjF,eAAO,MAAM,2BAA2B,KAAK,CAAC;AAE9C;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,MAAM,CAAC;AAE7C,eAAO,MAAM,wBAAwB,QAA6B,CAAC;AAEnE,yFAAyF;AACzF,eAAO,MAAM,0BAA0B,MAAM,CAAC;AAE9C,qFAAqF;AACrF,eAAO,MAAM,qBAAqB,MAAM,CAAC;AAEzC;;;GAGG;AACH,eAAO,MAAM,cAAc,IAAM,CAAC;AAElC,yCAAyC;AACzC,eAAO,MAAM,uCAAuC,QAAmB,CAAC;AAExE,iCAAiC;AACjC,eAAO,MAAM,sCAAsC,QAAmB,CAAC;AAEvE;;;GAGG;AACH,eAAO,MAAM,gCAAgC,QAAmB,CAAC;AAEjE,+EAA+E;AAC/E,eAAO,MAAM,iCAAiC,SAAS,CAAC;AAExD,eAAO,MAAM,cAAc,QAA+B,CAAC;AAE3D;;;GAGG;AACH,eAAO,MAAM,iBAAiB,QAAyB,CAAC;AAExD,eAAO,MAAM,sBAAsB,OAAO,CAAC;AAC3C,eAAO,MAAM,sBAAsB,QAA8B,CAAC;AAElE,eAAO,MAAM,yBAAyB,MAAM,CAAC;AAE7C,6FAA6F;AAC7F,eAAO,MAAM,gDAAgD,QAAQ,CAAC;AAEtE,4CAA4C;AAC5C,eAAO,MAAM,8BAA8B,QAA4B,CAAC;AAExE;;;GAGG;AACH,eAAO,MAAM,cAAc,KAAK,CAAC;AAEjC;;;GAGG;AACH,eAAO,MAAM,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAgB,CAAC;AAExD;;;GAGG;AACH,eAAO,MAAM,UAAU,EAAE,QAAQ,CAAC,MAAM,CAAgB,CAAC;AAEzD;;;;;GAKG;AACH,eAAO,MAAM,YAAY,EAAE,QAAQ,CAAC,KAAK,CAAkB,CAAC;AAE5D;;;;GAIG;AACH,eAAO,MAAM,aAAa,EAAE,QAAQ,CAAC,MAAM,CAAsB,CAAC"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/core/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,kBAAkB,EAClB,YAAY,EAEb,MAAM,8BAA8B,CAAC;AAMtC;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB;;;;EAI7B,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,iCAAiC,SAAS,CAAC;AAExD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,4CAA4C,CAAC;AAE7E,mEAAmE;AACnE,eAAO,MAAM,kBAAkB,KAAK,CAAC;AAErC,iGAAiG;AACjG,eAAO,MAAM,wBAAwB,KAAK,CAAC;AAE3C,eAAO,MAAM,sBAAsB,wBAAwB,CAAC;AAE5D,gGAAgG;AAChG,eAAO,MAAM,qBAAqB,KAAK,CAAC;AAExC,eAAO,MAAM,qBAAqB,MAAM,CAAC;AAEzC,eAAO,MAAM,kBAAkB,KAAK,CAAC;AAErC;;;;GAIG;AACH,eAAO,MAAM,gCAAgC,KAAK,CAAC;AAEnD;;;GAGG;AACH,eAAO,MAAM,cAAc,iBAAiB,CAAC;AAE7C;;;;;;GAMG;AAEH,eAAO,MAAM,+BAA+B,wDAAmC,CAAC;AAEhF,2EAA2E;AAC3E,eAAO,MAAM,sBAAsB,KAAK,CAAC;AAEzC,2EAA2E;AAC3E,eAAO,MAAM,sBAAsB,QAA8B,CAAC;AAElE,wFAAwF;AACxF,eAAO,MAAM,gCAAgC,yBAK3C,CAAC;AAEH,8EAA8E;AAC9E,eAAO,MAAM,wBAAwB,KAAK,CAAC;AAE3C,8EAA8E;AAC9E,eAAO,MAAM,wBAAwB,QAAgC,CAAC;AAEtE,eAAO,MAAM,6BAA6B,KAAK,CAAC;AAEhD;;;GAGG;AACH,eAAO,MAAM,wBAAwB,KAAK,CAAC;AAE3C;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,KAAK,CAAC;AAEvC;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,MAAM,CAAC;AAExC;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,KAAK,CAAC;AAEpC,6DAA6D;AAC7D,eAAO,MAAM,cAAc,IAAI,CAAC;AAEhC,iFAAiF;AACjF,eAAO,MAAM,2BAA2B,KAAK,CAAC;AAE9C;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,MAAM,CAAC;AAE7C,eAAO,MAAM,wBAAwB,QAA6B,CAAC;AAEnE,yFAAyF;AACzF,eAAO,MAAM,0BAA0B,MAAM,CAAC;AAE9C,qFAAqF;AACrF,eAAO,MAAM,qBAAqB,MAAM,CAAC;AAEzC;;;GAGG;AACH,eAAO,MAAM,cAAc,IAAM,CAAC;AAElC,yCAAyC;AACzC,eAAO,MAAM,uCAAuC,QAAmB,CAAC;AAExE,iCAAiC;AACjC,eAAO,MAAM,sCAAsC,QAAmB,CAAC;AAEvE;;;GAGG;AACH,eAAO,MAAM,gCAAgC,QAAmB,CAAC;AAEjE,+EAA+E;AAC/E,eAAO,MAAM,iCAAiC,SAAS,CAAC;AAExD,eAAO,MAAM,cAAc,QAA+B,CAAC;AAE3D;;;GAGG;AACH,eAAO,MAAM,iBAAiB,QAAyB,CAAC;AAExD,eAAO,MAAM,sBAAsB,OAAO,CAAC;AAC3C,eAAO,MAAM,sBAAsB,QAA8B,CAAC;AAElE,eAAO,MAAM,yBAAyB,MAAM,CAAC;AAE7C,6FAA6F;AAC7F,eAAO,MAAM,gDAAgD,QAAQ,CAAC;AAEtE,4CAA4C;AAC5C,eAAO,MAAM,8BAA8B,QAA4B,CAAC;AAExE;;;GAGG;AACH,eAAO,MAAM,cAAc,KAAK,CAAC;AAEjC;;;;;GAKG;AACH,eAAO,MAAM,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAgB,CAAC;AAExD;;;;;GAKG;AACH,eAAO,MAAM,UAAU,EAAE,QAAQ,CAAC,MAAM,CAAgB,CAAC;AAEzD;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,EAAE,QAAQ,CAAC,KAAK,CAAkB,CAAC;AAE5D;;;;GAIG;AACH,eAAO,MAAM,aAAa,EAAE,QAAQ,CAAC,MAAM,CAAsB,CAAC"}

package/dist/src/core/constants.lua

@@ -115,13 +115,19 @@ ____exports.TELEPORTER_ACTIVATION_DISTANCE = ____exports.DISTANCE_OF_GRID_TILE /
 --- This is the number of draw coordinates that each heart spans on the UI in the upper left hand
 -- corner.
 ____exports.UI_HEART_WIDTH = 12
---- This is a safe version of the `Vector.One` constant. (Other mods can mutate `Vector.One`, so it
+--- Equal to `Vector(1, 1)`.
+-- 
+-- This is a safe version of the `Vector.One` constant. (Other mods can mutate `Vector.One`, so it
 -- is not safe to use.)
 ____exports.VectorOne = Vector(1, 1)
---- This is a safe version of the `Vector.Zero` constant. (Other mods can mutate `Vector.Zero`, so it
+--- Equal to `Vector(0, 0)`.
+-- 
+-- This is a safe version of the `Vector.Zero` constant. (Other mods can mutate `Vector.Zero`, so it
 -- is not safe to use.)
 ____exports.VectorZero = Vector(0, 0)
---- This is a safe version of the `Color.Default` constant. (Other mods can mutate `Color.Default`,
+--- Equal to `Color(1, 1, 1)`.
+-- 
+-- This is a safe version of the `Color.Default` constant. (Other mods can mutate `Color.Default`,
 -- so it is not safe to use.)
 -- 
 -- If you need to mutate this, make a copy first with the `copyColor` helper function.

package/package.json

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

package/src/classes/ModFeature.ts

@@ -82,8 +82,24 @@ export class ModFeature {
    * 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.
+   *
+   * The function has the following signature:
+   *
+   * ```ts
+   * (
+   *   vanilla: boolean, // Whether or not this is a vanilla or custom callback.
+   *   modCallback: ModCallback | ModCallbackCustom,
+   *   ...callbackArgs: unknown[]
+   * ) => boolean;
+   * ```
    */
-  protected callbackConditionalFunc: (() => boolean) | null = null;
+  protected callbackConditionalFunc:
+    | ((
+        vanilla: boolean,
+        modCallback: ModCallback | ModCallbackCustom,
+        ...callbackArgs: unknown[]
+      ) => boolean)
+    | null = null;
 
   /**
    * Whether or not the feature has registered its callbacks yet (and submitted its variables to the
@@ -205,13 +221,18 @@ function initDecoratedCallbacks(
         modFeature,
         modFeatureConstructor,
         mod,
-        modCallback,
+        modCallback, // eslint-disable-line isaacscript/strict-enums
         callback,
         parameters,
         vanilla,
       );
     } else {
-      removeCallback(modFeatureConstructor, mod, modCallback, vanilla);
+      removeCallback(
+        modFeatureConstructor,
+        mod,
+        modCallback, // eslint-disable-line isaacscript/strict-enums
+        vanilla,
+      );
     }
   }
 }
@@ -220,9 +241,8 @@ function addCallback(
   modFeature: ModFeature,
   modFeatureConstructor: ModFeatureConstructor,
   mod: ModUpgradedBase,
-  modCallback: unknown,
-  // eslint-disable-next-line @typescript-eslint/ban-types
-  callback: Function,
+  modCallback: ModCallback | ModCallbackCustom,
+  callback: Function, // eslint-disable-line @typescript-eslint/ban-types
   parameters: unknown[],
   vanilla: boolean,
 ) {
@@ -232,7 +252,7 @@ function addCallback(
     // eslint-disable-next-line @typescript-eslint/dot-notation
     const conditionalFunc = modFeature["callbackConditionalFunc"];
     if (conditionalFunc !== null) {
-      const shouldRun = conditionalFunc();
+      const shouldRun = conditionalFunc(vanilla, modCallback, ...callbackArgs);
       if (!shouldRun) {
         return undefined;
       }
@@ -284,7 +304,7 @@ function addCallback(
 function removeCallback(
   modFeatureConstructor: ModFeatureConstructor,
   mod: ModUpgradedBase,
-  modCallback: unknown,
+  modCallback: ModCallback | ModCallbackCustom,
   vanilla: boolean,
 ) {
   if (vanilla) {

package/src/core/constants.ts

@@ -190,18 +190,24 @@ export const TELEPORTER_ACTIVATION_DISTANCE = DISTANCE_OF_GRID_TILE / 2;
 export const UI_HEART_WIDTH = 12;
 
 /**
+ * Equal to `Vector(1, 1)`.
+ *
  * This is a safe version of the `Vector.One` constant. (Other mods can mutate `Vector.One`, so it
  * is not safe to use.)
  */
 export const VectorOne: Readonly<Vector> = Vector(1, 1);
 
 /**
+ * Equal to `Vector(0, 0)`.
+ *
  * This is a safe version of the `Vector.Zero` constant. (Other mods can mutate `Vector.Zero`, so it
  * is not safe to use.)
  */
 export const VectorZero: Readonly<Vector> = Vector(0, 0);
 
 /**
+ * Equal to `Color(1, 1, 1)`.
+ *
  * This is a safe version of the `Color.Default` constant. (Other mods can mutate `Color.Default`,
  * so it is not safe to use.)
  *