isaacscript-common 19.0.2 → 19.1.1

package/dist/index.d.ts

@@ -338,6 +338,11 @@ declare interface AddCallbackParametersCustom {
     pickupVariant?: PickupVariant,
     subType?: int
     ];
+    [ModCallbackCustom.POST_PICKUP_INIT_FILTER]: [
+    callback: (pickup: EntityPickup) => void,
+    pickupVariant?: PickupVariant,
+    subType?: int
+    ];
     [ModCallbackCustom.POST_PICKUP_INIT_FIRST]: [
     callback: (pickup: EntityPickup) => void,
     pickupVariant?: PickupVariant,
@@ -348,11 +353,26 @@ declare interface AddCallbackParametersCustom {
     pickupVariant?: PickupVariant,
     subType?: int
     ];
+    [ModCallbackCustom.POST_PICKUP_RENDER_FILTER]: [
+    callback: (pickup: EntityPickup, renderOffset: Vector) => void,
+    pickupVariant?: PickupVariant,
+    subType?: int
+    ];
+    [ModCallbackCustom.POST_PICKUP_SELECTION_FILTER]: [
+    callback: (pickup: EntityPickup, variant: PickupVariant, subType: int) => [PickupVariant, int] | undefined,
+    pickupVariant?: PickupVariant,
+    subType?: int
+    ];
     [ModCallbackCustom.POST_PICKUP_STATE_CHANGED]: [
     callback: (pickup: EntityPickup, previousState: int, currentState: int) => void,
     pickupVariant?: PickupVariant,
     subType?: int
     ];
+    [ModCallbackCustom.POST_PICKUP_UPDATE_FILTER]: [
+    callback: (pickup: EntityPickup) => void,
+    pickupVariant?: PickupVariant,
+    subType?: int
+    ];
     [ModCallbackCustom.POST_PIT_RENDER]: [
     callback: (pit: GridEntityPit) => void,
     pitVariant?: PitVariant
@@ -9605,6 +9625,21 @@ export declare enum ModCallbackCustom {
      * ```
      */
     POST_PICKUP_COLLECT = 56,
+    /**
+     * The exact same thing as the vanilla `POST_PICKUP_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 `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 postPickupInitFilter(pickup: EntityPickup): void {}
+     * ```
+     */
+    POST_PICKUP_INIT_FILTER = 57,
     /**
      * Fires from the `POST_PICKUP_INIT` callback on the first time that a player has seen the
      * respective pickup on the run.
@@ -9622,7 +9657,7 @@ export declare enum ModCallbackCustom {
      * function postPickupInitFirst(pickup: EntityPickup): void {}
      * ```
      */
-    POST_PICKUP_INIT_FIRST = 57,
+    POST_PICKUP_INIT_FIRST = 58,
     /**
      * Fires on the first `POST_PICKUP_UPDATE` frame for each pickup.
      *
@@ -9639,7 +9674,41 @@ export declare enum ModCallbackCustom {
      * function postPickupInitLate(pickup: EntityPickup): void {}
      * ```
      */
-    POST_PICKUP_INIT_LATE = 58,
+    POST_PICKUP_INIT_LATE = 59,
+    /**
+     * The exact same thing as the vanilla `POST_PICKUP_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 `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 postPickupRenderFilter(pickup: EntityPickup, renderOffset: Vector): void {}
+     * ```
+     */
+    POST_PICKUP_RENDER_FILTER = 60,
+    /**
+     * The exact same thing as the vanilla `POST_PICKUP_SELECTION` 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 `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 postPickupSelectionFilter(
+     *   pickup: EntityPickup,
+     *   variant: PickupVariant,
+     *   subType: int,
+     * ): [PickupVariant, int] | undefined {}
+     * ```
+     */
+    POST_PICKUP_SELECTION_FILTER = 61,
     /**
      * 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.)
@@ -9658,7 +9727,22 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PICKUP_STATE_CHANGED = 59,
+    POST_PICKUP_STATE_CHANGED = 62,
+    /**
+     * The exact same thing as the vanilla `POST_PICKUP_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 `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 postPickupUpdateFilter(pickup: EntityPickup): void {}
+     * ```
+     */
+    POST_PICKUP_UPDATE_FILTER = 63,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a pit exists.
      *
@@ -9670,7 +9754,7 @@ export declare enum ModCallbackCustom {
      * function postPitRender(pit: GridEntityPit): void {}
      * ```
      */
-    POST_PIT_RENDER = 60,
+    POST_PIT_RENDER = 64,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a pit exists.
      *
@@ -9682,7 +9766,7 @@ export declare enum ModCallbackCustom {
      * function postPitUpdate(pit: GridEntityPit): void {}
      * ```
      */
-    POST_PIT_UPDATE = 61,
+    POST_PIT_UPDATE = 65,
     /**
      * 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`
@@ -9704,7 +9788,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PLAYER_CHANGE_HEALTH = 62,
+    POST_PLAYER_CHANGE_HEALTH = 66,
     /**
      * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when one of the player's stats change
      * from what they were on the previous frame.
@@ -9734,7 +9818,7 @@ export declare enum ModCallbackCustom {
      * ) => void {}
      * ```
      */
-    POST_PLAYER_CHANGE_STAT = 63,
+    POST_PLAYER_CHANGE_STAT = 67,
     /**
      * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when a player entity changes its player
      * type
@@ -9757,7 +9841,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PLAYER_CHANGE_TYPE = 64,
+    POST_PLAYER_CHANGE_TYPE = 68,
     /**
      * 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
@@ -9774,7 +9858,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PLAYER_COLLECTIBLE_ADDED = 65,
+    POST_PLAYER_COLLECTIBLE_ADDED = 69,
     /**
      * 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
@@ -9791,7 +9875,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PLAYER_COLLECTIBLE_REMOVED = 66,
+    POST_PLAYER_COLLECTIBLE_REMOVED = 70,
     /**
      * Fires from the `ENTITY_TAKE_DMG` callback when a player takes fatal damage. Return false to
      * prevent the fatal damage.
@@ -9809,7 +9893,7 @@ export declare enum ModCallbackCustom {
      * function postPlayerFatalDamage(player: EntityPlayer): boolean | undefined {}
      * ```
      */
-    POST_PLAYER_FATAL_DAMAGE = 67,
+    POST_PLAYER_FATAL_DAMAGE = 71,
     /**
      * Fires on the first `POST_PEFFECT_UPDATE_REORDERED` frame for each player, similar to the
      * `POST_PLAYER_INIT_LATE` callback, with two changes:
@@ -9831,7 +9915,7 @@ export declare enum ModCallbackCustom {
      * function postPlayerInitFirst(player: EntityPlayer): void {}
      * ```
      */
-    POST_PLAYER_INIT_FIRST = 68,
+    POST_PLAYER_INIT_FIRST = 72,
     /**
      * Fires on the first `POST_PEFFECT_UPDATE_REORDERED` frame for each player.
      *
@@ -9851,7 +9935,7 @@ export declare enum ModCallbackCustom {
      * function postPlayerInitLate(pickup: EntityPickup): void {}
      * ```
      */
-    POST_PLAYER_INIT_LATE = 69,
+    POST_PLAYER_INIT_LATE = 73,
     /**
      * 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).
@@ -9875,7 +9959,7 @@ export declare enum ModCallbackCustom {
      * function postPlayerRenderReordered(player: EntityPlayer): void {}
      * ```
      */
-    POST_PLAYER_RENDER_REORDERED = 70,
+    POST_PLAYER_RENDER_REORDERED = 74,
     /**
      * 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
@@ -9900,7 +9984,7 @@ export declare enum ModCallbackCustom {
      * function postPlayerUpdateReordered(player: EntityPlayer): void {}
      * ```
      */
-    POST_PLAYER_UPDATE_REORDERED = 71,
+    POST_PLAYER_UPDATE_REORDERED = 75,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a poop exists.
      *
@@ -9912,7 +9996,7 @@ export declare enum ModCallbackCustom {
      * function postPoopRender(poop: GridEntityPoop): void {}
      * ```
      */
-    POST_POOP_RENDER = 72,
+    POST_POOP_RENDER = 76,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a poop exists.
      *
@@ -9924,7 +10008,7 @@ export declare enum ModCallbackCustom {
      * function postPoopUpdate(poop: GridEntityPoop): void {}
      * ```
      */
-    POST_POOP_UPDATE = 73,
+    POST_POOP_UPDATE = 77,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a pressure plate exists.
      *
@@ -9936,7 +10020,7 @@ export declare enum ModCallbackCustom {
      * function postPressurePlateRender(pressurePlate: GridEntityPressurePlate): void {}
      * ```
      */
-    POST_PRESSURE_PLATE_RENDER = 74,
+    POST_PRESSURE_PLATE_RENDER = 78,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a pressure plate exists.
      *
@@ -9948,7 +10032,7 @@ export declare enum ModCallbackCustom {
      * function postPressurePlateUpdate(pressurePlate: GridEntityPressurePlate): void {}
      * ```
      */
-    POST_PRESSURE_PLATE_UPDATE = 75,
+    POST_PRESSURE_PLATE_UPDATE = 79,
     /**
      * Fires on the first `POST_PROJECTILE_UPDATE` frame for each projectile.
      *
@@ -9965,7 +10049,7 @@ export declare enum ModCallbackCustom {
      * function postProjectileInitLate(projectile: EntityProjectile): void {}
      * ```
      */
-    POST_PROJECTILE_INIT_LATE = 76,
+    POST_PROJECTILE_INIT_LATE = 80,
     /**
      * 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
@@ -9981,7 +10065,7 @@ export declare enum ModCallbackCustom {
      * function postPurchase(player: EntityPlayer, pickup: EntityPickup): void {}
      * ```
      */
-    POST_PURCHASE = 77,
+    POST_PURCHASE = 81,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a rock exists.
      *
@@ -9995,7 +10079,7 @@ export declare enum ModCallbackCustom {
      * function postRockRender(rock: GridEntityRock): void {}
      * ```
      */
-    POST_ROCK_RENDER = 78,
+    POST_ROCK_RENDER = 82,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a rock exists.
      *
@@ -10009,7 +10093,7 @@ export declare enum ModCallbackCustom {
      * function postRockUpdate(rock: GridEntityRock): void {}
      * ```
      */
-    POST_ROCK_UPDATE = 79,
+    POST_ROCK_UPDATE = 83,
     /**
      * Fires from the `POST_UPDATE` callback when the clear state of a room changes (as according to
      * the `Room.IsClear` method).
@@ -10026,7 +10110,7 @@ export declare enum ModCallbackCustom {
      * function postRoomClearChanged(roomClear: boolean): void {}
      * ```
      */
-    POST_ROOM_CLEAR_CHANGED = 80,
+    POST_ROOM_CLEAR_CHANGED = 84,
     /**
      * Fires from the `ENTITY_TAKE_DMG` callback when a player takes damage from spikes in a Sacrifice
      * Room.
@@ -10041,7 +10125,7 @@ export declare enum ModCallbackCustom {
      * function postSacrifice(player: EntityPlayer, numSacrifices: int): void {}
      * ```
      */
-    POST_SACRIFICE = 81,
+    POST_SACRIFICE = 85,
     /**
      * Fires from the `POST_RENDER` callback when a slot entity's animation changes.
      *
@@ -10055,7 +10139,7 @@ export declare enum ModCallbackCustom {
      * function postSlotAnimationChanged(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_ANIMATION_CHANGED = 82,
+    POST_SLOT_ANIMATION_CHANGED = 86,
     /**
      * 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.)
@@ -10079,7 +10163,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_SLOT_COLLISION = 83,
+    POST_SLOT_COLLISION = 87,
     /**
      * Fires from the `POST_RENDER` callback when a slot plays the animation that indicates that it
      * has broken.
@@ -10094,7 +10178,7 @@ export declare enum ModCallbackCustom {
      * function postSlotDestroyed(slot: Entity, slotDestructionType: SlotDestructionType): void {}
      * ```
      */
-    POST_SLOT_DESTROYED = 84,
+    POST_SLOT_DESTROYED = 88,
     /**
      * Fires when a new slot entity is initialized. Specifically, this is either:
      *
@@ -10113,7 +10197,7 @@ export declare enum ModCallbackCustom {
      * function postSlotInit(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_INIT = 85,
+    POST_SLOT_INIT = 89,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a slot entity exists.
      *
@@ -10127,7 +10211,7 @@ export declare enum ModCallbackCustom {
      * function postSlotRender(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_RENDER = 86,
+    POST_SLOT_RENDER = 90,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a slot entity exists.
      *
@@ -10141,7 +10225,7 @@ export declare enum ModCallbackCustom {
      * function postSlotUpdate(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_UPDATE = 87,
+    POST_SLOT_UPDATE = 91,
     /**
      * Fires from the `POST_RENDER` callback on every frame that spikes exist.
      *
@@ -10153,7 +10237,7 @@ export declare enum ModCallbackCustom {
      * function postSpikesRender(spikes: GridEntitySpikes): void {}
      * ```
      */
-    POST_SPIKES_RENDER = 88,
+    POST_SPIKES_RENDER = 92,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that spikes exist.
      *
@@ -10165,7 +10249,7 @@ export declare enum ModCallbackCustom {
      * function postSpikesUpdate(spikes: GridEntitySpikes): void {}
      * ```
      */
-    POST_SPIKES_UPDATE = 89,
+    POST_SPIKES_UPDATE = 93,
     /**
      * Fires on the first `POST_TEAR_UPDATE` frame for each tear (which is when
      * `EntityTear.FrameCount` is equal to 0).
@@ -10183,7 +10267,7 @@ export declare enum ModCallbackCustom {
      * function postTearInitLate(tear: EntityTear): void {}
      * ```
      */
-    POST_TEAR_INIT_LATE = 90,
+    POST_TEAR_INIT_LATE = 94,
     /**
      * Fires on the second `POST_TEAR_UPDATE` frame for each tear (which is when
      * `EntityTear.FrameCount` is equal to 1).
@@ -10200,7 +10284,7 @@ export declare enum ModCallbackCustom {
      * function postTearInitVeryLate(tear: EntityTear): void {}
      * ```
      */
-    POST_TEAR_INIT_VERY_LATE = 91,
+    POST_TEAR_INIT_VERY_LATE = 95,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a TNT exists.
      *
@@ -10212,7 +10296,7 @@ export declare enum ModCallbackCustom {
      * function postTNTRender(tnt: GridEntityTNT): void {}
      * ```
      */
-    POST_TNT_RENDER = 92,
+    POST_TNT_RENDER = 96,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a TNT exists.
      *
@@ -10224,7 +10308,7 @@ export declare enum ModCallbackCustom {
      * function postTNTUpdate(tnt: GridEntityTNT): void {}
      * ```
      */
-    POST_TNT_UPDATE = 93,
+    POST_TNT_UPDATE = 97,
     /**
      * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when a player gains or loses a new
      * transformation.
@@ -10243,7 +10327,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_TRANSFORMATION = 94,
+    POST_TRANSFORMATION = 98,
     /**
      * Fires from `ENTITY_TAKE_DMG` callback when a Wishbone or a Walnut breaks.
      *
@@ -10258,7 +10342,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_TRINKET_BREAK = 95,
+    POST_TRINKET_BREAK = 99,
     /**
      * 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
@@ -10274,7 +10358,7 @@ export declare enum ModCallbackCustom {
      * function preBerserkDeath(player: EntityPlayer): void {}
      * ```
      */
-    PRE_BERSERK_DEATH = 96,
+    PRE_BERSERK_DEATH = 100,
     /**
      * 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
@@ -10293,7 +10377,7 @@ export declare enum ModCallbackCustom {
      * function preCustomRevive(player: EntityPlayer): int | undefined {}
      * ```
      */
-    PRE_CUSTOM_REVIVE = 97,
+    PRE_CUSTOM_REVIVE = 101,
     /**
      * Fires from the `PRE_PICKUP_COLLISION` callback when a player touches a collectible pedestal and
      * meets all of the conditions to pick it up.
@@ -10313,7 +10397,7 @@ export declare enum ModCallbackCustom {
      * function preGetPedestal(player: EntityPlayer, collectible: EntityPickupCollectible): void {}
      * ```
      */
-    PRE_GET_PEDESTAL = 98,
+    PRE_GET_PEDESTAL = 102,
     /**
      * 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).
@@ -10333,7 +10417,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    PRE_ITEM_PICKUP = 99,
+    PRE_ITEM_PICKUP = 103,
     /**
      * 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
@@ -10347,7 +10431,7 @@ export declare enum ModCallbackCustom {
      * function preNewLevel(player: EntityPlayer): void {}
      * ```
      */
-    PRE_NEW_LEVEL = 100,
+    PRE_NEW_LEVEL = 104,
     /**
      * The exact same thing as the vanilla `PRE_NPC_COLLISION` callback, except this callback allows
      * you to specify extra arguments for additional filtration.
@@ -10368,7 +10452,7 @@ export declare enum ModCallbackCustom {
      * ): boolean | undefined {}
      * ```
      */
-    PRE_NPC_COLLISION_FILTER = 101,
+    PRE_NPC_COLLISION_FILTER = 105,
     /**
      * The exact same thing as the vanilla `PRE_NPC_UPDATE` callback, except this callback allows you
      * to specify extra arguments for additional filtration.
@@ -10385,7 +10469,7 @@ export declare enum ModCallbackCustom {
      * function preNPCUpdateFilter(entity: Entity): boolean | undefined {}
      * ```
      */
-    PRE_NPC_UPDATE_FILTER = 102
+    PRE_NPC_UPDATE_FILTER = 106
 }
 
 /**
@@ -11367,8 +11451,10 @@ export declare const MOVEMENT_ACTIONS_SET: ReadonlySet<ButtonAction>;
  * If there is more than one player, they will be distributed around the center in a circle.
  *
  * This function emulates what happens in the vanilla game when you travel to a new floor.
+ *
+ * @param radius Optional. The radius of the circle. Default is 10.
  */
-export declare function movePlayersToCenter(): void;
+export declare function movePlayersToCenter(radius?: float): void;
 
 /**
  * A cached version of the class returned from the `MusicManager()` constructor.