isaacscript-common 27.10.1 → 27.11.0

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

@@ -266,6 +266,21 @@ export declare enum ModCallbackCustom {
      * ```
      */
     POST_DOOR_UPDATE = 15,
+    /**
+     * The exact same thing as the vanilla `POST_EFFECT_INIT` callback, except this callback allows
+     * you to specify extra arguments for additional filtration.
+     *
+     * When registering the callback with the `ModUpgraded.AddCallbackCustom` method:
+     * - You can provide an optional third argument that will make the callback only fire if it
+     *   matches the `EffectVariant` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the sub-type provided.
+     *
+     * ```ts
+     * function postEffectInitFilter(effect: EntityEffect): void {}
+     * ```
+     */
+    POST_EFFECT_INIT_FILTER = 16,
     /**
      * Fires on the first `POST_EFFECT_UPDATE` frame for each effect.
      *
@@ -282,7 +297,22 @@ export declare enum ModCallbackCustom {
      * function postEffectInitLate(effect: EntityEffect): void {}
      * ```
      */
-    POST_EFFECT_INIT_LATE = 16,
+    POST_EFFECT_INIT_LATE = 17,
+    /**
+     * The exact same thing as the vanilla `POST_EFFECT_RENDER` callback, except this callback allows
+     * you to specify extra arguments for additional filtration.
+     *
+     * When registering the callback with the `ModUpgraded.AddCallbackCustom` method:
+     * - You can provide an optional third argument that will make the callback only fire if it
+     *   matches the `EffectVariant` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the sub-type provided.
+     *
+     * ```ts
+     * function postEffectRenderFilter(effect: EntityEffect, renderOffset: Vector): void {}
+     * ```
+     */
+    POST_EFFECT_RENDER_FILTER = 18,
     /**
      * 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.)
@@ -301,7 +331,22 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_EFFECT_STATE_CHANGED = 17,
+    POST_EFFECT_STATE_CHANGED = 19,
+    /**
+     * The exact same thing as the vanilla `POST_EFFECT_UPDATE` callback, except this callback allows
+     * you to specify extra arguments for additional filtration.
+     *
+     * When registering the callback with the `ModUpgraded.AddCallbackCustom` method:
+     * - You can provide an optional third argument that will make the callback only fire if it
+     *   matches the `EffectVariant` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the sub-type provided.
+     *
+     * ```ts
+     * function postEffectUpdateFilter(effect: EntityEffect): void {}
+     * ```
+     */
+    POST_EFFECT_UPDATE_FILTER = 20,
     /**
      * The exact same thing as the vanilla `POST_ENTITY_KILL` callback, except this callback allows
      * you to specify extra arguments for additional filtration.
@@ -318,7 +363,7 @@ export declare enum ModCallbackCustom {
      * function postEntityKillFilter(entity: Entity): void {}
      * ```
      */
-    POST_ENTITY_KILL_FILTER = 18,
+    POST_ENTITY_KILL_FILTER = 21,
     /**
      * 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.)
@@ -327,7 +372,22 @@ export declare enum ModCallbackCustom {
      * function postEsauJr(player: EntityPlayer): void {}
      * ```
      */
-    POST_ESAU_JR = 19,
+    POST_ESAU_JR = 22,
+    /**
+     * The exact same thing as the vanilla `POST_FAMILIAR_INIT` callback, except this callback allows
+     * you to specify extra arguments for additional filtration.
+     *
+     * When registering the callback with the `ModUpgraded.AddCallbackCustom` method:
+     * - You can provide an optional third argument that will make the callback only fire if it
+     *   matches the `FamiliarVariant` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the sub-type provided.
+     *
+     * ```ts
+     * function postFamiliarInitFilter(familiar: EntityFamiliar): void {}
+     * ```
+     */
+    POST_FAMILIAR_INIT_FILTER = 23,
     /**
      * Fires on the first `FAMILIAR_UPDATE` frame for each familiar.
      *
@@ -344,7 +404,22 @@ export declare enum ModCallbackCustom {
      * function postFamiliarInitLate(familiar: EntityFamiliar): void {}
      * ```
      */
-    POST_FAMILIAR_INIT_LATE = 20,
+    POST_FAMILIAR_INIT_LATE = 24,
+    /**
+     * The exact same thing as the vanilla `POST_FAMILIAR_RENDER` callback, except this callback
+     * allows you to specify extra arguments for additional filtration.
+     *
+     * When registering the callback with the `ModUpgraded.AddCallbackCustom` method:
+     * - You can provide an optional third argument that will make the callback only fire if it
+     *   matches the `FamiliarVariant` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the sub-type provided.
+     *
+     * ```ts
+     * function postFamiliarRenderFilter(familiar: EntityFamiliar, renderOffset: Vector): void {}
+     * ```
+     */
+    POST_FAMILIAR_RENDER_FILTER = 25,
     /**
      * 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`
@@ -364,7 +439,22 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_FAMILIAR_STATE_CHANGED = 21,
+    POST_FAMILIAR_STATE_CHANGED = 26,
+    /**
+     * The exact same thing as the vanilla `POST_FAMILIAR_UPDATE` callback, except this callback
+     * allows you to specify extra arguments for additional filtration.
+     *
+     * When registering the callback with the `ModUpgraded.AddCallbackCustom` method:
+     * - You can provide an optional third argument that will make the callback only fire if it
+     *   matches the `FamiliarVariant` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the sub-type provided.
+     *
+     * ```ts
+     * function postFamiliarUpdateFilter(familiar: EntityFamiliar): void {}
+     * ```
+     */
+    POST_FAMILIAR_UPDATE_FILTER = 27,
     /**
      * 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.)
@@ -376,7 +466,7 @@ export declare enum ModCallbackCustom {
      * function postFirstEsauJr(player: EntityPlayer): void {}
      * ```
      */
-    POST_FIRST_ESAU_JR = 22,
+    POST_FIRST_ESAU_JR = 28,
     /**
      * 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
@@ -389,7 +479,7 @@ export declare enum ModCallbackCustom {
      * function postFirstFlip(newLazarus: EntityPlayer, oldLazarus: EntityPlayer): void {}
      * ```
      */
-    POST_FIRST_FLIP = 23,
+    POST_FIRST_FLIP = 29,
     /**
      * 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
@@ -402,7 +492,7 @@ export declare enum ModCallbackCustom {
      * function postFlip(newLazarus: EntityPlayer, oldLazarus: EntityPlayer): void {}
      * ```
      */
-    POST_FLIP = 24,
+    POST_FLIP = 30,
     /**
      * 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:
@@ -421,7 +511,7 @@ export declare enum ModCallbackCustom {
      * function postGameStartedReordered(isContinued: boolean): void {}
      * ```
      */
-    POST_GAME_STARTED_REORDERED = 25,
+    POST_GAME_STARTED_REORDERED = 31,
     /**
      * 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
@@ -440,7 +530,7 @@ export declare enum ModCallbackCustom {
      * function postGameStartedReorderedLast(isContinued: boolean): void {}
      * ```
      */
-    POST_GAME_STARTED_REORDERED_LAST = 26,
+    POST_GAME_STARTED_REORDERED_LAST = 32,
     /**
      * Fires from the `POST_UPDATE` callback when the Greed Mode wave increases.
      *
@@ -448,7 +538,7 @@ export declare enum ModCallbackCustom {
      * function postGreedModeWave(oldWave: int, newWave: int): void {}
      * ```
      */
-    POST_GREED_MODE_WAVE = 27,
+    POST_GREED_MODE_WAVE = 33,
     /**
      * 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
@@ -467,7 +557,7 @@ export declare enum ModCallbackCustom {
      * function postGridEntityBroken(gridEntity: GridEntity): void {}
      * ```
      */
-    POST_GRID_ENTITY_BROKEN = 28,
+    POST_GRID_ENTITY_BROKEN = 34,
     /**
      * 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
@@ -495,7 +585,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_GRID_ENTITY_COLLISION = 29,
+    POST_GRID_ENTITY_COLLISION = 35,
     /**
      * The same as the `POST_GRID_ENTITY_BROKEN` callback, but only fires for grid entities created
      * with the `spawnCustomGridEntity` helper function.
@@ -512,7 +602,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_GRID_ENTITY_CUSTOM_BROKEN = 30,
+    POST_GRID_ENTITY_CUSTOM_BROKEN = 36,
     /**
      * The same as the `POST_GRID_ENTITY_COLLISION` callback, but only fires for grid entities created
      * with the `spawnCustomGridEntity` helper function.
@@ -536,7 +626,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_GRID_ENTITY_CUSTOM_COLLISION = 31,
+    POST_GRID_ENTITY_CUSTOM_COLLISION = 37,
     /**
      * The same as the `POST_GRID_ENTITY_INIT` callback, but only fires for grid entities created with
      * the `spawnCustomGridEntity` helper function.
@@ -553,7 +643,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_GRID_ENTITY_CUSTOM_INIT = 32,
+    POST_GRID_ENTITY_CUSTOM_INIT = 38,
     /**
      * The same as the `POST_GRID_ENTITY_REMOVE` callback, but only fires for grid entities created
      * with the `spawnCustomGridEntity` helper function.
@@ -570,7 +660,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_GRID_ENTITY_CUSTOM_REMOVE = 33,
+    POST_GRID_ENTITY_CUSTOM_REMOVE = 39,
     /**
      * The same as the `POST_GRID_ENTITY_RENDER` callback, but only fires for grid entities created
      * with the `spawnCustomGridEntity` helper function.
@@ -587,7 +677,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_GRID_ENTITY_CUSTOM_RENDER = 34,
+    POST_GRID_ENTITY_CUSTOM_RENDER = 40,
     /**
      * The same as the `POST_GRID_ENTITY_STATE_CHANGED` callback, but only fires for grid entities
      * created with the `spawnCustomGridEntity` helper function.
@@ -606,7 +696,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_GRID_ENTITY_CUSTOM_STATE_CHANGED = 35,
+    POST_GRID_ENTITY_CUSTOM_STATE_CHANGED = 41,
     /**
      * The same as the `POST_GRID_ENTITY_UPDATE` callback, but only fires for grid entities created
      * with the `spawnCustomGridEntity` helper function.
@@ -623,7 +713,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_GRID_ENTITY_CUSTOM_UPDATE = 36,
+    POST_GRID_ENTITY_CUSTOM_UPDATE = 42,
     /**
      * Fires when a new grid entity is initialized. Specifically, this is either:
      *
@@ -645,7 +735,7 @@ export declare enum ModCallbackCustom {
      * function postGridEntityInit(gridEntity: GridEntity): void {}
      * ```
      */
-    POST_GRID_ENTITY_INIT = 37,
+    POST_GRID_ENTITY_INIT = 43,
     /**
      * 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).
@@ -670,7 +760,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_GRID_ENTITY_REMOVE = 38,
+    POST_GRID_ENTITY_REMOVE = 44,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a grid entity exists.
      *
@@ -687,7 +777,7 @@ export declare enum ModCallbackCustom {
      * function postGridEntityRender(gridEntity: GridEntity): void {}
      * ```
      */
-    POST_GRID_ENTITY_RENDER = 39,
+    POST_GRID_ENTITY_RENDER = 45,
     /**
      * Fires from the `POST_UPDATE` callback when a grid entity changes its state. (In this context,
      * "state" refers to the `GridEntity.State` field.)
@@ -709,7 +799,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_GRID_ENTITY_STATE_CHANGED = 40,
+    POST_GRID_ENTITY_STATE_CHANGED = 46,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a grid entity exists.
      *
@@ -726,7 +816,7 @@ export declare enum ModCallbackCustom {
      * function postGridEntityUpdate(gridEntity: GridEntity): void {}
      * ```
      */
-    POST_GRID_ENTITY_UPDATE = 41,
+    POST_GRID_ENTITY_UPDATE = 47,
     /**
      * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when the player loses a Holy Mantle
      * temporary collectible effect.
@@ -749,7 +839,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_HOLY_MANTLE_REMOVED = 42,
+    POST_HOLY_MANTLE_REMOVED = 48,
     /**
      * Fires from `POST_PEFFECT_UPDATE_REORDERED` callback when the player loses charge on their
      * active collectible item, implying that the item was just used.
@@ -772,7 +862,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_ITEM_DISCHARGE = 43,
+    POST_ITEM_DISCHARGE = 49,
     /**
      * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when an item is no longer queued (i.e.
      * when the animation of the player holding the item above their head is finished and the item is
@@ -793,7 +883,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_ITEM_PICKUP = 44,
+    POST_ITEM_PICKUP = 50,
     /**
      * Fires on the first `POST_RENDER` frame after a key on the keyboard has been pressed or
      * released. (In other words, the callback only fires when the "pressed" status is different than
@@ -809,7 +899,7 @@ export declare enum ModCallbackCustom {
      * function postKeyboardChanged(keyboard: Keyboard, pressed: boolean): void {}
      * ```
      */
-    POST_KEYBOARD_CHANGED = 45,
+    POST_KEYBOARD_CHANGED = 51,
     /**
      * Fires on the first `POST_KNIFE_UPDATE` frame for each knife.
      *
@@ -826,7 +916,7 @@ export declare enum ModCallbackCustom {
      * function postKnifeInitLate(knife: EntityKnife): void {}
      * ```
      */
-    POST_KNIFE_INIT_LATE = 46,
+    POST_KNIFE_INIT_LATE = 52,
     /**
      * Fires on the first `POST_LASER_UPDATE` frame for each laser.
      *
@@ -843,7 +933,7 @@ export declare enum ModCallbackCustom {
      * function postLaserInitLate(laser: EntityLaser): void {}
      * ```
      */
-    POST_LASER_INIT_LATE = 47,
+    POST_LASER_INIT_LATE = 53,
     /**
      * 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:
@@ -869,7 +959,7 @@ export declare enum ModCallbackCustom {
      * function postNewLevelReordered(stage: LevelStage, stageType: StageType): void {}
      * ```
      */
-    POST_NEW_LEVEL_REORDERED = 48,
+    POST_NEW_LEVEL_REORDERED = 54,
     /**
      * 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
@@ -886,7 +976,7 @@ export declare enum ModCallbackCustom {
      * function postNewRoomEarly(roomType: RoomType): void {}
      * ```
      */
-    POST_NEW_ROOM_EARLY = 49,
+    POST_NEW_ROOM_EARLY = 55,
     /**
      * 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:
@@ -909,7 +999,7 @@ export declare enum ModCallbackCustom {
      * function postNewRoomReordered(roomType: RoomType): void {}
      * ```
      */
-    POST_NEW_ROOM_REORDERED = 50,
+    POST_NEW_ROOM_REORDERED = 56,
     /**
      * The exact same thing as the vanilla `POST_NPC_DEATH` callback, except this callback allows you
      * to specify extra arguments for additional filtration.
@@ -926,7 +1016,7 @@ export declare enum ModCallbackCustom {
      * function postNPCDeathFilter(npc: EntityNPC): void {}
      * ```
      */
-    POST_NPC_DEATH_FILTER = 51,
+    POST_NPC_DEATH_FILTER = 57,
     /**
      * The exact same thing as the vanilla `POST_NPC_INIT` callback, except this callback allows you
      * to specify extra arguments for additional filtration.
@@ -943,7 +1033,7 @@ export declare enum ModCallbackCustom {
      * function postNPCInitFilter(npc: EntityNPC): void {}
      * ```
      */
-    POST_NPC_INIT_FILTER = 52,
+    POST_NPC_INIT_FILTER = 58,
     /**
      * Fires on the first `NPC_UPDATE` frame for each NPC.
      *
@@ -962,7 +1052,7 @@ export declare enum ModCallbackCustom {
      * function postNPCInitLate(npc: EntityNPC): void {}
      * ```
      */
-    POST_NPC_INIT_LATE = 53,
+    POST_NPC_INIT_LATE = 59,
     /**
      * The exact same thing as the vanilla `POST_NPC_RENDER` callback, except this callback allows you
      * to specify extra arguments for additional filtration.
@@ -979,7 +1069,7 @@ export declare enum ModCallbackCustom {
      * function postNPCRenderFilter(npc: EntityNPC, renderOffset: Vector): void {}
      * ```
      */
-    POST_NPC_RENDER_FILTER = 54,
+    POST_NPC_RENDER_FILTER = 60,
     /**
      * 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.)
@@ -1000,7 +1090,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_NPC_STATE_CHANGED = 55,
+    POST_NPC_STATE_CHANGED = 61,
     /**
      * The exact same thing as the vanilla `POST_NPC_UPDATE` callback, except this callback allows you
      * to specify extra arguments for additional filtration.
@@ -1017,7 +1107,7 @@ export declare enum ModCallbackCustom {
      * function postNPCUpdateFilter(npc: EntityNPC): void {}
      * ```
      */
-    POST_NPC_UPDATE_FILTER = 56,
+    POST_NPC_UPDATE_FILTER = 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
@@ -1042,7 +1132,7 @@ export declare enum ModCallbackCustom {
      * function postPEffectUpdateReordered(player: EntityPlayer): void {}
      * ```
      */
-    POST_PEFFECT_UPDATE_REORDERED = 57,
+    POST_PEFFECT_UPDATE_REORDERED = 63,
     /**
      * Fires from the `POST_PICKUP_UPDATE` callback when a pickup has a different variant or sub-type
      * than what it was on the previous frame.
@@ -1063,7 +1153,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PICKUP_CHANGED = 58,
+    POST_PICKUP_CHANGED = 64,
     /**
      * Fires on the first `POST_RENDER` frame that a pickup plays the "Collect" animation.
      *
@@ -1082,7 +1172,7 @@ export declare enum ModCallbackCustom {
      * function postPickupCollect(pickup: EntityPickup, player: EntityPlayer): void {}
      * ```
      */
-    POST_PICKUP_COLLECT = 59,
+    POST_PICKUP_COLLECT = 65,
     /**
      * The exact same thing as the vanilla `POST_PICKUP_INIT` callback, except this callback allows
      * you to specify extra arguments for additional filtration.
@@ -1097,7 +1187,7 @@ export declare enum ModCallbackCustom {
      * function postPickupInitFilter(pickup: EntityPickup): void {}
      * ```
      */
-    POST_PICKUP_INIT_FILTER = 60,
+    POST_PICKUP_INIT_FILTER = 66,
     /**
      * Fires from the `POST_PICKUP_INIT` callback on the first time that a player has seen the
      * respective pickup on the run.
@@ -1115,7 +1205,7 @@ export declare enum ModCallbackCustom {
      * function postPickupInitFirst(pickup: EntityPickup): void {}
      * ```
      */
-    POST_PICKUP_INIT_FIRST = 61,
+    POST_PICKUP_INIT_FIRST = 67,
     /**
      * Fires on the first `POST_PICKUP_UPDATE` frame for each pickup.
      *
@@ -1132,7 +1222,7 @@ export declare enum ModCallbackCustom {
      * function postPickupInitLate(pickup: EntityPickup): void {}
      * ```
      */
-    POST_PICKUP_INIT_LATE = 62,
+    POST_PICKUP_INIT_LATE = 68,
     /**
      * The exact same thing as the vanilla `POST_PICKUP_RENDER` callback, except this callback allows
      * you to specify extra arguments for additional filtration.
@@ -1147,7 +1237,7 @@ export declare enum ModCallbackCustom {
      * function postPickupRenderFilter(pickup: EntityPickup, renderOffset: Vector): void {}
      * ```
      */
-    POST_PICKUP_RENDER_FILTER = 63,
+    POST_PICKUP_RENDER_FILTER = 69,
     /**
      * The exact same thing as the vanilla `POST_PICKUP_SELECTION` callback, except this callback
      * allows you to specify extra arguments for additional filtration.
@@ -1166,7 +1256,7 @@ export declare enum ModCallbackCustom {
      * ): [PickupVariant, int] | undefined {}
      * ```
      */
-    POST_PICKUP_SELECTION_FILTER = 64,
+    POST_PICKUP_SELECTION_FILTER = 70,
     /**
      * 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.)
@@ -1185,7 +1275,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PICKUP_STATE_CHANGED = 65,
+    POST_PICKUP_STATE_CHANGED = 71,
     /**
      * The exact same thing as the vanilla `POST_PICKUP_UPDATE` callback, except this callback allows
      * you to specify extra arguments for additional filtration.
@@ -1200,7 +1290,7 @@ export declare enum ModCallbackCustom {
      * function postPickupUpdateFilter(pickup: EntityPickup): void {}
      * ```
      */
-    POST_PICKUP_UPDATE_FILTER = 66,
+    POST_PICKUP_UPDATE_FILTER = 72,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a pit exists.
      *
@@ -1212,7 +1302,7 @@ export declare enum ModCallbackCustom {
      * function postPitRender(pit: GridEntityPit): void {}
      * ```
      */
-    POST_PIT_RENDER = 67,
+    POST_PIT_RENDER = 73,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a pit exists.
      *
@@ -1224,7 +1314,7 @@ export declare enum ModCallbackCustom {
      * function postPitUpdate(pit: GridEntityPit): void {}
      * ```
      */
-    POST_PIT_UPDATE = 68,
+    POST_PIT_UPDATE = 74,
     /**
      * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when a player's health (i.e. hearts) is
      * different than what it was on the previous frame. For more information, see the `PlayerHealth`
@@ -1246,7 +1336,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PLAYER_CHANGE_HEALTH = 69,
+    POST_PLAYER_CHANGE_HEALTH = 75,
     /**
      * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when one of the player's stats change
      * from what they were on the previous frame.
@@ -1276,7 +1366,7 @@ export declare enum ModCallbackCustom {
      * ) => void {}
      * ```
      */
-    POST_PLAYER_CHANGE_STAT = 70,
+    POST_PLAYER_CHANGE_STAT = 76,
     /**
      * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when a player entity changes its player
      * type
@@ -1299,7 +1389,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PLAYER_CHANGE_TYPE = 71,
+    POST_PLAYER_CHANGE_TYPE = 77,
     /**
      * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when a player's collectible count is
      * higher than what it was on the previous frame, or when the active items change, or when the
@@ -1316,7 +1406,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PLAYER_COLLECTIBLE_ADDED = 72,
+    POST_PLAYER_COLLECTIBLE_ADDED = 78,
     /**
      * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when a player's collectible count is
      * lower than what it was on the previous frame, or when the active items change, or when the
@@ -1333,7 +1423,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PLAYER_COLLECTIBLE_REMOVED = 73,
+    POST_PLAYER_COLLECTIBLE_REMOVED = 79,
     /**
      * Fires from the `ENTITY_TAKE_DMG` callback when a player takes fatal damage. Return false to
      * prevent the fatal damage.
@@ -1351,7 +1441,7 @@ export declare enum ModCallbackCustom {
      * function postPlayerFatalDamage(player: EntityPlayer): boolean | undefined {}
      * ```
      */
-    POST_PLAYER_FATAL_DAMAGE = 74,
+    POST_PLAYER_FATAL_DAMAGE = 80,
     /**
      * Fires on the first `POST_PEFFECT_UPDATE_REORDERED` frame for each player, similar to the
      * `POST_PLAYER_INIT_LATE` callback, with two changes:
@@ -1373,7 +1463,7 @@ export declare enum ModCallbackCustom {
      * function postPlayerInitFirst(player: EntityPlayer): void {}
      * ```
      */
-    POST_PLAYER_INIT_FIRST = 75,
+    POST_PLAYER_INIT_FIRST = 81,
     /**
      * Fires on the first `POST_PEFFECT_UPDATE_REORDERED` frame for each player.
      *
@@ -1393,7 +1483,7 @@ export declare enum ModCallbackCustom {
      * function postPlayerInitLate(pickup: EntityPickup): void {}
      * ```
      */
-    POST_PLAYER_INIT_LATE = 76,
+    POST_PLAYER_INIT_LATE = 82,
     /**
      * 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).
@@ -1417,7 +1507,7 @@ export declare enum ModCallbackCustom {
      * function postPlayerRenderReordered(player: EntityPlayer, renderOffset: Vector): void {}
      * ```
      */
-    POST_PLAYER_RENDER_REORDERED = 77,
+    POST_PLAYER_RENDER_REORDERED = 83,
     /**
      * 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
@@ -1442,7 +1532,7 @@ export declare enum ModCallbackCustom {
      * function postPlayerUpdateReordered(player: EntityPlayer): void {}
      * ```
      */
-    POST_PLAYER_UPDATE_REORDERED = 78,
+    POST_PLAYER_UPDATE_REORDERED = 84,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a poop exists.
      *
@@ -1454,7 +1544,7 @@ export declare enum ModCallbackCustom {
      * function postPoopRender(poop: GridEntityPoop): void {}
      * ```
      */
-    POST_POOP_RENDER = 79,
+    POST_POOP_RENDER = 85,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a poop exists.
      *
@@ -1466,7 +1556,7 @@ export declare enum ModCallbackCustom {
      * function postPoopUpdate(poop: GridEntityPoop): void {}
      * ```
      */
-    POST_POOP_UPDATE = 80,
+    POST_POOP_UPDATE = 86,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a pressure plate exists.
      *
@@ -1478,7 +1568,7 @@ export declare enum ModCallbackCustom {
      * function postPressurePlateRender(pressurePlate: GridEntityPressurePlate): void {}
      * ```
      */
-    POST_PRESSURE_PLATE_RENDER = 81,
+    POST_PRESSURE_PLATE_RENDER = 87,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a pressure plate exists.
      *
@@ -1490,7 +1580,7 @@ export declare enum ModCallbackCustom {
      * function postPressurePlateUpdate(pressurePlate: GridEntityPressurePlate): void {}
      * ```
      */
-    POST_PRESSURE_PLATE_UPDATE = 82,
+    POST_PRESSURE_PLATE_UPDATE = 88,
     /**
      * Fires on the first `POST_PROJECTILE_UPDATE` frame for each projectile.
      *
@@ -1507,7 +1597,7 @@ export declare enum ModCallbackCustom {
      * function postProjectileInitLate(projectile: EntityProjectile): void {}
      * ```
      */
-    POST_PROJECTILE_INIT_LATE = 83,
+    POST_PROJECTILE_INIT_LATE = 89,
     /**
      * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when a player first picks up a new
      * item. The pickup returned in the callback is assumed to be the first pickup that no longer
@@ -1523,7 +1613,7 @@ export declare enum ModCallbackCustom {
      * function postPurchase(player: EntityPlayer, pickup: EntityPickup): void {}
      * ```
      */
-    POST_PURCHASE = 84,
+    POST_PURCHASE = 90,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a rock exists.
      *
@@ -1537,7 +1627,7 @@ export declare enum ModCallbackCustom {
      * function postRockRender(rock: GridEntityRock): void {}
      * ```
      */
-    POST_ROCK_RENDER = 85,
+    POST_ROCK_RENDER = 91,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a rock exists.
      *
@@ -1551,7 +1641,7 @@ export declare enum ModCallbackCustom {
      * function postRockUpdate(rock: GridEntityRock): void {}
      * ```
      */
-    POST_ROCK_UPDATE = 86,
+    POST_ROCK_UPDATE = 92,
     /**
      * Fires from the `POST_UPDATE` callback when the clear state of a room changes (as according to
      * the `Room.IsClear` method).
@@ -1568,7 +1658,7 @@ export declare enum ModCallbackCustom {
      * function postRoomClearChanged(roomClear: boolean): void {}
      * ```
      */
-    POST_ROOM_CLEAR_CHANGED = 87,
+    POST_ROOM_CLEAR_CHANGED = 93,
     /**
      * Fires from the `ENTITY_TAKE_DMG` callback when a player takes damage from spikes in a Sacrifice
      * Room.
@@ -1583,7 +1673,7 @@ export declare enum ModCallbackCustom {
      * function postSacrifice(player: EntityPlayer, numSacrifices: int): void {}
      * ```
      */
-    POST_SACRIFICE = 88,
+    POST_SACRIFICE = 94,
     /**
      * Fires from the `POST_RENDER` callback when a slot entity's animation changes.
      *
@@ -1601,7 +1691,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_SLOT_ANIMATION_CHANGED = 89,
+    POST_SLOT_ANIMATION_CHANGED = 95,
     /**
      * 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.)
@@ -1625,7 +1715,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_SLOT_COLLISION = 90,
+    POST_SLOT_COLLISION = 96,
     /**
      * Fires from the `POST_SLOT_UPDATE` or the `POST_ENTITY_REMOVE` callback when a slot machine is
      * destroyed or a beggar is removed.
@@ -1667,7 +1757,7 @@ export declare enum ModCallbackCustom {
      * function postSlotDestroyed(slot: Entity, slotDestructionType: SlotDestructionType): void {}
      * ```
      */
-    POST_SLOT_DESTROYED = 91,
+    POST_SLOT_DESTROYED = 97,
     /**
      * Fires when a new slot entity is initialized. Specifically, this is either:
      *
@@ -1686,7 +1776,7 @@ export declare enum ModCallbackCustom {
      * function postSlotInit(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_INIT = 92,
+    POST_SLOT_INIT = 98,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a slot entity exists.
      *
@@ -1700,7 +1790,7 @@ export declare enum ModCallbackCustom {
      * function postSlotRender(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_RENDER = 93,
+    POST_SLOT_RENDER = 99,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a slot entity exists.
      *
@@ -1714,7 +1804,7 @@ export declare enum ModCallbackCustom {
      * function postSlotUpdate(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_UPDATE = 94,
+    POST_SLOT_UPDATE = 100,
     /**
      * Fires from the `POST_RENDER` callback on every frame that spikes exist.
      *
@@ -1726,7 +1816,7 @@ export declare enum ModCallbackCustom {
      * function postSpikesRender(spikes: GridEntitySpikes): void {}
      * ```
      */
-    POST_SPIKES_RENDER = 95,
+    POST_SPIKES_RENDER = 101,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that spikes exist.
      *
@@ -1738,7 +1828,7 @@ export declare enum ModCallbackCustom {
      * function postSpikesUpdate(spikes: GridEntitySpikes): void {}
      * ```
      */
-    POST_SPIKES_UPDATE = 96,
+    POST_SPIKES_UPDATE = 102,
     /**
      * Fires on the first `POST_TEAR_UPDATE` frame for each tear (which is when
      * `EntityTear.FrameCount` is equal to 0).
@@ -1756,7 +1846,7 @@ export declare enum ModCallbackCustom {
      * function postTearInitLate(tear: EntityTear): void {}
      * ```
      */
-    POST_TEAR_INIT_LATE = 97,
+    POST_TEAR_INIT_LATE = 103,
     /**
      * Fires on the second `POST_TEAR_UPDATE` frame for each tear (which is when
      * `EntityTear.FrameCount` is equal to 1).
@@ -1773,7 +1863,7 @@ export declare enum ModCallbackCustom {
      * function postTearInitVeryLate(tear: EntityTear): void {}
      * ```
      */
-    POST_TEAR_INIT_VERY_LATE = 98,
+    POST_TEAR_INIT_VERY_LATE = 104,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a TNT exists.
      *
@@ -1785,7 +1875,7 @@ export declare enum ModCallbackCustom {
      * function postTNTRender(tnt: GridEntityTNT): void {}
      * ```
      */
-    POST_TNT_RENDER = 99,
+    POST_TNT_RENDER = 105,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a TNT exists.
      *
@@ -1797,7 +1887,7 @@ export declare enum ModCallbackCustom {
      * function postTNTUpdate(tnt: GridEntityTNT): void {}
      * ```
      */
-    POST_TNT_UPDATE = 100,
+    POST_TNT_UPDATE = 106,
     /**
      * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when a player gains or loses a new
      * transformation.
@@ -1816,7 +1906,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_TRANSFORMATION = 101,
+    POST_TRANSFORMATION = 107,
     /**
      * Fires from `ENTITY_TAKE_DMG` callback when a Wishbone or a Walnut breaks.
      *
@@ -1831,7 +1921,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_TRINKET_BREAK = 102,
+    POST_TRINKET_BREAK = 108,
     /**
      * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback on the frame before a Berserk effect
      * ends when the player is predicted to die (e.g. they currently have no health left or they took
@@ -1847,7 +1937,7 @@ export declare enum ModCallbackCustom {
      * function preBerserkDeath(player: EntityPlayer): void {}
      * ```
      */
-    PRE_BERSERK_DEATH = 103,
+    PRE_BERSERK_DEATH = 109,
     /**
      * 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
@@ -1866,7 +1956,7 @@ export declare enum ModCallbackCustom {
      * function preCustomRevive(player: EntityPlayer): int | undefined {}
      * ```
      */
-    PRE_CUSTOM_REVIVE = 104,
+    PRE_CUSTOM_REVIVE = 110,
     /**
      * The exact same thing as the vanilla `PRE_ENTITY_SPAWN` callback, except this callback allows
      * you to specify extra arguments for additional filtration.
@@ -1891,7 +1981,26 @@ export declare enum ModCallbackCustom {
      * ): [EntityType, int, int, int] | undefined {}
      * ```
      */
-    PRE_ENTITY_SPAWN_FILTER = 105,
+    PRE_ENTITY_SPAWN_FILTER = 111,
+    /**
+     * The exact same thing as the vanilla `PRE_FAMILIAR_COLLISION` callback, except this callback
+     * allows you to specify extra arguments for additional filtration.
+     *
+     * When registering the callback with the `ModUpgraded.AddCallbackCustom` method:
+     * - You can provide an optional third argument that will make the callback only fire if it
+     *   matches the `FamiliarVariant` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the sub-type provided.
+     *
+     * ```ts
+     * function preFamiliarCollisionFilter(
+     *   familiar: EntityFamiliar,
+     *   collider: Entity,
+     *   low: boolean,
+     * ): void {}
+     * ```
+     */
+    PRE_FAMILIAR_COLLISION_FILTER = 112,
     /**
      * Fires from the `PRE_PICKUP_COLLISION` callback when a player touches a collectible pedestal and
      * meets all of the conditions to pick it up.
@@ -1911,7 +2020,7 @@ export declare enum ModCallbackCustom {
      * function preGetPedestal(player: EntityPlayer, collectible: EntityPickupCollectible): void {}
      * ```
      */
-    PRE_GET_PEDESTAL = 106,
+    PRE_GET_PEDESTAL = 113,
     /**
      * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when an item becomes queued (i.e. when
      * the player begins to hold the item above their head).
@@ -1931,7 +2040,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    PRE_ITEM_PICKUP = 107,
+    PRE_ITEM_PICKUP = 114,
     /**
      * 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
@@ -1945,7 +2054,7 @@ export declare enum ModCallbackCustom {
      * function preNewLevel(player: EntityPlayer): void {}
      * ```
      */
-    PRE_NEW_LEVEL = 108,
+    PRE_NEW_LEVEL = 115,
     /**
      * The exact same thing as the vanilla `PRE_NPC_COLLISION` callback, except this callback allows
      * you to specify extra arguments for additional filtration.
@@ -1966,7 +2075,7 @@ export declare enum ModCallbackCustom {
      * ): boolean | undefined {}
      * ```
      */
-    PRE_NPC_COLLISION_FILTER = 109,
+    PRE_NPC_COLLISION_FILTER = 116,
     /**
      * The exact same thing as the vanilla `PRE_NPC_UPDATE` callback, except this callback allows you
      * to specify extra arguments for additional filtration.
@@ -1983,7 +2092,7 @@ export declare enum ModCallbackCustom {
      * function preNPCUpdateFilter(entity: Entity): boolean | undefined {}
      * ```
      */
-    PRE_NPC_UPDATE_FILTER = 110,
+    PRE_NPC_UPDATE_FILTER = 117,
     /**
      * The exact same thing as the vanilla `PRE_ROOM_ENTITY_SPAWN` callback, except this callback
      * allows you to specify extra arguments for additional filtration.
@@ -2006,6 +2115,6 @@ export declare enum ModCallbackCustom {
      * ): [EntityType | GridEntityXMLType, int, int] | undefined {}
      * ```
      */
-    PRE_ROOM_ENTITY_SPAWN_FILTER = 111
+    PRE_ROOM_ENTITY_SPAWN_FILTER = 118
 }
 //# sourceMappingURL=ModCallbackCustom.d.ts.map