isaacscript-common 6.6.1-dev.1 → 6.6.1-dev.5

package/dist/functions/character.d.ts

@@ -0,0 +1,49 @@
+import { PlayerType } from "isaac-typescript-definitions";
+/**
+ * Helper function to determine if the given character can have red heart containers. Returns true
+ * for characters like Isaac, Magdalene, or Cain. Returns true for Keeper and Tainted Keeper, even
+ * though coin containers are not technically the same as red heart containers. Returns false for
+ * characters like Blue Baby. Returns false for The Lost and Tainted Lost.
+ */
+export declare function characterCanHaveRedHearts(character: PlayerType): boolean;
+/**
+ * Helper function to determine if the given character can have soul hearts. Returns true for
+ * characters like Isaac, Magdalene, or Cain. Returns false for characters like Bethany. Returns
+ * false for The Lost and Tainted Lost.
+ */
+export declare function characterCanHaveSoulHearts(character: PlayerType): boolean;
+/**
+ * Helper function for determining whether the given character can take free Devil Deals. (e.g. The
+ * Lost, Tainted Lost, etc.)
+ */
+export declare function characterCanTakeFreeDevilDeals(character: PlayerType): boolean;
+/**
+ * Normally, characters get a red heart container upon reaching a new floor with an eternal heart,
+ * but some characters grant a black heart instead. Returns true for Dark Judas and Tainted Judas.
+ * Otherwise, returns false.
+ */
+export declare function characterGetsBlackHeartFromEternalHeart(character: PlayerType): boolean;
+/**
+ * Helper function to determine if the specified character starts with an active item.
+ *
+ * For the purposes of this function, the save file is considered to be fully unlocked (e.g. Isaac
+ * is considered to starts with the D6, but this is not the case on a brand new save file).
+ */
+export declare function characterStartsWithActiveItem(character: PlayerType): boolean;
+/**
+ * - Most characters have a 56 frame death animation (i.e. the "Death" animation).
+ * - The Lost and Tainted Lost have a 38 frame death animation (i.e. the "LostDeath" animation).
+ * - Tainted Forgotten have a 20 frame death animation (i.e. the "ForgottenDeath" animation).
+ */
+export declare function getCharacterDeathAnimationName(character: PlayerType): string;
+/**
+ * Returns the maximum heart containers that the provided character can have. Normally, this is 12,
+ * but with Keeper it is 3, and with Tainted Keeper it is 2. This does not account for Birthright or
+ * Mother's Kiss; use the `getPlayerMaxHeartContainers` helper function for that.
+ */
+export declare function getCharacterMaxHeartContainers(character: PlayerType): int;
+/** Helper function to get the name of a character. Returns "Unknown" for modded characters. */
+export declare function getCharacterName(character: PlayerType): string;
+export declare function isModdedCharacter(character: PlayerType): boolean;
+export declare function isVanillaCharacter(character: PlayerType): boolean;
+//# sourceMappingURL=character.d.ts.map

package/dist/functions/character.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"character.d.ts","sourceRoot":"","sources":["../../../../../packages/isaacscript-common/src/functions/character.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAU1D;;;;;GAKG;AACH,wBAAgB,yBAAyB,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAExE;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAEzE;AAED;;;GAGG;AACH,wBAAgB,8BAA8B,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAE7E;AAED;;;;GAIG;AACH,wBAAgB,uCAAuC,CACrD,SAAS,EAAE,UAAU,GACpB,OAAO,CAET;AAED;;;;;GAKG;AACH,wBAAgB,6BAA6B,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAE5E;AAED;;;;GAIG;AACH,wBAAgB,8BAA8B,CAAC,SAAS,EAAE,UAAU,GAAG,MAAM,CAU5E;AAED;;;;GAIG;AACH,wBAAgB,8BAA8B,CAAC,SAAS,EAAE,UAAU,GAAG,GAAG,CAsBzE;AAED,+FAA+F;AAC/F,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,UAAU,GAAG,MAAM,CAM9D;AAED,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAEhE;AAED,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAEjE"}

package/dist/functions/character.lua

@@ -0,0 +1,94 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
+local ____constantsFirstLast = require("constantsFirstLast")
+local LAST_VANILLA_CHARACTER = ____constantsFirstLast.LAST_VANILLA_CHARACTER
+local ____characterNames = require("objects.characterNames")
+local CHARACTER_NAMES = ____characterNames.CHARACTER_NAMES
+local ____charactersThatStartWithAnActiveItemSet = require("sets.charactersThatStartWithAnActiveItemSet")
+local CHARACTERS_THAT_START_WITH_AN_ACTIVE_ITEM_SET = ____charactersThatStartWithAnActiveItemSet.CHARACTERS_THAT_START_WITH_AN_ACTIVE_ITEM_SET
+local ____charactersWithBlackHeartFromEternalHeartSet = require("sets.charactersWithBlackHeartFromEternalHeartSet")
+local CHARACTERS_WITH_BLACK_HEART_FROM_ETERNAL_HEART_SET = ____charactersWithBlackHeartFromEternalHeartSet.CHARACTERS_WITH_BLACK_HEART_FROM_ETERNAL_HEART_SET
+local ____charactersWithFreeDevilDealsSet = require("sets.charactersWithFreeDevilDealsSet")
+local CHARACTERS_WITH_FREE_DEVIL_DEALS_SET = ____charactersWithFreeDevilDealsSet.CHARACTERS_WITH_FREE_DEVIL_DEALS_SET
+local ____charactersWithNoRedHeartsSet = require("sets.charactersWithNoRedHeartsSet")
+local CHARACTERS_WITH_NO_RED_HEARTS_SET = ____charactersWithNoRedHeartsSet.CHARACTERS_WITH_NO_RED_HEARTS_SET
+local ____charactersWithNoSoulHeartsSet = require("sets.charactersWithNoSoulHeartsSet")
+local CHARACTERS_WITH_NO_SOUL_HEARTS_SET = ____charactersWithNoSoulHeartsSet.CHARACTERS_WITH_NO_SOUL_HEARTS_SET
+local ____lostStyleCharactersSet = require("sets.lostStyleCharactersSet")
+local LOST_STYLE_CHARACTERS_SET = ____lostStyleCharactersSet.LOST_STYLE_CHARACTERS_SET
+function ____exports.isModdedCharacter(self, character)
+    return not ____exports.isVanillaCharacter(nil, character)
+end
+function ____exports.isVanillaCharacter(self, character)
+    return character <= LAST_VANILLA_CHARACTER
+end
+--- Helper function to determine if the given character can have red heart containers. Returns true
+-- for characters like Isaac, Magdalene, or Cain. Returns true for Keeper and Tainted Keeper, even
+-- though coin containers are not technically the same as red heart containers. Returns false for
+-- characters like Blue Baby. Returns false for The Lost and Tainted Lost.
+function ____exports.characterCanHaveRedHearts(self, character)
+    return not CHARACTERS_WITH_NO_RED_HEARTS_SET:has(character)
+end
+--- Helper function to determine if the given character can have soul hearts. Returns true for
+-- characters like Isaac, Magdalene, or Cain. Returns false for characters like Bethany. Returns
+-- false for The Lost and Tainted Lost.
+function ____exports.characterCanHaveSoulHearts(self, character)
+    return not CHARACTERS_WITH_NO_SOUL_HEARTS_SET:has(character)
+end
+--- Helper function for determining whether the given character can take free Devil Deals. (e.g. The
+-- Lost, Tainted Lost, etc.)
+function ____exports.characterCanTakeFreeDevilDeals(self, character)
+    return CHARACTERS_WITH_FREE_DEVIL_DEALS_SET:has(character)
+end
+--- Normally, characters get a red heart container upon reaching a new floor with an eternal heart,
+-- but some characters grant a black heart instead. Returns true for Dark Judas and Tainted Judas.
+-- Otherwise, returns false.
+function ____exports.characterGetsBlackHeartFromEternalHeart(self, character)
+    return CHARACTERS_WITH_BLACK_HEART_FROM_ETERNAL_HEART_SET:has(character)
+end
+--- Helper function to determine if the specified character starts with an active item.
+-- 
+-- For the purposes of this function, the save file is considered to be fully unlocked (e.g. Isaac
+-- is considered to starts with the D6, but this is not the case on a brand new save file).
+function ____exports.characterStartsWithActiveItem(self, character)
+    return CHARACTERS_THAT_START_WITH_AN_ACTIVE_ITEM_SET:has(character)
+end
+--- - Most characters have a 56 frame death animation (i.e. the "Death" animation).
+-- - The Lost and Tainted Lost have a 38 frame death animation (i.e. the "LostDeath" animation).
+-- - Tainted Forgotten have a 20 frame death animation (i.e. the "ForgottenDeath" animation).
+function ____exports.getCharacterDeathAnimationName(self, character)
+    if LOST_STYLE_CHARACTERS_SET:has(character) then
+        return "LostDeath"
+    end
+    if character == PlayerType.THE_FORGOTTEN_B then
+        return "ForgottenDeath"
+    end
+    return "Death"
+end
+--- Returns the maximum heart containers that the provided character can have. Normally, this is 12,
+-- but with Keeper it is 3, and with Tainted Keeper it is 2. This does not account for Birthright or
+-- Mother's Kiss; use the `getPlayerMaxHeartContainers` helper function for that.
+function ____exports.getCharacterMaxHeartContainers(self, character)
+    if character == PlayerType.KEEPER then
+        return 3
+    end
+    if character == PlayerType.THE_FORGOTTEN then
+        return 6
+    end
+    if character == PlayerType.THE_SOUL then
+        return 6
+    end
+    if character == PlayerType.KEEPER_B then
+        return 2
+    end
+    return 12
+end
+--- Helper function to get the name of a character. Returns "Unknown" for modded characters.
+function ____exports.getCharacterName(self, character)
+    if ____exports.isModdedCharacter(nil, character) then
+        return "Unknown"
+    end
+    return CHARACTER_NAMES[character]
+end
+return ____exports

package/dist/functions/charge.d.ts

@@ -0,0 +1,77 @@
+import { ActiveSlot } from "isaac-typescript-definitions";
+/**
+ * Helper function to add a charge to the player's active item. Will flash the HUD and play the
+ * appropriate sound effect, depending on whether the charge is partially full or completely full.
+ *
+ * If the player's active item is already fully charged, then this function will return 0 and not
+ * flash the HUD or play a sound effect.
+ *
+ * This function will take the following things into account:
+ * - The Battery
+ * - AAA Battery
+ *
+ * @param player The player to grant the charges to.
+ * @param activeSlot The slot to grant the charges to.
+ * @param numCharges Optional. The amount of charges to grant. Default is 1.
+ * @param playSoundEffect Optional. Whether to play a charge-related sound effect. Default is true.
+ * @returns The amount of charges that were actually granted. For example, if the active item was
+ *          only one away from a full charge, but the `numCharges` provided to this function was 2,
+ *          then this function would return 1.
+ */
+export declare function addCharge(player: EntityPlayer, activeSlot: ActiveSlot, numCharges?: number, playSoundEffect?: boolean): int;
+/**
+ * Helper function to add a charge to a player's active item(s), emulating what happens when a room
+ * is cleared.
+ *
+ * This function will take the following things into account:
+ * - 2x2 rooms and L rooms granting a double charge
+ * - The Battery
+ * - AAA Battery
+ *
+ * @param player The player to grant the charges to.
+ * @param bigRoomDoubleCharge Optional. If set to false, it will treat the current room as a 1x1
+ *                            room for the purposes of calculating how much charge to grant. Default
+ *                            is true.
+ * @param playSoundEffect Optional. Whether to play a charge-related sound effect. Default is true.
+ */
+export declare function addRoomClearCharge(player: EntityPlayer, bigRoomDoubleCharge?: boolean, playSoundEffect?: boolean): void;
+/**
+ * Helper function to add a charge to one of a player's active items, emulating what happens when a
+ * room is cleared.
+ *
+ * This function will take the following things into account:
+ * - L rooms and 2x2 rooms granting a double charge
+ * - The Battery
+ * - AAA Battery
+ *
+ * @param player The player to grant the charges to.
+ * @param activeSlot The active item slot to grant the charges to.
+ * @param bigRoomDoubleCharge Optional. If set to false, it will treat the current room as a 1x1
+ *                            room for the purposes of calculating how much charge to grant. Default
+ *                            is true.
+ * @param playSoundEffect Optional. Whether to play a charge-related sound effect. Default is true.
+ */
+export declare function addRoomClearChargeToSlot(player: EntityPlayer, activeSlot: ActiveSlot, bigRoomDoubleCharge?: boolean, playSoundEffect?: boolean): void;
+/**
+ * Helper function to add a charge to every player's active item, emulating what happens when a room
+ * is cleared.
+ *
+ * This function will take the following things into account:
+ * - L rooms and 2x2 rooms granting a double charge
+ * - The Battery
+ * - AAA Battery
+ *
+ * @param ignoreBigRoomDoubleCharge Optional. If set to true, it will treat the current room as a
+ *                                 1x1 room for the purposes of calculating how much charge to
+ *                                 grant. Default is false.
+ */
+export declare function addRoomClearCharges(ignoreBigRoomDoubleCharge?: boolean): void;
+/**
+ * Helper function to get the combined normal charge and the battery charge for the player's active
+ * item. This is useful because you have to add these two values together when setting the active
+ * charge.
+ */
+export declare function getTotalCharge(player: EntityPlayer, activeSlot: ActiveSlot): int;
+export declare function isActiveSlotDoubleCharged(player: EntityPlayer, activeSlot: ActiveSlot): boolean;
+export declare function playChargeSoundEffect(player: EntityPlayer, activeSlot: ActiveSlot): void;
+//# sourceMappingURL=charge.d.ts.map

package/dist/functions/charge.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"charge.d.ts","sourceRoot":"","sources":["../../../../../packages/isaacscript-common/src/functions/charge.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EAIX,MAAM,8BAA8B,CAAC;AAMtC;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,SAAS,CACvB,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,UAAU,EACtB,UAAU,SAAI,EACd,eAAe,UAAO,GACrB,GAAG,CA2BL;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,YAAY,EACpB,mBAAmB,UAAO,EAC1B,eAAe,UAAO,GACrB,IAAI,CAaN;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,wBAAwB,CACtC,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,UAAU,EACtB,mBAAmB,UAAO,EAC1B,eAAe,UAAO,GACrB,IAAI,CAMN;AAuED;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CAAC,yBAAyB,UAAQ,GAAG,IAAI,CAI3E;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAC5B,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,UAAU,GACrB,GAAG,CAKL;AAED,wBAAgB,yBAAyB,CACvC,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,UAAU,GACrB,OAAO,CAMT;AAED,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,UAAU,GACrB,IAAI,CAYN"}

package/dist/functions/charge.lua

@@ -0,0 +1,207 @@
+local ____exports = {}
+local getClampedChargesToAdd, getChargesToAddWithAAAModifier, shouldPlayFullRechargeSound
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local ActiveSlot = ____isaac_2Dtypescript_2Ddefinitions.ActiveSlot
+local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
+local SoundEffect = ____isaac_2Dtypescript_2Ddefinitions.SoundEffect
+local TrinketType = ____isaac_2Dtypescript_2Ddefinitions.TrinketType
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local sfxManager = ____cachedClasses.sfxManager
+local ____collectibles = require("functions.collectibles")
+local getCollectibleMaxCharges = ____collectibles.getCollectibleMaxCharges
+local ____playerIndex = require("functions.playerIndex")
+local getPlayers = ____playerIndex.getPlayers
+local ____roomShape = require("functions.roomShape")
+local getRoomShapeCharges = ____roomShape.getRoomShapeCharges
+--- Helper function to add a charge to the player's active item. Will flash the HUD and play the
+-- appropriate sound effect, depending on whether the charge is partially full or completely full.
+-- 
+-- If the player's active item is already fully charged, then this function will return 0 and not
+-- flash the HUD or play a sound effect.
+-- 
+-- This function will take the following things into account:
+-- - The Battery
+-- - AAA Battery
+-- 
+-- @param player The player to grant the charges to.
+-- @param activeSlot The slot to grant the charges to.
+-- @param numCharges Optional. The amount of charges to grant. Default is 1.
+-- @param playSoundEffect Optional. Whether to play a charge-related sound effect. Default is true.
+-- @returns The amount of charges that were actually granted. For example, if the active item was
+-- only one away from a full charge, but the `numCharges` provided to this function was 2,
+-- then this function would return 1.
+function ____exports.addCharge(self, player, activeSlot, numCharges, playSoundEffect)
+    if numCharges == nil then
+        numCharges = 1
+    end
+    if playSoundEffect == nil then
+        playSoundEffect = true
+    end
+    local hud = game:GetHUD()
+    local chargesToAdd = getClampedChargesToAdd(nil, player, activeSlot, numCharges)
+    local modifiedChargesToAdd = getChargesToAddWithAAAModifier(nil, player, activeSlot, chargesToAdd)
+    local totalCharge = ____exports.getTotalCharge(nil, player, activeSlot)
+    local newCharge = totalCharge + modifiedChargesToAdd
+    if newCharge == totalCharge then
+        return 0
+    end
+    player:SetActiveCharge(newCharge, activeSlot)
+    hud:FlashChargeBar(player, activeSlot)
+    if playSoundEffect then
+        ____exports.playChargeSoundEffect(nil, player, activeSlot)
+    end
+    return modifiedChargesToAdd
+end
+--- Helper function to add a charge to one of a player's active items, emulating what happens when a
+-- room is cleared.
+-- 
+-- This function will take the following things into account:
+-- - L rooms and 2x2 rooms granting a double charge
+-- - The Battery
+-- - AAA Battery
+-- 
+-- @param player The player to grant the charges to.
+-- @param activeSlot The active item slot to grant the charges to.
+-- @param bigRoomDoubleCharge Optional. If set to false, it will treat the current room as a 1x1
+-- room for the purposes of calculating how much charge to grant. Default
+-- is true.
+-- @param playSoundEffect Optional. Whether to play a charge-related sound effect. Default is true.
+function ____exports.addRoomClearChargeToSlot(self, player, activeSlot, bigRoomDoubleCharge, playSoundEffect)
+    if bigRoomDoubleCharge == nil then
+        bigRoomDoubleCharge = true
+    end
+    if playSoundEffect == nil then
+        playSoundEffect = true
+    end
+    local room = game:GetRoom()
+    local roomShape = room:GetRoomShape()
+    local numCharges = bigRoomDoubleCharge and getRoomShapeCharges(nil, roomShape) or 1
+    ____exports.addCharge(
+        nil,
+        player,
+        activeSlot,
+        numCharges,
+        playSoundEffect
+    )
+end
+function getClampedChargesToAdd(self, player, activeSlot, numCharges)
+    local activeItem = player:GetActiveItem(activeSlot)
+    local activeCharge = player:GetActiveCharge(activeSlot)
+    local batteryCharge = player:GetBatteryCharge(activeSlot)
+    local hasBattery = player:HasCollectible(CollectibleType.BATTERY)
+    local maxCharges = getCollectibleMaxCharges(nil, activeItem)
+    if not hasBattery and activeCharge == maxCharges then
+        return 0
+    end
+    if hasBattery and batteryCharge == maxCharges then
+        return 0
+    end
+    if not hasBattery and activeCharge + 1 == maxCharges then
+        return 1
+    end
+    if hasBattery and batteryCharge + 1 == maxCharges then
+        return 1
+    end
+    return numCharges
+end
+function getChargesToAddWithAAAModifier(self, player, activeSlot, chargesToAdd)
+    local activeItem = player:GetActiveItem(activeSlot)
+    local activeCharge = player:GetActiveCharge(activeSlot)
+    local batteryCharge = player:GetBatteryCharge(activeSlot)
+    local hasBattery = player:HasCollectible(CollectibleType.BATTERY)
+    local hasAAABattery = player:HasTrinket(TrinketType.AAA_BATTERY)
+    local maxCharges = getCollectibleMaxCharges(nil, activeItem)
+    if not hasAAABattery then
+        return chargesToAdd
+    end
+    if not hasBattery and activeCharge + chargesToAdd == maxCharges - 1 then
+        return chargesToAdd + 1
+    end
+    if hasBattery and batteryCharge + chargesToAdd == maxCharges - 1 then
+        return chargesToAdd + 1
+    end
+    return chargesToAdd
+end
+--- Helper function to get the combined normal charge and the battery charge for the player's active
+-- item. This is useful because you have to add these two values together when setting the active
+-- charge.
+function ____exports.getTotalCharge(self, player, activeSlot)
+    local activeCharge = player:GetActiveCharge(activeSlot)
+    local batteryCharge = player:GetBatteryCharge(activeSlot)
+    return activeCharge + batteryCharge
+end
+function ____exports.playChargeSoundEffect(self, player, activeSlot)
+    for ____, soundEffect in ipairs({SoundEffect.BATTERY_CHARGE, SoundEffect.BEEP}) do
+        sfxManager:Stop(soundEffect)
+    end
+    local chargeSoundEffect = shouldPlayFullRechargeSound(nil, player, activeSlot) and SoundEffect.BATTERY_CHARGE or SoundEffect.BEEP
+    sfxManager:Play(chargeSoundEffect)
+end
+function shouldPlayFullRechargeSound(self, player, activeSlot)
+    local activeItem = player:GetActiveItem(activeSlot)
+    local activeCharge = player:GetActiveCharge(activeSlot)
+    local batteryCharge = player:GetBatteryCharge(activeSlot)
+    local hasBattery = player:HasCollectible(CollectibleType.BATTERY)
+    local maxCharges = getCollectibleMaxCharges(nil, activeItem)
+    if not hasBattery then
+        return activeCharge == maxCharges
+    end
+    return batteryCharge == maxCharges or activeCharge == maxCharges and batteryCharge == 0
+end
+--- Helper function to add a charge to a player's active item(s), emulating what happens when a room
+-- is cleared.
+-- 
+-- This function will take the following things into account:
+-- - 2x2 rooms and L rooms granting a double charge
+-- - The Battery
+-- - AAA Battery
+-- 
+-- @param player The player to grant the charges to.
+-- @param bigRoomDoubleCharge Optional. If set to false, it will treat the current room as a 1x1
+-- room for the purposes of calculating how much charge to grant. Default
+-- is true.
+-- @param playSoundEffect Optional. Whether to play a charge-related sound effect. Default is true.
+function ____exports.addRoomClearCharge(self, player, bigRoomDoubleCharge, playSoundEffect)
+    if bigRoomDoubleCharge == nil then
+        bigRoomDoubleCharge = true
+    end
+    if playSoundEffect == nil then
+        playSoundEffect = true
+    end
+    for ____, activeSlot in ipairs({ActiveSlot.PRIMARY, ActiveSlot.SECONDARY, ActiveSlot.POCKET}) do
+        ____exports.addRoomClearChargeToSlot(
+            nil,
+            player,
+            activeSlot,
+            bigRoomDoubleCharge,
+            playSoundEffect
+        )
+    end
+end
+--- Helper function to add a charge to every player's active item, emulating what happens when a room
+-- is cleared.
+-- 
+-- This function will take the following things into account:
+-- - L rooms and 2x2 rooms granting a double charge
+-- - The Battery
+-- - AAA Battery
+-- 
+-- @param ignoreBigRoomDoubleCharge Optional. If set to true, it will treat the current room as a
+-- 1x1 room for the purposes of calculating how much charge to
+-- grant. Default is false.
+function ____exports.addRoomClearCharges(self, ignoreBigRoomDoubleCharge)
+    if ignoreBigRoomDoubleCharge == nil then
+        ignoreBigRoomDoubleCharge = false
+    end
+    for ____, player in ipairs(getPlayers(nil)) do
+        ____exports.addRoomClearCharge(nil, player, ignoreBigRoomDoubleCharge)
+    end
+end
+function ____exports.isActiveSlotDoubleCharged(self, player, activeSlot)
+    local collectibleType = player:GetActiveItem(activeSlot)
+    local batteryCharge = player:GetBatteryCharge(activeSlot)
+    local maxCharges = getCollectibleMaxCharges(nil, collectibleType)
+    return batteryCharge >= maxCharges
+end
+return ____exports

package/dist/functions/chargeBar.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+import { ChargeBarSprites } from "../interfaces/ChargeBarSprites";
+/**
+ * Constructor for a `ChargeBarSprites` object. For more information, see the `renderChargeBar`
+ * helper function.
+ */
+export declare function newChargeBarSprites(maxCharges: int): ChargeBarSprites;
+/**
+ * Helper function to render a charge bar on the screen. First, call the `newChargeBarSprites`
+ * function to initialize the sprites, and then call this function on every render frame.
+ */
+export declare function renderChargeBar(sprites: ChargeBarSprites, position: Vector, normalCharges: int, batteryCharges: int): void;
+//# sourceMappingURL=chargeBar.d.ts.map

package/dist/functions/chargeBar.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chargeBar.d.ts","sourceRoot":"","sources":["../../../../../packages/isaacscript-common/src/functions/chargeBar.ts"],"names":[],"mappings":";;AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAIlE;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,UAAU,EAAE,GAAG,GAAG,gBAAgB,CAwBrE;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAC7B,OAAO,EAAE,gBAAgB,EACzB,QAAQ,EAAE,MAAM,EAChB,aAAa,EAAE,GAAG,EAClB,cAAc,EAAE,GAAG,GAClB,IAAI,CAgBN"}

package/dist/functions/chargeBar.lua

@@ -0,0 +1,45 @@
+local ____exports = {}
+local getChargeBarClamp
+function getChargeBarClamp(self, charges, maxCharges)
+    local meterMultiplier = 24 / maxCharges
+    local meterClip = 26 - charges * meterMultiplier
+    return Vector(0, meterClip)
+end
+local CHARGE_BAR_ANM2 = "gfx/ui/ui_chargebar.anm2"
+--- Constructor for a `ChargeBarSprites` object. For more information, see the `renderChargeBar`
+-- helper function.
+function ____exports.newChargeBarSprites(self, maxCharges)
+    local back = Sprite()
+    back:Load(CHARGE_BAR_ANM2, true)
+    back:Play("BarEmpty", true)
+    local meter = Sprite()
+    meter:Load(CHARGE_BAR_ANM2, true)
+    meter:Play("BarFull", true)
+    local meterBattery = Sprite()
+    meterBattery:Load(CHARGE_BAR_ANM2, true)
+    meterBattery:Play("BarFull", true)
+    local lines = Sprite()
+    lines:Load(CHARGE_BAR_ANM2, true)
+    lines:Play(
+        "BarOverlay" .. tostring(maxCharges),
+        true
+    )
+    return {
+        back = back,
+        meter = meter,
+        meterBattery = meterBattery,
+        lines = lines,
+        maxCharges = maxCharges
+    }
+end
+--- Helper function to render a charge bar on the screen. First, call the `newChargeBarSprites`
+-- function to initialize the sprites, and then call this function on every render frame.
+function ____exports.renderChargeBar(self, sprites, position, normalCharges, batteryCharges)
+    sprites.back:Render(position)
+    local normalChargesClamp = getChargeBarClamp(nil, normalCharges, sprites.maxCharges)
+    sprites.meter:Render(position, normalChargesClamp)
+    local batteryChargesClamp = getChargeBarClamp(nil, batteryCharges, sprites.maxCharges)
+    sprites.meterBattery:Render(position, batteryChargesClamp)
+    sprites.lines:Render(position)
+end
+return ____exports

package/dist/functions/collectibleCacheFlag.d.ts

@@ -0,0 +1,24 @@
+import { CacheFlag, CollectibleType } from "isaac-typescript-definitions";
+export declare function collectibleHasCacheFlag(collectibleType: CollectibleType, cacheFlag: CacheFlag): boolean;
+/**
+ * Returns a set containing every collectible type with the given cache flag, including modded
+ * collectibles.
+ */
+export declare function getCollectiblesForCacheFlag(cacheFlag: CacheFlag): Set<CollectibleType>;
+/**
+ * Returns an array containing every collectible type that the player has that matches the provided
+ * CacheFlag.
+ *
+ * For example, if the cache flag is `CacheFlag.FLYING`, and the player has one Lord of the Pit and
+ * two Dead Doves, then this function would return:
+ *
+ * ```ts
+ * [
+ *   CollectibleType.LORD_OF_THE_PIT,
+ *   CollectibleType.DEAD_DOVE,
+ *   CollectibleType.DEAD_DOVE,
+ * ]
+ * ```
+ */
+export declare function getPlayerCollectiblesForCacheFlag(player: EntityPlayer, cacheFlag: CacheFlag): CollectibleType[];
+//# sourceMappingURL=collectibleCacheFlag.d.ts.map

package/dist/functions/collectibleCacheFlag.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"collectibleCacheFlag.d.ts","sourceRoot":"","sources":["../../../../../packages/isaacscript-common/src/functions/collectibleCacheFlag.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AA2B1E,wBAAgB,uBAAuB,CACrC,eAAe,EAAE,eAAe,EAChC,SAAS,EAAE,SAAS,GACnB,OAAO,CAOT;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,CACzC,SAAS,EAAE,SAAS,GACnB,GAAG,CAAC,eAAe,CAAC,CAYtB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,iCAAiC,CAC/C,MAAM,EAAE,YAAY,EACpB,SAAS,EAAE,SAAS,GACnB,eAAe,EAAE,CAYnB"}

package/dist/functions/collectibleCacheFlag.lua

@@ -0,0 +1,80 @@
+local ____lualib = require("lualib_bundle")
+local Map = ____lualib.Map
+local __TS__New = ____lualib.__TS__New
+local Set = ____lualib.Set
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local CacheFlag = ____isaac_2Dtypescript_2Ddefinitions.CacheFlag
+local ____cachedClasses = require("cachedClasses")
+local itemConfig = ____cachedClasses.itemConfig
+local ____collectibleSet = require("functions.collectibleSet")
+local getCollectibleArray = ____collectibleSet.getCollectibleArray
+local ____enums = require("functions.enums")
+local getEnumValues = ____enums.getEnumValues
+local ____flag = require("functions.flag")
+local hasFlag = ____flag.hasFlag
+local ____set = require("functions.set")
+local copySet = ____set.copySet
+local getSortedSetValues = ____set.getSortedSetValues
+local ____utils = require("functions.utils")
+local ____repeat = ____utils["repeat"]
+function ____exports.collectibleHasCacheFlag(self, collectibleType, cacheFlag)
+    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
+    if itemConfigItem == nil then
+        return false
+    end
+    return hasFlag(nil, itemConfigItem.CacheFlags, cacheFlag)
+end
+local CACHE_FLAG_TO_COLLECTIBLES_MAP = __TS__New(Map)
+local function initCacheFlagMap(self)
+    for ____, cacheFlag in ipairs(getEnumValues(nil, CacheFlag)) do
+        local collectiblesSet = __TS__New(Set)
+        for ____, collectibleType in ipairs(getCollectibleArray(nil)) do
+            if ____exports.collectibleHasCacheFlag(nil, collectibleType, cacheFlag) then
+                collectiblesSet:add(collectibleType)
+            end
+        end
+        CACHE_FLAG_TO_COLLECTIBLES_MAP:set(cacheFlag, collectiblesSet)
+    end
+end
+--- Returns a set containing every collectible type with the given cache flag, including modded
+-- collectibles.
+function ____exports.getCollectiblesForCacheFlag(self, cacheFlag)
+    if CACHE_FLAG_TO_COLLECTIBLES_MAP.size == 0 then
+        initCacheFlagMap(nil)
+    end
+    local collectiblesSet = CACHE_FLAG_TO_COLLECTIBLES_MAP:get(cacheFlag)
+    if collectiblesSet == nil then
+        return __TS__New(Set)
+    end
+    return copySet(nil, collectiblesSet)
+end
+--- Returns an array containing every collectible type that the player has that matches the provided
+-- CacheFlag.
+-- 
+-- For example, if the cache flag is `CacheFlag.FLYING`, and the player has one Lord of the Pit and
+-- two Dead Doves, then this function would return:
+-- 
+-- ```ts
+-- [
+--   CollectibleType.LORD_OF_THE_PIT,
+--   CollectibleType.DEAD_DOVE,
+--   CollectibleType.DEAD_DOVE,
+-- ]
+-- ```
+function ____exports.getPlayerCollectiblesForCacheFlag(self, player, cacheFlag)
+    local collectiblesForCacheFlag = ____exports.getCollectiblesForCacheFlag(nil, cacheFlag)
+    local playerCollectibles = {}
+    for ____, collectibleType in ipairs(getSortedSetValues(nil, collectiblesForCacheFlag)) do
+        local numCollectibles = player:GetCollectibleNum(collectibleType)
+        ____repeat(
+            nil,
+            numCollectibles,
+            function()
+                playerCollectibles[#playerCollectibles + 1] = collectibleType
+            end
+        )
+    end
+    return playerCollectibles
+end
+return ____exports

package/dist/functions/collectibleSet.d.ts

@@ -0,0 +1,45 @@
+import { CollectibleType } from "isaac-typescript-definitions";
+/**
+ * Returns an array containing every valid collectible type in the game, including modded
+ * collectibles.
+ *
+ * Use this if you need to iterate over the collectibles in order. If you need to do O(1) lookups,
+ * then use the `getCollectibleArray` helper function instead.
+ */
+export declare function getCollectibleArray(): readonly CollectibleType[];
+/**
+ * Returns a set containing every valid collectible type in the game, including modded collectibles.
+ *
+ * Use this if you need to do O(1) lookups. If you need to iterate over the collectibles in order,
+ * then use the `getCollectibleArray` helper function instead.
+ */
+export declare function getCollectibleSet(): ReadonlySet<CollectibleType>;
+/**
+ * Returns an array containing every modded collectible type in the game.
+ *
+ * Use this if you need to iterate over the collectibles in order. If you need to do O(1) lookups,
+ * then use the `getModdedCollectibleSet` helper function instead.
+ */
+export declare function getModdedCollectibleArray(): readonly CollectibleType[];
+/**
+ * Returns a set containing every modded collectible type in the game.
+ *
+ * Use this if you need to do O(1) lookups. If you need to iterate over the collectibles in order,
+ * then use the `getModdedCollectibleArray` helper function instead.
+ */
+export declare function getModdedCollectibleSet(): ReadonlySet<CollectibleType>;
+/**
+ * Returns an array containing every valid vanilla collectible type in the game.
+ *
+ * Use this if you need to iterate over the collectibles in order. If you need to do O(1) lookups,
+ * then use the `getVanillaCollectibleSet` helper function instead.
+ */
+export declare function getVanillaCollectibleArray(): readonly CollectibleType[];
+/**
+ * Returns a set containing every valid vanilla collectible type in the game.
+ *
+ * Use this if you need to do O(1) lookups. If you need to iterate over the collectibles in order,
+ * then use the `getVanillaCollectibleArray` helper function instead.
+ */
+export declare function getVanillaCollectibleSet(): ReadonlySet<CollectibleType>;
+//# sourceMappingURL=collectibleSet.d.ts.map

package/dist/functions/collectibleSet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"collectibleSet.d.ts","sourceRoot":"","sources":["../../../../../packages/isaacscript-common/src/functions/collectibleSet.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAuD/D;;;;;;GAMG;AACH,wBAAgB,mBAAmB,IAAI,SAAS,eAAe,EAAE,CAKhE;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,IAAI,WAAW,CAAC,eAAe,CAAC,CAKhE;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,IAAI,SAAS,eAAe,EAAE,CAKtE;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,IAAI,WAAW,CAAC,eAAe,CAAC,CAKtE;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,IAAI,SAAS,eAAe,EAAE,CAKvE;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,IAAI,WAAW,CAAC,eAAe,CAAC,CAKvE"}