isaacscript-common 51.2.0 → 51.2.2

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

@@ -10,6 +10,7 @@ import { Exported } from "../../../decorators";
 import { ModCallbackCustom } from "../../../enums/ModCallbackCustom";
 import { isVanillaConsoleCommand } from "../../../functions/console";
 import { addFlag, bitFlags } from "../../../functions/flag";
+import { logError } from "../../../functions/logMisc";
 import { getMapPartialMatch } from "../../../functions/string";
 import { assertDefined } from "../../../functions/utils";
 import { Feature } from "../../private/Feature";
@@ -268,15 +269,17 @@ export class ExtraConsoleCommands extends Feature {
     }
 
     if (isVanillaConsoleCommand(commandName)) {
-      error(
+      logError(
         `Failed to add a new console command of "${commandName}" because that name already belongs to a vanilla command. You must pick a non-colliding name.`,
       );
+      return;
     }
 
     if (this.commandFunctionMap.has(commandName)) {
-      error(
+      logError(
         `Failed to add a new console command of "${commandName}" because there is already an existing custom command by that name. If you want to overwrite a command from the standard library, you can use the "removeExtraConsoleCommand" function.`,
       );
+      return;
     }
 
     this.commandFunctionMap.set(commandName, commandFunction);

package/src/functions/bosses.ts

@@ -5,6 +5,7 @@ import type {
 } from "isaac-typescript-definitions";
 import { EntityType, LokiVariant } from "isaac-typescript-definitions";
 import { VectorZero } from "../core/constants";
+import { ENTITY_TYPE_VARIANT_TO_BOSS_ID_MAP } from "../maps/entityTypeVariantToBossIDMap";
 import { BOSS_ID_TO_ENTITY_TYPE_VARIANT } from "../objects/bossIDToEntityTypeVariant";
 import {
   ALL_BOSSES_EXCLUDING_STORY_BOSSES_SET,
@@ -30,21 +31,6 @@ const BOSSES_THAT_REQUIRE_MULTIPLE_SPAWNS = new ReadonlySet<EntityType>([
 
 const DEFAULT_BOSS_MULTI_SEGMENTS = 4;
 
-const ENTITY_TYPE_VARIANT_TO_BOSS_ID: ReadonlyMap<string, BossID> = (() => {
-  const entityTypeVariantToBossID = new Map<string, BossID>();
-
-  for (const [bossIDRaw, entityTypeVariant] of Object.entries(
-    BOSS_ID_TO_ENTITY_TYPE_VARIANT,
-  )) {
-    const bossID = bossIDRaw as unknown as BossID;
-    const [entityType, variant] = entityTypeVariant;
-    const entityTypeVariantString = `${entityType}.${variant}`;
-    entityTypeVariantToBossID.set(entityTypeVariantString, bossID);
-  }
-
-  return entityTypeVariantToBossID;
-})();
-
 /**
  * Helper function to get all of the non-dead bosses in the room.
  *
@@ -72,11 +58,15 @@ export function getAliveBosses(
 /**
  * Helper function to get the set of every boss in the game.
  *
- * Note that this set does not include:
+ * This includes:
+ * - Ultra Greed
+ *
+ * This does not include:
  * - mini-bosses (e.g. Ultra Pride, Krampus)
  * - bosses that do not appear in Boss Rooms (e.g. Uriel, Gabriel)
- * - the second phase of multi-phase bosses (e.g. Mega Satan 2, Ultra Famine, Ultra Pestilence,
- *   Ultra War, Ultra Death)
+ * - the second phase of multi-phase bosses (e.g. Mega Satan 2)
+ * - sub-bosses of The Beast Fight (e.g. Ultra Famine, Ultra Pestilence, Ultra War, Ultra Death)
+ * - bosses that do not have any Boss Rooms defined due to being unfinished (e.g. Raglich)
  *
  * Also see the `getBossSet` and `getCombinedBossSet` functions.
  *
@@ -96,7 +86,7 @@ export function getBossIDFromEntityTypeVariant(
   variant: int,
 ): BossID | undefined {
   const entityTypeVariant = `${entityType}.${variant}`;
-  return ENTITY_TYPE_VARIANT_TO_BOSS_ID.get(entityTypeVariant);
+  return ENTITY_TYPE_VARIANT_TO_BOSS_ID_MAP.get(entityTypeVariant);
 }
 
 /**

package/src/functions/input.ts

@@ -5,7 +5,7 @@ import {
   Keyboard,
 } from "isaac-typescript-definitions";
 import { CONTROLLER_INDEX_VALUES } from "../arrays/cachedEnumValues";
-import { KEYBOARD_TO_STRING } from "../maps/keyboardToString";
+import { KEYBOARD_TO_STRING_MAP } from "../maps/keyboardToStringMap";
 import { ReadonlySet } from "../types/ReadonlySet";
 import { trimPrefix } from "./string";
 
@@ -233,7 +233,7 @@ export function keyboardToString(
   keyboard: Keyboard,
   uppercase: boolean,
 ): string | undefined {
-  const tuple = KEYBOARD_TO_STRING.get(keyboard);
+  const tuple = KEYBOARD_TO_STRING_MAP.get(keyboard);
   if (tuple === undefined) {
     return undefined;
   }

package/src/functions/pills.ts

@@ -13,8 +13,8 @@ import {
   LAST_NORMAL_PILL_COLOR,
   LAST_VANILLA_PILL_EFFECT,
 } from "../core/constantsFirstLast";
-import { PHD_PILL_CONVERSIONS } from "../maps/PHDPillConversions";
-import { FALSE_PHD_PILL_CONVERSIONS } from "../maps/falsePHDPillConversions";
+import { PHD_PILL_CONVERSIONS_MAP } from "../maps/PHDPillConversionsMap";
+import { FALSE_PHD_PILL_CONVERSIONS_MAP } from "../maps/falsePHDPillConversionsMap";
 import {
   DEFAULT_PILL_EFFECT_CLASS,
   PILL_EFFECT_CLASSES,
@@ -52,7 +52,7 @@ export function getAllPillColors(): PillColor[] {
  * is not altered by False PHD, then the same pill effect will be returned.
  */
 export function getFalsePHDPillEffect(pillEffect: PillEffect): PillEffect {
-  const convertedPillEffect = FALSE_PHD_PILL_CONVERSIONS.get(pillEffect);
+  const convertedPillEffect = FALSE_PHD_PILL_CONVERSIONS_MAP.get(pillEffect);
   return convertedPillEffect ?? pillEffect;
 }
 
@@ -96,7 +96,7 @@ export function getNormalPillColors(): PillColor[] {
  * altered by PHD, then the same pill effect will be returned.
  */
 export function getPHDPillEffect(pillEffect: PillEffect): PillEffect {
-  const convertedPillEffect = PHD_PILL_CONVERSIONS.get(pillEffect);
+  const convertedPillEffect = PHD_PILL_CONVERSIONS_MAP.get(pillEffect);
   return convertedPillEffect ?? pillEffect;
 }
 

package/src/functions/roomShapeWalls.ts

@@ -3,27 +3,88 @@ import { ROOM_SHAPE_VALUES } from "../arrays/cachedEnumValues";
 import { game } from "../core/cachedClasses";
 import { CornerType } from "../enums/CornerType";
 import type { Corner } from "../interfaces/Corner";
+import { ReadonlyMap } from "../types/ReadonlyMap";
 import { ReadonlySet } from "../types/ReadonlySet";
 import { getGridIndexesBetween } from "./gridIndex";
 import { getRoomShapeCorners, isLRoomShape } from "./roomShape";
 import { inBossRoomOf, inHomeCloset } from "./rooms";
 import { assertDefined } from "./utils";
 
-const ROOM_SHAPE_TO_WALL_GRID_INDEX_SET: ReadonlyMap<
-  RoomShape,
-  ReadonlySet<int>
-> = (() => {
-  const roomShapeToWallGridIndexSet = new Map<RoomShape, ReadonlySet<int>>();
+const ROOM_SHAPE_TO_WALL_GRID_INDEX_MAP = new ReadonlyMap(
+  ROOM_SHAPE_VALUES.map((roomShape) => [
+    roomShape,
+    getVanillaWallGridIndexSetForRoomShape(roomShape),
+  ]),
+);
 
-  for (const roomShape of ROOM_SHAPE_VALUES) {
-    const gridIndexSet = getVanillaWallGridIndexSetForRoomShape(roomShape);
-    roomShapeToWallGridIndexSet.set(roomShape, gridIndexSet);
-  }
+/** The Home closet is is 9x3, which is different from `RoomShape.IH` (which is 13x3). */
+const HOME_CLOSET_CORNERS = [
+  {
+    type: CornerType.TOP_LEFT,
+    gridIndex: 30,
+    position: Vector(60, 220),
+  },
+  {
+    type: CornerType.TOP_RIGHT,
+    gridIndex: 38,
+    position: Vector(340, 220),
+  },
+  {
+    type: CornerType.BOTTOM_LEFT,
+    gridIndex: 90,
+    position: Vector(60, 340),
+  },
+  {
+    type: CornerType.BOTTOM_RIGHT,
+    gridIndex: 98,
+    position: Vector(340, 340),
+  },
+] as const;
+
+const HOME_CLOSET_CORNERS_SET = getVanillaWallGridIndexSetForRectangleRoomShape(
+  RoomShape.IH,
+  HOME_CLOSET_CORNERS,
+);
+
+/**
+ * The Mother Boss Room is 15x11, which is different from `RoomShape.SHAPE_1x2` (which is 15x16).
+ */
+const MOTHER_ROOM_CORNERS = [
+  {
+    type: CornerType.TOP_LEFT,
+    gridIndex: 0,
+    position: Vector(60, 140),
+  },
+  {
+    type: CornerType.TOP_RIGHT,
+    gridIndex: 14,
+    position: Vector(580, 140),
+  },
+  {
+    type: CornerType.BOTTOM_LEFT,
+    gridIndex: 150,
+    position: Vector(60, 500),
+  },
+  {
+    type: CornerType.BOTTOM_RIGHT,
+    gridIndex: 164,
+    position: Vector(580, 500),
+  },
+] as const;
 
-  return roomShapeToWallGridIndexSet;
-})();
+const MOTHER_ROOM_CORNERS_SET = getVanillaWallGridIndexSetForRectangleRoomShape(
+  RoomShape.SHAPE_1x2,
+  MOTHER_ROOM_CORNERS,
+);
 
-function getVanillaWallGridIndexSetForRoomShape(
+/**
+ * Helper function to get the set of grid indexes that represent where the walls are supposed to be
+ * in a given room shape.
+ *
+ * This function only works reliably in vanilla rooms because in a modded room, it is possible to
+ * place walls in a non-standard location.
+ */
+export function getVanillaWallGridIndexSetForRoomShape(
   roomShape: RoomShape,
 ): ReadonlySet<int> {
   const corners = getRoomShapeCorners(roomShape);
@@ -201,7 +262,10 @@ function getVanillaWallGridIndexSetForRoomShape(
     }
 
     default: {
-      return getWallGridIndexSetForRectangleRoomShape(roomShape, corners);
+      return getVanillaWallGridIndexSetForRectangleRoomShape(
+        roomShape,
+        corners,
+      );
     }
   }
 }
@@ -210,7 +274,7 @@ function getVanillaWallGridIndexSetForRoomShape(
  * Providing the room shape is necessary so that the `getGridIndexesBetween` function can use the
  * corresponding grid width.
  */
-function getWallGridIndexSetForRectangleRoomShape(
+function getVanillaWallGridIndexSetForRectangleRoomShape(
   roomShape: RoomShape,
   corners: readonly Corner[],
 ): ReadonlySet<int> {
@@ -250,66 +314,6 @@ function getWallGridIndexSetForRectangleRoomShape(
   ]);
 }
 
-/** The Home closet is is 9x3, which is different from `RoomShape.IH` (which is 13x3). */
-const HOME_CLOSET_CORNERS = [
-  {
-    type: CornerType.TOP_LEFT,
-    gridIndex: 30,
-    position: Vector(60, 220),
-  },
-  {
-    type: CornerType.TOP_RIGHT,
-    gridIndex: 38,
-    position: Vector(340, 220),
-  },
-  {
-    type: CornerType.BOTTOM_LEFT,
-    gridIndex: 90,
-    position: Vector(60, 340),
-  },
-  {
-    type: CornerType.BOTTOM_RIGHT,
-    gridIndex: 98,
-    position: Vector(340, 340),
-  },
-] as const;
-
-const HOME_CLOSET_CORNERS_SET = getWallGridIndexSetForRectangleRoomShape(
-  RoomShape.IH,
-  HOME_CLOSET_CORNERS,
-);
-
-/**
- * The Mother Boss Room is 15x11, which is different from `RoomShape.SHAPE_1x2` (which is 15x16).
- */
-const MOTHER_ROOM_CORNERS = [
-  {
-    type: CornerType.TOP_LEFT,
-    gridIndex: 0,
-    position: Vector(60, 140),
-  },
-  {
-    type: CornerType.TOP_RIGHT,
-    gridIndex: 14,
-    position: Vector(580, 140),
-  },
-  {
-    type: CornerType.BOTTOM_LEFT,
-    gridIndex: 150,
-    position: Vector(60, 500),
-  },
-  {
-    type: CornerType.BOTTOM_RIGHT,
-    gridIndex: 164,
-    position: Vector(580, 500),
-  },
-] as const;
-
-const MOTHER_ROOM_CORNERS_SET = getWallGridIndexSetForRectangleRoomShape(
-  RoomShape.SHAPE_1x2,
-  MOTHER_ROOM_CORNERS,
-);
-
 /**
  * Helper function to determine if a given grid index should have a wall generated by the vanilla
  * game. This is useful as a mechanism to distinguish between real walls and custom walls spawned by
@@ -329,7 +333,7 @@ export function isVanillaWallGridIndex(gridIndex: int): boolean {
   } else if (inBossRoomOf(BossID.MOTHER)) {
     wallGridIndexSet = MOTHER_ROOM_CORNERS_SET;
   } else {
-    wallGridIndexSet = ROOM_SHAPE_TO_WALL_GRID_INDEX_SET.get(roomShape);
+    wallGridIndexSet = ROOM_SHAPE_TO_WALL_GRID_INDEX_MAP.get(roomShape);
     assertDefined(
       wallGridIndexSet,
       `Failed to find the wall grid index set for: RoomShape.${RoomShape[roomShape]} (${roomShape})`,

package/src/maps/PHDPillConversionsMap.ts

@@ -0,0 +1,23 @@
+import { PillEffect } from "isaac-typescript-definitions";
+import { ReadonlyMap } from "../types/ReadonlyMap";
+
+export const PHD_PILL_CONVERSIONS_MAP = new ReadonlyMap<PillEffect, PillEffect>(
+  [
+    [PillEffect.BAD_TRIP, PillEffect.BALLS_OF_STEEL], // 1
+    [PillEffect.HEALTH_DOWN, PillEffect.HEALTH_UP], // 6
+    [PillEffect.RANGE_DOWN, PillEffect.RANGE_UP], // 11
+    [PillEffect.SPEED_DOWN, PillEffect.SPEED_UP], // 13
+    [PillEffect.TEARS_DOWN, PillEffect.TEARS_UP], // 15
+    [PillEffect.LUCK_DOWN, PillEffect.LUCK_UP], // 17
+    [PillEffect.PARALYSIS, PillEffect.PHEROMONES], // 22
+    [PillEffect.AMNESIA, PillEffect.I_CAN_SEE_FOREVER], // 25
+    [PillEffect.R_U_A_WIZARD, PillEffect.POWER], // 27
+    [PillEffect.ADDICTED, PillEffect.PERCS], // 29
+    [PillEffect.QUESTION_MARKS, PillEffect.TELEPILLS], // 31
+    [PillEffect.RETRO_VISION, PillEffect.I_CAN_SEE_FOREVER], // 37
+    [PillEffect.X_LAX, PillEffect.SOMETHINGS_WRONG], // 39
+    [PillEffect.IM_EXCITED, PillEffect.IM_DROWSY], // 42
+    [PillEffect.HORF, PillEffect.GULP], // 44
+    [PillEffect.SHOT_SPEED_DOWN, PillEffect.SHOT_SPEED_UP], // 47
+  ],
+);

package/src/maps/collectibleNameToTypeMap.ts

@@ -1,5 +1,5 @@
-import type { CollectibleType } from "isaac-typescript-definitions";
 import { removeNonAlphanumericCharacters } from "../functions/string";
+import { ReadonlyMap } from "../types/ReadonlyMap";
 import { COLLECTIBLE_TYPE_TO_NAME_MAP } from "./collectibleTypeToNameMap";
 
 /**
@@ -7,16 +7,11 @@ import { COLLECTIBLE_TYPE_TO_NAME_MAP } from "./collectibleTypeToNameMap";
  *
  * For a mapping of `CollectibleType` to name, see `COLLECTIBLE_TYPE_TO_NAME_MAP`.
  */
-export const COLLECTIBLE_NAME_TO_TYPE_MAP: ReadonlyMap<
-  string,
-  CollectibleType
-> = (() => {
-  const collectibleNameToTypeMap = new Map<string, CollectibleType>();
-
-  for (const [collectibleType, name] of COLLECTIBLE_TYPE_TO_NAME_MAP) {
-    const simpleString = removeNonAlphanumericCharacters(name);
-    collectibleNameToTypeMap.set(simpleString, collectibleType);
-  }
-
-  return collectibleNameToTypeMap;
-})();
+export const COLLECTIBLE_NAME_TO_TYPE_MAP = new ReadonlyMap(
+  [...COLLECTIBLE_TYPE_TO_NAME_MAP.entries()].map(
+    ([collectibleType, collectibleName]) => [
+      removeNonAlphanumericCharacters(collectibleName),
+      collectibleType,
+    ],
+  ),
+);

package/src/maps/entityTypeVariantToBossIDMap.ts

@@ -0,0 +1,14 @@
+import type { BossID } from "isaac-typescript-definitions";
+import { BOSS_ID_TO_ENTITY_TYPE_VARIANT } from "../objects/bossIDToEntityTypeVariant";
+import { ReadonlyMap } from "../types/ReadonlyMap";
+
+export const ENTITY_TYPE_VARIANT_TO_BOSS_ID_MAP = new ReadonlyMap(
+  [...Object.entries(BOSS_ID_TO_ENTITY_TYPE_VARIANT)].map(
+    ([bossIDRaw, entityTypeVariant]) => {
+      const bossID = bossIDRaw as unknown as BossID;
+      const [entityType, variant] = entityTypeVariant;
+      const entityTypeVariantString = `${entityType}.${variant}`;
+      return [entityTypeVariantString, bossID];
+    },
+  ),
+);

package/src/maps/{falsePHDPillConversions.ts → falsePHDPillConversionsMap.ts}

@@ -1,7 +1,7 @@
 import { PillEffect } from "isaac-typescript-definitions";
 import { ReadonlyMap } from "../types/ReadonlyMap";
 
-export const FALSE_PHD_PILL_CONVERSIONS = new ReadonlyMap<
+export const FALSE_PHD_PILL_CONVERSIONS_MAP = new ReadonlyMap<
   PillEffect,
   PillEffect
 >([

package/src/maps/{keyboardToString.ts → keyboardToStringMap.ts}

@@ -2,7 +2,7 @@ import { Keyboard } from "isaac-typescript-definitions";
 import { ReadonlyMap } from "../types/ReadonlyMap";
 
 /** Maps each keyboard enum member to its corresponding lowercase and uppercase characters. */
-export const KEYBOARD_TO_STRING = new ReadonlyMap<
+export const KEYBOARD_TO_STRING_MAP = new ReadonlyMap<
   Keyboard,
   readonly [lowercaseCharacter: string, uppercaseCharacter: string]
 >([