isaacscript-common 19.1.1 → 20.1.0

package/dist/index.d.ts

@@ -4287,8 +4287,13 @@ export declare function getCircleDiscretizedPoints(centerPos: Vector, radius: fl
  * const gapers = getEntities(EntityType.GAPER);
  * const closestGaper = getClosestEntityTo(player, gapers);
  * ```
+ *
+ * @param referenceEntity The entity that is close by.
+ * @param entities The array of entities to look through.
+ * @param filterFunc Optional. A function to filter for a specific type of entity, like e.g. an
+ *                   enemy with a certain amount of HP left.
  */
-export declare function getClosestEntityTo<T extends AnyEntity>(referenceEntity: Entity, entities: T[]): T | undefined;
+export declare function getClosestEntityTo<T extends AnyEntity>(referenceEntity: Entity, entities: T[], filterFunc?: (entity: T) => boolean): T | undefined;
 
 export declare function getClosestPlayer(position: Vector): EntityPlayer;
 
@@ -11294,26 +11299,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.1.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -19478,12 +19478,12 @@ function ____exports.doesEntityExist(self, entityType, variant, subType, ignoreF
     )
     return count > 0
 end
-function ____exports.getClosestEntityTo(self, referenceEntity, entities)
+function ____exports.getClosestEntityTo(self, referenceEntity, entities, filterFunc)
     local closestEntity
     local closestDistance = math.huge
     for ____, entity in ipairs(entities) do
         local distance = referenceEntity.Position:Distance(entity.Position)
-        if distance < closestDistance then
+        if distance < closestDistance and (filterFunc == nil or filterFunc(nil, entity)) then
             closestEntity = entity
             closestDistance = distance
         end
@@ -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/dist/src/functions/entities.d.ts

@@ -34,8 +34,13 @@ export declare function doesEntityExist(entityType?: EntityType, variant?: numbe
  * const gapers = getEntities(EntityType.GAPER);
  * const closestGaper = getClosestEntityTo(player, gapers);
  * ```
+ *
+ * @param referenceEntity The entity that is close by.
+ * @param entities The array of entities to look through.
+ * @param filterFunc Optional. A function to filter for a specific type of entity, like e.g. an
+ *                   enemy with a certain amount of HP left.
  */
-export declare function getClosestEntityTo<T extends AnyEntity>(referenceEntity: Entity, entities: T[]): T | undefined;
+export declare function getClosestEntityTo<T extends AnyEntity>(referenceEntity: Entity, entities: T[], filterFunc?: (entity: T) => boolean): T | undefined;
 /** Helper function to get the entity type, variant, and sub-type from an `EntityID`. */
 export declare function getConstituentsFromEntityID(entityID: EntityID): [entityType: EntityType, variant: int, subType: int];
 /**

package/dist/src/functions/entities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../src/functions/entities.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAK1D,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAkB7C;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CAC3B,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,GAAG,CAcL;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC7B,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,OAAO,CAGT;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,SAAS,EACpD,eAAe,EAAE,MAAM,EACvB,QAAQ,EAAE,CAAC,EAAE,GACZ,CAAC,GAAG,SAAS,CAaf;AAED,wFAAwF;AACxF,wBAAgB,2BAA2B,CACzC,QAAQ,EAAE,QAAQ,GACjB,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,CAAC,CA0BtD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,WAAW,CACzB,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,MAAM,EAAE,CAMV;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,MAAM,GACb,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC,CA8B3C;AA0BD;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAGzE;AAED,2FAA2F;AAC3F,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,QAAQ,CAEpD;AAED;;GAEG;AACH,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,GACX,QAAQ,CAEV;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,SAAS,EACxD,WAAW,EAAE,CAAC,EAAE,EAChB,WAAW,EAAE,CAAC,EAAE,GACf,CAAC,EAAE,CAWL;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAGhD;AAED;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,SAAO,GAAG,OAAO,CAExE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAE3D;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAC3B,QAAQ,EAAE,MAAM,GACf,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,CAAC,GAAG,SAAS,CAwBlE;AAED;;;;;;;GAOG;AACH,wBAAgB,4BAA4B,CAC1C,uBAAuB,EAAE,MAAM,GAC9B,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,CAAC,GAAG,SAAS,CAmBpD;AAED;;;;;;;;;GASG;AACH,wBAAgB,yBAAyB,CACvC,UAAU,EAAE,UAAU,EACtB,aAAa,SAAK,EAClB,aAAa,SAAK,EAClB,GAAG,GAAE,GAAG,GAAG,SAAqB,GAC/B,MAAM,EAAE,CAGV;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,SAAS,EAChD,QAAQ,EAAE,CAAC,EAAE,EACb,GAAG,CAAC,EAAE,GAAG,GACR,CAAC,EAAE,CAgBL;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAgB9D;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAEzD;AAED,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CASzD;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,KAAK,CACnB,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,mBAAmB,EAAE,MAAM,GAAG,GAAG,EACjC,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,EACvC,SAAS,GAAE,IAAI,GAAG,GAAG,GAAG,SAAqB,GAC5C,MAAM,CA4CR;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,aAAa,CAC3B,QAAQ,EAAE,QAAQ,EAClB,mBAAmB,EAAE,MAAM,GAAG,GAAG,EACjC,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,EACvC,SAAS,GAAE,IAAI,GAAG,GAAG,GAAG,SAAqB,GAC5C,MAAM,CAWR;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAC3B,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,mBAAmB,EAAE,MAAM,GAAG,GAAG,EACjC,SAAS,EAAE,IAAI,GAAG,GAAG,EACrB,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,GACtC,MAAM,CAUR"}
+{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../src/functions/entities.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAK1D,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAkB7C;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CAC3B,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,GAAG,CAcL;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC7B,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,OAAO,CAGT;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,SAAS,EACpD,eAAe,EAAE,MAAM,EACvB,QAAQ,EAAE,CAAC,EAAE,EACb,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,OAAO,GAClC,CAAC,GAAG,SAAS,CAgBf;AAED,wFAAwF;AACxF,wBAAgB,2BAA2B,CACzC,QAAQ,EAAE,QAAQ,GACjB,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,CAAC,CA0BtD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,WAAW,CACzB,UAAU,GAAE,UAAe,EAC3B,OAAO,SAAK,EACZ,OAAO,SAAK,EACZ,cAAc,UAAQ,GACrB,MAAM,EAAE,CAMV;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,MAAM,GACb,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC,CA8B3C;AA0BD;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAGzE;AAED,2FAA2F;AAC3F,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,QAAQ,CAEpD;AAED;;GAEG;AACH,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,GACX,QAAQ,CAEV;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,SAAS,EACxD,WAAW,EAAE,CAAC,EAAE,EAChB,WAAW,EAAE,CAAC,EAAE,GACf,CAAC,EAAE,CAWL;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAGhD;AAED;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,SAAO,GAAG,OAAO,CAExE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAE3D;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAC3B,QAAQ,EAAE,MAAM,GACf,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,CAAC,GAAG,SAAS,CAwBlE;AAED;;;;;;;GAOG;AACH,wBAAgB,4BAA4B,CAC1C,uBAAuB,EAAE,MAAM,GAC9B,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,CAAC,GAAG,SAAS,CAmBpD;AAED;;;;;;;;;GASG;AACH,wBAAgB,yBAAyB,CACvC,UAAU,EAAE,UAAU,EACtB,aAAa,SAAK,EAClB,aAAa,SAAK,EAClB,GAAG,GAAE,GAAG,GAAG,SAAqB,GAC/B,MAAM,EAAE,CAGV;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,SAAS,EAChD,QAAQ,EAAE,CAAC,EAAE,EACb,GAAG,CAAC,EAAE,GAAG,GACR,CAAC,EAAE,CAgBL;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAgB9D;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAEzD;AAED,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CASzD;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,KAAK,CACnB,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,mBAAmB,EAAE,MAAM,GAAG,GAAG,EACjC,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,EACvC,SAAS,GAAE,IAAI,GAAG,GAAG,GAAG,SAAqB,GAC5C,MAAM,CA4CR;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,aAAa,CAC3B,QAAQ,EAAE,QAAQ,EAClB,mBAAmB,EAAE,MAAM,GAAG,GAAG,EACjC,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,EACvC,SAAS,GAAE,IAAI,GAAG,GAAG,GAAG,SAAqB,GAC5C,MAAM,CAWR;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAC3B,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,GAAG,EACZ,mBAAmB,EAAE,MAAM,GAAG,GAAG,EACjC,SAAS,EAAE,IAAI,GAAG,GAAG,EACrB,QAAQ,GAAE,MAAmB,EAC7B,OAAO,GAAE,MAAM,GAAG,SAAqB,GACtC,MAAM,CAUR"}

package/dist/src/functions/entities.lua

@@ -143,12 +143,17 @@ end
 -- const gapers = getEntities(EntityType.GAPER);
 -- const closestGaper = getClosestEntityTo(player, gapers);
 -- ```
-function ____exports.getClosestEntityTo(self, referenceEntity, entities)
+-- 
+-- @param referenceEntity The entity that is close by.
+-- @param entities The array of entities to look through.
+-- @param filterFunc Optional. A function to filter for a specific type of entity, like e.g. an
+-- enemy with a certain amount of HP left.
+function ____exports.getClosestEntityTo(self, referenceEntity, entities, filterFunc)
     local closestEntity
     local closestDistance = math.huge
     for ____, entity in ipairs(entities) do
         local distance = referenceEntity.Position:Distance(entity.Position)
-        if distance < closestDistance then
+        if distance < closestDistance and (filterFunc == nil or filterFunc(nil, entity)) then
             closestEntity = entity
             closestDistance = distance
         end

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "19.1.1",
+  "version": "20.1.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) {

package/src/functions/entities.ts

@@ -83,17 +83,26 @@ export function doesEntityExist(
  * const gapers = getEntities(EntityType.GAPER);
  * const closestGaper = getClosestEntityTo(player, gapers);
  * ```
+ *
+ * @param referenceEntity The entity that is close by.
+ * @param entities The array of entities to look through.
+ * @param filterFunc Optional. A function to filter for a specific type of entity, like e.g. an
+ *                   enemy with a certain amount of HP left.
  */
 export function getClosestEntityTo<T extends AnyEntity>(
   referenceEntity: Entity,
   entities: T[],
+  filterFunc?: (entity: T) => boolean,
 ): T | undefined {
   let closestEntity: T | undefined;
   let closestDistance = math.huge;
   for (const entity of entities) {
     const distance = referenceEntity.Position.Distance(entity.Position);
 
-    if (distance < closestDistance) {
+    if (
+      distance < closestDistance &&
+      (filterFunc === undefined || filterFunc(entity))
+    ) {
       closestEntity = entity;
       closestDistance = distance;
     }