isaacscript-common 21.5.2 → 21.6.0

package/src/classes/callbacks/PreRoomEntitySpawnFilter.ts

@@ -22,7 +22,6 @@ export class PreRoomEntitySpawnFilter extends CustomCallback<T> {
     ];
   }
 
-  // eslint-disable-next-line class-methods-use-this
   protected override shouldFire = (
     fireArgs: FireArgs<T>,
     optionalArgs: OptionalArgs<T>,

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

@@ -127,8 +127,12 @@ export class CustomItemPools extends Feature {
       customItemPool,
       seedOrRNG,
     );
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-    const tuple = customItemPool[randomIndex]!;
+    const tuple = customItemPool[randomIndex];
+    if (tuple === undefined) {
+      error(
+        `Failed to get an element from a custom item pool using a random index of: ${randomIndex}`,
+      );
+    }
 
     if (decrease) {
       arrayRemoveIndexInPlace(customItemPool, randomIndex);

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

@@ -40,7 +40,6 @@ export class RunInNFrames extends Feature {
     },
   };
 
-  // eslint-disable-next-line class-methods-use-this
   public override vConditionalFunc = (): boolean => false;
 
   private roomHistory: RoomHistory;

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

@@ -11,7 +11,6 @@ export class RunNextRoom extends Feature {
     },
   };
 
-  // eslint-disable-next-line class-methods-use-this
   public override vConditionalFunc = (): boolean => false;
 
   /** @internal */

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

@@ -31,7 +31,6 @@ export class TaintedLazarusPlayers extends Feature {
     },
   };
 
-  // eslint-disable-next-line class-methods-use-this
   public override vConditionalFunc = (): boolean => false;
 
   /** @internal */

package/src/classes/features/other/customStages/backdrop.ts

@@ -36,12 +36,12 @@ enum BackdropKind {
 }
 
 /** This is created by the vanilla Basement files. */
-const DEFAULT_BACKDROP: NonNullable<CustomStage["backdropPNGPaths"]> = {
+const DEFAULT_BACKDROP = {
   nFloors: [`${ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH}/backdrop/nfloor.png`],
   lFloors: [`${ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH}/backdrop/lfloor.png`], // cspell:ignore lfloor
   walls: [`${ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH}/backdrop/wall.png`],
   corners: [`${ISAACSCRIPT_CUSTOM_STAGE_GFX_PATH}/backdrop/corner.png`],
-} as const;
+} as const satisfies NonNullable<CustomStage["backdropPNGPaths"]>;
 
 const ROOM_SHAPE_WALL_ANM2_LAYERS = {
   [RoomShape.SHAPE_1x1]: 44, // 1
@@ -58,16 +58,18 @@ const ROOM_SHAPE_WALL_ANM2_LAYERS = {
   [RoomShape.LBR]: 63, // 12
 } as const satisfies Record<RoomShape, int>;
 
-const ROOM_SHAPE_WALL_EXTRA_ANM2_LAYERS: {
-  readonly [Key in RoomShape]?: int;
-} = {
+// We don't use `as const` since we need the object to be indexable by all `RoomShape`.
+// eslint-disable-next-line isaacscript/require-capital-const-assertions
+const ROOM_SHAPE_WALL_EXTRA_ANM2_LAYERS: Readonly<
+  Partial<Record<RoomShape, int>>
+> = {
   [RoomShape.SHAPE_2x1]: 7, // 6
   [RoomShape.SHAPE_2x2]: 21, // 8
   [RoomShape.LTL]: 19, // 9
   [RoomShape.LTR]: 19, // 10
   [RoomShape.LBL]: 19, // 11
   [RoomShape.LBR]: 19, // 12
-} as const;
+};
 
 const WALL_OFFSET = Vector(-80, -80);
 
@@ -177,8 +179,7 @@ function spawnWallEntity(
   wallEffect.SpriteOffset = modifiedOffset;
 
   sprite.LoadGraphics();
-  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-  const roomShapeName = RoomShape[roomShape]!;
+  const roomShapeName = RoomShape[roomShape];
   const animation = trimPrefix(roomShapeName, "SHAPE_");
   const modifiedAnimation = isExtraWall ? `${animation}X` : animation;
   sprite.Play(modifiedAnimation, true);
@@ -252,8 +253,7 @@ function spawnFloorEntity(customStage: CustomStage, rng: RNG) {
   floorEffect.SpriteOffset = modifiedOffset;
 
   sprite.LoadGraphics();
-  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-  const roomShapeName = RoomShape[roomShape]!;
+  const roomShapeName = RoomShape[roomShape];
   const animation = trimPrefix(roomShapeName, "SHAPE_");
   sprite.Play(animation, true);
 }

package/src/classes/private/CustomCallback.ts

@@ -81,7 +81,6 @@ export abstract class CustomCallback<
    * This method needs to be overwritten for any callback that has optional filtration arguments.
    * See "shouldFire.ts" for methods tailored to specific kinds of callbacks.
    */
-  // eslint-disable-next-line class-methods-use-this
   protected shouldFire: (
     fireArgs: FireArgs<T>,
     optionalArgs: OptionalArgs<T>,

package/src/functions/modFeatures.ts

@@ -25,7 +25,7 @@ import { ModUpgraded } from "../classes/ModUpgraded";
 export function initModFeatures<T extends ReadonlyArray<typeof ModFeature>>(
   mod: ModUpgraded,
   modFeatures: T,
-): { [Key in keyof T]: InstanceType<T[Key]> } {
+): { [K in keyof T]: InstanceType<T[K]> } {
   const instantiatedModFeatures: ModFeature[] = [];
 
   for (const modFeature of modFeatures) {
@@ -36,5 +36,5 @@ export function initModFeatures<T extends ReadonlyArray<typeof ModFeature>>(
     instantiatedModFeatures.push(instantiatedModFeature);
   }
 
-  return instantiatedModFeatures as { [Key in keyof T]: InstanceType<T[Key]> };
+  return instantiatedModFeatures as { [K in keyof T]: InstanceType<T[K]> };
 }

package/src/functions/stage.ts

@@ -2,11 +2,13 @@ import {
   GameStateFlag,
   LevelStage,
   RoomType,
+  StageID,
   StageType,
 } from "isaac-typescript-definitions";
 import { game } from "../core/cachedClasses";
 import { ENGLISH_LEVEL_NAMES } from "../objects/englishLevelNames";
 import { ROOM_TYPE_GOTO_PREFIXES } from "../objects/roomTypeGotoPrefixes";
+import { STAGE_TO_STAGE_ID } from "../objects/stageToStageID";
 import { STAGE_TYPE_SUFFIXES } from "../objects/stageTypeSuffixes";
 import { STAGE_TYPE_TO_LETTER } from "../objects/stageTypeToLetter";
 import { asLevelStage, asNumber } from "./types";
@@ -88,7 +90,6 @@ export function getEffectiveStage(): LevelStage {
   return stage;
 }
 
-// eslint-disable-next-line isaacscript/complete-sentences-jsdoc
 /**
  * Helper function to get the English name of the level. For example, "Caves 1".
  *
@@ -134,6 +135,31 @@ export function getStage(): LevelStage {
   return level.GetStage();
 }
 
+/**
+ * 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.
+ *
+ * @param stage Optional. If not specified, the stage corresponding to the current floor will be
+ *              used.
+ * @param stageType Optional. If not specified, the stage type corresponding to the current floor
+ *                  will be used.
+ */
+export function getStageID(stage?: LevelStage, stageType?: StageType): StageID {
+  const level = game.GetLevel();
+
+  if (stage === undefined) {
+    stage = level.GetStage();
+  }
+
+  if (stageType === undefined) {
+    stageType = level.GetStageType();
+  }
+
+  const stageTypeToStageID = STAGE_TO_STAGE_ID[stage];
+  return stageTypeToStageID[stageType];
+}
+
 /** Alias for the `Level.GetStageType` method. */
 export function getStageType(): StageType {
   const level = game.GetLevel();

package/src/functions/weighted.ts

@@ -13,8 +13,14 @@ export function getRandomFromWeightedArray<T>(
   seedOrRNG: Seed | RNG = getRandomSeed(),
 ): T {
   const randomIndex = getRandomIndexFromWeightedArray(weightedArray, seedOrRNG);
-  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-  const randomElement = weightedArray[randomIndex]!;
+
+  const randomElement = weightedArray[randomIndex];
+  if (randomElement === undefined) {
+    error(
+      `Failed to get an element from a weighted array using a random index of: ${randomIndex}`,
+    );
+  }
+
   return randomElement[0];
 }
 

package/src/interfaces/CustomStageTSConfig.ts

@@ -548,7 +548,6 @@ export interface CustomStageBossPoolEntry {
 
   /** Optional. A collection of sprites used for the boss on the "versus" screen. */
   versusScreen?: {
-    // eslint-disable-next-line isaacscript/complete-sentences-jsdoc
     /**
      * Mandatory. The full path to the spritesheet that contains the graphics of the name of the
      * boss that will be displayed on the top of the boss "versus" screen.
@@ -557,7 +556,6 @@ export interface CustomStageBossPoolEntry {
      */
     namePNGPath: string;
 
-    // eslint-disable-next-line isaacscript/complete-sentences-jsdoc
     /**
      * Mandatory. The full path to the spritesheet that contains the portrait of the boss that will
      * be displayed on the right side of the boss "versus" screen.

package/src/objects/LRoomShapeToRectangles.ts

@@ -15,10 +15,11 @@ const TWO_BY_TWO_BOTTOM_RIGHT = newReadonlyVector(25, 13);
  * "Vector(0, 0)" corresponds to the top left tile of a room, not including the walls. (The top-left
  * wall would be at "Vector(-1, -1)".)
  */
-// We need to specify the type so that the object will be indexable by room shapes.
-export const L_ROOM_SHAPE_TO_RECTANGLES: {
-  readonly [Key in RoomShape]?: LRoomRectangles;
-} = {
+// We don't use `as const` since we need the object to be indexable by all `RoomShape`.
+// eslint-disable-next-line isaacscript/require-capital-const-assertions
+export const L_ROOM_SHAPE_TO_RECTANGLES: Readonly<
+  Partial<Record<RoomShape, LRoomRectangles>>
+> = {
   // 9
   [RoomShape.LTL]: {
     verticalTopLeft: newReadonlyVector(13, 0),
@@ -50,4 +51,4 @@ export const L_ROOM_SHAPE_TO_RECTANGLES: {
     horizontalTopLeft: VectorZero,
     horizontalBottomRight: newReadonlyVector(12, 13),
   },
-} as const;
+};

package/src/objects/englishLevelNames.ts

@@ -1,6 +1,5 @@
 import { LevelStage, StageType } from "isaac-typescript-definitions";
 
-// eslint-disable-next-line isaacscript/complete-sentences-jsdoc
 /**
  * A mapping of stage and stage types to the corresponding English level name.
  *
@@ -9,11 +8,7 @@ import { LevelStage, StageType } from "isaac-typescript-definitions";
  *
  * Note that this contains "Blue Womb" instead of "???" for stage 9.
  */
-export const ENGLISH_LEVEL_NAMES: {
-  readonly [levelStage in LevelStage]: {
-    readonly [stageType in StageType]: string;
-  };
-} = {
+export const ENGLISH_LEVEL_NAMES = {
   [LevelStage.BASEMENT_1]: {
     [StageType.ORIGINAL]: "Basement 1",
     [StageType.WRATH_OF_THE_LAMB]: "Cellar 1",
@@ -118,4 +113,4 @@ export const ENGLISH_LEVEL_NAMES: {
     [StageType.REPENTANCE]: "Home",
     [StageType.REPENTANCE_B]: "Home",
   },
-} as const;
+} as const satisfies Record<LevelStage, Record<StageType, string>>;

package/src/objects/isaacAPIClassTypeToFunctions.ts

@@ -80,12 +80,14 @@ export interface IsaacAPIClassTypeFunctions<T, SerializedT> {
   deserialize: (object: SerializedT) => T;
 }
 
-export const ISAAC_API_CLASS_TYPE_TO_FUNCTIONS: {
-  readonly [Key in CopyableIsaacAPIClassType]: IsaacAPIClassTypeFunctions<
-    IsaacAPIClassTypeToType[Key],
-    IsaacAPIClassTypeToSerializedType[Key]
+type IsaacAPIClassTypeToFunctions = {
+  readonly [K in CopyableIsaacAPIClassType]: IsaacAPIClassTypeFunctions<
+    IsaacAPIClassTypeToType[K],
+    IsaacAPIClassTypeToSerializedType[K]
   >;
-} = {
+};
+
+export const ISAAC_API_CLASS_TYPE_TO_FUNCTIONS = {
   [CopyableIsaacAPIClassType.BIT_SET_128]: {
     is: isBitSet128,
     isSerialized: isSerializedBitSet128,
@@ -121,4 +123,4 @@ export const ISAAC_API_CLASS_TYPE_TO_FUNCTIONS: {
     serialize: serializeVector,
     deserialize: deserializeVector,
   },
-} as const;
+} as const satisfies IsaacAPIClassTypeToFunctions;

package/src/objects/roomShapeToDoorSlotsToGridIndexDelta.ts

@@ -11,11 +11,11 @@ const DOWN = LEVEL_GRID_ROW_WIDTH;
  * Deltas are considered to be from the safe grid index of the room (i.e. the top left corner, or
  * top right corner in the case of `RoomShape.LTL`).
  */
-// We need the maps to be widened for all `DoorSlot`, so we specify the type instead of using the
-// `satisfies` operator.
-export const ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA: {
-  readonly [Key in RoomShape]: ReadonlyMap<DoorSlot, int>;
-} = {
+// We don't use `as const` since we need the map to be indexable by all `DoorSlot`.
+// eslint-disable-next-line isaacscript/require-capital-const-assertions
+export const ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA: Readonly<
+  Record<RoomShape, ReadonlyMap<DoorSlot, int>>
+> = {
   // 1
   [RoomShape.SHAPE_1x1]: new ReadonlyMap([
     [DoorSlot.LEFT_0, LEFT], // 0
@@ -127,4 +127,4 @@ export const ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA: {
     [DoorSlot.RIGHT_1, DOWN + RIGHT], // 6
     [DoorSlot.DOWN_1, RIGHT + DOWN], // 7
   ]),
-} as const;
+};

package/src/objects/stageToMusic.ts

@@ -1,98 +1,98 @@
 import { LevelStage, Music, StageType } from "isaac-typescript-definitions";
 
 const BASEMENT_TO_MUSIC = {
-  [StageType.ORIGINAL]: Music.BASEMENT,
-  [StageType.WRATH_OF_THE_LAMB]: Music.CELLAR,
-  [StageType.AFTERBIRTH]: Music.BURNING_BASEMENT,
-  [StageType.GREED_MODE]: Music.BASEMENT,
-  [StageType.REPENTANCE]: Music.DOWNPOUR,
-  [StageType.REPENTANCE_B]: Music.DROSS,
+  [StageType.ORIGINAL]: Music.BASEMENT, // 0
+  [StageType.WRATH_OF_THE_LAMB]: Music.CELLAR, // 1
+  [StageType.AFTERBIRTH]: Music.BURNING_BASEMENT, // 2
+  [StageType.GREED_MODE]: Music.BASEMENT, // 3
+  [StageType.REPENTANCE]: Music.DOWNPOUR, // 4
+  [StageType.REPENTANCE_B]: Music.DROSS, // 5
 } as const satisfies Record<StageType, Music>;
 
 const CAVES_TO_MUSIC = {
-  [StageType.ORIGINAL]: Music.CAVES,
-  [StageType.WRATH_OF_THE_LAMB]: Music.CATACOMBS,
-  [StageType.AFTERBIRTH]: Music.FLOODED_CAVES,
-  [StageType.GREED_MODE]: Music.CAVES,
-  [StageType.REPENTANCE]: Music.MINES,
-  [StageType.REPENTANCE_B]: Music.ASHPIT,
+  [StageType.ORIGINAL]: Music.CAVES, // 0
+  [StageType.WRATH_OF_THE_LAMB]: Music.CATACOMBS, // 1
+  [StageType.AFTERBIRTH]: Music.FLOODED_CAVES, // 2
+  [StageType.GREED_MODE]: Music.CAVES, // 3
+  [StageType.REPENTANCE]: Music.MINES, // 4
+  [StageType.REPENTANCE_B]: Music.ASHPIT, // 5
 } as const satisfies Record<StageType, Music>;
 
 const DEPTHS_TO_MUSIC = {
-  [StageType.ORIGINAL]: Music.DEPTHS,
-  [StageType.WRATH_OF_THE_LAMB]: Music.NECROPOLIS,
-  [StageType.AFTERBIRTH]: Music.DANK_DEPTHS,
-  [StageType.GREED_MODE]: Music.DEPTHS,
-  [StageType.REPENTANCE]: Music.MAUSOLEUM,
-  [StageType.REPENTANCE_B]: Music.GEHENNA,
+  [StageType.ORIGINAL]: Music.DEPTHS, // 0
+  [StageType.WRATH_OF_THE_LAMB]: Music.NECROPOLIS, // 1
+  [StageType.AFTERBIRTH]: Music.DANK_DEPTHS, // 2
+  [StageType.GREED_MODE]: Music.DEPTHS, // 3
+  [StageType.REPENTANCE]: Music.MAUSOLEUM, // 4
+  [StageType.REPENTANCE_B]: Music.GEHENNA, // 5
 } as const satisfies Record<StageType, Music>;
 
 const WOMB_TO_MUSIC = {
-  [StageType.ORIGINAL]: Music.WOMB,
-  [StageType.WRATH_OF_THE_LAMB]: Music.UTERO,
-  [StageType.AFTERBIRTH]: Music.SCARRED_WOMB,
-  [StageType.GREED_MODE]: Music.WOMB,
-  [StageType.REPENTANCE]: Music.CORPSE,
-  [StageType.REPENTANCE_B]: Music.MORTIS,
+  [StageType.ORIGINAL]: Music.WOMB, // 0
+  [StageType.WRATH_OF_THE_LAMB]: Music.UTERO, // 1
+  [StageType.AFTERBIRTH]: Music.SCARRED_WOMB, // 2
+  [StageType.GREED_MODE]: Music.WOMB, // 3
+  [StageType.REPENTANCE]: Music.CORPSE, // 4
+  [StageType.REPENTANCE_B]: Music.MORTIS, // 5
 } as const satisfies Record<StageType, Music>;
 
 const BLUE_WOMB_TO_MUSIC = {
-  [StageType.ORIGINAL]: Music.BLUE_WOMB,
-  [StageType.WRATH_OF_THE_LAMB]: Music.BLUE_WOMB,
-  [StageType.AFTERBIRTH]: Music.BLUE_WOMB,
-  [StageType.GREED_MODE]: Music.BLUE_WOMB,
-  [StageType.REPENTANCE]: Music.BLUE_WOMB,
-  [StageType.REPENTANCE_B]: Music.BLUE_WOMB,
+  [StageType.ORIGINAL]: Music.BLUE_WOMB, // 0
+  [StageType.WRATH_OF_THE_LAMB]: Music.BLUE_WOMB, // 1
+  [StageType.AFTERBIRTH]: Music.BLUE_WOMB, // 2
+  [StageType.GREED_MODE]: Music.BLUE_WOMB, // 3
+  [StageType.REPENTANCE]: Music.BLUE_WOMB, // 4
+  [StageType.REPENTANCE_B]: Music.BLUE_WOMB, // 5
 } as const satisfies Record<StageType, Music>;
 
 const SHEOL_CATHEDRAL_TO_MUSIC = {
-  [StageType.ORIGINAL]: Music.SHEOL,
-  [StageType.WRATH_OF_THE_LAMB]: Music.CATHEDRAL,
-  [StageType.AFTERBIRTH]: Music.SHEOL,
-  [StageType.GREED_MODE]: Music.SHEOL,
-  [StageType.REPENTANCE]: Music.SHEOL,
-  [StageType.REPENTANCE_B]: Music.SHEOL,
+  [StageType.ORIGINAL]: Music.SHEOL, // 0
+  [StageType.WRATH_OF_THE_LAMB]: Music.CATHEDRAL, // 1
+  [StageType.AFTERBIRTH]: Music.SHEOL, // 2
+  [StageType.GREED_MODE]: Music.SHEOL, // 3
+  [StageType.REPENTANCE]: Music.SHEOL, // 4
+  [StageType.REPENTANCE_B]: Music.SHEOL, // 5
 } as const satisfies Record<StageType, Music>;
 
 const DARK_ROOM_CHEST_TO_MUSIC = {
-  [StageType.ORIGINAL]: Music.DARK_ROOM,
-  [StageType.WRATH_OF_THE_LAMB]: Music.CHEST,
-  [StageType.AFTERBIRTH]: Music.DARK_ROOM,
-  [StageType.GREED_MODE]: Music.DARK_ROOM,
-  [StageType.REPENTANCE]: Music.DARK_ROOM,
-  [StageType.REPENTANCE_B]: Music.DARK_ROOM,
+  [StageType.ORIGINAL]: Music.DARK_ROOM, // 0
+  [StageType.WRATH_OF_THE_LAMB]: Music.CHEST, // 1
+  [StageType.AFTERBIRTH]: Music.DARK_ROOM, // 2
+  [StageType.GREED_MODE]: Music.DARK_ROOM, // 3
+  [StageType.REPENTANCE]: Music.DARK_ROOM, // 4
+  [StageType.REPENTANCE_B]: Music.DARK_ROOM, // 5
 } as const satisfies Record<StageType, Music>;
 
-const THE_VOID_TO_MUSIC = {
-  [StageType.ORIGINAL]: Music.VOID,
-  [StageType.WRATH_OF_THE_LAMB]: Music.VOID,
-  [StageType.AFTERBIRTH]: Music.VOID,
-  [StageType.GREED_MODE]: Music.VOID,
-  [StageType.REPENTANCE]: Music.VOID,
-  [StageType.REPENTANCE_B]: Music.VOID,
+const VOID_TO_MUSIC = {
+  [StageType.ORIGINAL]: Music.VOID, // 0
+  [StageType.WRATH_OF_THE_LAMB]: Music.VOID, // 1
+  [StageType.AFTERBIRTH]: Music.VOID, // 2
+  [StageType.GREED_MODE]: Music.VOID, // 3
+  [StageType.REPENTANCE]: Music.VOID, // 4
+  [StageType.REPENTANCE_B]: Music.VOID, // 5
 } as const satisfies Record<StageType, Music>;
 
 const HOME_TO_MUSIC = {
-  [StageType.ORIGINAL]: Music.ISAACS_HOUSE,
-  [StageType.WRATH_OF_THE_LAMB]: Music.ISAACS_HOUSE,
-  [StageType.AFTERBIRTH]: Music.ISAACS_HOUSE,
-  [StageType.GREED_MODE]: Music.ISAACS_HOUSE,
-  [StageType.REPENTANCE]: Music.ISAACS_HOUSE,
-  [StageType.REPENTANCE_B]: Music.ISAACS_HOUSE,
+  [StageType.ORIGINAL]: Music.ISAACS_HOUSE, // 0
+  [StageType.WRATH_OF_THE_LAMB]: Music.ISAACS_HOUSE, // 1
+  [StageType.AFTERBIRTH]: Music.ISAACS_HOUSE, // 2
+  [StageType.GREED_MODE]: Music.ISAACS_HOUSE, // 3
+  [StageType.REPENTANCE]: Music.ISAACS_HOUSE, // 4
+  [StageType.REPENTANCE_B]: Music.ISAACS_HOUSE, // 5
 } as const satisfies Record<StageType, Music>;
 
 export const STAGE_TO_MUSIC = {
-  [LevelStage.BASEMENT_1]: BASEMENT_TO_MUSIC,
-  [LevelStage.BASEMENT_2]: BASEMENT_TO_MUSIC,
-  [LevelStage.CAVES_1]: CAVES_TO_MUSIC,
-  [LevelStage.CAVES_2]: CAVES_TO_MUSIC,
-  [LevelStage.DEPTHS_1]: DEPTHS_TO_MUSIC,
-  [LevelStage.DEPTHS_2]: DEPTHS_TO_MUSIC,
-  [LevelStage.WOMB_1]: WOMB_TO_MUSIC,
-  [LevelStage.WOMB_2]: WOMB_TO_MUSIC,
-  [LevelStage.BLUE_WOMB]: BLUE_WOMB_TO_MUSIC,
-  [LevelStage.SHEOL_CATHEDRAL]: SHEOL_CATHEDRAL_TO_MUSIC,
-  [LevelStage.DARK_ROOM_CHEST]: DARK_ROOM_CHEST_TO_MUSIC,
-  [LevelStage.THE_VOID]: THE_VOID_TO_MUSIC,
-  [LevelStage.HOME]: HOME_TO_MUSIC,
+  [LevelStage.BASEMENT_1]: BASEMENT_TO_MUSIC, // 1
+  [LevelStage.BASEMENT_2]: BASEMENT_TO_MUSIC, // 2
+  [LevelStage.CAVES_1]: CAVES_TO_MUSIC, // 3
+  [LevelStage.CAVES_2]: CAVES_TO_MUSIC, // 4
+  [LevelStage.DEPTHS_1]: DEPTHS_TO_MUSIC, // 5
+  [LevelStage.DEPTHS_2]: DEPTHS_TO_MUSIC, // 6
+  [LevelStage.WOMB_1]: WOMB_TO_MUSIC, // 7
+  [LevelStage.WOMB_2]: WOMB_TO_MUSIC, // 8
+  [LevelStage.BLUE_WOMB]: BLUE_WOMB_TO_MUSIC, // 9
+  [LevelStage.SHEOL_CATHEDRAL]: SHEOL_CATHEDRAL_TO_MUSIC, // 10
+  [LevelStage.DARK_ROOM_CHEST]: DARK_ROOM_CHEST_TO_MUSIC, // 11
+  [LevelStage.THE_VOID]: VOID_TO_MUSIC, // 12
+  [LevelStage.HOME]: HOME_TO_MUSIC, // 13
 } as const satisfies Record<LevelStage, Record<StageType, Music>>;

package/src/objects/stageToStageID.ts

@@ -0,0 +1,98 @@
+import { LevelStage, StageID, StageType } from "isaac-typescript-definitions";
+
+const BASEMENT_TO_STAGE_ID = {
+  [StageType.ORIGINAL]: StageID.BASEMENT, // 0
+  [StageType.WRATH_OF_THE_LAMB]: StageID.CELLAR, // 1
+  [StageType.AFTERBIRTH]: StageID.BURNING_BASEMENT, // 2
+  [StageType.GREED_MODE]: StageID.BASEMENT, // 3
+  [StageType.REPENTANCE]: StageID.DOWNPOUR, // 4
+  [StageType.REPENTANCE_B]: StageID.DROSS, // 5
+} as const satisfies Record<StageType, StageID>;
+
+const CAVES_TO_STAGE_ID = {
+  [StageType.ORIGINAL]: StageID.CAVES, // 0
+  [StageType.WRATH_OF_THE_LAMB]: StageID.CATACOMBS, // 1
+  [StageType.AFTERBIRTH]: StageID.FLOODED_CAVES, // 2
+  [StageType.GREED_MODE]: StageID.CAVES, // 3
+  [StageType.REPENTANCE]: StageID.MINES, // 4
+  [StageType.REPENTANCE_B]: StageID.ASHPIT, // 5
+} as const satisfies Record<StageType, StageID>;
+
+const DEPTHS_TO_STAGE_ID = {
+  [StageType.ORIGINAL]: StageID.DEPTHS, // 0
+  [StageType.WRATH_OF_THE_LAMB]: StageID.NECROPOLIS, // 1
+  [StageType.AFTERBIRTH]: StageID.DANK_DEPTHS, // 2
+  [StageType.GREED_MODE]: StageID.DEPTHS, // 3
+  [StageType.REPENTANCE]: StageID.MAUSOLEUM, // 4
+  [StageType.REPENTANCE_B]: StageID.GEHENNA, // 5
+} as const satisfies Record<StageType, StageID>;
+
+const WOMB_TO_STAGE_ID = {
+  [StageType.ORIGINAL]: StageID.WOMB, // 0
+  [StageType.WRATH_OF_THE_LAMB]: StageID.UTERO, // 1
+  [StageType.AFTERBIRTH]: StageID.SCARRED_WOMB, // 2
+  [StageType.GREED_MODE]: StageID.WOMB, // 3
+  [StageType.REPENTANCE]: StageID.CORPSE, // 4
+  [StageType.REPENTANCE_B]: StageID.MORTIS, // 5
+} as const satisfies Record<StageType, StageID>;
+
+const BLUE_WOMB_TO_STAGE_ID = {
+  [StageType.ORIGINAL]: StageID.BLUE_WOMB, // 0
+  [StageType.WRATH_OF_THE_LAMB]: StageID.BLUE_WOMB, // 1
+  [StageType.AFTERBIRTH]: StageID.BLUE_WOMB, // 2
+  [StageType.GREED_MODE]: StageID.BLUE_WOMB, // 3
+  [StageType.REPENTANCE]: StageID.BLUE_WOMB, // 4
+  [StageType.REPENTANCE_B]: StageID.BLUE_WOMB, // 5
+} as const satisfies Record<StageType, StageID>;
+
+const SHEOL_CATHEDRAL_TO_STAGE_ID = {
+  [StageType.ORIGINAL]: StageID.SHEOL, // 0
+  [StageType.WRATH_OF_THE_LAMB]: StageID.CATHEDRAL, // 1
+  [StageType.AFTERBIRTH]: StageID.SHEOL, // 2
+  [StageType.GREED_MODE]: StageID.SHEOL, // 3
+  [StageType.REPENTANCE]: StageID.SHEOL, // 4
+  [StageType.REPENTANCE_B]: StageID.SHEOL, // 5
+} as const satisfies Record<StageType, StageID>;
+
+const DARK_ROOM_CHEST_TO_STAGE_ID = {
+  [StageType.ORIGINAL]: StageID.DARK_ROOM, // 0
+  [StageType.WRATH_OF_THE_LAMB]: StageID.CHEST, // 1
+  [StageType.AFTERBIRTH]: StageID.DARK_ROOM, // 2
+  [StageType.GREED_MODE]: StageID.DARK_ROOM, // 3
+  [StageType.REPENTANCE]: StageID.DARK_ROOM, // 4
+  [StageType.REPENTANCE_B]: StageID.DARK_ROOM, // 5
+} as const satisfies Record<StageType, StageID>;
+
+const VOID_TO_STAGE_ID = {
+  [StageType.ORIGINAL]: StageID.VOID, // 0
+  [StageType.WRATH_OF_THE_LAMB]: StageID.VOID, // 1
+  [StageType.AFTERBIRTH]: StageID.VOID, // 2
+  [StageType.GREED_MODE]: StageID.VOID, // 3
+  [StageType.REPENTANCE]: StageID.VOID, // 4
+  [StageType.REPENTANCE_B]: StageID.VOID, // 5
+} as const satisfies Record<StageType, StageID>;
+
+const HOME_TO_STAGE_ID = {
+  [StageType.ORIGINAL]: StageID.HOME, // 0
+  [StageType.WRATH_OF_THE_LAMB]: StageID.HOME, // 1
+  [StageType.AFTERBIRTH]: StageID.HOME, // 2
+  [StageType.GREED_MODE]: StageID.HOME, // 3
+  [StageType.REPENTANCE]: StageID.HOME, // 4
+  [StageType.REPENTANCE_B]: StageID.HOME, // 5
+} as const satisfies Record<StageType, StageID>;
+
+export const STAGE_TO_STAGE_ID = {
+  [LevelStage.BASEMENT_1]: BASEMENT_TO_STAGE_ID, // 1
+  [LevelStage.BASEMENT_2]: BASEMENT_TO_STAGE_ID, // 2
+  [LevelStage.CAVES_1]: CAVES_TO_STAGE_ID, // 3
+  [LevelStage.CAVES_2]: CAVES_TO_STAGE_ID, // 4
+  [LevelStage.DEPTHS_1]: DEPTHS_TO_STAGE_ID, // 5
+  [LevelStage.DEPTHS_2]: DEPTHS_TO_STAGE_ID, // 6
+  [LevelStage.WOMB_1]: WOMB_TO_STAGE_ID, // 7
+  [LevelStage.WOMB_2]: WOMB_TO_STAGE_ID, // 8
+  [LevelStage.BLUE_WOMB]: BLUE_WOMB_TO_STAGE_ID, // 9
+  [LevelStage.SHEOL_CATHEDRAL]: SHEOL_CATHEDRAL_TO_STAGE_ID, // 10
+  [LevelStage.DARK_ROOM_CHEST]: DARK_ROOM_CHEST_TO_STAGE_ID, // 11
+  [LevelStage.THE_VOID]: VOID_TO_STAGE_ID, // 12
+  [LevelStage.HOME]: HOME_TO_STAGE_ID, // 13
+} as const satisfies Record<LevelStage, unknown>;

package/src/types/private/CallbackTuple.ts

@@ -9,10 +9,10 @@ import { AllButFirst } from "../AllButFirst";
  * added/removed.
  */
 export type CallbackTuple = {
-  [Key in ModCallback]: [
-    modCallback: Key,
-    callbackFunc: AddCallbackParameters[Key][0],
-    optionalArgs?: AllButFirst<AddCallbackParameters[Key]>,
+  [K in ModCallback]: [
+    modCallback: K,
+    callbackFunc: AddCallbackParameters[K][0],
+    optionalArgs?: AllButFirst<AddCallbackParameters[K]>,
   ];
 }[ModCallback];
 
@@ -22,9 +22,9 @@ export type CallbackTuple = {
  * get added/removed.
  */
 export type CustomCallbackTuple = {
-  [Key in ModCallbackCustom]: [
-    modCallback: Key,
-    callbackFunc: AddCallbackParametersCustom[Key][0],
-    optionalArgs?: AllButFirst<AddCallbackParametersCustom[Key]>,
+  [K in ModCallbackCustom]: [
+    modCallback: K,
+    callbackFunc: AddCallbackParametersCustom[K][0],
+    optionalArgs?: AllButFirst<AddCallbackParametersCustom[K]>,
   ];
 }[ModCallbackCustom];

package/src/types/private/ModUpgradedWithFeatures.ts

@@ -37,5 +37,5 @@ type ISCFeaturesToKeys<T extends readonly ISCFeature[]> = Omit<
  * same private fields will cause a `never` type.
  */
 type ISCFeatureTupleToClassTuple<T extends ISCFeature[]> = {
-  [Key in keyof T]: PublicInterface<ISCFeatureToClass[T[Key]]>;
+  [K in keyof T]: PublicInterface<ISCFeatureToClass[T[K]]>;
 };