isaacscript-common 31.7.2 → 31.8.0

package/dist/src/functions/pocketItems.lua

@@ -93,9 +93,9 @@ function ____exports.getFirstPill(self, player)
         function(____, pocketItem) return pocketItem.type == PocketItemType.PILL end
     )
 end
---- Returns whether or not the player can hold an additional pocket item, beyond what they are
--- currently carrying. This takes into account items that modify the max number of pocket items,
--- like Starter Deck.
+--- Returns whether the player can hold an additional pocket item, beyond what they are currently
+-- carrying. This takes into account items that modify the max number of pocket items, like Starter
+-- Deck.
 -- 
 -- If the player is the Tainted Soul, this always returns false, since that character cannot pick up
 -- items. (Only Tainted Forgotten can pick up items.)
@@ -109,8 +109,8 @@ function ____exports.hasOpenPocketItemSlot(self, player)
         function(____, pocketItem) return pocketItem.type == PocketItemType.EMPTY end
     )
 end
---- Helper function to determine whether or not the player's "active" pocket item slot is set to
--- their pocket active item.
+--- Helper function to determine whether the player's "active" pocket item slot is set to their
+-- pocket active item.
 function ____exports.isFirstSlotPocketActiveItem(self, player)
     local pocketItems = ____exports.getPocketItems(nil, player)
     local firstPocketItem = pocketItems[1]

package/dist/src/functions/revive.d.ts

@@ -7,9 +7,9 @@
  */
 export declare function isDamageToPlayerFatal(player: EntityPlayer, amount: int, source: EntityRef, lastDamageGameFrame: int | undefined): boolean;
 /**
- * Assuming that we are on the frame of fatal damage, this function returns whether or not
- * Mysterious Paper would rotate to Missing Poster on the frame that the "Game Over" screen would
- * appear (which would subsequently save the player from fatal damage).
+ * Assuming that we are on the frame of fatal damage, this function returns whether Mysterious Paper
+ * would rotate to Missing Poster on the frame that the "Game Over" screen would appear (which would
+ * subsequently save the player from fatal damage).
  *
  * Mysterious Paper rotates between the 4 items on every frame, in order. The formula for whether
  * Mysterious Paper be Missing Power is: `gameFrameCount % 4 === 3`

package/dist/src/functions/revive.lua

@@ -96,9 +96,9 @@ function ____exports.isDamageToPlayerFatal(self, player, amount, source, lastDam
     end
     return true
 end
---- Assuming that we are on the frame of fatal damage, this function returns whether or not
--- Mysterious Paper would rotate to Missing Poster on the frame that the "Game Over" screen would
--- appear (which would subsequently save the player from fatal damage).
+--- Assuming that we are on the frame of fatal damage, this function returns whether Mysterious Paper
+-- would rotate to Missing Poster on the frame that the "Game Over" screen would appear (which would
+-- subsequently save the player from fatal damage).
 -- 
 -- Mysterious Paper rotates between the 4 items on every frame, in order. The formula for whether
 -- Mysterious Paper be Missing Power is: `gameFrameCount % 4 === 3`

package/dist/src/functions/rooms.d.ts

@@ -188,9 +188,9 @@ export declare function inSecretExit(): boolean;
  */
 export declare function inSecretShop(): boolean;
 /**
- * Helper function to determine whether or not the current room is the starting room of a floor. It
- * only returns true for the starting room of the primary dimension (meaning that being in the
- * starting room of the mirror world does not count).
+ * Helper function to determine whether the current room is the starting room of a floor. It only
+ * returns true for the starting room of the primary dimension (meaning that being in the starting
+ * room of the mirror world does not count).
  */
 export declare function inStartingRoom(): boolean;
 /**
@@ -205,10 +205,10 @@ export declare function is2x1Room(roomData: RoomConfig): boolean;
  * @param onlyCheckRoomTypes Optional. A whitelist of room types. If specified, room types not in
  *                           the array will be ignored. If not specified, then all rooms will be
  *                           checked. Undefined by default.
- * @param includeSecretAndSuperSecretRoom Optional. Whether or not to include the Secret Room and
- *                                 the Super Secret Room. Default is false.
- * @param includeUltraSecretRoom Optional. Whether or not to include the Ultra Secret Room. Default
- *                               is false.
+ * @param includeSecretAndSuperSecretRoom Optional. Whether to include the Secret Room and the Super
+ *                                 Secret Room. Default is false.
+ * @param includeUltraSecretRoom Optional. Whether to include the Ultra Secret Room. Default is
+ *                               false.
  * @allowEmptyVariadic
  */
 export declare function isAllRoomsClear(onlyCheckRoomTypes?: RoomType[], includeSecretAndSuperSecretRoom?: boolean, includeUltraSecretRoom?: boolean): boolean;

package/dist/src/functions/rooms.lua

@@ -465,9 +465,9 @@ function ____exports.inSecretShop(self)
     local roomDescriptor = getRoomDescriptorReadOnly(nil)
     return ____exports.isSecretShop(nil, roomDescriptor)
 end
---- Helper function to determine whether or not the current room is the starting room of a floor. It
--- only returns true for the starting room of the primary dimension (meaning that being in the
--- starting room of the mirror world does not count).
+--- Helper function to determine whether the current room is the starting room of a floor. It only
+-- returns true for the starting room of the primary dimension (meaning that being in the starting
+-- room of the mirror world does not count).
 function ____exports.inStartingRoom(self)
     local level = game:GetLevel()
     local startingRoomGridIndex = level:GetStartingRoomIndex()
@@ -481,10 +481,10 @@ end
 -- @param onlyCheckRoomTypes Optional. A whitelist of room types. If specified, room types not in
 -- the array will be ignored. If not specified, then all rooms will be
 -- checked. Undefined by default.
--- @param includeSecretAndSuperSecretRoom Optional. Whether or not to include the Secret Room and
--- the Super Secret Room. Default is false.
--- @param includeUltraSecretRoom Optional. Whether or not to include the Ultra Secret Room. Default
--- is false.
+-- @param includeSecretAndSuperSecretRoom Optional. Whether to include the Secret Room and the Super
+-- Secret Room. Default is false.
+-- @param includeUltraSecretRoom Optional. Whether to include the Ultra Secret Room. Default is
+-- false.
 -- @allowEmptyVariadic
 function ____exports.isAllRoomsClear(self, onlyCheckRoomTypes, includeSecretAndSuperSecretRoom, includeUltraSecretRoom)
     if includeSecretAndSuperSecretRoom == nil then

package/dist/src/functions/run.d.ts

@@ -10,7 +10,7 @@ export declare function canRunUnlockAchievements(): boolean;
  */
 export declare function isGreedMode(): boolean;
 /**
- * Whether or not the player is playing on a set seed (i.e. that they entered in a specific seed by
+ * Whether the player is playing on a set seed (i.e. that they entered in a specific seed by
  * pressing tab on the character selection screen). When the player resets the game on a set seed,
  * the game will not switch to a different seed.
  */

package/dist/src/functions/run.lua

@@ -27,7 +27,7 @@ end
 function ____exports.isGreedMode(self)
     return game.Difficulty == Difficulty.GREED or game.Difficulty == Difficulty.GREEDIER
 end
---- Whether or not the player is playing on a set seed (i.e. that they entered in a specific seed by
+--- Whether the player is playing on a set seed (i.e. that they entered in a specific seed by
 -- pressing tab on the character selection screen). When the player resets the game on a set seed,
 -- the game will not switch to a different seed.
 function ____exports.onSetSeed(self)

package/dist/src/functions/set.d.ts

@@ -48,7 +48,7 @@ export declare function getRandomSetElement<T>(set: Set<T> | ReadonlySet<T>, see
  * - [1, 2, 3]
  *
  * @param set The set to get the combinations of.
- * @param includeEmptyArray Whether or not to include an empty array in the combinations.
+ * @param includeEmptyArray Whether to include an empty array in the combinations.
  */
 export declare function getSetCombinations<T>(set: Set<T> | ReadonlySet<T>, includeEmptyArray: boolean): ReadonlyArray<ReadonlySet<T>>;
 /**

package/dist/src/functions/set.lua

@@ -111,7 +111,7 @@ end
 -- - [1, 2, 3]
 -- 
 -- @param set The set to get the combinations of.
--- @param includeEmptyArray Whether or not to include an empty array in the combinations.
+-- @param includeEmptyArray Whether to include an empty array in the combinations.
 function ____exports.getSetCombinations(self, set, includeEmptyArray)
     local values = ____exports.getSortedSetValues(nil, set)
     local combinations = getArrayCombinations(nil, values, includeEmptyArray)

package/dist/src/functions/stage.d.ts

@@ -56,11 +56,61 @@ export declare function getStageID(stage?: LevelStage, stageType?: StageType): S
 export declare function getStageType(): StageType;
 /** Helper function to directly warp to a specific stage using the "stage" console command. */
 export declare function goToStage(stage: LevelStage, stageType: StageType): void;
+/**
+ * Returns whether the provided stage and stage type represent a "final floor". This is defined as a
+ * floor that prevents the player from entering the I AM ERROR room on.
+ *
+ * For example, when using Undefined on The Chest, it has a 50% chance of teleporting the player to
+ * the Secret Room and a 50% chance of teleporting the player to the Super Secret Room, because the
+ * I AM ERROR room is never entered into the list of possibilities.
+ */
+export declare function isFinalFloor(stage: LevelStage, stageType: StageType): boolean;
 /**
  * Helper function to check if the provided stage type is equal to `StageType.REPENTANCE` or
  * `StageType.REPENTANCE_B`.
  */
 export declare function isRepentanceStage(stageType: StageType): boolean;
+/**
+ * Helper function to check if the provided effective stage is one that has the possibility to grant
+ * a natural Devil Room or Angel Room after killing the boss.
+ *
+ * Note that in order for this function to work properly, you must provide it with the effective
+ * stage (e.g. from the `getEffectiveStage` helper function) and not the absolute stage (e.g. from
+ * the `Level.GetStage` method).
+ */
+export declare function isStageWithNaturalDevilRoom(effectiveStage: LevelStage): boolean;
+/**
+ * After defeating the boss on most stages, a random collectible will spawn from the Boss Room pool.
+ * However, this does not happen on Depths 2, Womb 2, and beyond.
+ */
+export declare function isStageWithRandomBossCollectible(stage: LevelStage): boolean;
+/**
+ * Helper function to check if the provided stage will spawn a locked door to Downpour/Dross after
+ * defeating the boss.
+ */
+export declare function isStageWithSecretExitToDownpour(stage: LevelStage): boolean;
+/**
+ * Helper function to check if the provided stage and stage type will spawn a spiked door to
+ * Mausoleum/Gehenna after defeating the boss.
+ */
+export declare function isStageWithSecretExitToMausoleum(stage: LevelStage, stageType: StageType): boolean;
+/**
+ * Helper function to check if the provided stage and stage type will spawn a wooden door to
+ * Mines/Ashpit after defeating the boss.
+ */
+export declare function isStageWithSecretExitToMines(stage: LevelStage, stageType: StageType): boolean;
+/**
+ * Helper function to check if the current stage is one that would create a trapdoor if We Need to
+ * Go Deeper was used.
+ */
+export declare function isStageWithShovelTrapdoors(stage: LevelStage, stageType: StageType): boolean;
+/**
+ * Helper function to check if the provided stage is one with a story boss. Specifically, this is
+ * Depths 2 (Mom), Womb 2 (Mom's Heart / It Lives), Blue Womb (Hush), Sheol (Satan), Cathedral
+ * (Isaac), Dark Room (Lamb), The Chest (Blue Baby), The Void (Delirium), and Home (Dogma / The
+ * Beast).
+ */
+export declare function isStageWithStoryBoss(stage: LevelStage): boolean;
 /**
  * Helper function to check if the player has taken Dad's Note. This sets the game state flag of
  * `GameStateFlag.BACKWARDS_PATH` and causes floor generation to change.
@@ -77,8 +127,8 @@ export declare function onDarkRoom(): boolean;
  */
 export declare function onEffectiveStage(...effectiveStages: LevelStage[]): boolean;
 /**
- * Returns whether or not the player is on the "final floor" of the particular run. The final floor
- * is defined as one that prevents the player from entering the I AM ERROR room on.
+ * Returns whether the player is on the "final floor" of the particular run. The final floor is
+ * defined as one that prevents the player from entering the I AM ERROR room on.
  *
  * For example, when using Undefined on The Chest, it has a 50% chance of teleporting the player to
  * the Secret Room and a 50% chance of teleporting the player to the Super Secret Room, because the
@@ -86,7 +136,7 @@ export declare function onEffectiveStage(...effectiveStages: LevelStage[]): bool
  */
 export declare function onFinalFloor(): boolean;
 /**
- * Returns whether or not the player is on the first floor of the particular run.
+ * Returns whether the player is on the first floor of the particular run.
  *
  * This is tricky to determine because we have to handle the cases of Downpour/Dross 1 not being the
  * first floor and The Ascent.
@@ -143,7 +193,14 @@ export declare function onStageWithSecretExitToMines(): boolean;
  * Helper function to check if the current stage is one that would create a trapdoor if We Need to
  * Go Deeper was used.
  */
-export declare function onStageWithShovelWorking(): boolean;
+export declare function onStageWithShovelTrapdoors(): boolean;
+/**
+ * Helper function to check if the current stage is one with a story boss. Specifically, this is
+ * Depths 2 (Mom), Womb 2 (Mom's Heart / It Lives), Blue Womb (Hush), Sheol (Satan), Cathedral
+ * (Isaac), Dark Room (Lamb), The Chest (Blue Baby), The Void (Delirium), and Home (Dogma / The
+ * Beast).
+ */
+export declare function onStageWithStoryBoss(): boolean;
 /**
  * Helper function to warp to a new stage/level.
  *
@@ -152,9 +209,9 @@ export declare function onStageWithShovelWorking(): boolean;
  *
  * @param stage The stage number to warp to.
  * @param stageType The stage type to warp to.
- * @param reseed Optional. Whether or not to reseed the floor upon arrival. Default is false. Set
- *               this to true if you are warping to the same stage but a different stage type (or
- *               else the floor layout will be identical to the old floor).
+ * @param reseed Optional. Whether to reseed the floor upon arrival. Default is false. Set this to
+ *               true if you are warping to the same stage but a different stage type (or else the
+ *               floor layout will be identical to the old floor).
  */
 export declare function setStage(stage: LevelStage, stageType: StageType, reseed?: boolean): void;
 /**

package/dist/src/functions/stage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"stage.d.ts","sourceRoot":"","sources":["../../../src/functions/stage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAEL,UAAU,EACV,QAAQ,EACR,SAAS,EACV,MAAM,8BAA8B,CAAC;AAUtC;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CA6B/D;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CAmBzE;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,UAAU,CAS9C;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,CAAC,EAAE,UAAU,EAClB,SAAS,CAAC,EAAE,SAAS,GACpB,MAAM,CAaR;AAED;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,QAAQ,EAClB,WAAW,EAAE,GAAG,EAChB,iCAAiC,UAAQ,GACxC,MAAM,CAOR;AAED,6CAA6C;AAC7C,wBAAgB,QAAQ,IAAI,UAAU,CAIrC;AAED;;;;;;;;;GASG;AACH,wBAAgB,UAAU,CAAC,KAAK,CAAC,EAAE,UAAU,EAAE,SAAS,CAAC,EAAE,SAAS,GAAG,OAAO,CAa7E;AAED,iDAAiD;AACjD,wBAAgB,YAAY,IAAI,SAAS,CAIxC;AAED,8FAA8F;AAC9F,wBAAgB,SAAS,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,GAAG,IAAI,CAIvE;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAI/D;AAED;;;GAGG;AACH,wBAAgB,QAAQ,IAAI,OAAO,CAElC;AAED,wBAAgB,WAAW,IAAI,OAAO,CASrC;AAED,wBAAgB,OAAO,IAAI,OAAO,CASjC;AAED,wBAAgB,UAAU,IAAI,OAAO,CAQpC;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,eAAe,EAAE,UAAU,EAAE,GAAG,OAAO,CAG1E;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAUtC;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAKtC;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,IAAI,OAAO,CAK3C;AAED,wBAAgB,OAAO,IAAI,OAAO,CAQjC;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,GAAG,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,CAIxD;AAED,gGAAgG;AAChG,wBAAgB,eAAe,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAI1D;AAED,gGAAgG;AAChG,wBAAgB,cAAc,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAIzD;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,GAAG,UAAU,EAAE,SAAS,EAAE,GAAG,OAAO,CAI/D;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,IAAI,OAAO,CAMrD;AAED;;;GAGG;AACH,wBAAgB,gCAAgC,IAAI,OAAO,CAK1D;AAED;;;GAGG;AACH,wBAAgB,+BAA+B,IAAI,OAAO,CAKzD;AAED;;;GAGG;AACH,wBAAgB,gCAAgC,IAAI,OAAO,CAS1D;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,IAAI,OAAO,CAStD;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,IAAI,OAAO,CAQlD;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,UAAU,EACjB,SAAS,EAAE,SAAS,EACpB,MAAM,UAAQ,GACb,IAAI,CAUN;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,CAE9D"}
+{"version":3,"file":"stage.d.ts","sourceRoot":"","sources":["../../../src/functions/stage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAEL,UAAU,EACV,QAAQ,EACR,SAAS,EACV,MAAM,8BAA8B,CAAC;AAUtC;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CA6B/D;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CAmBzE;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,UAAU,CAS9C;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,CAAC,EAAE,UAAU,EAClB,SAAS,CAAC,EAAE,SAAS,GACpB,MAAM,CAaR;AAED;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,QAAQ,EAClB,WAAW,EAAE,GAAG,EAChB,iCAAiC,UAAQ,GACxC,MAAM,CAOR;AAED,6CAA6C;AAC7C,wBAAgB,QAAQ,IAAI,UAAU,CAIrC;AAED;;;;;;;;;GASG;AACH,wBAAgB,UAAU,CAAC,KAAK,CAAC,EAAE,UAAU,EAAE,SAAS,CAAC,EAAE,SAAS,GAAG,OAAO,CAa7E;AAED,iDAAiD;AACjD,wBAAgB,YAAY,IAAI,SAAS,CAIxC;AAED,8FAA8F;AAC9F,wBAAgB,SAAS,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,GAAG,IAAI,CAIvE;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,GAAG,OAAO,CAO7E;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAI/D;AAED;;;;;;;GAOG;AACH,wBAAgB,2BAA2B,CACzC,cAAc,EAAE,UAAU,GACzB,OAAO,CAKT;AAED;;;GAGG;AACH,wBAAgB,gCAAgC,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAE3E;AAED;;;GAGG;AACH,wBAAgB,+BAA+B,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAE1E;AAED;;;GAGG;AACH,wBAAgB,gCAAgC,CAC9C,KAAK,EAAE,UAAU,EACjB,SAAS,EAAE,SAAS,GACnB,OAAO,CAOT;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAC1C,KAAK,EAAE,UAAU,EACjB,SAAS,EAAE,SAAS,GACnB,OAAO,CAOT;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,CACxC,KAAK,EAAE,UAAU,EACjB,SAAS,EAAE,SAAS,GACnB,OAAO,CAOT;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAE/D;AAED;;;GAGG;AACH,wBAAgB,QAAQ,IAAI,OAAO,CAElC;AAED,wBAAgB,WAAW,IAAI,OAAO,CASrC;AAED,wBAAgB,OAAO,IAAI,OAAO,CASjC;AAED,wBAAgB,UAAU,IAAI,OAAO,CAQpC;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,eAAe,EAAE,UAAU,EAAE,GAAG,OAAO,CAG1E;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAMtC;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAKtC;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,IAAI,OAAO,CAK3C;AAED,wBAAgB,OAAO,IAAI,OAAO,CAQjC;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,GAAG,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,CAIxD;AAED,gGAAgG;AAChG,wBAAgB,eAAe,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAI1D;AAED,gGAAgG;AAChG,wBAAgB,cAAc,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAIzD;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,GAAG,UAAU,EAAE,SAAS,EAAE,GAAG,OAAO,CAI/D;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,IAAI,OAAO,CAGrD;AAED;;;GAGG;AACH,wBAAgB,gCAAgC,IAAI,OAAO,CAK1D;AAED;;;GAGG;AACH,wBAAgB,+BAA+B,IAAI,OAAO,CAKzD;AAED;;;GAGG;AACH,wBAAgB,gCAAgC,IAAI,OAAO,CAM1D;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,IAAI,OAAO,CAMtD;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,IAAI,OAAO,CAMpD;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,IAAI,OAAO,CAK9C;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,UAAU,EACjB,SAAS,EAAE,SAAS,EACpB,MAAM,UAAQ,GACb,IAAI,CAUN;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,CAE9D"}

package/dist/src/functions/stage.lua

@@ -156,6 +156,59 @@ function ____exports.goToStage(self, stage, stageType)
     local command = ("stage " .. tostring(stage)) .. stageTypeLetterSuffix
     Isaac.ExecuteCommand(command)
 end
+--- Returns whether the provided stage and stage type represent a "final floor". This is defined as a
+-- floor that prevents the player from entering the I AM ERROR room on.
+-- 
+-- For example, when using Undefined on The Chest, it has a 50% chance of teleporting the player to
+-- the Secret Room and a 50% chance of teleporting the player to the Super Secret Room, because the
+-- I AM ERROR room is never entered into the list of possibilities.
+function ____exports.isFinalFloor(self, stage, stageType)
+    return stage == LevelStage.DARK_ROOM_CHEST or stage == LevelStage.THE_VOID or stage == LevelStage.HOME or stage == LevelStage.WOMB_2 and ____exports.isRepentanceStage(nil, stageType)
+end
+--- Helper function to check if the provided effective stage is one that has the possibility to grant
+-- a natural Devil Room or Angel Room after killing the boss.
+-- 
+-- Note that in order for this function to work properly, you must provide it with the effective
+-- stage (e.g. from the `getEffectiveStage` helper function) and not the absolute stage (e.g. from
+-- the `Level.GetStage` method).
+function ____exports.isStageWithNaturalDevilRoom(self, effectiveStage)
+    return inRange(nil, effectiveStage, LevelStage.BASEMENT_2, LevelStage.WOMB_2) and effectiveStage ~= LevelStage.BLUE_WOMB
+end
+--- After defeating the boss on most stages, a random collectible will spawn from the Boss Room pool.
+-- However, this does not happen on Depths 2, Womb 2, and beyond.
+function ____exports.isStageWithRandomBossCollectible(self, stage)
+    return stage ~= LevelStage.DEPTHS_2 and stage < LevelStage.WOMB_2
+end
+--- Helper function to check if the provided stage will spawn a locked door to Downpour/Dross after
+-- defeating the boss.
+function ____exports.isStageWithSecretExitToDownpour(self, stage)
+    return stage == LevelStage.BASEMENT_1 or stage == LevelStage.BASEMENT_2
+end
+--- Helper function to check if the provided stage and stage type will spawn a spiked door to
+-- Mausoleum/Gehenna after defeating the boss.
+function ____exports.isStageWithSecretExitToMausoleum(self, stage, stageType)
+    local repentanceStage = ____exports.isRepentanceStage(nil, stageType)
+    return stage == LevelStage.DEPTHS_1 and not repentanceStage or stage == LevelStage.CAVES_2 and repentanceStage
+end
+--- Helper function to check if the provided stage and stage type will spawn a wooden door to
+-- Mines/Ashpit after defeating the boss.
+function ____exports.isStageWithSecretExitToMines(self, stage, stageType)
+    local repentanceStage = ____exports.isRepentanceStage(nil, stageType)
+    return stage == LevelStage.CAVES_1 and not repentanceStage or stage == LevelStage.BASEMENT_2 and repentanceStage
+end
+--- Helper function to check if the current stage is one that would create a trapdoor if We Need to
+-- Go Deeper was used.
+function ____exports.isStageWithShovelTrapdoors(self, stage, stageType)
+    local repentanceStage = ____exports.isRepentanceStage(nil, stageType)
+    return stage < LevelStage.WOMB_2 or stage == LevelStage.WOMB_2 and not repentanceStage
+end
+--- Helper function to check if the provided stage is one with a story boss. Specifically, this is
+-- Depths 2 (Mom), Womb 2 (Mom's Heart / It Lives), Blue Womb (Hush), Sheol (Satan), Cathedral
+-- (Isaac), Dark Room (Lamb), The Chest (Blue Baby), The Void (Delirium), and Home (Dogma / The
+-- Beast).
+function ____exports.isStageWithStoryBoss(self, stage)
+    return stage == LevelStage.DEPTHS_2 or stage >= LevelStage.WOMB_2
+end
 --- Helper function to check if the player has taken Dad's Note. This sets the game state flag of
 -- `GameStateFlag.BACKWARDS_PATH` and causes floor generation to change.
 function ____exports.onAscent(self)
@@ -188,8 +241,8 @@ function ____exports.onEffectiveStage(self, ...)
     local thisEffectiveStage = ____exports.getEffectiveStage(nil)
     return __TS__ArrayIncludes(effectiveStages, thisEffectiveStage)
 end
---- Returns whether or not the player is on the "final floor" of the particular run. The final floor
--- is defined as one that prevents the player from entering the I AM ERROR room on.
+--- Returns whether the player is on the "final floor" of the particular run. The final floor is
+-- defined as one that prevents the player from entering the I AM ERROR room on.
 -- 
 -- For example, when using Undefined on The Chest, it has a 50% chance of teleporting the player to
 -- the Secret Room and a 50% chance of teleporting the player to the Super Secret Room, because the
@@ -197,9 +250,10 @@ end
 function ____exports.onFinalFloor(self)
     local level = game:GetLevel()
     local stage = level:GetStage()
-    return stage == LevelStage.DARK_ROOM_CHEST or stage == LevelStage.THE_VOID or stage == LevelStage.HOME or stage == LevelStage.WOMB_2 and ____exports.onRepentanceStage(nil)
+    local stageType = level:GetStageType()
+    return ____exports.isFinalFloor(nil, stage, stageType)
 end
---- Returns whether or not the player is on the first floor of the particular run.
+--- Returns whether the player is on the first floor of the particular run.
 -- 
 -- This is tricky to determine because we have to handle the cases of Downpour/Dross 1 not being the
 -- first floor and The Ascent.
@@ -248,44 +302,54 @@ end
 -- Devil Room or Angel Room after killing the boss.
 function ____exports.onStageWithNaturalDevilRoom(self)
     local effectiveStage = ____exports.getEffectiveStage(nil)
-    return inRange(nil, effectiveStage, LevelStage.BASEMENT_2, LevelStage.WOMB_2) and effectiveStage ~= LevelStage.BLUE_WOMB
+    return ____exports.isStageWithNaturalDevilRoom(nil, effectiveStage)
 end
 --- After defeating the boss on most stages, a random collectible will spawn from the Boss Room pool.
 -- However, this does not happen on Depths 2, Womb 2, and beyond.
 function ____exports.onStageWithRandomBossCollectible(self)
     local level = game:GetLevel()
     local stage = level:GetStage()
-    return stage ~= LevelStage.DEPTHS_2 and stage < LevelStage.WOMB_2
+    return ____exports.isStageWithRandomBossCollectible(nil, stage)
 end
 --- Helper function to check if the current stage will spawn a locked door to Downpour/Dross after
 -- defeating the boss.
 function ____exports.onStageWithSecretExitToDownpour(self)
     local level = game:GetLevel()
     local stage = level:GetStage()
-    return stage == LevelStage.BASEMENT_1 or stage == LevelStage.BASEMENT_2
+    return ____exports.isStageWithSecretExitToDownpour(nil, stage)
 end
 --- Helper function to check if the current stage will spawn a spiked door to Mausoleum/Gehenna after
 -- defeating the boss.
 function ____exports.onStageWithSecretExitToMausoleum(self)
     local level = game:GetLevel()
     local stage = level:GetStage()
-    local repentanceStage = ____exports.onRepentanceStage(nil)
-    return stage == LevelStage.DEPTHS_1 and not repentanceStage or stage == LevelStage.CAVES_2 and repentanceStage
+    local stageType = level:GetStageType()
+    return ____exports.isStageWithSecretExitToMausoleum(nil, stage, stageType)
 end
 --- Helper function to check if the current stage will spawn a wooden door to Mines/Ashpit after
 -- defeating the boss.
 function ____exports.onStageWithSecretExitToMines(self)
     local level = game:GetLevel()
     local stage = level:GetStage()
-    local repentanceStage = ____exports.onRepentanceStage(nil)
-    return stage == LevelStage.CAVES_1 and not repentanceStage or stage == LevelStage.BASEMENT_2 and repentanceStage
+    local stageType = level:GetStageType()
+    return ____exports.isStageWithSecretExitToMines(nil, stage, stageType)
 end
 --- Helper function to check if the current stage is one that would create a trapdoor if We Need to
 -- Go Deeper was used.
-function ____exports.onStageWithShovelWorking(self)
+function ____exports.onStageWithShovelTrapdoors(self)
+    local level = game:GetLevel()
+    local stage = level:GetStage()
+    local stageType = level:GetStageType()
+    return ____exports.isStageWithShovelTrapdoors(nil, stage, stageType)
+end
+--- Helper function to check if the current stage is one with a story boss. Specifically, this is
+-- Depths 2 (Mom), Womb 2 (Mom's Heart / It Lives), Blue Womb (Hush), Sheol (Satan), Cathedral
+-- (Isaac), Dark Room (Lamb), The Chest (Blue Baby), The Void (Delirium), and Home (Dogma / The
+-- Beast).
+function ____exports.onStageWithStoryBoss(self)
     local level = game:GetLevel()
     local stage = level:GetStage()
-    return stage < LevelStage.WOMB_2 or stage == LevelStage.WOMB_2 and not ____exports.onRepentanceStage(nil)
+    return ____exports.isStageWithStoryBoss(nil, stage)
 end
 --- Helper function to warp to a new stage/level.
 -- 
@@ -294,9 +358,9 @@ end
 -- 
 -- @param stage The stage number to warp to.
 -- @param stageType The stage type to warp to.
--- @param reseed Optional. Whether or not to reseed the floor upon arrival. Default is false. Set
--- this to true if you are warping to the same stage but a different stage type (or
--- else the floor layout will be identical to the old floor).
+-- @param reseed Optional. Whether to reseed the floor upon arrival. Default is false. Set this to
+-- true if you are warping to the same stage but a different stage type (or else the
+-- floor layout will be identical to the old floor).
 function ____exports.setStage(self, stage, stageType, reseed)
     if reseed == nil then
         reseed = false

package/dist/src/functions/trinkets.d.ts

@@ -79,7 +79,7 @@ export declare function getTrinketName(trinketType: TrinketType): string;
  */
 export declare function getVanillaTrinketTypeRange(): TrinketType[];
 /**
- * Returns whether or not the player can hold an additional trinket, beyond what they are currently
+ * Returns whether the player can hold an additional trinket, beyond what they are currently
  * carrying. This takes into account items that modify the max number of trinkets, like Mom's Purse.
  *
  * If the player is the Tainted Soul, this always returns false, since that character cannot pick up

package/dist/src/functions/trinkets.lua

@@ -161,7 +161,7 @@ end
 function ____exports.getVanillaTrinketTypeRange(self)
     return iRange(nil, FIRST_TRINKET_TYPE, LAST_VANILLA_TRINKET_TYPE)
 end
---- Returns whether or not the player can hold an additional trinket, beyond what they are currently
+--- Returns whether the player can hold an additional trinket, beyond what they are currently
 -- carrying. This takes into account items that modify the max number of trinkets, like Mom's Purse.
 -- 
 -- If the player is the Tainted Soul, this always returns false, since that character cannot pick up

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "31.7.2",
+  "version": "31.8.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -25,6 +25,6 @@
   "main": "dist/src/index",
   "types": "dist/index.rollup.d.ts",
   "dependencies": {
-    "isaac-typescript-definitions": "^13.0.32"
+    "isaac-typescript-definitions": "^13.0.35"
   }
 }

package/src/classes/ModFeature.ts

@@ -82,7 +82,7 @@ export class ModFeature {
    *
    * ```ts
    * <T extends boolean>(
-   *   vanilla: T, // Whether or not this is a vanilla or custom callback.
+   *   vanilla: T, // Whether this is a vanilla or custom callback.
    *   modCallback: T extends true ? ModCallback : ModCallbackCustom,
    *   ...callbackArgs: unknown[] // This would be e.g. `pickup: EntityPickup` for the `POST_PICKUP_INIT` callback.
    * ) => boolean;
@@ -97,7 +97,7 @@ export class ModFeature {
     | null = null;
 
   /**
-   * Whether or not the feature has registered its callbacks yet.
+   * Whether the feature has registered its callbacks yet.
    *
    * This will almost always be equal to true unless you explicitly passed `false` to the second
    * argument of the constructor.

package/src/classes/callbacks/PostPlayerFatalDamage.ts

@@ -27,7 +27,7 @@ import { CustomCallback } from "../private/CustomCallback";
 
 const v = {
   run: {
-    /** Needed to detect if Glass Cannon will kill the player or not. */
+    /** Needed to detect if Glass Cannon will kill the player. */
     playersLastDamageGameFrame: new Map<PlayerIndex, int>(),
   },
 };

package/src/classes/callbacks/PostUsePillFilter.ts

@@ -26,8 +26,8 @@ const v = {
 /**
  * The vanilla `POST_USE_PILL` callback does not pass the `PillColor` of the used pill. We can
  * resolve pill effect to pill color by using the `ItemPool.GetPillEffect` method. However, this
- * does not tell us whether or not the pill used was a horse pill. Thus, we must keep track of the
- * pills that the player is holding on every frame to account for this.
+ * does not tell us whether the pill used was a horse pill. Thus, we must keep track of the pills
+ * that the player is holding on every frame to account for this.
  *
  * In some cases, pills can be used without a corresponding pocket item slot, like in the case of
  * the reverse Temperance card. In this case, we fall back to looking up the color using the

package/src/classes/features/callbackLogic/CustomGridEntities.ts

@@ -284,7 +284,7 @@ export class CustomGridEntities extends Feature {
    * @param gridIndexOrPositionOrGridEntity You can specify the custom grid entity to remove by
    *                                providing the grid index, the room position, or the grid entity
    *                                itself.
-   * @param updateRoom Optional. Whether or not to update the room after the grid entity is removed.
+   * @param updateRoom Optional. Whether to update the room after the grid entity is removed.
    *                   Default is true. This is generally a good idea because if the room is not
    *                   updated, you will be unable to spawn another grid entity on the same tile
    *                   until a frame has passed. However, doing this is expensive, since it involves

package/src/classes/features/other/CustomItemPools.ts

@@ -102,7 +102,7 @@ export class CustomItemPools extends Feature {
    * In order to use this function, you must upgrade your mod with `ISCFeature.CUSTOM_ITEM_POOLS`.
    *
    * @param itemPoolTypeCustom An integer representing the custom item pool to use.
-   * @param decrease Optional. Whether or not to remove the selected collectible from the item pool.
+   * @param decrease Optional. Whether to remove the selected collectible from the item pool.
    *                 Default is true.
    * @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided,
    *                  the `RNG.Next` method will be called. Default is `getRandomSeed()`.

package/src/classes/features/other/CustomTrapdoors.ts

@@ -732,8 +732,8 @@ export class CustomTrapdoors extends Feature {
    * @param anm2Path Optional. The path to the anm2 file to use. By default, the vanilla trapdoor
    *                 anm2 of "gfx/grid/door_11_trapdoor.anm2" will be used. The specified anm2 file
    *                 must have animations called "Opened", "Closed", and "Open Animation".
-   * @param spawnOpen Optional. Whether or not to spawn the trapdoor in an open state. By default,
-   *                  behavior will be used that emulates a vanilla trapdoor.
+   * @param spawnOpen Optional. Whether to spawn the trapdoor in an open state. By default, behavior
+   *                  will be used that emulates a vanilla trapdoor.
    */
   @Exported
   public spawnCustomTrapdoor(