isaacscript-common 2.2.0 → 2.3.0

package/functions/charge.d.ts

@@ -1,54 +0,0 @@
-import { ActiveSlot } from "isaac-typescript-definitions";
-/**
- * Helper function to add a charge to a 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 player The player to grant the charges to.
- * @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 addRoomClearCharge(player: EntityPlayer, ignoreBigRoomDoubleCharge?: 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 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 addRoomClearChargeToSlot(player: EntityPlayer, activeSlot: ActiveSlot, ignoreBigRoomDoubleCharge?: 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;

package/functions/charge.lua

@@ -1,123 +0,0 @@
-local ____exports = {}
-local getNumChargesToAdd, getNumChargesWithAAAModifier, shouldPlayFullRechargeSound
-local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
-local ActiveSlot = ____isaac_2Dtypescript_2Ddefinitions.ActiveSlot
-local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
-local RoomShape = ____isaac_2Dtypescript_2Ddefinitions.RoomShape
-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
-function ____exports.addRoomClearChargeToSlot(self, player, activeSlot, ignoreBigRoomDoubleCharge)
-    if ignoreBigRoomDoubleCharge == nil then
-        ignoreBigRoomDoubleCharge = false
-    end
-    if not player:NeedsCharge(activeSlot) then
-        return
-    end
-    local hud = game:GetHUD()
-    local totalCharge = ____exports.getTotalCharge(nil, player, activeSlot)
-    local chargesToAdd = getNumChargesToAdd(nil, player, activeSlot, ignoreBigRoomDoubleCharge)
-    local modifiedChargesToAdd = getNumChargesWithAAAModifier(nil, player, activeSlot, chargesToAdd)
-    local newCharge = totalCharge + modifiedChargesToAdd
-    player:SetActiveCharge(newCharge, activeSlot)
-    hud:FlashChargeBar(player, activeSlot)
-    ____exports.playChargeSoundEffect(nil, player, activeSlot)
-end
-function getNumChargesToAdd(self, player, activeSlot, ignoreBigRoomDoubleCharge)
-    if ignoreBigRoomDoubleCharge == nil then
-        ignoreBigRoomDoubleCharge = false
-    end
-    local room = game:GetRoom()
-    local roomShape = room:GetRoomShape()
-    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
-    if roomShape >= RoomShape.SHAPE_2x2 and not ignoreBigRoomDoubleCharge then
-        return 2
-    end
-    return 1
-end
-function getNumChargesWithAAAModifier(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 maxCharges + 1
-    end
-    if hasBattery and batteryCharge + chargesToAdd == maxCharges - 1 then
-        return maxCharges + 1
-    end
-    return chargesToAdd
-end
-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 not player:NeedsCharge(activeSlot)
-    end
-    return not player:NeedsCharge(activeSlot) or activeCharge == maxCharges and batteryCharge == 0
-end
-function ____exports.addRoomClearCharge(self, player, ignoreBigRoomDoubleCharge)
-    if ignoreBigRoomDoubleCharge == nil then
-        ignoreBigRoomDoubleCharge = false
-    end
-    for ____, activeSlot in ipairs({ActiveSlot.PRIMARY, ActiveSlot.SECONDARY, ActiveSlot.POCKET}) do
-        ____exports.addRoomClearChargeToSlot(nil, player, activeSlot, ignoreBigRoomDoubleCharge)
-    end
-end
-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/functions/chargeBar.d.ts

@@ -1,12 +0,0 @@
-/// <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;

package/functions/chargeBar.lua

@@ -1,43 +0,0 @@
-local ____exports = {}
-local getChargeBarClamp
-local ____constants = require("constants")
-local VectorZero = ____constants.VectorZero
-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"
-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
-function ____exports.renderChargeBar(self, sprites, position, normalCharges, batteryCharges)
-    sprites.back:Render(position, VectorZero, VectorZero)
-    local normalChargesClamp = getChargeBarClamp(nil, normalCharges, sprites.maxCharges)
-    sprites.meter:Render(position, normalChargesClamp, VectorZero)
-    local batteryChargesClamp = getChargeBarClamp(nil, batteryCharges, sprites.maxCharges)
-    sprites.meterBattery:Render(position, batteryChargesClamp, VectorZero)
-    sprites.lines:Render(position, VectorZero, VectorZero)
-end
-return ____exports

package/functions/collectibleCacheFlag.d.ts

@@ -1,23 +0,0 @@
-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[];

package/functions/collectibleCacheFlag.lua

@@ -1,65 +0,0 @@
-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 ____collectibles = require("functions.collectibles")
-local getCollectibleTypeRange = ____collectibles.getCollectibleTypeRange
-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(getCollectibleTypeRange(nil)) do
-            if ____exports.collectibleHasCacheFlag(nil, collectibleType, cacheFlag) then
-                collectiblesSet:add(collectibleType)
-            end
-        end
-        CACHE_FLAG_TO_COLLECTIBLES_MAP:set(cacheFlag, collectiblesSet)
-    end
-end
-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
-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/functions/collectibleSet.d.ts

@@ -1,9 +0,0 @@
-import { CollectibleType } from "isaac-typescript-definitions";
-/**
- * Returns a set containing every valid collectible type in the game, including modded collectibles.
- */
-export declare function getCollectibleSet(): Set<CollectibleType>;
-/** Returns a set containing every modded collectible type in the game. */
-export declare function getModdedCollectibleSet(): Set<CollectibleType>;
-/** Returns a set containing every valid vanilla collectible type in the game. */
-export declare function getVanillaCollectibleSet(): Set<CollectibleType>;

package/functions/collectibleSet.lua

@@ -1,51 +0,0 @@
-local ____lualib = require("lualib_bundle")
-local Set = ____lualib.Set
-local __TS__New = ____lualib.__TS__New
-local ____exports = {}
-local ____cachedClasses = require("cachedClasses")
-local itemConfig = ____cachedClasses.itemConfig
-local ____constantsFirstLast = require("constantsFirstLast")
-local LAST_VANILLA_COLLECTIBLE_TYPE = ____constantsFirstLast.LAST_VANILLA_COLLECTIBLE_TYPE
-local ____collectibles = require("functions.collectibles")
-local getCollectibleTypeRange = ____collectibles.getCollectibleTypeRange
-local ____set = require("functions.set")
-local copySet = ____set.copySet
-local ALL_COLLECTIBLES_SET = __TS__New(Set)
-local VANILLA_COLLECTIBLES_SET = __TS__New(Set)
-local MODDED_COLLECTIBLES_SET = __TS__New(Set)
-local function initCollectibleSets(self)
-    for ____, collectibleType in ipairs(getCollectibleTypeRange(nil)) do
-        do
-            local itemConfigItem = itemConfig:GetCollectible(collectibleType)
-            if itemConfigItem == nil then
-                goto __continue3
-            end
-            ALL_COLLECTIBLES_SET:add(collectibleType)
-            if collectibleType <= LAST_VANILLA_COLLECTIBLE_TYPE then
-                VANILLA_COLLECTIBLES_SET:add(collectibleType)
-            else
-                MODDED_COLLECTIBLES_SET:add(collectibleType)
-            end
-        end
-        ::__continue3::
-    end
-end
-function ____exports.getCollectibleSet(self)
-    if ALL_COLLECTIBLES_SET.size == 0 then
-        initCollectibleSets(nil)
-    end
-    return copySet(nil, ALL_COLLECTIBLES_SET)
-end
-function ____exports.getModdedCollectibleSet(self)
-    if ALL_COLLECTIBLES_SET.size == 0 then
-        initCollectibleSets(nil)
-    end
-    return copySet(nil, MODDED_COLLECTIBLES_SET)
-end
-function ____exports.getVanillaCollectibleSet(self)
-    if ALL_COLLECTIBLES_SET.size == 0 then
-        initCollectibleSets(nil)
-    end
-    return copySet(nil, VANILLA_COLLECTIBLES_SET)
-end
-return ____exports

package/functions/collectibleTag.d.ts

@@ -1,16 +0,0 @@
-import { CollectibleType, ItemConfigTag } from "isaac-typescript-definitions";
-export declare function collectibleHasTag(collectibleType: CollectibleType, tag: ItemConfigTag): boolean;
-/**
- * Helper function to get all of the collectible types in the game that have a certain tag.
- *
- * For example, to get all of the collectible types that count as offensive for the purposes of
- * Tainted Lost:
- *
- * ```ts
- * const offensiveCollectibleTypes = getCollectibleTypesWithTag(ItemConfigTag.OFFENSIVE);
- * ```
- */
-export declare function getCollectibleTypesWithTag(itemConfigTag: ItemConfigTag): Set<CollectibleType>;
-/** Returns the number of items that a player has towards a particular transformation. */
-export declare function getPlayerNumCollectiblesWithTag(player: EntityPlayer, itemConfigTag: ItemConfigTag): int;
-export declare function isQuestCollectible(collectibleType: CollectibleType): boolean;

package/functions/collectibleTag.lua

@@ -1,74 +0,0 @@
-local ____lualib = require("lualib_bundle")
-local Map = ____lualib.Map
-local __TS__New = ____lualib.__TS__New
-local Set = ____lualib.Set
-local __TS__Spread = ____lualib.__TS__Spread
-local ____exports = {}
-local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
-local ItemConfigTag = ____isaac_2Dtypescript_2Ddefinitions.ItemConfigTag
-local ____cachedClasses = require("cachedClasses")
-local itemConfig = ____cachedClasses.itemConfig
-local ____collectibles = require("functions.collectibles")
-local getCollectibleTypeRange = ____collectibles.getCollectibleTypeRange
-local ____enums = require("functions.enums")
-local getEnumValues = ____enums.getEnumValues
-local ____flag = require("functions.flag")
-local getFlagName = ____flag.getFlagName
-local ____player = require("functions.player")
-local getPlayerCollectibleCount = ____player.getPlayerCollectibleCount
-local ____set = require("functions.set")
-local copySet = ____set.copySet
-function ____exports.collectibleHasTag(self, collectibleType, tag)
-    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
-    if itemConfigItem == nil then
-        return false
-    end
-    return itemConfigItem:HasTags(tag)
-end
-local TAG_TO_COLLECTIBLE_TYPES_MAP = __TS__New(Map)
-local function initTagMap(self)
-    for ____, itemConfigTag in ipairs(getEnumValues(nil, ItemConfigTag)) do
-        TAG_TO_COLLECTIBLE_TYPES_MAP:set(
-            itemConfigTag,
-            __TS__New(Set)
-        )
-    end
-    for ____, collectibleType in ipairs(getCollectibleTypeRange(nil)) do
-        for ____, itemConfigTag in ipairs(getEnumValues(nil, ItemConfigTag)) do
-            do
-                if not ____exports.collectibleHasTag(nil, collectibleType, itemConfigTag) then
-                    goto __continue6
-                end
-                local collectibleTypesSet = TAG_TO_COLLECTIBLE_TYPES_MAP:get(itemConfigTag)
-                if collectibleTypesSet == nil then
-                    local flagName = getFlagName(nil, itemConfigTag, ItemConfigTag)
-                    error("Failed to get the collectible types for item tag: " .. tostring(flagName))
-                end
-                collectibleTypesSet:add(collectibleType)
-            end
-            ::__continue6::
-        end
-    end
-end
-function ____exports.getCollectibleTypesWithTag(self, itemConfigTag)
-    if TAG_TO_COLLECTIBLE_TYPES_MAP.size == 0 then
-        initTagMap(nil)
-    end
-    local collectibleTypes = TAG_TO_COLLECTIBLE_TYPES_MAP:get(itemConfigTag)
-    if collectibleTypes == nil then
-        error(("The item config tag of " .. tostring(itemConfigTag)) .. " is not a valid value of the ItemConfigTag enum.")
-    end
-    return copySet(nil, collectibleTypes)
-end
-function ____exports.getPlayerNumCollectiblesWithTag(self, player, itemConfigTag)
-    local collectibleTypesSet = ____exports.getCollectibleTypesWithTag(nil, itemConfigTag)
-    return getPlayerCollectibleCount(
-        nil,
-        player,
-        __TS__Spread(collectibleTypesSet:values())
-    )
-end
-function ____exports.isQuestCollectible(self, collectibleType)
-    return ____exports.collectibleHasTag(nil, collectibleType, ItemConfigTag.QUEST)
-end
-return ____exports