isaacscript-common 18.2.0 → 18.3.0

package/src/enums/ModCallbackCustom.ts

@@ -30,6 +30,16 @@ 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,
 
@@ -42,9 +52,63 @@ export enum ModCallbackCustom {
    *   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,
 
+  /**
+   * The exact same thing as the vanilla `INPUT_ACTION` 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 `InputHook` provided.
+   * - You can provide an optional fourth argument that will make the callback only fire if it
+   *   matches the `ButtonAction` provided.
+   *
+   * ```ts
+   * function inputActionFilter(
+   *   entity: Entity | undefined,
+   *   inputHook: InputHook,
+   *   buttonAction: ButtonAction,
+   * ): boolean | undefined {}
+   * ```
+   */
+  INPUT_ACTION_FILTER,
+
+  /**
+   * The exact same thing as the vanilla `INPUT_ACTION` callback, except this callback automatically
+   * filters for `EntityType.ENTITY_PLAYER` and casts the `Entity` object to a `EntityPlayer`. It
+   * also allows you to specify extra arguments for additional filtration.
+   *
+   * - 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.
+   * - You can provide an optional fifth argument that will make the callback only fire if it
+   *   matches the `InputHook` provided.
+   * - You can provide an optional sixth argument that will make the callback only fire if it
+   *   matches the `ButtonAction` provided.
+   *
+   * ```ts
+   * function inputActionPlayer(
+   *   player: EntityPlayer,
+   *   inputHook: InputHook,
+   *   buttonAction: ButtonAction,
+   * ): boolean | undefined {}
+   * ```
+   */
+  INPUT_ACTION_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.
@@ -848,6 +912,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,
 
@@ -862,6 +930,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,
 
@@ -896,6 +968,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,
 
@@ -932,6 +1008,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,
 
@@ -1779,6 +1859,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,
 
@@ -1793,6 +1881,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

@@ -1,6 +1,7 @@
 import {
   ActiveSlot,
   BombVariant,
+  ButtonAction,
   CollectibleType,
   DamageFlag,
   DiceFloorSubType,
@@ -9,6 +10,7 @@ import {
   EntityType,
   FamiliarVariant,
   GridEntityType,
+  InputHook,
   ItemType,
   KnifeVariant,
   LaserVariant,
@@ -63,6 +65,28 @@ export interface AddCallbackParametersCustom {
     character?: PlayerType,
   ];
 
+  [ModCallbackCustom.INPUT_ACTION_FILTER]: [
+    callback: (
+      entity: Entity | undefined,
+      inputHook: InputHook,
+      buttonAction: ButtonAction,
+    ) => boolean | float | undefined,
+    inputHook?: InputHook,
+    buttonAction?: ButtonAction,
+  ];
+
+  [ModCallbackCustom.INPUT_ACTION_PLAYER]: [
+    callback: (
+      player: EntityPlayer,
+      inputHook: InputHook,
+      buttonAction: ButtonAction,
+    ) => boolean | float | undefined,
+    playerVariant?: PlayerVariant,
+    character?: PlayerType,
+    inputHook?: InputHook,
+    buttonAction?: ButtonAction,
+  ];
+
   [ModCallbackCustom.POST_AMBUSH_FINISHED]: [
     callback: (ambushType: AmbushType) => void,
     ambushType?: AmbushType,