isaacscript-common 29.4.0 → 29.5.1

package/dist/index.rollup.d.ts

@@ -144,10 +144,6 @@ declare interface AddCallbackParametersCustom {
     callback: (collectible: EntityPickupCollectible, oldCollectibleType: CollectibleType) => void,
     collectibleType?: CollectibleType
     ];
-    [ModCallbackCustom.POST_COLLECTIBLE_INIT_FIRST]: [
-    callback: (collectible: EntityPickupCollectible) => void,
-    collectibleType?: CollectibleType
-    ];
     [ModCallbackCustom.POST_CURSED_TELEPORT]: [
     callback: (player: EntityPlayer) => void,
     playerVariant?: PlayerVariant,
@@ -235,6 +231,10 @@ declare interface AddCallbackParametersCustom {
     [ModCallbackCustom.POST_FLIP]: [
     callback: (newLazarus: EntityPlayer, oldLazarus: EntityPlayer) => void
     ];
+    [ModCallbackCustom.POST_GAME_END_FILTER]: [
+    callback: (isGameOver: boolean) => void,
+    isGameOver?: boolean
+    ];
     [ModCallbackCustom.POST_GAME_STARTED_REORDERED]: [
     callback: (isContinued: boolean) => void,
     isContinued: boolean | undefined
@@ -1509,24 +1509,6 @@ export declare function collectibleHasCacheFlag(collectibleOrCollectibleType: En
 
 export declare function collectibleHasTag(collectibleType: CollectibleType, tag: ItemConfigTag): boolean;
 
-/**
- * `CollectibleIndex` is a specific type of string that represents a unique identifier for a
- * collectible. Mods can signify that data structures handle collectibles by using this type.
- *
- * For more information, see the documentation for the `getCollectibleIndex` function.
- *
- * For example:
- *
- * ```ts
- * const collectiblesNameMap = new Map<CollectibleIndex, string>();
- * ```
- *
- * This type is branded for extra type safety.
- */
-export declare type CollectibleIndex = string & {
-    readonly __collectibleIndexBrand: symbol;
-};
-
 declare class CollectibleItemPoolType extends Feature {
     private pickupIndexCreation;
     private postPickupInitCollectible;
@@ -4677,58 +4659,6 @@ export declare function getCollectibleDevilHeartPrice(collectibleOrCollectibleTy
  */
 export declare function getCollectibleGfxFilename(collectibleOrCollectibleType: EntityPickup | CollectibleType | -1): string;
 
-/**
- * Mods may have to keep track of data relating to a collectible. Finding an index for these kinds
- * of data structures is difficult, since collectibles are respawned every time a player re-enters a
- * room (like all other pickups), so the `PtrHash` will change.
- *
- * Use this function to get a unique index for a collectible to use in these data structures.
- *
- * If your mod is upgraded, then you should use the `getPickupIndex` function instead, as it is more
- * general purpose and less prone to error (but relies on stateful tracking of pickups as the run
- * progresses).
- *
- * Collectibles are a special case of pickups: they cannot be pushed around. (They actually can be
- * pushed, but usually will stay on the same grid index.) Thus, it is possible to generate a
- * somewhat reliable non-stateful index for collectibles. We use a 4-tuple of the room list index,
- * the grid index of the collectible in the room, the collectible's `SubType`, and the collectible's
- * `InitSeed`.
- *
- * Collectibles that are shifted by Tainted Isaac's mechanic will have unique collectible indexes
- * because the `SubType` is different. (The collectible entities share the same `InitSeed` and
- * `PtrHash`.)
- *
- * Collectibles that are rolled (with e.g. a D6) will have unique collectible indexes because the
- * `SubType` and `InitSeed` are different. If you want to track collectibles independently of any
- * rerolls, then you can use the `PtrHash` as an index instead. (The `PtrHash` will not persist
- * between rooms, however.)
- *
- * Note that:
- * - The grid index is a necessary part of the collectible index because Diplopia and Crooked Penny
- *   can cause two or more collectibles with the same `SubType` and `InitSeed` to exist in the same
- *   room.
- * - This index will fail in the case where the player uses Diplopia or a successful Crooked Penny
- *   seven or more times in the same room, since that will cause two or more collectibles with the
- *   same grid index, `SubType`, and `InitSeed` to exist. (More than seven is required in non-1x1
- *   rooms.)
- * - The `SubType` is a necessary part of the collectible index because Tainted Isaac will
- *   continuously cause collectibles to morph into new sub-types with the same `InitSeed`.
- * - Using a collectible's position as part of the index is problematic, since players can push a
- *   pedestal. (Even using the grid index does not solve this problem, since it is possible in
- *   certain cases for collectibles to be spawned at a position that is not aligned with the grid,
- *   and the pedestal pushed to an adjacent tile, but this case should be extremely rare.)
- * - Mega Chests spawn two collectibles on the exact same position. However, both of them will have
- *   a different `InitSeed`, so this is not a problem for this indexing scheme.
- * - The indexing scheme used is different for collectibles that are inside of a Treasure Room or
- *   Boss Room, in order to handle the case of the player seeing the same collectible again in a
- *   post-Ascent Treasure Room or Boss Room. A 5-tuple of stage, stage type, grid index, `SubType`,
- *   and `InitSeed` is used in this case. (Using the room list index or the room grid index is not
- *   suitable for this purpose, since both of these values can change in the post-Ascent rooms.)
- *   Even though Treasure Rooms and Boss Rooms are grouped together in this scheme, there probably
- *   will not be collectibles with the same grid index, SubType, and InitSeed.
- */
-export declare function getCollectibleIndex(collectible: EntityPickup): CollectibleIndex;
-
 /**
  * Helper function to get the initial amount of charges that a collectible has. Returns 0 if the
  * provided collectible type was not valid.
@@ -5851,9 +5781,9 @@ export declare function getPlayerHearts(player: EntityPlayer): int;
  * (1). This works even if the player does not have any Sad Onions.
  *
  * Note that by default, this returns the same index for both The Forgotten and The Soul. (Even
- * though they are technically different characters, they share the same inventory and InitSeed.) If
- * this is not desired, pass true for the `differentiateForgottenAndSoul` argument, and the RNG of
- * Spoon Bender (3) will be used for The Soul.
+ * though they are technically different characters, they share the same inventory and `InitSeed`.)
+ * If this is not desired, pass true for the `differentiateForgottenAndSoul` argument, and the RNG
+ * of Spoon Bender (3) will be used for The Soul.
  *
  * Also note that this index does not work in the `POST_PLAYER_INIT` function for players 2 through
  * 4. With that said, in almost all cases, you should be lazy-initializing your data structures in
@@ -7360,6 +7290,13 @@ export declare function inDevilsCrownTreasureRoom(): boolean;
 
 export declare function inDimension(dimension: Dimension): boolean;
 
+/**
+ * Helper function to detect if the current room is a Double Trouble Boss Room.
+ *
+ * This is performed by checking for the string "Double Trouble" inside of the room name. The
+ * vanilla game uses this convention for every Double Trouble Boss Room. Note that this method might
+ * fail for mods that add extra Double Trouble rooms but do not follow the convention.
+ */
 export declare function inDoubleTrouble(): boolean;
 
 export declare function inGenesisRoom(): boolean;
@@ -9512,24 +9449,6 @@ export declare enum ModCallbackCustom {
      * ```
      */
     POST_COLLECTIBLE_EMPTY = 12,
-    /**
-     * Fires from the `POST_PICKUP_INIT` callback on the first time that a player has seen the
-     * respective collectible on the run. For more details on how this is calculated, see the
-     * documentation for the `getCollectibleIndex` helper function.
-     *
-     * This callback is useful because collectibles will despawn upon leaving the room and respawn
-     * upon re-entering the room. Additionally, when playing as Tainted Isaac, the `POST_PICKUP_INIT`
-     * callback will fire every time the item shifts.
-     *
-     * 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 `CollectibleType` provided.
-     *
-     * ```ts
-     * function postCollectibleInitLate(collectible: EntityPickupCollectible): void {}
-     * ```
-     */
-    POST_COLLECTIBLE_INIT_FIRST = 13,
     /**
      * Fires from the `POST_PLAYER_RENDER` callback on the first frame that the "TeleportUp" animation
      * begins playing after a player triggers a Cursed Eye teleport or a Cursed Skull teleport. (Both
@@ -9545,7 +9464,7 @@ export declare enum ModCallbackCustom {
      * function postCursedTeleport(player: EntityPlayer): void {}
      * ```
      */
-    POST_CURSED_TELEPORT = 14,
+    POST_CURSED_TELEPORT = 13,
     /**
      * Fires from the `POST_PLAYER_UPDATE` callback after the player has finished the death animation,
      * has teleported to the previous room, and is ready to play the animation for the modded revival
@@ -9563,7 +9482,7 @@ export declare enum ModCallbackCustom {
      * function postCustomRevive(player: EntityPlayer, revivalType: int): void {}
      * ```
      */
-    POST_CUSTOM_REVIVE = 15,
+    POST_CUSTOM_REVIVE = 14,
     /**
      * Fires from the `EFFECT_POST_UPDATE` callback after a player has entered the range of a Dice
      * Room floor.
@@ -9579,7 +9498,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_DICE_ROOM_ACTIVATED = 16,
+    POST_DICE_ROOM_ACTIVATED = 15,
     /**
      * Fires from the `POST_RENDER` callback on every frame that a door exists.
      *
@@ -9591,7 +9510,7 @@ export declare enum ModCallbackCustom {
      * function postDoorRender(door: GridEntityDoor): void {}
      * ```
      */
-    POST_DOOR_RENDER = 17,
+    POST_DOOR_RENDER = 16,
     /**
      * Fires from the `POST_UPDATE` callback on every frame that a door exists.
      *
@@ -9603,7 +9522,7 @@ export declare enum ModCallbackCustom {
      * function postDoorUpdate(door: GridEntityDoor): void {}
      * ```
      */
-    POST_DOOR_UPDATE = 18,
+    POST_DOOR_UPDATE = 17,
     /**
      * The exact same thing as the vanilla `POST_EFFECT_INIT` callback, except this callback allows
      * you to specify extra arguments for additional filtration.
@@ -9618,7 +9537,7 @@ export declare enum ModCallbackCustom {
      * function postEffectInitFilter(effect: EntityEffect): void {}
      * ```
      */
-    POST_EFFECT_INIT_FILTER = 19,
+    POST_EFFECT_INIT_FILTER = 18,
     /**
      * Fires on the first `POST_EFFECT_UPDATE` frame for each effect.
      *
@@ -9635,7 +9554,7 @@ export declare enum ModCallbackCustom {
      * function postEffectInitLate(effect: EntityEffect): void {}
      * ```
      */
-    POST_EFFECT_INIT_LATE = 20,
+    POST_EFFECT_INIT_LATE = 19,
     /**
      * The exact same thing as the vanilla `POST_EFFECT_RENDER` callback, except this callback allows
      * you to specify extra arguments for additional filtration.
@@ -9650,7 +9569,7 @@ export declare enum ModCallbackCustom {
      * function postEffectRenderFilter(effect: EntityEffect, renderOffset: Vector): void {}
      * ```
      */
-    POST_EFFECT_RENDER_FILTER = 21,
+    POST_EFFECT_RENDER_FILTER = 20,
     /**
      * Fires from the `POST_EFFECT_UPDATE` callback when an effect's state has changed from what it
      * was on the previous frame. (In this context, "state" refers to the `EntityEffect.State` field.)
@@ -9669,7 +9588,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_EFFECT_STATE_CHANGED = 22,
+    POST_EFFECT_STATE_CHANGED = 21,
     /**
      * The exact same thing as the vanilla `POST_EFFECT_UPDATE` callback, except this callback allows
      * you to specify extra arguments for additional filtration.
@@ -9684,7 +9603,7 @@ export declare enum ModCallbackCustom {
      * function postEffectUpdateFilter(effect: EntityEffect): void {}
      * ```
      */
-    POST_EFFECT_UPDATE_FILTER = 23,
+    POST_EFFECT_UPDATE_FILTER = 22,
     /**
      * The exact same thing as the vanilla `POST_ENTITY_KILL` callback, except this callback allows
      * you to specify extra arguments for additional filtration.
@@ -9701,7 +9620,7 @@ export declare enum ModCallbackCustom {
      * function postEntityKillFilter(entity: Entity): void {}
      * ```
      */
-    POST_ENTITY_KILL_FILTER = 24,
+    POST_ENTITY_KILL_FILTER = 23,
     /**
      * Fires one `POST_UPDATE` frame after the player has used the Esau Jr. item. (The player is not
      * updated to the new character until a game frame has passed.)
@@ -9710,7 +9629,7 @@ export declare enum ModCallbackCustom {
      * function postEsauJr(player: EntityPlayer): void {}
      * ```
      */
-    POST_ESAU_JR = 25,
+    POST_ESAU_JR = 24,
     /**
      * The exact same thing as the vanilla `POST_FAMILIAR_INIT` callback, except this callback allows
      * you to specify extra arguments for additional filtration.
@@ -9725,7 +9644,7 @@ export declare enum ModCallbackCustom {
      * function postFamiliarInitFilter(familiar: EntityFamiliar): void {}
      * ```
      */
-    POST_FAMILIAR_INIT_FILTER = 26,
+    POST_FAMILIAR_INIT_FILTER = 25,
     /**
      * Fires on the first `FAMILIAR_UPDATE` frame for each familiar.
      *
@@ -9742,7 +9661,7 @@ export declare enum ModCallbackCustom {
      * function postFamiliarInitLate(familiar: EntityFamiliar): void {}
      * ```
      */
-    POST_FAMILIAR_INIT_LATE = 27,
+    POST_FAMILIAR_INIT_LATE = 26,
     /**
      * The exact same thing as the vanilla `POST_FAMILIAR_RENDER` callback, except this callback
      * allows you to specify extra arguments for additional filtration.
@@ -9757,7 +9676,7 @@ export declare enum ModCallbackCustom {
      * function postFamiliarRenderFilter(familiar: EntityFamiliar, renderOffset: Vector): void {}
      * ```
      */
-    POST_FAMILIAR_RENDER_FILTER = 28,
+    POST_FAMILIAR_RENDER_FILTER = 27,
     /**
      * Fires from the `POST_FAMILIAR_UPDATE` callback when a familiar's state has changed from what it
      * was on the previous frame. (In this context, "state" refers to the `EntityFamiliar.State`
@@ -9777,7 +9696,7 @@ export declare enum ModCallbackCustom {
      * ): void {}
      * ```
      */
-    POST_FAMILIAR_STATE_CHANGED = 29,
+    POST_FAMILIAR_STATE_CHANGED = 28,
     /**
      * The exact same thing as the vanilla `POST_FAMILIAR_UPDATE` callback, except this callback
      * allows you to specify extra arguments for additional filtration.
@@ -9792,7 +9711,7 @@ export declare enum ModCallbackCustom {
      * function postFamiliarUpdateFilter(familiar: EntityFamiliar): void {}
      * ```
      */
-    POST_FAMILIAR_UPDATE_FILTER = 30,
+    POST_FAMILIAR_UPDATE_FILTER = 29,
     /**
      * Fires one `POST_UPDATE` frame after the player has first used the Esau Jr. item. (The player is
      * not updated to the new character until a game frame has passed.)
@@ -9804,7 +9723,7 @@ export declare enum ModCallbackCustom {
      * function postFirstEsauJr(player: EntityPlayer): void {}
      * ```
      */
-    POST_FIRST_ESAU_JR = 31,
+    POST_FIRST_ESAU_JR = 30,
     /**
      * Fires after the player has used the Flip item for the first time. Unlike the vanilla `USE_ITEM`
      * callback, this callback will return the player object for the new Lazarus (not the one who used
@@ -9817,7 +9736,7 @@ export declare enum ModCallbackCustom {
      * function postFirstFlip(newLazarus: EntityPlayer, oldLazarus: EntityPlayer): void {}
      * ```
      */
-    POST_FIRST_FLIP = 32,
+    POST_FIRST_FLIP = 31,
     /**
      * Fires after the player has used the Flip item. Unlike the vanilla `USE_ITEM` callback, this
      * callback will return the player object for the new Lazarus (not the one who used the Flip
@@ -9830,7 +9749,20 @@ export declare enum ModCallbackCustom {
      * function postFlip(newLazarus: EntityPlayer, oldLazarus: EntityPlayer): void {}
      * ```
      */
-    POST_FLIP = 33,
+    POST_FLIP = 32,
+    /**
+     * The exact same thing as the vanilla `POST_GAME_END` 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 `isGameOver` value provided.
+     *
+     * ```ts
+     * function postGameEndFilter(isGameOver: boolean): void {}
+     * ```
+     */
+    POST_GAME_END_FILTER = 33,
     /**
      * Similar to the vanilla callback of the same name, but fires in the correct order with respect
      * to the `POST_NEW_LEVEL` and the `POST_NEW_ROOM` callbacks:
@@ -13196,6 +13128,10 @@ declare class PickupIndexCreation extends Feature {
      *
      * Tracking pickups requires stateful tracking, so using pickup indexes requires an upgraded mod.
      *
+     * Note that the pickup index will not change:
+     * - When a pickup is rolled with e.g. D6 or D20.
+     * - When an item is "rotated" via e.g. Tainted Isaac's mechanic.
+     *
      * In order to use this function, you must upgrade your mod with
      * `ISCFeature.PICKUP_INDEX_CREATION`.
      */
@@ -13596,9 +13532,13 @@ declare class PreventChildEntities extends Feature {
 }
 
 declare class PreventCollectibleRotation extends Feature {
+    private pickupIndexCreation;
+    /**
+     * Soul of Isaac causes items to flip. We assume that the player deliberately wants to roll a
+     * quest item, so we delete all tracked items in the current room.
+     */
     private useCardSoulOfIsaac;
-    private postPickupUpdateCollectible;
-    private checkCollectibleRotated;
+    private postPickupChanged;
     /**
      * Helper function to prevent a collectible from being affected by Tainted Isaac's rotation
      * mechanic. (This mechanic also happens from Glitched Crown and Binge Eater.) This is useful