isaacscript-common 27.12.0 → 27.13.0

package/src/enums/ModCallbackCustom.ts

@@ -964,6 +964,22 @@ export enum ModCallbackCustom {
    */
   POST_KEYBOARD_CHANGED,
 
+  /**
+   * The exact same thing as the vanilla `POST_KNIFE_INIT` 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 `KnifeVariant` provided.
+   * - You can provide an optional fourth argument that will make the callback only fire if it
+   *   matches the sub-type provided.
+   *
+   * ```ts
+   * function postKnifeInitFilter(knife: EntityKnife): void {}
+   * ```
+   */
+  POST_KNIFE_INIT_FILTER,
+
   /**
    * Fires on the first `POST_KNIFE_UPDATE` frame for each knife.
    *
@@ -982,6 +998,38 @@ export enum ModCallbackCustom {
    */
   POST_KNIFE_INIT_LATE,
 
+  /**
+   * The exact same thing as the vanilla `POST_KNIFE_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 `KnifeVariant` provided.
+   * - You can provide an optional fourth argument that will make the callback only fire if it
+   *   matches the sub-type provided.
+   *
+   * ```ts
+   * function postKnifeRenderFilter(knife: EntityKnife, renderOffset: Vector): void {}
+   * ```
+   */
+  POST_KNIFE_RENDER_FILTER,
+
+  /**
+   * The exact same thing as the vanilla `POST_KNIFE_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 `KnifeVariant` provided.
+   * - You can provide an optional fourth argument that will make the callback only fire if it
+   *   matches the sub-type provided.
+   *
+   * ```ts
+   * function postKnifeUpdateFilter(knife: EntityKnife): void {}
+   * ```
+   */
+  POST_KNIFE_UPDATE_FILTER,
+
   /**
    * The exact same thing as the vanilla `POST_LASER_INIT` callback, except this callback allows you
    * to specify extra arguments for additional filtration.
@@ -2216,6 +2264,26 @@ export enum ModCallbackCustom {
    */
   PRE_ITEM_PICKUP,
 
+  /**
+   * The exact same thing as the vanilla `PRE_KNIFE_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 `KnifeVariant` provided.
+   * - You can provide an optional fourth argument that will make the callback only fire if it
+   *   matches the sub-type provided.
+   *
+   * ```ts
+   * function preKnifeCollisionFilter(
+   *   knife: EntityKnife,
+   *   collider: Entity,
+   *   low: boolean,
+   * ): void {}
+   * ```
+   */
+  PRE_KNIFE_COLLISION_FILTER,
+
   /**
    * Fires on the `POST_RENDER` frame before the player is taken to a new floor. Only fires when a
    * player jumps into a trapdoor or enters a heaven door (beam of light). Does not fire on the

package/src/interfaces/private/AddCallbackParametersCustom.ts

@@ -423,12 +423,30 @@ export interface AddCallbackParametersCustom {
     pressed?: boolean,
   ];
 
+  [ModCallbackCustom.POST_KNIFE_INIT_FILTER]: [
+    callback: (knife: EntityKnife) => void,
+    knifeVariant?: KnifeVariant,
+    subType?: int,
+  ];
+
   [ModCallbackCustom.POST_KNIFE_INIT_LATE]: [
     callback: (knife: EntityKnife) => void,
     knifeVariant?: KnifeVariant,
     subType?: int,
   ];
 
+  [ModCallbackCustom.POST_KNIFE_RENDER_FILTER]: [
+    callback: (knife: EntityKnife, renderOffset: Vector) => void,
+    knifeVariant?: KnifeVariant,
+    subType?: int,
+  ];
+
+  [ModCallbackCustom.POST_KNIFE_UPDATE_FILTER]: [
+    callback: (knife: EntityKnife) => void,
+    knifeVariant?: KnifeVariant,
+    subType?: int,
+  ];
+
   [ModCallbackCustom.POST_LASER_INIT_FILTER]: [
     callback: (laser: EntityLaser) => void,
     laserVariant?: LaserVariant,
@@ -882,6 +900,16 @@ export interface AddCallbackParametersCustom {
         trinketType?: TrinketType,
       ];
 
+  [ModCallbackCustom.PRE_KNIFE_COLLISION_FILTER]: [
+    callback: (
+      knife: EntityKnife,
+      collider: Entity,
+      low: boolean,
+    ) => boolean | undefined,
+    knifeVariant?: KnifeVariant,
+    subtype?: int,
+  ];
+
   [ModCallbackCustom.PRE_NEW_LEVEL]: [callback: (player: EntityPlayer) => void];
 
   [ModCallbackCustom.PRE_NPC_COLLISION_FILTER]: [

package/src/shouldFire.ts

@@ -231,7 +231,10 @@ export function shouldFireItemPickup(
 }
 
 export function shouldFireKnife(
-  fireArgs: [knife: EntityKnife],
+  fireArgs:
+    | [knife: EntityKnife]
+    | [knife: EntityKnife, renderOffset: Vector]
+    | [knife: EntityKnife, collider: Entity, low: boolean],
   optionalArgs: [knifeVariant?: KnifeVariant, subType?: int],
 ): boolean {
   const [knife] = fireArgs;