isaacscript-common 15.3.7 → 15.4.0

package/src/classes/callbacks/EntityTakeDmgFilter.ts

@@ -0,0 +1,25 @@
+import { DamageFlag, ModCallback } from "isaac-typescript-definitions";
+import { ModCallbackCustom } from "../../enums/ModCallbackCustom";
+import { shouldFireEntity } from "../../shouldFire";
+import { CustomCallback } from "../private/CustomCallback";
+
+export class EntityTakeDmgFilter extends CustomCallback<ModCallbackCustom.ENTITY_TAKE_DMG_FILTER> {
+  constructor() {
+    super();
+
+    this.callbacksUsed = [
+      [ModCallback.ENTITY_TAKE_DMG, [this.entityTakeDmg]], // 11
+    ];
+  }
+
+  protected override shouldFire = shouldFireEntity;
+
+  // ModCallback.ENTITY_TAKE_DMG (11)
+  private entityTakeDmg = (
+    entity: Entity,
+    amount: number,
+    damageFlags: BitFlags<DamageFlag>,
+    source: EntityRef,
+    countdownFrames: number,
+  ) => this.fire(entity, amount, damageFlags, source, countdownFrames);
+}

package/src/classes/callbacks/PostGridEntityCollision.ts

@@ -12,7 +12,7 @@ export class PostGridEntityCollision extends CustomCallback<T> {
   constructor() {
     super();
 
-    this.featuresUsed = [ISCFeature.GRID_ENTITY_UPDATE_DETECTION];
+    this.featuresUsed = [ISCFeature.GRID_ENTITY_COLLISION_DETECTION];
   }
 
   // eslint-disable-next-line class-methods-use-this

package/src/classes/callbacks/PostGridEntityCustomCollision.ts

@@ -12,7 +12,7 @@ export class PostGridEntityCustomCollision extends CustomCallback<T> {
   constructor() {
     super();
 
-    this.featuresUsed = [ISCFeature.GRID_ENTITY_UPDATE_DETECTION];
+    this.featuresUsed = [ISCFeature.GRID_ENTITY_COLLISION_DETECTION];
   }
 
   // eslint-disable-next-line class-methods-use-this

package/src/classes/callbacks/PostNPCDeathFilter.ts

@@ -0,0 +1,21 @@
+import { ModCallback } from "isaac-typescript-definitions";
+import { ModCallbackCustom } from "../../enums/ModCallbackCustom";
+import { shouldFireNPC } from "../../shouldFire";
+import { CustomCallback } from "../private/CustomCallback";
+
+export class PostNPCDeathFilter extends CustomCallback<ModCallbackCustom.POST_NPC_DEATH_FILTER> {
+  constructor() {
+    super();
+
+    this.callbacksUsed = [
+      [ModCallback.POST_NPC_DEATH, [this.postNPCRender]], // 29
+    ];
+  }
+
+  protected override shouldFire = shouldFireNPC;
+
+  // ModCallback.POST_NPC_DEATH (29)
+  private postNPCRender = (npc: EntityNPC) => {
+    this.fire(npc);
+  };
+}

package/src/classes/callbacks/PostNPCRenderFilter.ts

@@ -0,0 +1,21 @@
+import { ModCallback } from "isaac-typescript-definitions";
+import { ModCallbackCustom } from "../../enums/ModCallbackCustom";
+import { shouldFireNPC } from "../../shouldFire";
+import { CustomCallback } from "../private/CustomCallback";
+
+export class PostNPCRenderFilter extends CustomCallback<ModCallbackCustom.POST_NPC_RENDER_FILTER> {
+  constructor() {
+    super();
+
+    this.callbacksUsed = [
+      [ModCallback.POST_NPC_RENDER, [this.postNPCRender]], // 28
+    ];
+  }
+
+  protected override shouldFire = shouldFireNPC;
+
+  // ModCallback.POST_NPC_RENDER (28)
+  private postNPCRender = (npc: EntityNPC, renderOffset: Vector) => {
+    this.fire(npc, renderOffset);
+  };
+}

package/src/classes/callbacks/PreNPCCollisionFilter.ts

@@ -0,0 +1,20 @@
+import { ModCallback } from "isaac-typescript-definitions";
+import { ModCallbackCustom } from "../../enums/ModCallbackCustom";
+import { shouldFireNPC } from "../../shouldFire";
+import { CustomCallback } from "../private/CustomCallback";
+
+export class PreNPCCollisionFilter extends CustomCallback<ModCallbackCustom.PRE_NPC_COLLISION_FILTER> {
+  constructor() {
+    super();
+
+    this.callbacksUsed = [
+      [ModCallback.PRE_NPC_COLLISION, [this.preNPCCollision]], // 30
+    ];
+  }
+
+  protected override shouldFire = shouldFireNPC;
+
+  // ModCallback.PRE_NPC_COLLISION (30)
+  private preNPCCollision = (npc: EntityNPC, collider: Entity, low: boolean) =>
+    this.fire(npc, collider, low);
+}

package/src/classes/callbacks/PreNPCUpdateFilter.ts

@@ -0,0 +1,19 @@
+import { ModCallback } from "isaac-typescript-definitions";
+import { ModCallbackCustom } from "../../enums/ModCallbackCustom";
+import { shouldFireNPC } from "../../shouldFire";
+import { CustomCallback } from "../private/CustomCallback";
+
+export class PreNPCUpdateFilter extends CustomCallback<ModCallbackCustom.PRE_NPC_UPDATE_FILTER> {
+  constructor() {
+    super();
+
+    this.callbacksUsed = [
+      [ModCallback.PRE_NPC_UPDATE, [this.preNPCUpdate]], // 69
+    ];
+  }
+
+  protected override shouldFire = shouldFireNPC;
+
+  // ModCallback.PRE_NPC_UPDATE (69)
+  private preNPCUpdate = (npc: EntityNPC) => this.fire(npc);
+}

package/src/enums/ModCallbackCustom.ts

@@ -19,6 +19,20 @@ eslint isaacscript/member-ordering: [
  * - You must upgrade your mod with the `upgradeMod` helper function before using a custom callback.
  */
 export enum ModCallbackCustom {
+  /**
+   * The exact same thing as the vanilla `ENTITY_TAKE_DMG` 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.
+   */
+  ENTITY_TAKE_DMG_FILTER,
+
   /**
    * Fires from the `POST_UPDATE` callback when a Challenge Room or Boss Rush is started.
    * Specifically, this happens on the first frame that `Room.IsAmbushDone` is true.
@@ -811,6 +825,20 @@ export enum ModCallbackCustom {
    */
   POST_NEW_ROOM_REORDERED,
 
+  /**
+   * The exact same thing as the vanilla `POST_NPC_DEATH` 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.
+   */
+  POST_NPC_DEATH_FILTER,
+
   /**
    * The exact same thing as the vanilla `POST_NPC_INIT` callback, except this callback allows you
    * to specify extra arguments for additional filtration.
@@ -845,6 +873,20 @@ export enum ModCallbackCustom {
    */
   POST_NPC_INIT_LATE,
 
+  /**
+   * The exact same thing as the vanilla `POST_NPC_RENDER` 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.
+   */
+  POST_NPC_RENDER_FILTER,
+
   /**
    * Fires from the `POST_NPC_UPDATE` callback when an NPC's state has changed from what it was on
    * the previous frame. (In this context, "state" refers to the `EntityNPC.State` field.)
@@ -1710,4 +1752,32 @@ export enum ModCallbackCustom {
    * ```
    */
   PRE_NEW_LEVEL,
+
+  /**
+   * The exact same thing as the vanilla `PRE_NPC_COLLISION` 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.
+   */
+  PRE_NPC_COLLISION_FILTER,
+
+  /**
+   * The exact same thing as the vanilla `PRE_NPC_UPDATE` 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.
+   */
+  PRE_NPC_UPDATE_FILTER,
 }

package/src/interfaces/private/AddCallbackParametersCustom.ts

@@ -38,6 +38,19 @@ import {
 import { StatTypeType } from "../StatTypeType";
 
 export interface AddCallbackParametersCustom {
+  [ModCallbackCustom.ENTITY_TAKE_DMG_FILTER]: [
+    callback: (
+      entity: Entity,
+      amount: float,
+      damageFlags: BitFlags<DamageFlag>,
+      source: EntityRef,
+      countdownFrames: int,
+    ) => boolean | undefined,
+    entityType?: EntityType,
+    variant?: number,
+    subType?: number,
+  ];
+
   [ModCallbackCustom.POST_AMBUSH_FINISHED]: [
     callback: (ambushType: AmbushType) => void,
     ambushType?: AmbushType,
@@ -334,6 +347,13 @@ export interface AddCallbackParametersCustom {
 
   [ModCallbackCustom.POST_NEW_ROOM_REORDERED]: [callback: () => void];
 
+  [ModCallbackCustom.POST_NPC_DEATH_FILTER]: [
+    callback: (npc: EntityNPC) => void,
+    entityType?: EntityType,
+    variant?: int,
+    subType?: int,
+  ];
+
   [ModCallbackCustom.POST_NPC_INIT_FILTER]: [
     callback: (npc: EntityNPC) => void,
     entityType?: EntityType,
@@ -348,6 +368,13 @@ export interface AddCallbackParametersCustom {
     subType?: int,
   ];
 
+  [ModCallbackCustom.POST_NPC_RENDER_FILTER]: [
+    callback: (npc: EntityNPC, renderOffset: Vector) => void,
+    entityType?: EntityType,
+    variant?: int,
+    subType?: int,
+  ];
+
   [ModCallbackCustom.POST_NPC_STATE_CHANGED]: [
     callback: (npc: EntityNPC, previousState: int, currentState: int) => void,
     entityType?: EntityType,
@@ -669,6 +696,24 @@ export interface AddCallbackParametersCustom {
       ];
 
   [ModCallbackCustom.PRE_NEW_LEVEL]: [callback: (player: EntityPlayer) => void];
+
+  [ModCallbackCustom.PRE_NPC_COLLISION_FILTER]: [
+    callback: (
+      npc: EntityNPC,
+      collider: Entity,
+      low: boolean,
+    ) => undefined | boolean,
+    entityType?: EntityType,
+    variant?: int,
+    subType?: int,
+  ];
+
+  [ModCallbackCustom.PRE_NPC_UPDATE_FILTER]: [
+    callback: (npc: EntityNPC) => undefined | boolean,
+    entityType?: EntityType,
+    variant?: int,
+    subType?: int,
+  ];
 }
 
 validateInterfaceMatchesEnum<AddCallbackParametersCustom, ModCallbackCustom>();

package/src/shouldFire.ts

@@ -124,6 +124,28 @@ export function shouldFireEffect(
   );
 }
 
+export function shouldFireEntity(
+  fireArgs:
+    | [entity: Entity]
+    | [
+        entity: Entity,
+        amount: number,
+        damageFlags: BitFlags<DamageFlag>,
+        source: EntityRef,
+        countdownFrames: number,
+      ],
+  optionalArgs: [entityType?: EntityType, variant?: int, subType?: int],
+): boolean {
+  const [entity] = fireArgs;
+  const [callbackEntityType, callbackVariant, callbackSubType] = optionalArgs;
+
+  return (
+    (callbackEntityType === undefined || callbackEntityType === entity.Type) &&
+    (callbackVariant === undefined || callbackVariant === entity.Variant) &&
+    (callbackSubType === undefined || callbackSubType === entity.SubType)
+  );
+}
+
 export function shouldFireFamiliar(
   fireArgs:
     | [familiar: EntityFamiliar]
@@ -225,7 +247,9 @@ export function shouldFireLaser(
 export function shouldFireNPC(
   fireArgs:
     | [npc: EntityNPC]
-    | [npc: EntityNPC, previousState: int, currentState: int],
+    | [npc: EntityNPC, previousState: int, currentState: int]
+    | [npc: EntityNPC, renderOffset: Vector]
+    | [npc: EntityNPC, collider: Entity, low: boolean],
   optionalArgs: [entityType?: EntityType, variant?: int, subType?: int],
 ): boolean {
   const [npc] = fireArgs;