isaacscript-common 45.0.0 → 47.0.0

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;
 /**

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": "45.0.0",
+  "version": "47.0.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",

package/src/classes/features/other/ModdedElementSets.ts

@@ -29,7 +29,7 @@ import {
   collectibleHasCacheFlag,
   isActiveCollectible,
   isHiddenCollectible,
-  isPassiveCollectible,
+  isPassiveOrFamiliarCollectible,
 } from "../../../functions/collectibles";
 import { getFlagName } from "../../../functions/flag";
 import { getRandomSeed } from "../../../functions/rng";
@@ -413,7 +413,7 @@ export class ModdedElementSets extends Feature {
         this.edenActiveCollectibleTypesSet.add(collectibleType);
       }
 
-      if (isPassiveCollectible(collectibleType)) {
+      if (isPassiveOrFamiliarCollectible(collectibleType)) {
         this.edenPassiveCollectibleTypesSet.add(collectibleType);
       }
     }
@@ -1167,7 +1167,8 @@ export class ModdedElementSets extends Feature {
   }
 
   /**
-   * Returns a random passive collectible type that that is a valid starting item for Eden.
+   * Returns a random passive collectible type that that is a valid starting item for Eden
+   * (including familiars).
    *
    * This function can only be called if at least one callback has been executed. This is because
    * not all collectible types will necessarily be present when a mod first loads (due to mod load

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/collectibles.ts

@@ -477,7 +477,7 @@ export function isModdedCollectibleType(
  * Returns true if the item type in the item config is equal to `ItemType.ITEM_PASSIVE` or
  * `ItemType.ITEM_FAMILIAR`.
  */
-export function isPassiveCollectible(
+export function isPassiveOrFamiliarCollectible(
   collectibleOrCollectibleType: EntityPickup | CollectibleType,
 ): boolean {
   const collectibleType = getCollectibleTypeFromArg(

package/src/functions/deepCopy.ts

@@ -740,9 +740,8 @@ function deepCopyUserdata(
       return serializeIsaacAPIClass(value);
     }
 
-    // eslint-disable-next-line isaacscript/require-break
     case SerializationType.DESERIALIZE: {
-      error(
+      return error(
         `The deep copy function can not deserialize "${traversalDescription}", since it is userdata.`,
       );
     }