isaacscript-common 82.0.2 → 83.1.0

package/src/functions/stage.ts

@@ -1,14 +1,17 @@
-import type { StageID } from "isaac-typescript-definitions";
 import {
   GameStateFlag,
   LevelStage,
   RoomType,
+  StageID,
   StageType,
 } from "isaac-typescript-definitions";
 import { game } from "../core/cachedClasses";
-import { LEVEL_NAMES } from "../objects/levelNames";
 import { ROOM_TYPE_SPECIAL_GOTO_PREFIXES } from "../objects/roomTypeSpecialGotoPrefixes";
-import { STAGE_TO_STAGE_ID } from "../objects/stageToStageID";
+import { STAGE_ID_NAMES } from "../objects/stageIDNames";
+import {
+  STAGE_TO_STAGE_ID,
+  STAGE_TO_STAGE_ID_GREED_MODE,
+} from "../objects/stageToStageID";
 import { STAGE_TYPE_SUFFIXES } from "../objects/stageTypeSuffixes";
 import { log } from "./log";
 import { asLevelStage } from "./types";
@@ -138,8 +141,34 @@ export function getLevelName(
     stageType = level.GetStageType();
   }
 
-  const stageNames = LEVEL_NAMES[stage];
-  return stageNames[stageType];
+  const stageID = getStageID(stage, stageType);
+  const stageIDName = getStageIDName(stageID);
+
+  let suffix: string;
+  switch (stage) {
+    case LevelStage.BASEMENT_1:
+    case LevelStage.CAVES_1:
+    case LevelStage.DEPTHS_1:
+    case LevelStage.WOMB_1: {
+      suffix = " 1";
+      break;
+    }
+
+    case LevelStage.BASEMENT_2:
+    case LevelStage.CAVES_2:
+    case LevelStage.DEPTHS_2:
+    case LevelStage.WOMB_2: {
+      suffix = " 2";
+      break;
+    }
+
+    default: {
+      suffix = "";
+      break;
+    }
+  }
+
+  return stageIDName + suffix;
 }
 
 /** Alias for the `Level.GetStage` method. */
@@ -150,9 +179,13 @@ export function getStage(): LevelStage {
 }
 
 /**
- * Helper function to get the stage ID that corresponds to a particular floor. It does this by
- * manually converting `LevelStage` and `StageType` into `StageID`. This is useful because
- * `getRoomStageID` will not correctly return the `StageID` if the player is in a special room.
+ * Helper function to get the stage ID that corresponds to a particular stage and stage type.
+ *
+ * This is useful because `getRoomStageID` will not correctly return the `StageID` if the player is
+ * in a special room.
+ *
+ * This correctly handles the case of Greed Mode. In Greed Mode, if an undefined stage and stage
+ * type combination are passed, `StageID.SPECIAL_ROOMS` (0) will be returned.
  *
  * @param stage Optional. If not specified, the stage corresponding to the current floor will be
  *              used.
@@ -170,10 +203,31 @@ export function getStageID(stage?: LevelStage, stageType?: StageType): StageID {
     stageType = level.GetStageType();
   }
 
+  if (game.IsGreedMode()) {
+    const stageTypeToStageID = STAGE_TO_STAGE_ID_GREED_MODE.get(stage);
+    if (stageTypeToStageID === undefined) {
+      return StageID.SPECIAL_ROOMS;
+    }
+
+    return stageTypeToStageID[stageType];
+  }
+
   const stageTypeToStageID = STAGE_TO_STAGE_ID[stage];
   return stageTypeToStageID[stageType];
 }
 
+/**
+ * Helper function to get the English name corresponding to a stage ID. For example, "Caves".
+ *
+ * This is derived from the data in the "stages.xml" file.
+ *
+ * Note that unlike "stages.xml", Blue Womb is specified with a name of "Blue Womb" instead of
+ * "???".
+ */
+export function getStageIDName(stageID: StageID): string {
+  return STAGE_ID_NAMES[stageID];
+}
+
 /** Alias for the `Level.GetStageType` method. */
 export function getStageType(): StageType {
   const level = game.GetLevel();

package/src/objects/stageIDNames.ts

@@ -0,0 +1,41 @@
+import { StageID } from "isaac-typescript-definitions";
+
+/**
+ * Derived from "stages.xml". Note that unlike "stages.xml":
+ *
+ * - `StageID.BLUE_WOMB` (13) is specified with a name of "Blue Womb" instead of "???".
+ * - `StageID.StageID.BACKWARDS` (36) is specified with a name of "The Ascent" instead of "???".
+ */
+export const STAGE_ID_NAMES = {
+  [StageID.SPECIAL_ROOMS]: "Special Rooms", // 0
+  [StageID.BASEMENT]: "Basement", // 1
+  [StageID.CELLAR]: "Cellar", // 2
+  [StageID.BURNING_BASEMENT]: "Burning Basement", // 3
+  [StageID.CAVES]: "Caves", // 4
+  [StageID.CATACOMBS]: "Catacombs", // 5
+  [StageID.FLOODED_CAVES]: "Flooded Caves", // 6
+  [StageID.DEPTHS]: "Depths", // 7
+  [StageID.NECROPOLIS]: "Necropolis", // 8
+  [StageID.DANK_DEPTHS]: "Dank Depths", // 9
+  [StageID.WOMB]: "Womb", // 10
+  [StageID.UTERO]: "Utero", // 11
+  [StageID.SCARRED_WOMB]: "Scarred Womb", // 12
+  [StageID.BLUE_WOMB]: "Blue Womb", // 13
+  [StageID.SHEOL]: "Sheol", // 14
+  [StageID.CATHEDRAL]: "Cathedral", // 15
+  [StageID.DARK_ROOM]: "Dark Room", // 16
+  [StageID.CHEST]: "Chest", // 17
+  [StageID.SHOP]: "The Shop", // 24
+  [StageID.ULTRA_GREED]: "Ultra Greed", // 25
+  [StageID.VOID]: "The Void", // 26
+  [StageID.DOWNPOUR]: "Downpour", // 27
+  [StageID.DROSS]: "Dross", // 28
+  [StageID.MINES]: "Mines", // 29
+  [StageID.ASHPIT]: "Ashpit", // 30
+  [StageID.MAUSOLEUM]: "Mausoleum", // 31
+  [StageID.GEHENNA]: "Gehenna", // 32
+  [StageID.CORPSE]: "Corpse", // 33
+  [StageID.MORTIS]: "Mortis", // 34
+  [StageID.HOME]: "Home", // 35
+  [StageID.BACKWARDS]: "The Ascent", // 36
+} as const satisfies Record<StageID, string>;

package/src/objects/stageToStageID.ts

@@ -1,4 +1,5 @@
 import { LevelStage, StageID, StageType } from "isaac-typescript-definitions";
+import { ReadonlyMap } from "../types/ReadonlyMap";
 
 const BASEMENT_TO_STAGE_ID = {
   [StageType.ORIGINAL]: StageID.BASEMENT, // 0
@@ -95,4 +96,35 @@ export const STAGE_TO_STAGE_ID = {
   [LevelStage.DARK_ROOM_CHEST]: DARK_ROOM_CHEST_TO_STAGE_ID, // 11
   [LevelStage.VOID]: VOID_TO_STAGE_ID, // 12
   [LevelStage.HOME]: HOME_TO_STAGE_ID, // 13
-} as const satisfies Record<LevelStage, unknown>;
+} as const satisfies Record<LevelStage, Record<StageType, StageID>>;
+
+const SHOP_TO_STAGE_ID = {
+  [StageType.ORIGINAL]: StageID.SHOP, // 0
+  [StageType.WRATH_OF_THE_LAMB]: StageID.SHOP, // 1
+  [StageType.AFTERBIRTH]: StageID.SHOP, // 2
+  [StageType.GREED_MODE]: StageID.SHOP, // 3
+  [StageType.REPENTANCE]: StageID.SHOP, // 4
+  [StageType.REPENTANCE_B]: StageID.SHOP, // 5
+} as const satisfies Record<StageType, StageID>;
+
+const ULTRA_GREED_TO_STAGE_ID = {
+  [StageType.ORIGINAL]: StageID.ULTRA_GREED, // 0
+  [StageType.WRATH_OF_THE_LAMB]: StageID.ULTRA_GREED, // 1
+  [StageType.AFTERBIRTH]: StageID.ULTRA_GREED, // 2
+  [StageType.GREED_MODE]: StageID.ULTRA_GREED, // 3
+  [StageType.REPENTANCE]: StageID.ULTRA_GREED, // 4
+  [StageType.REPENTANCE_B]: StageID.ULTRA_GREED, // 5
+} as const satisfies Record<StageType, StageID>;
+
+export const STAGE_TO_STAGE_ID_GREED_MODE = new ReadonlyMap<
+  LevelStage,
+  Record<StageType, StageID>
+>([
+  [LevelStage.BASEMENT_GREED_MODE, BASEMENT_TO_STAGE_ID], // 1
+  [LevelStage.CAVES_GREED_MODE, CAVES_TO_STAGE_ID], // 2
+  [LevelStage.DEPTHS_GREED_MODE, DEPTHS_TO_STAGE_ID], // 3
+  [LevelStage.WOMB_GREED_MODE, WOMB_TO_STAGE_ID], // 4
+  [LevelStage.SHEOL_GREED_MODE, SHEOL_CATHEDRAL_TO_STAGE_ID], // 5
+  [LevelStage.SHOP_GREED_MODE, SHOP_TO_STAGE_ID], // 6
+  [LevelStage.ULTRA_GREED_GREED_MODE, ULTRA_GREED_TO_STAGE_ID], // 7
+]);

package/src/objects/versusScreenBackgroundColors.ts

@@ -30,14 +30,8 @@ export const VERSUS_SCREEN_BACKGROUND_COLORS = {
   [StageID.CATHEDRAL]: newReadonlyColor(6 / 255, 13 / 255, 17 / 255), // 15
   [StageID.DARK_ROOM]: newReadonlyColor(9 / 255, 4 / 255, 3 / 255), // 16
   [StageID.CHEST]: newReadonlyColor(15 / 255, 9 / 255, 6 / 255), // 17
-  [StageID.SPECIAL_ROOMS_GREED_MODE]: DEFAULT_COLOR, // 18
-  [StageID.BASEMENT_GREED_MODE]: BASEMENT_COLOR, // 19
-  [StageID.CAVES_GREED_MODE]: CAVES_COLOR, // 20
-  [StageID.DEPTHS_GREED_MODE]: DEPTHS_COLOR, // 21
-  [StageID.WOMB_GREED_MODE]: WOMB_COLOR, // 22
-  [StageID.SHEOL_GREED_MODE]: SHEOL_COLOR, // 23
-  [StageID.SHOP_GREED_MODE]: DEFAULT_COLOR, // 24
-  [StageID.ULTRA_GREED_GREED_MODE]: DEFAULT_COLOR, // 25
+  [StageID.SHOP]: DEFAULT_COLOR, // 24
+  [StageID.ULTRA_GREED]: DEFAULT_COLOR, // 25
   [StageID.VOID]: newReadonlyColor(0, 0, 0), // 26
   [StageID.DOWNPOUR]: newReadonlyColor(29 / 255, 30 / 255, 32 / 255), // 27
   [StageID.DROSS]: newReadonlyColor(35 / 255, 35 / 255, 29 / 255), // 28

package/src/objects/versusScreenDirtSpotColors.ts

@@ -30,14 +30,8 @@ export const VERSUS_SCREEN_DIRT_SPOT_COLORS = {
   [StageID.CATHEDRAL]: newReadonlyColor(44 / 255, 100 / 255, 111 / 255), // 15
   [StageID.DARK_ROOM]: newReadonlyColor(80 / 255, 38 / 255, 20 / 255), // 16
   [StageID.CHEST]: newReadonlyColor(175 / 255, 108 / 255, 72 / 255), // 17
-  [StageID.SPECIAL_ROOMS_GREED_MODE]: DEFAULT_COLOR, // 18
-  [StageID.BASEMENT_GREED_MODE]: BASEMENT_COLOR, // 19
-  [StageID.CAVES_GREED_MODE]: CAVES_COLOR, // 20
-  [StageID.DEPTHS_GREED_MODE]: DEPTHS_COLOR, // 21
-  [StageID.WOMB_GREED_MODE]: WOMB_COLOR, // 22
-  [StageID.SHEOL_GREED_MODE]: SHEOL_COLOR, // 23
-  [StageID.SHOP_GREED_MODE]: DEFAULT_COLOR, // 24
-  [StageID.ULTRA_GREED_GREED_MODE]: DEFAULT_COLOR, // 25
+  [StageID.SHOP]: DEFAULT_COLOR, // 24
+  [StageID.ULTRA_GREED]: DEFAULT_COLOR, // 25
   [StageID.VOID]: newReadonlyColor(70 / 255, 5 / 255, 5 / 255), // 26
   [StageID.DOWNPOUR]: newReadonlyColor(149 / 255, 157 / 255, 167 / 255), // 27
   [StageID.DROSS]: newReadonlyColor(179 / 255, 179 / 255, 143 / 255), // 28