isaacscript-common 28.0.1 → 28.1.0

package/dist/index.rollup.d.ts

@@ -533,10 +533,25 @@ declare interface AddCallbackParametersCustom {
     callback: (pressurePlate: GridEntityPressurePlate) => void,
     pressurePlateVariant?: PressurePlateVariant
     ];
+    [ModCallbackCustom.POST_PROJECTILE_INIT_FILTER]: [
+    callback: (projectile: EntityProjectile) => void,
+    projectileVariant?: ProjectileVariant,
+    subType?: int
+    ];
     [ModCallbackCustom.POST_PROJECTILE_INIT_LATE]: [
     callback: (projectile: EntityProjectile) => void,
     projectileVariant?: ProjectileVariant
     ];
+    [ModCallbackCustom.POST_PROJECTILE_UPDATE_FILTER]: [
+    callback: (projectile: EntityProjectile) => void,
+    projectileVariant?: ProjectileVariant,
+    subType?: int
+    ];
+    [ModCallbackCustom.POST_PROJECTILE_RENDER_FILTER]: [
+    callback: (projectile: EntityProjectile, renderOffset: Vector) => void,
+    projectileVariant?: ProjectileVariant,
+    subType?: int
+    ];
     [ModCallbackCustom.POST_PURCHASE]: [
     callback: (player: EntityPlayer, pickup: EntityPickup) => void,
     pickupVariant?: PickupVariant,
@@ -693,6 +708,11 @@ declare interface AddCallbackParametersCustom {
     variant?: int,
     subType?: int
     ];
+    [ModCallbackCustom.PRE_PROJECTILE_COLLISION_FILTER]: [
+    callback: (projectile: EntityProjectile, collider: Entity, low: boolean) => boolean | undefined,
+    projectileVariant?: ProjectileVariant,
+    subtype?: int
+    ];
     [ModCallbackCustom.PRE_ROOM_ENTITY_SPAWN_FILTER]: [
     callback: (entityTypeOrGridEntityXMLType: EntityType | GridEntityXMLType, variant: int, subType: int, gridIndex: int, seed: Seed) => [EntityType | GridEntityXMLType, int, int] | undefined,
     entityTypeOrGridEntityXMLType?: EntityType | GridEntityXMLType,
@@ -10873,6 +10893,21 @@ export declare enum ModCallbackCustom {
      * ```
      */
     POST_PRESSURE_PLATE_UPDATE = 94,
+    /**
+     * The exact same thing as the vanilla `POST_PROJECTILE_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 `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 postProjectileInitFilter(tear: EntityTear): void {}
+     * ```
+     */
+    POST_PROJECTILE_INIT_FILTER = 95,
     /**
      * Fires on the first `POST_PROJECTILE_UPDATE` frame for each projectile.
      *
@@ -10889,7 +10924,37 @@ export declare enum ModCallbackCustom {
      * function postProjectileInitLate(projectile: EntityProjectile): void {}
      * ```
      */
-    POST_PROJECTILE_INIT_LATE = 95,
+    POST_PROJECTILE_INIT_LATE = 96,
+    /**
+     * The exact same thing as the vanilla `POST_PROJECTILE_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 `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 postProjectileRenderFilter(tear: EntityTear, renderOffset: Vector): void {}
+     * ```
+     */
+    POST_PROJECTILE_RENDER_FILTER = 97,
+    /**
+     * The exact same thing as the vanilla `POST_PROJECTILE_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 `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 postProjectileUpdateFilter(tear: EntityTear): void {}
+     * ```
+     */
+    POST_PROJECTILE_UPDATE_FILTER = 98,
     /**
      * 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
@@ -10905,7 +10970,7 @@ export declare enum ModCallbackCustom {
      * function postPurchase(player: EntityPlayer, pickup: EntityPickup): void {}
      * ```
      */
-    POST_PURCHASE = 96,
+    POST_PURCHASE = 99,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a rock exists.
      *
@@ -10919,7 +10984,7 @@ export declare enum ModCallbackCustom {
      * function postRockRender(rock: GridEntityRock): void {}
      * ```
      */
-    POST_ROCK_RENDER = 97,
+    POST_ROCK_RENDER = 100,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a rock exists.
      *
@@ -10933,7 +10998,7 @@ export declare enum ModCallbackCustom {
      * function postRockUpdate(rock: GridEntityRock): void {}
      * ```
      */
-    POST_ROCK_UPDATE = 98,
+    POST_ROCK_UPDATE = 101,
     /**
      * Fires from the `POST_UPDATE` callback when the clear state of a room changes (as according to
      * the `Room.IsClear` method).
@@ -10950,7 +11015,7 @@ export declare enum ModCallbackCustom {
      * function postRoomClearChanged(roomClear: boolean): void {}
      * ```
      */
-    POST_ROOM_CLEAR_CHANGED = 99,
+    POST_ROOM_CLEAR_CHANGED = 102,
     /**
      * Fires from the `ENTITY_TAKE_DMG` callback when a player takes damage from spikes in a Sacrifice
      * Room.
@@ -10965,7 +11030,7 @@ export declare enum ModCallbackCustom {
      * function postSacrifice(player: EntityPlayer, numSacrifices: int): void {}
      * ```
      */
-    POST_SACRIFICE = 100,
+    POST_SACRIFICE = 103,
     /**
      * Fires from the `POST_RENDER` callback when a slot entity's animation changes.
      *
@@ -10983,7 +11048,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_SLOT_ANIMATION_CHANGED = 101,
+    POST_SLOT_ANIMATION_CHANGED = 104,
     /**
      * 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.)
@@ -11007,7 +11072,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_SLOT_COLLISION = 102,
+    POST_SLOT_COLLISION = 105,
     /**
      * Fires from the `POST_SLOT_UPDATE` or the `POST_ENTITY_REMOVE` callback when a slot machine is
      * destroyed or a beggar is removed.
@@ -11049,7 +11114,7 @@ export declare enum ModCallbackCustom {
      * function postSlotDestroyed(slot: Entity, slotDestructionType: SlotDestructionType): void {}
      * ```
      */
-    POST_SLOT_DESTROYED = 103,
+    POST_SLOT_DESTROYED = 106,
     /**
      * Fires when a new slot entity is initialized. Specifically, this is either:
      *
@@ -11068,7 +11133,7 @@ export declare enum ModCallbackCustom {
      * function postSlotInit(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_INIT = 104,
+    POST_SLOT_INIT = 107,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a slot entity exists.
      *
@@ -11082,7 +11147,7 @@ export declare enum ModCallbackCustom {
      * function postSlotRender(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_RENDER = 105,
+    POST_SLOT_RENDER = 108,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a slot entity exists.
      *
@@ -11096,7 +11161,7 @@ export declare enum ModCallbackCustom {
      * function postSlotUpdate(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_UPDATE = 106,
+    POST_SLOT_UPDATE = 109,
     /**
      * Fires from the `POST_RENDER` callback on every frame that spikes exist.
      *
@@ -11108,7 +11173,7 @@ export declare enum ModCallbackCustom {
      * function postSpikesRender(spikes: GridEntitySpikes): void {}
      * ```
      */
-    POST_SPIKES_RENDER = 107,
+    POST_SPIKES_RENDER = 110,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that spikes exist.
      *
@@ -11120,7 +11185,7 @@ export declare enum ModCallbackCustom {
      * function postSpikesUpdate(spikes: GridEntitySpikes): void {}
      * ```
      */
-    POST_SPIKES_UPDATE = 108,
+    POST_SPIKES_UPDATE = 111,
     /**
      * The exact same thing as the vanilla `POST_TEAR_INIT` callback, except this callback allows you
      * to specify extra arguments for additional filtration.
@@ -11135,7 +11200,7 @@ export declare enum ModCallbackCustom {
      * function postTearInitFilter(tear: EntityTear): void {}
      * ```
      */
-    POST_TEAR_INIT_FILTER = 109,
+    POST_TEAR_INIT_FILTER = 112,
     /**
      * Fires on the first `POST_TEAR_UPDATE` frame for each tear (which is when
      * `EntityTear.FrameCount` is equal to 0).
@@ -11153,7 +11218,7 @@ export declare enum ModCallbackCustom {
      * function postTearInitLate(tear: EntityTear): void {}
      * ```
      */
-    POST_TEAR_INIT_LATE = 110,
+    POST_TEAR_INIT_LATE = 113,
     /**
      * Fires on the second `POST_TEAR_UPDATE` frame for each tear (which is when
      * `EntityTear.FrameCount` is equal to 1).
@@ -11170,7 +11235,7 @@ export declare enum ModCallbackCustom {
      * function postTearInitVeryLate(tear: EntityTear): void {}
      * ```
      */
-    POST_TEAR_INIT_VERY_LATE = 111,
+    POST_TEAR_INIT_VERY_LATE = 114,
     /**
      * The exact same thing as the vanilla `POST_TEAR_RENDER` callback, except this callback allows
      * you to specify extra arguments for additional filtration.
@@ -11185,7 +11250,7 @@ export declare enum ModCallbackCustom {
      * function postTearRenderFilter(tear: EntityTear, renderOffset: Vector): void {}
      * ```
      */
-    POST_TEAR_RENDER_FILTER = 112,
+    POST_TEAR_RENDER_FILTER = 115,
     /**
      * The exact same thing as the vanilla `POST_TEAR_INIT` callback, except this callback allows you
      * to specify extra arguments for additional filtration.
@@ -11200,7 +11265,7 @@ export declare enum ModCallbackCustom {
      * function postTearUpdateFilter(tear: EntityTear): void {}
      * ```
      */
-    POST_TEAR_UPDATE_FILTER = 113,
+    POST_TEAR_UPDATE_FILTER = 116,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a TNT exists.
      *
@@ -11212,7 +11277,7 @@ export declare enum ModCallbackCustom {
      * function postTNTRender(tnt: GridEntityTNT): void {}
      * ```
      */
-    POST_TNT_RENDER = 114,
+    POST_TNT_RENDER = 117,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a TNT exists.
      *
@@ -11224,7 +11289,7 @@ export declare enum ModCallbackCustom {
      * function postTNTUpdate(tnt: GridEntityTNT): void {}
      * ```
      */
-    POST_TNT_UPDATE = 115,
+    POST_TNT_UPDATE = 118,
     /**
      * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when a player gains or loses a new
      * transformation.
@@ -11243,7 +11308,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_TRANSFORMATION = 116,
+    POST_TRANSFORMATION = 119,
     /**
      * Fires from `ENTITY_TAKE_DMG` callback when a Wishbone or a Walnut breaks.
      *
@@ -11258,7 +11323,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_TRINKET_BREAK = 117,
+    POST_TRINKET_BREAK = 120,
     /**
      * 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
@@ -11274,7 +11339,7 @@ export declare enum ModCallbackCustom {
      * function preBerserkDeath(player: EntityPlayer): void {}
      * ```
      */
-    PRE_BERSERK_DEATH = 118,
+    PRE_BERSERK_DEATH = 121,
     /**
      * 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
@@ -11293,7 +11358,7 @@ export declare enum ModCallbackCustom {
      * function preCustomRevive(player: EntityPlayer): int | undefined {}
      * ```
      */
-    PRE_CUSTOM_REVIVE = 119,
+    PRE_CUSTOM_REVIVE = 122,
     /**
      * The exact same thing as the vanilla `PRE_ENTITY_SPAWN` callback, except this callback allows
      * you to specify extra arguments for additional filtration.
@@ -11318,7 +11383,7 @@ export declare enum ModCallbackCustom {
      * ): [EntityType, int, int, int] | undefined {}
      * ```
      */
-    PRE_ENTITY_SPAWN_FILTER = 120,
+    PRE_ENTITY_SPAWN_FILTER = 123,
     /**
      * The exact same thing as the vanilla `PRE_FAMILIAR_COLLISION` callback, except this callback
      * allows you to specify extra arguments for additional filtration.
@@ -11337,7 +11402,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    PRE_FAMILIAR_COLLISION_FILTER = 121,
+    PRE_FAMILIAR_COLLISION_FILTER = 124,
     /**
      * Fires from the `PRE_PICKUP_COLLISION` callback when a player touches a collectible pedestal and
      * meets all of the conditions to pick it up.
@@ -11357,7 +11422,7 @@ export declare enum ModCallbackCustom {
      * function preGetPedestal(player: EntityPlayer, collectible: EntityPickupCollectible): void {}
      * ```
      */
-    PRE_GET_PEDESTAL = 122,
+    PRE_GET_PEDESTAL = 125,
     /**
      * 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).
@@ -11377,7 +11442,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    PRE_ITEM_PICKUP = 123,
+    PRE_ITEM_PICKUP = 126,
     /**
      * The exact same thing as the vanilla `PRE_KNIFE_COLLISION` callback, except this callback allows
      * you to specify extra arguments for additional filtration.
@@ -11396,7 +11461,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    PRE_KNIFE_COLLISION_FILTER = 124,
+    PRE_KNIFE_COLLISION_FILTER = 127,
     /**
      * 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
@@ -11410,7 +11475,7 @@ export declare enum ModCallbackCustom {
      * function preNewLevel(player: EntityPlayer): void {}
      * ```
      */
-    PRE_NEW_LEVEL = 125,
+    PRE_NEW_LEVEL = 128,
     /**
      * The exact same thing as the vanilla `PRE_NPC_COLLISION` callback, except this callback allows
      * you to specify extra arguments for additional filtration.
@@ -11431,7 +11496,7 @@ export declare enum ModCallbackCustom {
      * ): boolean | undefined {}
      * ```
      */
-    PRE_NPC_COLLISION_FILTER = 126,
+    PRE_NPC_COLLISION_FILTER = 129,
     /**
      * The exact same thing as the vanilla `PRE_NPC_UPDATE` callback, except this callback allows you
      * to specify extra arguments for additional filtration.
@@ -11448,7 +11513,26 @@ export declare enum ModCallbackCustom {
      * function preNPCUpdateFilter(entity: Entity): boolean | undefined {}
      * ```
      */
-    PRE_NPC_UPDATE_FILTER = 127,
+    PRE_NPC_UPDATE_FILTER = 130,
+    /**
+     * The exact same thing as the vanilla `PRE_PROJECTILE_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 `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 preProjectileCollisionFilter(
+     *   tear: EntityTear,
+     *   collider: Entity,
+     *   low: boolean,
+     * ): void {}
+     * ```
+     */
+    PRE_PROJECTILE_COLLISION_FILTER = 131,
     /**
      * The exact same thing as the vanilla `PRE_ROOM_ENTITY_SPAWN` callback, except this callback
      * allows you to specify extra arguments for additional filtration.
@@ -11471,7 +11555,7 @@ export declare enum ModCallbackCustom {
      * ): [EntityType | GridEntityXMLType, int, int] | undefined {}
      * ```
      */
-    PRE_ROOM_ENTITY_SPAWN_FILTER = 128,
+    PRE_ROOM_ENTITY_SPAWN_FILTER = 132,
     /**
      * The exact same thing as the vanilla `PRE_TEAR_COLLISION` callback, except this callback allows
      * you to specify extra arguments for additional filtration.
@@ -11490,7 +11574,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    PRE_TEAR_COLLISION_FILTER = 129
+    PRE_TEAR_COLLISION_FILTER = 133
 }
 
 /**