isaacscript-common 9.13.6 → 9.16.0

package/src/functions/minimap.ts

@@ -1,8 +1,48 @@
 import { DisplayFlag, DisplayFlagZero } from "isaac-typescript-definitions";
 import { game } from "../core/cachedClasses";
-import { getRoomDescriptor } from "./roomData";
+import { addFlag } from "./flag";
+import { getRoomDescriptor, getRoomGridIndex } from "./roomData";
 import { getRoomsInsideGrid } from "./rooms";
 
+/**
+ * Helper function to add a `DisplayFlag` to a particular room's minimap display flags (e.g. whether
+ * or not it is visible and so on).
+ *
+ * @param roomGridIndex Set to undefined to use the current room index.
+ * @param displayFlag The `DisplayFlag` to set. (See the `DisplayFlag` enum.)
+ * @param updateVisibility Optional. Whether to call the `Level.UpdateVisibility` method in order to
+ *                         make the changes immediately visible. Default is true.
+ */
+export function addRoomDisplayFlag(
+  roomGridIndex: int | undefined,
+  displayFlag: DisplayFlag,
+  updateVisibility = true,
+): void {
+  if (MinimapAPI === undefined) {
+    const roomDescriptor = getRoomDescriptor(roomGridIndex);
+    roomDescriptor.DisplayFlags = addFlag(
+      roomDescriptor.DisplayFlags,
+      displayFlag,
+    );
+  } else {
+    if (roomGridIndex === undefined) {
+      roomGridIndex = getRoomGridIndex();
+    }
+    const roomDescriptor = MinimapAPI.GetRoomByIdx(roomGridIndex);
+    if (roomDescriptor !== undefined) {
+      roomDescriptor.DisplayFlags = addFlag(
+        roomDescriptor.DisplayFlags,
+        displayFlag,
+      );
+    }
+  }
+
+  if (updateVisibility) {
+    const level = game.GetLevel();
+    level.UpdateVisibility();
+  }
+}
+
 /**
  * Helper function to set the value of `DisplayFlag` for every room on the floor to 0.
  *
@@ -66,7 +106,8 @@ export function setDisplayFlags(
 
   for (const [roomGridIndex, displayFlags] of displayFlagsMap.entries()) {
     if (MinimapAPI === undefined) {
-      setRoomDisplayFlags(roomGridIndex, displayFlags);
+      // We pass false to the `updateVisibility` argument as a small optimization.
+      setRoomDisplayFlags(roomGridIndex, displayFlags, false);
     } else {
       const roomDescriptor = MinimapAPI.GetRoomByIdx(roomGridIndex);
       if (roomDescriptor !== undefined) {
@@ -90,16 +131,46 @@ export function setFloorDisplayFlags(
  * Helper function to set a particular room's minimap display flags (e.g. whether or not it is
  * visible and so on).
  *
- * You must call the `Level.UpdateVisibility` method after using this function for the changes to
- * take effect.
- *
  * @param roomGridIndex Set to undefined to use the current room index.
  * @param displayFlags The bit flags value to set. (See the `DisplayFlag` enum.)
+ * @param updateVisibility Optional. Whether to call the `Level.UpdateVisibility` method in order to
+ *                         make the changes immediately visible. Default is true.
  */
 export function setRoomDisplayFlags(
   roomGridIndex: int | undefined,
   displayFlags: BitFlags<DisplayFlag>,
+  updateVisibility = true,
 ): void {
-  const roomDescriptor = getRoomDescriptor(roomGridIndex);
-  roomDescriptor.DisplayFlags = displayFlags;
+  if (MinimapAPI === undefined) {
+    const roomDescriptor = getRoomDescriptor(roomGridIndex);
+    roomDescriptor.DisplayFlags = displayFlags;
+  } else {
+    if (roomGridIndex === undefined) {
+      roomGridIndex = getRoomGridIndex();
+    }
+    const roomDescriptor = MinimapAPI.GetRoomByIdx(roomGridIndex);
+    if (roomDescriptor !== undefined) {
+      roomDescriptor.DisplayFlags = displayFlags;
+    }
+  }
+
+  if (updateVisibility) {
+    const level = game.GetLevel();
+    level.UpdateVisibility();
+  }
+}
+
+/**
+ * Helper function to make a single room visible in a similar way to how the Compass makes a Boss
+ * Room visible (e.g. by adding `DisplayFlag.SHOW_ICON`).
+ *
+ * @param roomGridIndex Set to undefined to use the current room index.
+ * @param updateVisibility Optional. Whether to call the `Level.UpdateVisibility` method in order to
+ *                         make the changes immediately visible. Default is true.
+ */
+export function setRoomVisible(
+  roomGridIndex: int | undefined,
+  updateVisibility = true,
+): void {
+  addRoomDisplayFlag(roomGridIndex, DisplayFlag.SHOW_ICON, updateVisibility);
 }

package/src/functions/string.ts

@@ -55,6 +55,12 @@ export function removeCharactersBefore(
   return string.slice(index);
 }
 
+/** Helper function to remove all characters from a string that are not letters or numbers. */
+export function removeNonAlphanumericCharacters(str: string): string {
+  const [returnValue, _] = string.gsub(str, "%W", "");
+  return returnValue;
+}
+
 /**
  * Helper function to remove one or more substrings from a string, if they exist. Returns the
  * modified string.

package/src/functions/trinkets.ts

@@ -13,7 +13,10 @@ import {
   DEFAULT_TRINKET_DESCRIPTION,
   TRINKET_DESCRIPTION_MAP,
 } from "../maps/trinketDescriptionMap";
-import { DEFAULT_TRINKET_NAME, TRINKET_NAME_MAP } from "../maps/trinketNameMap";
+import {
+  DEFAULT_TRINKET_NAME,
+  TRINKET_TYPE_TO_NAME_MAP,
+} from "../maps/trinketTypeToNameMap";
 import { getEntityID } from "./entities";
 import { isTrinket } from "./pickupVariants";
 import { isCharacter } from "./players";
@@ -123,7 +126,7 @@ export function getTrinketGfxFilename(trinketType: TrinketType): string {
 export function getTrinketName(trinketType: TrinketType): string {
   // "ItemConfigItem.Name" is bugged with vanilla items on patch v1.7.6, so we use a hard-coded map
   // as a workaround.
-  const trinketName = TRINKET_NAME_MAP.get(trinketType);
+  const trinketName = TRINKET_TYPE_TO_NAME_MAP.get(trinketType);
   if (trinketName !== undefined) {
     return trinketName;
   }

package/src/index.ts

@@ -159,10 +159,10 @@ export * from "./interfaces/RoomDescription";
 export * from "./interfaces/SaveData";
 export * from "./interfaces/StatTypeType";
 export * from "./interfaces/TrinketSituation";
-export * from "./maps/cardMap";
-export * from "./maps/characterMap";
-export * from "./maps/pillEffectMap";
-export * from "./maps/roomTypeMap";
+export * from "./maps/cardNameToTypeMap";
+export * from "./maps/characterNameToTypeMap";
+export * from "./maps/pillNameToEffectMap";
+export * from "./maps/roomNameToTypeMap";
 export * from "./objects/colors";
 export * from "./types/AnyEntity";
 export * from "./types/AnyGridEntity";

package/src/maps/{cardMap.ts → cardNameToTypeMap.ts}

@@ -2,8 +2,8 @@ import { CardType } from "isaac-typescript-definitions";
 
 // cspell:ignore hiero
 
-/** Maps card names to card sub-types. */
-export const CARD_MAP: ReadonlyMap<string, CardType> = new Map([
+/** Maps card names to the values of the `CardType` enum. */
+export const CARD_NAME_TO_TYPE_MAP: ReadonlyMap<string, CardType> = new Map([
   ["fool", CardType.FOOL], // 1
   ["magician", CardType.MAGICIAN], // 2
   ["mag", CardType.MAGICIAN], // 2 - Needed since we have "mag?"

package/src/maps/characterNameToTypeMap.ts

@@ -0,0 +1,88 @@
+import { PlayerType } from "isaac-typescript-definitions";
+
+/** Maps character names to the values of the `PlayerType` enum. */
+export const CHARACTER_NAME_TO_TYPE_MAP = new Map<string, PlayerType>([
+  ["isaac", PlayerType.ISAAC], // 0
+  ["magdalene", PlayerType.MAGDALENE], // 1
+  ["maggy", PlayerType.MAGDALENE], // 1
+  ["cain", PlayerType.CAIN], // 2
+  ["judas", PlayerType.JUDAS], // 3
+  ["blueBaby", PlayerType.BLUE_BABY], // 4
+  ["bb", PlayerType.BLUE_BABY], // 4
+  ["eve", PlayerType.EVE], // 5
+  ["samson", PlayerType.SAMSON], // 6
+  ["azazel", PlayerType.AZAZEL], // 7
+  ["lazarus", PlayerType.LAZARUS], // 8
+  // Needed so that "laz2" does not take precedence over "lazarus".
+  ["laz", PlayerType.LAZARUS], // 8
+  ["eden", PlayerType.EDEN], // 9
+  ["theLost", PlayerType.THE_LOST], // 10
+  ["lost", PlayerType.THE_LOST], // 10
+  ["lazarus2", PlayerType.LAZARUS_2], // 11
+  ["laz2", PlayerType.LAZARUS_2], // 11
+  ["darkJudas", PlayerType.DARK_JUDAS], // 12
+  ["dJudas", PlayerType.DARK_JUDAS], // 12
+  ["blackJudas", PlayerType.DARK_JUDAS], // 12
+  ["bJudas", PlayerType.DARK_JUDAS], // 12
+  ["lilith", PlayerType.LILITH], // 13
+  ["keeper", PlayerType.KEEPER], // 14
+  ["apollyon", PlayerType.APOLLYON], // 15
+  ["theForgotten", PlayerType.THE_FORGOTTEN], // 16
+  ["forgotten", PlayerType.THE_FORGOTTEN], // 16
+  ["theSoul", PlayerType.THE_SOUL], // 17
+  ["soul", PlayerType.THE_SOUL], // 17
+  ["bethany", PlayerType.BETHANY], // 18
+  ["jacob", PlayerType.JACOB], // 19
+  ["esau", PlayerType.ESAU], // 20
+  ["taintedIsaac", PlayerType.ISAAC_B], // 21
+  ["tIsaac", PlayerType.ISAAC_B], // 21
+  ["taintedMagdalene", PlayerType.MAGDALENE_B], // 22
+  ["tMagdalene", PlayerType.MAGDALENE_B], // 22
+  ["taintedMaggy", PlayerType.MAGDALENE_B], // 22
+  ["tMaggy", PlayerType.MAGDALENE_B], // 22
+  ["taintedCain", PlayerType.CAIN_B], // 23
+  ["tCain", PlayerType.CAIN_B], // 23
+  ["taintedJudas", PlayerType.JUDAS_B], // 24
+  ["tJudas", PlayerType.JUDAS_B], // 24
+  ["taintedBlueBaby", PlayerType.BLUE_BABY_B], // 25
+  ["tBlueBaby", PlayerType.BLUE_BABY_B], // 25
+  ["tbb", PlayerType.BLUE_BABY_B], // 25
+  ["taintedEve", PlayerType.EVE_B], // 26
+  ["tEve", PlayerType.EVE_B], // 26
+  ["taintedSamson", PlayerType.SAMSON_B], // 27
+  ["tSamson", PlayerType.SAMSON_B], // 27
+  ["taintedAzazel", PlayerType.AZAZEL_B], // 28
+  ["tAzazel", PlayerType.AZAZEL_B], // 28
+  ["taintedLazarus", PlayerType.LAZARUS_B], // 29
+  ["tLazarus", PlayerType.LAZARUS_B], // 29
+  ["taintedLaz", PlayerType.LAZARUS_B], // 29
+  ["tLaz", PlayerType.LAZARUS_B], // 29
+  ["taintedEden", PlayerType.EDEN_B], // 30
+  ["tEden", PlayerType.EDEN_B], // 30
+  ["taintedLost", PlayerType.THE_LOST_B], // 31
+  ["tLost", PlayerType.THE_LOST_B], // 31
+  ["taintedLilith", PlayerType.LILITH_B], // 32
+  ["tLilith", PlayerType.LILITH_B], // 32
+  ["taintedKeeper", PlayerType.KEEPER_B], // 33
+  ["tKeeper", PlayerType.KEEPER_B], // 33
+  ["taintedApollyon", PlayerType.APOLLYON_B], // 34
+  ["tApollyon", PlayerType.APOLLYON_B], // 34
+  ["taintedForgotten", PlayerType.THE_FORGOTTEN_B], // 35
+  ["tForgotten", PlayerType.THE_FORGOTTEN_B], // 35
+  ["taintedBethany", PlayerType.BETHANY_B], // 36
+  ["tBethany", PlayerType.BETHANY_B], // 36
+  ["taintedJacob", PlayerType.JACOB_B], // 37
+  ["tJacob", PlayerType.JACOB_B], // 37
+  ["taintedLazarusDead", PlayerType.LAZARUS_2_B], // 38
+  ["tLazarusDead", PlayerType.LAZARUS_2_B], // 38
+  ["taintedLazDead", PlayerType.LAZARUS_2_B], // 38
+  ["tLazDead", PlayerType.LAZARUS_2_B], // 38
+  ["deadTaintedLazarus", PlayerType.LAZARUS_2_B], // 38
+  ["deadTLazarus", PlayerType.LAZARUS_2_B], // 38
+  ["deadTaintedLaz", PlayerType.LAZARUS_2_B], // 38
+  ["deadTLaz", PlayerType.LAZARUS_2_B], // 38
+  ["taintedJacobGhost", PlayerType.JACOB_2_B], // 39
+  ["tJacobGhost", PlayerType.JACOB_2_B], // 39
+  ["taintedSoul", PlayerType.THE_SOUL_B], // 40
+  ["tSoul", PlayerType.THE_SOUL_B], // 40
+]);

package/src/maps/collectibleDescriptionMap.ts

@@ -5,8 +5,12 @@ import { CollectibleType } from "isaac-typescript-definitions";
 
 export const DEFAULT_COLLECTIBLE_DESCRIPTION = "Unknown";
 
-// This is a temporary map due to missing features in the vanilla API. (Otherwise, this would be
-// converted to a type-safe object.)
+/**
+ * Maps collectible types to the real English descriptions from the "stringtable.sta" file.
+ *
+ * This is a temporary map due to missing features in the vanilla API. (Otherwise, this would be
+ * converted to a type-safe object.)
+ */
 export const COLLECTIBLE_DESCRIPTION_MAP: ReadonlyMap<CollectibleType, string> =
   new Map([
     [1, "Tears up"],

package/src/maps/collectibleNameToTypeMap.ts

@@ -0,0 +1,19 @@
+import { CollectibleType } from "isaac-typescript-definitions";
+import { removeNonAlphanumericCharacters } from "../functions/string";
+import { COLLECTIBLE_TYPE_TO_NAME_MAP } from "./collectibleTypeToNameMap";
+
+/**
+ * Maps collectible names to the values of the `CollectibleType` enum.
+ *
+ * For a mapping of `CollectibleType` to name, see `COLLECTIBLE_TYPE_TO_NAME_MAP`.
+ */
+const collectibleNameToTypeMap = new Map<string, CollectibleType>();
+for (const [collectibleType, name] of COLLECTIBLE_TYPE_TO_NAME_MAP) {
+  const simpleString = removeNonAlphanumericCharacters(name);
+  collectibleNameToTypeMap.set(simpleString, collectibleType);
+}
+
+export const COLLECTIBLE_NAME_TO_TYPE_MAP: ReadonlyMap<
+  string,
+  CollectibleType
+> = collectibleNameToTypeMap;