feat(common): onStageWithStoryBoss

IsaacScript · Sep 1, 2023 · 81e469d · 81e469d
1 parent f944f59
commit 81e469d
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/packages/isaacscript-common/src/functions/stage.ts b/packages/isaacscript-common/src/functions/stage.ts
@@ -417,6 +417,16 @@ export function onStageWithShovelWorking(): 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 function onStageWithStoryBoss(): boolean {
+  return onStage(LevelStage.DEPTHS_2) || onStageOrHigher(LevelStage.WOMB_2);
+}
+
 /**
  * Helper function to warp to a new stage/level.
  *