isaacscript-common 31.8.0 → 31.8.1

package/dist/index.rollup.d.ts

@@ -8846,8 +8846,15 @@ export declare function isSpikes(variable: unknown): variable is GridEntitySpike
 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.
+ * Helper function to check if the provided stage is one that will have a random collectible drop
+ * upon defeating the boss of the floor.
+ *
+ * This happens on most stages but will not happen on Depths 2, Womb 2, Sheol, Cathedral, Dark Room,
+ * The Chest, and Home (due to the presence of a story boss).
+ *
+ * Note that even though Delirium does not drop a random boss collectible, The Void is still
+ * considered to be a stage that has a random boss collectible since all of the non-Delirium Boss
+ * Rooms will drop random boss collectibles.
  */
 export declare function isStageWithRandomBossCollectible(stage: LevelStage): boolean;
 
@@ -13551,8 +13558,15 @@ export declare function onStageType(...stageTypes: StageType[]): boolean;
 export declare function onStageWithNaturalDevilRoom(): 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.
+ * Helper function to check if the current stage is one that will have a random collectible drop
+ * upon defeating the boss of the floor.
+ *
+ * This happens on most stages but will not happen on Depths 2, Womb 2, Sheol, Cathedral, Dark Room,
+ * The Chest, and Home (due to the presence of a story boss).
+ *
+ * Note that even though Delirium does not drop a random boss collectible, The Void is still
+ * considered to be a stage that has a random boss collectible since all of the non-Delirium Boss
+ * Rooms will drop random boss collectibles.
  */
 export declare function onStageWithRandomBossCollectible(): boolean;
 

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 31.8.0
+isaacscript-common 31.8.1
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -27213,6 +27213,9 @@ local inRange = ____utils.inRange
 function ____exports.isRepentanceStage(self, stageType)
     return stageType == StageType.REPENTANCE or stageType == StageType.REPENTANCE_B
 end
+function ____exports.isStageWithStoryBoss(self, stage)
+    return stage == LevelStage.DEPTHS_2 or stage >= LevelStage.WOMB_2
+end
 function ____exports.onRepentanceStage(self)
     local level = game:GetLevel()
     local stageType = level:GetStageType()
@@ -27307,7 +27310,7 @@ function ____exports.isStageWithNaturalDevilRoom(self, effectiveStage)
     return inRange(nil, effectiveStage, LevelStage.BASEMENT_2, LevelStage.WOMB_2) and effectiveStage ~= LevelStage.BLUE_WOMB
 end
 function ____exports.isStageWithRandomBossCollectible(self, stage)
-    return stage ~= LevelStage.DEPTHS_2 and stage < LevelStage.WOMB_2
+    return not ____exports.isStageWithStoryBoss(nil, stage) or stage == LevelStage.THE_VOID
 end
 function ____exports.isStageWithSecretExitToDownpour(self, stage)
     return stage == LevelStage.BASEMENT_1 or stage == LevelStage.BASEMENT_2
@@ -27324,9 +27327,6 @@ 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
-function ____exports.isStageWithStoryBoss(self, stage)
-    return stage == LevelStage.DEPTHS_2 or stage >= LevelStage.WOMB_2
-end
 function ____exports.onAscent(self)
     return game:GetStateFlag(GameStateFlag.BACKWARDS_PATH)
 end

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

@@ -80,8 +80,15 @@ export declare function isRepentanceStage(stageType: StageType): boolean;
  */
 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.
+ * Helper function to check if the provided stage is one that will have a random collectible drop
+ * upon defeating the boss of the floor.
+ *
+ * This happens on most stages but will not happen on Depths 2, Womb 2, Sheol, Cathedral, Dark Room,
+ * The Chest, and Home (due to the presence of a story boss).
+ *
+ * Note that even though Delirium does not drop a random boss collectible, The Void is still
+ * considered to be a stage that has a random boss collectible since all of the non-Delirium Boss
+ * Rooms will drop random boss collectibles.
  */
 export declare function isStageWithRandomBossCollectible(stage: LevelStage): boolean;
 /**
@@ -170,8 +177,15 @@ export declare function onStageType(...stageTypes: StageType[]): boolean;
  */
 export declare function onStageWithNaturalDevilRoom(): 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.
+ * Helper function to check if the current stage is one that will have a random collectible drop
+ * upon defeating the boss of the floor.
+ *
+ * This happens on most stages but will not happen on Depths 2, Womb 2, Sheol, Cathedral, Dark Room,
+ * The Chest, and Home (due to the presence of a story boss).
+ *
+ * Note that even though Delirium does not drop a random boss collectible, The Void is still
+ * considered to be a stage that has a random boss collectible since all of the non-Delirium Boss
+ * Rooms will drop random boss collectibles.
  */
 export declare function onStageWithRandomBossCollectible(): boolean;
 /**

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;;;;;;;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"}
+{"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;;;;;;;;;;GAUG;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;;;;;;;;;;GAUG;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

@@ -28,6 +28,13 @@ local inRange = ____utils.inRange
 function ____exports.isRepentanceStage(self, stageType)
     return stageType == StageType.REPENTANCE or stageType == StageType.REPENTANCE_B
 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 current stage type is equal to `StageType.REPENTANCE` or
 -- `StageType.REPENTANCE_B`.
 function ____exports.onRepentanceStage(self)
@@ -174,10 +181,17 @@ end
 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.
+--- Helper function to check if the provided stage is one that will have a random collectible drop
+-- upon defeating the boss of the floor.
+-- 
+-- This happens on most stages but will not happen on Depths 2, Womb 2, Sheol, Cathedral, Dark Room,
+-- The Chest, and Home (due to the presence of a story boss).
+-- 
+-- Note that even though Delirium does not drop a random boss collectible, The Void is still
+-- considered to be a stage that has a random boss collectible since all of the non-Delirium Boss
+-- Rooms will drop random boss collectibles.
 function ____exports.isStageWithRandomBossCollectible(self, stage)
-    return stage ~= LevelStage.DEPTHS_2 and stage < LevelStage.WOMB_2
+    return not ____exports.isStageWithStoryBoss(nil, stage) or stage == LevelStage.THE_VOID
 end
 --- Helper function to check if the provided stage will spawn a locked door to Downpour/Dross after
 -- defeating the boss.
@@ -202,13 +216,6 @@ 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)
@@ -304,8 +311,15 @@ function ____exports.onStageWithNaturalDevilRoom(self)
     local effectiveStage = ____exports.getEffectiveStage(nil)
     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.
+--- Helper function to check if the current stage is one that will have a random collectible drop
+-- upon defeating the boss of the floor.
+-- 
+-- This happens on most stages but will not happen on Depths 2, Womb 2, Sheol, Cathedral, Dark Room,
+-- The Chest, and Home (due to the presence of a story boss).
+-- 
+-- Note that even though Delirium does not drop a random boss collectible, The Void is still
+-- considered to be a stage that has a random boss collectible since all of the non-Delirium Boss
+-- Rooms will drop random boss collectibles.
 function ____exports.onStageWithRandomBossCollectible(self)
     local level = game:GetLevel()
     local stage = level:GetStage()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "31.8.0",
+  "version": "31.8.1",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",

package/src/functions/stage.ts

@@ -233,11 +233,18 @@ export function isStageWithNaturalDevilRoom(
 }
 
 /**
- * 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.
+ * Helper function to check if the provided stage is one that will have a random collectible drop
+ * upon defeating the boss of the floor.
+ *
+ * This happens on most stages but will not happen on Depths 2, Womb 2, Sheol, Cathedral, Dark Room,
+ * The Chest, and Home (due to the presence of a story boss).
+ *
+ * Note that even though Delirium does not drop a random boss collectible, The Void is still
+ * considered to be a stage that has a random boss collectible since all of the non-Delirium Boss
+ * Rooms will drop random boss collectibles.
  */
 export function isStageWithRandomBossCollectible(stage: LevelStage): boolean {
-  return stage !== LevelStage.DEPTHS_2 && stage < LevelStage.WOMB_2;
+  return !isStageWithStoryBoss(stage) || stage === LevelStage.THE_VOID;
 }
 
 /**
@@ -453,8 +460,15 @@ export function onStageWithNaturalDevilRoom(): 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.
+ * Helper function to check if the current stage is one that will have a random collectible drop
+ * upon defeating the boss of the floor.
+ *
+ * This happens on most stages but will not happen on Depths 2, Womb 2, Sheol, Cathedral, Dark Room,
+ * The Chest, and Home (due to the presence of a story boss).
+ *
+ * Note that even though Delirium does not drop a random boss collectible, The Void is still
+ * considered to be a stage that has a random boss collectible since all of the non-Delirium Boss
+ * Rooms will drop random boss collectibles.
  */
 export function onStageWithRandomBossCollectible(): boolean {
   const level = game.GetLevel();