isaacscript-common 13.3.3 → 14.0.0

package/dist/index.d.ts

@@ -79,7 +79,7 @@ import { TrapdoorVariant } from 'isaac-typescript-definitions';
 import { TrinketType } from 'isaac-typescript-definitions';
 import { UseFlag } from 'isaac-typescript-definitions';
 
-declare interface AddCallbackParameterCustom {
+declare interface AddCallbackParametersCustom {
     [ModCallbackCustom.POST_AMBUSH_FINISHED]: PostAmbushFinishedRegisterParameters;
     [ModCallbackCustom.POST_AMBUSH_STARTED]: PostAmbushStartedRegisterParameters;
     [ModCallbackCustom.POST_BOMB_EXPLODED]: PostBombExplodedRegisterParameters;
@@ -88,7 +88,6 @@ declare interface AddCallbackParameterCustom {
     [ModCallbackCustom.POST_COLLECTIBLE_EMPTY]: PostCollectibleEmptyRegisterParameters;
     [ModCallbackCustom.POST_COLLECTIBLE_INIT_FIRST]: PostCollectibleInitFirstRegisterParameters;
     [ModCallbackCustom.POST_CURSED_TELEPORT]: PostCursedTeleportRegisterParameters;
-    [ModCallbackCustom.POST_CUSTOM_DOOR_ENTER]: PostCustomDoorEnterRegisterParameters;
     [ModCallbackCustom.POST_CUSTOM_REVIVE]: PostCustomReviveRegisterParameters;
     [ModCallbackCustom.POST_DICE_ROOM_ACTIVATED]: PostDiceRoomActivatedRegisterParameters;
     [ModCallbackCustom.POST_DOOR_RENDER]: PostDoorRenderRegisterParameters;
@@ -133,7 +132,6 @@ declare interface AddCallbackParameterCustom {
     [ModCallbackCustom.POST_PICKUP_INIT_FIRST]: PostPickupInitFirstRegisterParameters;
     [ModCallbackCustom.POST_PICKUP_INIT_LATE]: PostPickupInitLateRegisterParameters;
     [ModCallbackCustom.POST_PICKUP_STATE_CHANGED]: PostPickupStateChangedRegisterParameters;
-    [ModCallbackCustom.POST_PIT_RENDER]: PostPitRenderRegisterParameters;
     [ModCallbackCustom.POST_PIT_UPDATE]: PostPitUpdateRegisterParameters;
     [ModCallbackCustom.POST_PLAYER_CHANGE_HEALTH]: PostPlayerChangeHealthRegisterParameters;
     [ModCallbackCustom.POST_PLAYER_CHANGE_STAT]: PostPlayerChangeStatRegisterParameters;
@@ -145,6 +143,7 @@ declare interface AddCallbackParameterCustom {
     [ModCallbackCustom.POST_PLAYER_INIT_LATE]: PostPlayerInitLateRegisterParameters;
     [ModCallbackCustom.POST_PLAYER_RENDER_REORDERED]: PostPlayerRenderReorderedRegisterParameters;
     [ModCallbackCustom.POST_PLAYER_UPDATE_REORDERED]: PostPlayerUpdateReorderedRegisterParameters;
+    [ModCallbackCustom.POST_PIT_RENDER]: PostPitRenderRegisterParameters;
     [ModCallbackCustom.POST_POOP_RENDER]: PostPoopRenderRegisterParameters;
     [ModCallbackCustom.POST_POOP_UPDATE]: PostPoopUpdateRegisterParameters;
     [ModCallbackCustom.POST_PRESSURE_PLATE_RENDER]: PostPressurePlateRenderRegisterParameters;
@@ -176,6 +175,58 @@ declare interface AddCallbackParameterCustom {
     [ModCallbackCustom.PRE_NEW_LEVEL]: PreNewLevelRegisterParameters;
 }
 
+declare interface AddCallbackParametersCustom2 {
+    [ModCallbackCustom2.POST_AMBUSH_FINISHED]: [
+    callback: (ambushType: AmbushType) => void,
+    ambushType?: AmbushType
+    ];
+    [ModCallbackCustom2.POST_AMBUSH_STARTED]: [
+    callback: (ambushType: AmbushType) => void,
+    ambushType?: AmbushType
+    ];
+    [ModCallbackCustom2.POST_BOMB_EXPLODED]: [
+    callback: (bomb: EntityBomb) => void,
+    bombVariant?: BombVariant
+    ];
+    [ModCallbackCustom2.POST_BOMB_INIT_LATE]: [
+    callback: (bomb: EntityBomb) => void,
+    bombVariant?: BombVariant
+    ];
+    [ModCallbackCustom2.POST_BONE_SWING]: [
+    callback: (knife: EntityKnife) => void
+    ];
+    [ModCallbackCustom2.POST_COLLECTIBLE_EMPTY]: [
+    callback: (collectible: EntityPickupCollectible, oldCollectibleType: CollectibleType) => void,
+    collectibleType?: CollectibleType
+    ];
+    [ModCallbackCustom2.POST_COLLECTIBLE_INIT_FIRST]: [
+    callback: (collectible: EntityPickupCollectible) => void,
+    collectibleType?: CollectibleType
+    ];
+    [ModCallbackCustom2.POST_CURSED_TELEPORT]: [
+    callback: (player: EntityPlayer) => void,
+    playerVariant?: PlayerVariant,
+    character?: PlayerType
+    ];
+    [ModCallbackCustom2.POST_KNIFE_INIT_LATE]: [
+    callback: (knife: EntityKnife) => void,
+    knifeVariant?: KnifeVariant
+    ];
+    [ModCallbackCustom2.POST_NEW_ROOM_EARLY]: [callback: () => void];
+    [ModCallbackCustom2.POST_PIT_RENDER]: [
+    callback: (pit: GridEntityPit) => void,
+    pitVariant?: PitVariant
+    ];
+    [ModCallbackCustom2.POST_ROOM_CLEAR_CHANGED]: [
+    callback: (roomClear: boolean) => void,
+    roomClear?: boolean
+    ];
+    [ModCallbackCustom2.POST_SPIKES_RENDER]: [
+    callback: (spikes: GridEntitySpikes) => void,
+    gridEntityVariant?: int
+    ];
+}
+
 /**
  * Helper function to add a charge to the player's active item. Will flash the HUD and play the
  * appropriate sound effect, depending on whether the charge is partially full or completely full.
@@ -296,6 +347,8 @@ export declare function addRoomClearChargeToSlot(player: EntityPlayer, activeSlo
  * Helper function to add a `DisplayFlag` to a particular room's minimap display flags (e.g. whether
  * or not it is visible and so on).
  *
+ * This function automatically accounts for whether or not MinimapAPI is being used.
+ *
  * @param roomGridIndex Set to undefined to use the current room index.
  * @param displayFlag The `DisplayFlag` to set. (See the `DisplayFlag` enum.)
  * @param updateVisibility Optional. Whether to call the `Level.UpdateVisibility` method in order to
@@ -2470,6 +2523,12 @@ export declare function getAllPlayers(): EntityPlayer[];
 /** Helper function to get the room safe grid index for every room on the entire floor. */
 export declare function getAllRoomGridIndexes(): int[];
 
+/**
+ * Helper function to get the corresponding ambush type for the current room. Returns undefined if
+ * the current room does not correspond to any particular ambush type.
+ */
+export declare function getAmbushType(): AmbushType | undefined;
+
 export declare function getAngelRoomDoor(): GridEntityDoor | undefined;
 
 export declare function getAngleDifference(angle1: float, angle2: float): float;
@@ -5712,33 +5771,6 @@ export declare function inHomeCloset(): boolean;
  */
 export declare function initArray<T>(defaultValue: T, size: int): T[];
 
-/**
- * `isaacscript-common` provides custom doors that can be spawned where any wall segment is. If you
- * use this feature, you must first call this initialization function at the beginning of your mod.
- *
- * Each kind of custom door that you create must have an entry in the "content/entities2.xml" file,
- * like so:
- *
- * ```xml
- * <entity id="1000" name="Foo Custom Door" anm2path="grid/door_foo.anm2" />
- * ```
- *
- * (Custom door entities must have an id of "1000", which corresponds to an effect. If you do not
- * specify the variant, then the game will automatically assign it.)
- *
- * Next, pass the variant into this function:
- *
- * ```ts
- * const modVanilla = RegisterMod("My Mod", 1);
- * const mod = upgradeMod(modVanilla);
- * const fooEffectVariant = Isaac.GetEntityVariantByName("Foo Custom Door");
- * initCustomDoor(mod, fooEffectVariant);
- * ```
- *
- * Also see the `spawnCustomDoor` function.
- */
-export declare function initCustomDoor(mod: ModUpgraded, effectVariant: EffectVariant): void;
-
 /** Helper function to determine if the current room shape is one of the four L room shapes. */
 export declare function inLRoom(): boolean;
 
@@ -5830,6 +5862,41 @@ declare interface IsaacAPIClassTypeToType {
     [CopyableIsaacAPIClassType.VECTOR]: Vector;
 }
 
+export declare enum IsaacScriptCommonFeature {
+    CHARACTER_HEALTH_CONVERSION = "characterHealthConversion",
+    CHARACTER_STATS = "characterStats",
+    COLLECTIBLE_ITEM_POOL_TYPE = "collectibleItemPoolType",
+    CUSTOM_GRID_ENTITY = "customGridEntity",
+    CUSTOM_HOTKEYS = "customHotkeys",
+    CUSTOM_PICKUP = "customPickup",
+    CUSTOM_STAGE = "customStage",
+    CUSTOM_TRAPDOOR = "customTrapdoor",
+    DEBUG_DISPLAY = "debugDisplay",
+    DEPLOY_JSON_ROOM = "deployJSONRoom",
+    DISABLE_ALL_SOUND = "displayAllSound",
+    DISABLE_INPUTS = "disableInputs",
+    FADE_IN_REMOVER = "fadeInRemover",
+    FAST_RESET = "fastReset",
+    FIRST_LAST = "firstLast",
+    FORGOTTEN_SWITCH = "forgottenSwitch",
+    EXTRA_CONSOLE_COMMANDS = "extraConsoleCommands",
+    PAUSE = "pause",
+    PERSISTENT_ENTITIES = "persistentEntities",
+    PICKUP_INDEX = "pickupIndex",
+    PLAYER_INVENTORY = "playerInventory",
+    PONY_DETECTION = "ponyDetection",
+    PREVENT_CHILD_ENTITIES = "preventChildEntities",
+    PREVENT_COLLECTIBLE_ROTATION = "preventCollectibleRotation",
+    ROOM_CLEAR_FRAME = "roomClearFrame",
+    ROOM_HISTORY = "roomHistory",
+    RUN_IN_N_FRAMES = "runInNFrames",
+    RUN_NEXT_ROOM = "runNextRoom",
+    SAVE_DATA_MANAGER = "saveDataManager",
+    SIREN_HELPERS = "sirenHelpers",
+    STAGE_HISTORY = "stageHistory",
+    TAINTED_LAZARUS_PLAYERS = "taintedLazarusPlayers"
+}
+
 /** Iterates over all inputs to determine if a particular button is pressed (i.e. held down). */
 export declare function isActionPressedOnAnyInput(buttonAction: ButtonAction): boolean;
 
@@ -6408,8 +6475,13 @@ export declare function isRedHeart(pickup: EntityPickup): boolean;
 export declare function isRedKeyRoom(roomGridIndex?: int): boolean;
 
 /**
- * Since this is a UI element, we do not want to draw it in water reflections. `renderOffset` will
- * be a non-zero value in reflections.
+ * Helper function to see if the current render callback is rendering a water reflection.
+ *
+ * When the player is in a room with water, things will be rendered twice: once for the normal
+ * rendering, and once for the reflecting rendering. Thus, any mod code in a render callback will
+ * run twice per frame in these situations, which may be unexpected or cause bugs.
+ *
+ * This function is typically used to early return from a render function if it returns true.
  */
 export declare function isReflectionRender(): boolean;
 
@@ -6858,6 +6930,23 @@ export declare function kColorEquals(kColor1: KColor, kColor2: KColor): boolean;
  */
 export declare function keyboardToString(keyboard: Keyboard, uppercase: boolean): string | undefined;
 
+/**
+ * For `EntityType.EFFECT` (1000), `EffectVariant.LADDER` (8).
+ *
+ * Note that vanilla ladders only use a sub-type of 0. The `isaacscript-common` library uses ladders
+ * to represent custom objects, since they are non-interacting and will not automatically despawn
+ * after time passes, unlike most other effects.
+ *
+ * This enum tracks the kinds of custom objects that are represented by vanilla ladders. We start
+ * assigning sub-types after 100 as to not interfere with any possible modded ladder variants.
+ */
+export declare enum LadderSubTypeCustom {
+    LADDER = 0,
+    CUSTOM_BACKDROP = 101,
+    CUSTOM_SHADOW = 102,
+    CUSTOM_PICKUP = 103
+}
+
 /**
  * Equal to `PillColor.HORSE_WHITE_YELLOW`.
  *
@@ -7182,8 +7271,9 @@ export declare enum ModCallbackCustom {
      * Fires from the `POST_UPDATE` callback when a Challenge Room or Boss Rush is started.
      * Specifically, this happens on the first frame that `Room.IsAmbushDone` is true.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if for the `AmbushType` provided.
+     * 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 `AmbushType`
+     * provided.
      *
      * ```ts
      * function postAmbushFinished(ambushType: AmbushType): void {}
@@ -7194,8 +7284,9 @@ export declare enum ModCallbackCustom {
      * Fires from the `POST_UPDATE` callback when a Challenge Room or Boss Rush is completed.
      * Specifically, this happens on the first frame that `Room.IsAmbushActive` is true.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if for the `AmbushType` provided.
+     * 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 `AmbushType`
+     * provided.
      *
      * ```ts
      * function postAmbushStarted(ambushType: AmbushType): void {}
@@ -7205,8 +7296,9 @@ export declare enum ModCallbackCustom {
     /**
      * Fires on the `POST_BOMB_UPDATE` callback that it explodes.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if the bomb variant matches the `BombVariant` provided.
+     * 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
+     * `BombVariant` provided.
      *
      * ```ts
      * function postBombDetonated(bomb: EntityBomb): void {}
@@ -7219,8 +7311,9 @@ export declare enum ModCallbackCustom {
      * This callback is useful because many attributes cannot be set or retrieved properly in the
      * normal `POST_BOMB_INIT` callback.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if the bomb variant matches the `BombVariant` provided.
+     * 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
+     * `BombVariant` provided.
      *
      * ```ts
      * function postBombInitLate(bomb: EntityBomb): void {}
@@ -7239,8 +7332,9 @@ export declare enum ModCallbackCustom {
      * Fires from the `POST_PICKUP_UPDATE` callback when a collectible goes from a non-zero sub-type
      * to `CollectibleType.NULL` (i.e. an "empty" pedestal).
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if the collectible type changed from the `CollectibleType` provided.
+     * When registering the callback with the `ModUpgraded.AddCallbackCustom` method, you can provide
+     * an optional third argument that will make the callback only fire if the pedestal changed from
+     * the `CollectibleType` provided.
      *
      * ```ts
      * function postCollectibleEmpty(
@@ -7259,11 +7353,12 @@ export declare enum ModCallbackCustom {
      * upon re-entering the room. Additionally, when playing as Tainted Isaac, the `POST_PICKUP_INIT`
      * callback will fire every time the item shifts.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if the collectible type matches the `CollectibleType` provided.
+     * 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
+     * `CollectibleType` provided.
      *
      * ```ts
-     * function postCollectibleInitLate(collectible: EntityPickup): void {}
+     * function postCollectibleInitLate(collectible: EntityPickupCollectible): void {}
      * ```
      */
     POST_COLLECTIBLE_INIT_FIRST = 6,
@@ -7272,28 +7367,17 @@ export declare enum ModCallbackCustom {
      * begins playing after a player triggers a Cursed Eye teleport or a Cursed Skull teleport. (Both
      * of these have the same effect in causing Isaac to be teleported to a random room.)
      *
+     * 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 `PlayerVariant` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the `PlayerType` provided.
+     *
      * ```ts
      * function postCursedTeleport(player: EntityPlayer): void {}
      * ```
      */
     POST_CURSED_TELEPORT = 7,
-    /**
-     * Fires from the `POST_PEFFECT_UPDATE` callback when a player enters the loading zone of a custom
-     * door created with the `spawnCustomDoor` helper function.
-     *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `DoorVariant` provided.
-     *
-     * ```ts
-     * function postCustomDoorEnter(
-     *   player: EntityPlayer,
-     *   effectVariant: int,
-     *   doorSlot: DoorSlot,
-     *   direction: Direction,
-     * ): void {}
-     * ```
-     */
-    POST_CUSTOM_DOOR_ENTER = 8,
     /**
      * Fires from the `POST_PLAYER_UPDATE` callback after the player has finished the death animation,
      * has teleported to the previous room, and is ready to play the animation for the modded revival
@@ -7303,20 +7387,22 @@ export declare enum ModCallbackCustom {
      * `player.AnimateCollectible(CollectibleTypeCustom.COLLECTIBLE_MY_REVIVAL_ITEM);`, otherwise the
      * animation for a 1-Up will play.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if the revival type matches the one provided.
+     * When registering the callback with the `ModUpgraded.AddCallbackCustom` method, you can provide
+     * an optional third argument that will make the callback only fire if the revival type matches
+     * the one provided.
      *
      * ```ts
      * function postCustomRevive(player: EntityPlayer, revivalType: int): void {}
      * ```
      */
-    POST_CUSTOM_REVIVE = 9,
+    POST_CUSTOM_REVIVE = 8,
     /**
      * Fires from the `EFFECT_POST_UPDATE` callback after a player has entered the range of a Dice
      * Room floor.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if the `DiceFloorSubType` type matches the one provided.
+     * 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
+     * `DiceFloorSubType` provided.
      *
      * ```ts
      * function postDiceRoomActivated(
@@ -7325,49 +7411,53 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_DICE_ROOM_ACTIVATED = 10,
+    POST_DICE_ROOM_ACTIVATED = 9,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a door exists.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the variant provided.
+     * 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 variant
+     * provided.
      *
      * ```ts
      * function postDoorRender(door: GridEntityDoor): void {}
      * ```
      */
-    POST_DOOR_RENDER = 11,
+    POST_DOOR_RENDER = 10,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a door exists.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the variant provided.
+     * 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 variant
+     * provided.
      *
      * ```ts
      * function postDoorUpdate(door: GridEntityDoor): void {}
      * ```
      */
-    POST_DOOR_UPDATE = 12,
+    POST_DOOR_UPDATE = 11,
     /**
      * Fires on the first `POST_EFFECT_UPDATE` frame for each effect.
      *
      * This callback is useful because many attributes cannot be set or retrieved properly in the
      * normal `POST_EFFECT_INIT` callback.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if the effect variant matches the `EffectVariant` provided.
+     * 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
+     * `EffectVariant` provided.
      *
      * ```ts
      * function postEffectInitLate(effect: EntityEffect): void {}
      * ```
      */
-    POST_EFFECT_INIT_LATE = 13,
+    POST_EFFECT_INIT_LATE = 12,
     /**
      * Fires from the `POST_EFFECT_UPDATE` callback when an effect's state has changed from what it
      * was on the previous frame. (In this context, "state" refers to the `EntityEffect.State` field.)
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `EffectVariant` provided.
+     * 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
+     * `EffectVariant` provided.
      *
      * ```ts
      * function postEffectStateChanged(
@@ -7377,7 +7467,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_EFFECT_STATE_CHANGED = 14,
+    POST_EFFECT_STATE_CHANGED = 13,
     /**
      * Fires one `POST_UPDATE` frame after the player has used the Esau Jr. item. (The player is not
      * updated to the new character until a game frame has passed.)
@@ -7386,28 +7476,30 @@ export declare enum ModCallbackCustom {
      * function postEsauJr(player: EntityPlayer): void {}
      * ```
      */
-    POST_ESAU_JR = 15,
+    POST_ESAU_JR = 14,
     /**
      * Fires on the first `FAMILIAR_UPDATE` frame for each familiar.
      *
      * This callback is useful because many attributes cannot be set or retrieved properly in the
      * normal `POST_TEAR_INIT` callback.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if the familiar variant matches the `FamiliarVariant` provided.
+     * 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
+     * `FamiliarVariant` provided.
      *
      * ```ts
      * function postFamiliarInitLate(familiar: EntityFamiliar): void {}
      * ```
      */
-    POST_FAMILIAR_INIT_LATE = 16,
+    POST_FAMILIAR_INIT_LATE = 15,
     /**
      * Fires from the `POST_FAMILIAR_UPDATE` callback when a familiar's state has changed from what it
      * was on the previous frame. (In this context, "state" refers to the `EntityFamiliar.State`
      * field.)
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `FamiliarVariant` provided.
+     * 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
+     * `FamiliarVariant` provided.
      *
      * ```ts
      * function postFamiliarStateChanged(
@@ -7417,7 +7509,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_FAMILIAR_STATE_CHANGED = 17,
+    POST_FAMILIAR_STATE_CHANGED = 16,
     /**
      * Fires one `POST_UPDATE` frame after the player has first used the Esau Jr. item. (The player is
      * not updated to the new character until a game frame has passed.)
@@ -7429,7 +7521,7 @@ export declare enum ModCallbackCustom {
      * function postFirstEsauJr(player: EntityPlayer): void {}
      * ```
      */
-    POST_FIRST_ESAU_JR = 18,
+    POST_FIRST_ESAU_JR = 17,
     /**
      * Fires after the player has used the Flip item for the first time. Unlike the vanilla `USE_ITEM`
      * callback, this callback will return the player object for the new Lazarus (not the one who used
@@ -7442,7 +7534,7 @@ export declare enum ModCallbackCustom {
      * function postFirstFlip(newLazarus: EntityPlayer, oldLazarus: EntityPlayer): void {}
      * ```
      */
-    POST_FIRST_FLIP = 19,
+    POST_FIRST_FLIP = 18,
     /**
      * Fires after the player has used the Flip item. Unlike the vanilla `USE_ITEM` callback, this
      * callback will return the player object for the new Lazarus (not the one who used the Flip
@@ -7455,7 +7547,7 @@ export declare enum ModCallbackCustom {
      * function postFlip(newLazarus: EntityPlayer, oldLazarus: EntityPlayer): void {}
      * ```
      */
-    POST_FLIP = 20,
+    POST_FLIP = 19,
     /**
      * Similar to the vanilla callback of the same name, but fires in the correct order with respect
      * to the `POST_NEW_LEVEL` and the `POST_NEW_ROOM` callbacks:
@@ -7466,7 +7558,7 @@ export declare enum ModCallbackCustom {
      * function postGameStartedReordered(isContinued: boolean): void {}
      * ```
      */
-    POST_GAME_STARTED_REORDERED = 21,
+    POST_GAME_STARTED_REORDERED = 20,
     /**
      * Similar to the `POST_GAME_STARTED_REORDERED` callback, but fires after all of the subscribed
      * callbacks have finished firing. Thus, you can use this callback to do perform things after a
@@ -7477,7 +7569,7 @@ export declare enum ModCallbackCustom {
      * function postGameStartedReorderedLast(isContinued: boolean): void {}
      * ```
      */
-    POST_GAME_STARTED_REORDERED_LAST = 22,
+    POST_GAME_STARTED_REORDERED_LAST = 21,
     /**
      * Fires from the `POST_UPDATE` callback when the Greed Mode wave increases.
      *
@@ -7485,7 +7577,7 @@ export declare enum ModCallbackCustom {
      * function postGreedModeWave(oldWave: int, newWave: int): void {}
      * ```
      */
-    POST_GREED_MODE_WAVE = 23,
+    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. (For example, this will fire for a
@@ -7494,16 +7586,17 @@ export declare enum ModCallbackCustom {
      * For grid entities created with `spawnCustomGridEntity`, use the
      * `POST_GRID_ENTITY_CUSTOM_BROKEN` callback instead.
      *
-     * - When registering the callback, takes an optional second argument that will make the callback
-     *   only fire if it matches the `GridEntityType` provided.
-     * - When registering the callback, takes an optional third argument that will make the callback
-     *   only fire if it matches the variant provided.
+     * 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 `GridEntityType` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the variant provided.
      *
      * ```ts
      * function postGridEntityBroken(gridEntity: GridEntity): void {}
      * ```
      */
-    POST_GRID_ENTITY_BROKEN = 24,
+    POST_GRID_ENTITY_BROKEN = 23,
     /**
      * Fires from the `POST_UPDATE` callback when a new entity collides with a grid entity. (After
      * this, the callback will not continue to fire. It will only fire again once the entity moves out
@@ -7512,14 +7605,15 @@ export declare enum ModCallbackCustom {
      * For grid entities created with `spawnCustomGridEntity`, use the
      * `POST_GRID_ENTITY_CUSTOM_COLLISION` callback instead.
      *
-     * - When registering the callback, takes an optional second argument that will make the callback
-     *   only fire if it matches the `GridEntityType` provided.
-     * - When registering the callback, takes an optional third argument that will make the callback
-     *   only fire if it matches the variant provided (for the grid entity).
-     * - When registering the callback, takes an optional fourth argument that will make the callback
-     *   only fire if the colliding entity matches the `EntityType` provided.
-     * - When registering the callback, takes an optional fifth argument that will make the callback
-     *   only fire if the colliding entity matches the variant provided.
+     * 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 `GridEntityType` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the variant provided (for the grid entity).
+     * - You can provide an optional fifth argument that will make the callback only fire if the
+     *   colliding entity matches the `EntityType` provided.
+     * - You can provide an optional sixth argument that will make the callback only fire if the
+     *   colliding entity matches the variant provided.
      *
      * ```ts
      * function postGridEntityCollision(
@@ -7528,14 +7622,15 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_GRID_ENTITY_COLLISION = 25,
+    POST_GRID_ENTITY_COLLISION = 24,
     /**
      * 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. (Custom grid entities do not have
-     * variants, so there is no need for an optional third argument to filter by variant.)
+     * 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 custom
+     * `GridEntityType` provided. (Custom grid entities do not have variants, so there is no need for
+     * an optional argument to filter by variant.)
      *
      * ```ts
      * function postGridEntityCustomBroken(
@@ -7544,18 +7639,19 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_GRID_ENTITY_CUSTOM_BROKEN = 26,
+    POST_GRID_ENTITY_CUSTOM_BROKEN = 25,
     /**
      * 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. (Custom grid entities do not have
-     *   variants, so there is no need for an optional third argument to filter by variant.)
-     * - When registering the callback, takes an optional third argument that will make the callback
-     *   only fire if the the colliding entity matches the `EntityType` provided.
-     * - When registering the callback, takes an optional fourth argument that will make the callback
-     *   only fire if the the colliding entity matches the variant provided.
+     * 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 custom `GridEntityType` provided. (Custom grid entities do not have variants, so
+     *   there is no need for an optional argument to filter by variant.)
+     * - You can provide an optional fourth argument that will make the callback only fire if the
+     *   colliding entity matches the `EntityType` provided.
+     * - You can provide an optional fifth argument that will make the callback only fire if the
+     *   colliding entity matches the variant provided.
      *
      * ```ts
      * function postGridEntityCustomCollision(
@@ -7565,14 +7661,15 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_GRID_ENTITY_CUSTOM_COLLISION = 27,
+    POST_GRID_ENTITY_CUSTOM_COLLISION = 26,
     /**
      * 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. (Custom grid entities do not have
-     * variants, so there is no need for an optional third argument to filter by variant.)
+     * 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 custom
+     * `GridEntityType` provided. (Custom grid entities do not have variants, so there is no need for
+     * an optional argument to filter by variant.)
      *
      * ```ts
      * function postGridEntityCustomInit(
@@ -7581,14 +7678,15 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_GRID_ENTITY_CUSTOM_INIT = 28,
+    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. (Custom grid entities do not have
-     * variants, so there is no need for an optional third argument to filter by variant.)
+     * 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 custom
+     * `GridEntityType` provided. (Custom grid entities do not have variants, so there is no need for
+     * an optional argument to filter by variant.)
      *
      * ```ts
      * function postGridEntityCustomRemove(
@@ -7597,14 +7695,15 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_GRID_ENTITY_CUSTOM_REMOVE = 29,
+    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. (Custom grid entities do not have
-     * variants, so there is no need for an optional third argument to filter by variant.)
+     * 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 custom
+     * `GridEntityType` provided. (Custom grid entities do not have variants, so there is no need for
+     * an optional argument to filter by variant.)
      *
      * ```ts
      * function postGridEntityCustomRender(
@@ -7613,14 +7712,15 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_GRID_ENTITY_CUSTOM_RENDER = 30,
+    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. (Custom grid entities do not have
-     * variants, so there is no need for an optional third argument to filter by variant.)
+     * 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 custom
+     * `GridEntityType` provided. (Custom grid entities do not have variants, so there is no need for
+     * an optional argument to filter by variant.)
      *
      * ```ts
      * function postGridEntityCustomStateChanged(
@@ -7631,14 +7731,15 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_GRID_ENTITY_CUSTOM_STATE_CHANGED = 31,
+    POST_GRID_ENTITY_CUSTOM_STATE_CHANGED = 30,
     /**
      * 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. (Custom grid entities do not have
-     * variants, so there is no need for an optional third argument to filter by variant.)
+     * 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 custom
+     * `GridEntityType` provided. (Custom grid entities do not have variants, so there is no need for
+     * an optional argument to filter by variant.)
      *
      * ```ts
      * function postGridEntityCustomUpdate(
@@ -7647,7 +7748,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_GRID_ENTITY_CUSTOM_UPDATE = 32,
+    POST_GRID_ENTITY_CUSTOM_UPDATE = 31,
     /**
      * Fires when a new grid entity is initialized. Specifically, this is either:
      *
@@ -7659,16 +7760,17 @@ export declare enum ModCallbackCustom {
      * For grid entities created with `spawnCustomGridEntity`, use the `POST_GRID_ENTITY_CUSTOM_INIT`
      * callback instead.
      *
-     * - When registering the callback, takes an optional second argument that will make the callback
-     *   only fire if it matches the `GridEntityType` provided.
-     * - When registering the callback, takes an optional third argument that will make the callback
-     *   only fire if it matches the variant provided.
+     * 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 `GridEntityType` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the variant provided.
      *
      * ```ts
      * function postGridEntityInit(gridEntity: GridEntity): void {}
      * ```
      */
-    POST_GRID_ENTITY_INIT = 33,
+    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).
@@ -7680,10 +7782,11 @@ export declare enum ModCallbackCustom {
      * For grid entities created with `spawnCustomGridEntity`, use the
      * `POST_GRID_ENTITY_CUSTOM_REMOVE` callback instead.
      *
-     * - When registering the callback, takes an optional second argument that will make the callback
-     *   only fire if it matches the `GridEntityType` provided.
-     * - When registering the callback, takes an optional third argument that will make the callback
-     *   only fire if it matches the variant provided.
+     * 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 `GridEntityType` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the variant provided.
      *
      * ```ts
      * function postGridEntityRemove(
@@ -7692,23 +7795,24 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_GRID_ENTITY_REMOVE = 34,
+    POST_GRID_ENTITY_REMOVE = 33,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a grid entity exists.
      *
      * For grid entities created with `spawnCustomGridEntity`, use the
      * `POST_GRID_ENTITY_CUSTOM_RENDER` callback instead.
      *
-     * - When registering the callback, takes an optional second argument that will make the callback
-     *   only fire if it matches the `GridEntityType` provided.
-     * - When registering the callback, takes an optional third argument that will make the callback
-     *   only fire if it matches the variant provided.
+     * 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 `GridEntityType` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the variant provided.
      *
      * ```ts
      * function postGridEntityRender(gridEntity: GridEntity): void {}
      * ```
      */
-    POST_GRID_ENTITY_RENDER = 35,
+    POST_GRID_ENTITY_RENDER = 34,
     /**
      * Fires from the `POST_UPDATE` callback when a grid entity changes its state. (In this context,
      * "state" refers to the `GridEntity.State` field.)
@@ -7716,10 +7820,11 @@ export declare enum ModCallbackCustom {
      * For grid entities created with `spawnCustomGridEntity`, use the
      * `POST_GRID_ENTITY_CUSTOM_STATE_CHANGED` callback instead.
      *
-     * - When registering the callback, takes an optional second argument that will make the callback
-     *   only fire if it matches the `GridEntityType` provided.
-     * - When registering the callback, takes an optional third argument that will make the callback
-     *   only fire if it matches the variant provided.
+     * 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 `GridEntityType` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the variant provided.
      *
      * ```ts
      * function postGridEntityStateChanged(
@@ -7729,23 +7834,24 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_GRID_ENTITY_STATE_CHANGED = 36,
+    POST_GRID_ENTITY_STATE_CHANGED = 35,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a grid entity exists.
      *
      * For grid entities created with `spawnCustomGridEntity`, use the
      * `POST_GRID_ENTITY_CUSTOM_UPDATE` callback instead.
      *
-     * - When registering the callback, takes an optional second argument that will make the callback
-     *   only fire if it matches the `GridEntityType` provided.
-     * - When registering the callback, takes an optional third argument that will make the callback
-     *   only fire if it matches the variant provided.
+     * 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 `GridEntityType` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the variant provided.
      *
      * ```ts
      * function postGridEntityUpdate(gridEntity: GridEntity): void {}
      * ```
      */
-    POST_GRID_ENTITY_UPDATE = 37,
+    POST_GRID_ENTITY_UPDATE = 36,
     /**
      * Fires from the `POST_PEFFECT_UPDATE` callback when the player loses a Holy Mantle temporary
      * collectible effect.
@@ -7754,10 +7860,11 @@ export declare enum ModCallbackCustom {
      * from an enemy. Normally, you would accomplish this via the `ENTITY_TAKE_DMG` callback, but that
      * callback never fires if the player has a Holy Mantle shield.
      *
-     * - When registering the callback, takes an optional second argument that will make the callback
-     *   only fire if the player matches the `PlayerVariant` provided.
-     * - When registering the callback, takes an optional third argument that will make the callback
-     *   only fire if the player matches the `PlayerType` provided.
+     * 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 `PlayerVariant` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the `PlayerType` provided.
      *
      * ```ts
      * function postPlayerInitReordered(
@@ -7767,7 +7874,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_HOLY_MANTLE_REMOVED = 38,
+    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.
@@ -7778,8 +7885,9 @@ export declare enum ModCallbackCustom {
      * Note that this callback will not fire if the active item is both discharged and swapped for
      * another item / discharged on the same frame, like in the case of Alabaster Box.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `CollectibleType` provided.
+     * 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
+     * `CollectibleType` provided.
      *
      * ```ts
      * function postItemDischarge(
@@ -7789,7 +7897,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_ITEM_DISCHARGE = 39,
+    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
@@ -7797,10 +7905,11 @@ export declare enum ModCallbackCustom {
      *
      * Note that this callback will only fire once per Forgotten/Soul pair.
      *
-     * - When registering the callback, takes an optional second argument that will make the callback
-     *   only fire if it matches the `ItemType` provided.
-     * - When registering the callback, takes an optional third argument that will make the callback
-     *   only fire if the `CollectibleType` or the `TrinketType` matches the sub-type provided.
+     * 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 `ItemType` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if the
+     *   sub-type matches the `CollectibleType` or the `TrinketType` provided.
      *
      * ```ts
      * function postItemPickup(
@@ -7809,35 +7918,37 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_ITEM_PICKUP = 40,
+    POST_ITEM_PICKUP = 39,
     /**
      * Fires on the first `POST_KNIFE_UPDATE` frame for each knife.
      *
      * This callback is useful because many attributes cannot be set or retrieved properly in the
      * normal `POST_KNIFE_INIT` callback.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if the knife variant matches the `KnifeVariant` provided.
+     * 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
+     * `KnifeVariant` provided.
      *
      * ```ts
      * function postKnifeInitLate(knife: EntityKnife): void {}
      * ```
      */
-    POST_KNIFE_INIT_LATE = 41,
+    POST_KNIFE_INIT_LATE = 40,
     /**
      * Fires on the first `POST_LASER_UPDATE` frame for each laser.
      *
      * This callback is useful because many attributes cannot be set or retrieved properly in the
      * normal `POST_LASER_INIT` callback.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if the laser variant matches the `LaserVariant` provided.
+     * 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
+     * `LaserVariant` provided.
      *
      * ```ts
      * function postLaserInitLate(laser: EntityLaser): void {}
      * ```
      */
-    POST_LASER_INIT_LATE = 42,
+    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:
@@ -7854,7 +7965,7 @@ export declare enum ModCallbackCustom {
      * function postNewLevelReordered(): void {}
      * ```
      */
-    POST_NEW_LEVEL_REORDERED = 43,
+    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
@@ -7865,7 +7976,7 @@ export declare enum ModCallbackCustom {
      * function postNewRoomEarly(): void {}
      * ```
      */
-    POST_NEW_ROOM_EARLY = 44,
+    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:
@@ -7882,29 +7993,31 @@ export declare enum ModCallbackCustom {
      * function postNewRoomReordered(): void {}
      * ```
      */
-    POST_NEW_ROOM_REORDERED = 45,
+    POST_NEW_ROOM_REORDERED = 44,
     /**
      * Fires on the first `NPC_UPDATE` frame for each NPC.
      *
      * This callback is useful because many attributes cannot be set or retrieved properly in the
      * normal `POST_NPC_INIT` callback.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if the NPC's entity type matches the entity type provided.
+     * 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 `EntityType`
+     * provided.
      *
      * ```ts
      * function postNPCInitLate(npc: EntityNPC): void {}
      * ```
      */
-    POST_NPC_INIT_LATE = 46,
+    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. (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.
-     * - When registering the callback, takes an optional third argument that will make the callback
-     *   only fire if it matches the variant provided.
+     * 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 `EntityType` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the variant provided.
      *
      * ```ts
      * function postNPCStateChanged(
@@ -7914,7 +8027,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_NPC_STATE_CHANGED = 47,
+    POST_NPC_STATE_CHANGED = 46,
     /**
      * 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
@@ -7929,29 +8042,31 @@ export declare enum ModCallbackCustom {
      *    callback. For example, since the level is not generated yet, you will not be able to access
      *    any rooms.
      *
-     * - When registering the callback, takes an optional second argument that will make the callback
-     *   only fire if the player matches the `PlayerVariant` provided.
-     * - When registering the callback, takes an optional third argument that will make the callback
-     *   only fire if the player matches the `PlayerType` provided.
+     * 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 `PlayerVariant` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the `PlayerType` provided.
      *
      * ```ts
      * function postPEffectUpdateReordered(player: EntityPlayer): void {}
      * ```
      */
-    POST_PEFFECT_UPDATE_REORDERED = 48,
+    POST_PEFFECT_UPDATE_REORDERED = 47,
     /**
      * Fires on the first `POST_RENDER` frame that a pickup plays the "Collect" animation.
      *
      * Use this callback to know when a pickup is added to the player's inventory or health.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if the pickup variant matches the `PickupVariant` provided.
+     * 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
+     * `PickupVariant` provided.
      *
      * ```ts
      * function postPickupCollect(pickup: EntityPickup, player: EntityPlayer): void {}
      * ```
      */
-    POST_PICKUP_COLLECT = 49,
+    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.
@@ -7959,34 +8074,37 @@ export declare enum ModCallbackCustom {
      * This callback is useful because pickups will despawn upon leaving the room and respawn upon
      * re-entering the room.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if the collectible type matches the `PickupVariant` provided.
+     * 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
+     * `PickupVariant` provided.
      *
      * ```ts
      * function postPickupInitFirst(pickup: EntityPickup): void {}
      * ```
      */
-    POST_PICKUP_INIT_FIRST = 50,
+    POST_PICKUP_INIT_FIRST = 49,
     /**
      * Fires on the first `POST_PICKUP_UPDATE` frame for each pickup.
      *
      * This callback is useful because many attributes cannot be set or retrieved properly in the
      * normal `POST_PICKUP_INIT` callback.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if the pickup variant matches the `PickupVariant` provided.
+     * 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
+     * `PickupVariant` provided.
      *
      * ```ts
      * function postPickupInitLate(pickup: EntityPickup): void {}
      * ```
      */
-    POST_PICKUP_INIT_LATE = 51,
+    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. (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.
+     * 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
+     * `PickupVariant` provided.
      *
      * ```ts
      * function postPickupStateChanged(
@@ -7996,37 +8114,40 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PICKUP_STATE_CHANGED = 52,
+    POST_PICKUP_STATE_CHANGED = 51,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a pit exists.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the variant provided.
+     * 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 variant
+     * provided.
      *
      * ```ts
      * function postPitRender(pit: GridEntityPit): void {}
      * ```
      */
-    POST_PIT_RENDER = 53,
+    POST_PIT_RENDER = 52,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a pit exists.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the variant provided.
+     * 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 variant
+     * provided.
      *
      * ```ts
      * function postPitUpdate(pit: GridEntityPit): void {}
      * ```
      */
-    POST_PIT_UPDATE = 54,
+    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.
      *
-     * - When registering the callback, takes an optional second argument that will make the callback
-     *   only fire if the player matches the `PlayerVariant` provided.
-     * - When registering the callback, takes an optional third argument that will make the callback
-     *   only fire if the player matches the `PlayerType` provided.
+     * 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 `PlayerVariant` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the `PlayerType` provided.
      *
      * ```ts
      * function postPlayerChangeHealth(
@@ -8038,7 +8159,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PLAYER_CHANGE_HEALTH = 55,
+    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.
@@ -8052,10 +8173,11 @@ export declare enum ModCallbackCustom {
      * numbers. (For these cases, you should examine the `oldValue` and `newValue` arguments
      * accordingly.)
      *
-     * - When registering the callback, takes an optional second argument that will make the callback
-     *   only fire if the player matches the `PlayerVariant` provided.
-     * - When registering the callback, takes an optional third argument that will make the callback
-     *   only fire if the player matches the `PlayerType` provided.
+     * 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 `PlayerVariant` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the `PlayerType` provided.
      *
      * ```ts
      * function postPlayerChangeStat(
@@ -8067,7 +8189,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PLAYER_CHANGE_STAT = 56,
+    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
@@ -8077,6 +8199,10 @@ export declare enum ModCallbackCustom {
      * those items cause separate player entities to be created. Use the `POST_FLIP` and
      * `POST_ESAU_JR` callbacks to handle those situations.
      *
+     * 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
+     * `PlayerVariant` provided.
+     *
      * ```ts
      * function postPlayerChangeType(
      *   player: EntityPlayer,
@@ -8085,14 +8211,15 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PLAYER_CHANGE_TYPE = 57,
+    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, or when the active items change, or when the build is
      * rerolled.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if the collectible matches the `CollectibleType` provided.
+     * When registering the callback with the `ModUpgraded.AddCallbackCustom` method, you can provide
+     * an optional third argument that will make the callback only fire if the collectible matches the
+     * `CollectibleType` provided.
      *
      * ```ts
      * function postPlayerCollectibleAdded(
@@ -8101,14 +8228,15 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PLAYER_COLLECTIBLE_ADDED = 58,
+    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, or when the active items change, or when the build is
      * rerolled.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if the collectible matches the `CollectibleType` provided.
+     * When registering the callback with the `ModUpgraded.AddCallbackCustom` method, you can provide
+     * an optional third argument that will make the callback only fire if the collectible matches the
+     * `CollectibleType` provided.
      *
      * ```ts
      * function postPlayerCollectibleRemoved(
@@ -8117,7 +8245,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PLAYER_COLLECTIBLE_REMOVED = 59,
+    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.
@@ -8125,16 +8253,17 @@ export declare enum ModCallbackCustom {
      * Note that this function does properly take into account Guppy's Collar, Broken Ankh, Spirit
      * Shackles, and Mysterious Paper. It also takes into account using The Bible on Satan.
      *
-     * - When registering the callback, takes an optional second argument that will make the callback
-     *   only fire if the player matches the `PlayerVariant` provided.
-     * - When registering the callback, takes an optional third argument that will make the callback
-     *   only fire if the player matches the `PlayerType` provided.
+     * 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 `PlayerVariant` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the `PlayerType` provided.
      *
      * ```ts
      * function postPlayerFatalDamage(player: EntityPlayer): boolean | undefined {}
      * ```
      */
-    POST_PLAYER_FATAL_DAMAGE = 60,
+    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:
@@ -8146,16 +8275,17 @@ export declare enum ModCallbackCustom {
      * character their starting items for the run. (You do not want to use the vanilla
      * `POST_PLAYER_INIT` callback for this because it fires when a run is continued.)
      *
-     * - When registering the callback, takes an optional second argument that will make the callback
-     *   only fire if the player matches the `PlayerVariant` provided.
-     * - When registering the callback, takes an optional third argument that will make the callback
-     *   only fire if the player matches the `PlayerType` provided.
+     * 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 `PlayerVariant` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the `PlayerType` provided.
      *
      * ```ts
      * function postPlayerInitFirst(player: EntityPlayer): void {}
      * ```
      */
-    POST_PLAYER_INIT_FIRST = 61,
+    POST_PLAYER_INIT_FIRST = 60,
     /**
      * Fires on the first `POST_PEFFECT_UPDATE_REORDERED` frame for each player.
      *
@@ -8165,16 +8295,17 @@ export declare enum ModCallbackCustom {
      * For initializing a player with custom items and so forth, use the `POST_PLAYER_INIT_FIRST`
      * callback instead to handle the case of a Genesis room.
      *
-     * - When registering the callback, takes an optional second argument that will make the callback
-     *   only fire if the player matches the `PlayerVariant` provided.
-     * - When registering the callback, takes an optional third argument that will make the callback
-     *   only fire if the player matches the `PlayerType` provided.
+     * 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 `PlayerVariant` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the `PlayerType` provided.
      *
      * ```ts
      * function postPlayerInitLate(pickup: EntityPickup): void {}
      * ```
      */
-    POST_PLAYER_INIT_LATE = 62,
+    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).
@@ -8188,16 +8319,17 @@ export declare enum ModCallbackCustom {
      *    callback. For example, since the level is not generated yet, you will not be able to access
      *    any rooms.
      *
-     * - When registering the callback, takes an optional second argument that will make the callback
-     *   only fire if the player matches the `PlayerVariant` provided.
-     * - When registering the callback, takes an optional third argument that will make the callback
-     *   only fire if the player matches the `PlayerType` provided.
+     * 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 `PlayerVariant` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the `PlayerType` provided.
      *
      * ```ts
      * function postPlayerRenderReordered(player: EntityPlayer): void {}
      * ```
      */
-    POST_PLAYER_RENDER_REORDERED = 63,
+    POST_PLAYER_RENDER_REORDERED = 62,
     /**
      * 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
@@ -8212,147 +8344,159 @@ export declare enum ModCallbackCustom {
      *    callback. For example, since the level is not generated yet, you will not be able to access
      *    any rooms.
      *
-     * - When registering the callback, takes an optional second argument that will make the callback
-     *   only fire if the player matches the `PlayerVariant` provided.
-     * - When registering the callback, takes an optional third argument that will make the callback
-     *   only fire if the player matches the `PlayerType` provided.
+     * 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 `PlayerVariant` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the `PlayerType` provided.
      *
      * ```ts
      * function postPlayerUpdateReordered(player: EntityPlayer): void {}
      * ```
      */
-    POST_PLAYER_UPDATE_REORDERED = 64,
+    POST_PLAYER_UPDATE_REORDERED = 63,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a poop exists.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the variant provided.
+     * 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 variant
+     * provided.
      *
      * ```ts
      * function postPoopRender(poop: GridEntityPoop): void {}
      * ```
      */
-    POST_POOP_RENDER = 65,
+    POST_POOP_RENDER = 64,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a poop exists.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the variant provided.
+     * 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 variant
+     * provided.
      *
      * ```ts
      * function postPoopUpdate(poop: GridEntityPoop): void {}
      * ```
      */
-    POST_POOP_UPDATE = 66,
+    POST_POOP_UPDATE = 65,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a pressure plate exists.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the variant provided.
+     * 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 variant
+     * provided.
      *
      * ```ts
      * function postPressurePlateRender(pressurePlate: GridEntityPressurePlate): void {}
      * ```
      */
-    POST_PRESSURE_PLATE_RENDER = 67,
+    POST_PRESSURE_PLATE_RENDER = 66,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a pressure plate exists.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the variant provided.
+     * 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 variant
+     * provided.
      *
      * ```ts
      * function postPressurePlateUpdate(pressurePlate: GridEntityPressurePlate): void {}
      * ```
      */
-    POST_PRESSURE_PLATE_UPDATE = 68,
+    POST_PRESSURE_PLATE_UPDATE = 67,
     /**
      * Fires on the first `POST_PROJECTILE_UPDATE` frame for each projectile.
      *
      * This callback is useful because many attributes cannot be set or retrieved properly in the
      * normal `POST_PROJECTILE_INIT` callback.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if the projectile variant matches the `ProjectileVariant` provided.
+     * When registering the callback with the `ModUpgraded.AddCallbackCustom` method, you can provide
+     * an optional third argument that will make the callback only fire if matches the
+     * `ProjectileVariant` provided.
      *
      * ```ts
      * function postProjectileInitLate(projectile: EntityProjectile): void {}
      * ```
      */
-    POST_PROJECTILE_INIT_LATE = 69,
+    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.
      *
-     * - When registering the callback, takes an optional second argument that will make the callback
-     *   only fire if it matches the `PickupVariant` provided.
-     * - When registering the callback, takes an optional third argument that will make the callback
-     *   only fire if it matches the sub-type provided.
+     * 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 `PickupVariant` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the sub-type provided.
      *
      * ```ts
      * function postPurchase(player: EntityPlayer, pickup: EntityPickup): void {}
      * ```
      */
-    POST_PURCHASE = 70,
+    POST_PURCHASE = 69,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a rock exists.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the variant provided.
+     * 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 variant
+     * provided.
      *
      * ```ts
      * function postRockRender(rock: GridEntityRock): void {}
      * ```
      */
-    POST_ROCK_RENDER = 71,
+    POST_ROCK_RENDER = 70,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a rock exists.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the variant provided.
+     * 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 variant
+     * provided.
      *
      * ```ts
      * function postRockUpdate(rock: GridEntityRock): void {}
      * ```
      */
-    POST_ROCK_UPDATE = 72,
+    POST_ROCK_UPDATE = 71,
     /**
      * 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.
+     * When registering the callback with the `ModUpgraded.AddCallbackCustom` method, you can provide
+     * an optional third argument that will make the callback only fire if the room clear state
+     * matches the boolean provided.
      *
      * ```ts
      * function postRoomClearChanged(roomClear: boolean): void {}
      * ```
      */
-    POST_ROOM_CLEAR_CHANGED = 73,
+    POST_ROOM_CLEAR_CHANGED = 72,
     /**
      * Fires from the `ENTITY_TAKE_DMG` callback when a player takes damage from spikes in a Sacrifice
      * Room.
      *
-     * - When registering the callback, takes an optional second argument that will make the callback
-     *   only fire if the player matches the `PlayerVariant` provided.
-     * - When registering the callback, takes an optional third argument that will make the callback
-     *   only fire if the player matches the `PlayerType` provided.
+     * 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 `PlayerVariant` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the `PlayerType` provided.
      *
      * ```ts
      * function postSacrifice(player: EntityPlayer, numSacrifices: int): void {}
      * ```
      */
-    POST_SACRIFICE = 74,
+    POST_SACRIFICE = 73,
     /**
      * Fires from the `POST_RENDER` callback when a slot entity's animation changes.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `SlotVariant` provided.
+     * 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
+     * `SlotVariant` provided.
      *
      * ```ts
      * function postSlotAnimationChanged(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_ANIMATION_CHANGED = 75,
+    POST_SLOT_ANIMATION_CHANGED = 74,
     /**
      * 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.)
@@ -8361,9 +8505,10 @@ export declare enum ModCallbackCustom {
      * colliding with it on every frame. Thus, you should only perform actions in this callback under
      * certain conditions, like if the slot entity is playing the "Idle" animation, and so on.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `SlotVariant` provided. (There is no need for any additional
-     * arguments, since only players will cause this callback to fire.)
+     * 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
+     * `SlotVariant` provided. (Only players will cause this callback to fire, so there is no need for
+     * an optional argument to filter by `EntityType`.)
      *
      * ```ts
      * function postSlotCollision(
@@ -8372,21 +8517,22 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_SLOT_COLLISION = 76,
+    POST_SLOT_COLLISION = 75,
     /**
      * Fires from the `POST_RENDER` callback when a slot plays the animation that indicates that it
      * has broken.
      *
-     * - When registering the callback, takes an optional second argument that will make the callback
-     *   only fire if it matches the `SlotVariant` provided.
-     * - When registering the callback, takes an optional third argument that will make the callback
-     *   only fire if the destruction type matches the `SlotDestructionType` provided.
+     * 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 `SlotVariant` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the `SlotDestructionType` provided.
      *
      * ```ts
      * function postSlotDestroyed(slot: Entity, slotDestructionType: SlotDestructionType): void {}
      * ```
      */
-    POST_SLOT_DESTROYED = 77,
+    POST_SLOT_DESTROYED = 76,
     /**
      * Fires when a new slot entity is initialized. Specifically, this is either:
      *
@@ -8395,58 +8541,63 @@ export declare enum ModCallbackCustom {
      * - in the `POST_UPDATE` callback (if the entity appeared mid-way through the room, like when a
      *   Wheel of Fortune card is used)
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `SlotVariant` provided.
+     * 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
+     * `SlotVariant` provided.
      *
      * ```ts
      * function postSlotInit(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_INIT = 78,
+    POST_SLOT_INIT = 77,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a slot entity exists.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `SlotVariant` provided.
+     * 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
+     * `SlotVariant` provided.
      *
      * ```ts
      * function postSlotRender(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_RENDER = 79,
+    POST_SLOT_RENDER = 78,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a slot entity exists.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `SlotVariant` provided.
+     * 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
+     * `SlotVariant` provided.
      *
      * ```ts
      * function postSlotUpdate(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_UPDATE = 80,
+    POST_SLOT_UPDATE = 79,
     /**
      * Fires from the `POST_RENDER` callback on every frame that spikes exist.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the variant provided.
+     * 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 variant
+     * provided.
      *
      * ```ts
      * function postSpikesRender(spikes: GridEntitySpikes): void {}
      * ```
      */
-    POST_SPIKES_RENDER = 81,
+    POST_SPIKES_RENDER = 80,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that spikes exist.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the variant provided.
+     * 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 variant
+     * provided.
      *
      * ```ts
      * function postSpikesUpdate(spikes: GridEntitySpikes): void {}
      * ```
      */
-    POST_SPIKES_UPDATE = 82,
+    POST_SPIKES_UPDATE = 81,
     /**
      * Fires on the first `POST_TEAR_UPDATE` frame for each tear (which is when
      * `EntityTear.FrameCount` is equal to 0).
@@ -8454,58 +8605,63 @@ export declare enum ModCallbackCustom {
      * This callback is useful because many attributes cannot be set or retrieved properly in the
      * normal `POST_TEAR_INIT` callback.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if the tear variant matches the `TearVariant` provided.
+     * 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
+     * `TearVariant` provided.
      *
      * ```ts
      * function postTearInitLate(tear: EntityTear): void {}
      * ```
      */
-    POST_TEAR_INIT_LATE = 83,
+    POST_TEAR_INIT_LATE = 82,
     /**
      * Fires on the second `POST_TEAR_UPDATE` frame for each tear (which is when
      * `EntityTear.FrameCount` is equal to 1).
      *
      * This callback is useful because Incubus tears are not distinguishable until the second frame.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if the tear variant matches the `TearVariant` provided.
+     * 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
+     * `TearVariant` provided.
      *
      * ```ts
      * function postTearInitVeryLate(tear: EntityTear): void {}
      * ```
      */
-    POST_TEAR_INIT_VERY_LATE = 84,
+    POST_TEAR_INIT_VERY_LATE = 83,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a TNT exists.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the variant provided.
+     * 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 variant
+     * provided.
      *
      * ```ts
      * function postTNTRender(tnt: GridEntityTNT): void {}
      * ```
      */
-    POST_TNT_RENDER = 85,
+    POST_TNT_RENDER = 84,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a TNT exists.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the variant provided.
+     * 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 variant
+     * provided.
      *
      * ```ts
      * function postTNTUpdate(tnt: GridEntityTNT): void {}
      * ```
      */
-    POST_TNT_UPDATE = 86,
+    POST_TNT_UPDATE = 85,
     /**
      * Fires from the `POST_PEFFECT_UPDATE` callback when a player gains or loses a new
      * transformation.
      *
      * Note that this callback will only fire once per Forgotten/Soul pair.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `PlayerForm` provided.
+     * 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 `PlayerForm`
+     * provided.
      *
      * ```ts
      * function postTransformation(
@@ -8515,12 +8671,13 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_TRANSFORMATION = 87,
+    POST_TRANSFORMATION = 86,
     /**
      * Fires from `ENTITY_TAKE_DMG` callback when a Wishbone or a Walnut breaks.
      *
-     * When registering the callback, takes an optional second argument that will make the callback
-     * only fire if it matches the `TrinketType` provided.
+     * 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
+     * `TrinketType` provided.
      *
      * ```ts
      * function postTrinketBreak(
@@ -8529,22 +8686,23 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_TRINKET_BREAK = 88,
+    POST_TRINKET_BREAK = 87,
     /**
      * 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
      * a "Lost" form).
      *
-     * - When registering the callback, takes an optional second argument that will make the callback
-     *   only fire if the player matches the `PlayerVariant` provided.
-     * - When registering the callback, takes an optional third argument that will make the callback
-     *   only fire if the player matches the `PlayerType` provided.
+     * 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 `PlayerVariant` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the `PlayerType` provided.
      *
      * ```ts
      * function preBerserkDeath(player: EntityPlayer): void {}
      * ```
      */
-    PRE_BERSERK_DEATH = 89,
+    PRE_BERSERK_DEATH = 88,
     /**
      * 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
@@ -8553,16 +8711,17 @@ export declare enum ModCallbackCustom {
      * This callback is useful because reviving the player after the game things that player should
      * have died will result in the save data for the run getting deleted.
      *
-     * - When registering the callback, takes an optional second argument that will make the callback
-     *   only fire if the player matches the `PlayerVariant` provided.
-     * - When registering the callback, takes an optional third argument that will make the callback
-     *   only fire if the player matches the `PlayerType` provided.
+     * 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 `PlayerVariant` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the `PlayerType` provided.
      *
      * ```ts
      * function preCustomRevive(player: EntityPlayer): int | undefined {}
      * ```
      */
-    PRE_CUSTOM_REVIVE = 90,
+    PRE_CUSTOM_REVIVE = 89,
     /**
      * Fires from the `PRE_PICKUP_COLLISION` callback when a player touches a collectible pedestal and
      * meets all of the conditions to pick it up.
@@ -8572,26 +8731,28 @@ export declare enum ModCallbackCustom {
      * note that this callback will continue to fire for every frame that the player touches the
      * pedestal, so you would need to continue returning false.)
      *
-     * - When registering the callback, takes an optional second argument that will make the callback
-     *   only fire if the player matches the `PlayerVariant` provided.
-     * - When registering the callback, takes an optional third argument that will make the callback
-     *   only fire if the player matches the `PlayerType` provided.
+     * 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 `PlayerVariant` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the `PlayerType` provided.
      *
      * ```ts
      * function preGetPedestal(player: EntityPlayer, collectible: EntityPickupCollectible): void {}
      * ```
      */
-    PRE_GET_PEDESTAL = 91,
+    PRE_GET_PEDESTAL = 90,
     /**
      * 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).
      *
      * Note that this callback will only fire once per Forgotten/Soul pair.
      *
-     * - When registering the callback, takes an optional second argument that will make the callback
-     *   only fire if it matches the `ItemType` provided.
-     * - When registering the callback, takes an optional third argument that will make the callback
-     *   only fire if the `CollectibleType` or the `TrinketType` matches the ID provided.
+     * 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 `ItemType` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if the
+     *   sub-type matches the `CollectibleType` or the `TrinketType` provided.
      *
      * ```ts
      * function preItemPickup(
@@ -8600,7 +8761,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    PRE_ITEM_PICKUP = 92,
+    PRE_ITEM_PICKUP = 91,
     /**
      * 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
@@ -8614,39 +8775,62 @@ export declare enum ModCallbackCustom {
      * function preNewLevel(player: EntityPlayer): void {}
      * ```
      */
-    PRE_NEW_LEVEL = 93
+    PRE_NEW_LEVEL = 92
+}
+
+/** TODO */
+export declare enum ModCallbackCustom2 {
+    POST_AMBUSH_FINISHED = 0,
+    POST_AMBUSH_STARTED = 1,
+    POST_BOMB_EXPLODED = 2,
+    POST_BOMB_INIT_LATE = 3,
+    POST_BONE_SWING = 4,
+    POST_COLLECTIBLE_EMPTY = 5,
+    POST_COLLECTIBLE_INIT_FIRST = 6,
+    POST_CURSED_TELEPORT = 7,
+    POST_KNIFE_INIT_LATE = 8,
+    POST_NEW_ROOM_EARLY = 9,
+    POST_PIT_RENDER = 10,
+    POST_ROOM_CLEAR_CHANGED = 11,
+    POST_SPIKES_RENDER = 12
 }
 
 /**
  * `isaacscript-common` has many custom callbacks that you can use in your mods. Instead of
  * hijacking the vanilla `Mod` object, we provide a `ModUpgraded` object for you to use, which
- * extends the base class and adds a new method of `AddCallbackCustom`. (There is no corresponding
- * `RemoveCallbackCustom`.)
+ * extends the base class and adds a new method of `AddCallbackCustom`.
  *
  * To upgrade your mod, use the `upgradeMod` helper function.
  */
 export declare class ModUpgraded implements Mod {
     /**
      * The vanilla mod object stores the name of the mod for some reason. (It is never used or
-     * referenced.
+     * referenced. (We match the casing of the vanilla variable.)
      */
     Name: string;
     /** We store a copy of the original mod object so that we can re-implement its functions. */
-    Mod: Mod;
-    Debug: boolean;
-    TimeThreshold: float | undefined;
+    private mod;
+    private debug;
+    private timeThreshold;
+    private callbacks;
     constructor(mod: Mod, debug: boolean, timeThreshold?: float);
-    AddCallback<T extends ModCallback>(modCallback: T, ...args: AddCallbackParameter[T]): void;
+    AddCallback<T extends ModCallback>(modCallback: T, ...args: AddCallbackParameters[T]): void;
     HasData(): boolean;
     LoadData(): string;
     /**
      * This method does not care about the tertiary argument. Regardless of the conditions of how you
      * registered the callback, it will be removed.
      */
-    RemoveCallback<T extends ModCallback>(modCallback: T, callback: AddCallbackParameter[T][0]): void;
+    RemoveCallback<T extends ModCallback>(modCallback: T, callback: AddCallbackParameters[T][0]): void;
     RemoveData(): void;
     SaveData(data: string): void;
-    AddCallbackCustom<T extends ModCallbackCustom>(modCallbackCustom: T, ...args: AddCallbackParameterCustom[T]): void;
+    AddCallbackCustom<T extends ModCallbackCustom>(modCallbackCustom: T, ...args: AddCallbackParametersCustom[T]): void;
+    AddCallbackCustom2<T extends ModCallbackCustom2>(modCallbackCustom: T, ...args: AddCallbackParametersCustom2[T]): void;
+    /**
+     * This method does not care about the tertiary argument. Regardless of the conditions of how you
+     * registered the callback, it will be removed.
+     */
+    RemoveCallbackCustom<T extends ModCallbackCustom>(modCallback: T, callback: AddCallbackParametersCustom[T][0]): void;
 }
 
 /**
@@ -9014,22 +9198,19 @@ callback: (boneClub: EntityKnife) => void
 ];
 
 declare type PostCollectibleEmptyRegisterParameters = [
-callback: (collectible: EntityPickup, oldCollectibleType: CollectibleType) => void,
+callback: (collectible: EntityPickupCollectible, oldCollectibleType: CollectibleType) => void,
 collectibleType?: CollectibleType
 ];
 
 declare type PostCollectibleInitFirstRegisterParameters = [
-callback: (collectible: EntityPickup) => void,
+callback: (collectible: EntityPickupCollectible) => void,
 collectibleType?: CollectibleType
 ];
 
 declare type PostCursedTeleportRegisterParameters = [
-callback: (player: EntityPlayer) => void
-];
-
-declare type PostCustomDoorEnterRegisterParameters = [
-callback: (player: EntityPlayer, effectVariant: int, doorSlot: DoorSlot, direction: Direction) => void,
-effectVariant?: int
+callback: (player: EntityPlayer) => void,
+playerVariant?: PlayerVariant,
+character?: PlayerType
 ];
 
 declare type PostCustomReviveRegisterParameters = [
@@ -10888,6 +11069,8 @@ export declare function setDeletePlayer(set: Set<PlayerIndex>, player: EntityPla
  * This function automatically calls the `Level.UpdateVisibility` after setting the flags so that
  * the changes will be immediately visible.
  *
+ * This function automatically accounts for whether or not MinimapAPI is being used.
+ *
  * @param displayFlagsMap A map of the display flags that is indexed by the room's safe grid index.
  */
 export declare function setDisplayFlags(displayFlagsMap: Map<int, BitFlags<DisplayFlag>>): void;
@@ -11426,10 +11609,11 @@ export declare function spawnCoin(coinSubType: CoinSubType, position: Vector, ve
 export declare function spawnCoinWithSeed(coinSubType: CoinSubType, position: Vector, seedOrRNG: Seed | RNG, velocity?: Vector, spawner?: Entity | undefined): EntityPickupCoin;
 
 /**
- * Helper function to spawn a collectible. Use this instead of the `Game.Spawn` method because it
- * handles the cases of Tainted Keeper collectibles costing coins and preventing quest items from
- * being rotated by Tainted Isaac's rotation mechanic. (Rotation prevention will only occur in
- * upgraded mods.)
+ * Helper function to spawn a collectible.
+ *
+ * Use this instead of the `Game.Spawn` method because it handles the cases of Tainted Keeper
+ * collectibles costing coins and preventing quest items from being rotated by Tainted Isaac's
+ * rotation mechanic. (Rotation prevention will only occur in upgraded mods.)
  *
  * @param collectibleType The collectible type to spawn.
  * @param position The position to spawn the collectible at.
@@ -11443,35 +11627,31 @@ export declare function spawnCoinWithSeed(coinSubType: CoinSubType, position: Ve
  */
 export declare function spawnCollectible(collectibleType: CollectibleType, position: Vector, seedOrRNG?: Seed | RNG, options?: boolean, forceFreeItem?: boolean, spawner?: Entity): EntityPickupCollectible;
 
+/**
+ * Helper function to spawn a collectible from a specific item pool.
+ *
+ * Use this instead of the `Game.Spawn` method because it handles the cases of Tainted Keeper
+ * collectibles costing coins and preventing quest items from being rotated by Tainted Isaac's
+ * rotation mechanic. (Rotation prevention will only occur in upgraded mods.)
+ *
+ * @param itemPoolType The item pool to draw the collectible type from.
+ * @param position The position to spawn the collectible at.
+ * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
+ *                  `RNG.Next` method will be called. Default is `getRandomSeed()`.
+ * @param options Optional. Set to true to make the collectible a "There's Options" style
+ *                collectible. Default is false.
+ * @param forceFreeItem Optional. Set to true to disable the logic that gives the item a price for
+ *                      Tainted Keeper. Default is false.
+ * @param spawner Optional.
+ */
+export declare function spawnCollectibleFromPool(itemPoolType: ItemPoolType, position: Vector, seedOrRNG?: Seed | RNG, options?: boolean, forceFreeItem?: boolean, spawner?: Entity): EntityPickupCollectible;
+
 /** Helper function to spawn a `GridEntityType.CRAWL_SPACE` (18). */
 export declare function spawnCrawlSpace(gridIndexOrPosition: int | Vector): GridEntity | undefined;
 
 /** Helper function to spawn a `GridEntityType.CRAWL_SPACE` (18) with a specific variant. */
 export declare function spawnCrawlSpaceWithVariant(crawlSpaceVariant: CrawlSpaceVariant, gridIndexOrPosition: int | Vector): GridEntity | undefined;
 
-/**
- * Helper function to spawn a custom door. This is intended to be called from the `POST_NEW_ROOM`
- * callback when the player enters a room that should have a custom door. (You could also call it
- * from another callback if you want the door to appear e.g. after clearing all enemies.)
- *
- * Like other entities, the door is not persistent, so you must spawn it every time when re-entering
- * the room.
- *
- * Handle when a player enters the door by hooking the custom `POST_CUSTOM_DOOR_ENTER` callback.
- *
- * The custom door is an `EntityEffect`. You can manually open or close the door by modifying its
- * state. (The values to use correspond to the `DoorState` enum.)
- *
- * This function will throw a run-time error if:
- * - the door slot already has a vanilla door
- * - the door slot already has a custom door
- * - the tile at the door slot does not have a wall
- *
- * Before using this function, you must first initialize the effect/door variant with the
- * `initCustomDoor` function.
- */
-export declare function spawnCustomDoor(effectVariant: EffectVariant, doorSlot: DoorSlot): EntityEffect;
-
 /**
  * Helper function to spawn a custom grid entity. Custom grid entities are persistent in that they
  * will reappear if the player leaves and re-enters the room. (It will be manually respawned in the
@@ -11964,15 +12144,14 @@ export declare function tanh(x: number): number;
  * Use this function instead of invoking the `Game.StartRoomTransition` method directly so that:
  * - you do not forget to set the `Level.LeaveDoor` field
  * - to prevent crashing on invalid room grid indexes
- * - to automatically handle Curse of the Maze
+ *
+ * Note that if the current floor has Curse of the Maze, it may redirect the intended teleport.
  *
  * @param roomGridIndex The room grid index of the destination room.
  * @param direction Optional. Default is `Direction.NO_DIRECTION`.
  * @param roomTransitionAnim Optional. Default is `RoomTransitionAnim.TELEPORT`.
- * @param force Optional. Whether to temporarily disable Curse of the Maze. Default is false. If set
- *              to false, then this function may not go to the provided room grid index.
  */
-export declare function teleport(roomGridIndex: int, direction?: Direction, roomTransitionAnim?: RoomTransitionAnim, force?: boolean): void;
+export declare function teleport(roomGridIndex: int, direction?: Direction, roomTransitionAnim?: RoomTransitionAnim): void;
 
 /** For `GridEntityType.TELEPORTER` (23). */
 export declare const TELEPORTER_ACTIVATION_DISTANCE: number;