isaacscript-common 45.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.
  *
@@ -8950,7 +9001,7 @@ export declare function isOdd(num: int): boolean;
  * Returns true if the item type in the item config is equal to `ItemType.ITEM_PASSIVE` or
  * `ItemType.ITEM_FAMILIAR`.
  */
-export declare function isPassiveCollectible(collectibleOrCollectibleType: EntityPickup | CollectibleType): boolean;
+export declare function isPassiveOrFamiliarCollectible(collectibleOrCollectibleType: EntityPickup | CollectibleType): boolean;
 
 /** Helper function to narrow the type of `PickingUpItem`. */
 export declare function isPickingUpItemCollectible(pickingUpItem: PickingUpItem): pickingUpItem is PickingUpItemCollectible;
@@ -13391,7 +13442,8 @@ declare class ModdedElementSets extends Feature {
      */
     getRandomEdenActiveCollectibleType(seedOrRNG?: Seed | RNG, exceptions?: CollectibleType[] | readonly CollectibleType[]): CollectibleType;
     /**
-     * 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/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 45.0.0
+isaacscript-common 47.0.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -24755,7 +24755,7 @@ end
 function ____exports.isModdedCollectibleType(self, collectibleType)
     return not ____exports.isVanillaCollectibleType(nil, collectibleType)
 end
-function ____exports.isPassiveCollectible(self, collectibleOrCollectibleType)
+function ____exports.isPassiveOrFamiliarCollectible(self, collectibleOrCollectibleType)
     local collectibleType = getCollectibleTypeFromArg(nil, collectibleOrCollectibleType, "isPassiveCollectible")
     local itemType = ____exports.getCollectibleItemType(nil, collectibleType)
     return itemType == ItemType.PASSIVE or itemType == ItemType.FAMILIAR
@@ -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()
@@ -36699,9 +36699,8 @@ function deepCopyUserdata(self, value, serializationType, traversalDescription)
         ____cond100 = ____cond100 or ____switch100 == SerializationType.DESERIALIZE
         if ____cond100 then
             do
-                error(("The deep copy function can not deserialize \"" .. traversalDescription) .. "\", since it is userdata.")
+                return error(("The deep copy function can not deserialize \"" .. traversalDescription) .. "\", since it is userdata.")
             end
-            break
         end
     until true
 end
@@ -38718,7 +38717,7 @@ local ____collectibles = require("src.functions.collectibles")
 local collectibleHasCacheFlag = ____collectibles.collectibleHasCacheFlag
 local isActiveCollectible = ____collectibles.isActiveCollectible
 local isHiddenCollectible = ____collectibles.isHiddenCollectible
-local isPassiveCollectible = ____collectibles.isPassiveCollectible
+local isPassiveOrFamiliarCollectible = ____collectibles.isPassiveOrFamiliarCollectible
 local ____flag = require("src.functions.flag")
 local getFlagName = ____flag.getFlagName
 local ____rng = require("src.functions.rng")
@@ -38997,7 +38996,7 @@ function ModdedElementSets.prototype.lazyInitEdenCollectibleTypesSet(self)
             if isActiveCollectible(nil, collectibleType) then
                 self.edenActiveCollectibleTypesSet:add(collectibleType)
             end
-            if isPassiveCollectible(nil, collectibleType) then
+            if isPassiveOrFamiliarCollectible(nil, collectibleType) then
                 self.edenPassiveCollectibleTypesSet:add(collectibleType)
             end
         end
@@ -39776,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(...) 
@@ -39793,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(...) 
@@ -40166,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")
@@ -40180,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(
@@ -40191,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/classes/features/other/ModdedElementSets.d.ts

@@ -465,7 +465,8 @@ export declare class ModdedElementSets extends Feature {
      */
     getRandomEdenActiveCollectibleType(seedOrRNG?: Seed | RNG, exceptions?: CollectibleType[] | readonly CollectibleType[]): CollectibleType;
     /**
-     * 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/dist/src/classes/features/other/ModdedElementSets.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ModdedElementSets.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/ModdedElementSets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EACL,SAAS,EACT,QAAQ,EACR,eAAe,EACf,kBAAkB,EAClB,aAAa,EACb,UAAU,EACV,WAAW,EACZ,MAAM,8BAA8B,CAAC;AA2CtC,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AA2BhD;;;;;;;GAOG;AACH,qBAAa,iBAAkB,SAAQ,OAAO;IAC5C,OAAO,CAAC,iBAAiB,CAAS;IAElC,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAAyB;IAClE,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAA8B;IAErE,OAAO,CAAC,QAAQ,CAAC,2BAA2B,CAAyB;IACrE,OAAO,CAAC,QAAQ,CAAC,yBAAyB,CAA8B;IAExE,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAqB;IAC1D,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAA0B;IAE7D,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAAqB;IAC7D,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAA0B;IAEhE,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAkB;IACpD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAuB;IAEvD,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAkB;IACvD,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAuB;IAE1D,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAoB;IACxD,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAyB;IAE3D,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAAoB;IAC3D,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAyB;IAE9D,OAAO,CAAC,QAAQ,CAAC,8BAA8B,CAG3C;IAEJ,OAAO,CAAC,QAAQ,CAAC,0BAA0B,CAGvC;IAEJ,OAAO,CAAC,yBAAyB,CAA8B;IAC/D,OAAO,CAAC,QAAQ,CAAC,kCAAkC,CACtB;IAE7B,OAAO,CAAC,qBAAqB,CAA0B;IAEvD,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAGrC;IAEJ,OAAO,CAAC,QAAQ,CAAC,6BAA6B,CAA8B;IAC5E,OAAO,CAAC,QAAQ,CAAC,8BAA8B,CAA8B;IAE7E,OAAO,CAAC,QAAQ,CAAC,+BAA+B,CAG5C;IAEJ;;;;;OAKG;IACH,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAuB;IAE/C,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAAyB;IAWhE,OAAO,CAAC,QAAQ;IAmBhB,OAAO,CAAC,8BAA8B;IAiCtC,OAAO,CAAC,0BAA0B;IA6BlC,OAAO,CAAC,uBAAuB;IA6B/B,OAAO,CAAC,yBAAyB;IA6BjC,OAAO,CAAC,gCAAgC;IA0BxC,OAAO,CAAC,sCAAsC;IAc9C,OAAO,CAAC,kCAAkC;IAc1C,OAAO,CAAC,iCAAiC;IA+BzC,OAAO,CAAC,6BAA6B;IAgBrC,OAAO,CAAC,+BAA+B;IAmBvC,OAAO,CAAC,iBAAiB;IAiCzB;;;;;;;;;;;;OAYG;IAEI,mBAAmB,IAAI,SAAS,eAAe,EAAE;IAKxD;;;;;;;;;;;;OAYG;IAEI,qBAAqB,IAAI,WAAW,CAAC,eAAe,CAAC;IAK5D;;;;;;;;;;;OAWG;IAEI,yBAAyB,IAAI,SAAS,eAAe,EAAE;IAK9D;;;;;;;;;;;OAWG;IAEI,4BAA4B,IAAI,WAAW,CAAC,eAAe,CAAC;IAKnE;;;;;;;;;;;OAWG;IAEI,uBAAuB,CAC5B,MAAM,EAAE,YAAY,GACnB,GAAG,CAAC,eAAe,EAAE,GAAG,CAAC;IAwC5B;;;;;;;;;;;OAWG;IAEI,eAAe,IAAI,SAAS,WAAW,EAAE;IAKhD;;;;;;;;;;;OAWG;IAEI,kBAAkB,IAAI,WAAW,CAAC,WAAW,CAAC;IAKrD;;;;;;;;;;;OAWG;IAEI,qBAAqB,IAAI,SAAS,WAAW,EAAE;IAKtD;;;;;;;;;;;OAWG;IAEI,wBAAwB,IAAI,WAAW,CAAC,WAAW,CAAC;IAS3D;;;;;;;;;;OAUG;IAEI,YAAY,IAAI,SAAS,QAAQ,EAAE;IAK1C;;;;;;;;;;OAUG;IAEI,eAAe,IAAI,WAAW,CAAC,QAAQ,CAAC;IAK/C;;;;;;;;;;OAUG;IAEI,kBAAkB,IAAI,SAAS,QAAQ,EAAE;IAKhD;;;;;;;;;;OAUG;IAEI,qBAAqB,IAAI,WAAW,CAAC,QAAQ,CAAC;IASrD;;;;;;;;;;;OAWG;IAEI,cAAc,IAAI,SAAS,UAAU,EAAE;IAK9C;;;;;;;;;;;OAWG;IAEI,iBAAiB,IAAI,WAAW,CAAC,UAAU,CAAC;IAKnD;;;;;;;;;;;OAWG;IAEI,oBAAoB,IAAI,SAAS,UAAU,EAAE;IAKpD;;;;;;;;;;;OAWG;IAEI,uBAAuB,IAAI,WAAW,CAAC,UAAU,CAAC;IASzD;;;;;;;;;OASG;IAEI,gCAAgC,CACrC,SAAS,EAAE,SAAS,GACnB,WAAW,CAAC,eAAe,CAAC;IAW/B;;;;;;;;;OASG;IAEI,6BAA6B,CAClC,SAAS,EAAE,SAAS,GACnB,WAAW,CAAC,WAAW,CAAC;IAW3B;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IAEI,kCAAkC,CACvC,MAAM,EAAE,YAAY,EACpB,SAAS,EAAE,SAAS,GACnB,eAAe,EAAE;IAkBpB;;;;;;;;;OASG;IAEI,8BAA8B,CACnC,MAAM,EAAE,YAAY,EACpB,SAAS,EAAE,SAAS,GACnB,GAAG,CAAC,WAAW,EAAE,GAAG,CAAC;IAexB;;;;;;;;;;;;;;;;;;;;OAoBG;IAEI,yBAAyB,CAC9B,uBAAuB,EAAE,OAAO,GAC/B,WAAW,CAAC,eAAe,CAAC;IAQ/B;;;;;;;;;;;;;OAaG;IAEI,qBAAqB,IAAI,WAAW,CAAC,WAAW,CAAC;IASxD;;;;;;;;;;;;;;;OAeG;IAEI,0BAA0B,CAC/B,aAAa,EAAE,aAAa,GAC3B,WAAW,CAAC,eAAe,CAAC;IAY/B;;;;;;;;OAQG;IAEI,4BAA4B,CACjC,MAAM,EAAE,YAAY,EACpB,aAAa,EAAE,aAAa,GAC3B,eAAe,EAAE;IAgBpB;;;;;;;;;;;;;;;OAeG;IAEI,oCAAoC,CACzC,UAAU,EAAE,UAAU,GACrB,WAAW,CAAC,eAAe,CAAC;IAU/B;;;;;;;;OAQG;IAEI,sCAAsC,CAC3C,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,UAAU,GACrB,eAAe,EAAE;IAkBpB;;;;;;;;;;;OAWG;IAEI,6BAA6B,IAAI,WAAW,CAAC,eAAe,CAAC;IAKpE;;;;;;;;;;;OAWG;IAEI,8BAA8B,IAAI,WAAW,CAAC,eAAe,CAAC;IAKrE;;;;;;;;;;;;OAYG;IAEI,kCAAkC,CACvC,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,UAAU,GAAE,eAAe,EAAE,GAAG,SAAS,eAAe,EAAO,GAC9D,eAAe;IASlB;;;;;;;;;;;;OAYG;IAEI,mCAAmC,CACxC,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,UAAU,GAAE,eAAe,EAAE,GAAG,SAAS,eAAe,EAAO,GAC9D,eAAe;IAalB;;;;;;;;;;OAUG;IAEI,kBAAkB,CACvB,GAAG,mBAAmB,EAAE,kBAAkB,EAAE,GAC3C,GAAG,CAAC,QAAQ,CAAC;IAoBhB;;;;;;;;;;;;;OAaG;IAEI,uBAAuB,CAC5B,kBAAkB,EAAE,kBAAkB,EACtC,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,UAAU,GAAE,QAAQ,EAAO,GAC1B,QAAQ;IAKX;;;;;;;;;;;;;;;OAeG;IAEI,aAAa,CAClB,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,UAAU,GAAE,QAAQ,EAAO,GAC1B,QAAQ;IAKX;;;;;;;;;;;;OAYG;IAEI,aAAa,CAClB,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,UAAU,GAAE,QAAQ,EAAO,GAC1B,QAAQ;CAKZ"}
+{"version":3,"file":"ModdedElementSets.d.ts","sourceRoot":"","sources":["../../../../../src/classes/features/other/ModdedElementSets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EACL,SAAS,EACT,QAAQ,EACR,eAAe,EACf,kBAAkB,EAClB,aAAa,EACb,UAAU,EACV,WAAW,EACZ,MAAM,8BAA8B,CAAC;AA2CtC,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AA2BhD;;;;;;;GAOG;AACH,qBAAa,iBAAkB,SAAQ,OAAO;IAC5C,OAAO,CAAC,iBAAiB,CAAS;IAElC,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAAyB;IAClE,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAA8B;IAErE,OAAO,CAAC,QAAQ,CAAC,2BAA2B,CAAyB;IACrE,OAAO,CAAC,QAAQ,CAAC,yBAAyB,CAA8B;IAExE,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAqB;IAC1D,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAA0B;IAE7D,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAAqB;IAC7D,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAA0B;IAEhE,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAkB;IACpD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAuB;IAEvD,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAkB;IACvD,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAuB;IAE1D,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAoB;IACxD,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAyB;IAE3D,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAAoB;IAC3D,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAyB;IAE9D,OAAO,CAAC,QAAQ,CAAC,8BAA8B,CAG3C;IAEJ,OAAO,CAAC,QAAQ,CAAC,0BAA0B,CAGvC;IAEJ,OAAO,CAAC,yBAAyB,CAA8B;IAC/D,OAAO,CAAC,QAAQ,CAAC,kCAAkC,CACtB;IAE7B,OAAO,CAAC,qBAAqB,CAA0B;IAEvD,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAGrC;IAEJ,OAAO,CAAC,QAAQ,CAAC,6BAA6B,CAA8B;IAC5E,OAAO,CAAC,QAAQ,CAAC,8BAA8B,CAA8B;IAE7E,OAAO,CAAC,QAAQ,CAAC,+BAA+B,CAG5C;IAEJ;;;;;OAKG;IACH,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAuB;IAE/C,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAAyB;IAWhE,OAAO,CAAC,QAAQ;IAmBhB,OAAO,CAAC,8BAA8B;IAiCtC,OAAO,CAAC,0BAA0B;IA6BlC,OAAO,CAAC,uBAAuB;IA6B/B,OAAO,CAAC,yBAAyB;IA6BjC,OAAO,CAAC,gCAAgC;IA0BxC,OAAO,CAAC,sCAAsC;IAc9C,OAAO,CAAC,kCAAkC;IAc1C,OAAO,CAAC,iCAAiC;IA+BzC,OAAO,CAAC,6BAA6B;IAgBrC,OAAO,CAAC,+BAA+B;IAmBvC,OAAO,CAAC,iBAAiB;IAiCzB;;;;;;;;;;;;OAYG;IAEI,mBAAmB,IAAI,SAAS,eAAe,EAAE;IAKxD;;;;;;;;;;;;OAYG;IAEI,qBAAqB,IAAI,WAAW,CAAC,eAAe,CAAC;IAK5D;;;;;;;;;;;OAWG;IAEI,yBAAyB,IAAI,SAAS,eAAe,EAAE;IAK9D;;;;;;;;;;;OAWG;IAEI,4BAA4B,IAAI,WAAW,CAAC,eAAe,CAAC;IAKnE;;;;;;;;;;;OAWG;IAEI,uBAAuB,CAC5B,MAAM,EAAE,YAAY,GACnB,GAAG,CAAC,eAAe,EAAE,GAAG,CAAC;IAwC5B;;;;;;;;;;;OAWG;IAEI,eAAe,IAAI,SAAS,WAAW,EAAE;IAKhD;;;;;;;;;;;OAWG;IAEI,kBAAkB,IAAI,WAAW,CAAC,WAAW,CAAC;IAKrD;;;;;;;;;;;OAWG;IAEI,qBAAqB,IAAI,SAAS,WAAW,EAAE;IAKtD;;;;;;;;;;;OAWG;IAEI,wBAAwB,IAAI,WAAW,CAAC,WAAW,CAAC;IAS3D;;;;;;;;;;OAUG;IAEI,YAAY,IAAI,SAAS,QAAQ,EAAE;IAK1C;;;;;;;;;;OAUG;IAEI,eAAe,IAAI,WAAW,CAAC,QAAQ,CAAC;IAK/C;;;;;;;;;;OAUG;IAEI,kBAAkB,IAAI,SAAS,QAAQ,EAAE;IAKhD;;;;;;;;;;OAUG;IAEI,qBAAqB,IAAI,WAAW,CAAC,QAAQ,CAAC;IASrD;;;;;;;;;;;OAWG;IAEI,cAAc,IAAI,SAAS,UAAU,EAAE;IAK9C;;;;;;;;;;;OAWG;IAEI,iBAAiB,IAAI,WAAW,CAAC,UAAU,CAAC;IAKnD;;;;;;;;;;;OAWG;IAEI,oBAAoB,IAAI,SAAS,UAAU,EAAE;IAKpD;;;;;;;;;;;OAWG;IAEI,uBAAuB,IAAI,WAAW,CAAC,UAAU,CAAC;IASzD;;;;;;;;;OASG;IAEI,gCAAgC,CACrC,SAAS,EAAE,SAAS,GACnB,WAAW,CAAC,eAAe,CAAC;IAW/B;;;;;;;;;OASG;IAEI,6BAA6B,CAClC,SAAS,EAAE,SAAS,GACnB,WAAW,CAAC,WAAW,CAAC;IAW3B;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IAEI,kCAAkC,CACvC,MAAM,EAAE,YAAY,EACpB,SAAS,EAAE,SAAS,GACnB,eAAe,EAAE;IAkBpB;;;;;;;;;OASG;IAEI,8BAA8B,CACnC,MAAM,EAAE,YAAY,EACpB,SAAS,EAAE,SAAS,GACnB,GAAG,CAAC,WAAW,EAAE,GAAG,CAAC;IAexB;;;;;;;;;;;;;;;;;;;;OAoBG;IAEI,yBAAyB,CAC9B,uBAAuB,EAAE,OAAO,GAC/B,WAAW,CAAC,eAAe,CAAC;IAQ/B;;;;;;;;;;;;;OAaG;IAEI,qBAAqB,IAAI,WAAW,CAAC,WAAW,CAAC;IASxD;;;;;;;;;;;;;;;OAeG;IAEI,0BAA0B,CAC/B,aAAa,EAAE,aAAa,GAC3B,WAAW,CAAC,eAAe,CAAC;IAY/B;;;;;;;;OAQG;IAEI,4BAA4B,CACjC,MAAM,EAAE,YAAY,EACpB,aAAa,EAAE,aAAa,GAC3B,eAAe,EAAE;IAgBpB;;;;;;;;;;;;;;;OAeG;IAEI,oCAAoC,CACzC,UAAU,EAAE,UAAU,GACrB,WAAW,CAAC,eAAe,CAAC;IAU/B;;;;;;;;OAQG;IAEI,sCAAsC,CAC3C,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,UAAU,GACrB,eAAe,EAAE;IAkBpB;;;;;;;;;;;OAWG;IAEI,6BAA6B,IAAI,WAAW,CAAC,eAAe,CAAC;IAKpE;;;;;;;;;;;OAWG;IAEI,8BAA8B,IAAI,WAAW,CAAC,eAAe,CAAC;IAKrE;;;;;;;;;;;;OAYG;IAEI,kCAAkC,CACvC,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,UAAU,GAAE,eAAe,EAAE,GAAG,SAAS,eAAe,EAAO,GAC9D,eAAe;IASlB;;;;;;;;;;;;;OAaG;IAEI,mCAAmC,CACxC,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,UAAU,GAAE,eAAe,EAAE,GAAG,SAAS,eAAe,EAAO,GAC9D,eAAe;IAalB;;;;;;;;;;OAUG;IAEI,kBAAkB,CACvB,GAAG,mBAAmB,EAAE,kBAAkB,EAAE,GAC3C,GAAG,CAAC,QAAQ,CAAC;IAoBhB;;;;;;;;;;;;;OAaG;IAEI,uBAAuB,CAC5B,kBAAkB,EAAE,kBAAkB,EACtC,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,UAAU,GAAE,QAAQ,EAAO,GAC1B,QAAQ;IAKX;;;;;;;;;;;;;;;OAeG;IAEI,aAAa,CAClB,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,UAAU,GAAE,QAAQ,EAAO,GAC1B,QAAQ;IAKX;;;;;;;;;;;;OAYG;IAEI,aAAa,CAClB,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,UAAU,GAAE,QAAQ,EAAO,GAC1B,QAAQ;CAKZ"}

package/dist/src/classes/features/other/ModdedElementSets.lua

@@ -40,7 +40,7 @@ local ____collectibles = require("src.functions.collectibles")
 local collectibleHasCacheFlag = ____collectibles.collectibleHasCacheFlag
 local isActiveCollectible = ____collectibles.isActiveCollectible
 local isHiddenCollectible = ____collectibles.isHiddenCollectible
-local isPassiveCollectible = ____collectibles.isPassiveCollectible
+local isPassiveOrFamiliarCollectible = ____collectibles.isPassiveOrFamiliarCollectible
 local ____flag = require("src.functions.flag")
 local getFlagName = ____flag.getFlagName
 local ____rng = require("src.functions.rng")
@@ -325,7 +325,7 @@ function ModdedElementSets.prototype.lazyInitEdenCollectibleTypesSet(self)
             if isActiveCollectible(nil, collectibleType) then
                 self.edenActiveCollectibleTypesSet:add(collectibleType)
             end
-            if isPassiveCollectible(nil, collectibleType) then
+            if isPassiveOrFamiliarCollectible(nil, collectibleType) then
                 self.edenPassiveCollectibleTypesSet:add(collectibleType)
             end
         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/collectibles.d.ts

@@ -110,7 +110,7 @@ export declare function isModdedCollectibleType(collectibleType: CollectibleType
  * Returns true if the item type in the item config is equal to `ItemType.ITEM_PASSIVE` or
  * `ItemType.ITEM_FAMILIAR`.
  */
-export declare function isPassiveCollectible(collectibleOrCollectibleType: EntityPickup | CollectibleType): boolean;
+export declare function isPassiveOrFamiliarCollectible(collectibleOrCollectibleType: EntityPickup | CollectibleType): boolean;
 /** Helper function to check if a collectible type is a particular quality. */
 export declare function isQuality(collectibleOrCollectibleType: EntityPickup | CollectibleType, quality: int): boolean;
 /**

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

@@ -1 +1 @@
-{"version":3,"file":"collectibles.d.ts","sourceRoot":"","sources":["../../../src/functions/collectibles.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,SAAS,EACT,uBAAuB,EACvB,aAAa,EACd,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAEL,eAAe,EAEf,oBAAoB,EAEpB,QAAQ,EACR,WAAW,EAGZ,MAAM,8BAA8B,CAAC;AAsCtC,wBAAgB,sBAAsB,CAAC,WAAW,EAAE,YAAY,GAAG,IAAI,CAStE;AAED,iGAAiG;AACjG,wBAAgB,uBAAuB,CACrC,4BAA4B,EAAE,YAAY,GAAG,eAAe,EAC5D,SAAS,EAAE,SAAS,GACnB,OAAO,CAYT;AAED,6FAA6F;AAC7F,wBAAgB,uBAAuB,CACrC,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,GACd,OAAO,CAsBT;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAC3D,oBAAoB,CAYtB;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CACvC,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAC3D,MAAM,CAoBR;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAC1C,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAC3D,GAAG,CAgBL;AAED;;;GAGG;AACH,wBAAgB,6BAA6B,CAC3C,4BAA4B,EAAE,YAAY,GAAG,eAAe,EAC5D,MAAM,EAAE,YAAY,GACnB,WAAW,CA6Bb;AAED;;;;;;;;;GASG;AACH,wBAAgB,yBAAyB,CACvC,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAAG,CAAC,CAAC,GAChE,MAAM,CAgBR;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAC3D,GAAG,CAYL;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CACpC,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAC3D,QAAQ,CAYV;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAC3D,GAAG,CAYL;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAChC,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAC3D,MAAM,CAmBR;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,CACxC,WAAW,EAAE,YAAY,GACxB,uBAAuB,CAUzB;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CACnC,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAC3D,GAAG,CAYL;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,kBAAkB,CAChC,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAC3D,QAAQ,CAAC,aAAa,CAAC,CAQzB;AAED,2FAA2F;AAC3F,wBAAgB,mBAAmB,CAAC,eAAe,EAAE,eAAe,GAAG,OAAO,CAG7E;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,YAAY,GAAG,OAAO,CAsBrE;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,WAAW,EAAE,YAAY,GAAG,OAAO,CAKxE;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAC3D,OAAO,CAQT;AAED,wBAAgB,uBAAuB,CACrC,eAAe,EAAE,eAAe,GAC/B,OAAO,CAET;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAClC,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAC3D,OAAO,CAQT;AAED,8EAA8E;AAC9E,wBAAgB,SAAS,CACvB,4BAA4B,EAAE,YAAY,GAAG,eAAe,EAC5D,OAAO,EAAE,GAAG,GACX,OAAO,CAGT;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CACpC,eAAe,EAAE,eAAe,GAC/B,OAAO,CAET;AAED,wBAAgB,sBAAsB,CACpC,eAAe,EAAE,eAAe,GAC/B,OAAO,CAGT;AAED,wBAAgB,wBAAwB,CACtC,eAAe,EAAE,eAAe,GAC/B,OAAO,CAET;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,eAAe,EAAE,eAAe,GAAG,CAAC,CAAC,GACpC,MAAM,CAiBR;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,WAAW,EAAE,YAAY,GAAG,IAAI,CAS5E;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,YAAY,GAAG,IAAI,CASnE;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,YAAY,GAAG,IAAI,CAUnE;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,WAAW,EAAE,YAAY,GAAG,IAAI,CAuBtE;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CACxC,WAAW,EAAE,YAAY,EACzB,uBAAuB,EAAE,uBAAuB,GAC/C,IAAI,CAWN;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,YAAY,EACzB,OAAO,EAAE,MAAM,GAAG,SAAS,GAC1B,IAAI,CAqBN;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CACnC,WAAW,EAAE,YAAY,EACzB,kBAAkB,EAAE,eAAe,GAClC,IAAI,CA2BN;AAED;;;GAGG;AACH,wBAAgB,qCAAqC,IAAI,IAAI,CAK5D"}
+{"version":3,"file":"collectibles.d.ts","sourceRoot":"","sources":["../../../src/functions/collectibles.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,SAAS,EACT,uBAAuB,EACvB,aAAa,EACd,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAEL,eAAe,EAEf,oBAAoB,EAEpB,QAAQ,EACR,WAAW,EAGZ,MAAM,8BAA8B,CAAC;AAsCtC,wBAAgB,sBAAsB,CAAC,WAAW,EAAE,YAAY,GAAG,IAAI,CAStE;AAED,iGAAiG;AACjG,wBAAgB,uBAAuB,CACrC,4BAA4B,EAAE,YAAY,GAAG,eAAe,EAC5D,SAAS,EAAE,SAAS,GACnB,OAAO,CAYT;AAED,6FAA6F;AAC7F,wBAAgB,uBAAuB,CACrC,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,GACd,OAAO,CAsBT;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAC3D,oBAAoB,CAYtB;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CACvC,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAC3D,MAAM,CAoBR;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAC1C,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAC3D,GAAG,CAgBL;AAED;;;GAGG;AACH,wBAAgB,6BAA6B,CAC3C,4BAA4B,EAAE,YAAY,GAAG,eAAe,EAC5D,MAAM,EAAE,YAAY,GACnB,WAAW,CA6Bb;AAED;;;;;;;;;GASG;AACH,wBAAgB,yBAAyB,CACvC,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAAG,CAAC,CAAC,GAChE,MAAM,CAgBR;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAC3D,GAAG,CAYL;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CACpC,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAC3D,QAAQ,CAYV;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAC3D,GAAG,CAYL;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAChC,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAC3D,MAAM,CAmBR;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,CACxC,WAAW,EAAE,YAAY,GACxB,uBAAuB,CAUzB;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CACnC,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAC3D,GAAG,CAYL;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,kBAAkB,CAChC,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAC3D,QAAQ,CAAC,aAAa,CAAC,CAQzB;AAED,2FAA2F;AAC3F,wBAAgB,mBAAmB,CAAC,eAAe,EAAE,eAAe,GAAG,OAAO,CAG7E;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,YAAY,GAAG,OAAO,CAsBrE;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,WAAW,EAAE,YAAY,GAAG,OAAO,CAKxE;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAC3D,OAAO,CAQT;AAED,wBAAgB,uBAAuB,CACrC,eAAe,EAAE,eAAe,GAC/B,OAAO,CAET;AAED;;;GAGG;AACH,wBAAgB,8BAA8B,CAC5C,4BAA4B,EAAE,YAAY,GAAG,eAAe,GAC3D,OAAO,CAQT;AAED,8EAA8E;AAC9E,wBAAgB,SAAS,CACvB,4BAA4B,EAAE,YAAY,GAAG,eAAe,EAC5D,OAAO,EAAE,GAAG,GACX,OAAO,CAGT;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CACpC,eAAe,EAAE,eAAe,GAC/B,OAAO,CAET;AAED,wBAAgB,sBAAsB,CACpC,eAAe,EAAE,eAAe,GAC/B,OAAO,CAGT;AAED,wBAAgB,wBAAwB,CACtC,eAAe,EAAE,eAAe,GAC/B,OAAO,CAET;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,eAAe,EAAE,eAAe,GAAG,CAAC,CAAC,GACpC,MAAM,CAiBR;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,WAAW,EAAE,YAAY,GAAG,IAAI,CAS5E;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,YAAY,GAAG,IAAI,CASnE;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,YAAY,GAAG,IAAI,CAUnE;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,WAAW,EAAE,YAAY,GAAG,IAAI,CAuBtE;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CACxC,WAAW,EAAE,YAAY,EACzB,uBAAuB,EAAE,uBAAuB,GAC/C,IAAI,CAWN;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,YAAY,EACzB,OAAO,EAAE,MAAM,GAAG,SAAS,GAC1B,IAAI,CAqBN;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CACnC,WAAW,EAAE,YAAY,EACzB,kBAAkB,EAAE,eAAe,GAClC,IAAI,CA2BN;AAED;;;GAGG;AACH,wBAAgB,qCAAqC,IAAI,IAAI,CAK5D"}

package/dist/src/functions/collectibles.lua

@@ -358,7 +358,7 @@ function ____exports.isModdedCollectibleType(self, collectibleType)
 end
 --- Returns true if the item type in the item config is equal to `ItemType.ITEM_PASSIVE` or
 -- `ItemType.ITEM_FAMILIAR`.
-function ____exports.isPassiveCollectible(self, collectibleOrCollectibleType)
+function ____exports.isPassiveOrFamiliarCollectible(self, collectibleOrCollectibleType)
     local collectibleType = getCollectibleTypeFromArg(nil, collectibleOrCollectibleType, "isPassiveCollectible")
     local itemType = ____exports.getCollectibleItemType(nil, collectibleType)
     return itemType == ItemType.PASSIVE or itemType == ItemType.FAMILIAR

package/dist/src/functions/deepCopy.lua

@@ -586,9 +586,8 @@ function deepCopyUserdata(self, value, serializationType, traversalDescription)
         ____cond100 = ____cond100 or ____switch100 == SerializationType.DESERIALIZE
         if ____cond100 then
             do
-                error(("The deep copy function can not deserialize \"" .. traversalDescription) .. "\", since it is userdata.")
+                return error(("The deep copy function can not deserialize \"" .. traversalDescription) .. "\", since it is userdata.")
             end
-            break
         end
     until true
 end

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