isaacscript-common 21.2.1 → 21.4.0

package/dist/index.d.ts

@@ -280,6 +280,11 @@ declare interface AddCallbackParametersCustom {
     itemType: ItemType.TRINKET,
     trinketType?: TrinketType
     ];
+    [ModCallbackCustom.POST_KEYBOARD_CHANGED]: [
+    callback: (keyboard: Keyboard, pressed: boolean) => void,
+    keyboard?: Keyboard,
+    pressed?: boolean
+    ];
     [ModCallbackCustom.POST_KNIFE_INIT_LATE]: [
     callback: (knife: EntityKnife) => void,
     knifeVariant?: KnifeVariant,
@@ -2734,113 +2739,185 @@ declare class DebugDisplay extends Feature {
      * Toggles the debug display for players, which will draw text on the screen next to each player.
      *
      * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
+     *
+     * @param force Optional. A boolean that represents the value to force the display to. For
+     *              example, you can specify true to always make the display turn on, regardless of
+     *              whether or not it is already on.
      */
-    togglePlayerDisplay(): void;
+    togglePlayerDisplay(force?: boolean): void;
     /**
      * Toggles the debug display for tears, which will draw text on the screen next to each tear.
      *
-     * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
+     * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`. *
+     *
+     * @param force Optional. A boolean that represents the value to force the display to. For
+     *              example, you can specify true to always make the display turn on, regardless of
+     *              whether or not it is already on.
      */
-    toggleTearDisplay(): void;
+    toggleTearDisplay(force?: boolean): void;
     /**
      * Toggles the debug display for familiars, which will draw text on the screen next to each
      * familiar.
      *
      * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
+     *
+     * @param force Optional. A boolean that represents the value to force the display to. For
+     *              example, you can specify true to always make the display turn on, regardless of
+     *              whether or not it is already on.
      */
-    toggleFamiliarDisplay(): void;
+    toggleFamiliarDisplay(force?: boolean): void;
     /**
      * Toggles the debug display for bombs, which will draw text on the screen next to each bomb.
      *
      * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
+     *
+     * @param force Optional. A boolean that represents the value to force the display to. For
+     *              example, you can specify true to always make the display turn on, regardless of
+     *              whether or not it is already on.
      */
-    toggleBombDisplay(): void;
+    toggleBombDisplay(force?: boolean): void;
     /**
      * Toggles the debug display for pickups, which will draw text on the screen next to each pickup.
      *
      * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
+     *
+     * @param force Optional. A boolean that represents the value to force the display to. For
+     *              example, you can specify true to always make the display turn on, regardless of
+     *              whether or not it is already on.
      */
-    togglePickupDisplay(): void;
+    togglePickupDisplay(force?: boolean): void;
     /**
      * Toggles the debug display for slots, which will draw text on the screen next to each slot.
      *
      * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
+     *
+     * @param force Optional. A boolean that represents the value to force the display to. For
+     *              example, you can specify true to always make the display turn on, regardless of
+     *              whether or not it is already on.
      */
-    toggleSlotDisplay(): void;
+    toggleSlotDisplay(force?: boolean): void;
     /**
      * Toggles the debug display for lasers, which will draw text on the screen next to each laser.
      *
      * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
+     *
+     * @param force Optional. A boolean that represents the value to force the display to. For
+     *              example, you can specify true to always make the display turn on, regardless of
+     *              whether or not it is already on.
      */
-    toggleLaserDisplay(): void;
+    toggleLaserDisplay(force?: boolean): void;
     /**
      * Toggles the debug display for knives, which will draw text on the screen next to each knife.
      *
      * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
+     *
+     * @param force Optional. A boolean that represents the value to force the display to. For
+     *              example, you can specify true to always make the display turn on, regardless of
+     *              whether or not it is already on.
      */
-    toggleKnifeDisplay(): void;
+    toggleKnifeDisplay(force?: boolean): void;
     /**
      * Toggles the debug display for projectiles, which will draw text on the screen next to each
      * projectile.
      *
      * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
+     *
+     * @param force Optional. A boolean that represents the value to force the display to. For
+     *              example, you can specify true to always make the display turn on, regardless of
+     *              whether or not it is already on.
      */
-    toggleProjectileDisplay(): void;
+    toggleProjectileDisplay(force?: boolean): void;
     /**
      * Toggles the debug display for effects, which will draw text on the screen next to each effect.
      *
      * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
+     *
+     * @param force Optional. A boolean that represents the value to force the display to. For
+     *              example, you can specify true to always make the display turn on, regardless of
+     *              whether or not it is already on.
      */
-    toggleEffectDisplay(): void;
+    toggleEffectDisplay(force?: boolean): void;
     /**
      * Toggles the debug display for NPCs, which will draw text on the screen next to each NPC.
      *
      * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
+     *
+     * @param force Optional. A boolean that represents the value to force the display to. For
+     *              example, you can specify true to always make the display turn on, regardless of
+     *              whether or not it is already on.
      */
-    toggleNPCDisplay(): void;
+    toggleNPCDisplay(force?: boolean): void;
     /**
      * Toggles the debug display for rocks, which will draw text on the screen next to each rock.
      *
      * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
+     *
+     * @param force Optional. A boolean that represents the value to force the display to. For
+     *              example, you can specify true to always make the display turn on, regardless of
+     *              whether or not it is already on.
      */
-    toggleRockDisplay(): void;
+    toggleRockDisplay(force?: boolean): void;
     /**
      * Toggles the debug display for pits, which will draw text on the screen next to each pit.
      *
      * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
+     *
+     * @param force Optional. A boolean that represents the value to force the display to. For
+     *              example, you can specify true to always make the display turn on, regardless of
+     *              whether or not it is already on.
      */
-    togglePitDisplay(): void;
+    togglePitDisplay(force?: boolean): void;
     /**
      * Toggles the debug display for spikes, which will draw text on the screen next to each spike.
      *
      * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
+     *
+     * @param force Optional. A boolean that represents the value to force the display to. For
+     *              example, you can specify true to always make the display turn on, regardless of
+     *              whether or not it is already on.
      */
-    toggleSpikesDisplay(): void;
+    toggleSpikesDisplay(force?: boolean): void;
     /**
      * Toggles the debug display for TNT, which will draw text on the screen next to each TNT.
      *
      * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
+     *
+     * @param force Optional. A boolean that represents the value to force the display to. For
+     *              example, you can specify true to always make the display turn on, regardless of
+     *              whether or not it is already on.
      */
-    toggleTNTDisplay(): void;
+    toggleTNTDisplay(force?: boolean): void;
     /**
      * Toggles the debug display for poops, which will draw text on the screen next to each poop.
      *
      * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
+     *
+     * @param force Optional. A boolean that represents the value to force the display to. For
+     *              example, you can specify true to always make the display turn on, regardless of
+     *              whether or not it is already on.
      */
-    togglePoopDisplay(): void;
+    togglePoopDisplay(force?: boolean): void;
     /**
      * Toggles the debug display for doors, which will draw text on the screen next to each door.
      *
      * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
+     *
+     * @param force Optional. A boolean that represents the value to force the display to. For
+     *              example, you can specify true to always make the display turn on, regardless of
+     *              whether or not it is already on.
      */
-    toggleDoorDisplay(): void;
+    toggleDoorDisplay(force?: boolean): void;
     /**
      * Toggles the debug display for pressure plates, which will draw text on the screen next to each
      * pressure plate.
      *
      * In order to use this function, you must upgrade your mod with `ISCFeature.DEBUG_DISPLAY`.
+     *
+     * @param force Optional. A boolean that represents the value to force the display to. For
+     *              example, you can specify true to always make the display turn on, regardless of
+     *              whether or not it is already on.
      */
-    togglePressurePlateDisplay(): void;
+    togglePressurePlateDisplay(force?: boolean): void;
 }
 
 /**
@@ -9557,6 +9634,22 @@ export declare enum ModCallbackCustom {
      * ```
      */
     POST_ITEM_PICKUP = 43,
+    /**
+     * Fires on the first `POST_RENDER` frame after a key on the keyboard has been pressed or
+     * released. (In other words, the callback only fires when the "pressed" status is different than
+     * what it was on the previous frame.)
+     *
+     * 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 `Keyboard` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the pressed state provided. (`true` for pressed, `false` for released.)
+     *
+     * ```ts
+     * function postKeyboardChanged(keyboard: Keyboard, pressed: boolean): void {}
+     * ```
+     */
+    POST_KEYBOARD_CHANGED = 44,
     /**
      * Fires on the first `POST_KNIFE_UPDATE` frame for each knife.
      *
@@ -9573,7 +9666,7 @@ export declare enum ModCallbackCustom {
      * function postKnifeInitLate(knife: EntityKnife): void {}
      * ```
      */
-    POST_KNIFE_INIT_LATE = 44,
+    POST_KNIFE_INIT_LATE = 45,
     /**
      * Fires on the first `POST_LASER_UPDATE` frame for each laser.
      *
@@ -9590,7 +9683,7 @@ export declare enum ModCallbackCustom {
      * function postLaserInitLate(laser: EntityLaser): void {}
      * ```
      */
-    POST_LASER_INIT_LATE = 45,
+    POST_LASER_INIT_LATE = 46,
     /**
      * 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:
@@ -9607,7 +9700,7 @@ export declare enum ModCallbackCustom {
      * function postNewLevelReordered(): void {}
      * ```
      */
-    POST_NEW_LEVEL_REORDERED = 46,
+    POST_NEW_LEVEL_REORDERED = 47,
     /**
      * 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
@@ -9618,7 +9711,7 @@ export declare enum ModCallbackCustom {
      * function postNewRoomEarly(): void {}
      * ```
      */
-    POST_NEW_ROOM_EARLY = 47,
+    POST_NEW_ROOM_EARLY = 48,
     /**
      * 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:
@@ -9635,7 +9728,7 @@ export declare enum ModCallbackCustom {
      * function postNewRoomReordered(): void {}
      * ```
      */
-    POST_NEW_ROOM_REORDERED = 48,
+    POST_NEW_ROOM_REORDERED = 49,
     /**
      * The exact same thing as the vanilla `POST_NPC_DEATH` callback, except this callback allows you
      * to specify extra arguments for additional filtration.
@@ -9652,7 +9745,7 @@ export declare enum ModCallbackCustom {
      * function postNPCDeathFilter(npc: EntityNPC): void {}
      * ```
      */
-    POST_NPC_DEATH_FILTER = 49,
+    POST_NPC_DEATH_FILTER = 50,
     /**
      * The exact same thing as the vanilla `POST_NPC_INIT` callback, except this callback allows you
      * to specify extra arguments for additional filtration.
@@ -9669,7 +9762,7 @@ export declare enum ModCallbackCustom {
      * function postNPCInitFilter(npc: EntityNPC): void {}
      * ```
      */
-    POST_NPC_INIT_FILTER = 50,
+    POST_NPC_INIT_FILTER = 51,
     /**
      * Fires on the first `NPC_UPDATE` frame for each NPC.
      *
@@ -9688,7 +9781,7 @@ export declare enum ModCallbackCustom {
      * function postNPCInitLate(npc: EntityNPC): void {}
      * ```
      */
-    POST_NPC_INIT_LATE = 51,
+    POST_NPC_INIT_LATE = 52,
     /**
      * The exact same thing as the vanilla `POST_NPC_RENDER` callback, except this callback allows you
      * to specify extra arguments for additional filtration.
@@ -9705,7 +9798,7 @@ export declare enum ModCallbackCustom {
      * function postNPCRenderFilter(npc: EntityNPC, renderOffset: Vector): void {}
      * ```
      */
-    POST_NPC_RENDER_FILTER = 52,
+    POST_NPC_RENDER_FILTER = 53,
     /**
      * 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.)
@@ -9726,7 +9819,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_NPC_STATE_CHANGED = 53,
+    POST_NPC_STATE_CHANGED = 54,
     /**
      * The exact same thing as the vanilla `POST_NPC_UPDATE` callback, except this callback allows you
      * to specify extra arguments for additional filtration.
@@ -9743,7 +9836,7 @@ export declare enum ModCallbackCustom {
      * function postNPCUpdateFilter(npc: EntityNPC): void {}
      * ```
      */
-    POST_NPC_UPDATE_FILTER = 54,
+    POST_NPC_UPDATE_FILTER = 55,
     /**
      * 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
@@ -9768,7 +9861,7 @@ export declare enum ModCallbackCustom {
      * function postPEffectUpdateReordered(player: EntityPlayer): void {}
      * ```
      */
-    POST_PEFFECT_UPDATE_REORDERED = 55,
+    POST_PEFFECT_UPDATE_REORDERED = 56,
     /**
      * Fires on the first `POST_RENDER` frame that a pickup plays the "Collect" animation.
      *
@@ -9787,7 +9880,7 @@ export declare enum ModCallbackCustom {
      * function postPickupCollect(pickup: EntityPickup, player: EntityPlayer): void {}
      * ```
      */
-    POST_PICKUP_COLLECT = 56,
+    POST_PICKUP_COLLECT = 57,
     /**
      * The exact same thing as the vanilla `POST_PICKUP_INIT` callback, except this callback allows
      * you to specify extra arguments for additional filtration.
@@ -9802,7 +9895,7 @@ export declare enum ModCallbackCustom {
      * function postPickupInitFilter(pickup: EntityPickup): void {}
      * ```
      */
-    POST_PICKUP_INIT_FILTER = 57,
+    POST_PICKUP_INIT_FILTER = 58,
     /**
      * Fires from the `POST_PICKUP_INIT` callback on the first time that a player has seen the
      * respective pickup on the run.
@@ -9820,7 +9913,7 @@ export declare enum ModCallbackCustom {
      * function postPickupInitFirst(pickup: EntityPickup): void {}
      * ```
      */
-    POST_PICKUP_INIT_FIRST = 58,
+    POST_PICKUP_INIT_FIRST = 59,
     /**
      * Fires on the first `POST_PICKUP_UPDATE` frame for each pickup.
      *
@@ -9837,7 +9930,7 @@ export declare enum ModCallbackCustom {
      * function postPickupInitLate(pickup: EntityPickup): void {}
      * ```
      */
-    POST_PICKUP_INIT_LATE = 59,
+    POST_PICKUP_INIT_LATE = 60,
     /**
      * The exact same thing as the vanilla `POST_PICKUP_RENDER` callback, except this callback allows
      * you to specify extra arguments for additional filtration.
@@ -9852,7 +9945,7 @@ export declare enum ModCallbackCustom {
      * function postPickupRenderFilter(pickup: EntityPickup, renderOffset: Vector): void {}
      * ```
      */
-    POST_PICKUP_RENDER_FILTER = 60,
+    POST_PICKUP_RENDER_FILTER = 61,
     /**
      * The exact same thing as the vanilla `POST_PICKUP_SELECTION` callback, except this callback
      * allows you to specify extra arguments for additional filtration.
@@ -9871,7 +9964,7 @@ export declare enum ModCallbackCustom {
      * ): [PickupVariant, int] | undefined {}
      * ```
      */
-    POST_PICKUP_SELECTION_FILTER = 61,
+    POST_PICKUP_SELECTION_FILTER = 62,
     /**
      * 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.)
@@ -9890,7 +9983,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PICKUP_STATE_CHANGED = 62,
+    POST_PICKUP_STATE_CHANGED = 63,
     /**
      * The exact same thing as the vanilla `POST_PICKUP_UPDATE` callback, except this callback allows
      * you to specify extra arguments for additional filtration.
@@ -9905,7 +9998,7 @@ export declare enum ModCallbackCustom {
      * function postPickupUpdateFilter(pickup: EntityPickup): void {}
      * ```
      */
-    POST_PICKUP_UPDATE_FILTER = 63,
+    POST_PICKUP_UPDATE_FILTER = 64,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a pit exists.
      *
@@ -9917,7 +10010,7 @@ export declare enum ModCallbackCustom {
      * function postPitRender(pit: GridEntityPit): void {}
      * ```
      */
-    POST_PIT_RENDER = 64,
+    POST_PIT_RENDER = 65,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a pit exists.
      *
@@ -9929,7 +10022,7 @@ export declare enum ModCallbackCustom {
      * function postPitUpdate(pit: GridEntityPit): void {}
      * ```
      */
-    POST_PIT_UPDATE = 65,
+    POST_PIT_UPDATE = 66,
     /**
      * 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`
@@ -9951,7 +10044,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PLAYER_CHANGE_HEALTH = 66,
+    POST_PLAYER_CHANGE_HEALTH = 67,
     /**
      * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when one of the player's stats change
      * from what they were on the previous frame.
@@ -9981,7 +10074,7 @@ export declare enum ModCallbackCustom {
      * ) => void {}
      * ```
      */
-    POST_PLAYER_CHANGE_STAT = 67,
+    POST_PLAYER_CHANGE_STAT = 68,
     /**
      * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when a player entity changes its player
      * type
@@ -10004,7 +10097,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PLAYER_CHANGE_TYPE = 68,
+    POST_PLAYER_CHANGE_TYPE = 69,
     /**
      * 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
@@ -10021,7 +10114,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PLAYER_COLLECTIBLE_ADDED = 69,
+    POST_PLAYER_COLLECTIBLE_ADDED = 70,
     /**
      * 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
@@ -10038,7 +10131,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PLAYER_COLLECTIBLE_REMOVED = 70,
+    POST_PLAYER_COLLECTIBLE_REMOVED = 71,
     /**
      * Fires from the `ENTITY_TAKE_DMG` callback when a player takes fatal damage. Return false to
      * prevent the fatal damage.
@@ -10056,7 +10149,7 @@ export declare enum ModCallbackCustom {
      * function postPlayerFatalDamage(player: EntityPlayer): boolean | undefined {}
      * ```
      */
-    POST_PLAYER_FATAL_DAMAGE = 71,
+    POST_PLAYER_FATAL_DAMAGE = 72,
     /**
      * Fires on the first `POST_PEFFECT_UPDATE_REORDERED` frame for each player, similar to the
      * `POST_PLAYER_INIT_LATE` callback, with two changes:
@@ -10078,7 +10171,7 @@ export declare enum ModCallbackCustom {
      * function postPlayerInitFirst(player: EntityPlayer): void {}
      * ```
      */
-    POST_PLAYER_INIT_FIRST = 72,
+    POST_PLAYER_INIT_FIRST = 73,
     /**
      * Fires on the first `POST_PEFFECT_UPDATE_REORDERED` frame for each player.
      *
@@ -10098,7 +10191,7 @@ export declare enum ModCallbackCustom {
      * function postPlayerInitLate(pickup: EntityPickup): void {}
      * ```
      */
-    POST_PLAYER_INIT_LATE = 73,
+    POST_PLAYER_INIT_LATE = 74,
     /**
      * 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).
@@ -10122,7 +10215,7 @@ export declare enum ModCallbackCustom {
      * function postPlayerRenderReordered(player: EntityPlayer): void {}
      * ```
      */
-    POST_PLAYER_RENDER_REORDERED = 74,
+    POST_PLAYER_RENDER_REORDERED = 75,
     /**
      * 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
@@ -10147,7 +10240,7 @@ export declare enum ModCallbackCustom {
      * function postPlayerUpdateReordered(player: EntityPlayer): void {}
      * ```
      */
-    POST_PLAYER_UPDATE_REORDERED = 75,
+    POST_PLAYER_UPDATE_REORDERED = 76,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a poop exists.
      *
@@ -10159,7 +10252,7 @@ export declare enum ModCallbackCustom {
      * function postPoopRender(poop: GridEntityPoop): void {}
      * ```
      */
-    POST_POOP_RENDER = 76,
+    POST_POOP_RENDER = 77,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a poop exists.
      *
@@ -10171,7 +10264,7 @@ export declare enum ModCallbackCustom {
      * function postPoopUpdate(poop: GridEntityPoop): void {}
      * ```
      */
-    POST_POOP_UPDATE = 77,
+    POST_POOP_UPDATE = 78,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a pressure plate exists.
      *
@@ -10183,7 +10276,7 @@ export declare enum ModCallbackCustom {
      * function postPressurePlateRender(pressurePlate: GridEntityPressurePlate): void {}
      * ```
      */
-    POST_PRESSURE_PLATE_RENDER = 78,
+    POST_PRESSURE_PLATE_RENDER = 79,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a pressure plate exists.
      *
@@ -10195,7 +10288,7 @@ export declare enum ModCallbackCustom {
      * function postPressurePlateUpdate(pressurePlate: GridEntityPressurePlate): void {}
      * ```
      */
-    POST_PRESSURE_PLATE_UPDATE = 79,
+    POST_PRESSURE_PLATE_UPDATE = 80,
     /**
      * Fires on the first `POST_PROJECTILE_UPDATE` frame for each projectile.
      *
@@ -10212,7 +10305,7 @@ export declare enum ModCallbackCustom {
      * function postProjectileInitLate(projectile: EntityProjectile): void {}
      * ```
      */
-    POST_PROJECTILE_INIT_LATE = 80,
+    POST_PROJECTILE_INIT_LATE = 81,
     /**
      * 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
@@ -10228,7 +10321,7 @@ export declare enum ModCallbackCustom {
      * function postPurchase(player: EntityPlayer, pickup: EntityPickup): void {}
      * ```
      */
-    POST_PURCHASE = 81,
+    POST_PURCHASE = 82,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a rock exists.
      *
@@ -10242,7 +10335,7 @@ export declare enum ModCallbackCustom {
      * function postRockRender(rock: GridEntityRock): void {}
      * ```
      */
-    POST_ROCK_RENDER = 82,
+    POST_ROCK_RENDER = 83,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a rock exists.
      *
@@ -10256,7 +10349,7 @@ export declare enum ModCallbackCustom {
      * function postRockUpdate(rock: GridEntityRock): void {}
      * ```
      */
-    POST_ROCK_UPDATE = 83,
+    POST_ROCK_UPDATE = 84,
     /**
      * Fires from the `POST_UPDATE` callback when the clear state of a room changes (as according to
      * the `Room.IsClear` method).
@@ -10273,7 +10366,7 @@ export declare enum ModCallbackCustom {
      * function postRoomClearChanged(roomClear: boolean): void {}
      * ```
      */
-    POST_ROOM_CLEAR_CHANGED = 84,
+    POST_ROOM_CLEAR_CHANGED = 85,
     /**
      * Fires from the `ENTITY_TAKE_DMG` callback when a player takes damage from spikes in a Sacrifice
      * Room.
@@ -10288,7 +10381,7 @@ export declare enum ModCallbackCustom {
      * function postSacrifice(player: EntityPlayer, numSacrifices: int): void {}
      * ```
      */
-    POST_SACRIFICE = 85,
+    POST_SACRIFICE = 86,
     /**
      * Fires from the `POST_RENDER` callback when a slot entity's animation changes.
      *
@@ -10306,7 +10399,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_SLOT_ANIMATION_CHANGED = 86,
+    POST_SLOT_ANIMATION_CHANGED = 87,
     /**
      * 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.)
@@ -10330,7 +10423,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_SLOT_COLLISION = 87,
+    POST_SLOT_COLLISION = 88,
     /**
      * Fires from the `POST_SLOT_UPDATE` or the `POST_ENTITY_REMOVE` callback when a slot machine is
      * destroyed or a beggar is removed.
@@ -10372,7 +10465,7 @@ export declare enum ModCallbackCustom {
      * function postSlotDestroyed(slot: Entity, slotDestructionType: SlotDestructionType): void {}
      * ```
      */
-    POST_SLOT_DESTROYED = 88,
+    POST_SLOT_DESTROYED = 89,
     /**
      * Fires when a new slot entity is initialized. Specifically, this is either:
      *
@@ -10391,7 +10484,7 @@ export declare enum ModCallbackCustom {
      * function postSlotInit(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_INIT = 89,
+    POST_SLOT_INIT = 90,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a slot entity exists.
      *
@@ -10405,7 +10498,7 @@ export declare enum ModCallbackCustom {
      * function postSlotRender(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_RENDER = 90,
+    POST_SLOT_RENDER = 91,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a slot entity exists.
      *
@@ -10419,7 +10512,7 @@ export declare enum ModCallbackCustom {
      * function postSlotUpdate(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_UPDATE = 91,
+    POST_SLOT_UPDATE = 92,
     /**
      * Fires from the `POST_RENDER` callback on every frame that spikes exist.
      *
@@ -10431,7 +10524,7 @@ export declare enum ModCallbackCustom {
      * function postSpikesRender(spikes: GridEntitySpikes): void {}
      * ```
      */
-    POST_SPIKES_RENDER = 92,
+    POST_SPIKES_RENDER = 93,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that spikes exist.
      *
@@ -10443,7 +10536,7 @@ export declare enum ModCallbackCustom {
      * function postSpikesUpdate(spikes: GridEntitySpikes): void {}
      * ```
      */
-    POST_SPIKES_UPDATE = 93,
+    POST_SPIKES_UPDATE = 94,
     /**
      * Fires on the first `POST_TEAR_UPDATE` frame for each tear (which is when
      * `EntityTear.FrameCount` is equal to 0).
@@ -10461,7 +10554,7 @@ export declare enum ModCallbackCustom {
      * function postTearInitLate(tear: EntityTear): void {}
      * ```
      */
-    POST_TEAR_INIT_LATE = 94,
+    POST_TEAR_INIT_LATE = 95,
     /**
      * Fires on the second `POST_TEAR_UPDATE` frame for each tear (which is when
      * `EntityTear.FrameCount` is equal to 1).
@@ -10478,7 +10571,7 @@ export declare enum ModCallbackCustom {
      * function postTearInitVeryLate(tear: EntityTear): void {}
      * ```
      */
-    POST_TEAR_INIT_VERY_LATE = 95,
+    POST_TEAR_INIT_VERY_LATE = 96,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a TNT exists.
      *
@@ -10490,7 +10583,7 @@ export declare enum ModCallbackCustom {
      * function postTNTRender(tnt: GridEntityTNT): void {}
      * ```
      */
-    POST_TNT_RENDER = 96,
+    POST_TNT_RENDER = 97,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a TNT exists.
      *
@@ -10502,7 +10595,7 @@ export declare enum ModCallbackCustom {
      * function postTNTUpdate(tnt: GridEntityTNT): void {}
      * ```
      */
-    POST_TNT_UPDATE = 97,
+    POST_TNT_UPDATE = 98,
     /**
      * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when a player gains or loses a new
      * transformation.
@@ -10521,7 +10614,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_TRANSFORMATION = 98,
+    POST_TRANSFORMATION = 99,
     /**
      * Fires from `ENTITY_TAKE_DMG` callback when a Wishbone or a Walnut breaks.
      *
@@ -10536,7 +10629,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_TRINKET_BREAK = 99,
+    POST_TRINKET_BREAK = 100,
     /**
      * 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
@@ -10552,7 +10645,7 @@ export declare enum ModCallbackCustom {
      * function preBerserkDeath(player: EntityPlayer): void {}
      * ```
      */
-    PRE_BERSERK_DEATH = 100,
+    PRE_BERSERK_DEATH = 101,
     /**
      * 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
@@ -10571,7 +10664,7 @@ export declare enum ModCallbackCustom {
      * function preCustomRevive(player: EntityPlayer): int | undefined {}
      * ```
      */
-    PRE_CUSTOM_REVIVE = 101,
+    PRE_CUSTOM_REVIVE = 102,
     /**
      * The exact same thing as the vanilla `PRE_ENTITY_SPAWN` callback, except this callback allows
      * you to specify extra arguments for additional filtration.
@@ -10596,7 +10689,7 @@ export declare enum ModCallbackCustom {
      * ): [EntityType, int, int, int] | undefined {}
      * ```
      */
-    PRE_ENTITY_SPAWN_FILTER = 102,
+    PRE_ENTITY_SPAWN_FILTER = 103,
     /**
      * Fires from the `PRE_PICKUP_COLLISION` callback when a player touches a collectible pedestal and
      * meets all of the conditions to pick it up.
@@ -10616,7 +10709,7 @@ export declare enum ModCallbackCustom {
      * function preGetPedestal(player: EntityPlayer, collectible: EntityPickupCollectible): void {}
      * ```
      */
-    PRE_GET_PEDESTAL = 103,
+    PRE_GET_PEDESTAL = 104,
     /**
      * 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).
@@ -10636,7 +10729,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    PRE_ITEM_PICKUP = 104,
+    PRE_ITEM_PICKUP = 105,
     /**
      * 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
@@ -10650,7 +10743,7 @@ export declare enum ModCallbackCustom {
      * function preNewLevel(player: EntityPlayer): void {}
      * ```
      */
-    PRE_NEW_LEVEL = 105,
+    PRE_NEW_LEVEL = 106,
     /**
      * The exact same thing as the vanilla `PRE_NPC_COLLISION` callback, except this callback allows
      * you to specify extra arguments for additional filtration.
@@ -10671,7 +10764,7 @@ export declare enum ModCallbackCustom {
      * ): boolean | undefined {}
      * ```
      */
-    PRE_NPC_COLLISION_FILTER = 106,
+    PRE_NPC_COLLISION_FILTER = 107,
     /**
      * The exact same thing as the vanilla `PRE_NPC_UPDATE` callback, except this callback allows you
      * to specify extra arguments for additional filtration.
@@ -10688,7 +10781,7 @@ export declare enum ModCallbackCustom {
      * function preNPCUpdateFilter(entity: Entity): boolean | undefined {}
      * ```
      */
-    PRE_NPC_UPDATE_FILTER = 107,
+    PRE_NPC_UPDATE_FILTER = 108,
     /**
      * The exact same thing as the vanilla `PRE_ROOM_ENTITY_SPAWN` callback, except this callback
      * allows you to specify extra arguments for additional filtration.
@@ -10711,7 +10804,7 @@ export declare enum ModCallbackCustom {
      * ): [EntityType | GridEntityXMLType, int, int] | undefined {}
      * ```
      */
-    PRE_ROOM_ENTITY_SPAWN_FILTER = 108
+    PRE_ROOM_ENTITY_SPAWN_FILTER = 109
 }
 
 /**