feat: POST_ENTITY_REMOVE_FILTER

Author: Zamiell

package.json

@@ -88,5 +88,6 @@
   },
   "devDependencies": {
     "eslint": "9.32.0"
-  }
+  },
+  "packageManager": "[email protected]+sha512.1fc009bc09d13cfd0e19efa44cbfc2b9cf6ca61482725eb35bbc5e257e093ebf4130db6dfe15d604ff4b79efd8e1e8e99b25fa7d0a6197c9f9826358d4d65c3c"
 }

packages/docs/docs/main/change-log.md

@@ -9,6 +9,11 @@ This page lists the changes to the IsaacScript framework.
 
 <br />
 
+## July 26th, 2024
+
+- Added the following custom callbacks:
+  - `POST_ENTITY_REMOVE_FILTER`
+
 ## September 11th, 2024
 
 - Breaking changes:

packages/isaacscript-common/src/callbackClasses.ts

@@ -25,6 +25,7 @@ export { PostEffectRenderFilter } from "./classes/callbacks/PostEffectRenderFilt
 export { PostEffectStateChanged } from "./classes/callbacks/PostEffectStateChanged";
 export { PostEffectUpdateFilter } from "./classes/callbacks/PostEffectUpdateFilter";
 export { PostEntityKillFilter } from "./classes/callbacks/PostEntityKillFilter";
+export { PostEntityRemoveFilter } from "./classes/callbacks/PostEntityRemoveFilter";
 export { PostEsauJr } from "./classes/callbacks/PostEsauJr";
 export { PostFamiliarInitFilter } from "./classes/callbacks/PostFamiliarInitFilter";
 export { PostFamiliarInitLate } from "./classes/callbacks/PostFamiliarInitLate";

packages/isaacscript-common/src/callbacks.ts

@@ -28,6 +28,7 @@ const MOD_CALLBACK_CUSTOM_TO_CLASS = {
   [ModCallbackCustom.POST_EFFECT_STATE_CHANGED]: cc.PostEffectStateChanged,
   [ModCallbackCustom.POST_EFFECT_UPDATE_FILTER]: cc.PostEffectUpdateFilter,
   [ModCallbackCustom.POST_ENTITY_KILL_FILTER]: cc.PostEntityKillFilter,
+  [ModCallbackCustom.POST_ENTITY_REMOVE_FILTER]: cc.PostEntityRemoveFilter,
   [ModCallbackCustom.POST_ESAU_JR]: cc.PostEsauJr,
   [ModCallbackCustom.POST_FAMILIAR_INIT_FILTER]: cc.PostFamiliarInitFilter,
   [ModCallbackCustom.POST_FAMILIAR_INIT_LATE]: cc.PostFamiliarInitLate,

packages/isaacscript-common/src/classes/callbacks/PostEntityRemoveFilter.ts

@@ -0,0 +1,22 @@
+import { ModCallback } from "isaac-typescript-definitions";
+import type { ModCallbackCustom } from "../../enums/ModCallbackCustom";
+import { shouldFireEntity } from "../../shouldFire";
+import { CustomCallback } from "../private/CustomCallback";
+
+export class PostEntityRemoveFilter extends CustomCallback<ModCallbackCustom.POST_ENTITY_REMOVE_FILTER> {
+  constructor() {
+    super();
+
+    this.callbacksUsed = [
+      // 67
+      [ModCallback.POST_ENTITY_REMOVE, this.postEntityRemove],
+    ];
+  }
+
+  protected override shouldFire = shouldFireEntity;
+
+  // ModCallback.POST_ENTITY_REMOVE (67)
+  private readonly postEntityRemove = (entity: Entity) => {
+    this.fire(entity);
+  };
+}

packages/isaacscript-common/src/enums/ModCallbackCustom.ts

@@ -415,6 +415,24 @@ export enum ModCallbackCustom {
    */
   POST_ENTITY_KILL_FILTER,
 
+  /**
+   * The exact same thing as the vanilla `POST_ENTITY_REMOVE` callback, except this callback allows
+   * you to specify extra arguments for additional filtration.
+   *
+   * When registering the callback with the `ModUpgraded.AddCallbackCustom` method:
+   * - You can provide an optional third argument that will make the callback only fire if it
+   *   matches the `EntityType` provided.
+   * - You can provide an optional fourth argument that will make the callback only fire if it
+   *   matches the variant provided.
+   * - You can provide an optional fifth argument that will make the callback only fire if it
+   *   matches the sub-type provided.
+   *
+   * ```ts
+   * function postEntityRemoveFilter(entity: Entity): void {}
+   * ```
+   */
+  POST_ENTITY_REMOVE_FILTER,
+
   /**
    * Fires one `POST_UPDATE` frame after the player has used the Esau Jr. item. (The player is not
    * updated to the new character until a game frame has passed.)

packages/isaacscript-common/src/interfaces/private/AddCallbackParametersCustom.ts

@@ -215,6 +215,13 @@ export interface AddCallbackParametersCustom {
     subType?: int,
   ];
 
+  [ModCallbackCustom.POST_ENTITY_REMOVE_FILTER]: [
+    callback: (entity: Entity) => void,
+    entityType?: EntityType,
+    variant?: int,
+    subType?: int,
+  ];
+
   // - Co-op babies cannot turn into Esau Jr, so it does not make sense to filter by
   //   `PlayerVariant`.
   // - The character of Esau Jr. is equal to `PlayerType.ISAAC`, so it does not make sense to filter