isaacscript-common 18.1.0 → 18.2.1

package/src/enums/ModCallbackCustom.ts

@@ -30,9 +30,41 @@ export enum ModCallbackCustom {
    *   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 entityTakeDmgFilter(
+   *   entity: Entity,
+   *   amount: float,
+   *   damageFlags: BitFlags<DamageFlag>,
+   *   source: EntityRef,
+   *   countdownFrames: int,
+   * ): boolean | undefined {}
+   * ```
    */
   ENTITY_TAKE_DMG_FILTER,
 
+  /**
+   * The exact same thing as the vanilla `ENTITY_TAKE_DMG` callback, except this callback
+   * automatically filters for `EntityType.ENTITY_PLAYER` and casts the `Entity` object to a
+   * `EntityPlayer`.
+   *
+   * - You can provide an optional third argument that will make the callback only fire if it
+   *   matches the `PlayerVariant` provided.
+   * - You can provide an optional fourth argument that will make the callback only fire if it
+   *   matches the `PlayerType` provided.
+   *
+   * ```ts
+   * function entityTakeDmgPlayer(
+   *   player: EntityPlayer,
+   *   amount: float,
+   *   damageFlags: BitFlags<DamageFlag>,
+   *   source: EntityRef,
+   *   countdownFrames: int,
+   * ): boolean | undefined {}
+   * ```
+   */
+  ENTITY_TAKE_DMG_PLAYER,
+
   /**
    * 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.
@@ -836,6 +868,10 @@ export enum ModCallbackCustom {
    *   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 postNPCDeathFilter(npc: EntityNPC): void {}
+   * ```
    */
   POST_NPC_DEATH_FILTER,
 
@@ -850,6 +886,10 @@ export enum ModCallbackCustom {
    *   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 postNPCInitFilter(npc: EntityNPC): void {}
+   * ```
    */
   POST_NPC_INIT_FILTER,
 
@@ -884,6 +924,10 @@ export enum ModCallbackCustom {
    *   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 postNPCRenderFilter(npc: EntityNPC, renderOffset: Vector): void {}
+   * ```
    */
   POST_NPC_RENDER_FILTER,
 
@@ -920,6 +964,10 @@ export enum ModCallbackCustom {
    *   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 postNPCUpdateFilter(npc: EntityNPC): void {}
+   * ```
    */
   POST_NPC_UPDATE_FILTER,
 
@@ -1767,6 +1815,14 @@ export enum ModCallbackCustom {
    *   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 preNPCCollisionFilter(
+   *   npc: EntityNPC,
+   *   collider: Entity,
+   *   low: boolean,
+   * ): boolean | undefined {}
+   * ```
    */
   PRE_NPC_COLLISION_FILTER,
 
@@ -1781,6 +1837,10 @@ export enum ModCallbackCustom {
    *   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 preNPCUpdateFilter(entity: Entity): boolean | undefined {}
+   * ```
    */
   PRE_NPC_UPDATE_FILTER,
 }

package/src/interfaces/private/AddCallbackParametersCustom.ts

@@ -51,6 +51,18 @@ export interface AddCallbackParametersCustom {
     subType?: number,
   ];
 
+  [ModCallbackCustom.ENTITY_TAKE_DMG_PLAYER]: [
+    callback: (
+      player: EntityPlayer,
+      amount: float,
+      damageFlags: BitFlags<DamageFlag>,
+      source: EntityRef,
+      countdownFrames: int,
+    ) => boolean | undefined,
+    playerVariant?: PlayerVariant,
+    character?: PlayerType,
+  ];
+
   [ModCallbackCustom.POST_AMBUSH_FINISHED]: [
     callback: (ambushType: AmbushType) => void,
     ambushType?: AmbushType,