isaacscript-common 15.0.4 → 15.1.0

package/dist/index.d.ts

@@ -271,6 +271,12 @@ declare interface AddCallbackParametersCustom {
     [ModCallbackCustom.POST_NEW_LEVEL_REORDERED]: [callback: () => void];
     [ModCallbackCustom.POST_NEW_ROOM_EARLY]: [callback: () => void];
     [ModCallbackCustom.POST_NEW_ROOM_REORDERED]: [callback: () => void];
+    [ModCallbackCustom.POST_NPC_INIT_FILTER]: [
+    callback: (npc: EntityNPC) => void,
+    entityType?: EntityType,
+    variant?: int,
+    subType?: int
+    ];
     [ModCallbackCustom.POST_NPC_INIT_LATE]: [
     callback: (npc: EntityNPC) => void,
     entityType?: EntityType,
@@ -283,6 +289,12 @@ declare interface AddCallbackParametersCustom {
     variant?: int,
     subType?: int
     ];
+    [ModCallbackCustom.POST_NPC_UPDATE_FILTER]: [
+    callback: (npc: EntityNPC) => void,
+    entityType?: EntityType,
+    variant?: int,
+    subType?: int
+    ];
     [ModCallbackCustom.POST_PEFFECT_UPDATE_REORDERED]: [
     callback: (player: EntityPlayer) => void,
     playerVariant?: PlayerVariant,
@@ -4704,6 +4716,9 @@ export declare function getGridEntities(...gridEntityTypes: GridEntityType[]): G
  */
 export declare function getGridEntitiesExcept(...gridEntityTypes: GridEntityType[]): GridEntity[];
 
+/** Helper function to get all grid entities in a given radius around a given point. */
+export declare function getGridEntitiesInRadius(targetPosition: Vector, radius: number): GridEntity[];
+
 /**
  * Helper function to get a map of every grid entity in the current room. The indexes of the map are
  * equal to the grid index. The values of the map are equal to the grid entities.
@@ -4713,6 +4728,9 @@ export declare function getGridEntitiesExcept(...gridEntityTypes: GridEntityType
  */
 export declare function getGridEntitiesMap(...gridEntityTypes: GridEntityType[]): Map<int, GridEntity>;
 
+/** Helper function to get the top left and bottom right corners of a given grid entity. */
+export declare function getGridEntityCollisionPoints(gridEntity: GridEntity): [topLeft: Vector, bottomRight: Vector];
+
 /** Helper function to get a string containing the grid entity's type and variant. */
 export declare function getGridEntityID(gridEntity: GridEntity): string;
 
@@ -9164,6 +9182,19 @@ export declare enum ModCallbackCustom {
      * ```
      */
     POST_NEW_ROOM_REORDERED = 44,
+    /**
+     * The exact same thing as the vanilla `POST_NPC_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 `EntityType` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the variant provided.
+     * - You can provide an optional fifth argument that will make the callback only fire if it
+     *   matches the sub-type provided.
+     */
+    POST_NPC_INIT_FILTER = 45,
     /**
      * Fires on the first `NPC_UPDATE` frame for each NPC.
      *
@@ -9182,7 +9213,7 @@ export declare enum ModCallbackCustom {
      * function postNPCInitLate(npc: EntityNPC): void {}
      * ```
      */
-    POST_NPC_INIT_LATE = 45,
+    POST_NPC_INIT_LATE = 46,
     /**
      * 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.)
@@ -9203,7 +9234,20 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_NPC_STATE_CHANGED = 46,
+    POST_NPC_STATE_CHANGED = 47,
+    /**
+     * The exact same thing as the vanilla `POST_NPC_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 `EntityType` provided.
+     * - You can provide an optional fourth argument that will make the callback only fire if it
+     *   matches the variant provided.
+     * - You can provide an optional fifth argument that will make the callback only fire if it
+     *   matches the sub-type provided.
+     */
+    POST_NPC_UPDATE_FILTER = 48,
     /**
      * 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
@@ -9228,7 +9272,7 @@ export declare enum ModCallbackCustom {
      * function postPEffectUpdateReordered(player: EntityPlayer): void {}
      * ```
      */
-    POST_PEFFECT_UPDATE_REORDERED = 47,
+    POST_PEFFECT_UPDATE_REORDERED = 49,
     /**
      * Fires on the first `POST_RENDER` frame that a pickup plays the "Collect" animation.
      *
@@ -9244,7 +9288,7 @@ export declare enum ModCallbackCustom {
      * function postPickupCollect(pickup: EntityPickup, player: EntityPlayer): void {}
      * ```
      */
-    POST_PICKUP_COLLECT = 48,
+    POST_PICKUP_COLLECT = 50,
     /**
      * Fires from the `POST_PICKUP_INIT` callback on the first time that a player has seen the
      * respective pickup on the run.
@@ -9262,7 +9306,7 @@ export declare enum ModCallbackCustom {
      * function postPickupInitFirst(pickup: EntityPickup): void {}
      * ```
      */
-    POST_PICKUP_INIT_FIRST = 49,
+    POST_PICKUP_INIT_FIRST = 51,
     /**
      * Fires on the first `POST_PICKUP_UPDATE` frame for each pickup.
      *
@@ -9279,7 +9323,7 @@ export declare enum ModCallbackCustom {
      * function postPickupInitLate(pickup: EntityPickup): void {}
      * ```
      */
-    POST_PICKUP_INIT_LATE = 50,
+    POST_PICKUP_INIT_LATE = 52,
     /**
      * 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.)
@@ -9298,7 +9342,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PICKUP_STATE_CHANGED = 51,
+    POST_PICKUP_STATE_CHANGED = 53,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a pit exists.
      *
@@ -9310,7 +9354,7 @@ export declare enum ModCallbackCustom {
      * function postPitRender(pit: GridEntityPit): void {}
      * ```
      */
-    POST_PIT_RENDER = 52,
+    POST_PIT_RENDER = 54,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a pit exists.
      *
@@ -9322,7 +9366,7 @@ export declare enum ModCallbackCustom {
      * function postPitUpdate(pit: GridEntityPit): void {}
      * ```
      */
-    POST_PIT_UPDATE = 53,
+    POST_PIT_UPDATE = 55,
     /**
      * Fires from the `POST_PEFFECT_UPDATE` 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` enum.
@@ -9343,7 +9387,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PLAYER_CHANGE_HEALTH = 54,
+    POST_PLAYER_CHANGE_HEALTH = 56,
     /**
      * Fires from the `POST_PEFFECT_UPDATE` callback when one of the player's stats change from what
      * they were on the previous frame.
@@ -9373,7 +9417,7 @@ export declare enum ModCallbackCustom {
      * ) => void {}
      * ```
      */
-    POST_PLAYER_CHANGE_STAT = 55,
+    POST_PLAYER_CHANGE_STAT = 57,
     /**
      * Fires from the `POST_PEFFECT_UPDATE` callback when a player entity changes its player type
      * (i.e. character) from what it was on the previous frame. For example, it will fire after using
@@ -9395,7 +9439,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PLAYER_CHANGE_TYPE = 56,
+    POST_PLAYER_CHANGE_TYPE = 58,
     /**
      * Fires from the `POST_PEFFECT_UPDATE` 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 build is
@@ -9412,7 +9456,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PLAYER_COLLECTIBLE_ADDED = 57,
+    POST_PLAYER_COLLECTIBLE_ADDED = 59,
     /**
      * Fires from the `POST_PEFFECT_UPDATE` 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 build is
@@ -9429,7 +9473,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_PLAYER_COLLECTIBLE_REMOVED = 58,
+    POST_PLAYER_COLLECTIBLE_REMOVED = 60,
     /**
      * Fires from the `ENTITY_TAKE_DMG` callback when a player takes fatal damage. Return false to
      * prevent the fatal damage.
@@ -9447,7 +9491,7 @@ export declare enum ModCallbackCustom {
      * function postPlayerFatalDamage(player: EntityPlayer): boolean | undefined {}
      * ```
      */
-    POST_PLAYER_FATAL_DAMAGE = 59,
+    POST_PLAYER_FATAL_DAMAGE = 61,
     /**
      * Fires on the first `POST_PEFFECT_UPDATE_REORDERED` frame for each player, similar to the
      * `POST_PLAYER_INIT_LATE` callback, with two changes:
@@ -9469,7 +9513,7 @@ export declare enum ModCallbackCustom {
      * function postPlayerInitFirst(player: EntityPlayer): void {}
      * ```
      */
-    POST_PLAYER_INIT_FIRST = 60,
+    POST_PLAYER_INIT_FIRST = 62,
     /**
      * Fires on the first `POST_PEFFECT_UPDATE_REORDERED` frame for each player.
      *
@@ -9489,7 +9533,7 @@ export declare enum ModCallbackCustom {
      * function postPlayerInitLate(pickup: EntityPickup): void {}
      * ```
      */
-    POST_PLAYER_INIT_LATE = 61,
+    POST_PLAYER_INIT_LATE = 63,
     /**
      * 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).
@@ -9513,7 +9557,7 @@ export declare enum ModCallbackCustom {
      * function postPlayerRenderReordered(player: EntityPlayer): void {}
      * ```
      */
-    POST_PLAYER_RENDER_REORDERED = 62,
+    POST_PLAYER_RENDER_REORDERED = 64,
     /**
      * 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
@@ -9538,7 +9582,7 @@ export declare enum ModCallbackCustom {
      * function postPlayerUpdateReordered(player: EntityPlayer): void {}
      * ```
      */
-    POST_PLAYER_UPDATE_REORDERED = 63,
+    POST_PLAYER_UPDATE_REORDERED = 65,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a poop exists.
      *
@@ -9550,7 +9594,7 @@ export declare enum ModCallbackCustom {
      * function postPoopRender(poop: GridEntityPoop): void {}
      * ```
      */
-    POST_POOP_RENDER = 64,
+    POST_POOP_RENDER = 66,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a poop exists.
      *
@@ -9562,7 +9606,7 @@ export declare enum ModCallbackCustom {
      * function postPoopUpdate(poop: GridEntityPoop): void {}
      * ```
      */
-    POST_POOP_UPDATE = 65,
+    POST_POOP_UPDATE = 67,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a pressure plate exists.
      *
@@ -9574,7 +9618,7 @@ export declare enum ModCallbackCustom {
      * function postPressurePlateRender(pressurePlate: GridEntityPressurePlate): void {}
      * ```
      */
-    POST_PRESSURE_PLATE_RENDER = 66,
+    POST_PRESSURE_PLATE_RENDER = 68,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a pressure plate exists.
      *
@@ -9586,7 +9630,7 @@ export declare enum ModCallbackCustom {
      * function postPressurePlateUpdate(pressurePlate: GridEntityPressurePlate): void {}
      * ```
      */
-    POST_PRESSURE_PLATE_UPDATE = 67,
+    POST_PRESSURE_PLATE_UPDATE = 69,
     /**
      * Fires on the first `POST_PROJECTILE_UPDATE` frame for each projectile.
      *
@@ -9603,7 +9647,7 @@ export declare enum ModCallbackCustom {
      * function postProjectileInitLate(projectile: EntityProjectile): void {}
      * ```
      */
-    POST_PROJECTILE_INIT_LATE = 68,
+    POST_PROJECTILE_INIT_LATE = 70,
     /**
      * Fires from the `POST_PEFFECT_UPDATE` 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 exists.
@@ -9618,7 +9662,7 @@ export declare enum ModCallbackCustom {
      * function postPurchase(player: EntityPlayer, pickup: EntityPickup): void {}
      * ```
      */
-    POST_PURCHASE = 69,
+    POST_PURCHASE = 71,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a rock exists.
      *
@@ -9632,7 +9676,7 @@ export declare enum ModCallbackCustom {
      * function postRockRender(rock: GridEntityRock): void {}
      * ```
      */
-    POST_ROCK_RENDER = 70,
+    POST_ROCK_RENDER = 72,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a rock exists.
      *
@@ -9646,7 +9690,7 @@ export declare enum ModCallbackCustom {
      * function postRockUpdate(rock: GridEntityRock): void {}
      * ```
      */
-    POST_ROCK_UPDATE = 71,
+    POST_ROCK_UPDATE = 73,
     /**
      * Fires from the `POST_UPDATE` callback when the clear state of a room changes (as according to
      * the `Room.IsClear` method).
@@ -9663,7 +9707,7 @@ export declare enum ModCallbackCustom {
      * function postRoomClearChanged(roomClear: boolean): void {}
      * ```
      */
-    POST_ROOM_CLEAR_CHANGED = 72,
+    POST_ROOM_CLEAR_CHANGED = 74,
     /**
      * Fires from the `ENTITY_TAKE_DMG` callback when a player takes damage from spikes in a Sacrifice
      * Room.
@@ -9678,7 +9722,7 @@ export declare enum ModCallbackCustom {
      * function postSacrifice(player: EntityPlayer, numSacrifices: int): void {}
      * ```
      */
-    POST_SACRIFICE = 73,
+    POST_SACRIFICE = 75,
     /**
      * Fires from the `POST_RENDER` callback when a slot entity's animation changes.
      *
@@ -9692,7 +9736,7 @@ export declare enum ModCallbackCustom {
      * function postSlotAnimationChanged(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_ANIMATION_CHANGED = 74,
+    POST_SLOT_ANIMATION_CHANGED = 76,
     /**
      * 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.)
@@ -9716,7 +9760,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_SLOT_COLLISION = 75,
+    POST_SLOT_COLLISION = 77,
     /**
      * Fires from the `POST_RENDER` callback when a slot plays the animation that indicates that it
      * has broken.
@@ -9731,7 +9775,7 @@ export declare enum ModCallbackCustom {
      * function postSlotDestroyed(slot: Entity, slotDestructionType: SlotDestructionType): void {}
      * ```
      */
-    POST_SLOT_DESTROYED = 76,
+    POST_SLOT_DESTROYED = 78,
     /**
      * Fires when a new slot entity is initialized. Specifically, this is either:
      *
@@ -9750,7 +9794,7 @@ export declare enum ModCallbackCustom {
      * function postSlotInit(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_INIT = 77,
+    POST_SLOT_INIT = 79,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a slot entity exists.
      *
@@ -9764,7 +9808,7 @@ export declare enum ModCallbackCustom {
      * function postSlotRender(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_RENDER = 78,
+    POST_SLOT_RENDER = 80,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a slot entity exists.
      *
@@ -9778,7 +9822,7 @@ export declare enum ModCallbackCustom {
      * function postSlotUpdate(slot: Entity): void {}
      * ```
      */
-    POST_SLOT_UPDATE = 79,
+    POST_SLOT_UPDATE = 81,
     /**
      * Fires from the `POST_RENDER` callback on every frame that spikes exist.
      *
@@ -9790,7 +9834,7 @@ export declare enum ModCallbackCustom {
      * function postSpikesRender(spikes: GridEntitySpikes): void {}
      * ```
      */
-    POST_SPIKES_RENDER = 80,
+    POST_SPIKES_RENDER = 82,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that spikes exist.
      *
@@ -9802,7 +9846,7 @@ export declare enum ModCallbackCustom {
      * function postSpikesUpdate(spikes: GridEntitySpikes): void {}
      * ```
      */
-    POST_SPIKES_UPDATE = 81,
+    POST_SPIKES_UPDATE = 83,
     /**
      * Fires on the first `POST_TEAR_UPDATE` frame for each tear (which is when
      * `EntityTear.FrameCount` is equal to 0).
@@ -9820,7 +9864,7 @@ export declare enum ModCallbackCustom {
      * function postTearInitLate(tear: EntityTear): void {}
      * ```
      */
-    POST_TEAR_INIT_LATE = 82,
+    POST_TEAR_INIT_LATE = 84,
     /**
      * Fires on the second `POST_TEAR_UPDATE` frame for each tear (which is when
      * `EntityTear.FrameCount` is equal to 1).
@@ -9837,7 +9881,7 @@ export declare enum ModCallbackCustom {
      * function postTearInitVeryLate(tear: EntityTear): void {}
      * ```
      */
-    POST_TEAR_INIT_VERY_LATE = 83,
+    POST_TEAR_INIT_VERY_LATE = 85,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a TNT exists.
      *
@@ -9849,7 +9893,7 @@ export declare enum ModCallbackCustom {
      * function postTNTRender(tnt: GridEntityTNT): void {}
      * ```
      */
-    POST_TNT_RENDER = 84,
+    POST_TNT_RENDER = 86,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a TNT exists.
      *
@@ -9861,7 +9905,7 @@ export declare enum ModCallbackCustom {
      * function postTNTUpdate(tnt: GridEntityTNT): void {}
      * ```
      */
-    POST_TNT_UPDATE = 85,
+    POST_TNT_UPDATE = 87,
     /**
      * Fires from the `POST_PEFFECT_UPDATE` callback when a player gains or loses a new
      * transformation.
@@ -9880,7 +9924,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_TRANSFORMATION = 86,
+    POST_TRANSFORMATION = 88,
     /**
      * Fires from `ENTITY_TAKE_DMG` callback when a Wishbone or a Walnut breaks.
      *
@@ -9895,7 +9939,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_TRINKET_BREAK = 87,
+    POST_TRINKET_BREAK = 89,
     /**
      * Fires from the `POST_PEFFECT_UPDATE` 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 damage in
@@ -9911,7 +9955,7 @@ export declare enum ModCallbackCustom {
      * function preBerserkDeath(player: EntityPlayer): void {}
      * ```
      */
-    PRE_BERSERK_DEATH = 88,
+    PRE_BERSERK_DEATH = 90,
     /**
      * 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
@@ -9930,7 +9974,7 @@ export declare enum ModCallbackCustom {
      * function preCustomRevive(player: EntityPlayer): int | undefined {}
      * ```
      */
-    PRE_CUSTOM_REVIVE = 89,
+    PRE_CUSTOM_REVIVE = 91,
     /**
      * Fires from the `PRE_PICKUP_COLLISION` callback when a player touches a collectible pedestal and
      * meets all of the conditions to pick it up.
@@ -9950,7 +9994,7 @@ export declare enum ModCallbackCustom {
      * function preGetPedestal(player: EntityPlayer, collectible: EntityPickupCollectible): void {}
      * ```
      */
-    PRE_GET_PEDESTAL = 90,
+    PRE_GET_PEDESTAL = 92,
     /**
      * Fires from the `POST_PEFFECT_UPDATE` callback when an item becomes queued (i.e. when the player
      * begins to hold the item above their head).
@@ -9970,7 +10014,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    PRE_ITEM_PICKUP = 91,
+    PRE_ITEM_PICKUP = 93,
     /**
      * 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
@@ -9984,7 +10028,7 @@ export declare enum ModCallbackCustom {
      * function preNewLevel(player: EntityPlayer): void {}
      * ```
      */
-    PRE_NEW_LEVEL = 92
+    PRE_NEW_LEVEL = 94
 }
 
 /**
@@ -12306,7 +12350,7 @@ export declare function roomUpdateSafe(): void;
  * From: http://lua-users.org/wiki/SimpleRound
  *
  * @param num The number to round.
- * @param numDecimalPlaces Default is 0.
+ * @param numDecimalPlaces Optional. Default is 0.
  */
 export declare function round(num: float, numDecimalPlaces?: number): float;