isaacscript-common 7.4.2 → 7.5.1

package/dist/index.d.ts

@@ -104,7 +104,10 @@ declare interface AddCallbackParameterCustom {
     [ModCallbackCustom.POST_GRID_ENTITY_COLLISION]: PostGridEntityCollisionRegisterParameters;
     [ModCallbackCustom.POST_GRID_ENTITY_CUSTOM_BROKEN]: PostGridEntityCustomBrokenRegisterParameters;
     [ModCallbackCustom.POST_GRID_ENTITY_CUSTOM_COLLISION]: PostGridEntityCustomCollisionRegisterParameters;
+    [ModCallbackCustom.POST_GRID_ENTITY_CUSTOM_INIT]: PostGridEntityCustomInitRegisterParameters;
+    [ModCallbackCustom.POST_GRID_ENTITY_CUSTOM_REMOVE]: PostGridEntityCustomRemoveRegisterParameters;
     [ModCallbackCustom.POST_GRID_ENTITY_CUSTOM_RENDER]: PostGridEntityCustomRenderRegisterParameters;
+    [ModCallbackCustom.POST_GRID_ENTITY_CUSTOM_STATE_CHANGED]: PostGridEntityCustomStateChangedRegisterParameters;
     [ModCallbackCustom.POST_GRID_ENTITY_CUSTOM_UPDATE]: PostGridEntityCustomUpdateRegisterParameters;
     [ModCallbackCustom.POST_GRID_ENTITY_INIT]: PostGridEntityInitRegisterParameters;
     [ModCallbackCustom.POST_GRID_ENTITY_REMOVE]: PostGridEntityRemoveRegisterParameters;
@@ -959,53 +962,63 @@ export declare function countEntities(entityType?: EntityType, variant?: number,
  */
 export declare function countSetBits(n: int): int;
 
-/** An object that represents a possible boss for a custom stage. */
+/**
+ * An object that represents a possible boss for a custom stage. This can be for a vanilla boss or a
+ * custom boss.
+ */
 export declare interface CustomStageBossPoolEntry {
     /**
-     * The name of the boss. This must correspond to the entry in "entities2.xml".
-     *
-     * Note that since there is no way to determine the corresponding `EntityType` of the boss during
-     * compile-time, you must specify the `EntityType` at run-time when your mod first loads using the
-     * `registerCustomBoss` helper function.
+     * The name of the boss. This should correspond to the entry for the boss in the "entities2.xml"
+     * file.
      */
     name: string;
+    /**
+     * The arbitrary sub-type chosen for this boss, ranging between 1 and 999. You must set the boss
+     * rooms for this boss to this sub-type in Basement Renovator by right-clicking on the room on the
+     * right-hand-side.
+     *
+     * It does not matter if the arbitrary sub-type overlaps with any of the vanilla `BossID` values
+     * (e.g. vanilla Boss Room sub-types in "00.special_rooms.stb"). It also does not matter if this
+     * value overlaps with the values from other mods.
+     *
+     * If you are creating an entry for a vanilla boss, it is recommended that you match the sub-type
+     * with the corresponding vanilla `BossID` value. This will make things a bit easier to understand
+     * for people working on your mod, but is not a hard requirement.
+     *
+     * @minimum 1
+     * @maximum 999
+     */
+    subType: number;
     /**
      * The weight of the boss. This is used when randomly selecting which boss to use for the floor.
      * For example, use a value of 1 if you want this boss to be equally likely as any other boss, 0.5
      * if you want it to be half as likely, 2 if you want it to be twice as likely, and so on.
      */
     weight: number;
+    /** Optional. A collection of sprites used for the boss on the "versus" screen. */
+    versusScreen?: {
+        /**
+         * Mandatory. The full path to the spritesheet that contains the graphics of the name of the
+         * boss that will be displayed on the top of the boss "versus" screen.
+         *
+         * If not specified, a sprite showing "???" will be used.
+         */
+        namePNGPath: string;
+        /**
+         * Mandatory. The full path to the spritesheet that contains the portrait of the boss that will
+         * be displayed on the right side of the boss "versus" screen.
+         *
+         * If not specified, a sprite showing "???" will be used.
+         */
+        portraitPNGPath: string;
+    };
 }
 
-/**
- * An object that represents a custom stage. The "metadata.lua" file contains an array of these
- * objects. Besides the room metadata, the data is the same as what is specified inside the
- * "tsconfig.json" file.
- *
- * The `CustomStage` interface extends this, adding more data.
- */
-export declare interface CustomStageLua extends CustomStageTSConfig {
-    readonly roomsMetadata: readonly CustomStageRoomMetadata[];
-}
-
-/**
- * Metadata about a custom stage room. Each custom stage object contains an array with metadata for
- * each room.
- */
-export declare type CustomStageRoomMetadata = Readonly<{
-    type: number;
-    variant: number;
-    subType: number;
-    shape: number;
-    doorSlotFlags: number;
-    weight: number;
-}>;
-
 /**
  * A description of a custom stage shadow. (In this context, "shadows" are the outlines from things
  * on the roof. For example, in Basement, a shadow of a sideways V is used, among others.)
  */
-export declare type CustomStageShadow = Readonly<{
+export declare interface CustomStageShadow {
     /**
      * The full path to the shadow overlay PNG file.
      *
@@ -1019,7 +1032,7 @@ export declare type CustomStageShadow = Readonly<{
      * If not specified, an object of `{ r: 0, g: 0, b: 0, a: 0.25 }` will be used (which corresponds
      * to 75% faded black).
      */
-    color?: Readonly<{
+    color?: {
         /**
          * @minimum 0
          * @maximum 1
@@ -1040,8 +1053,8 @@ export declare type CustomStageShadow = Readonly<{
          * @maximum 1
          */
         a: number;
-    }>;
-}>;
+    };
+}
 
 /**
  * This is the format of a custom stage in the "isaacscript" section of the "tsconfig.json" file.
@@ -1054,7 +1067,7 @@ export declare type CustomStageShadow = Readonly<{
  *
  * The `CustomStageLua` interface extends this, adding room metadata.
  */
-export declare type CustomStageTSConfig = Readonly<{
+export declare interface CustomStageTSConfig {
     /** Mandatory. The name of the custom stage. */
     name: string;
     /**
@@ -1079,8 +1092,14 @@ export declare type CustomStageTSConfig = Readonly<{
      * number of the stage that will be warped to and used as a basis for the stage by the level
      * generation algorithm.
      *
-     * (It is not possible to use Basement 1 as a base stage due to conflicts with the `Game.SetStage`
-     * method.)
+     * For example, if you wanted to have a custom stage with a small amount of rooms per floor, then
+     * you should choose 2 as a base. (This would copy the number of rooms that would appear in
+     * Basement 2.) And if you wanted to have a custom stage with the maximum amount of rooms, then
+     * you should choose 13 as a base. (This would copy the number of rooms that would appear on The
+     * Void.)
+     *
+     * It is not possible to use Basement 1 as a base stage due to conflicts with the `Game.SetStage`
+     * method.
      *
      * If not specified, `LevelStage.BASEMENT_2` (2) will be used.
      *
@@ -1104,7 +1123,7 @@ export declare type CustomStageTSConfig = Readonly<{
      * the graphics for the walls and floor.) If not specified, the graphics for Basement will be
      * used.
      */
-    backdropPNGPaths?: Readonly<{
+    backdropPNGPaths?: {
         /**
          * An array that contains the full paths to the graphic files that are used for the floor in
          * narrow rooms. (The "n" stands for "narrow").
@@ -1114,7 +1133,7 @@ export declare type CustomStageTSConfig = Readonly<{
          *
          * For an example of this, see the vanilla file "resources/gfx/backdrop/01_basement_nfloor.png".
          */
-        nFloors: readonly string[];
+        nFloors: string[];
         /**
          * An array that contains the full paths to the graphic files that are used for the floor in L
          * rooms.
@@ -1124,7 +1143,7 @@ export declare type CustomStageTSConfig = Readonly<{
          *
          * For an example of this, see the vanilla file "resources/gfx/backdrop/01_lbasementfloor.png".
          */
-        lFloors: readonly string[];
+        lFloors: string[];
         /**
          * An array that contains the full paths to the graphic files that are used for the walls of the
          * floor.
@@ -1136,7 +1155,7 @@ export declare type CustomStageTSConfig = Readonly<{
          * the vanilla file, they concatenate all four variations together into one PNG file. However,
          * for the custom stages feature, you must separate each wall variation into a separate file.)
          */
-        walls: readonly string[];
+        walls: string[];
         /**
          * An array that contains the full paths to the graphic files for the stage's corners.
          *
@@ -1150,8 +1169,8 @@ export declare type CustomStageTSConfig = Readonly<{
          * you must separate each corner variation into a separate file (and put it in a different file
          * from the walls).
          */
-        corners: readonly string[];
-    }>;
+        corners: string[];
+    };
     /**
      * Optional. The full path to the spritesheet that contains the graphics of the decorations for
      * the floor.
@@ -1185,7 +1204,7 @@ export declare type CustomStageTSConfig = Readonly<{
      * Optional. A collection of paths that contain graphics for the doors of the floor. If not
      * specified, the doors for Basement will be used.
      */
-    doorPNGPaths?: Readonly<{
+    doorPNGPaths?: {
         /**
          * Optional. The full path to the spritesheet that contains the graphics of the normal doors for
          * the floor.
@@ -1282,14 +1301,14 @@ export declare type CustomStageTSConfig = Readonly<{
          * located at: `resources/gfx/grid/door_02b_chestroomdoor.png`
          */
         chestRoom?: string;
-    }>;
+    };
     /**
      * Optional. An array of shadow objects that describe the graphics for the custom shadows of the
      * floor. (In this context, "shadows" are the outlines from things on the roof. For example, in
      * Basement, a shadow of a sideways V is used, among others.) If not specified, no extra shadows
      * will be drawn.
      */
-    shadows?: Readonly<{
+    shadows?: {
         /**
          * Optional. An array containing the shadows that will be used in rooms of shape
          * `RoomShape.SHAPE_1x1` (1), `RoomShape.IH` (2), and `RoomShape.IV` (3).
@@ -1298,7 +1317,7 @@ export declare type CustomStageTSConfig = Readonly<{
          *
          * If not specified, no extra shadows will be drawn in these room shapes.
          */
-        "1x1"?: readonly CustomStageShadow[];
+        "1x1"?: CustomStageShadow[];
         /**
          * Optional. An array containing the shadows that will be used in rooms of shape
          * `RoomShape.SHAPE_1x2` (4) and `RoomShape.IIV` (5).
@@ -1307,7 +1326,7 @@ export declare type CustomStageTSConfig = Readonly<{
          *
          * If not specified, no extra shadows will be drawn in these room shapes.
          */
-        "1x2"?: readonly CustomStageShadow[];
+        "1x2"?: CustomStageShadow[];
         /**
          * Optional. An array containing the shadows that will be used in rooms of shape
          * `RoomShape.SHAPE_2x1` (6) and `RoomShape.IIH` (7).
@@ -1316,7 +1335,7 @@ export declare type CustomStageTSConfig = Readonly<{
          *
          * If not specified, no extra shadows will be drawn in these room shapes.
          */
-        "2x1"?: readonly CustomStageShadow[];
+        "2x1"?: CustomStageShadow[];
         /**
          * Optional. An array containing the shadows that will be used in rooms of shape
          * `RoomShape.SHAPE_2x2` (8), `RoomShape.LTL` (9), `RoomShape.LTR` (10), `RoomShape.LBL` (11),
@@ -1326,12 +1345,20 @@ export declare type CustomStageTSConfig = Readonly<{
          *
          * If not specified, no extra shadows will be drawn in these room shapes.
          */
-        "2x2"?: readonly CustomStageShadow[];
-    }>;
-    /** Optional. An array containing the bosses that should be used for the stage. */
-    bossPool?: readonly CustomStageBossPoolEntry[];
-    /** Optional. A collection of colors used in the boss "versus" screen. */
-    versusScreen?: Readonly<{
+        "2x2"?: CustomStageShadow[];
+    };
+    /**
+     * Optional. An array containing the bosses that should be used for the stage. This can include
+     * both vanilla bosses and modded bosses.
+     */
+    bossPool?: CustomStageBossPoolEntry[];
+    /**
+     * Optional. A collection of colors used for in the boss "versus" screen for all of the bosses.
+     *
+     * Note that these graphics will only be applied if one or more bosses are specified in the
+     * `bossPool` field.
+     */
+    versusScreen?: {
         /**
          * Optional. An object representing the color to use for the background of the boss "versus"
          * screen. If not specified, the color for Basement 1 will be used.
@@ -1339,7 +1366,7 @@ export declare type CustomStageTSConfig = Readonly<{
          * For a list of the colors that correspond to the vanilla stages, see
          * `versusScreenBackgroundColors.ts`.
          */
-        backgroundColor?: Readonly<{
+        backgroundColor?: {
             /**
              * @minimum 0
              * @maximum 1
@@ -1360,7 +1387,7 @@ export declare type CustomStageTSConfig = Readonly<{
              * @maximum 1
              */
             a: number;
-        }>;
+        };
         /**
          * Optional. An object representing the color to use for the dirt spots in the boss "versus"
          * screen. (There are two dirt spots; one for the player and one for the boss.) If not
@@ -1369,7 +1396,7 @@ export declare type CustomStageTSConfig = Readonly<{
          * For a list of the colors that correspond to the vanilla stages, see
          * `versusScreenDirtSpotColors.ts`.
          */
-        dirtSpotColor?: Readonly<{
+        dirtSpotColor?: {
             /**
              * @minimum 0
              * @maximum 1
@@ -1390,9 +1417,9 @@ export declare type CustomStageTSConfig = Readonly<{
              * @maximum 1
              */
             a: number;
-        }>;
-    }>;
-}>;
+        };
+    };
+}
 
 /**
  * `deepCopy` is a semi-generic deep cloner. It will recursively copy all of the values so that none
@@ -1434,7 +1461,8 @@ export declare const DEFAULT_BASE_STAGE_TYPE = StageType.ORIGINAL;
 export declare const DEFAULT_ITEM_POOL_TYPE = ItemPoolType.TREASURE;
 
 /**
- * `DefaultMap` is a data structure that makes working with default values easier.
+ * `DefaultMap` is a data structure that makes working with default values easier. It extends a
+ * `Map` and adds additional methods.
  *
  * It is a common pattern to look up a value in a `Map`, and then, if the value does not exist, set
  * a default value for the key, and then return the default value. `DefaultMap` abstracts this
@@ -1518,7 +1546,7 @@ export declare class DefaultMap<Key, Value, Args extends unknown[] = []> extends
     private defaultValueFactory;
     /**
      * See the main `DefaultMap` documentation:
-     * https://isaacscript.github.io/isaacscript-common/classes/classes_DefaultMap.DefaultMap
+     * https://isaacscript.github.io/isaacscript-common/other/classes/DefaultMap
      */
     constructor(defaultValueOrFactoryFunction: Value | FactoryFunction<Value, Args>, initializerArray?: Iterable<[Key, Value]>);
     /**
@@ -1788,8 +1816,16 @@ export declare function doesPlayerHaveAllSoulHearts(player: EntityPlayer): boole
 
 export declare const DOOR_HITBOX_RADIUS = 11;
 
+export declare function doorSlotFlagsToDoorSlots(doorSlotFlags: BitFlags<DoorSlotFlag>): DoorSlot[];
+
 export declare function doorSlotFlagToDoorSlot(doorSlotFlag: DoorSlotFlag): DoorSlot;
 
+/**
+ * Helper function to convert an array of door slots or a set of door slots to the resulting bit
+ * flag number.
+ */
+export declare function doorSlotsToDoorSlotFlags(doorSlots: DoorSlot[] | readonly DoorSlot[] | Set<DoorSlot> | ReadonlySet<DoorSlot>): BitFlags<DoorSlotFlag>;
+
 export declare function doorSlotToDirection(doorSlot: DoorSlot): Direction;
 
 export declare function doorSlotToDoorSlotFlag(doorSlot: DoorSlot): DoorSlotFlag;
@@ -1913,6 +1949,25 @@ export declare function enableAllInputsExceptFor(key: string, blacklist: Set<But
  */
 export declare function enableAllSound(key: string): void;
 
+/**
+ * Helper function to enable some IsaacScript features that are useful when developing a mod. They
+ * shouldn't be enabled when your mod goes to production (i.e. it is uploaded to the Steam
+ * Workshop).
+ *
+ * The list of development features that are enabled are as follows:
+ *
+ * - `saveDataManagerSetGlobal` - Sets your local variables registered with the save data manager as
+ *   global variables so you can access them from the in-game console.
+ * - `setLogFunctionsGlobal` - Sets the various log functions global so that you can access them
+ *   from the in-game console.
+ * - `enableExtraConsoleCommands` - Enables many extra in-game console commands that make warping
+ *   around easier (like e.g. `angel` to warp to the Angel Room).
+ * - `enableFastReset` - Makes it so that the r key resets the game instantaneously.
+ * - `removeFadeIn` - Removes the slow fade in that occurs at the beginning of the run, so that you
+ *   can immediately start playing or testing.
+ */
+export declare function enableDevFeatures(mod: ModUpgraded): void;
+
 /**
  * Enables extra console commands which are useful for debugging. See [the
  * docs](https://isaacscript.github.io/isaacscript-common/features/extraConsoleCommands_listCommands)
@@ -2741,12 +2796,6 @@ export declare function getDoors(...roomTypes: RoomType[]): GridEntityDoor[];
  */
 export declare function getDoorSlotEnterPositionOffset(doorSlot: DoorSlot): Readonly<Vector>;
 
-/**
- * Helper function to convert an array of door slots or a set of door slots to the resulting bit
- * flag number.
- */
-export declare function getDoorSlotFlags(doorSlots: DoorSlot[] | readonly DoorSlot[] | Set<DoorSlot> | ReadonlySet<DoorSlot>): BitFlags<DoorSlotFlag>;
-
 /** Helper function to get the possible door slots that can exist for a given room shape. */
 export declare function getDoorSlotsForRoomShape(roomShape: RoomShape): ReadonlySet<DoorSlot>;
 
@@ -2876,7 +2925,7 @@ export declare function getEntityVelocities(entities?: Entity[]): Map<PtrHash, V
  * Also see the `getEnumKeys` and `getEnumValues` helper functions.
  *
  * For a more in depth explanation, see:
- * https://isaacscript.github.io/gotchas#iterating-over-enums
+ * https://isaacscript.github.io/main/gotchas#iterating-over-enums
  */
 export declare function getEnumEntries<T>(transpiledEnum: T): Array<[key: string, value: T[keyof T]]>;
 
@@ -2894,7 +2943,7 @@ export declare function getEnumEntries<T>(transpiledEnum: T): Array<[key: string
  * Also see the `getEnumEntries` and `getEnumValues` helper functions.
  *
  * For a more in depth explanation, see:
- * https://isaacscript.github.io/gotchas#iterating-over-enums
+ * https://isaacscript.github.io/main/gotchas#iterating-over-enums
  */
 export declare function getEnumKeys<T>(transpiledEnum: T): string[];
 
@@ -2915,7 +2964,7 @@ export declare function getEnumLength<T>(transpiledEnum: T): int;
  * Also see the `getEnumEntries` and `getEnumKeys` helper functions.
  *
  * For a more in depth explanation, see:
- * https://isaacscript.github.io/gotchas#iterating-over-enums
+ * https://isaacscript.github.io/main/gotchas#iterating-over-enums
  */
 export declare function getEnumValues<T>(transpiledEnum: T): Array<T[keyof T]>;
 
@@ -5017,6 +5066,12 @@ export declare function inMineShaft(): boolean;
  */
 export declare function inMinibossRoomOf(minibossID: MinibossID): boolean;
 
+/**
+ * Helper function to check if the current room is a "mirror room" in Downpour or Dross. (These
+ * rooms are marked with a specific sub-type.)
+ */
+export declare function inMirrorRoom(): boolean;
+
 /**
  * Helper function to check if a given position is within a given rectangle.
  *
@@ -5837,7 +5892,7 @@ export declare function iterateTableInOrder<K, V>(luaMap: LuaMap<K, V>, func: (k
  */
 export declare function jsonDecode(jsonString: string): LuaMap<AnyNotNil, unknown>;
 
-/** Part of `JSONRooms`. */
+/** Part of `JSONRoomsFile`. */
 export declare interface JSONDoor {
     $: {
         /** Equal to "True" or "False". Needs to be converted to an `boolean`. */
@@ -5861,7 +5916,7 @@ export declare interface JSONDoor {
  */
 export declare function jsonEncode(luaTable: unknown): string;
 
-/** Part of `JSONRooms`. */
+/** Part of `JSONRoomsFile`. */
 export declare interface JSONEntity {
     $: {
         /** Needs to be converted to an `int`. */
@@ -5875,7 +5930,7 @@ export declare interface JSONEntity {
     };
 }
 
-/** Part of `JSONRooms`. */
+/** Part of `JSONRoomsFile`. */
 export declare interface JSONRoom {
     $: {
         /** Needs to be converted to an `int`. */
@@ -5900,6 +5955,7 @@ export declare interface JSONRoom {
     spawn: JSONSpawn[];
 }
 
+/** Part of `JSONRoomsFile`. */
 export declare interface JSONRooms {
     room: JSONRoom[];
 }
@@ -5907,7 +5963,7 @@ export declare interface JSONRooms {
 /**
  * The standard library has the feature to deploy a new room on-the-fly with the `deployJSONRoom`
  * helper function. It requires a `JSONRoomsFile` as an argument, which is simply an XML file
- * converted to JSON. (You create XML room files using the Basement Renovator program.)
+ * converted to JSON. (You can create XML room files using the Basement Renovator program.)
  *
  * You can convert your XML files using the following command:
  *
@@ -5923,7 +5979,7 @@ export declare interface JSONRoomsFile {
     rooms: JSONRooms;
 }
 
-/** Part of `JSONRooms`. */
+/** Part of `JSONRoomsFile`. */
 export declare interface JSONSpawn {
     $: {
         /** Needs to be converted to an `int`. */
@@ -6457,7 +6513,7 @@ export declare enum ModCallbackCustom {
     POST_EFFECT_INIT_LATE = 13,
     /**
      * Fires from the `POST_EFFECT_UPDATE` callback when an effect's state has changed from what it
-     * was on the previous frame.
+     * was on the previous frame. (In this context, "state" refers to the `EntityEffect.State` field.)
      *
      * When registering the callback, takes an optional second argument that will make the callback
      * only fire if it matches the `EffectVariant` provided.
@@ -6496,7 +6552,8 @@ export declare enum ModCallbackCustom {
     POST_FAMILIAR_INIT_LATE = 16,
     /**
      * Fires from the `POST_FAMILIAR_UPDATE` callback when a familiar's state has changed from what it
-     * was on the previous frame.
+     * was on the previous frame. (In this context, "state" refers to the `EntityFamiliar.State`
+     * field.)
      *
      * When registering the callback, takes an optional second argument that will make the callback
      * only fire if it matches the `FamiliarVariant` provided.
@@ -6569,7 +6626,8 @@ export declare enum ModCallbackCustom {
     POST_GREED_MODE_WAVE = 22,
     /**
      * 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.
+     * the broken state for the respective grid entity type. (For example, this will fire for a
+     * `GridEntityType.ROCK` (2) when its state changes to `RockState.BROKEN` (2).)
      *
      * When registering the callback, takes an optional second argument that will make the callback
      * only fire if it matches the `GridEntityType` provided.
@@ -6594,12 +6652,8 @@ export declare enum ModCallbackCustom {
      */
     POST_GRID_ENTITY_COLLISION = 24,
     /**
-     * Fires from the `POST_UPDATE` callback when a grid entity created with the
-     * `spawnCustomGridEntity` helper function is hit by an explosion.
-     *
-     * In most cases, you will want to remove the grid entity inside of this callback in order to
-     * prevent further "broken" callbacks from firing. (This would not be the case if you were trying
-     * to emulate a super tinted rock that takes multiple explosions to destroy, for example.)
+     * The same as the `POST_GRID_ENTITY_BROKEN` callback, but only fires for grid entities created
+     * with the `spawnCustomGridEntity` helper function.
      *
      * When registering the callback, takes an optional second argument that will make the callback
      * only fire if it matches the `GridEntityType` provided.
@@ -6613,23 +6667,54 @@ export declare enum ModCallbackCustom {
      */
     POST_GRID_ENTITY_CUSTOM_BROKEN = 25,
     /**
-     * Fires from the `POST_UPDATE` callback a new entity collides with a grid entity created with the
-     * `spawnCustomGridEntity` helper function.
+     * The same as the `POST_GRID_ENTITY_COLLISION` callback, but only fires for grid entities created
+     * with the `spawnCustomGridEntity` helper function.
      *
      * When registering the callback, takes an optional second argument that will make the callback
      * only fire if it matches the `GridEntityType` provided.
      *
      * ```ts
-     * function postGridEntityCustomRender(
+     * function postGridEntityCustomCollision(
      *   gridEntity: GridEntity,
      *   gridEntityTypeCustom: GridEntityType,
+     *   entity: Entity,
      * ): void {}
      * ```
      */
     POST_GRID_ENTITY_CUSTOM_COLLISION = 26,
     /**
-     * Fires from the `POST_RENDER` callback on every frame that a grid entity created with the
-     * `spawnCustomGridEntity` helper function exists.
+     * The same as the `POST_GRID_ENTITY_INIT` callback, but only fires for grid entities created with
+     * the `spawnCustomGridEntity` helper function.
+     *
+     * When registering the callback, takes an optional second argument that will make the callback
+     * only fire if it matches the `GridEntityType` provided.
+     *
+     * ```ts
+     * function postGridEntityCustomInit(
+     *   gridEntity: GridEntity,
+     *   gridEntityTypeCustom: GridEntityType,
+     * ): void {}
+     * ```
+     */
+    POST_GRID_ENTITY_CUSTOM_INIT = 27,
+    /**
+     * The same as the `POST_GRID_ENTITY_REMOVE` callback, but only fires for grid entities created
+     * with the `spawnCustomGridEntity` helper function.
+     *
+     * When registering the callback, takes an optional second argument that will make the callback
+     * only fire if it matches the `GridEntityType` provided.
+     *
+     * ```ts
+     * function postGridEntityCustomRemove(
+     *   gridIndex: int,
+     *   gridEntityTypeCustom: GridEntityType,
+     * ): void {}
+     * ```
+     */
+    POST_GRID_ENTITY_CUSTOM_REMOVE = 28,
+    /**
+     * The same as the `POST_GRID_ENTITY_RENDER` callback, but only fires for grid entities created
+     * with the `spawnCustomGridEntity` helper function.
      *
      * When registering the callback, takes an optional second argument that will make the callback
      * only fire if it matches the `GridEntityType` provided.
@@ -6641,10 +6726,27 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_GRID_ENTITY_CUSTOM_RENDER = 27,
+    POST_GRID_ENTITY_CUSTOM_RENDER = 29,
+    /**
+     * The same as the `POST_GRID_ENTITY_STATE_CHANGED` callback, but only fires for grid entities
+     * created with the `spawnCustomGridEntity` helper function.
+     *
+     * When registering the callback, takes an optional second argument that will make the callback
+     * only fire if it matches the `GridEntityType` provided.
+     *
+     * ```ts
+     * function postGridEntityCustomStateChanged(
+     *   gridEntity: GridEntity,
+     *   gridEntityTypeCustom: GridEntityType,
+     *   oldState: int,
+     *   newState: int,
+     * ): void {}
+     * ```
+     */
+    POST_GRID_ENTITY_CUSTOM_STATE_CHANGED = 30,
     /**
-     * Fires from the `POST_UPDATE` callback on every frame that a grid entity created with the
-     * `spawnCustomGridEntity` helper function exists.
+     * The same as the `POST_GRID_ENTITY_UPDATE` callback, but only fires for grid entities created
+     * with the `spawnCustomGridEntity` helper function.
      *
      * When registering the callback, takes an optional second argument that will make the callback
      * only fire if it matches the `GridEntityType` provided.
@@ -6656,7 +6758,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_GRID_ENTITY_CUSTOM_UPDATE = 28,
+    POST_GRID_ENTITY_CUSTOM_UPDATE = 31,
     /**
      * Fires when a new grid entity is initialized. Specifically, this is either:
      *
@@ -6672,11 +6774,13 @@ export declare enum ModCallbackCustom {
      * function postGridEntityInit(gridEntity: GridEntity): void {}
      * ```
      */
-    POST_GRID_ENTITY_INIT = 29,
+    POST_GRID_ENTITY_INIT = 32,
     /**
      * 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).
      *
+     * (Leaving a room with a grid entity does not count as "removing" it.)
+     *
      * When registering the callback, takes an optional second argument that will make the callback
      * only fire if it matches the `GridEntityType` provided.
      *
@@ -6687,7 +6791,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_GRID_ENTITY_REMOVE = 30,
+    POST_GRID_ENTITY_REMOVE = 33,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a grid entity exists.
      *
@@ -6700,9 +6804,10 @@ export declare enum ModCallbackCustom {
      * function postGridEntityRender(gridEntity: GridEntity): void {}
      * ```
      */
-    POST_GRID_ENTITY_RENDER = 31,
+    POST_GRID_ENTITY_RENDER = 34,
     /**
-     * Fires from the `POST_UPDATE` callback when a grid entity changes its state.
+     * Fires from the `POST_UPDATE` callback when a grid entity changes its state. (In this context,
+     * "state" refers to the `GridEntity.State` field.)
      *
      * When registering the callback, takes an optional second argument that will make the callback
      * only fire if it matches the `GridEntityType` provided.
@@ -6715,7 +6820,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_GRID_ENTITY_STATE_CHANGED = 32,
+    POST_GRID_ENTITY_STATE_CHANGED = 35,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a grid entity exists.
      *
@@ -6728,7 +6833,7 @@ export declare enum ModCallbackCustom {
      * function postGridEntityUpdate(gridEntity: GridEntity): void {}
      * ```
      */
-    POST_GRID_ENTITY_UPDATE = 33,
+    POST_GRID_ENTITY_UPDATE = 36,
     /**
      * Fires from the `POST_PEFFECT_UPDATE` callback when the player loses a Holy Mantle temporary
      * collectible effect.
@@ -6750,7 +6855,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_HOLY_MANTLE_REMOVED = 34,
+    POST_HOLY_MANTLE_REMOVED = 37,
     /**
      * Fires from `POST_PEFFECT_UPDATE` callback when the player loses charge on their active
      * collectible item, implying that the item was just used.
@@ -6772,7 +6877,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_ITEM_DISCHARGE = 35,
+    POST_ITEM_DISCHARGE = 38,
     /**
      * Fires from the `POST_PEFFECT_UPDATE` 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 actually
@@ -6792,7 +6897,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_ITEM_PICKUP = 36,
+    POST_ITEM_PICKUP = 39,
     /**
      * Fires on the first `POST_KNIFE_UPDATE` frame for each knife.
      *
@@ -6806,7 +6911,7 @@ export declare enum ModCallbackCustom {
      * function postKnifeInitLate(knife: EntityKnife): void {}
      * ```
      */
-    POST_KNIFE_INIT_LATE = 37,
+    POST_KNIFE_INIT_LATE = 40,
     /**
      * Fires on the first `POST_LASER_UPDATE` frame for each laser.
      *
@@ -6820,7 +6925,7 @@ export declare enum ModCallbackCustom {
      * function postLaserInitLate(laser: EntityLaser): void {}
      * ```
      */
-    POST_LASER_INIT_LATE = 38,
+    POST_LASER_INIT_LATE = 41,
     /**
      * 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:
@@ -6837,7 +6942,7 @@ export declare enum ModCallbackCustom {
      * function postNewLevelReordered(): void {}
      * ```
      */
-    POST_NEW_LEVEL_REORDERED = 39,
+    POST_NEW_LEVEL_REORDERED = 42,
     /**
      * 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
@@ -6848,7 +6953,7 @@ export declare enum ModCallbackCustom {
      * function postNewRoomEarly(): void {}
      * ```
      */
-    POST_NEW_ROOM_EARLY = 40,
+    POST_NEW_ROOM_EARLY = 43,
     /**
      * 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:
@@ -6865,7 +6970,7 @@ export declare enum ModCallbackCustom {
      * function postNewRoomReordered(): void {}
      * ```
      */
-    POST_NEW_ROOM_REORDERED = 41,
+    POST_NEW_ROOM_REORDERED = 44,
     /**
      * Fires on the first `NPC_UPDATE` frame for each NPC.
      *
@@ -6879,10 +6984,10 @@ export declare enum ModCallbackCustom {
      * function postNPCInitLate(npc: EntityNPC): void {}
      * ```
      */
-    POST_NPC_INIT_LATE = 42,
+    POST_NPC_INIT_LATE = 45,
     /**
      * Fires from the `POST_NPC_UPDATE` callback when an NPC's state has changed from what it was on
-     * the previous frame.
+     * the previous frame. (In this context, "state" refers to the `EntityNPC.State` field.)
      *
      * - When registering the callback, takes an optional second argument that will make the callback
      *   only fire if it matches the `EntityType` provided.
@@ -6897,7 +7002,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_NPC_STATE_CHANGED = 43,
+    POST_NPC_STATE_CHANGED = 46,
     /**
      * Similar to the vanilla callback of the same name, but fires after the `POST_GAME_STARTED`
      * callback fires (if the player is being updated on the 0th game frame of the run).
@@ -6920,7 +7025,7 @@ export declare enum ModCallbackCustom {
      * function postPEffectUpdateReordered(player: EntityPlayer): void {}
      * ```
      */
-    POST_PEFFECT_UPDATE_REORDERED = 44,
+    POST_PEFFECT_UPDATE_REORDERED = 47,
     /**
      * Fires on the first `POST_RENDER` frame that a pickup plays the "Collect" animation.
      *
@@ -6933,7 +7038,7 @@ export declare enum ModCallbackCustom {
      * function postPickupCollect(pickup: EntityPickup, player: EntityPlayer): void {}
      * ```
      */
-    POST_PICKUP_COLLECT = 45,
+    POST_PICKUP_COLLECT = 48,
     /**
      * Fires from the `POST_PICKUP_INIT` callback on the first time that a player has seen the
      * respective pickup on the run.
@@ -6948,7 +7053,7 @@ export declare enum ModCallbackCustom {
      * function postPickupInitFirst(pickup: EntityPickup): void {}
      * ```
      */
-    POST_PICKUP_INIT_FIRST = 46,
+    POST_PICKUP_INIT_FIRST = 49,
     /**
      * Fires on the first `POST_PICKUP_UPDATE` frame for each pickup.
      *
@@ -6962,10 +7067,10 @@ export declare enum ModCallbackCustom {
      * function postPickupInitLate(pickup: EntityPickup): void {}
      * ```
      */
-    POST_PICKUP_INIT_LATE = 47,
+    POST_PICKUP_INIT_LATE = 50,
     /**
      * Fires from the `POST_PICKUP_UPDATE` callback when a pickup's state has changed from what it was
-     * on the previous frame.
+     * on the previous frame. (In this context, "state" refers to the `EntityPickup.State` field.)
      *
      * When registering the callback, takes an optional second argument that will make the callback
      * only fire if it matches the `PickupVariant` provided.
@@ -6978,7 +7083,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PICKUP_STATE_CHANGED = 48,
+    POST_PICKUP_STATE_CHANGED = 51,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a pit exists.
      *
@@ -6989,7 +7094,7 @@ export declare enum ModCallbackCustom {
      * function postPitRender(pit: GridEntityPit): void {}
      * ```
      */
-    POST_PIT_RENDER = 49,
+    POST_PIT_RENDER = 52,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a pit exists.
      *
@@ -7000,7 +7105,7 @@ export declare enum ModCallbackCustom {
      * function postPitUpdate(pit: GridEntityPit): void {}
      * ```
      */
-    POST_PIT_UPDATE = 50,
+    POST_PIT_UPDATE = 53,
     /**
      * Fires from the `POST_PEFFECT_UPDATE` 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` enum.
@@ -7020,7 +7125,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PLAYER_CHANGE_HEALTH = 51,
+    POST_PLAYER_CHANGE_HEALTH = 54,
     /**
      * Fires from the `POST_PEFFECT_UPDATE` callback when one of the player's stats change from what
      * they were on the previous frame.
@@ -7049,7 +7154,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PLAYER_CHANGE_STAT = 52,
+    POST_PLAYER_CHANGE_STAT = 55,
     /**
      * Fires from the `POST_PEFFECT_UPDATE` callback when a player entity changes its player type
      * (i.e. character) from what it was on the previous frame. For example, it will fire after using
@@ -7067,7 +7172,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PLAYER_CHANGE_TYPE = 53,
+    POST_PLAYER_CHANGE_TYPE = 56,
     /**
      * Fires from the `POST_PEFFECT_UPDATE` callback when a player's collectible count is higher than
      * what it was on the previous frame.
@@ -7082,7 +7187,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PLAYER_COLLECTIBLE_ADDED = 54,
+    POST_PLAYER_COLLECTIBLE_ADDED = 57,
     /**
      * Fires from the `POST_PEFFECT_UPDATE` callback when a player's collectible count is lower than
      * what it was on the previous frame.
@@ -7097,7 +7202,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PLAYER_COLLECTIBLE_REMOVED = 55,
+    POST_PLAYER_COLLECTIBLE_REMOVED = 58,
     /**
      * Fires from the `ENTITY_TAKE_DMG` callback when a player takes fatal damage. Return false to
      * prevent the fatal damage.
@@ -7114,7 +7219,7 @@ export declare enum ModCallbackCustom {
      * function postPlayerFatalDamage(player: EntityPlayer): boolean | undefined {}
      * ```
      */
-    POST_PLAYER_FATAL_DAMAGE = 56,
+    POST_PLAYER_FATAL_DAMAGE = 59,
     /**
      * Fires on the first `POST_PEFFECT_UPDATE_REORDERED` frame for each player, similar to the
      * `POST_PLAYER_INIT_LATE` callback, with two changes:
@@ -7135,7 +7240,7 @@ export declare enum ModCallbackCustom {
      * function postPlayerInitFirst(player: EntityPlayer): void {}
      * ```
      */
-    POST_PLAYER_INIT_FIRST = 57,
+    POST_PLAYER_INIT_FIRST = 60,
     /**
      * Fires on the first `POST_PEFFECT_UPDATE_REORDERED` frame for each player.
      *
@@ -7154,7 +7259,7 @@ export declare enum ModCallbackCustom {
      * function postPlayerInitLate(pickup: EntityPickup): void {}
      * ```
      */
-    POST_PLAYER_INIT_LATE = 58,
+    POST_PLAYER_INIT_LATE = 61,
     /**
      * 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).
@@ -7177,7 +7282,7 @@ export declare enum ModCallbackCustom {
      * function postPlayerRenderReordered(player: EntityPlayer): void {}
      * ```
      */
-    POST_PLAYER_RENDER_REORDERED = 59,
+    POST_PLAYER_RENDER_REORDERED = 62,
     /**
      * Similar to the vanilla callback of the same name, but fires after the `POST_GAME_STARTED`
      * callback fires (if the player is being updated on the 0th game frame of the run).
@@ -7200,7 +7305,7 @@ export declare enum ModCallbackCustom {
      * function postPlayerUpdateReordered(player: EntityPlayer): void {}
      * ```
      */
-    POST_PLAYER_UPDATE_REORDERED = 60,
+    POST_PLAYER_UPDATE_REORDERED = 63,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a poop exists.
      *
@@ -7211,7 +7316,7 @@ export declare enum ModCallbackCustom {
      * function postPoopRender(poop: GridEntityPoop): void {}
      * ```
      */
-    POST_POOP_RENDER = 61,
+    POST_POOP_RENDER = 64,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a poop exists.
      *
@@ -7222,7 +7327,7 @@ export declare enum ModCallbackCustom {
      * function postPoopUpdate(poop: GridEntityPoop): void {}
      * ```
      */
-    POST_POOP_UPDATE = 62,
+    POST_POOP_UPDATE = 65,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a pressure plate exists.
      *
@@ -7233,7 +7338,7 @@ export declare enum ModCallbackCustom {
      * function postPressurePlateRender(pressurePlate: GridEntityPressurePlate): void {}
      * ```
      */
-    POST_PRESSURE_PLATE_RENDER = 63,
+    POST_PRESSURE_PLATE_RENDER = 66,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a pressure plate exists.
      *
@@ -7244,7 +7349,7 @@ export declare enum ModCallbackCustom {
      * function postPressurePlateUpdate(pressurePlate: GridEntityPressurePlate): void {}
      * ```
      */
-    POST_PRESSURE_PLATE_UPDATE = 64,
+    POST_PRESSURE_PLATE_UPDATE = 67,
     /**
      * Fires on the first `POST_PROJECTILE_UPDATE` frame for each projectile.
      *
@@ -7258,7 +7363,7 @@ export declare enum ModCallbackCustom {
      * function postProjectileInitLate(projectile: EntityProjectile): void {}
      * ```
      */
-    POST_PROJECTILE_INIT_LATE = 65,
+    POST_PROJECTILE_INIT_LATE = 68,
     /**
      * Fires from the `POST_PEFFECT_UPDATE` 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 exists.
@@ -7272,7 +7377,7 @@ export declare enum ModCallbackCustom {
      * function postPurchase(player: EntityPlayer, pickup: EntityPickup): void {}
      * ```
      */
-    POST_PURCHASE = 66,
+    POST_PURCHASE = 69,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a rock exists.
      *
@@ -7283,7 +7388,7 @@ export declare enum ModCallbackCustom {
      * function postRockRender(rock: GridEntityRock): void {}
      * ```
      */
-    POST_ROCK_RENDER = 67,
+    POST_ROCK_RENDER = 70,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a rock exists.
      *
@@ -7294,9 +7399,10 @@ export declare enum ModCallbackCustom {
      * function postRockUpdate(rock: GridEntityRock): void {}
      * ```
      */
-    POST_ROCK_UPDATE = 68,
+    POST_ROCK_UPDATE = 71,
     /**
-     * Fires from the `POST_UPDATE` callback when the clear state of a room changes.
+     * Fires from the `POST_UPDATE` callback when the clear state of a room changes (as according to
+     * the `Room.IsClear` method).
      *
      * When registering the callback, takes an optional second argument that will make the callback
      * only fire if the room clear state matches the boolean provided.
@@ -7305,7 +7411,7 @@ export declare enum ModCallbackCustom {
      * function postRoomClearChanged(roomClear: boolean): void {}
      * ```
      */
-    POST_ROOM_CLEAR_CHANGED = 69,
+    POST_ROOM_CLEAR_CHANGED = 72,
     /**
      * Fires from the `ENTITY_TAKE_DMG` callback when a player takes damage from spikes in a Sacrifice
      * Room.
@@ -7319,7 +7425,7 @@ export declare enum ModCallbackCustom {
      * function postSacrifice(player: EntityPlayer, numSacrifices: int): void {}
      * ```
      */
-    POST_SACRIFICE = 70,
+    POST_SACRIFICE = 73,
     /**
      * Fires from the `POST_RENDER` callback when a slot entity's animation changes.
      *
@@ -7330,7 +7436,7 @@ export declare enum ModCallbackCustom {
      * function postSlotAnimationChanged(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_ANIMATION_CHANGED = 71,
+    POST_SLOT_ANIMATION_CHANGED = 74,
     /**
      * Fires from the `POST_RENDER` callback when a slot plays the animation that indicates that it
      * has broken.
@@ -7344,7 +7450,7 @@ export declare enum ModCallbackCustom {
      * function postSlotDestroyed(slot: Entity, slotDestructionType: SlotDestructionType): void {}
      * ```
      */
-    POST_SLOT_DESTROYED = 72,
+    POST_SLOT_DESTROYED = 75,
     /**
      * Fires when a new slot entity is initialized. Specifically, this is either:
      *
@@ -7360,7 +7466,7 @@ export declare enum ModCallbackCustom {
      * function postSlotInit(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_INIT = 73,
+    POST_SLOT_INIT = 76,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a slot entity exists.
      *
@@ -7371,7 +7477,7 @@ export declare enum ModCallbackCustom {
      * function postSlotRender(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_RENDER = 74,
+    POST_SLOT_RENDER = 77,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a slot entity exists.
      *
@@ -7382,7 +7488,7 @@ export declare enum ModCallbackCustom {
      * function postSlotUpdate(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_UPDATE = 75,
+    POST_SLOT_UPDATE = 78,
     /**
      * Fires from the `POST_RENDER` callback on every frame that spikes exist.
      *
@@ -7393,7 +7499,7 @@ export declare enum ModCallbackCustom {
      * function postSpikesRender(spikes: GridEntitySpikes): void {}
      * ```
      */
-    POST_SPIKES_RENDER = 76,
+    POST_SPIKES_RENDER = 79,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that spikes exist.
      *
@@ -7404,7 +7510,7 @@ export declare enum ModCallbackCustom {
      * function postSpikesUpdate(spikes: GridEntitySpikes): void {}
      * ```
      */
-    POST_SPIKES_UPDATE = 77,
+    POST_SPIKES_UPDATE = 80,
     /**
      * Fires on the first `POST_TEAR_UPDATE` frame for each tear (which is when
      * `EntityTear.FrameCount` is equal to 0).
@@ -7419,7 +7525,7 @@ export declare enum ModCallbackCustom {
      * function postTearInitLate(tear: EntityTear): void {}
      * ```
      */
-    POST_TEAR_INIT_LATE = 78,
+    POST_TEAR_INIT_LATE = 81,
     /**
      * Fires on the second `POST_TEAR_UPDATE` frame for each tear (which is when
      * `EntityTear.FrameCount` is equal to 1).
@@ -7433,7 +7539,7 @@ export declare enum ModCallbackCustom {
      * function postTearInitVeryLate(tear: EntityTear): void {}
      * ```
      */
-    POST_TEAR_INIT_VERY_LATE = 79,
+    POST_TEAR_INIT_VERY_LATE = 82,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a TNT exists.
      *
@@ -7444,7 +7550,7 @@ export declare enum ModCallbackCustom {
      * function postTNTRender(tnt: GridEntityTNT): void {}
      * ```
      */
-    POST_TNT_RENDER = 80,
+    POST_TNT_RENDER = 83,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a TNT exists.
      *
@@ -7455,7 +7561,7 @@ export declare enum ModCallbackCustom {
      * function postTNTUpdate(tnt: GridEntityTNT): void {}
      * ```
      */
-    POST_TNT_UPDATE = 81,
+    POST_TNT_UPDATE = 84,
     /**
      * Fires from the `POST_PEFFECT_UPDATE` callback when a player gains or loses a new
      * transformation.
@@ -7473,7 +7579,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_TRANSFORMATION = 82,
+    POST_TRANSFORMATION = 85,
     /**
      * Fires from `ENTITY_TAKE_DMG` callback when a Wishbone or a Walnut breaks.
      *
@@ -7487,7 +7593,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_TRINKET_BREAK = 83,
+    POST_TRINKET_BREAK = 86,
     /**
      * Fires from the `POST_PEFFECT_UPDATE` 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 damage in
@@ -7502,7 +7608,7 @@ export declare enum ModCallbackCustom {
      * function preBerserkDeath(player: EntityPlayer): void {}
      * ```
      */
-    PRE_BERSERK_DEATH = 84,
+    PRE_BERSERK_DEATH = 87,
     /**
      * 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
@@ -7520,7 +7626,7 @@ export declare enum ModCallbackCustom {
      * function preCustomRevive(player: EntityPlayer): int | undefined {}
      * ```
      */
-    PRE_CUSTOM_REVIVE = 85,
+    PRE_CUSTOM_REVIVE = 88,
     /**
      * Fires from the `POST_PEFFECT_UPDATE` callback when an item becomes queued (i.e. when the player
      * begins to hold the item above their head).
@@ -7539,7 +7645,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    PRE_ITEM_PICKUP = 86,
+    PRE_ITEM_PICKUP = 89,
     /**
      * 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
@@ -7553,7 +7659,7 @@ export declare enum ModCallbackCustom {
      * function preNewLevel(player: EntityPlayer): void {}
      * ```
      */
-    PRE_NEW_LEVEL = 87
+    PRE_NEW_LEVEL = 90
 }
 
 /**
@@ -7925,6 +8031,12 @@ export declare enum PocketItemType {
     UNDETERMINABLE = 5
 }
 
+/**
+ * These are the possible types that player stats can be. For example, `EntityPlayer.Damage` is of
+ * type `float`, `EntityPlayer.CanFly` is of type `boolean`, and so on.
+ */
+export declare type PossibleStatType = number | boolean | BitFlags<TearFlag> | Color | Vector;
+
 declare type PostAmbushFinishedRegisterParameters = [
 callback: (ambushType: AmbushType) => void,
 ambushType?: AmbushType
@@ -8054,11 +8166,26 @@ callback: (gridEntity: GridEntity, gridEntityTypeCustom: GridEntityType, entity:
 gridEntityTypeCustom?: GridEntityType
 ];
 
+declare type PostGridEntityCustomInitRegisterParameters = [
+callback: (gridEntity: GridEntity, gridEntityTypeCustom: GridEntityType) => void,
+gridEntityTypeCustom?: GridEntityType
+];
+
+declare type PostGridEntityCustomRemoveRegisterParameters = [
+callback: (gridIndex: int, gridEntityTypeCustom: GridEntityType) => void,
+gridEntityTypeCustom?: GridEntityType
+];
+
 declare type PostGridEntityCustomRenderRegisterParameters = [
 callback: (gridEntity: GridEntity, gridEntityTypeCustom: GridEntityType) => void,
 gridEntityTypeCustom?: GridEntityType
 ];
 
+declare type PostGridEntityCustomStateChangedRegisterParameters = [
+callback: (gridEntity: GridEntity, gridEntityTypeCustom: GridEntityType, oldState: int, newState: int) => void,
+gridEntityTypeCustom?: GridEntityType
+];
+
 declare type PostGridEntityCustomUpdateRegisterParameters = [
 callback: (gridEntity: GridEntity, gridEntityTypeCustom: GridEntityType) => void,
 gridEntityTypeCustom?: GridEntityType
@@ -8185,7 +8312,7 @@ character?: PlayerType
 ];
 
 declare type PostPlayerChangeStatRegisterParameters = [
-callback: (player: EntityPlayer, statType: StatType, difference: int, oldValue: number | boolean | BitFlags<TearFlag> | Color | Vector, newValue: number | boolean | BitFlags<TearFlag> | Color | Vector) => void,
+callback: (player: EntityPlayer, statType: StatType, difference: int, oldValue: PossibleStatType, newValue: PossibleStatType) => void,
 playerVariant?: PlayerVariant,
 character?: PlayerType
 ];
@@ -8427,31 +8554,6 @@ export declare function registerCharacterHealthConversion(playerType: PlayerType
  */
 export declare function registerCharacterStats(playerType: PlayerType, statMap: Map<CacheFlag, number> | ReadonlyMap<CacheFlag, number>): void;
 
-/**
- * By default, unknown bosses will be drawn on the boss "versus" screen as "???". If your custom
- * stage has custom bosses, you can use this function to register the corresponding graphic file
- * files for them.
- *
- * For reference:
- * - The vanilla name sprite for Monstro is located at:
- *   `resources/gfx/ui/boss/bossname_20.0_monstro.png`
- * - The vanilla portrait sprite for Monstro is located at:
- *   `resources/gfx/ui/boss/portrait_20.0_monstro.png`
- *
- * (Note that boss metadata like this cannot be specified with the rest of the custom stage metadata
- * in the "tsconfig.json" file because there is not a way to retrieve the name of an entity at
- * run-time.)
- *
- * @param entityType The entity type of the custom boss.
- * @param variant The variant of the custom boss.
- * @param subType The sub-type of the custom boss.
- * @param namePNGPath The full path to the PNG file that contains the name of the boss that will be
- *                    displayed on the top of the boss "versus" screen.
- * @param portraitPNGPath The full path to the PNG file that contains the portrait of the boss that
- *                        will be displayed on the right side of the boss "versus" screen.
- */
-export declare function registerCustomBoss(entityType: EntityType, variant: int, subType: int, namePNGPath: string, portraitPNGPath: string): void;
-
 /**
  * Helper function to run arbitrary code when you press and release a specific keyboard key.
  *
@@ -8979,6 +9081,9 @@ export declare function removeGridEntities<T extends AnyGridEntity>(gridEntities
  * Helper function to remove a grid entity by providing the grid entity object or the grid index
  * inside of the room.
  *
+ * If removing a Devil Statue or an Angel Statue, this will also remove the associated effect
+ * (`EffectVariant.DEVIL` (6) or `EffectVariant.ANGEL` (9), respectively.)
+ *
  * @param gridEntityOrGridIndex The grid entity or grid index to remove.
  * @param updateRoom Whether or not to update the room after the grid entity is removed. This is
  *                   generally a good idea because if the room is not updated, you will be unable to
@@ -10217,18 +10322,24 @@ export declare function spawnCustomDoor(effectVariant: EffectVariant, doorSlot:
  * will reappear if the player leaves and re-enters the room. (It will be manually respawned in the
  * `POST_NEW_ROOM` callback.)
  *
- * This is an IsaacScript feature because the vanilla game does not support any custom grid
- * entities. Under the hood, IsaacScript accomplishes this by using decorations with an arbitrary
- * non-zero variant to represent custom grid entities.
+ * Custom grid entities are built on top of real grid entities. You can use any existing grid entity
+ * type as a base. For example, if you want to create a custom rock that would be breakable like a
+ * normal rock, then you should specify `GridEntityType.ROCK` as the base grid entity type.
  *
  * Once a custom grid entity is spawned, you can take advantage of the custom grid callbacks such as
- * `POST_GRID_ENTITY_CUSTOM_UPDATE`.
+ * `POST_GRID_ENTITY_CUSTOM_UPDATE`. Note that the "normal" grid entities callbacks will not fire
+ * for custom entities. For example, if you had a custom grid entity based on `GridEntityType.ROCK`,
+ * and you also had a subscription to the `POST_GRID_ENTITY_UPDATE` callback, the callback would
+ * only fire for normal rocks and not the custom entity.
+ *
+ * Custom grid entities are an IsaacScript feature because the vanilla game does not support any
+ * custom grid entities.
  *
  * @param gridEntityTypeCustom An integer that identifies what kind of grid entity you are creating.
- *                             It should correspond to a local enum value in your mod. The integer
- *                             can be any unique value and will not correspond to the actual grid
- *                             entity type used. (This integer is used in the various custom grid
- *                             entity callbacks.)
+ *                             It should correspond to a local enum value created in your mod. The
+ *                             integer can be any unique value and will not correspond to the actual
+ *                             grid entity type used. (This integer is used in the various custom
+ *                             grid entity callbacks.)
  * @param gridIndexOrPosition The grid index or position in the room that you want to spawn the grid
  *                            entity at. If a position is specified, the closest grid index will be
  *                            used.
@@ -10237,12 +10348,12 @@ export declare function spawnCustomDoor(effectVariant: EffectVariant, doorSlot:
  * @param defaultAnimation Optional. The name of the animation to play after the sprite is
  *                         initialized and after the player re-enters a room with this grid entity
  *                         in it. If not specified, the default animation in the anm2 will be used.
- * @param breakable Optional. Whether or not an explosion will be able to break this grid entity.
- *                  False by default. Use the `POST_GRID_ENTITY_CUSTOM_BROKEN` callback to detect
- *                  when it breaks. Due to technical limitations, you can only set the grid entity
- *                  to be breakable if it has a collision class.
+ * @param baseGridEntityType Optional. The type of the grid entity to use as a "base" for this
+ *                           custom grid entity. Default is `GridEntityType.DECORATION`.
+ * @param baseGridEntityVariant Optional. The variant of the grid entity to use as a "base" for this
+ *                              custom grid entity. Default is 0.
  */
-export declare function spawnCustomGrid(gridEntityTypeCustom: GridEntityType, gridIndexOrPosition: int | Vector, gridCollisionClass: GridCollisionClass, anm2Path: string, defaultAnimation?: string, breakable?: boolean): GridEntity;
+export declare function spawnCustomGrid(gridEntityTypeCustom: GridEntityType, gridIndexOrPosition: int | Vector, gridCollisionClass: GridCollisionClass, anm2Path: string, defaultAnimation?: string, baseGridEntityType?: GridEntityType, baseGridEntityVariant?: number): GridEntity;
 
 /**
  * Helper function to spawn a trapdoor grid entity that will have one or more of the following
@@ -10575,7 +10686,9 @@ export declare enum StatType {
     /** Corresponds to `CacheFlag.FLYING` (1 << 7) and `EntityPlayer.CanFly`. */
     FLYING = 10,
     /** Corresponds to `CacheFlag.LUCK` (1 << 10) and `EntityPlayer.Luck`. */
-    LUCK = 11
+    LUCK = 11,
+    /** Corresponds to `CacheFlag.SIZE` (1 << 11) and `EntityPlayer.SpriteScale`. */
+    SIZE = 12
 }
 
 /**
@@ -10595,6 +10708,7 @@ export declare interface StatTypeType {
     [StatType.TEAR_COLOR]: Color;
     [StatType.FLYING]: boolean;
     [StatType.LUCK]: float;
+    [StatType.SIZE]: Vector;
 }
 
 export declare function stopAllSoundEffects(): void;