isaacscript-common 46.0.0 → 47.0.0

package/dist/index.rollup.d.ts

@@ -4803,6 +4803,14 @@ export declare function getAzazelBrimstoneDistance(playerOrTearHeight: EntityPla
  */
 export declare function getBatteries(batterySubType?: BatterySubType | -1): EntityPickupBattery[];
 
+/**
+ * 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 declare function getBatteryName(batterySubType: BatterySubType): string;
+
 /**
  * Helper function to get the door that leads to the off-grid room that contains the hole to the
  * Blue Womb. (In vanilla, the door will only appear in the It Lives Boss Room.)
@@ -4811,6 +4819,13 @@ export declare function getBatteries(batterySubType?: BatterySubType | -1): Enti
  */
 export declare function getBlueWombDoor(): GridEntityDoor | undefined;
 
+/**
+ * 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 declare function getBombName(bombSubType: BombSubType): string;
+
 /**
  * Helper function to get all of the bomb entities in the room. (Specifically, this refers to bomb
  * pickups, not the `EntityBomb` class.)
@@ -4882,7 +4897,7 @@ export declare function getBossSet(stage: int, stageType: StageType): ReadonlySe
 export declare function getCardDescription(cardType: CardType): string;
 
 /**
- * Helper function to get a card name from a Card.
+ * Helper function to get a card name from a `CardType`.
  *
  * For example, `getCardName(Card.FOOL)` would return "0 - The Fool".
  */
@@ -4951,6 +4966,14 @@ export declare function getCharacterStartingTrinketType(character: PlayerType):
  */
 export declare function getChargesAwayFromMax(player: EntityPlayer, activeSlot?: ActiveSlot): int;
 
+/**
+ * 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 declare function getChestName(pickupVariant: PickupVariant): string;
+
 /**
  * Helper function to get an array of equidistant points on the circumference around a circle.
  * Useful for equally distributing things in a circle pattern.
@@ -5000,6 +5023,13 @@ export declare function getClosestPlayer(position: Vector): EntityPlayer;
  */
 export declare function getClosestVectorTo(referenceVector: Vector, vectors: Vector[]): Vector | undefined;
 
+/**
+ * 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 declare function getCoinName(coinSubType: CoinSubType): string;
+
 /**
  * Helper function to get all of the coin pickup entities in the room.
  *
@@ -5278,19 +5308,6 @@ export declare function getEffects(effectVariant?: EffectVariant | -1, subType?:
  */
 export declare function getEffectsList(player: EntityPlayer): TemporaryEffect[];
 
-/**
- * Helper function to get the English name of the level. For example, "Caves 1".
- *
- * This is useful because the `Level.GetName` method returns a localized version of the level name,
- * which will not display correctly on some fonts.
- *
- * Note that this returns "Blue Womb" instead of "???" for stage 9.
- *
- * @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 declare function getEnglishLevelName(stage?: LevelStage, stageType?: StageType): string;
-
 /**
  * Helper function to get all of the entities in the room or all of the entities that match a
  * specific entity type / variant / sub-type.
@@ -5602,6 +5619,13 @@ export declare function getGridIndexDelta(roomShape: RoomShape, doorSlot: DoorSl
  */
 export declare function getGridIndexesBetween(gridIndex1: int, gridIndex2: int, roomShape: RoomShape): int[];
 
+/**
+ * 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 declare function getHeartName(heartSubType: HeartSubType): string;
+
 /**
  * Returns how many hearts are in the heart UI row. If the player has more than 6 hearts, this
  * function will return 6.
@@ -5717,6 +5741,13 @@ export declare function getJSONRoomsOfSubType(jsonRooms: JSONRoom[] | readonly J
 /** Helper function to get the value of a specific but in a binary representation of a number. */
 export declare function getKBitOfN(k: int, n: int): int;
 
+/**
+ * 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 declare function getKeyName(keySubType: KeySubType): string;
+
 /**
  * Helper function to get all of the key pickup entities in the room.
  *
@@ -5794,6 +5825,19 @@ export declare function getLastFrameOfAnimation(sprite: Sprite, animation?: stri
  */
 export declare function getLevelBossIDs(): BossID[];
 
+/**
+ * Helper function to get the English name of the level. For example, "Caves 1".
+ *
+ * This is useful because the `Level.GetName` method returns a localized version of the level name,
+ * which will not display correctly on some fonts.
+ *
+ * Note that this returns "Blue Womb" instead of "???" for stage 9.
+ *
+ * @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 declare function getLevelName(stage?: LevelStage, stageType?: StageType): string;
+
 /**
  * Helper function to get the lowest value in an array. Returns undefined if there were no elements
  * in the array.
@@ -6154,7 +6198,7 @@ export declare function getPillColorFromEffect(pillEffect: PillEffect): PillColo
 export declare function getPillEffectClass(pillEffect: PillEffect): ItemConfigPillEffectClass;
 
 /**
- * Helper function to get a pill effect name from a PillEffect enum value.
+ * Helper function to get a pill effect name from a `PillEffect`.
  *
  * For example, `getPillEffectName(PillEffect.BAD_GAS)` would return "Bad Gas".
  */
@@ -7184,6 +7228,13 @@ export declare function getRoomVariant(roomGridIndex?: int): int | undefined;
  */
 export declare function getRoomVisitedCount(roomGridIndex?: int): int;
 
+/**
+ * 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 declare function getSackName(sackSubType: SackSubType): string;
+
 /**
  * Helper function to get all of the sack (i.e. grab bag) entities in the room.
  *

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 46.0.0
+isaacscript-common 47.0.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -27229,12 +27229,12 @@ function ____exports.reloadRoom(self)
 end
 return ____exports
  end,
-["src.objects.englishLevelNames"] = function(...) 
+["src.objects.levelNames"] = function(...) 
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
 local LevelStage = ____isaac_2Dtypescript_2Ddefinitions.LevelStage
 local StageType = ____isaac_2Dtypescript_2Ddefinitions.StageType
-____exports.ENGLISH_LEVEL_NAMES = {
+____exports.LEVEL_NAMES = {
     [LevelStage.BASEMENT_1] = {
         [StageType.ORIGINAL] = "Basement 1",
         [StageType.WRATH_OF_THE_LAMB] = "Cellar 1",
@@ -27513,8 +27513,8 @@ local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
 local StageType = ____isaac_2Dtypescript_2Ddefinitions.StageType
 local ____cachedClasses = require("src.core.cachedClasses")
 local game = ____cachedClasses.game
-local ____englishLevelNames = require("src.objects.englishLevelNames")
-local ENGLISH_LEVEL_NAMES = ____englishLevelNames.ENGLISH_LEVEL_NAMES
+local ____levelNames = require("src.objects.levelNames")
+local LEVEL_NAMES = ____levelNames.LEVEL_NAMES
 local ____roomTypeSpecialGotoPrefixes = require("src.objects.roomTypeSpecialGotoPrefixes")
 local ROOM_TYPE_SPECIAL_GOTO_PREFIXES = ____roomTypeSpecialGotoPrefixes.ROOM_TYPE_SPECIAL_GOTO_PREFIXES
 local ____stageToStageID = require("src.objects.stageToStageID")
@@ -27577,17 +27577,6 @@ function ____exports.getEffectiveStage(self)
     end
     return stage
 end
-function ____exports.getEnglishLevelName(self, stage, stageType)
-    local level = game:GetLevel()
-    if stage == nil then
-        stage = level:GetStage()
-    end
-    if stageType == nil then
-        stageType = level:GetStageType()
-    end
-    local stageNames = ENGLISH_LEVEL_NAMES[stage]
-    return stageNames[stageType]
-end
 function ____exports.getGotoCommand(self, roomType, roomVariant, useSpecialRoomsForRoomTypeDefault)
     if useSpecialRoomsForRoomTypeDefault == nil then
         useSpecialRoomsForRoomTypeDefault = false
@@ -27597,6 +27586,17 @@ function ____exports.getGotoCommand(self, roomType, roomVariant, useSpecialRooms
     local prefix = isNormalRoom and "d" or "s." .. roomTypeSpecialGotoPrefix
     return (("goto " .. prefix) .. ".") .. tostring(roomVariant)
 end
+function ____exports.getLevelName(self, stage, stageType)
+    local level = game:GetLevel()
+    if stage == nil then
+        stage = level:GetStage()
+    end
+    if stageType == nil then
+        stageType = level:GetStageType()
+    end
+    local stageNames = LEVEL_NAMES[stage]
+    return stageNames[stageType]
+end
 function ____exports.getStage(self)
     local level = game:GetLevel()
     return level:GetStage()
@@ -39775,6 +39775,74 @@ function SlotUpdateDetection.prototype.checkNewEntity(self, slot)
         self.postSlotInit:fire(slot)
     end
 end
+return ____exports
+ end,
+["src.objects.batteryNames"] = function(...) 
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
+local BatterySubType = ____isaac_2Dtypescript_2Ddefinitions.BatterySubType
+____exports.DEFAULT_BATTERY_NAME = "Unknown"
+____exports.BATTERY_NAMES = {
+    [BatterySubType.NULL] = ____exports.DEFAULT_BATTERY_NAME,
+    [BatterySubType.NORMAL] = "Lil' Battery",
+    [BatterySubType.MICRO] = "Micro Battery",
+    [BatterySubType.MEGA] = "Mega Battery",
+    [BatterySubType.GOLDEN] = "Golden Battery"
+}
+return ____exports
+ end,
+["src.objects.bombNames"] = function(...) 
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
+local BombSubType = ____isaac_2Dtypescript_2Ddefinitions.BombSubType
+____exports.DEFAULT_BOMB_NAME = "Unknown"
+____exports.BOMB_NAMES = {
+    [BombSubType.NULL] = ____exports.DEFAULT_BOMB_NAME,
+    [BombSubType.NORMAL] = "Bomb",
+    [BombSubType.DOUBLE_PACK] = "Double Bomb",
+    [BombSubType.TROLL] = "Troll Bomb",
+    [BombSubType.GOLDEN] = "Golden Bomb",
+    [BombSubType.MEGA_TROLL] = "Megatroll Bomb",
+    [BombSubType.GOLDEN_TROLL] = "Golden Troll Bomb",
+    [BombSubType.GIGA] = "Giga Bomb"
+}
+return ____exports
+ end,
+["src.objects.chestNames"] = function(...) 
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
+local PickupVariant = ____isaac_2Dtypescript_2Ddefinitions.PickupVariant
+____exports.CHEST_NAMES = {
+    [PickupVariant.CHEST] = "Chest",
+    [PickupVariant.BOMB_CHEST] = "Bomb Chest",
+    [PickupVariant.SPIKED_CHEST] = "Spiked Chest",
+    [PickupVariant.ETERNAL_CHEST] = "Eternal Chest",
+    [PickupVariant.MIMIC_CHEST] = "Mimic Chest",
+    [PickupVariant.OLD_CHEST] = "Old Chest",
+    [PickupVariant.WOODEN_CHEST] = "Wooden Chest",
+    [PickupVariant.MEGA_CHEST] = "Mega Chest",
+    [PickupVariant.HAUNTED_CHEST] = "Haunted Chest",
+    [PickupVariant.LOCKED_CHEST] = "Locked Chest",
+    [PickupVariant.RED_CHEST] = "Red Chest",
+    [PickupVariant.MOMS_CHEST] = "Mom's Chest"
+}
+return ____exports
+ end,
+["src.objects.coinNames"] = function(...) 
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
+local CoinSubType = ____isaac_2Dtypescript_2Ddefinitions.CoinSubType
+____exports.DEFAULT_COIN_NAME = "Unknown"
+____exports.COIN_NAMES = {
+    [CoinSubType.NULL] = ____exports.DEFAULT_COIN_NAME,
+    [CoinSubType.PENNY] = "Penny",
+    [CoinSubType.NICKEL] = "Nickel",
+    [CoinSubType.DIME] = "Dime",
+    [CoinSubType.DOUBLE_PACK] = "Double Penny",
+    [CoinSubType.LUCKY_PENNY] = "Lucky Penny",
+    [CoinSubType.STICKY_NICKEL] = "Sticky Nickel",
+    [CoinSubType.GOLDEN] = "Golden Penny"
+}
 return ____exports
  end,
 ["src.objects.coinSubTypeToValue"] = function(...) 
@@ -39792,6 +39860,50 @@ ____exports.COIN_SUB_TYPE_TO_VALUE = {
     [CoinSubType.STICKY_NICKEL] = 5,
     [CoinSubType.GOLDEN] = 1
 }
+return ____exports
+ end,
+["src.objects.heartNames"] = function(...) 
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
+local HeartSubType = ____isaac_2Dtypescript_2Ddefinitions.HeartSubType
+____exports.DEFAULT_HEART_NAME = "Unknown"
+____exports.HEART_NAMES = {
+    [HeartSubType.NULL] = ____exports.DEFAULT_HEART_NAME,
+    [HeartSubType.FULL] = "Heart",
+    [HeartSubType.HALF] = "Heart (half)",
+    [HeartSubType.SOUL] = "Heart (soul)",
+    [HeartSubType.ETERNAL] = "Heart (eternal)",
+    [HeartSubType.DOUBLE_PACK] = "Heart (double)",
+    [HeartSubType.BLACK] = "Black Heart",
+    [HeartSubType.GOLDEN] = "Gold Heart",
+    [HeartSubType.HALF_SOUL] = "Heart (half soul)",
+    [HeartSubType.SCARED] = "Scared Heart",
+    [HeartSubType.BLENDED] = "Blended Heart",
+    [HeartSubType.BONE] = "Bone Heart",
+    [HeartSubType.ROTTEN] = "Rotten Heart"
+}
+return ____exports
+ end,
+["src.objects.keyNames"] = function(...) 
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
+local KeySubType = ____isaac_2Dtypescript_2Ddefinitions.KeySubType
+____exports.DEFAULT_KEY_NAME = "Unknown"
+____exports.KEY_NAMES = {
+    [KeySubType.NULL] = ____exports.DEFAULT_KEY_NAME,
+    [KeySubType.NORMAL] = "Key",
+    [KeySubType.GOLDEN] = "Golden Key",
+    [KeySubType.DOUBLE_PACK] = "Key Ring",
+    [KeySubType.CHARGED] = "Charged Key"
+}
+return ____exports
+ end,
+["src.objects.sackNames"] = function(...) 
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("lua_modules.isaac-typescript-definitions.dist.src.index")
+local SackSubType = ____isaac_2Dtypescript_2Ddefinitions.SackSubType
+____exports.DEFAULT_SACK_NAME = "Unknown"
+____exports.SACK_NAMES = {[SackSubType.NULL] = ____exports.DEFAULT_SACK_NAME, [SackSubType.NORMAL] = "Grab Bag", [SackSubType.BLACK] = "Black Sack"}
 return ____exports
  end,
 ["src.sets.redHeartSubTypesSet"] = function(...) 
@@ -40165,9 +40277,29 @@ local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local ____exports = {}
 local ____constants = require("src.core.constants")
 local CHEST_PICKUP_VARIANTS_SET = ____constants.CHEST_PICKUP_VARIANTS_SET
+local ____batteryNames = require("src.objects.batteryNames")
+local BATTERY_NAMES = ____batteryNames.BATTERY_NAMES
+local DEFAULT_BATTERY_NAME = ____batteryNames.DEFAULT_BATTERY_NAME
+local ____bombNames = require("src.objects.bombNames")
+local BOMB_NAMES = ____bombNames.BOMB_NAMES
+local DEFAULT_BOMB_NAME = ____bombNames.DEFAULT_BOMB_NAME
+local ____chestNames = require("src.objects.chestNames")
+local CHEST_NAMES = ____chestNames.CHEST_NAMES
+local ____coinNames = require("src.objects.coinNames")
+local COIN_NAMES = ____coinNames.COIN_NAMES
+local DEFAULT_COIN_NAME = ____coinNames.DEFAULT_COIN_NAME
 local ____coinSubTypeToValue = require("src.objects.coinSubTypeToValue")
 local COIN_SUB_TYPE_TO_VALUE = ____coinSubTypeToValue.COIN_SUB_TYPE_TO_VALUE
 local DEFAULT_COIN_VALUE = ____coinSubTypeToValue.DEFAULT_COIN_VALUE
+local ____heartNames = require("src.objects.heartNames")
+local DEFAULT_HEART_NAME = ____heartNames.DEFAULT_HEART_NAME
+local HEART_NAMES = ____heartNames.HEART_NAMES
+local ____keyNames = require("src.objects.keyNames")
+local DEFAULT_KEY_NAME = ____keyNames.DEFAULT_KEY_NAME
+local KEY_NAMES = ____keyNames.KEY_NAMES
+local ____sackNames = require("src.objects.sackNames")
+local DEFAULT_SACK_NAME = ____sackNames.DEFAULT_SACK_NAME
+local SACK_NAMES = ____sackNames.SACK_NAMES
 local ____redHeartSubTypesSet = require("src.sets.redHeartSubTypesSet")
 local RED_HEART_SUB_TYPES_SET = ____redHeartSubTypesSet.RED_HEART_SUB_TYPES_SET
 local ____entities = require("src.functions.entities")
@@ -40179,10 +40311,29 @@ local getHearts = ____pickupsSpecific.getHearts
 function ____exports.isChestVariant(self, pickupVariant)
     return CHEST_PICKUP_VARIANTS_SET:has(pickupVariant)
 end
+function ____exports.getBatteryName(self, batterySubType)
+    return BATTERY_NAMES[batterySubType] or DEFAULT_BATTERY_NAME
+end
+function ____exports.getBombName(self, bombSubType)
+    return BOMB_NAMES[bombSubType] or DEFAULT_BOMB_NAME
+end
+function ____exports.getChestName(self, pickupVariant)
+    local chestNames = CHEST_NAMES
+    return chestNames[pickupVariant] or "Unknown"
+end
+function ____exports.getCoinName(self, coinSubType)
+    return COIN_NAMES[coinSubType] or DEFAULT_COIN_NAME
+end
 function ____exports.getCoinValue(self, coinSubType)
     local value = COIN_SUB_TYPE_TO_VALUE[coinSubType]
     return value or DEFAULT_COIN_VALUE
 end
+function ____exports.getHeartName(self, heartSubType)
+    return HEART_NAMES[heartSubType] or DEFAULT_HEART_NAME
+end
+function ____exports.getKeyName(self, keySubType)
+    return KEY_NAMES[keySubType] or DEFAULT_KEY_NAME
+end
 function ____exports.getRedHearts(self)
     local hearts = getHearts(nil)
     return __TS__ArrayFilter(
@@ -40190,6 +40341,9 @@ function ____exports.getRedHearts(self)
         function(____, heart) return RED_HEART_SUB_TYPES_SET:has(heart.SubType) end
     )
 end
+function ____exports.getSackName(self, sackSubType)
+    return SACK_NAMES[sackSubType] or DEFAULT_SACK_NAME
+end
 function ____exports.isChest(self, pickup)
     return ____exports.isChestVariant(nil, pickup.Variant)
 end

package/dist/src/functions/cards.d.ts

@@ -7,7 +7,7 @@ import { ItemConfigCardType } from "isaac-typescript-definitions";
  */
 export declare function getCardDescription(cardType: CardType): string;
 /**
- * Helper function to get a card name from a Card.
+ * Helper function to get a card name from a `CardType`.
  *
  * For example, `getCardName(Card.FOOL)` would return "0 - The Fool".
  */

package/dist/src/functions/cards.lua

@@ -34,7 +34,7 @@ function ____exports.getCardDescription(self, cardType)
     end
     return DEFAULT_CARD_DESCRIPTION
 end
---- Helper function to get a card name from a Card.
+--- Helper function to get a card name from a `CardType`.
 -- 
 -- For example, `getCardName(Card.FOOL)` would return "0 - The Fool".
 function ____exports.getCardName(self, cardType)

package/dist/src/functions/pickups.d.ts

@@ -1,11 +1,55 @@
-import type { CoinSubType, HeartSubType, PickupVariant } from "isaac-typescript-definitions";
+import type { BatterySubType, BombSubType, CoinSubType, HeartSubType, KeySubType, PickupVariant, SackSubType } from "isaac-typescript-definitions";
+/**
+ * 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 declare function getBatteryName(batterySubType: BatterySubType): string;
+/**
+ * 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 declare function getBombName(bombSubType: BombSubType): string;
+/**
+ * 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 declare function getChestName(pickupVariant: PickupVariant): string;
+/**
+ * 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 declare function getCoinName(coinSubType: CoinSubType): string;
 /**
  * Helper function to get the corresponding coin amount from a `CoinSubType`. Returns 1 for modded
  * sub-types.
  */
 export declare function getCoinValue(coinSubType: CoinSubType): int;
+/**
+ * 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 declare function getHeartName(heartSubType: HeartSubType): string;
+/**
+ * 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 declare function getKeyName(keySubType: KeySubType): string;
 /** Helper function to get all of the red heart pickup entities in the room. */
 export declare function getRedHearts(): EntityPickupHeart[];
+/**
+ * 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 declare function getSackName(sackSubType: SackSubType): string;
 /** Helper function to test if the provided pickup matches one of the various chest variants. */
 export declare function isChest(pickup: EntityPickup): boolean;
 /**

package/dist/src/functions/pickups.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pickups.d.ts","sourceRoot":"","sources":["../../../src/functions/pickups.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,YAAY,EACZ,aAAa,EACd,MAAM,8BAA8B,CAAC;AAWtC;;;GAGG;AACH,wBAAgB,YAAY,CAAC,WAAW,EAAE,WAAW,GAAG,GAAG,CAK1D;AAED,+EAA+E;AAC/E,wBAAgB,YAAY,IAAI,iBAAiB,EAAE,CAGlD;AAED,gGAAgG;AAChG,wBAAgB,OAAO,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAErD;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,aAAa,EAAE,aAAa,GAAG,OAAO,CAEpE;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAExD;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAErE;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,iBAAiB,EAAE,CAGjE"}
+{"version":3,"file":"pickups.d.ts","sourceRoot":"","sources":["../../../src/functions/pickups.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,WAAW,EACX,WAAW,EACX,YAAY,EACZ,UAAU,EACV,aAAa,EACb,WAAW,EACZ,MAAM,8BAA8B,CAAC;AAkBtC;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,cAAc,EAAE,cAAc,GAAG,MAAM,CAIrE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,CAI5D;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,aAAa,EAAE,aAAa,GAAG,MAAM,CAGjE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,CAI5D;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,WAAW,EAAE,WAAW,GAAG,GAAG,CAK1D;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAI/D;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,CAIzD;AAED,+EAA+E;AAC/E,wBAAgB,YAAY,IAAI,iBAAiB,EAAE,CAGlD;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,CAI5D;AAED,gGAAgG;AAChG,wBAAgB,OAAO,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAErD;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,aAAa,EAAE,aAAa,GAAG,OAAO,CAEpE;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAExD;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAErE;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,CAAC,EAAE,GAAG,GAAG,iBAAiB,EAAE,CAGjE"}

package/dist/src/functions/pickups.lua

@@ -3,9 +3,29 @@ local __TS__ArrayFilter = ____lualib.__TS__ArrayFilter
 local ____exports = {}
 local ____constants = require("src.core.constants")
 local CHEST_PICKUP_VARIANTS_SET = ____constants.CHEST_PICKUP_VARIANTS_SET
+local ____batteryNames = require("src.objects.batteryNames")
+local BATTERY_NAMES = ____batteryNames.BATTERY_NAMES
+local DEFAULT_BATTERY_NAME = ____batteryNames.DEFAULT_BATTERY_NAME
+local ____bombNames = require("src.objects.bombNames")
+local BOMB_NAMES = ____bombNames.BOMB_NAMES
+local DEFAULT_BOMB_NAME = ____bombNames.DEFAULT_BOMB_NAME
+local ____chestNames = require("src.objects.chestNames")
+local CHEST_NAMES = ____chestNames.CHEST_NAMES
+local ____coinNames = require("src.objects.coinNames")
+local COIN_NAMES = ____coinNames.COIN_NAMES
+local DEFAULT_COIN_NAME = ____coinNames.DEFAULT_COIN_NAME
 local ____coinSubTypeToValue = require("src.objects.coinSubTypeToValue")
 local COIN_SUB_TYPE_TO_VALUE = ____coinSubTypeToValue.COIN_SUB_TYPE_TO_VALUE
 local DEFAULT_COIN_VALUE = ____coinSubTypeToValue.DEFAULT_COIN_VALUE
+local ____heartNames = require("src.objects.heartNames")
+local DEFAULT_HEART_NAME = ____heartNames.DEFAULT_HEART_NAME
+local HEART_NAMES = ____heartNames.HEART_NAMES
+local ____keyNames = require("src.objects.keyNames")
+local DEFAULT_KEY_NAME = ____keyNames.DEFAULT_KEY_NAME
+local KEY_NAMES = ____keyNames.KEY_NAMES
+local ____sackNames = require("src.objects.sackNames")
+local DEFAULT_SACK_NAME = ____sackNames.DEFAULT_SACK_NAME
+local SACK_NAMES = ____sackNames.SACK_NAMES
 local ____redHeartSubTypesSet = require("src.sets.redHeartSubTypesSet")
 local RED_HEART_SUB_TYPES_SET = ____redHeartSubTypesSet.RED_HEART_SUB_TYPES_SET
 local ____entities = require("src.functions.entities")
@@ -18,12 +38,51 @@ local getHearts = ____pickupsSpecific.getHearts
 function ____exports.isChestVariant(self, pickupVariant)
     return CHEST_PICKUP_VARIANTS_SET:has(pickupVariant)
 end
+--- 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".
+function ____exports.getBatteryName(self, batterySubType)
+    return BATTERY_NAMES[batterySubType] or DEFAULT_BATTERY_NAME
+end
+--- 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".
+function ____exports.getBombName(self, bombSubType)
+    return BOMB_NAMES[bombSubType] or DEFAULT_BOMB_NAME
+end
+--- 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".
+function ____exports.getChestName(self, pickupVariant)
+    local chestNames = CHEST_NAMES
+    return chestNames[pickupVariant] or "Unknown"
+end
+--- 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".
+function ____exports.getCoinName(self, coinSubType)
+    return COIN_NAMES[coinSubType] or DEFAULT_COIN_NAME
+end
 --- Helper function to get the corresponding coin amount from a `CoinSubType`. Returns 1 for modded
 -- sub-types.
 function ____exports.getCoinValue(self, coinSubType)
     local value = COIN_SUB_TYPE_TO_VALUE[coinSubType]
     return value or DEFAULT_COIN_VALUE
 end
+--- 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)".
+function ____exports.getHeartName(self, heartSubType)
+    return HEART_NAMES[heartSubType] or DEFAULT_HEART_NAME
+end
+--- 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".
+function ____exports.getKeyName(self, keySubType)
+    return KEY_NAMES[keySubType] or DEFAULT_KEY_NAME
+end
 --- Helper function to get all of the red heart pickup entities in the room.
 function ____exports.getRedHearts(self)
     local hearts = getHearts(nil)
@@ -32,6 +91,12 @@ function ____exports.getRedHearts(self)
         function(____, heart) return RED_HEART_SUB_TYPES_SET:has(heart.SubType) end
     )
 end
+--- 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".
+function ____exports.getSackName(self, sackSubType)
+    return SACK_NAMES[sackSubType] or DEFAULT_SACK_NAME
+end
 --- Helper function to test if the provided pickup matches one of the various chest variants.
 function ____exports.isChest(self, pickup)
     return ____exports.isChestVariant(nil, pickup.Variant)

package/dist/src/functions/pills.d.ts

@@ -60,7 +60,7 @@ export declare function getPillColorFromEffect(pillEffect: PillEffect): PillColo
  */
 export declare function getPillEffectClass(pillEffect: PillEffect): ItemConfigPillEffectClass;
 /**
- * Helper function to get a pill effect name from a PillEffect enum value.
+ * Helper function to get a pill effect name from a `PillEffect`.
  *
  * For example, `getPillEffectName(PillEffect.BAD_GAS)` would return "Bad Gas".
  */

package/dist/src/functions/pills.lua

@@ -119,7 +119,7 @@ function ____exports.getPillEffectClass(self, pillEffect)
     local pillEffectClass = PILL_EFFECT_CLASSES[pillEffect]
     return pillEffectClass or DEFAULT_PILL_EFFECT_CLASS
 end
---- Helper function to get a pill effect name from a PillEffect enum value.
+--- Helper function to get a pill effect name from a `PillEffect`.
 -- 
 -- For example, `getPillEffectName(PillEffect.BAD_GAS)` would return "Bad Gas".
 function ____exports.getPillEffectName(self, pillEffect)

package/dist/src/functions/stage.d.ts

@@ -16,18 +16,6 @@ export declare function calculateStageTypeRepentance(stage: LevelStage): StageTy
  * consider Downpour 2 to have a stage of 3.
  */
 export declare function getEffectiveStage(): LevelStage;
-/**
- * Helper function to get the English name of the level. For example, "Caves 1".
- *
- * This is useful because the `Level.GetName` method returns a localized version of the level name,
- * which will not display correctly on some fonts.
- *
- * Note that this returns "Blue Womb" instead of "???" for stage 9.
- *
- * @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 declare function getEnglishLevelName(stage?: LevelStage, stageType?: StageType): string;
 /**
  * Helper function to get the corresponding "goto" console command that would correspond to the
  * provided room type and room variant.
@@ -39,6 +27,18 @@ export declare function getEnglishLevelName(stage?: LevelStage, stageType?: Stag
  *                                 `RoomType.DEFAULT` (1). False by default.
  */
 export declare function getGotoCommand(roomType: RoomType, roomVariant: int, useSpecialRoomsForRoomTypeDefault?: boolean): string;
+/**
+ * Helper function to get the English name of the level. For example, "Caves 1".
+ *
+ * This is useful because the `Level.GetName` method returns a localized version of the level name,
+ * which will not display correctly on some fonts.
+ *
+ * Note that this returns "Blue Womb" instead of "???" for stage 9.
+ *
+ * @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 declare function getLevelName(stage?: LevelStage, stageType?: StageType): string;
 /** Alias for the `Level.GetStage` method. */
 export declare function getStage(): LevelStage;
 /**