isaacscript-common 28.3.0 → 28.4.0

package/dist/index.rollup.d.ts

@@ -12803,6 +12803,12 @@ 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.
+ */
+export declare function onStageWithRandomBossCollectible(): boolean;
+
 /**
  * Helper function to check if the current stage will spawn a locked door to Downpour/Dross after
  * defeating the boss.
@@ -12821,6 +12827,12 @@ export declare function onStageWithSecretExitToMausoleum(): boolean;
  */
 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;
+
 /**
  * For the purposes of this function, doors to Secret Rooms or Super Secret Rooms that have not been
  * discovered yet will not be opened.

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 28.3.0
+isaacscript-common 28.4.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -26984,6 +26984,11 @@ function ____exports.onStageWithNaturalDevilRoom(self)
     local effectiveStage = ____exports.getEffectiveStage(nil)
     return inRange(nil, effectiveStage, LevelStage.BASEMENT_2, LevelStage.WOMB_2) and effectiveStage ~= LevelStage.BLUE_WOMB
 end
+function ____exports.onStageWithRandomBossCollectible(self)
+    local level = game:GetLevel()
+    local stage = level:GetStage()
+    return stage ~= LevelStage.DEPTHS_2 and stage < LevelStage.WOMB_2
+end
 function ____exports.onStageWithSecretExitToDownpour(self)
     local level = game:GetLevel()
     local stage = level:GetStage()
@@ -27001,6 +27006,11 @@ function ____exports.onStageWithSecretExitToMines(self)
     local repentanceStage = ____exports.onRepentanceStage(nil)
     return stage == LevelStage.CAVES_1 and not repentanceStage or stage == LevelStage.BASEMENT_2 and repentanceStage
 end
+function ____exports.onStageWithShovelWorking(self)
+    local level = game:GetLevel()
+    local stage = level:GetStage()
+    return stage < LevelStage.WOMB_2 or stage == LevelStage.WOMB_2 and not ____exports.onRepentanceStage(nil)
+end
 function ____exports.setStage(self, stage, stageType, reseed)
     if reseed == nil then
         reseed = false

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

@@ -114,6 +114,11 @@ export declare function onStageType(...stageTypes: StageType[]): boolean;
  * Devil Room or Angel Room after killing the boss.
  */
 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.
+ */
+export declare function onStageWithRandomBossCollectible(): boolean;
 /**
  * Helper function to check if the current stage will spawn a locked door to Downpour/Dross after
  * defeating the boss.
@@ -129,6 +134,11 @@ export declare function onStageWithSecretExitToMausoleum(): boolean;
  * defeating the boss.
  */
 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;
 /**
  * Helper function to warp to a new stage/level.
  *

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,EAEL,UAAU,EACV,QAAQ,EACR,OAAO,EACP,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,CAK1E;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;;;;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,+BAA+B,IAAI,OAAO,CAKzD;AAED;;;GAGG;AACH,wBAAgB,gCAAgC,IAAI,OAAO,CAS1D;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,IAAI,OAAO,CAStD;AAED;;;;;;;;GAQG;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,EAEL,UAAU,EACV,QAAQ,EACR,OAAO,EACP,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,CAK1E;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;;;;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;;;;;;;;GAQG;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

@@ -247,6 +247,13 @@ function ____exports.onStageWithNaturalDevilRoom(self)
     local effectiveStage = ____exports.getEffectiveStage(nil)
     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.onStageWithRandomBossCollectible(self)
+    local level = game:GetLevel()
+    local stage = level:GetStage()
+    return stage ~= LevelStage.DEPTHS_2 and stage < LevelStage.WOMB_2
+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)
@@ -270,6 +277,13 @@ function ____exports.onStageWithSecretExitToMines(self)
     local repentanceStage = ____exports.onRepentanceStage(nil)
     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.onStageWithShovelWorking(self)
+    local level = game:GetLevel()
+    local stage = level:GetStage()
+    return stage < LevelStage.WOMB_2 or stage == LevelStage.WOMB_2 and not ____exports.onRepentanceStage(nil)
+end
 --- Helper function to warp to a new stage/level.
 -- 
 -- @param stage The stage number to warp to.

package/package.json

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

package/src/functions/stage.ts

@@ -339,6 +339,17 @@ 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.
+ */
+export function onStageWithRandomBossCollectible(): boolean {
+  const level = game.GetLevel();
+  const stage = level.GetStage();
+
+  return stage !== LevelStage.DEPTHS_2 && stage < LevelStage.WOMB_2;
+}
+
 /**
  * Helper function to check if the current stage will spawn a locked door to Downpour/Dross after
  * defeating the boss.
@@ -380,6 +391,20 @@ export 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 function onStageWithShovelWorking(): boolean {
+  const level = game.GetLevel();
+  const stage = level.GetStage();
+
+  return (
+    stage < LevelStage.WOMB_2 ||
+    (stage === LevelStage.WOMB_2 && !onRepentanceStage())
+  );
+}
+
 /**
  * Helper function to warp to a new stage/level.
  *