isaacscript-common 18.2.1 → 18.3.0

package/dist/index.d.ts

@@ -36,6 +36,7 @@ import { GridCollisionClass } from 'isaac-typescript-definitions';
 import { GridEntityType } from 'isaac-typescript-definitions';
 import { GridEntityXMLType } from 'isaac-typescript-definitions';
 import { HeartSubType } from 'isaac-typescript-definitions';
+import { InputHook } from 'isaac-typescript-definitions';
 import { ItemConfigCardType } from 'isaac-typescript-definitions';
 import { ItemConfigChargeType } from 'isaac-typescript-definitions';
 import { ItemConfigPillEffectClass } from 'isaac-typescript-definitions';
@@ -96,6 +97,18 @@ declare interface AddCallbackParametersCustom {
     playerVariant?: PlayerVariant,
     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
@@ -8659,6 +8672,48 @@ export declare enum ModCallbackCustom {
      * ```
      */
     ENTITY_TAKE_DMG_PLAYER = 1,
+    /**
+     * 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 = 2,
+    /**
+     * 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 = 3,
     /**
      * 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.
@@ -8671,7 +8726,7 @@ export declare enum ModCallbackCustom {
      * function postAmbushFinished(ambushType: AmbushType): void {}
      * ```
      */
-    POST_AMBUSH_FINISHED = 2,
+    POST_AMBUSH_FINISHED = 4,
     /**
      * Fires from the `POST_UPDATE` callback when a Challenge Room or Boss Rush is completed.
      * Specifically, this happens on the first frame that `Room.IsAmbushActive` is true.
@@ -8684,7 +8739,7 @@ export declare enum ModCallbackCustom {
      * function postAmbushStarted(ambushType: AmbushType): void {}
      * ```
      */
-    POST_AMBUSH_STARTED = 3,
+    POST_AMBUSH_STARTED = 5,
     /**
      * Fires on the `POST_BOMB_UPDATE` callback that it explodes.
      *
@@ -8698,7 +8753,7 @@ export declare enum ModCallbackCustom {
      * function postBombDetonated(bomb: EntityBomb): void {}
      * ```
      */
-    POST_BOMB_EXPLODED = 4,
+    POST_BOMB_EXPLODED = 6,
     /**
      * Fires on the first `POST_BOMB_UPDATE` frame for each bomb.
      *
@@ -8715,7 +8770,7 @@ export declare enum ModCallbackCustom {
      * function postBombInitLate(bomb: EntityBomb): void {}
      * ```
      */
-    POST_BOMB_INIT_LATE = 5,
+    POST_BOMB_INIT_LATE = 7,
     /**
      * Fires from the `POST_RENDER` callback when one of Forgotten's bone clubs is swung or thrown.
      *
@@ -8723,7 +8778,7 @@ export declare enum ModCallbackCustom {
      * function postBoneSwing(boneClub: EntityKnife): void {}
      * ```
      */
-    POST_BONE_SWING = 6,
+    POST_BONE_SWING = 8,
     /**
      * Fires from the `POST_PICKUP_UPDATE` callback when a collectible goes from a non-zero sub-type
      * to `CollectibleType.NULL` (i.e. an "empty" pedestal).
@@ -8739,7 +8794,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_COLLECTIBLE_EMPTY = 7,
+    POST_COLLECTIBLE_EMPTY = 9,
     /**
      * Fires from the `POST_PICKUP_INIT` callback on the first time that a player has seen the
      * respective collectible on the run. For more details on how this is calculated, see the
@@ -8757,7 +8812,7 @@ export declare enum ModCallbackCustom {
      * function postCollectibleInitLate(collectible: EntityPickupCollectible): void {}
      * ```
      */
-    POST_COLLECTIBLE_INIT_FIRST = 8,
+    POST_COLLECTIBLE_INIT_FIRST = 10,
     /**
      * Fires from the `POST_PLAYER_RENDER` callback on the first frame that the "TeleportUp" animation
      * begins playing after a player triggers a Cursed Eye teleport or a Cursed Skull teleport. (Both
@@ -8773,7 +8828,7 @@ export declare enum ModCallbackCustom {
      * function postCursedTeleport(player: EntityPlayer): void {}
      * ```
      */
-    POST_CURSED_TELEPORT = 9,
+    POST_CURSED_TELEPORT = 11,
     /**
      * Fires from the `POST_PLAYER_UPDATE` callback after the player has finished the death animation,
      * has teleported to the previous room, and is ready to play the animation for the modded revival
@@ -8791,7 +8846,7 @@ export declare enum ModCallbackCustom {
      * function postCustomRevive(player: EntityPlayer, revivalType: int): void {}
      * ```
      */
-    POST_CUSTOM_REVIVE = 10,
+    POST_CUSTOM_REVIVE = 12,
     /**
      * Fires from the `EFFECT_POST_UPDATE` callback after a player has entered the range of a Dice
      * Room floor.
@@ -8807,7 +8862,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_DICE_ROOM_ACTIVATED = 11,
+    POST_DICE_ROOM_ACTIVATED = 13,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a door exists.
      *
@@ -8819,7 +8874,7 @@ export declare enum ModCallbackCustom {
      * function postDoorRender(door: GridEntityDoor): void {}
      * ```
      */
-    POST_DOOR_RENDER = 12,
+    POST_DOOR_RENDER = 14,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a door exists.
      *
@@ -8831,7 +8886,7 @@ export declare enum ModCallbackCustom {
      * function postDoorUpdate(door: GridEntityDoor): void {}
      * ```
      */
-    POST_DOOR_UPDATE = 13,
+    POST_DOOR_UPDATE = 15,
     /**
      * Fires on the first `POST_EFFECT_UPDATE` frame for each effect.
      *
@@ -8848,7 +8903,7 @@ export declare enum ModCallbackCustom {
      * function postEffectInitLate(effect: EntityEffect): void {}
      * ```
      */
-    POST_EFFECT_INIT_LATE = 14,
+    POST_EFFECT_INIT_LATE = 16,
     /**
      * Fires from the `POST_EFFECT_UPDATE` callback when an effect's state has changed from what it
      * was on the previous frame. (In this context, "state" refers to the `EntityEffect.State` field.)
@@ -8867,7 +8922,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_EFFECT_STATE_CHANGED = 15,
+    POST_EFFECT_STATE_CHANGED = 17,
     /**
      * 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.)
@@ -8876,7 +8931,7 @@ export declare enum ModCallbackCustom {
      * function postEsauJr(player: EntityPlayer): void {}
      * ```
      */
-    POST_ESAU_JR = 16,
+    POST_ESAU_JR = 18,
     /**
      * Fires on the first `FAMILIAR_UPDATE` frame for each familiar.
      *
@@ -8893,7 +8948,7 @@ export declare enum ModCallbackCustom {
      * function postFamiliarInitLate(familiar: EntityFamiliar): void {}
      * ```
      */
-    POST_FAMILIAR_INIT_LATE = 17,
+    POST_FAMILIAR_INIT_LATE = 19,
     /**
      * Fires from the `POST_FAMILIAR_UPDATE` callback when a familiar's state has changed from what it
      * was on the previous frame. (In this context, "state" refers to the `EntityFamiliar.State`
@@ -8913,7 +8968,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_FAMILIAR_STATE_CHANGED = 18,
+    POST_FAMILIAR_STATE_CHANGED = 20,
     /**
      * Fires one `POST_UPDATE` frame after the player has first used the Esau Jr. item. (The player is
      * not updated to the new character until a game frame has passed.)
@@ -8925,7 +8980,7 @@ export declare enum ModCallbackCustom {
      * function postFirstEsauJr(player: EntityPlayer): void {}
      * ```
      */
-    POST_FIRST_ESAU_JR = 19,
+    POST_FIRST_ESAU_JR = 21,
     /**
      * Fires after the player has used the Flip item for the first time. Unlike the vanilla `USE_ITEM`
      * callback, this callback will return the player object for the new Lazarus (not the one who used
@@ -8938,7 +8993,7 @@ export declare enum ModCallbackCustom {
      * function postFirstFlip(newLazarus: EntityPlayer, oldLazarus: EntityPlayer): void {}
      * ```
      */
-    POST_FIRST_FLIP = 20,
+    POST_FIRST_FLIP = 22,
     /**
      * Fires after the player has used the Flip item. Unlike the vanilla `USE_ITEM` callback, this
      * callback will return the player object for the new Lazarus (not the one who used the Flip
@@ -8951,7 +9006,7 @@ export declare enum ModCallbackCustom {
      * function postFlip(newLazarus: EntityPlayer, oldLazarus: EntityPlayer): void {}
      * ```
      */
-    POST_FLIP = 21,
+    POST_FLIP = 23,
     /**
      * Similar to the vanilla callback of the same name, but fires in the correct order with respect
      * to the `POST_NEW_LEVEL` and the `POST_NEW_ROOM` callbacks:
@@ -8962,7 +9017,7 @@ export declare enum ModCallbackCustom {
      * function postGameStartedReordered(isContinued: boolean): void {}
      * ```
      */
-    POST_GAME_STARTED_REORDERED = 22,
+    POST_GAME_STARTED_REORDERED = 24,
     /**
      * Similar to the `POST_GAME_STARTED_REORDERED` callback, but fires after all of the subscribed
      * callbacks have finished firing. Thus, you can use this callback to do perform things after a
@@ -8973,7 +9028,7 @@ export declare enum ModCallbackCustom {
      * function postGameStartedReorderedLast(isContinued: boolean): void {}
      * ```
      */
-    POST_GAME_STARTED_REORDERED_LAST = 23,
+    POST_GAME_STARTED_REORDERED_LAST = 25,
     /**
      * Fires from the `POST_UPDATE` callback when the Greed Mode wave increases.
      *
@@ -8981,7 +9036,7 @@ export declare enum ModCallbackCustom {
      * function postGreedModeWave(oldWave: int, newWave: int): void {}
      * ```
      */
-    POST_GREED_MODE_WAVE = 24,
+    POST_GREED_MODE_WAVE = 26,
     /**
      * Fires from the `POST_UPDATE` callback when a grid entity changes to a state that corresponds to
      * the broken state for the respective grid entity type. (For example, this will fire for a
@@ -9000,7 +9055,7 @@ export declare enum ModCallbackCustom {
      * function postGridEntityBroken(gridEntity: GridEntity): void {}
      * ```
      */
-    POST_GRID_ENTITY_BROKEN = 25,
+    POST_GRID_ENTITY_BROKEN = 27,
     /**
      * Fires from the `POST_UPDATE` callback when a new entity collides with a grid entity. (After
      * this, the callback will not continue to fire. It will only fire again once the entity moves out
@@ -9028,7 +9083,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_GRID_ENTITY_COLLISION = 26,
+    POST_GRID_ENTITY_COLLISION = 28,
     /**
      * The same as the `POST_GRID_ENTITY_BROKEN` callback, but only fires for grid entities created
      * with the `spawnCustomGridEntity` helper function.
@@ -9045,7 +9100,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_GRID_ENTITY_CUSTOM_BROKEN = 27,
+    POST_GRID_ENTITY_CUSTOM_BROKEN = 29,
     /**
      * The same as the `POST_GRID_ENTITY_COLLISION` callback, but only fires for grid entities created
      * with the `spawnCustomGridEntity` helper function.
@@ -9069,7 +9124,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_GRID_ENTITY_CUSTOM_COLLISION = 28,
+    POST_GRID_ENTITY_CUSTOM_COLLISION = 30,
     /**
      * The same as the `POST_GRID_ENTITY_INIT` callback, but only fires for grid entities created with
      * the `spawnCustomGridEntity` helper function.
@@ -9086,7 +9141,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_GRID_ENTITY_CUSTOM_INIT = 29,
+    POST_GRID_ENTITY_CUSTOM_INIT = 31,
     /**
      * The same as the `POST_GRID_ENTITY_REMOVE` callback, but only fires for grid entities created
      * with the `spawnCustomGridEntity` helper function.
@@ -9103,7 +9158,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_GRID_ENTITY_CUSTOM_REMOVE = 30,
+    POST_GRID_ENTITY_CUSTOM_REMOVE = 32,
     /**
      * The same as the `POST_GRID_ENTITY_RENDER` callback, but only fires for grid entities created
      * with the `spawnCustomGridEntity` helper function.
@@ -9120,7 +9175,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_GRID_ENTITY_CUSTOM_RENDER = 31,
+    POST_GRID_ENTITY_CUSTOM_RENDER = 33,
     /**
      * The same as the `POST_GRID_ENTITY_STATE_CHANGED` callback, but only fires for grid entities
      * created with the `spawnCustomGridEntity` helper function.
@@ -9139,7 +9194,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_GRID_ENTITY_CUSTOM_STATE_CHANGED = 32,
+    POST_GRID_ENTITY_CUSTOM_STATE_CHANGED = 34,
     /**
      * The same as the `POST_GRID_ENTITY_UPDATE` callback, but only fires for grid entities created
      * with the `spawnCustomGridEntity` helper function.
@@ -9156,7 +9211,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_GRID_ENTITY_CUSTOM_UPDATE = 33,
+    POST_GRID_ENTITY_CUSTOM_UPDATE = 35,
     /**
      * Fires when a new grid entity is initialized. Specifically, this is either:
      *
@@ -9178,7 +9233,7 @@ export declare enum ModCallbackCustom {
      * function postGridEntityInit(gridEntity: GridEntity): void {}
      * ```
      */
-    POST_GRID_ENTITY_INIT = 34,
+    POST_GRID_ENTITY_INIT = 36,
     /**
      * Fires from the `POST_UPDATE` callback when a new grid entity is removed. Specifically, this on
      * the frame after it no longer exists (where it did exist a frame ago).
@@ -9203,7 +9258,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_GRID_ENTITY_REMOVE = 35,
+    POST_GRID_ENTITY_REMOVE = 37,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a grid entity exists.
      *
@@ -9220,7 +9275,7 @@ export declare enum ModCallbackCustom {
      * function postGridEntityRender(gridEntity: GridEntity): void {}
      * ```
      */
-    POST_GRID_ENTITY_RENDER = 36,
+    POST_GRID_ENTITY_RENDER = 38,
     /**
      * Fires from the `POST_UPDATE` callback when a grid entity changes its state. (In this context,
      * "state" refers to the `GridEntity.State` field.)
@@ -9242,7 +9297,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_GRID_ENTITY_STATE_CHANGED = 37,
+    POST_GRID_ENTITY_STATE_CHANGED = 39,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a grid entity exists.
      *
@@ -9259,7 +9314,7 @@ export declare enum ModCallbackCustom {
      * function postGridEntityUpdate(gridEntity: GridEntity): void {}
      * ```
      */
-    POST_GRID_ENTITY_UPDATE = 38,
+    POST_GRID_ENTITY_UPDATE = 40,
     /**
      * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when the player loses a Holy Mantle
      * temporary collectible effect.
@@ -9282,7 +9337,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_HOLY_MANTLE_REMOVED = 39,
+    POST_HOLY_MANTLE_REMOVED = 41,
     /**
      * Fires from `POST_PEFFECT_UPDATE_REORDERED` callback when the player loses charge on their
      * active collectible item, implying that the item was just used.
@@ -9305,7 +9360,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_ITEM_DISCHARGE = 40,
+    POST_ITEM_DISCHARGE = 42,
     /**
      * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when an item is no longer queued (i.e.
      * when the animation of the player holding the item above their head is finished and the item is
@@ -9326,7 +9381,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_ITEM_PICKUP = 41,
+    POST_ITEM_PICKUP = 43,
     /**
      * Fires on the first `POST_KNIFE_UPDATE` frame for each knife.
      *
@@ -9343,7 +9398,7 @@ export declare enum ModCallbackCustom {
      * function postKnifeInitLate(knife: EntityKnife): void {}
      * ```
      */
-    POST_KNIFE_INIT_LATE = 42,
+    POST_KNIFE_INIT_LATE = 44,
     /**
      * Fires on the first `POST_LASER_UPDATE` frame for each laser.
      *
@@ -9360,7 +9415,7 @@ export declare enum ModCallbackCustom {
      * function postLaserInitLate(laser: EntityLaser): void {}
      * ```
      */
-    POST_LASER_INIT_LATE = 43,
+    POST_LASER_INIT_LATE = 45,
     /**
      * The same as the vanilla callback of the same name, but fires in the correct order with respect
      * to the `POST_GAME_STARTED` and the `POST_NEW_ROOM` callbacks:
@@ -9377,7 +9432,7 @@ export declare enum ModCallbackCustom {
      * function postNewLevelReordered(): void {}
      * ```
      */
-    POST_NEW_LEVEL_REORDERED = 44,
+    POST_NEW_LEVEL_REORDERED = 46,
     /**
      * Fires on the first `POST_NEW_ROOM` or `PRE_ENTITY_SPAWN` callback where being in a new room is
      * detected. This is useful because the vanilla `POST_NEW_ROOM` callback fires only after entities
@@ -9388,7 +9443,7 @@ export declare enum ModCallbackCustom {
      * function postNewRoomEarly(): void {}
      * ```
      */
-    POST_NEW_ROOM_EARLY = 45,
+    POST_NEW_ROOM_EARLY = 47,
     /**
      * The same as the vanilla callback of the same name, but fires in the correct order with respect
      * to the `POST_GAME_STARTED` and the `POST_NEW_LEVEL` callbacks:
@@ -9405,7 +9460,7 @@ export declare enum ModCallbackCustom {
      * function postNewRoomReordered(): void {}
      * ```
      */
-    POST_NEW_ROOM_REORDERED = 46,
+    POST_NEW_ROOM_REORDERED = 48,
     /**
      * The exact same thing as the vanilla `POST_NPC_DEATH` callback, except this callback allows you
      * to specify extra arguments for additional filtration.
@@ -9422,7 +9477,7 @@ export declare enum ModCallbackCustom {
      * function postNPCDeathFilter(npc: EntityNPC): void {}
      * ```
      */
-    POST_NPC_DEATH_FILTER = 47,
+    POST_NPC_DEATH_FILTER = 49,
     /**
      * The exact same thing as the vanilla `POST_NPC_INIT` callback, except this callback allows you
      * to specify extra arguments for additional filtration.
@@ -9439,7 +9494,7 @@ export declare enum ModCallbackCustom {
      * function postNPCInitFilter(npc: EntityNPC): void {}
      * ```
      */
-    POST_NPC_INIT_FILTER = 48,
+    POST_NPC_INIT_FILTER = 50,
     /**
      * Fires on the first `NPC_UPDATE` frame for each NPC.
      *
@@ -9458,7 +9513,7 @@ export declare enum ModCallbackCustom {
      * function postNPCInitLate(npc: EntityNPC): void {}
      * ```
      */
-    POST_NPC_INIT_LATE = 49,
+    POST_NPC_INIT_LATE = 51,
     /**
      * The exact same thing as the vanilla `POST_NPC_RENDER` callback, except this callback allows you
      * to specify extra arguments for additional filtration.
@@ -9475,7 +9530,7 @@ export declare enum ModCallbackCustom {
      * function postNPCRenderFilter(npc: EntityNPC, renderOffset: Vector): void {}
      * ```
      */
-    POST_NPC_RENDER_FILTER = 50,
+    POST_NPC_RENDER_FILTER = 52,
     /**
      * 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.)
@@ -9496,7 +9551,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_NPC_STATE_CHANGED = 51,
+    POST_NPC_STATE_CHANGED = 53,
     /**
      * The exact same thing as the vanilla `POST_NPC_UPDATE` callback, except this callback allows you
      * to specify extra arguments for additional filtration.
@@ -9513,7 +9568,7 @@ export declare enum ModCallbackCustom {
      * function postNPCUpdateFilter(npc: EntityNPC): void {}
      * ```
      */
-    POST_NPC_UPDATE_FILTER = 52,
+    POST_NPC_UPDATE_FILTER = 54,
     /**
      * Similar to the vanilla callback of the same name, but fires after the
      * `POST_GAME_STARTED_REORDERED` callback fires (if the player is being updated on the 0th game
@@ -9538,7 +9593,7 @@ export declare enum ModCallbackCustom {
      * function postPEffectUpdateReordered(player: EntityPlayer): void {}
      * ```
      */
-    POST_PEFFECT_UPDATE_REORDERED = 53,
+    POST_PEFFECT_UPDATE_REORDERED = 55,
     /**
      * Fires on the first `POST_RENDER` frame that a pickup plays the "Collect" animation.
      *
@@ -9557,7 +9612,7 @@ export declare enum ModCallbackCustom {
      * function postPickupCollect(pickup: EntityPickup, player: EntityPlayer): void {}
      * ```
      */
-    POST_PICKUP_COLLECT = 54,
+    POST_PICKUP_COLLECT = 56,
     /**
      * Fires from the `POST_PICKUP_INIT` callback on the first time that a player has seen the
      * respective pickup on the run.
@@ -9575,7 +9630,7 @@ export declare enum ModCallbackCustom {
      * function postPickupInitFirst(pickup: EntityPickup): void {}
      * ```
      */
-    POST_PICKUP_INIT_FIRST = 55,
+    POST_PICKUP_INIT_FIRST = 57,
     /**
      * Fires on the first `POST_PICKUP_UPDATE` frame for each pickup.
      *
@@ -9592,7 +9647,7 @@ export declare enum ModCallbackCustom {
      * function postPickupInitLate(pickup: EntityPickup): void {}
      * ```
      */
-    POST_PICKUP_INIT_LATE = 56,
+    POST_PICKUP_INIT_LATE = 58,
     /**
      * Fires from the `POST_PICKUP_UPDATE` callback when a pickup's state has changed from what it was
      * on the previous frame. (In this context, "state" refers to the `EntityPickup.State` field.)
@@ -9611,7 +9666,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PICKUP_STATE_CHANGED = 57,
+    POST_PICKUP_STATE_CHANGED = 59,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a pit exists.
      *
@@ -9623,7 +9678,7 @@ export declare enum ModCallbackCustom {
      * function postPitRender(pit: GridEntityPit): void {}
      * ```
      */
-    POST_PIT_RENDER = 58,
+    POST_PIT_RENDER = 60,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a pit exists.
      *
@@ -9635,7 +9690,7 @@ export declare enum ModCallbackCustom {
      * function postPitUpdate(pit: GridEntityPit): void {}
      * ```
      */
-    POST_PIT_UPDATE = 59,
+    POST_PIT_UPDATE = 61,
     /**
      * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when a player's health (i.e. hearts) is
      * different than what it was on the previous frame. For more information, see the `PlayerHealth`
@@ -9657,7 +9712,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PLAYER_CHANGE_HEALTH = 60,
+    POST_PLAYER_CHANGE_HEALTH = 62,
     /**
      * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when one of the player's stats change
      * from what they were on the previous frame.
@@ -9687,7 +9742,7 @@ export declare enum ModCallbackCustom {
      * ) => void {}
      * ```
      */
-    POST_PLAYER_CHANGE_STAT = 61,
+    POST_PLAYER_CHANGE_STAT = 63,
     /**
      * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when a player entity changes its player
      * type
@@ -9710,7 +9765,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PLAYER_CHANGE_TYPE = 62,
+    POST_PLAYER_CHANGE_TYPE = 64,
     /**
      * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when a player's collectible count is
      * higher than what it was on the previous frame, or when the active items change, or when the
@@ -9727,7 +9782,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PLAYER_COLLECTIBLE_ADDED = 63,
+    POST_PLAYER_COLLECTIBLE_ADDED = 65,
     /**
      * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when a player's collectible count is
      * lower than what it was on the previous frame, or when the active items change, or when the
@@ -9744,7 +9799,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PLAYER_COLLECTIBLE_REMOVED = 64,
+    POST_PLAYER_COLLECTIBLE_REMOVED = 66,
     /**
      * Fires from the `ENTITY_TAKE_DMG` callback when a player takes fatal damage. Return false to
      * prevent the fatal damage.
@@ -9762,7 +9817,7 @@ export declare enum ModCallbackCustom {
      * function postPlayerFatalDamage(player: EntityPlayer): boolean | undefined {}
      * ```
      */
-    POST_PLAYER_FATAL_DAMAGE = 65,
+    POST_PLAYER_FATAL_DAMAGE = 67,
     /**
      * Fires on the first `POST_PEFFECT_UPDATE_REORDERED` frame for each player, similar to the
      * `POST_PLAYER_INIT_LATE` callback, with two changes:
@@ -9784,7 +9839,7 @@ export declare enum ModCallbackCustom {
      * function postPlayerInitFirst(player: EntityPlayer): void {}
      * ```
      */
-    POST_PLAYER_INIT_FIRST = 66,
+    POST_PLAYER_INIT_FIRST = 68,
     /**
      * Fires on the first `POST_PEFFECT_UPDATE_REORDERED` frame for each player.
      *
@@ -9804,7 +9859,7 @@ export declare enum ModCallbackCustom {
      * function postPlayerInitLate(pickup: EntityPickup): void {}
      * ```
      */
-    POST_PLAYER_INIT_LATE = 67,
+    POST_PLAYER_INIT_LATE = 69,
     /**
      * Similar to the vanilla callback of the same name, but fires after the `POST_GAME_STARTED`
      * callback fires (if the player is spawning on the 0th game frame of the run).
@@ -9828,7 +9883,7 @@ export declare enum ModCallbackCustom {
      * function postPlayerRenderReordered(player: EntityPlayer): void {}
      * ```
      */
-    POST_PLAYER_RENDER_REORDERED = 68,
+    POST_PLAYER_RENDER_REORDERED = 70,
     /**
      * Similar to the vanilla callback of the same name, but fires after the
      * `POST_GAME_STARTED_REORDERED` callback fires (if the player is being updated on the 0th game
@@ -9853,7 +9908,7 @@ export declare enum ModCallbackCustom {
      * function postPlayerUpdateReordered(player: EntityPlayer): void {}
      * ```
      */
-    POST_PLAYER_UPDATE_REORDERED = 69,
+    POST_PLAYER_UPDATE_REORDERED = 71,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a poop exists.
      *
@@ -9865,7 +9920,7 @@ export declare enum ModCallbackCustom {
      * function postPoopRender(poop: GridEntityPoop): void {}
      * ```
      */
-    POST_POOP_RENDER = 70,
+    POST_POOP_RENDER = 72,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a poop exists.
      *
@@ -9877,7 +9932,7 @@ export declare enum ModCallbackCustom {
      * function postPoopUpdate(poop: GridEntityPoop): void {}
      * ```
      */
-    POST_POOP_UPDATE = 71,
+    POST_POOP_UPDATE = 73,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a pressure plate exists.
      *
@@ -9889,7 +9944,7 @@ export declare enum ModCallbackCustom {
      * function postPressurePlateRender(pressurePlate: GridEntityPressurePlate): void {}
      * ```
      */
-    POST_PRESSURE_PLATE_RENDER = 72,
+    POST_PRESSURE_PLATE_RENDER = 74,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a pressure plate exists.
      *
@@ -9901,7 +9956,7 @@ export declare enum ModCallbackCustom {
      * function postPressurePlateUpdate(pressurePlate: GridEntityPressurePlate): void {}
      * ```
      */
-    POST_PRESSURE_PLATE_UPDATE = 73,
+    POST_PRESSURE_PLATE_UPDATE = 75,
     /**
      * Fires on the first `POST_PROJECTILE_UPDATE` frame for each projectile.
      *
@@ -9918,7 +9973,7 @@ export declare enum ModCallbackCustom {
      * function postProjectileInitLate(projectile: EntityProjectile): void {}
      * ```
      */
-    POST_PROJECTILE_INIT_LATE = 74,
+    POST_PROJECTILE_INIT_LATE = 76,
     /**
      * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when a player first picks up a new
      * item. The pickup returned in the callback is assumed to be the first pickup that no longer
@@ -9934,7 +9989,7 @@ export declare enum ModCallbackCustom {
      * function postPurchase(player: EntityPlayer, pickup: EntityPickup): void {}
      * ```
      */
-    POST_PURCHASE = 75,
+    POST_PURCHASE = 77,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a rock exists.
      *
@@ -9948,7 +10003,7 @@ export declare enum ModCallbackCustom {
      * function postRockRender(rock: GridEntityRock): void {}
      * ```
      */
-    POST_ROCK_RENDER = 76,
+    POST_ROCK_RENDER = 78,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a rock exists.
      *
@@ -9962,7 +10017,7 @@ export declare enum ModCallbackCustom {
      * function postRockUpdate(rock: GridEntityRock): void {}
      * ```
      */
-    POST_ROCK_UPDATE = 77,
+    POST_ROCK_UPDATE = 79,
     /**
      * Fires from the `POST_UPDATE` callback when the clear state of a room changes (as according to
      * the `Room.IsClear` method).
@@ -9979,7 +10034,7 @@ export declare enum ModCallbackCustom {
      * function postRoomClearChanged(roomClear: boolean): void {}
      * ```
      */
-    POST_ROOM_CLEAR_CHANGED = 78,
+    POST_ROOM_CLEAR_CHANGED = 80,
     /**
      * Fires from the `ENTITY_TAKE_DMG` callback when a player takes damage from spikes in a Sacrifice
      * Room.
@@ -9994,7 +10049,7 @@ export declare enum ModCallbackCustom {
      * function postSacrifice(player: EntityPlayer, numSacrifices: int): void {}
      * ```
      */
-    POST_SACRIFICE = 79,
+    POST_SACRIFICE = 81,
     /**
      * Fires from the `POST_RENDER` callback when a slot entity's animation changes.
      *
@@ -10008,7 +10063,7 @@ export declare enum ModCallbackCustom {
      * function postSlotAnimationChanged(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_ANIMATION_CHANGED = 80,
+    POST_SLOT_ANIMATION_CHANGED = 82,
     /**
      * Fires from the `PRE_PLAYER_COLLISION` callback when when a player collides with a slot entity.
      * (It will not fire if any other type of entity collides with the slot entity.)
@@ -10032,7 +10087,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_SLOT_COLLISION = 81,
+    POST_SLOT_COLLISION = 83,
     /**
      * Fires from the `POST_RENDER` callback when a slot plays the animation that indicates that it
      * has broken.
@@ -10047,7 +10102,7 @@ export declare enum ModCallbackCustom {
      * function postSlotDestroyed(slot: Entity, slotDestructionType: SlotDestructionType): void {}
      * ```
      */
-    POST_SLOT_DESTROYED = 82,
+    POST_SLOT_DESTROYED = 84,
     /**
      * Fires when a new slot entity is initialized. Specifically, this is either:
      *
@@ -10066,7 +10121,7 @@ export declare enum ModCallbackCustom {
      * function postSlotInit(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_INIT = 83,
+    POST_SLOT_INIT = 85,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a slot entity exists.
      *
@@ -10080,7 +10135,7 @@ export declare enum ModCallbackCustom {
      * function postSlotRender(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_RENDER = 84,
+    POST_SLOT_RENDER = 86,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a slot entity exists.
      *
@@ -10094,7 +10149,7 @@ export declare enum ModCallbackCustom {
      * function postSlotUpdate(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_UPDATE = 85,
+    POST_SLOT_UPDATE = 87,
     /**
      * Fires from the `POST_RENDER` callback on every frame that spikes exist.
      *
@@ -10106,7 +10161,7 @@ export declare enum ModCallbackCustom {
      * function postSpikesRender(spikes: GridEntitySpikes): void {}
      * ```
      */
-    POST_SPIKES_RENDER = 86,
+    POST_SPIKES_RENDER = 88,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that spikes exist.
      *
@@ -10118,7 +10173,7 @@ export declare enum ModCallbackCustom {
      * function postSpikesUpdate(spikes: GridEntitySpikes): void {}
      * ```
      */
-    POST_SPIKES_UPDATE = 87,
+    POST_SPIKES_UPDATE = 89,
     /**
      * Fires on the first `POST_TEAR_UPDATE` frame for each tear (which is when
      * `EntityTear.FrameCount` is equal to 0).
@@ -10136,7 +10191,7 @@ export declare enum ModCallbackCustom {
      * function postTearInitLate(tear: EntityTear): void {}
      * ```
      */
-    POST_TEAR_INIT_LATE = 88,
+    POST_TEAR_INIT_LATE = 90,
     /**
      * Fires on the second `POST_TEAR_UPDATE` frame for each tear (which is when
      * `EntityTear.FrameCount` is equal to 1).
@@ -10153,7 +10208,7 @@ export declare enum ModCallbackCustom {
      * function postTearInitVeryLate(tear: EntityTear): void {}
      * ```
      */
-    POST_TEAR_INIT_VERY_LATE = 89,
+    POST_TEAR_INIT_VERY_LATE = 91,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a TNT exists.
      *
@@ -10165,7 +10220,7 @@ export declare enum ModCallbackCustom {
      * function postTNTRender(tnt: GridEntityTNT): void {}
      * ```
      */
-    POST_TNT_RENDER = 90,
+    POST_TNT_RENDER = 92,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a TNT exists.
      *
@@ -10177,7 +10232,7 @@ export declare enum ModCallbackCustom {
      * function postTNTUpdate(tnt: GridEntityTNT): void {}
      * ```
      */
-    POST_TNT_UPDATE = 91,
+    POST_TNT_UPDATE = 93,
     /**
      * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when a player gains or loses a new
      * transformation.
@@ -10196,7 +10251,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_TRANSFORMATION = 92,
+    POST_TRANSFORMATION = 94,
     /**
      * Fires from `ENTITY_TAKE_DMG` callback when a Wishbone or a Walnut breaks.
      *
@@ -10211,7 +10266,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_TRINKET_BREAK = 93,
+    POST_TRINKET_BREAK = 95,
     /**
      * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback on the frame before a Berserk effect
      * ends when the player is predicted to die (e.g. they currently have no health left or they took
@@ -10227,7 +10282,7 @@ export declare enum ModCallbackCustom {
      * function preBerserkDeath(player: EntityPlayer): void {}
      * ```
      */
-    PRE_BERSERK_DEATH = 94,
+    PRE_BERSERK_DEATH = 96,
     /**
      * Fires from the `POST_PLAYER_FATAL_DAMAGE` callback when a player is about to die. If you want
      * to initiate a custom revival, return an integer that corresponds to the item or type of revival
@@ -10246,7 +10301,7 @@ export declare enum ModCallbackCustom {
      * function preCustomRevive(player: EntityPlayer): int | undefined {}
      * ```
      */
-    PRE_CUSTOM_REVIVE = 95,
+    PRE_CUSTOM_REVIVE = 97,
     /**
      * Fires from the `PRE_PICKUP_COLLISION` callback when a player touches a collectible pedestal and
      * meets all of the conditions to pick it up.
@@ -10266,7 +10321,7 @@ export declare enum ModCallbackCustom {
      * function preGetPedestal(player: EntityPlayer, collectible: EntityPickupCollectible): void {}
      * ```
      */
-    PRE_GET_PEDESTAL = 96,
+    PRE_GET_PEDESTAL = 98,
     /**
      * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when an item becomes queued (i.e. when
      * the player begins to hold the item above their head).
@@ -10286,7 +10341,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    PRE_ITEM_PICKUP = 97,
+    PRE_ITEM_PICKUP = 99,
     /**
      * 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
@@ -10300,7 +10355,7 @@ export declare enum ModCallbackCustom {
      * function preNewLevel(player: EntityPlayer): void {}
      * ```
      */
-    PRE_NEW_LEVEL = 98,
+    PRE_NEW_LEVEL = 100,
     /**
      * The exact same thing as the vanilla `PRE_NPC_COLLISION` callback, except this callback allows
      * you to specify extra arguments for additional filtration.
@@ -10321,7 +10376,7 @@ export declare enum ModCallbackCustom {
      * ): boolean | undefined {}
      * ```
      */
-    PRE_NPC_COLLISION_FILTER = 99,
+    PRE_NPC_COLLISION_FILTER = 101,
     /**
      * The exact same thing as the vanilla `PRE_NPC_UPDATE` callback, except this callback allows you
      * to specify extra arguments for additional filtration.
@@ -10338,7 +10393,7 @@ export declare enum ModCallbackCustom {
      * function preNPCUpdateFilter(entity: Entity): boolean | undefined {}
      * ```
      */
-    PRE_NPC_UPDATE_FILTER = 100
+    PRE_NPC_UPDATE_FILTER = 102
 }
 
 /**