isaacscript-common 29.6.2 → 29.8.0

package/dist/index.rollup.d.ts

@@ -555,7 +555,13 @@ declare interface AddCallbackParametersCustom {
     ];
     [ModCallbackCustom.POST_PROJECTILE_INIT_LATE]: [
     callback: (projectile: EntityProjectile) => void,
-    projectileVariant?: ProjectileVariant
+    projectileVariant?: ProjectileVariant,
+    subType?: int
+    ];
+    [ModCallbackCustom.POST_PROJECTILE_KILL]: [
+    callback: (projectile: EntityProjectile) => void,
+    projectileVariant?: ProjectileVariant,
+    subType?: number
     ];
     [ModCallbackCustom.POST_PROJECTILE_UPDATE_FILTER]: [
     callback: (projectile: EntityProjectile) => void,
@@ -644,6 +650,11 @@ declare interface AddCallbackParametersCustom {
     tearVariant?: TearVariant,
     subType?: int
     ];
+    [ModCallbackCustom.POST_TEAR_KILL]: [
+    callback: (tear: EntityTear) => void,
+    tearVariant?: TearVariant,
+    subType?: int
+    ];
     [ModCallbackCustom.POST_TEAR_RENDER_FILTER]: [
     callback: (tear: EntityTear, renderOffset: Vector) => void,
     tearVariant?: TearVariant,
@@ -6904,6 +6915,13 @@ export declare function getTSTLClassName(object: unknown): string | undefined;
  */
 export declare function getUnusedDoorSlots(): DoorSlot[];
 
+/**
+ * Helper function to find the active slots that the player has the corresponding collectible type
+ * in and have enough charge to be used. Returns an empty array if the player does not have the
+ * collectible in any active slot or does not have enough charges.
+ */
+export declare function getUsableActiveItemSlots(player: EntityPlayer, collectibleType: CollectibleType): ActiveSlot[];
+
 /**
  * Helper function to get an array with every valid vanilla card sub-type.
  *
@@ -10978,6 +10996,20 @@ export declare enum ModCallbackCustom {
      * ```
      */
     POST_PROJECTILE_INIT_LATE = 99,
+    /**
+     * Fires when the provided projectile is removed after colliding with an entity or grid entity.
+     *
+     * 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 `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 postProjectileKill(projectile: EntityProjectile): void {}
+     * ```
+     */
+    POST_PROJECTILE_KILL = 100,
     /**
      * The exact same thing as the vanilla `POST_PROJECTILE_RENDER` callback, except this callback
      * allows you to specify extra arguments for additional filtration.
@@ -10992,7 +11024,7 @@ export declare enum ModCallbackCustom {
      * function postProjectileRenderFilter(projectile: EntityProjectile, renderOffset: Vector): void {}
      * ```
      */
-    POST_PROJECTILE_RENDER_FILTER = 100,
+    POST_PROJECTILE_RENDER_FILTER = 101,
     /**
      * The exact same thing as the vanilla `POST_PROJECTILE_INIT` callback, except this callback
      * allows you to specify extra arguments for additional filtration.
@@ -11007,7 +11039,7 @@ export declare enum ModCallbackCustom {
      * function postProjectileUpdateFilter(projectile: EntityProjectile): void {}
      * ```
      */
-    POST_PROJECTILE_UPDATE_FILTER = 101,
+    POST_PROJECTILE_UPDATE_FILTER = 102,
     /**
      * 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
@@ -11023,7 +11055,7 @@ export declare enum ModCallbackCustom {
      * function postPurchase(player: EntityPlayer, pickup: EntityPickup): void {}
      * ```
      */
-    POST_PURCHASE = 102,
+    POST_PURCHASE = 103,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a rock exists.
      *
@@ -11037,7 +11069,7 @@ export declare enum ModCallbackCustom {
      * function postRockRender(rock: GridEntityRock): void {}
      * ```
      */
-    POST_ROCK_RENDER = 103,
+    POST_ROCK_RENDER = 104,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a rock exists.
      *
@@ -11051,7 +11083,7 @@ export declare enum ModCallbackCustom {
      * function postRockUpdate(rock: GridEntityRock): void {}
      * ```
      */
-    POST_ROCK_UPDATE = 104,
+    POST_ROCK_UPDATE = 105,
     /**
      * Fires from the `POST_UPDATE` callback when the clear state of a room changes (as according to
      * the `Room.IsClear` method).
@@ -11068,7 +11100,7 @@ export declare enum ModCallbackCustom {
      * function postRoomClearChanged(roomClear: boolean): void {}
      * ```
      */
-    POST_ROOM_CLEAR_CHANGED = 105,
+    POST_ROOM_CLEAR_CHANGED = 106,
     /**
      * Fires from the `ENTITY_TAKE_DMG` callback when a player takes damage from spikes in a Sacrifice
      * Room.
@@ -11083,7 +11115,7 @@ export declare enum ModCallbackCustom {
      * function postSacrifice(player: EntityPlayer, numSacrifices: int): void {}
      * ```
      */
-    POST_SACRIFICE = 106,
+    POST_SACRIFICE = 107,
     /**
      * Fires from the `POST_RENDER` callback when a slot entity's animation changes.
      *
@@ -11101,7 +11133,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_SLOT_ANIMATION_CHANGED = 107,
+    POST_SLOT_ANIMATION_CHANGED = 108,
     /**
      * 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.)
@@ -11125,7 +11157,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_SLOT_COLLISION = 108,
+    POST_SLOT_COLLISION = 109,
     /**
      * Fires from the `POST_SLOT_UPDATE` or the `POST_ENTITY_REMOVE` callback when a slot machine is
      * destroyed or a beggar is removed.
@@ -11167,7 +11199,7 @@ export declare enum ModCallbackCustom {
      * function postSlotDestroyed(slot: Entity, slotDestructionType: SlotDestructionType): void {}
      * ```
      */
-    POST_SLOT_DESTROYED = 109,
+    POST_SLOT_DESTROYED = 110,
     /**
      * Fires when a new slot entity is initialized. Specifically, this is either:
      *
@@ -11186,7 +11218,7 @@ export declare enum ModCallbackCustom {
      * function postSlotInit(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_INIT = 110,
+    POST_SLOT_INIT = 111,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a slot entity exists.
      *
@@ -11200,7 +11232,7 @@ export declare enum ModCallbackCustom {
      * function postSlotRender(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_RENDER = 111,
+    POST_SLOT_RENDER = 112,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a slot entity exists.
      *
@@ -11214,7 +11246,7 @@ export declare enum ModCallbackCustom {
      * function postSlotUpdate(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_UPDATE = 112,
+    POST_SLOT_UPDATE = 113,
     /**
      * Fires from the `POST_RENDER` callback on every frame that spikes exist.
      *
@@ -11226,7 +11258,7 @@ export declare enum ModCallbackCustom {
      * function postSpikesRender(spikes: GridEntitySpikes): void {}
      * ```
      */
-    POST_SPIKES_RENDER = 113,
+    POST_SPIKES_RENDER = 114,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that spikes exist.
      *
@@ -11238,7 +11270,7 @@ export declare enum ModCallbackCustom {
      * function postSpikesUpdate(spikes: GridEntitySpikes): void {}
      * ```
      */
-    POST_SPIKES_UPDATE = 114,
+    POST_SPIKES_UPDATE = 115,
     /**
      * The exact same thing as the vanilla `POST_TEAR_INIT` callback, except this callback allows you
      * to specify extra arguments for additional filtration.
@@ -11253,7 +11285,7 @@ export declare enum ModCallbackCustom {
      * function postTearInitFilter(tear: EntityTear): void {}
      * ```
      */
-    POST_TEAR_INIT_FILTER = 115,
+    POST_TEAR_INIT_FILTER = 116,
     /**
      * Fires on the first `POST_TEAR_UPDATE` frame for each tear (which is when
      * `EntityTear.FrameCount` is equal to 0).
@@ -11271,7 +11303,7 @@ export declare enum ModCallbackCustom {
      * function postTearInitLate(tear: EntityTear): void {}
      * ```
      */
-    POST_TEAR_INIT_LATE = 116,
+    POST_TEAR_INIT_LATE = 117,
     /**
      * Fires on the second `POST_TEAR_UPDATE` frame for each tear (which is when
      * `EntityTear.FrameCount` is equal to 1).
@@ -11288,7 +11320,21 @@ export declare enum ModCallbackCustom {
      * function postTearInitVeryLate(tear: EntityTear): void {}
      * ```
      */
-    POST_TEAR_INIT_VERY_LATE = 117,
+    POST_TEAR_INIT_VERY_LATE = 118,
+    /**
+     * Fires when the provided tear is removed after colliding with an entity or grid entity.
+     *
+     * 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 postTearKill(tear: EntityTear): void {}
+     * ```
+     */
+    POST_TEAR_KILL = 119,
     /**
      * The exact same thing as the vanilla `POST_TEAR_RENDER` callback, except this callback allows
      * you to specify extra arguments for additional filtration.
@@ -11303,7 +11349,7 @@ export declare enum ModCallbackCustom {
      * function postTearRenderFilter(tear: EntityTear, renderOffset: Vector): void {}
      * ```
      */
-    POST_TEAR_RENDER_FILTER = 118,
+    POST_TEAR_RENDER_FILTER = 120,
     /**
      * The exact same thing as the vanilla `POST_TEAR_INIT` callback, except this callback allows you
      * to specify extra arguments for additional filtration.
@@ -11318,7 +11364,7 @@ export declare enum ModCallbackCustom {
      * function postTearUpdateFilter(tear: EntityTear): void {}
      * ```
      */
-    POST_TEAR_UPDATE_FILTER = 119,
+    POST_TEAR_UPDATE_FILTER = 121,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a TNT exists.
      *
@@ -11330,7 +11376,7 @@ export declare enum ModCallbackCustom {
      * function postTNTRender(tnt: GridEntityTNT): void {}
      * ```
      */
-    POST_TNT_RENDER = 120,
+    POST_TNT_RENDER = 122,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a TNT exists.
      *
@@ -11342,7 +11388,7 @@ export declare enum ModCallbackCustom {
      * function postTNTUpdate(tnt: GridEntityTNT): void {}
      * ```
      */
-    POST_TNT_UPDATE = 121,
+    POST_TNT_UPDATE = 123,
     /**
      * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when a player gains or loses a new
      * transformation.
@@ -11361,7 +11407,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_TRANSFORMATION = 122,
+    POST_TRANSFORMATION = 124,
     /**
      * Fires from `ENTITY_TAKE_DMG` callback when a Wishbone or a Walnut breaks.
      *
@@ -11376,7 +11422,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_TRINKET_BREAK = 123,
+    POST_TRINKET_BREAK = 125,
     /**
      * The same thing as the vanilla `POST_USE_PILL` callback, except this callback passes the
      * `PillColor` of the used pill as the final argument. It allows you to filter by the `PillColor`.
@@ -11399,7 +11445,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_USE_PILL_FILTER = 124,
+    POST_USE_PILL_FILTER = 126,
     /**
      * 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
@@ -11415,7 +11461,7 @@ export declare enum ModCallbackCustom {
      * function preBerserkDeath(player: EntityPlayer): void {}
      * ```
      */
-    PRE_BERSERK_DEATH = 125,
+    PRE_BERSERK_DEATH = 127,
     /**
      * The exact same thing as the vanilla `PRE_BOMB_COLLISION` callback, except this callback allows
      * you to specify extra arguments for additional filtration.
@@ -11434,7 +11480,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    PRE_BOMB_COLLISION_FILTER = 126,
+    PRE_BOMB_COLLISION_FILTER = 128,
     /**
      * 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
@@ -11453,7 +11499,7 @@ export declare enum ModCallbackCustom {
      * function preCustomRevive(player: EntityPlayer): int | undefined {}
      * ```
      */
-    PRE_CUSTOM_REVIVE = 127,
+    PRE_CUSTOM_REVIVE = 129,
     /**
      * The exact same thing as the vanilla `PRE_ENTITY_SPAWN` callback, except this callback allows
      * you to specify extra arguments for additional filtration.
@@ -11478,7 +11524,7 @@ export declare enum ModCallbackCustom {
      * ): [EntityType, int, int, int] | undefined {}
      * ```
      */
-    PRE_ENTITY_SPAWN_FILTER = 128,
+    PRE_ENTITY_SPAWN_FILTER = 130,
     /**
      * The exact same thing as the vanilla `PRE_FAMILIAR_COLLISION` callback, except this callback
      * allows you to specify extra arguments for additional filtration.
@@ -11497,7 +11543,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    PRE_FAMILIAR_COLLISION_FILTER = 129,
+    PRE_FAMILIAR_COLLISION_FILTER = 131,
     /**
      * Fires from the `PRE_PICKUP_COLLISION` callback when a player touches a collectible pedestal and
      * meets all of the conditions to pick it up.
@@ -11517,7 +11563,7 @@ export declare enum ModCallbackCustom {
      * function preGetPedestal(player: EntityPlayer, collectible: EntityPickupCollectible): void {}
      * ```
      */
-    PRE_GET_PEDESTAL = 130,
+    PRE_GET_PEDESTAL = 132,
     /**
      * 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).
@@ -11537,7 +11583,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    PRE_ITEM_PICKUP = 131,
+    PRE_ITEM_PICKUP = 133,
     /**
      * The exact same thing as the vanilla `PRE_KNIFE_COLLISION` callback, except this callback allows
      * you to specify extra arguments for additional filtration.
@@ -11556,7 +11602,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    PRE_KNIFE_COLLISION_FILTER = 132,
+    PRE_KNIFE_COLLISION_FILTER = 134,
     /**
      * 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
@@ -11570,7 +11616,7 @@ export declare enum ModCallbackCustom {
      * function preNewLevel(player: EntityPlayer): void {}
      * ```
      */
-    PRE_NEW_LEVEL = 133,
+    PRE_NEW_LEVEL = 135,
     /**
      * The exact same thing as the vanilla `PRE_NPC_COLLISION` callback, except this callback allows
      * you to specify extra arguments for additional filtration.
@@ -11591,7 +11637,7 @@ export declare enum ModCallbackCustom {
      * ): boolean | undefined {}
      * ```
      */
-    PRE_NPC_COLLISION_FILTER = 134,
+    PRE_NPC_COLLISION_FILTER = 136,
     /**
      * The exact same thing as the vanilla `PRE_NPC_UPDATE` callback, except this callback allows you
      * to specify extra arguments for additional filtration.
@@ -11608,7 +11654,7 @@ export declare enum ModCallbackCustom {
      * function preNPCUpdateFilter(entity: Entity): boolean | undefined {}
      * ```
      */
-    PRE_NPC_UPDATE_FILTER = 135,
+    PRE_NPC_UPDATE_FILTER = 137,
     /**
      * The exact same thing as the vanilla `PRE_PROJECTILE_COLLISION` callback, except this callback
      * allows you to specify extra arguments for additional filtration.
@@ -11627,7 +11673,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    PRE_PROJECTILE_COLLISION_FILTER = 136,
+    PRE_PROJECTILE_COLLISION_FILTER = 138,
     /**
      * The exact same thing as the vanilla `PRE_ROOM_ENTITY_SPAWN` callback, except this callback
      * allows you to specify extra arguments for additional filtration.
@@ -11650,7 +11696,7 @@ export declare enum ModCallbackCustom {
      * ): [EntityType | GridEntityXMLType, int, int] | undefined {}
      * ```
      */
-    PRE_ROOM_ENTITY_SPAWN_FILTER = 137,
+    PRE_ROOM_ENTITY_SPAWN_FILTER = 139,
     /**
      * The exact same thing as the vanilla `PRE_TEAR_COLLISION` callback, except this callback allows
      * you to specify extra arguments for additional filtration.
@@ -11669,7 +11715,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    PRE_TEAR_COLLISION_FILTER = 138
+    PRE_TEAR_COLLISION_FILTER = 140
 }
 
 /**