isaacscript-common 9.14.0 → 9.15.0

package/dist/maps/{pillEffectMap.lua → pillNameToEffectMap.lua}

@@ -5,7 +5,7 @@ local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local PillEffect = ____isaac_2Dtypescript_2Ddefinitions.PillEffect
 --- Maps pill effect names to the values of the `PillEffect` enum.
-____exports.PILL_EFFECT_MAP = __TS__New(Map, {
+____exports.PILL_NAME_TO_EFFECT_MAP = __TS__New(Map, {
     {"badGas", PillEffect.BAD_GAS},
     {"gas", PillEffect.BAD_GAS},
     {"badTrip", PillEffect.BAD_TRIP},

package/dist/maps/roomNameToTypeMap.d.ts

@@ -0,0 +1,4 @@
+import { RoomType } from "isaac-typescript-definitions";
+/** Maps room names to the values of the `RoomType` enum. */
+export declare const ROOM_NAME_TO_TYPE_MAP: ReadonlyMap<string, RoomType>;
+//# sourceMappingURL=roomNameToTypeMap.d.ts.map

package/dist/maps/roomNameToTypeMap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"roomNameToTypeMap.d.ts","sourceRoot":"","sources":["../../src/maps/roomNameToTypeMap.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AAExD,4DAA4D;AAC5D,eAAO,MAAM,qBAAqB,EAAE,WAAW,CAAC,MAAM,EAAE,QAAQ,CAmC9D,CAAC"}

package/dist/maps/{roomTypeMap.lua → roomNameToTypeMap.lua}

@@ -4,8 +4,8 @@ local __TS__New = ____lualib.__TS__New
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
---- Maps room type names to room types.
-____exports.ROOM_TYPE_MAP = __TS__New(Map, {
+--- Maps room names to the values of the `RoomType` enum.
+____exports.ROOM_NAME_TO_TYPE_MAP = __TS__New(Map, {
     {"default", RoomType.DEFAULT},
     {"shop", RoomType.SHOP},
     {"error", RoomType.ERROR},

package/dist/maps/trinketDescriptionMap.d.ts

@@ -1,4 +1,10 @@
 import { TrinketType } from "isaac-typescript-definitions";
 export declare const DEFAULT_TRINKET_DESCRIPTION = "Unknown";
+/**
+ * Maps trinket 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 declare const TRINKET_DESCRIPTION_MAP: ReadonlyMap<TrinketType, string>;
 //# sourceMappingURL=trinketDescriptionMap.d.ts.map

package/dist/maps/trinketDescriptionMap.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"trinketDescriptionMap.d.ts","sourceRoot":"","sources":["../../src/maps/trinketDescriptionMap.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAE3D,eAAO,MAAM,2BAA2B,YAAY,CAAC;AAIrD,eAAO,MAAM,uBAAuB,EAAE,WAAW,CAAC,WAAW,EAAE,MAAM,CA8LjE,CAAC"}
+{"version":3,"file":"trinketDescriptionMap.d.ts","sourceRoot":"","sources":["../../src/maps/trinketDescriptionMap.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAE3D,eAAO,MAAM,2BAA2B,YAAY,CAAC;AAErD;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB,EAAE,WAAW,CAAC,WAAW,EAAE,MAAM,CA8LjE,CAAC"}

package/dist/maps/trinketDescriptionMap.lua

@@ -3,6 +3,10 @@ local Map = ____lualib.Map
 local __TS__New = ____lualib.__TS__New
 local ____exports = {}
 ____exports.DEFAULT_TRINKET_DESCRIPTION = "Unknown"
+--- Maps trinket 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.)
 ____exports.TRINKET_DESCRIPTION_MAP = __TS__New(Map, {
     {1, "Gulp!"},
     {2, "It feels lucky?"},

package/dist/maps/trinketNameToTypeMap.d.ts

@@ -0,0 +1,3 @@
+import { TrinketType } from "isaac-typescript-definitions";
+export declare const TRINKET_NAME_TO_TYPE_MAP: ReadonlyMap<string, TrinketType>;
+//# sourceMappingURL=trinketNameToTypeMap.d.ts.map

package/dist/maps/trinketNameToTypeMap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trinketNameToTypeMap.d.ts","sourceRoot":"","sources":["../../src/maps/trinketNameToTypeMap.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAe3D,eAAO,MAAM,wBAAwB,EAAE,WAAW,CAAC,MAAM,EAAE,WAAW,CAChD,CAAC"}

package/dist/maps/trinketNameToTypeMap.lua

@@ -0,0 +1,21 @@
+local ____lualib = require("lualib_bundle")
+local Map = ____lualib.Map
+local __TS__New = ____lualib.__TS__New
+local __TS__Iterator = ____lualib.__TS__Iterator
+local ____exports = {}
+local ____string = require("functions.string")
+local removeNonAlphanumericCharacters = ____string.removeNonAlphanumericCharacters
+local ____trinketTypeToNameMap = require("maps.trinketTypeToNameMap")
+local TRINKET_TYPE_TO_NAME_MAP = ____trinketTypeToNameMap.TRINKET_TYPE_TO_NAME_MAP
+--- Maps trinket names to the values of the `TrinketType` enum.
+-- 
+-- For a mapping of `TrinketType` to name, see `TRINKET_TYPE_TO_NAME_MAP`.
+local trinketNameToTypeMap = __TS__New(Map)
+for ____, ____value in __TS__Iterator(TRINKET_TYPE_TO_NAME_MAP) do
+    local trinketType = ____value[1]
+    local name = ____value[2]
+    local simpleString = removeNonAlphanumericCharacters(nil, name)
+    trinketNameToTypeMap:set(simpleString, trinketType)
+end
+____exports.TRINKET_NAME_TO_TYPE_MAP = trinketNameToTypeMap
+return ____exports

package/dist/maps/trinketTypeToNameMap.d.ts

@@ -0,0 +1,12 @@
+import { TrinketType } from "isaac-typescript-definitions";
+export declare const DEFAULT_TRINKET_NAME = "Unknown";
+/**
+ * Maps trinket types to the real English names 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.)
+ *
+ * For a mapping of name to `TrinketType`, see `TRINKET_NAME_TO_TYPE_MAP`.
+ */
+export declare const TRINKET_TYPE_TO_NAME_MAP: ReadonlyMap<TrinketType, string>;
+//# sourceMappingURL=trinketTypeToNameMap.d.ts.map

package/dist/maps/trinketTypeToNameMap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trinketTypeToNameMap.d.ts","sourceRoot":"","sources":["../../src/maps/trinketTypeToNameMap.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAE3D,eAAO,MAAM,oBAAoB,YAAY,CAAC;AAE9C;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB,EAAE,WAAW,CAAC,WAAW,EAAE,MAAM,CA8LlE,CAAC"}

package/dist/maps/{trinketNameMap.lua → trinketTypeToNameMap.lua}

@@ -3,7 +3,13 @@ local Map = ____lualib.Map
 local __TS__New = ____lualib.__TS__New
 local ____exports = {}
 ____exports.DEFAULT_TRINKET_NAME = "Unknown"
-____exports.TRINKET_NAME_MAP = __TS__New(Map, {
+--- Maps trinket types to the real English names 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.)
+-- 
+-- For a mapping of name to `TrinketType`, see `TRINKET_NAME_TO_TYPE_MAP`.
+____exports.TRINKET_TYPE_TO_NAME_MAP = __TS__New(Map, {
     {1, "Swallowed Penny"},
     {2, "Petrified Poop"},
     {3, "AAA Battery"},

package/dist/objects/characterDamageMultipliers.lua

@@ -16,7 +16,7 @@ ____exports.CHARACTER_DAMAGE_MULTIPLIERS = {
     [PlayerType.EDEN] = 1,
     [PlayerType.THE_LOST] = 1,
     [PlayerType.LAZARUS_2] = 1.4,
-    [PlayerType.BLACK_JUDAS] = 2,
+    [PlayerType.DARK_JUDAS] = 2,
     [PlayerType.LILITH] = 1,
     [PlayerType.KEEPER] = 1.2,
     [PlayerType.APOLLYON] = 1,

package/dist/objects/characterNames.lua

@@ -15,7 +15,7 @@ ____exports.CHARACTER_NAMES = {
     [PlayerType.EDEN] = "Eden",
     [PlayerType.THE_LOST] = "The Lost",
     [PlayerType.LAZARUS_2] = "Lazarus II",
-    [PlayerType.BLACK_JUDAS] = "Dark Judas",
+    [PlayerType.DARK_JUDAS] = "Dark Judas",
     [PlayerType.LILITH] = "Lilith",
     [PlayerType.KEEPER] = "Keeper",
     [PlayerType.APOLLYON] = "Apollyon",

package/dist/objects/playerNamePNGFileNames.lua

@@ -16,7 +16,7 @@ ____exports.PLAYER_NAME_PNG_FILE_NAMES = {
     [PlayerType.EDEN] = "playername_09_eden.png",
     [PlayerType.THE_LOST] = "playername_12_thelost.png",
     [PlayerType.LAZARUS_2] = "playername_10_lazarus.png",
-    [PlayerType.BLACK_JUDAS] = "playername_04_judas.png",
+    [PlayerType.DARK_JUDAS] = "playername_04_judas.png",
     [PlayerType.LILITH] = "playername_13_lilith.png",
     [PlayerType.KEEPER] = "playername_14_thekeeper.png",
     [PlayerType.APOLLYON] = "playername_15_apollyon.png",

package/dist/objects/playerPortraitPNGFileNames.lua

@@ -16,7 +16,7 @@ ____exports.PLAYER_PORTRAIT_PNG_FILE_NAMES = {
     [PlayerType.EDEN] = "playerportrait_eden.png",
     [PlayerType.THE_LOST] = "playerportrait_thelost.png",
     [PlayerType.LAZARUS_2] = "playerportrait_lazarus2.png",
-    [PlayerType.BLACK_JUDAS] = "playerportrait_darkjudas.png",
+    [PlayerType.DARK_JUDAS] = "playerportrait_darkjudas.png",
     [PlayerType.LILITH] = "playerportrait_lilith.png",
     [PlayerType.KEEPER] = "playerportrait_keeper.png",
     [PlayerType.APOLLYON] = "playerportrait_apollyon.png",

package/dist/sets/charactersWithBlackHeartFromEternalHeartSet.lua

@@ -4,5 +4,5 @@ local __TS__New = ____lualib.__TS__New
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
-____exports.CHARACTERS_WITH_BLACK_HEART_FROM_ETERNAL_HEART_SET = __TS__New(Set, {PlayerType.BLACK_JUDAS, PlayerType.JUDAS_B})
+____exports.CHARACTERS_WITH_BLACK_HEART_FROM_ETERNAL_HEART_SET = __TS__New(Set, {PlayerType.DARK_JUDAS, PlayerType.JUDAS_B})
 return ____exports

package/dist/sets/charactersWithNoRedHeartsSet.lua

@@ -9,7 +9,7 @@ local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
 ____exports.CHARACTERS_WITH_NO_RED_HEARTS_SET = __TS__New(Set, {
     PlayerType.BLUE_BABY,
     PlayerType.THE_LOST,
-    PlayerType.BLACK_JUDAS,
+    PlayerType.DARK_JUDAS,
     PlayerType.JUDAS_B,
     PlayerType.BLUE_BABY_B,
     PlayerType.THE_LOST_B,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "9.14.0",
+  "version": "9.15.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -22,6 +22,6 @@
   "main": "dist/index",
   "types": "dist/index.d.ts",
   "dependencies": {
-    "isaac-typescript-definitions": "^4.0.6"
+    "isaac-typescript-definitions": "^4.0.7"
   }
 }

package/src/features/extraConsoleCommands/listCommands.ts

@@ -85,7 +85,7 @@ import { runMergeTests } from "../../functions/mergeTests";
 import {
   spawnCard,
   spawnPill,
-  spawnTrinket,
+  spawnTrinket as spawnTrinketFunction,
 } from "../../functions/pickupsSpecific";
 import { getPillEffectName } from "../../functions/pills";
 import { getPlayers } from "../../functions/playerIndex";
@@ -99,14 +99,21 @@ import { gridCoordinatesToWorldPosition } from "../../functions/roomGrid";
 import { changeRoom } from "../../functions/rooms";
 import { reloadRoom as reloadRoomFunction } from "../../functions/roomTransition";
 import { onSetSeed, restart, setUnseeded } from "../../functions/run";
+import { spawnCollectible as spawnCollectibleFunction } from "../../functions/spawnCollectible";
 import { setStage } from "../../functions/stage";
 import { getGoldenTrinketType } from "../../functions/trinkets";
-import { asCardType } from "../../functions/types";
+import {
+  asCardType,
+  asCollectibleType,
+  asTrinketType,
+} from "../../functions/types";
 import { irange, printConsole, printEnabled } from "../../functions/utils";
-import { CARD_MAP } from "../../maps/cardMap";
-import { CHARACTER_MAP } from "../../maps/characterMap";
-import { PILL_EFFECT_MAP } from "../../maps/pillEffectMap";
-import { ROOM_TYPE_MAP } from "../../maps/roomTypeMap";
+import { CARD_NAME_TO_TYPE_MAP } from "../../maps/cardNameToTypeMap";
+import { CHARACTER_NAME_TO_TYPE_MAP } from "../../maps/characterNameToTypeMap";
+import { COLLECTIBLE_NAME_TO_TYPE_MAP } from "../../maps/collectibleNameToTypeMap";
+import { PILL_NAME_TO_EFFECT_MAP } from "../../maps/pillNameToEffectMap";
+import { ROOM_NAME_TO_TYPE_MAP } from "../../maps/roomNameToTypeMap";
+import { TRINKET_NAME_TO_TYPE_MAP } from "../../maps/trinketNameToTypeMap";
 import { getLastCardType, getLastPillEffect } from "../firstLast";
 import {
   addHeart,
@@ -343,7 +350,7 @@ export function card(params: string): void {
   let cardType: CardType;
   const num = tonumber(params) as CardType | undefined;
   if (num === undefined) {
-    const match = getMapPartialMatch(params, CARD_MAP);
+    const match = getMapPartialMatch(params, CARD_NAME_TO_TYPE_MAP);
     if (match === undefined) {
       printConsole(`Unknown card: ${params}`);
       return;
@@ -414,7 +421,7 @@ export function character(params: string): void {
   let playerType: PlayerType;
   const num = tonumber(params) as PlayerType | undefined;
   if (num === undefined) {
-    const match = getMapPartialMatch(params, CHARACTER_MAP);
+    const match = getMapPartialMatch(params, CHARACTER_NAME_TO_TYPE_MAP);
     if (match === undefined) {
       printConsole(`Unknown character: ${params}`);
       return;
@@ -940,7 +947,7 @@ export function pill(params: string): void {
   let pillEffect: PillEffect;
   const num = tonumber(params) as PillEffect | undefined;
   if (num === undefined) {
-    const match = getMapPartialMatch(params, PILL_EFFECT_MAP);
+    const match = getMapPartialMatch(params, PILL_NAME_TO_EFFECT_MAP);
     if (match === undefined) {
       printConsole(`Unknown pill effect: ${params}`);
       return;
@@ -1315,25 +1322,87 @@ export function spam(): void {
   printEnabled(v.run.spamBloodRights, "spamming Blood Rights");
 }
 
+export function spawnCollectible(params: string): void {
+  if (params === "") {
+    printConsole(
+      "You must specify the name or number corresponding to the collectible type.",
+    );
+    return;
+  }
+
+  const collectibleTypeNumber = tonumber(params);
+  let collectibleType: CollectibleType;
+  if (collectibleTypeNumber === undefined) {
+    const match = getMapPartialMatch(params, COLLECTIBLE_NAME_TO_TYPE_MAP);
+    if (match === undefined) {
+      printConsole(`Unknown collectible: ${params}`);
+      return;
+    }
+
+    collectibleType = match[1];
+  } else {
+    collectibleType = asCollectibleType(collectibleTypeNumber);
+  }
+
+  const roomClass = game.GetRoom();
+  const centerPos = roomClass.GetCenterPos();
+  spawnCollectibleFunction(collectibleType, centerPos);
+}
+
 /** Spawns a golden version of the specified trinket type. */
 export function spawnGoldenTrinket(params: string): void {
   if (params === "") {
     printConsole(
-      "You must specify the number corresponding to the trinket type.",
+      "You must specify the name or number corresponding to the trinket type.",
     );
     return;
   }
 
-  const trinketType = tonumber(params) as TrinketType | undefined;
-  if (trinketType === undefined) {
-    printConsole(`That is an invalid trinket type: ${params}`);
-    return;
+  const trinketTypeNumber = tonumber(params);
+  let trinketType: TrinketType;
+  if (trinketTypeNumber === undefined) {
+    const match = getMapPartialMatch(params, TRINKET_NAME_TO_TYPE_MAP);
+    if (match === undefined) {
+      printConsole(`Unknown trinket: ${params}`);
+      return;
+    }
+
+    trinketType = match[1];
+  } else {
+    trinketType = asTrinketType(trinketTypeNumber);
   }
 
+  const roomClass = game.GetRoom();
+  const centerPos = roomClass.GetCenterPos();
   const goldenTrinketType = getGoldenTrinketType(trinketType);
+  spawnTrinketFunction(goldenTrinketType, centerPos);
+}
+
+export function spawnTrinket(params: string): void {
+  if (params === "") {
+    printConsole(
+      "You must specify the name or number corresponding to the trinket type.",
+    );
+    return;
+  }
+
+  const trinketTypeNumber = tonumber(params);
+  let trinketType: TrinketType;
+  if (trinketTypeNumber === undefined) {
+    const match = getMapPartialMatch(params, TRINKET_NAME_TO_TYPE_MAP);
+    if (match === undefined) {
+      printConsole(`Unknown trinket: ${params}`);
+      return;
+    }
+
+    trinketType = match[1];
+  } else {
+    trinketType = asTrinketType(trinketTypeNumber);
+  }
+
   const roomClass = game.GetRoom();
   const centerPos = roomClass.GetCenterPos();
-  spawnTrinket(goldenTrinketType, centerPos);
+  spawnTrinketFunction(trinketType, centerPos);
 }
 
 /** Toggles maximum movement speed and flight for the player. */
@@ -1441,7 +1510,7 @@ export function warp(params: string): void {
   let roomType: RoomType;
   const num = tonumber(params) as RoomType | undefined;
   if (num === undefined) {
-    const match = getMapPartialMatch(params, ROOM_TYPE_MAP);
+    const match = getMapPartialMatch(params, ROOM_NAME_TO_TYPE_MAP);
     if (match === undefined) {
       printConsole(`Unknown room type: ${params}`);
       return;

package/src/functions/collectibles.ts

@@ -20,9 +20,9 @@ import {
   DEFAULT_COLLECTIBLE_DESCRIPTION,
 } from "../maps/collectibleDescriptionMap";
 import {
-  COLLECTIBLE_NAME_MAP,
+  COLLECTIBLE_TYPE_TO_NAME_MAP,
   DEFAULT_COLLECTIBLE_NAME,
-} from "../maps/collectibleNameMap";
+} from "../maps/collectibleTypeToNameMap";
 import { SINGLE_USE_ACTIVE_COLLECTIBLE_TYPES_SET } from "../sets/singleUseActiveCollectibleTypesSet";
 import { CollectibleIndex } from "../types/CollectibleIndex";
 import { getEntityID } from "./entities";
@@ -308,7 +308,7 @@ export function getCollectibleMaxCharges(
 export function getCollectibleName(collectibleType: CollectibleType): string {
   // "ItemConfigItem.Name" is bugged with vanilla items on patch v1.7.6, so we use a hard-coded map
   // as a workaround.
-  const collectibleName = COLLECTIBLE_NAME_MAP.get(collectibleType);
+  const collectibleName = COLLECTIBLE_TYPE_TO_NAME_MAP.get(collectibleType);
   if (collectibleName !== undefined) {
     return collectibleName;
   }

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;