isaacscript-common 27.13.0 → 28.0.1

package/dist/index.rollup.d.ts

@@ -53,7 +53,7 @@ import { LevelStage } from 'isaac-typescript-definitions';
 import { MinibossID } from 'isaac-typescript-definitions';
 import { ModCallback } from 'isaac-typescript-definitions';
 import { Music } from 'isaac-typescript-definitions';
-import { NpcState } from 'isaac-typescript-definitions';
+import { NPCState } from 'isaac-typescript-definitions';
 import { PickupPrice } from 'isaac-typescript-definitions';
 import { PickupVariant } from 'isaac-typescript-definitions';
 import { PillColor } from 'isaac-typescript-definitions';
@@ -599,6 +599,11 @@ declare interface AddCallbackParametersCustom {
     callback: (spikes: GridEntitySpikes) => void,
     variant?: int
     ];
+    [ModCallbackCustom.POST_TEAR_INIT_FILTER]: [
+    callback: (tear: EntityTear) => void,
+    tearVariant?: TearVariant,
+    subType?: int
+    ];
     [ModCallbackCustom.POST_TEAR_INIT_LATE]: [
     callback: (tear: EntityTear) => void,
     tearVariant?: TearVariant,
@@ -609,6 +614,16 @@ declare interface AddCallbackParametersCustom {
     tearVariant?: TearVariant,
     subType?: int
     ];
+    [ModCallbackCustom.POST_TEAR_RENDER_FILTER]: [
+    callback: (tear: EntityTear, renderOffset: Vector) => void,
+    tearVariant?: TearVariant,
+    subType?: int
+    ];
+    [ModCallbackCustom.POST_TEAR_UPDATE_FILTER]: [
+    callback: (tear: EntityTear) => void,
+    tearVariant?: TearVariant,
+    subType?: int
+    ];
     [ModCallbackCustom.POST_TNT_RENDER]: [
     callback: (tnt: GridEntityTNT) => void,
     variant?: int
@@ -684,6 +699,11 @@ declare interface AddCallbackParametersCustom {
     variant?: int,
     subType?: int
     ];
+    [ModCallbackCustom.PRE_TEAR_COLLISION_FILTER]: [
+    callback: (tear: EntityTear, collider: Entity, low: boolean) => boolean | undefined,
+    tearVariant?: TearVariant,
+    subtype?: int
+    ];
 }
 
 /**
@@ -1048,12 +1068,12 @@ export declare function asCollectibleType(num: number): CollectibleType;
 export declare function asLevelStage(num: number): LevelStage;
 
 /**
- * Helper function to safely cast a `number` to a `NpcState`. (This is better than using the `as`
+ * Helper function to safely cast a `number` to a `NPCState`. (This is better than using the `as`
  * TypeScript keyword to do a type assertion, since that can obfuscate compiler errors. )
  *
  * This is useful to satisfy the "isaacscript/strict-enums" ESLint rule.
  */
-export declare function asNpcState(num: number): NpcState;
+export declare function asNPCState(num: number): NPCState;
 
 /**
  * Helper function to safely cast an enum to a `number`. (This is better than using the `as`
@@ -3764,7 +3784,7 @@ export declare function easeOutQuint(time: number): number;
 export declare function easeOutSine(time: number): number;
 
 /**
- * When Eggies take fatal damage, they go into NpcState.STATE_SUICIDE and spawn 14 Swarm Spiders
+ * When Eggies take fatal damage, they go into NPCState.STATE_SUICIDE and spawn 14 Swarm Spiders
  * while their StateFrame ticks upwards. The 14th spider appears when the StateFrame is at this
  * value.
  */
@@ -7848,14 +7868,14 @@ export declare function isDoorToMomsHeart(door: GridEntityDoor): boolean;
 
 /**
  * Helper function to detect the custom death state of a Dump. When Dumps die, they go to
- * `NpcState.SPECIAL`, spit out their head, and then slowly fade away while shooting a burst of
+ * `NPCState.SPECIAL`, spit out their head, and then slowly fade away while shooting a burst of
  * tears.
  */
 export declare function isDyingDump(npc: EntityNPC): boolean;
 
 /**
  * Helper function to detect the custom death state of an Eggy. Eggies are never actually marked
- * dead by the game. Instead, when Eggies take fatal damage, they go into NpcState.STATE_SUICIDE and
+ * dead by the game. Instead, when Eggies take fatal damage, they go into NPCState.STATE_SUICIDE and
  * spawn 14 Swarm Spiders while their StateFrame ticks upwards.
  */
 export declare function isDyingEggyWithNoSpidersLeft(npc: EntityNPC): boolean;
@@ -11101,6 +11121,21 @@ export declare enum ModCallbackCustom {
      * ```
      */
     POST_SPIKES_UPDATE = 108,
+    /**
+     * The exact same thing as the vanilla `POST_TEAR_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 `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 postTearInitFilter(tear: EntityTear): void {}
+     * ```
+     */
+    POST_TEAR_INIT_FILTER = 109,
     /**
      * Fires on the first `POST_TEAR_UPDATE` frame for each tear (which is when
      * `EntityTear.FrameCount` is equal to 0).
@@ -11118,7 +11153,7 @@ export declare enum ModCallbackCustom {
      * function postTearInitLate(tear: EntityTear): void {}
      * ```
      */
-    POST_TEAR_INIT_LATE = 109,
+    POST_TEAR_INIT_LATE = 110,
     /**
      * Fires on the second `POST_TEAR_UPDATE` frame for each tear (which is when
      * `EntityTear.FrameCount` is equal to 1).
@@ -11135,7 +11170,37 @@ export declare enum ModCallbackCustom {
      * function postTearInitVeryLate(tear: EntityTear): void {}
      * ```
      */
-    POST_TEAR_INIT_VERY_LATE = 110,
+    POST_TEAR_INIT_VERY_LATE = 111,
+    /**
+     * The exact same thing as the vanilla `POST_TEAR_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 `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 postTearRenderFilter(tear: EntityTear, renderOffset: Vector): void {}
+     * ```
+     */
+    POST_TEAR_RENDER_FILTER = 112,
+    /**
+     * The exact same thing as the vanilla `POST_TEAR_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 `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 postTearUpdateFilter(tear: EntityTear): void {}
+     * ```
+     */
+    POST_TEAR_UPDATE_FILTER = 113,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a TNT exists.
      *
@@ -11147,7 +11212,7 @@ export declare enum ModCallbackCustom {
      * function postTNTRender(tnt: GridEntityTNT): void {}
      * ```
      */
-    POST_TNT_RENDER = 111,
+    POST_TNT_RENDER = 114,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a TNT exists.
      *
@@ -11159,7 +11224,7 @@ export declare enum ModCallbackCustom {
      * function postTNTUpdate(tnt: GridEntityTNT): void {}
      * ```
      */
-    POST_TNT_UPDATE = 112,
+    POST_TNT_UPDATE = 115,
     /**
      * Fires from the `POST_PEFFECT_UPDATE_REORDERED` callback when a player gains or loses a new
      * transformation.
@@ -11178,7 +11243,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_TRANSFORMATION = 113,
+    POST_TRANSFORMATION = 116,
     /**
      * Fires from `ENTITY_TAKE_DMG` callback when a Wishbone or a Walnut breaks.
      *
@@ -11193,7 +11258,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_TRINKET_BREAK = 114,
+    POST_TRINKET_BREAK = 117,
     /**
      * 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
@@ -11209,7 +11274,7 @@ export declare enum ModCallbackCustom {
      * function preBerserkDeath(player: EntityPlayer): void {}
      * ```
      */
-    PRE_BERSERK_DEATH = 115,
+    PRE_BERSERK_DEATH = 118,
     /**
      * 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
@@ -11228,7 +11293,7 @@ export declare enum ModCallbackCustom {
      * function preCustomRevive(player: EntityPlayer): int | undefined {}
      * ```
      */
-    PRE_CUSTOM_REVIVE = 116,
+    PRE_CUSTOM_REVIVE = 119,
     /**
      * The exact same thing as the vanilla `PRE_ENTITY_SPAWN` callback, except this callback allows
      * you to specify extra arguments for additional filtration.
@@ -11253,7 +11318,7 @@ export declare enum ModCallbackCustom {
      * ): [EntityType, int, int, int] | undefined {}
      * ```
      */
-    PRE_ENTITY_SPAWN_FILTER = 117,
+    PRE_ENTITY_SPAWN_FILTER = 120,
     /**
      * The exact same thing as the vanilla `PRE_FAMILIAR_COLLISION` callback, except this callback
      * allows you to specify extra arguments for additional filtration.
@@ -11272,7 +11337,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    PRE_FAMILIAR_COLLISION_FILTER = 118,
+    PRE_FAMILIAR_COLLISION_FILTER = 121,
     /**
      * Fires from the `PRE_PICKUP_COLLISION` callback when a player touches a collectible pedestal and
      * meets all of the conditions to pick it up.
@@ -11292,7 +11357,7 @@ export declare enum ModCallbackCustom {
      * function preGetPedestal(player: EntityPlayer, collectible: EntityPickupCollectible): void {}
      * ```
      */
-    PRE_GET_PEDESTAL = 119,
+    PRE_GET_PEDESTAL = 122,
     /**
      * 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).
@@ -11312,7 +11377,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    PRE_ITEM_PICKUP = 120,
+    PRE_ITEM_PICKUP = 123,
     /**
      * The exact same thing as the vanilla `PRE_KNIFE_COLLISION` callback, except this callback allows
      * you to specify extra arguments for additional filtration.
@@ -11331,7 +11396,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    PRE_KNIFE_COLLISION_FILTER = 121,
+    PRE_KNIFE_COLLISION_FILTER = 124,
     /**
      * 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
@@ -11345,7 +11410,7 @@ export declare enum ModCallbackCustom {
      * function preNewLevel(player: EntityPlayer): void {}
      * ```
      */
-    PRE_NEW_LEVEL = 122,
+    PRE_NEW_LEVEL = 125,
     /**
      * The exact same thing as the vanilla `PRE_NPC_COLLISION` callback, except this callback allows
      * you to specify extra arguments for additional filtration.
@@ -11366,7 +11431,7 @@ export declare enum ModCallbackCustom {
      * ): boolean | undefined {}
      * ```
      */
-    PRE_NPC_COLLISION_FILTER = 123,
+    PRE_NPC_COLLISION_FILTER = 126,
     /**
      * The exact same thing as the vanilla `PRE_NPC_UPDATE` callback, except this callback allows you
      * to specify extra arguments for additional filtration.
@@ -11383,7 +11448,7 @@ export declare enum ModCallbackCustom {
      * function preNPCUpdateFilter(entity: Entity): boolean | undefined {}
      * ```
      */
-    PRE_NPC_UPDATE_FILTER = 124,
+    PRE_NPC_UPDATE_FILTER = 127,
     /**
      * The exact same thing as the vanilla `PRE_ROOM_ENTITY_SPAWN` callback, except this callback
      * allows you to specify extra arguments for additional filtration.
@@ -11406,7 +11471,26 @@ export declare enum ModCallbackCustom {
      * ): [EntityType | GridEntityXMLType, int, int] | undefined {}
      * ```
      */
-    PRE_ROOM_ENTITY_SPAWN_FILTER = 125
+    PRE_ROOM_ENTITY_SPAWN_FILTER = 128,
+    /**
+     * The exact same thing as the vanilla `PRE_TEAR_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 `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 preTearCollisionFilter(
+     *   tear: EntityTear,
+     *   collider: Entity,
+     *   low: boolean,
+     * ): void {}
+     * ```
+     */
+    PRE_TEAR_COLLISION_FILTER = 129
 }
 
 /**