isaacscript-common 46.0.0 → 47.0.0

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

@@ -1 +1 @@
-{"version":3,"file":"stage.d.ts","sourceRoot":"","sources":["../../../src/functions/stage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAEL,UAAU,EACV,QAAQ,EACR,SAAS,EACV,MAAM,8BAA8B,CAAC;AAUtC;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CA6B/D;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CAmBzE;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,UAAU,CAS9C;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,CAAC,EAAE,UAAU,EAClB,SAAS,CAAC,EAAE,SAAS,GACpB,MAAM,CAaR;AAED;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,QAAQ,EAClB,WAAW,EAAE,GAAG,EAChB,iCAAiC,UAAQ,GACxC,MAAM,CAOR;AAED,6CAA6C;AAC7C,wBAAgB,QAAQ,IAAI,UAAU,CAIrC;AAED;;;;;;;;;GASG;AACH,wBAAgB,UAAU,CAAC,KAAK,CAAC,EAAE,UAAU,EAAE,SAAS,CAAC,EAAE,SAAS,GAAG,OAAO,CAa7E;AAED,iDAAiD;AACjD,wBAAgB,YAAY,IAAI,SAAS,CAIxC;AAED,8FAA8F;AAC9F,wBAAgB,SAAS,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,GAAG,IAAI,CAIvE;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,GAAG,OAAO,CAO7E;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAI/D;AAED;;;;;;;GAOG;AACH,wBAAgB,2BAA2B,CACzC,cAAc,EAAE,UAAU,GACzB,OAAO,CAKT;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,gCAAgC,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAE3E;AAED;;;GAGG;AACH,wBAAgB,+BAA+B,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAE1E;AAED;;;GAGG;AACH,wBAAgB,gCAAgC,CAC9C,KAAK,EAAE,UAAU,EACjB,SAAS,EAAE,SAAS,GACnB,OAAO,CAOT;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAC1C,KAAK,EAAE,UAAU,EACjB,SAAS,EAAE,SAAS,GACnB,OAAO,CAOT;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,CACxC,KAAK,EAAE,UAAU,EACjB,SAAS,EAAE,SAAS,GACnB,OAAO,CAOT;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAE/D;AAED;;;GAGG;AACH,wBAAgB,QAAQ,IAAI,OAAO,CAElC;AAED,wBAAgB,WAAW,IAAI,OAAO,CASrC;AAED,wBAAgB,OAAO,IAAI,OAAO,CASjC;AAED,wBAAgB,UAAU,IAAI,OAAO,CAQpC;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,eAAe,EAAE,UAAU,EAAE,GAAG,OAAO,CAG1E;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAMtC;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAKtC;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,IAAI,OAAO,CAK3C;AAED,wBAAgB,OAAO,IAAI,OAAO,CAQjC;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,GAAG,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,CAIxD;AAED,gGAAgG;AAChG,wBAAgB,eAAe,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAI1D;AAED,gGAAgG;AAChG,wBAAgB,cAAc,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAIzD;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,GAAG,UAAU,EAAE,SAAS,EAAE,GAAG,OAAO,CAI/D;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,IAAI,OAAO,CAGrD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,gCAAgC,IAAI,OAAO,CAK1D;AAED;;;GAGG;AACH,wBAAgB,+BAA+B,IAAI,OAAO,CAKzD;AAED;;;GAGG;AACH,wBAAgB,gCAAgC,IAAI,OAAO,CAM1D;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,IAAI,OAAO,CAMtD;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,IAAI,OAAO,CAMpD;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,IAAI,OAAO,CAK9C;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,UAAU,EACjB,SAAS,EAAE,SAAS,EACpB,MAAM,UAAQ,GACb,IAAI,CAUN;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,CAE9D"}
+{"version":3,"file":"stage.d.ts","sourceRoot":"","sources":["../../../src/functions/stage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAEL,UAAU,EACV,QAAQ,EACR,SAAS,EACV,MAAM,8BAA8B,CAAC;AAUtC;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CA6B/D;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CAmBzE;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,UAAU,CAS9C;AAED;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,QAAQ,EAClB,WAAW,EAAE,GAAG,EAChB,iCAAiC,UAAQ,GACxC,MAAM,CAOR;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,YAAY,CAC1B,KAAK,CAAC,EAAE,UAAU,EAClB,SAAS,CAAC,EAAE,SAAS,GACpB,MAAM,CAaR;AAED,6CAA6C;AAC7C,wBAAgB,QAAQ,IAAI,UAAU,CAIrC;AAED;;;;;;;;;GASG;AACH,wBAAgB,UAAU,CAAC,KAAK,CAAC,EAAE,UAAU,EAAE,SAAS,CAAC,EAAE,SAAS,GAAG,OAAO,CAa7E;AAED,iDAAiD;AACjD,wBAAgB,YAAY,IAAI,SAAS,CAIxC;AAED,8FAA8F;AAC9F,wBAAgB,SAAS,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,GAAG,IAAI,CAIvE;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,GAAG,OAAO,CAO7E;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAI/D;AAED;;;;;;;GAOG;AACH,wBAAgB,2BAA2B,CACzC,cAAc,EAAE,UAAU,GACzB,OAAO,CAKT;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,gCAAgC,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAE3E;AAED;;;GAGG;AACH,wBAAgB,+BAA+B,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAE1E;AAED;;;GAGG;AACH,wBAAgB,gCAAgC,CAC9C,KAAK,EAAE,UAAU,EACjB,SAAS,EAAE,SAAS,GACnB,OAAO,CAOT;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAC1C,KAAK,EAAE,UAAU,EACjB,SAAS,EAAE,SAAS,GACnB,OAAO,CAOT;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,CACxC,KAAK,EAAE,UAAU,EACjB,SAAS,EAAE,SAAS,GACnB,OAAO,CAOT;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAE/D;AAED;;;GAGG;AACH,wBAAgB,QAAQ,IAAI,OAAO,CAElC;AAED,wBAAgB,WAAW,IAAI,OAAO,CASrC;AAED,wBAAgB,OAAO,IAAI,OAAO,CASjC;AAED,wBAAgB,UAAU,IAAI,OAAO,CAQpC;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,eAAe,EAAE,UAAU,EAAE,GAAG,OAAO,CAG1E;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAMtC;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAKtC;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,IAAI,OAAO,CAK3C;AAED,wBAAgB,OAAO,IAAI,OAAO,CAQjC;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,GAAG,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,CAIxD;AAED,gGAAgG;AAChG,wBAAgB,eAAe,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAI1D;AAED,gGAAgG;AAChG,wBAAgB,cAAc,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAIzD;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,GAAG,UAAU,EAAE,SAAS,EAAE,GAAG,OAAO,CAI/D;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,IAAI,OAAO,CAGrD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,gCAAgC,IAAI,OAAO,CAK1D;AAED;;;GAGG;AACH,wBAAgB,+BAA+B,IAAI,OAAO,CAKzD;AAED;;;GAGG;AACH,wBAAgB,gCAAgC,IAAI,OAAO,CAM1D;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,IAAI,OAAO,CAMtD;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,IAAI,OAAO,CAMpD;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,IAAI,OAAO,CAK9C;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,UAAU,EACjB,SAAS,EAAE,SAAS,EACpB,MAAM,UAAQ,GACb,IAAI,CAUN;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,CAE9D"}

package/dist/src/functions/stage.lua

@@ -8,8 +8,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")
@@ -91,6 +91,23 @@ function ____exports.getEffectiveStage(self)
     end
     return stage
 end
+--- 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.
+function ____exports.getGotoCommand(self, roomType, roomVariant, useSpecialRoomsForRoomTypeDefault)
+    if useSpecialRoomsForRoomTypeDefault == nil then
+        useSpecialRoomsForRoomTypeDefault = false
+    end
+    local isNormalRoom = roomType == RoomType.DEFAULT and not useSpecialRoomsForRoomTypeDefault
+    local roomTypeSpecialGotoPrefix = ROOM_TYPE_SPECIAL_GOTO_PREFIXES[roomType]
+    local prefix = isNormalRoom and "d" or "s." .. roomTypeSpecialGotoPrefix
+    return (("goto " .. prefix) .. ".") .. tostring(roomVariant)
+end
 --- 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,
@@ -100,7 +117,7 @@ end
 -- 
 -- @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.
-function ____exports.getEnglishLevelName(self, stage, stageType)
+function ____exports.getLevelName(self, stage, stageType)
     local level = game:GetLevel()
     if stage == nil then
         stage = level:GetStage()
@@ -108,26 +125,9 @@ function ____exports.getEnglishLevelName(self, stage, stageType)
     if stageType == nil then
         stageType = level:GetStageType()
     end
-    local stageNames = ENGLISH_LEVEL_NAMES[stage]
+    local stageNames = LEVEL_NAMES[stage]
     return stageNames[stageType]
 end
---- 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.
-function ____exports.getGotoCommand(self, roomType, roomVariant, useSpecialRoomsForRoomTypeDefault)
-    if useSpecialRoomsForRoomTypeDefault == nil then
-        useSpecialRoomsForRoomTypeDefault = false
-    end
-    local isNormalRoom = roomType == RoomType.DEFAULT and not useSpecialRoomsForRoomTypeDefault
-    local roomTypeSpecialGotoPrefix = ROOM_TYPE_SPECIAL_GOTO_PREFIXES[roomType]
-    local prefix = isNormalRoom and "d" or "s." .. roomTypeSpecialGotoPrefix
-    return (("goto " .. prefix) .. ".") .. tostring(roomVariant)
-end
 --- Alias for the `Level.GetStage` method.
 function ____exports.getStage(self)
     local level = game:GetLevel()

package/dist/src/objects/batteryNames.d.ts

@@ -0,0 +1,10 @@
+export declare const DEFAULT_BATTERY_NAME = "Unknown";
+/** Taken from "entities2.xml". */
+export declare const BATTERY_NAMES: {
+    readonly 0: "Unknown";
+    readonly 1: "Lil' Battery";
+    readonly 2: "Micro Battery";
+    readonly 3: "Mega Battery";
+    readonly 4: "Golden Battery";
+};
+//# sourceMappingURL=batteryNames.d.ts.map

package/dist/src/objects/batteryNames.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"batteryNames.d.ts","sourceRoot":"","sources":["../../../src/objects/batteryNames.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,oBAAoB,YAAY,CAAC;AAE9C,kCAAkC;AAClC,eAAO,MAAM,aAAa;;;;;;CAMyB,CAAC"}

package/dist/src/objects/batteryNames.lua

@@ -0,0 +1,13 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local BatterySubType = ____isaac_2Dtypescript_2Ddefinitions.BatterySubType
+____exports.DEFAULT_BATTERY_NAME = "Unknown"
+--- Taken from "entities2.xml".
+____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

package/dist/src/objects/bombNames.d.ts

@@ -0,0 +1,13 @@
+export declare const DEFAULT_BOMB_NAME = "Unknown";
+/** Taken from "entities2.xml". */
+export declare const BOMB_NAMES: {
+    readonly 0: "Unknown";
+    readonly 1: "Bomb";
+    readonly 2: "Double Bomb";
+    readonly 3: "Troll Bomb";
+    readonly 4: "Golden Bomb";
+    readonly 5: "Megatroll Bomb";
+    readonly 6: "Golden Troll Bomb";
+    readonly 7: "Giga Bomb";
+};
+//# sourceMappingURL=bombNames.d.ts.map

package/dist/src/objects/bombNames.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bombNames.d.ts","sourceRoot":"","sources":["../../../src/objects/bombNames.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,iBAAiB,YAAY,CAAC;AAE3C,kCAAkC;AAClC,eAAO,MAAM,UAAU;;;;;;;;;CAUyB,CAAC"}

package/dist/src/objects/bombNames.lua

@@ -0,0 +1,16 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local BombSubType = ____isaac_2Dtypescript_2Ddefinitions.BombSubType
+____exports.DEFAULT_BOMB_NAME = "Unknown"
+--- Taken from "entities2.xml".
+____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

package/dist/src/objects/chestNames.d.ts

@@ -0,0 +1,16 @@
+/** Taken from "entities2.xml". */
+export declare const CHEST_NAMES: {
+    readonly 50: "Chest";
+    readonly 51: "Bomb Chest";
+    readonly 52: "Spiked Chest";
+    readonly 53: "Eternal Chest";
+    readonly 54: "Mimic Chest";
+    readonly 55: "Old Chest";
+    readonly 56: "Wooden Chest";
+    readonly 57: "Mega Chest";
+    readonly 58: "Haunted Chest";
+    readonly 60: "Locked Chest";
+    readonly 360: "Red Chest";
+    readonly 390: "Mom's Chest";
+};
+//# sourceMappingURL=chestNames.d.ts.map

package/dist/src/objects/chestNames.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chestNames.d.ts","sourceRoot":"","sources":["../../../src/objects/chestNames.ts"],"names":[],"mappings":"AAGA,kCAAkC;AAClC,eAAO,MAAM,WAAW;;;;;;;;;;;;;CAamD,CAAC"}

package/dist/src/objects/chestNames.lua

@@ -0,0 +1,19 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local PickupVariant = ____isaac_2Dtypescript_2Ddefinitions.PickupVariant
+--- Taken from "entities2.xml".
+____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

package/dist/src/objects/coinNames.d.ts

@@ -0,0 +1,13 @@
+export declare const DEFAULT_COIN_NAME = "Unknown";
+/** Taken from "entities2.xml". */
+export declare const COIN_NAMES: {
+    readonly 0: "Unknown";
+    readonly 1: "Penny";
+    readonly 2: "Nickel";
+    readonly 3: "Dime";
+    readonly 4: "Double Penny";
+    readonly 5: "Lucky Penny";
+    readonly 6: "Sticky Nickel";
+    readonly 7: "Golden Penny";
+};
+//# sourceMappingURL=coinNames.d.ts.map

package/dist/src/objects/coinNames.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"coinNames.d.ts","sourceRoot":"","sources":["../../../src/objects/coinNames.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,iBAAiB,YAAY,CAAC;AAE3C,kCAAkC;AAClC,eAAO,MAAM,UAAU;;;;;;;;;CASyB,CAAC"}

package/dist/src/objects/coinNames.lua

@@ -0,0 +1,16 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local CoinSubType = ____isaac_2Dtypescript_2Ddefinitions.CoinSubType
+____exports.DEFAULT_COIN_NAME = "Unknown"
+--- Taken from "entities2.xml".
+____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

package/dist/src/objects/heartNames.d.ts

@@ -0,0 +1,18 @@
+export declare const DEFAULT_HEART_NAME = "Unknown";
+/** Taken from "entities2.xml". */
+export declare const HEART_NAMES: {
+    readonly 0: "Unknown";
+    readonly 1: "Heart";
+    readonly 2: "Heart (half)";
+    readonly 3: "Heart (soul)";
+    readonly 4: "Heart (eternal)";
+    readonly 5: "Heart (double)";
+    readonly 6: "Black Heart";
+    readonly 7: "Gold Heart";
+    readonly 8: "Heart (half soul)";
+    readonly 9: "Scared Heart";
+    readonly 10: "Blended Heart";
+    readonly 11: "Bone Heart";
+    readonly 12: "Rotten Heart";
+};
+//# sourceMappingURL=heartNames.d.ts.map

package/dist/src/objects/heartNames.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"heartNames.d.ts","sourceRoot":"","sources":["../../../src/objects/heartNames.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,kBAAkB,YAAY,CAAC;AAE5C,kCAAkC;AAClC,eAAO,MAAM,WAAW;;;;;;;;;;;;;;CAcyB,CAAC"}

package/dist/src/objects/heartNames.lua

@@ -0,0 +1,21 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local HeartSubType = ____isaac_2Dtypescript_2Ddefinitions.HeartSubType
+____exports.DEFAULT_HEART_NAME = "Unknown"
+--- Taken from "entities2.xml".
+____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

package/dist/src/objects/keyNames.d.ts

@@ -0,0 +1,10 @@
+export declare const DEFAULT_KEY_NAME = "Unknown";
+/** Taken from "entities2.xml". */
+export declare const KEY_NAMES: {
+    readonly 0: "Unknown";
+    readonly 1: "Key";
+    readonly 2: "Golden Key";
+    readonly 3: "Key Ring";
+    readonly 4: "Charged Key";
+};
+//# sourceMappingURL=keyNames.d.ts.map

package/dist/src/objects/keyNames.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyNames.d.ts","sourceRoot":"","sources":["../../../src/objects/keyNames.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,gBAAgB,YAAY,CAAC;AAE1C,kCAAkC;AAClC,eAAO,MAAM,SAAS;;;;;;CAMyB,CAAC"}

package/dist/src/objects/keyNames.lua

@@ -0,0 +1,13 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local KeySubType = ____isaac_2Dtypescript_2Ddefinitions.KeySubType
+____exports.DEFAULT_KEY_NAME = "Unknown"
+--- Taken from "entities2.xml".
+____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

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

@@ -6,7 +6,7 @@
  *
  * Note that this contains "Blue Womb" instead of "???" for stage 9.
  */
-export declare const ENGLISH_LEVEL_NAMES: {
+export declare const LEVEL_NAMES: {
     readonly 1: {
         readonly 0: "Basement 1";
         readonly 1: "Cellar 1";
@@ -112,4 +112,4 @@ export declare const ENGLISH_LEVEL_NAMES: {
         readonly 5: "Home";
     };
 };
-//# sourceMappingURL=englishLevelNames.d.ts.map
+//# sourceMappingURL=levelNames.d.ts.map

package/dist/src/objects/levelNames.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"levelNames.d.ts","sourceRoot":"","sources":["../../../src/objects/levelNames.ts"],"names":[],"mappings":"AAEA;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkI0C,CAAC"}

package/dist/src/objects/{englishLevelNames.lua → levelNames.lua}

@@ -8,7 +8,7 @@ local StageType = ____isaac_2Dtypescript_2Ddefinitions.StageType
 -- which will not display correctly on some fonts.
 -- 
 -- Note that this contains "Blue Womb" instead of "???" for stage 9.
-____exports.ENGLISH_LEVEL_NAMES = {
+____exports.LEVEL_NAMES = {
     [LevelStage.BASEMENT_1] = {
         [StageType.ORIGINAL] = "Basement 1",
         [StageType.WRATH_OF_THE_LAMB] = "Cellar 1",

package/dist/src/objects/sackNames.d.ts

@@ -0,0 +1,8 @@
+export declare const DEFAULT_SACK_NAME = "Unknown";
+/** Taken from "entities2.xml". */
+export declare const SACK_NAMES: {
+    readonly 0: "Unknown";
+    readonly 1: "Grab Bag";
+    readonly 2: "Black Sack";
+};
+//# sourceMappingURL=sackNames.d.ts.map

package/dist/src/objects/sackNames.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sackNames.d.ts","sourceRoot":"","sources":["../../../src/objects/sackNames.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,iBAAiB,YAAY,CAAC;AAE3C,kCAAkC;AAClC,eAAO,MAAM,UAAU;;;;CAIyB,CAAC"}

package/dist/src/objects/sackNames.lua

@@ -0,0 +1,7 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local SackSubType = ____isaac_2Dtypescript_2Ddefinitions.SackSubType
+____exports.DEFAULT_SACK_NAME = "Unknown"
+--- Taken from "entities2.xml".
+____exports.SACK_NAMES = {[SackSubType.NULL] = ____exports.DEFAULT_SACK_NAME, [SackSubType.NORMAL] = "Grab Bag", [SackSubType.BLACK] = "Black Sack"}
+return ____exports

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "46.0.0",
+  "version": "47.0.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",

package/src/functions/cards.ts

@@ -34,7 +34,7 @@ export 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/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>;