isaacscript-common 14.1.3 → 15.0.0

package/dist/src/enums/ModCallbackCustom.d.ts

@@ -11,9 +11,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 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.
+     * 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 {}
@@ -24,9 +24,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 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.
+     * 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 {}
@@ -36,9 +36,11 @@ export declare enum ModCallbackCustom {
     /**
      * Fires on the `POST_BOMB_UPDATE` callback that it explodes.
      *
-     * 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.
+     * 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.
+     * - You can provide an optional forth argument that will make the callback only fire if it
+     *   matches the sub-type provided.
      *
      * ```ts
      * function postBombDetonated(bomb: EntityBomb): void {}
@@ -51,9 +53,11 @@ 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 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.
+     * 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.
+     * - You can provide an optional forth argument that will make the callback only fire if it
+     *   matches the sub-type provided.
      *
      * ```ts
      * function postBombInitLate(bomb: EntityBomb): void {}
@@ -72,9 +76,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 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.
+     * 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(
@@ -93,9 +97,9 @@ 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 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.
+     * 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: EntityPickupCollectible): void {}
@@ -127,9 +131,9 @@ export declare enum ModCallbackCustom {
      * `player.AnimateCollectible(CollectibleTypeCustom.COLLECTIBLE_MY_REVIVAL_ITEM);`, otherwise the
      * animation for a 1-Up will play.
      *
-     * 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.
+     * 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 {}
@@ -140,9 +144,9 @@ export declare enum ModCallbackCustom {
      * Fires from the `EFFECT_POST_UPDATE` callback after a player has entered the range of a Dice
      * Room floor.
      *
-     * 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.
+     * 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(
@@ -155,9 +159,9 @@ export declare enum ModCallbackCustom {
     /**
      * Fires from the `POST_RENDER` callback on every frame that a door exists.
      *
-     * 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.
+     * 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 {}
@@ -167,9 +171,9 @@ export declare enum ModCallbackCustom {
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a door exists.
      *
-     * 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.
+     * 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 {}
@@ -182,9 +186,11 @@ export declare enum ModCallbackCustom {
      * This callback is useful because many attributes cannot be set or retrieved properly in the
      * normal `POST_EFFECT_INIT` callback.
      *
-     * 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.
+     * 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.
+     * - You can provide an optional forth argument that will make the callback only fire if it
+     *   matches the sub-type provided.
      *
      * ```ts
      * function postEffectInitLate(effect: EntityEffect): void {}
@@ -195,9 +201,11 @@ export declare enum ModCallbackCustom {
      * 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 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.
+     * 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.
+     * - You can provide an optional forth argument that will make the callback only fire if it
+     *   matches the sub-type provided.
      *
      * ```ts
      * function postEffectStateChanged(
@@ -223,9 +231,11 @@ 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 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.
+     * 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.
+     * - You can provide an optional forth argument that will make the callback only fire if it
+     *   matches the sub-type provided.
      *
      * ```ts
      * function postFamiliarInitLate(familiar: EntityFamiliar): void {}
@@ -237,9 +247,11 @@ export declare enum ModCallbackCustom {
      * was on the previous frame. (In this context, "state" refers to the `EntityFamiliar.State`
      * field.)
      *
-     * 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.
+     * 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.
+     * - You can provide an optional forth argument that will make the callback only fire if it
+     *   matches the sub-type provided.
      *
      * ```ts
      * function postFamiliarStateChanged(
@@ -354,6 +366,8 @@ export declare enum ModCallbackCustom {
      *   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.
+     * - You can provide an optional seventh argument that will make the callback only fire if the
+     *   colliding entity matches the sub-type provided.
      *
      * ```ts
      * function postGridEntityCollision(
@@ -367,10 +381,10 @@ export declare enum ModCallbackCustom {
      * 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 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.)
+     * 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(
@@ -392,6 +406,8 @@ export declare enum ModCallbackCustom {
      *   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.
+     * - You can provide an optional sixth argument that will make the callback only fire if the
+     *   colliding entity matches the sub-type provided.
      *
      * ```ts
      * function postGridEntityCustomCollision(
@@ -406,10 +422,10 @@ export declare enum ModCallbackCustom {
      * 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 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.)
+     * 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(
@@ -423,10 +439,10 @@ export declare enum ModCallbackCustom {
      * 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 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.)
+     * 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(
@@ -440,10 +456,10 @@ export declare enum ModCallbackCustom {
      * 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 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.)
+     * 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(
@@ -457,10 +473,10 @@ export declare enum ModCallbackCustom {
      * 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 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.)
+     * 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(
@@ -476,10 +492,10 @@ export declare enum ModCallbackCustom {
      * 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 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.)
+     * 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(
@@ -625,9 +641,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 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.
+     * 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(
@@ -665,9 +681,11 @@ export declare enum ModCallbackCustom {
      * This callback is useful because many attributes cannot be set or retrieved properly in the
      * normal `POST_KNIFE_INIT` callback.
      *
-     * 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.
+     * 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.
+     * - You can provide an optional forth argument that will make the callback only fire if it
+     *   matches the sub-type provided.
      *
      * ```ts
      * function postKnifeInitLate(knife: EntityKnife): void {}
@@ -680,9 +698,11 @@ export declare enum ModCallbackCustom {
      * This callback is useful because many attributes cannot be set or retrieved properly in the
      * normal `POST_LASER_INIT` callback.
      *
-     * 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.
+     * 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.
+     * - You can provide an optional forth argument that will make the callback only fire if it
+     *   matches the sub-type provided.
      *
      * ```ts
      * function postLaserInitLate(laser: EntityLaser): void {}
@@ -740,9 +760,13 @@ export declare enum ModCallbackCustom {
      * This callback is useful because many attributes cannot be set or retrieved properly in the
      * normal `POST_NPC_INIT` callback.
      *
-     * 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.
+     * 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.
+     * - You can provide an optional fifth argument that will make the callback only fire if it
+     *   matches the sub-type provided.
      *
      * ```ts
      * function postNPCInitLate(npc: EntityNPC): void {}
@@ -758,6 +782,8 @@ export declare enum ModCallbackCustom {
      *   matches the `EntityType` provided.
      * - You can provide an optional fourth argument that will make the callback only fire if it
      *   matches the variant provided.
+     * - You can provide an optional fifth argument that will make the callback only fire if it
+     *   matches the sub-type provided.
      *
      * ```ts
      * function postNPCStateChanged(
@@ -798,9 +824,11 @@ export declare enum ModCallbackCustom {
      *
      * Use this callback to know when a pickup is added to the player's inventory or health.
      *
-     * 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.
+     * 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 postPickupCollect(pickup: EntityPickup, player: EntityPlayer): void {}
@@ -814,9 +842,11 @@ 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 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.
+     * 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 postPickupInitFirst(pickup: EntityPickup): void {}
@@ -829,9 +859,11 @@ export declare enum ModCallbackCustom {
      * This callback is useful because many attributes cannot be set or retrieved properly in the
      * normal `POST_PICKUP_INIT` callback.
      *
-     * 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.
+     * 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 postPickupInitLate(pickup: EntityPickup): void {}
@@ -842,9 +874,11 @@ export declare enum ModCallbackCustom {
      * 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 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.
+     * 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 postPickupStateChanged(
@@ -858,9 +892,9 @@ export declare enum ModCallbackCustom {
     /**
      * Fires from the `POST_RENDER` callback on every frame that a pit exists.
      *
-     * 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.
+     * 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 {}
@@ -870,9 +904,9 @@ export declare enum ModCallbackCustom {
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a pit exists.
      *
-     * 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.
+     * 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 {}
@@ -920,13 +954,13 @@ export declare enum ModCallbackCustom {
      *   matches the `PlayerType` provided.
      *
      * ```ts
-     * function postPlayerChangeStat(
+     * function postPlayerChangeStat<T extends StatType>(
      *   player: EntityPlayer,
-     *   statType: StatType,
+     *   statType: T,
      *   difference: int,
-     *   oldValue: number | boolean | BitFlags<TearFlag> | Color | Vector,
-     *   newValue: number | boolean | BitFlags<TearFlag> | Color | Vector,
-     * ): void {}
+     *   oldValue: StatTypeType[T],
+     *   newValue: StatTypeType[T],
+     * ) => void {}
      * ```
      */
     POST_PLAYER_CHANGE_STAT = 55,
@@ -939,9 +973,9 @@ 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.
+     * 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(
@@ -957,9 +991,9 @@ export declare enum ModCallbackCustom {
      * what it was on the previous frame, or when the active items change, or when the build is
      * rerolled.
      *
-     * 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.
+     * 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(
@@ -974,9 +1008,9 @@ export declare enum ModCallbackCustom {
      * what it was on the previous frame, or when the active items change, or when the build is
      * rerolled.
      *
-     * 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.
+     * 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(
@@ -1098,9 +1132,9 @@ export declare enum ModCallbackCustom {
     /**
      * Fires from the `POST_RENDER` callback on every frame that a poop exists.
      *
-     * 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.
+     * 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 {}
@@ -1110,9 +1144,9 @@ export declare enum ModCallbackCustom {
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a poop exists.
      *
-     * 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.
+     * 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 {}
@@ -1122,9 +1156,9 @@ export declare enum ModCallbackCustom {
     /**
      * Fires from the `POST_RENDER` callback on every frame that a pressure plate exists.
      *
-     * 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.
+     * 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 {}
@@ -1134,9 +1168,9 @@ export declare enum ModCallbackCustom {
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a pressure plate exists.
      *
-     * 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.
+     * 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 {}
@@ -1149,9 +1183,11 @@ export declare enum ModCallbackCustom {
      * This callback is useful because many attributes cannot be set or retrieved properly in the
      * normal `POST_PROJECTILE_INIT` callback.
      *
-     * 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.
+     * 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.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the sub-type provided.
      *
      * ```ts
      * function postProjectileInitLate(projectile: EntityProjectile): void {}
@@ -1176,9 +1212,11 @@ export declare enum ModCallbackCustom {
     /**
      * Fires from the `POST_RENDER` callback on every frame that a rock exists.
      *
-     * 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.
+     * 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 postRockRender(rock: GridEntityRock): void {}
@@ -1188,9 +1226,11 @@ export declare enum ModCallbackCustom {
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a rock exists.
      *
-     * 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.
+     * 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 postRockUpdate(rock: GridEntityRock): void {}
@@ -1201,9 +1241,13 @@ export declare enum ModCallbackCustom {
      * 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 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.
+     * For example, this callback fires when you defeat all the enemies in a room (clear --> not
+     * clear) or when you bomb an angel statue (not clear --> clear). This callback does not fire when
+     * you travel between a cleared room and an uncleared 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 the room
+     *   clear state matches the boolean provided.
      *
      * ```ts
      * function postRoomClearChanged(roomClear: boolean): void {}
@@ -1228,9 +1272,11 @@ export declare enum ModCallbackCustom {
     /**
      * Fires from the `POST_RENDER` callback when a slot entity's animation changes.
      *
-     * 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.
+     * 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 sub-type provided.
      *
      * ```ts
      * function postSlotAnimationChanged(slot: Entity): void {}
@@ -1245,10 +1291,13 @@ 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 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`.)
+     * 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 sub-type 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(
@@ -1266,7 +1315,7 @@ export declare enum ModCallbackCustom {
      * - 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.
+     *   matches the sub-type provided.
      *
      * ```ts
      * function postSlotDestroyed(slot: Entity, slotDestructionType: SlotDestructionType): void {}
@@ -1281,9 +1330,11 @@ 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 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.
+     * 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 sub-type provided.
      *
      * ```ts
      * function postSlotInit(slot: Entity): void {}
@@ -1293,9 +1344,11 @@ export declare enum ModCallbackCustom {
     /**
      * Fires from the `POST_RENDER` callback on every frame that a slot entity exists.
      *
-     * 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.
+     * 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 sub-type provided.
      *
      * ```ts
      * function postSlotRender(slot: Entity): void {}
@@ -1305,9 +1358,11 @@ export declare enum ModCallbackCustom {
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a slot entity exists.
      *
-     * 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.
+     * 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 sub-type provided.
      *
      * ```ts
      * function postSlotUpdate(slot: Entity): void {}
@@ -1317,9 +1372,9 @@ export declare enum ModCallbackCustom {
     /**
      * Fires from the `POST_RENDER` callback on every frame that spikes exist.
      *
-     * 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.
+     * 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 {}
@@ -1329,9 +1384,9 @@ export declare enum ModCallbackCustom {
     /**
      * Fires from the `POST_UPDATE` callback on every frame that spikes exist.
      *
-     * 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.
+     * 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 {}
@@ -1345,9 +1400,11 @@ 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 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.
+     * 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.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the sub-type provided.
      *
      * ```ts
      * function postTearInitLate(tear: EntityTear): void {}
@@ -1360,9 +1417,11 @@ export declare enum ModCallbackCustom {
      *
      * This callback is useful because Incubus tears are not distinguishable until the second frame.
      *
-     * When registering the callback with the `ModUpgraded.AddCallbackCustom` method, you can provide
-     * an optional third argument that will make the callback only fire if it matches the
-     * `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.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the sub-type provided.
      *
      * ```ts
      * function postTearInitVeryLate(tear: EntityTear): void {}
@@ -1372,9 +1431,9 @@ export declare enum ModCallbackCustom {
     /**
      * Fires from the `POST_RENDER` callback on every frame that a TNT exists.
      *
-     * 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.
+     * 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 {}
@@ -1384,9 +1443,9 @@ export declare enum ModCallbackCustom {
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a TNT exists.
      *
-     * 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.
+     * 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 {}
@@ -1399,9 +1458,9 @@ export declare enum ModCallbackCustom {
      *
      * Note that this callback will only fire once per Forgotten/Soul pair.
      *
-     * 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.
+     * 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(
@@ -1415,9 +1474,9 @@ export declare enum ModCallbackCustom {
     /**
      * Fires from `ENTITY_TAKE_DMG` callback when a Wishbone or a Walnut breaks.
      *
-     * 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.
+     * 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(