isaacscript-common 45.0.0 → 47.0.0

package/src/functions/pickups.ts

@@ -1,18 +1,74 @@
 import type {
+  BatterySubType,
+  BombSubType,
   CoinSubType,
   HeartSubType,
+  KeySubType,
   PickupVariant,
+  SackSubType,
 } from "isaac-typescript-definitions";
 import { CHEST_PICKUP_VARIANTS_SET } from "../core/constants";
+import { BATTERY_NAMES, DEFAULT_BATTERY_NAME } from "../objects/batteryNames";
+import { BOMB_NAMES, DEFAULT_BOMB_NAME } from "../objects/bombNames";
+import { CHEST_NAMES } from "../objects/chestNames";
+import { COIN_NAMES, DEFAULT_COIN_NAME } from "../objects/coinNames";
 import {
   COIN_SUB_TYPE_TO_VALUE,
   DEFAULT_COIN_VALUE,
 } from "../objects/coinSubTypeToValue";
+import { DEFAULT_HEART_NAME, HEART_NAMES } from "../objects/heartNames";
+import { DEFAULT_KEY_NAME, KEY_NAMES } from "../objects/keyNames";
+import { DEFAULT_SACK_NAME, SACK_NAMES } from "../objects/sackNames";
 import { RED_HEART_SUB_TYPES_SET } from "../sets/redHeartSubTypesSet";
 import { removeEntities } from "./entities";
 import { isHeart } from "./pickupVariants";
 import { getHearts } from "./pickupsSpecific";
 
+/**
+ * Helper function to get a battery name from a `BatterySubType`, as listed in the "entities2.xml"
+ * file.
+ *
+ * For example, `getBatteryName(BatterySubType.MICRO)` would return "Micro Battery".
+ */
+export function getBatteryName(batterySubType: BatterySubType): string {
+  // Handle modded hearts.
+  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+  return BATTERY_NAMES[batterySubType] ?? DEFAULT_BATTERY_NAME;
+}
+
+/**
+ * Helper function to get a bomb name from a `BombSubType`, as listed in the "entities2.xml" file.
+ *
+ * For example, `getBombName(BombSubType.DOUBLE_PACK)` would return "Double Bomb".
+ */
+export function getBombName(bombSubType: BombSubType): string {
+  // Handle modded bombs.
+  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+  return BOMB_NAMES[bombSubType] ?? DEFAULT_BOMB_NAME;
+}
+
+/**
+ * Helper function to get a chest name from a `PickupVariant`, as listed in the "entities2.xml"
+ * file. Returns "Unknown" if the pickup variant was not a chest.
+ *
+ * For example, `getChestName(PickupVariant.SPIKED_CHEST)` would return "Spiked Chest".
+ */
+export function getChestName(pickupVariant: PickupVariant): string {
+  const chestNames = CHEST_NAMES as Partial<Record<PickupVariant, string>>;
+  return chestNames[pickupVariant] ?? "Unknown";
+}
+
+/**
+ * Helper function to get a coin name from a `CoinSubType`, as listed in the "entities2.xml" file.
+ *
+ * For example, `getCoinName(CoinSubType.DOUBLE_PACK)` would return "Double Penny".
+ */
+export function getCoinName(coinSubType: CoinSubType): string {
+  // Handle modded coins.
+  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+  return COIN_NAMES[coinSubType] ?? DEFAULT_COIN_NAME;
+}
+
 /**
  * Helper function to get the corresponding coin amount from a `CoinSubType`. Returns 1 for modded
  * sub-types.
@@ -24,12 +80,45 @@ export function getCoinValue(coinSubType: CoinSubType): int {
   return value ?? DEFAULT_COIN_VALUE;
 }
 
+/**
+ * Helper function to get a heart name from a `HeartSubType`, as listed in the "entities2.xml" file.
+ *
+ * For example, `getHeartName(HeartSubType.ETERNAL)` would return "Heart (eternal)".
+ */
+export function getHeartName(heartSubType: HeartSubType): string {
+  // Handle modded hearts.
+  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+  return HEART_NAMES[heartSubType] ?? DEFAULT_HEART_NAME;
+}
+
+/**
+ * Helper function to get a key name from a `KeySubType`, as listed in the "entities2.xml" file.
+ *
+ * For example, `getKeyName(KeySubType.DOUBLE_PACK)` would return "Key Ring".
+ */
+export function getKeyName(keySubType: KeySubType): string {
+  // Handle modded bombs.
+  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+  return KEY_NAMES[keySubType] ?? DEFAULT_KEY_NAME;
+}
+
 /** Helper function to get all of the red heart pickup entities in the room. */
 export function getRedHearts(): EntityPickupHeart[] {
   const hearts = getHearts();
   return hearts.filter((heart) => RED_HEART_SUB_TYPES_SET.has(heart.SubType));
 }
 
+/**
+ * Helper function to get a sack name from a `SackSubType`, as listed in the "entities2.xml" file.
+ *
+ * For example, `getSackName(SackSubType.NORMAL)` would return "Grab Bag".
+ */
+export function getSackName(sackSubType: SackSubType): string {
+  // Handle modded hearts.
+  // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+  return SACK_NAMES[sackSubType] ?? DEFAULT_SACK_NAME;
+}
+
 /** Helper function to test if the provided pickup matches one of the various chest variants. */
 export function isChest(pickup: EntityPickup): boolean {
   return isChestVariant(pickup.Variant);

package/src/functions/pills.ts

@@ -149,7 +149,9 @@ export function getPillEffectClass(
 }
 
 /**
- * Helper function to get a pill effect name from a PillEffect enum value.
+ * Helper function to get a pill effect name from a `PillEffect`.
+ *
+ * This function works for both vanilla and modded trinkets.
  *
  * For example, `getPillEffectName(PillEffect.BAD_GAS)` would return "Bad Gas".
  */

package/src/functions/stage.ts

@@ -6,7 +6,7 @@ import {
   StageType,
 } from "isaac-typescript-definitions";
 import { game } from "../core/cachedClasses";
-import { ENGLISH_LEVEL_NAMES } from "../objects/englishLevelNames";
+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_TYPE_SUFFIXES } from "../objects/stageTypeSuffixes";
@@ -90,6 +90,29 @@ export function getEffectiveStage(): LevelStage {
   return stage;
 }
 
+/**
+ * Helper function to get the corresponding "goto" console command that would correspond to the
+ * provided room type and room variant.
+ *
+ * @param roomType The `RoomType` of the destination room.
+ * @param roomVariant The variant of the destination room.
+ * @param useSpecialRoomsForRoomTypeDefault Optional. Whether to use `s.default` as the prefix for
+ *                                 the `goto` command (instead of `d`) if the room type is
+ *                                 `RoomType.DEFAULT` (1). False by default.
+ */
+export function getGotoCommand(
+  roomType: RoomType,
+  roomVariant: int,
+  useSpecialRoomsForRoomTypeDefault = false,
+): string {
+  const isNormalRoom =
+    roomType === RoomType.DEFAULT && !useSpecialRoomsForRoomTypeDefault;
+  const roomTypeSpecialGotoPrefix = ROOM_TYPE_SPECIAL_GOTO_PREFIXES[roomType];
+  const prefix = isNormalRoom ? "d" : `s.${roomTypeSpecialGotoPrefix}`;
+
+  return `goto ${prefix}.${roomVariant}`;
+}
+
 /**
  * Helper function to get the English name of the level. For example, "Caves 1".
  *
@@ -101,7 +124,7 @@ export function getEffectiveStage(): LevelStage {
  * @param stage Optional. If not specified, the current stage will be used.
  * @param stageType Optional. If not specified, the current stage type will be used.
  */
-export function getEnglishLevelName(
+export function getLevelName(
   stage?: LevelStage,
   stageType?: StageType,
 ): string {
@@ -115,33 +138,10 @@ export function getEnglishLevelName(
     stageType = level.GetStageType();
   }
 
-  const stageNames = ENGLISH_LEVEL_NAMES[stage];
+  const stageNames = LEVEL_NAMES[stage];
   return stageNames[stageType];
 }
 
-/**
- * Helper function to get the corresponding "goto" console command that would correspond to the
- * provided room type and room variant.
- *
- * @param roomType The `RoomType` of the destination room.
- * @param roomVariant The variant of the destination room.
- * @param useSpecialRoomsForRoomTypeDefault Optional. Whether to use `s.default` as the prefix for
- *                                 the `goto` command (instead of `d`) if the room type is
- *                                 `RoomType.DEFAULT` (1). False by default.
- */
-export function getGotoCommand(
-  roomType: RoomType,
-  roomVariant: int,
-  useSpecialRoomsForRoomTypeDefault = false,
-): string {
-  const isNormalRoom =
-    roomType === RoomType.DEFAULT && !useSpecialRoomsForRoomTypeDefault;
-  const roomTypeSpecialGotoPrefix = ROOM_TYPE_SPECIAL_GOTO_PREFIXES[roomType];
-  const prefix = isNormalRoom ? "d" : `s.${roomTypeSpecialGotoPrefix}`;
-
-  return `goto ${prefix}.${roomVariant}`;
-}
-
 /** Alias for the `Level.GetStage` method. */
 export function getStage(): LevelStage {
   const level = game.GetLevel();

package/src/objects/batteryNames.ts

@@ -0,0 +1,12 @@
+import { BatterySubType } from "isaac-typescript-definitions";
+
+export const DEFAULT_BATTERY_NAME = "Unknown";
+
+/** Taken from "entities2.xml". */
+export const BATTERY_NAMES = {
+  [BatterySubType.NULL]: DEFAULT_BATTERY_NAME, // 0
+  [BatterySubType.NORMAL]: "Lil' Battery", // 1
+  [BatterySubType.MICRO]: "Micro Battery", // 2
+  [BatterySubType.MEGA]: "Mega Battery", // 3
+  [BatterySubType.GOLDEN]: "Golden Battery", // 4
+} as const satisfies Record<BatterySubType, string>;

package/src/objects/bombNames.ts

@@ -0,0 +1,16 @@
+import { BombSubType } from "isaac-typescript-definitions";
+
+export const DEFAULT_BOMB_NAME = "Unknown";
+
+/** Taken from "entities2.xml". */
+export const BOMB_NAMES = {
+  [BombSubType.NULL]: DEFAULT_BOMB_NAME, // 0
+  [BombSubType.NORMAL]: "Bomb", // 1
+  [BombSubType.DOUBLE_PACK]: "Double Bomb", // 2
+  [BombSubType.TROLL]: "Troll Bomb", // 3
+  [BombSubType.GOLDEN]: "Golden Bomb", // 4
+  [BombSubType.MEGA_TROLL]: "Megatroll Bomb", // 5
+  // The entry for "Golden Troll Bomb" is absent in "entities2.xml", so we infer the name.
+  [BombSubType.GOLDEN_TROLL]: "Golden Troll Bomb", // 6
+  [BombSubType.GIGA]: "Giga Bomb", // 7
+} as const satisfies Record<BombSubType, string>;

package/src/objects/cardNames.ts

@@ -4,102 +4,102 @@ export const DEFAULT_CARD_NAME = "Unknown";
 
 /** This is a temporary map due to missing features in the vanilla API. */
 export const CARD_NAMES = {
-  [CardType.NULL]: DEFAULT_CARD_NAME,
-  [CardType.FOOL]: "0 - The Fool",
-  [CardType.MAGICIAN]: "I - The Magician",
-  [CardType.HIGH_PRIESTESS]: "II - The High Priestess",
-  [CardType.EMPRESS]: "III - The Empress",
-  [CardType.EMPEROR]: "IV - The Emperor",
-  [CardType.HIEROPHANT]: "V - The Hierophant",
-  [CardType.LOVERS]: "VI - The Lovers",
-  [CardType.CHARIOT]: "VII - The Chariot",
-  [CardType.JUSTICE]: "VIII - Justice",
-  [CardType.HERMIT]: "IX - The Hermit",
-  [CardType.WHEEL_OF_FORTUNE]: "X - Wheel of Fortune",
-  [CardType.STRENGTH]: "XI - Strength",
-  [CardType.HANGED_MAN]: "XII - The Hanged Man",
-  [CardType.DEATH]: "XIII - Death",
-  [CardType.TEMPERANCE]: "XIV - Temperance",
-  [CardType.DEVIL]: "XV - The Devil",
-  [CardType.TOWER]: "XVI - The Tower",
-  [CardType.STARS]: "XVII - The Stars",
-  [CardType.MOON]: "XVIII - The Moon",
-  [CardType.SUN]: "XIX - The Sun",
-  [CardType.JUDGEMENT]: "XX - Judgement",
-  [CardType.WORLD]: "XXI - The World",
-  [CardType.CLUBS_2]: "2 of Clubs",
-  [CardType.DIAMONDS_2]: "2 of Diamonds",
-  [CardType.SPADES_2]: "2 of Spades",
-  [CardType.HEARTS_2]: "2 of Hearts",
-  [CardType.ACE_OF_CLUBS]: "Ace of Clubs",
-  [CardType.ACE_OF_DIAMONDS]: "Ace of Diamonds",
-  [CardType.ACE_OF_SPADES]: "Ace of Spades",
-  [CardType.ACE_OF_HEARTS]: "Ace of Hearts",
-  [CardType.JOKER]: "Joker",
-  [CardType.RUNE_HAGALAZ]: "Hagalaz",
-  [CardType.RUNE_JERA]: "Jera",
-  [CardType.RUNE_EHWAZ]: "Ehwaz",
-  [CardType.RUNE_DAGAZ]: "Dagaz",
-  [CardType.RUNE_ANSUZ]: "Ansuz",
-  [CardType.RUNE_PERTHRO]: "Perthro",
-  [CardType.RUNE_BERKANO]: "Berkano",
-  [CardType.RUNE_ALGIZ]: "Algiz",
-  [CardType.RUNE_BLANK]: "Blank Rune",
-  [CardType.RUNE_BLACK]: "Black Rune",
-  [CardType.CHAOS]: "Chaos Card",
-  [CardType.CREDIT]: "Credit Card",
-  [CardType.RULES]: "Rules Card",
-  [CardType.AGAINST_HUMANITY]: "A Card Against Humanity",
-  [CardType.SUICIDE_KING]: "Suicide King",
-  [CardType.GET_OUT_OF_JAIL_FREE]: "Get Out Of Jail Free Card",
-  [CardType.QUESTION_MARK]: "? Card",
-  [CardType.DICE_SHARD]: "Dice Shard",
-  [CardType.EMERGENCY_CONTACT]: "Emergency Contact",
-  [CardType.HOLY]: "Holy Card",
-  [CardType.HUGE_GROWTH]: "Huge Growth",
-  [CardType.ANCIENT_RECALL]: "Ancient Recall",
-  [CardType.ERA_WALK]: "Era Walk",
-  [CardType.RUNE_SHARD]: "Rune Shard",
-  [CardType.REVERSE_FOOL]: "0 - The Fool?",
-  [CardType.REVERSE_MAGICIAN]: "I - The Magician?",
-  [CardType.REVERSE_HIGH_PRIESTESS]: "II - The High Priestess?",
-  [CardType.REVERSE_EMPRESS]: "III - The Empress?",
-  [CardType.REVERSE_EMPEROR]: "IV - The Emperor?",
-  [CardType.REVERSE_HIEROPHANT]: "V - The Hierophant?",
-  [CardType.REVERSE_LOVERS]: "VI - The Lovers?",
-  [CardType.REVERSE_CHARIOT]: "VII - The Chariot?",
-  [CardType.REVERSE_JUSTICE]: "VIII - Justice?",
-  [CardType.REVERSE_HERMIT]: "IX - The Hermit?",
-  [CardType.REVERSE_WHEEL_OF_FORTUNE]: "X - Wheel of Fortune?",
-  [CardType.REVERSE_STRENGTH]: "XI - Strength?",
-  [CardType.REVERSE_HANGED_MAN]: "XII - The Hanged Man?",
-  [CardType.REVERSE_DEATH]: "XIII - Death?",
-  [CardType.REVERSE_TEMPERANCE]: "XIV - Temperance?",
-  [CardType.REVERSE_DEVIL]: "XV - The Devil?",
-  [CardType.REVERSE_TOWER]: "XVI - The Tower?",
-  [CardType.REVERSE_STARS]: "XVII - The Stars?",
-  [CardType.REVERSE_MOON]: "XVIII - The Moon?",
-  [CardType.REVERSE_SUN]: "XIX - The Sun?",
-  [CardType.REVERSE_JUDGEMENT]: "XX - Judgement?",
-  [CardType.REVERSE_WORLD]: "XXI - The World?",
-  [CardType.CRACKED_KEY]: "Cracked Key",
-  [CardType.QUEEN_OF_HEARTS]: "Queen of Hearts",
-  [CardType.WILD]: "Wild Card",
-  [CardType.SOUL_ISAAC]: "Soul of Isaac",
-  [CardType.SOUL_MAGDALENE]: "Soul of Magdalene",
-  [CardType.SOUL_CAIN]: "Soul of Cain",
-  [CardType.SOUL_JUDAS]: "Soul of Judas",
-  [CardType.SOUL_BLUE_BABY]: "Soul of ???",
-  [CardType.SOUL_EVE]: "Soul of Eve",
-  [CardType.SOUL_SAMSON]: "Soul of Samson",
-  [CardType.SOUL_AZAZEL]: "Soul of Azazel",
-  [CardType.SOUL_LAZARUS]: "Soul of Lazarus",
-  [CardType.SOUL_EDEN]: "Soul of Eden",
-  [CardType.SOUL_LOST]: "Soul of the Lost",
-  [CardType.SOUL_LILITH]: "Soul of Lilith",
-  [CardType.SOUL_KEEPER]: "Soul of the Keeper",
-  [CardType.SOUL_APOLLYON]: "Soul of Apollyon",
-  [CardType.SOUL_FORGOTTEN]: "Soul of the Forgotten",
-  [CardType.SOUL_BETHANY]: "Soul of Bethany",
-  [CardType.SOUL_JACOB]: "Soul of Jacob and Esau",
+  [CardType.NULL]: DEFAULT_CARD_NAME, // 0
+  [CardType.FOOL]: "0 - The Fool", // 1
+  [CardType.MAGICIAN]: "I - The Magician", // 2
+  [CardType.HIGH_PRIESTESS]: "II - The High Priestess", // 3
+  [CardType.EMPRESS]: "III - The Empress", // 4
+  [CardType.EMPEROR]: "IV - The Emperor", // 5
+  [CardType.HIEROPHANT]: "V - The Hierophant", // 6
+  [CardType.LOVERS]: "VI - The Lovers", // 7
+  [CardType.CHARIOT]: "VII - The Chariot", // 8
+  [CardType.JUSTICE]: "VIII - Justice", // 9
+  [CardType.HERMIT]: "IX - The Hermit", // 10
+  [CardType.WHEEL_OF_FORTUNE]: "X - Wheel of Fortune", // 11
+  [CardType.STRENGTH]: "XI - Strength", // 12
+  [CardType.HANGED_MAN]: "XII - The Hanged Man", // 13
+  [CardType.DEATH]: "XIII - Death", // 14
+  [CardType.TEMPERANCE]: "XIV - Temperance", // 15
+  [CardType.DEVIL]: "XV - The Devil", // 16
+  [CardType.TOWER]: "XVI - The Tower", // 17
+  [CardType.STARS]: "XVII - The Stars", // 18
+  [CardType.MOON]: "XVIII - The Moon", // 19
+  [CardType.SUN]: "XIX - The Sun", // 20
+  [CardType.JUDGEMENT]: "XX - Judgement", // 21
+  [CardType.WORLD]: "XXI - The World", // 22
+  [CardType.CLUBS_2]: "2 of Clubs", // 23
+  [CardType.DIAMONDS_2]: "2 of Diamonds", // 24
+  [CardType.SPADES_2]: "2 of Spades", // 25
+  [CardType.HEARTS_2]: "2 of Hearts", // 26
+  [CardType.ACE_OF_CLUBS]: "Ace of Clubs", // 27
+  [CardType.ACE_OF_DIAMONDS]: "Ace of Diamonds", // 28
+  [CardType.ACE_OF_SPADES]: "Ace of Spades", // 29
+  [CardType.ACE_OF_HEARTS]: "Ace of Hearts", // 30
+  [CardType.JOKER]: "Joker", // 31
+  [CardType.RUNE_HAGALAZ]: "Hagalaz", // 32
+  [CardType.RUNE_JERA]: "Jera", // 33
+  [CardType.RUNE_EHWAZ]: "Ehwaz", // 34
+  [CardType.RUNE_DAGAZ]: "Dagaz", // 35
+  [CardType.RUNE_ANSUZ]: "Ansuz", // 36
+  [CardType.RUNE_PERTHRO]: "Perthro", // 37
+  [CardType.RUNE_BERKANO]: "Berkano", // 38
+  [CardType.RUNE_ALGIZ]: "Algiz", // 39
+  [CardType.RUNE_BLANK]: "Blank Rune", // 40
+  [CardType.RUNE_BLACK]: "Black Rune", // 41
+  [CardType.CHAOS]: "Chaos Card", // 42
+  [CardType.CREDIT]: "Credit Card", // 43
+  [CardType.RULES]: "Rules Card", // 44
+  [CardType.AGAINST_HUMANITY]: "A Card Against Humanity", // 45
+  [CardType.SUICIDE_KING]: "Suicide King", // 46
+  [CardType.GET_OUT_OF_JAIL_FREE]: "Get Out Of Jail Free Card", // 47
+  [CardType.QUESTION_MARK]: "? Card", // 48
+  [CardType.DICE_SHARD]: "Dice Shard", // 49
+  [CardType.EMERGENCY_CONTACT]: "Emergency Contact", // 50
+  [CardType.HOLY]: "Holy Card", // 51
+  [CardType.HUGE_GROWTH]: "Huge Growth", // 52
+  [CardType.ANCIENT_RECALL]: "Ancient Recall", // 53
+  [CardType.ERA_WALK]: "Era Walk", // 54
+  [CardType.RUNE_SHARD]: "Rune Shard", // 55
+  [CardType.REVERSE_FOOL]: "0 - The Fool?", // 56
+  [CardType.REVERSE_MAGICIAN]: "I - The Magician?", // 57
+  [CardType.REVERSE_HIGH_PRIESTESS]: "II - The High Priestess?", // 58
+  [CardType.REVERSE_EMPRESS]: "III - The Empress?", // 59
+  [CardType.REVERSE_EMPEROR]: "IV - The Emperor?", // 60
+  [CardType.REVERSE_HIEROPHANT]: "V - The Hierophant?", // 61
+  [CardType.REVERSE_LOVERS]: "VI - The Lovers?", // 62
+  [CardType.REVERSE_CHARIOT]: "VII - The Chariot?", // 63
+  [CardType.REVERSE_JUSTICE]: "VIII - Justice?", // 64
+  [CardType.REVERSE_HERMIT]: "IX - The Hermit?", // 65
+  [CardType.REVERSE_WHEEL_OF_FORTUNE]: "X - Wheel of Fortune?", // 66
+  [CardType.REVERSE_STRENGTH]: "XI - Strength?", // 67
+  [CardType.REVERSE_HANGED_MAN]: "XII - The Hanged Man?", // 68
+  [CardType.REVERSE_DEATH]: "XIII - Death?", // 69
+  [CardType.REVERSE_TEMPERANCE]: "XIV - Temperance?", // 70
+  [CardType.REVERSE_DEVIL]: "XV - The Devil?", // 71
+  [CardType.REVERSE_TOWER]: "XVI - The Tower?", // 72
+  [CardType.REVERSE_STARS]: "XVII - The Stars?", // 73
+  [CardType.REVERSE_MOON]: "XVIII - The Moon?", // 74
+  [CardType.REVERSE_SUN]: "XIX - The Sun?", // 75
+  [CardType.REVERSE_JUDGEMENT]: "XX - Judgement?", // 76
+  [CardType.REVERSE_WORLD]: "XXI - The World?", // 77
+  [CardType.CRACKED_KEY]: "Cracked Key", // 78
+  [CardType.QUEEN_OF_HEARTS]: "Queen of Hearts", // 79
+  [CardType.WILD]: "Wild Card", // 80
+  [CardType.SOUL_ISAAC]: "Soul of Isaac", // 81
+  [CardType.SOUL_MAGDALENE]: "Soul of Magdalene", // 82
+  [CardType.SOUL_CAIN]: "Soul of Cain", // 83
+  [CardType.SOUL_JUDAS]: "Soul of Judas", // 84
+  [CardType.SOUL_BLUE_BABY]: "Soul of ???", // 85
+  [CardType.SOUL_EVE]: "Soul of Eve", // 86
+  [CardType.SOUL_SAMSON]: "Soul of Samson", // 87
+  [CardType.SOUL_AZAZEL]: "Soul of Azazel", // 88
+  [CardType.SOUL_LAZARUS]: "Soul of Lazarus", // 89
+  [CardType.SOUL_EDEN]: "Soul of Eden", // 90
+  [CardType.SOUL_LOST]: "Soul of the Lost", // 91
+  [CardType.SOUL_LILITH]: "Soul of Lilith", // 92
+  [CardType.SOUL_KEEPER]: "Soul of the Keeper", // 93
+  [CardType.SOUL_APOLLYON]: "Soul of Apollyon", // 94
+  [CardType.SOUL_FORGOTTEN]: "Soul of the Forgotten", // 95
+  [CardType.SOUL_BETHANY]: "Soul of Bethany", // 96
+  [CardType.SOUL_JACOB]: "Soul of Jacob and Esau", // 97
 } as const satisfies Record<CardType, string>;

package/src/objects/chestNames.ts

@@ -0,0 +1,18 @@
+import { PickupVariant } from "isaac-typescript-definitions";
+import type { CHEST_PICKUP_VARIANTS } from "../core/constants";
+
+/** Taken from "entities2.xml". */
+export const CHEST_NAMES = {
+  [PickupVariant.CHEST]: "Chest", // 50
+  [PickupVariant.BOMB_CHEST]: "Bomb Chest", // 51
+  [PickupVariant.SPIKED_CHEST]: "Spiked Chest", // 52
+  [PickupVariant.ETERNAL_CHEST]: "Eternal Chest", // 53
+  [PickupVariant.MIMIC_CHEST]: "Mimic Chest", // 54
+  [PickupVariant.OLD_CHEST]: "Old Chest", // 55
+  [PickupVariant.WOODEN_CHEST]: "Wooden Chest", // 56
+  [PickupVariant.MEGA_CHEST]: "Mega Chest", // 57
+  [PickupVariant.HAUNTED_CHEST]: "Haunted Chest", // 58
+  [PickupVariant.LOCKED_CHEST]: "Locked Chest", // 60
+  [PickupVariant.RED_CHEST]: "Red Chest", // 360
+  [PickupVariant.MOMS_CHEST]: "Mom's Chest", // 390
+} as const satisfies Record<(typeof CHEST_PICKUP_VARIANTS)[number], string>;

package/src/objects/coinNames.ts

@@ -0,0 +1,15 @@
+import { CoinSubType } from "isaac-typescript-definitions";
+
+export const DEFAULT_COIN_NAME = "Unknown";
+
+/** Taken from "entities2.xml". */
+export const COIN_NAMES = {
+  [CoinSubType.NULL]: DEFAULT_COIN_NAME, // 0
+  [CoinSubType.PENNY]: "Penny", // 1
+  [CoinSubType.NICKEL]: "Nickel", // 2
+  [CoinSubType.DIME]: "Dime", // 3
+  [CoinSubType.DOUBLE_PACK]: "Double Penny", // 4
+  [CoinSubType.LUCKY_PENNY]: "Lucky Penny", // 5
+  [CoinSubType.STICKY_NICKEL]: "Sticky Nickel", // 6
+  [CoinSubType.GOLDEN]: "Golden Penny", // 7
+} as const satisfies Record<CoinSubType, string>;

package/src/objects/heartNames.ts

@@ -0,0 +1,20 @@
+import { HeartSubType } from "isaac-typescript-definitions";
+
+export const DEFAULT_HEART_NAME = "Unknown";
+
+/** Taken from "entities2.xml". */
+export const HEART_NAMES = {
+  [HeartSubType.NULL]: DEFAULT_HEART_NAME, // 0
+  [HeartSubType.FULL]: "Heart", // 1
+  [HeartSubType.HALF]: "Heart (half)", // 2
+  [HeartSubType.SOUL]: "Heart (soul)", // 3
+  [HeartSubType.ETERNAL]: "Heart (eternal)", // 4
+  [HeartSubType.DOUBLE_PACK]: "Heart (double)", // 5
+  [HeartSubType.BLACK]: "Black Heart", // 6
+  [HeartSubType.GOLDEN]: "Gold Heart", // 7
+  [HeartSubType.HALF_SOUL]: "Heart (half soul)", // 8
+  [HeartSubType.SCARED]: "Scared Heart", // 9
+  [HeartSubType.BLENDED]: "Blended Heart", // 10
+  [HeartSubType.BONE]: "Bone Heart", // 11
+  [HeartSubType.ROTTEN]: "Rotten Heart", // 12
+} as const satisfies Record<HeartSubType, string>;

package/src/objects/keyNames.ts

@@ -0,0 +1,12 @@
+import { KeySubType } from "isaac-typescript-definitions";
+
+export const DEFAULT_KEY_NAME = "Unknown";
+
+/** Taken from "entities2.xml". */
+export const KEY_NAMES = {
+  [KeySubType.NULL]: DEFAULT_KEY_NAME, // 0
+  [KeySubType.NORMAL]: "Key", // 1
+  [KeySubType.GOLDEN]: "Golden Key", // 2
+  [KeySubType.DOUBLE_PACK]: "Key Ring", // 3
+  [KeySubType.CHARGED]: "Charged Key", // 4
+} as const satisfies Record<KeySubType, string>;

package/src/objects/languageNames.ts

@@ -1,11 +1,11 @@
 import { LanguageAbbreviation } from "isaac-typescript-definitions";
 
 export const LANGUAGE_NAMES = {
-  [LanguageAbbreviation.ENGLISH]: "English",
-  [LanguageAbbreviation.JAPANESE]: "Japanese",
-  [LanguageAbbreviation.KOREAN]: "Korean",
-  [LanguageAbbreviation.CHINESE_SIMPLE]: "Chinese (Simple)",
-  [LanguageAbbreviation.RUSSIAN]: "Russian",
-  [LanguageAbbreviation.GERMAN]: "German",
-  [LanguageAbbreviation.SPANISH]: "Spanish",
+  [LanguageAbbreviation.ENGLISH]: "English", // "en"
+  [LanguageAbbreviation.JAPANESE]: "Japanese", // "jp"
+  [LanguageAbbreviation.KOREAN]: "Korean", // "kr"
+  [LanguageAbbreviation.CHINESE_SIMPLE]: "Chinese (Simple)", // "zh"
+  [LanguageAbbreviation.RUSSIAN]: "Russian", // "ru"
+  [LanguageAbbreviation.GERMAN]: "German", // "de"
+  [LanguageAbbreviation.SPANISH]: "Spanish", // "es"
 } as const satisfies Record<LanguageAbbreviation, string>;

package/src/objects/{englishLevelNames.ts → levelNames.ts}

@@ -8,7 +8,8 @@ import { LevelStage, StageType } from "isaac-typescript-definitions";
  *
  * Note that this contains "Blue Womb" instead of "???" for stage 9.
  */
-export const ENGLISH_LEVEL_NAMES = {
+export const LEVEL_NAMES = {
+  // 1
   [LevelStage.BASEMENT_1]: {
     [StageType.ORIGINAL]: "Basement 1",
     [StageType.WRATH_OF_THE_LAMB]: "Cellar 1",
@@ -17,6 +18,8 @@ export const ENGLISH_LEVEL_NAMES = {
     [StageType.REPENTANCE]: "Downpour 1",
     [StageType.REPENTANCE_B]: "Dross 1",
   },
+
+  // 2
   [LevelStage.BASEMENT_2]: {
     [StageType.ORIGINAL]: "Basement 2",
     [StageType.WRATH_OF_THE_LAMB]: "Cellar 2",
@@ -25,6 +28,8 @@ export const ENGLISH_LEVEL_NAMES = {
     [StageType.REPENTANCE]: "Downpour 2",
     [StageType.REPENTANCE_B]: "Dross 2",
   },
+
+  // 3
   [LevelStage.CAVES_1]: {
     [StageType.ORIGINAL]: "Caves 1",
     [StageType.WRATH_OF_THE_LAMB]: "Catacombs 1",
@@ -33,6 +38,8 @@ export const ENGLISH_LEVEL_NAMES = {
     [StageType.REPENTANCE]: "Mines 1",
     [StageType.REPENTANCE_B]: "Ashpit 1",
   },
+
+  // 4
   [LevelStage.CAVES_2]: {
     [StageType.ORIGINAL]: "Caves 2",
     [StageType.WRATH_OF_THE_LAMB]: "Catacombs 2",
@@ -41,6 +48,8 @@ export const ENGLISH_LEVEL_NAMES = {
     [StageType.REPENTANCE]: "Mines 2",
     [StageType.REPENTANCE_B]: "Ashpit 2",
   },
+
+  // 5
   [LevelStage.DEPTHS_1]: {
     [StageType.ORIGINAL]: "Depths 1",
     [StageType.WRATH_OF_THE_LAMB]: "Necropolis 1",
@@ -49,6 +58,8 @@ export const ENGLISH_LEVEL_NAMES = {
     [StageType.REPENTANCE]: "Mausoleum 1",
     [StageType.REPENTANCE_B]: "Gehenna 1",
   },
+
+  // 6
   [LevelStage.DEPTHS_2]: {
     [StageType.ORIGINAL]: "Depths 2",
     [StageType.WRATH_OF_THE_LAMB]: "Necropolis 2",
@@ -57,6 +68,8 @@ export const ENGLISH_LEVEL_NAMES = {
     [StageType.REPENTANCE]: "Mausoleum 2",
     [StageType.REPENTANCE_B]: "Gehenna 2",
   },
+
+  // 7
   [LevelStage.WOMB_1]: {
     [StageType.ORIGINAL]: "Womb 1",
     [StageType.WRATH_OF_THE_LAMB]: "Utero 1",
@@ -65,6 +78,8 @@ export const ENGLISH_LEVEL_NAMES = {
     [StageType.REPENTANCE]: "Corpse 1",
     [StageType.REPENTANCE_B]: "Mortis 1",
   },
+
+  // 8
   [LevelStage.WOMB_2]: {
     [StageType.ORIGINAL]: "Womb 2",
     [StageType.WRATH_OF_THE_LAMB]: "Utero 2",
@@ -73,6 +88,8 @@ export const ENGLISH_LEVEL_NAMES = {
     [StageType.REPENTANCE]: "Corpse 2",
     [StageType.REPENTANCE_B]: "Mortis 2",
   },
+
+  // 9
   [LevelStage.BLUE_WOMB]: {
     [StageType.ORIGINAL]: "Blue Womb",
     [StageType.WRATH_OF_THE_LAMB]: "Blue Womb",
@@ -81,6 +98,8 @@ export const ENGLISH_LEVEL_NAMES = {
     [StageType.REPENTANCE]: "Blue Womb",
     [StageType.REPENTANCE_B]: "Blue Womb",
   },
+
+  // 10
   [LevelStage.SHEOL_CATHEDRAL]: {
     [StageType.ORIGINAL]: "Sheol",
     [StageType.WRATH_OF_THE_LAMB]: "Cathedral",
@@ -89,6 +108,8 @@ export const ENGLISH_LEVEL_NAMES = {
     [StageType.REPENTANCE]: "Undefined",
     [StageType.REPENTANCE_B]: "Undefined",
   },
+
+  // 11
   [LevelStage.DARK_ROOM_CHEST]: {
     [StageType.ORIGINAL]: "Dark Room",
     [StageType.WRATH_OF_THE_LAMB]: "The Chest",
@@ -97,6 +118,8 @@ export const ENGLISH_LEVEL_NAMES = {
     [StageType.REPENTANCE]: "Undefined",
     [StageType.REPENTANCE_B]: "Undefined",
   },
+
+  // 12
   [LevelStage.THE_VOID]: {
     [StageType.ORIGINAL]: "The Void",
     [StageType.WRATH_OF_THE_LAMB]: "The Void",
@@ -105,6 +128,8 @@ export const ENGLISH_LEVEL_NAMES = {
     [StageType.REPENTANCE]: "The Void",
     [StageType.REPENTANCE_B]: "The Void",
   },
+
+  // 13
   [LevelStage.HOME]: {
     [StageType.ORIGINAL]: "Home",
     [StageType.WRATH_OF_THE_LAMB]: "Home",