isaacscript-common 9.19.0 → 9.19.3

package/dist/src/functions/collectibles.lua

@@ -0,0 +1,465 @@
+local ____exports = {}
+local initQuestionMarkSprite
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local CollectibleSpriteLayer = ____isaac_2Dtypescript_2Ddefinitions.CollectibleSpriteLayer
+local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
+local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
+local ItemConfigChargeType = ____isaac_2Dtypescript_2Ddefinitions.ItemConfigChargeType
+local ItemConfigTagZero = ____isaac_2Dtypescript_2Ddefinitions.ItemConfigTagZero
+local ItemType = ____isaac_2Dtypescript_2Ddefinitions.ItemType
+local PickupPrice = ____isaac_2Dtypescript_2Ddefinitions.PickupPrice
+local PickupVariant = ____isaac_2Dtypescript_2Ddefinitions.PickupVariant
+local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
+local ____cachedClasses = require("src.core.cachedClasses")
+local game = ____cachedClasses.game
+local itemConfig = ____cachedClasses.itemConfig
+local ____constants = require("src.core.constants")
+local BLIND_ITEM_PNG_PATH = ____constants.BLIND_ITEM_PNG_PATH
+local DEFAULT_ITEM_POOL_TYPE = ____constants.DEFAULT_ITEM_POOL_TYPE
+local ____constantsFirstLast = require("src.core.constantsFirstLast")
+local FIRST_COLLECTIBLE_TYPE = ____constantsFirstLast.FIRST_COLLECTIBLE_TYPE
+local LAST_VANILLA_COLLECTIBLE_TYPE = ____constantsFirstLast.LAST_VANILLA_COLLECTIBLE_TYPE
+local ____collectibleDescriptionMap = require("src.maps.collectibleDescriptionMap")
+local COLLECTIBLE_DESCRIPTION_MAP = ____collectibleDescriptionMap.COLLECTIBLE_DESCRIPTION_MAP
+local DEFAULT_COLLECTIBLE_DESCRIPTION = ____collectibleDescriptionMap.DEFAULT_COLLECTIBLE_DESCRIPTION
+local ____collectibleTypeToNameMap = require("src.maps.collectibleTypeToNameMap")
+local COLLECTIBLE_TYPE_TO_NAME_MAP = ____collectibleTypeToNameMap.COLLECTIBLE_TYPE_TO_NAME_MAP
+local DEFAULT_COLLECTIBLE_NAME = ____collectibleTypeToNameMap.DEFAULT_COLLECTIBLE_NAME
+local ____singleUseActiveCollectibleTypesSet = require("src.sets.singleUseActiveCollectibleTypesSet")
+local SINGLE_USE_ACTIVE_COLLECTIBLE_TYPES_SET = ____singleUseActiveCollectibleTypesSet.SINGLE_USE_ACTIVE_COLLECTIBLE_TYPES_SET
+local ____entities = require("src.functions.entities")
+local getEntityID = ____entities.getEntityID
+local ____pickupVariants = require("src.functions.pickupVariants")
+local isCollectible = ____pickupVariants.isCollectible
+local ____roomData = require("src.functions.roomData")
+local getRoomListIndex = ____roomData.getRoomListIndex
+local ____sprites = require("src.functions.sprites")
+local clearSprite = ____sprites.clearSprite
+local spriteEquals = ____sprites.spriteEquals
+local ____utils = require("src.functions.utils")
+local irange = ____utils.irange
+function initQuestionMarkSprite(self)
+    local sprite = Sprite()
+    sprite:Load("gfx/005.100_collectible.anm2", false)
+    sprite:ReplaceSpritesheet(1, "gfx/items/collectibles/questionmark.png")
+    sprite:LoadGraphics()
+    return sprite
+end
+function ____exports.clearCollectibleSprite(self, collectible)
+    ____exports.setCollectibleSprite(nil, collectible, nil)
+end
+function ____exports.isVanillaCollectibleType(self, collectibleType)
+    return collectibleType <= LAST_VANILLA_COLLECTIBLE_TYPE
+end
+--- Helper function to remove the collectible from a collectible pedestal and make it appear as if a
+-- player has already taken the item. This is accomplished by changing the sub-type to
+-- `CollectibleType.NULL` and then setting the sprite to an empty/missing PNG file.
+-- 
+-- For more information, see the documentation for the "clearSprite" helper function.
+function ____exports.setCollectibleEmpty(self, collectible)
+    if not isCollectible(nil, collectible) then
+        local entityID = getEntityID(nil, collectible)
+        error("The \"setCollectibleEmpty\" function was given a non-collectible: " .. entityID)
+    end
+    collectible.SubType = CollectibleType.NULL
+    ____exports.clearCollectibleSprite(nil, collectible)
+end
+--- Helper function to change the sprite of a collectible pedestal entity.
+-- 
+-- For more information about removing the collectible sprite, see the documentation for the
+-- "clearSprite" helper function.
+-- 
+-- @param collectible The collectible whose sprite you want to modify.
+-- @param pngPath Equal to either the spritesheet path to load (e.g.
+-- "gfx/items/collectibles/collectibles_001_thesadonion.png") or undefined. If
+-- undefined, the sprite will be removed, making it appear like the collectible has
+-- already been taken by the player.
+function ____exports.setCollectibleSprite(self, collectible, pngPath)
+    if not isCollectible(nil, collectible) then
+        local entityID = getEntityID(nil, collectible)
+        error("The \"setCollectibleSprite\" function was given a non-collectible: " .. entityID)
+    end
+    local sprite = collectible:GetSprite()
+    if pngPath == nil then
+        clearSprite(nil, sprite, CollectibleSpriteLayer.HEAD, CollectibleSpriteLayer.ITEM_SHADOW)
+    else
+        sprite:ReplaceSpritesheet(CollectibleSpriteLayer.HEAD, pngPath)
+        sprite:LoadGraphics()
+    end
+end
+--- Helper function to change the collectible on a pedestal. Simply updating the `SubType` field is
+-- not sufficient because the sprite will not change.
+function ____exports.setCollectibleSubType(self, collectible, newCollectibleType)
+    if not isCollectible(nil, collectible) then
+        local entityID = getEntityID(nil, collectible)
+        error("The \"setCollectibleSubType\" function was given a non-collectible: " .. entityID)
+    end
+    if newCollectibleType == CollectibleType.NULL then
+        ____exports.setCollectibleEmpty(nil, collectible)
+        return
+    end
+    collectible:Morph(
+        EntityType.PICKUP,
+        PickupVariant.COLLECTIBLE,
+        newCollectibleType,
+        true,
+        true,
+        true
+    )
+end
+local COLLECTIBLE_ANM2_PATH = "gfx/005.100_collectible.anm2"
+local GLITCHED_ITEM_THRESHOLD = 4000000000
+local questionMarkSprite = initQuestionMarkSprite(nil)
+--- Helper function to check if two collectible sprites have the same sprite sheet loaded.
+function ____exports.collectibleSpriteEquals(self, sprite1, sprite2)
+    local xStart = -1
+    local xFinish = 1
+    local xIncrement = 1
+    local yStart = -40
+    local yFinish = 10
+    local yIncrement = 3
+    return spriteEquals(
+        nil,
+        sprite1,
+        sprite2,
+        CollectibleSpriteLayer.HEAD,
+        xStart,
+        xFinish,
+        xIncrement,
+        yStart,
+        yFinish,
+        yIncrement
+    )
+end
+--- Helper function to get the charge type that a collectible has. Returns
+-- `ItemConfigChargeType.NORMAL` if the provided collectible type was not valid.
+function ____exports.getCollectibleChargeType(self, collectibleType)
+    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
+    if itemConfigItem == nil then
+        return ItemConfigChargeType.NORMAL
+    end
+    return itemConfigItem.ChargeType
+end
+--- Helper function to get the in-game description for a collectible. Returns "Unknown" if the
+-- provided collectible type was not valid.
+function ____exports.getCollectibleDescription(self, collectibleType)
+    local collectibleDescription = COLLECTIBLE_DESCRIPTION_MAP:get(collectibleType)
+    if collectibleDescription ~= nil then
+        return collectibleDescription
+    end
+    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
+    if itemConfigItem ~= nil then
+        return itemConfigItem.Description
+    end
+    return DEFAULT_COLLECTIBLE_DESCRIPTION
+end
+--- Helper function to get the coin cost that a collectible item would be if it were being offered in
+-- a Devil Room deal. Returns 0 if passed `CollectibleType.NULL`.
+function ____exports.getCollectibleDevilCoinPrice(self, collectibleType)
+    if collectibleType == CollectibleType.NULL then
+        return 0
+    end
+    local defaultCollectiblePrice = 15
+    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
+    if itemConfigItem == nil then
+        return defaultCollectiblePrice
+    end
+    return itemConfigItem.DevilPrice * defaultCollectiblePrice
+end
+--- Helper function to get the heart cost that a collectible item would be if it were being offered
+-- in a Devil Room deal. Returns 0 if passed `CollectibleType.NULL`.
+function ____exports.getCollectibleDevilHeartPrice(self, collectibleType, player)
+    local maxHearts = player:GetMaxHearts()
+    if collectibleType == CollectibleType.NULL then
+        return 0
+    end
+    if maxHearts == 0 then
+        return PickupPrice.THREE_SOUL_HEARTS
+    end
+    local defaultCollectiblePrice = PickupPrice.ONE_HEART
+    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
+    if itemConfigItem == nil then
+        return defaultCollectiblePrice
+    end
+    local twoHeartPrice = maxHearts == 2 and PickupPrice.ONE_HEART_AND_TWO_SOUL_HEARTS or PickupPrice.TWO_HEARTS
+    return itemConfigItem.DevilPrice == 2 and twoHeartPrice or PickupPrice.ONE_HEART
+end
+--- Helper function to get the path to a collectible PNG file. Returns the path to the question mark
+-- sprite (i.e. from Curse of the Blind) if the provided collectible type was not valid.
+-- 
+-- Note that this does not return the file name, but the full path to the collectible's PNG file.
+-- The function is named "GfxFilename" to correspond to the associated `ItemConfigItem.GfxFileName`
+-- field.
+function ____exports.getCollectibleGfxFilename(self, collectibleType)
+    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
+    if itemConfigItem == nil then
+        return BLIND_ITEM_PNG_PATH
+    end
+    return itemConfigItem.GfxFileName
+end
+--- Mods may have to keep track of data relating to a collectible. Finding an index for these kinds
+-- of data structures is difficult, since collectibles are respawned every time a player re-enters a
+-- room (like all other pickups), so the `PtrHash` will change.
+-- 
+-- Use this function to get a unique index for a collectible to use in these data structures.
+-- 
+-- If your mod is upgraded, then you should use the `getPickupIndex` function instead, as it is more
+-- general purpose and less prone to error (but relies on stateful tracking of pickups as the run
+-- progresses).
+-- 
+-- Collectibles are a special case of pickups: they cannot be pushed around. (They actually can be
+-- pushed, but usually will stay on the same grid index.) Thus, it is possible to generate a
+-- somewhat reliable non-stateful index for collectibles. We use a 4-tuple of the room list index,
+-- the grid index of the collectible in the room, the collectible's `SubType`, and the collectible's
+-- `InitSeed`.
+-- 
+-- Collectibles that are shifted by Tainted Isaac's mechanic will have unique collectible indexes
+-- because the `SubType` is different. (The collectible entities share the same `InitSeed` and
+-- `PtrHash`.)
+-- 
+-- Collectibles that are rolled (with e.g. a D6) will have unique collectible indexes because the
+-- `SubType` and `InitSeed` are different. If you want to track collectibles independently of any
+-- rerolls, then you can use the `PtrHash` as an index instead. (The `PtrHash` will not persist
+-- between rooms, however.)
+-- 
+-- Note that:
+-- - The grid index is a necessary part of the collectible index because Diplopia and Crooked Penny
+--   can cause two or more collectibles with the same `SubType` and `InitSeed` to exist in the same
+--   room.
+-- - This index will fail in the case where the player uses Diplopia or a successful Crooked Penny
+--   seven or more times in the same room, since that will cause two or more collectibles with the
+--   same grid index, `SubType`, and `InitSeed` to exist. (More than seven is required in non-1x1
+--   rooms.)
+-- - The `SubType` is a necessary part of the collectible index because Tainted Isaac will
+--   continuously cause collectibles to morph into new sub-types with the same `InitSeed`.
+-- - Using a collectible's position as part of the index is problematic, since players can push a
+--   pedestal. (Even using the grid index does not solve this problem, since it is possible in
+--   certain cases for collectibles to be spawned at a position that is not aligned with the grid,
+--   and the pedestal pushed to an adjacent tile, but this case should be extremely rare.)
+-- - Mega Chests spawn two collectibles on the exact same position. However, both of them will have
+--   a different `InitSeed`, so this is not a problem for this indexing scheme.
+-- - The indexing scheme used is different for collectibles that are inside of a Treasure Room or
+--   Boss Room, in order to handle the case of the player seeing the same collectible again in a
+--   post-Ascent Treasure Room or Boss Room. A 5-tuple of stage, stage type, grid index, `SubType`,
+--   and `InitSeed` is used in this case. (Using the room list index or the room grid index is not
+--   suitable for this purpose, since both of these values can change in the post-Ascent rooms.)
+--   Even though Treasure Rooms and Boss Rooms are grouped together in this scheme, there probably
+--   will not be collectibles with the same grid index, SubType, and InitSeed.
+function ____exports.getCollectibleIndex(self, collectible)
+    if not isCollectible(nil, collectible) then
+        local entityID = getEntityID(nil, collectible)
+        error("The \"getCollectibleIndex\" function was given a non-collectible: " .. entityID)
+    end
+    local level = game:GetLevel()
+    local stage = level:GetStage()
+    local stageType = level:GetStageType()
+    local room = game:GetRoom()
+    local roomType = room:GetType()
+    local gridIndex = room:GetGridIndex(collectible.Position)
+    local roomListIndex = getRoomListIndex(nil)
+    if roomType == RoomType.TREASURE or roomType == RoomType.BOSS then
+        return (((((((tostring(stage) .. ",") .. tostring(stageType)) .. ",") .. tostring(gridIndex)) .. ",") .. tostring(collectible.SubType)) .. ",") .. tostring(collectible.InitSeed)
+    end
+    return (((((tostring(roomListIndex) .. ",") .. tostring(gridIndex)) .. ",") .. tostring(collectible.SubType)) .. ",") .. tostring(collectible.InitSeed)
+end
+--- Helper function to get the initial amount of charges that a collectible has. Returns 0 if the
+-- provided collectible type was not valid.
+function ____exports.getCollectibleInitCharge(self, collectibleType)
+    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
+    if itemConfigItem == nil then
+        return 0
+    end
+    return itemConfigItem.InitCharge
+end
+--- Helper function to get the `ItemType` of a collectible. Returns `ItemType.ITEM_NULL` if the
+-- provided collectible type was not valid.
+function ____exports.getCollectibleItemType(self, collectibleType)
+    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
+    if itemConfigItem == nil then
+        return ItemType.NULL
+    end
+    return itemConfigItem.Type
+end
+--- Helper function to get the maximum amount of charges that a collectible has. Returns 0 if the
+-- provided collectible type was not valid.
+function ____exports.getCollectibleMaxCharges(self, collectibleType)
+    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
+    if itemConfigItem == nil then
+        return 0
+    end
+    return itemConfigItem.MaxCharges
+end
+--- Helper function to get the name of a collectible. Returns "Unknown" if the provided collectible
+-- type is not valid.
+-- 
+-- For example, `getCollectibleName(CollectibleType.SAD_ONION)` would return "Sad Onion".
+function ____exports.getCollectibleName(self, collectibleType)
+    local collectibleName = COLLECTIBLE_TYPE_TO_NAME_MAP:get(collectibleType)
+    if collectibleName ~= nil then
+        return collectibleName
+    end
+    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
+    if itemConfigItem ~= nil then
+        return itemConfigItem.Name
+    end
+    return DEFAULT_COLLECTIBLE_NAME
+end
+--- Helper function to get the "pedestal type" of a collectible. For example, it might be sitting on
+-- top of a broken Blood Donation Machine, or it might be sitting on top of an opened Spiked Chest.
+function ____exports.getCollectiblePedestalType(self, collectible)
+    if not isCollectible(nil, collectible) then
+        local entityID = getEntityID(nil, collectible)
+        error("The \"getCollectiblePedestalType\" function was given a non-collectible: " .. entityID)
+    end
+    local sprite = collectible:GetSprite()
+    return sprite:GetOverlayFrame()
+end
+--- Helper function to get a collectible's quality. For example, Mom's Knife has a quality of 4.
+-- Returns 0 if the provided collectible type was not valid.
+function ____exports.getCollectibleQuality(self, collectibleType)
+    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
+    if itemConfigItem == nil then
+        return 0
+    end
+    return itemConfigItem.Quality
+end
+--- Helper function to get the tags of a collectible (which is the composition of zero or more
+-- `ItemConfigTag`). Returns 0 if the provided collectible type is not valid.
+-- 
+-- For example:
+-- 
+-- ```ts
+-- const collectibleType = CollectibleType.SAD_ONION;
+-- const itemConfigTags = getCollectibleTags(collectibleType); // itemConfigTags is "18350080"
+-- ```
+function ____exports.getCollectibleTags(self, collectibleType)
+    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
+    return itemConfigItem == nil and ItemConfigTagZero or itemConfigItem.Tags
+end
+--- Helper function to get an array that represents the range from the first collectible type to the
+-- last vanilla collectible type. This will include integers that do not represent any valid
+-- collectible types.
+-- 
+-- This function is only useful when building collectible type objects. For most purposes, you
+-- should use the `getVanillaCollectibleArray` or `getVanillaCollectibleSet` helper functions
+-- instead.
+function ____exports.getVanillaCollectibleTypeRange(self)
+    return irange(nil, FIRST_COLLECTIBLE_TYPE, LAST_VANILLA_COLLECTIBLE_TYPE)
+end
+--- Returns true if the item type in the item config is equal to `ItemType.ITEM_ACTIVE`.
+function ____exports.isActiveCollectible(self, collectibleType)
+    local itemType = ____exports.getCollectibleItemType(nil, collectibleType)
+    return itemType == ItemType.ACTIVE
+end
+--- Returns true if the collectible has a red question mark sprite.
+function ____exports.isBlindCollectible(self, collectible)
+    if not isCollectible(nil, collectible) then
+        local entityID = getEntityID(nil, collectible)
+        error("The \"isBlindCollectible\" function was given a non-collectible: " .. entityID)
+    end
+    local sprite = collectible:GetSprite()
+    local animation = sprite:GetAnimation()
+    local frame = sprite:GetFrame()
+    questionMarkSprite:SetFrame(animation, frame)
+    return ____exports.collectibleSpriteEquals(nil, sprite, questionMarkSprite)
+end
+--- Returns whether or not the given collectible is a "glitched" item. All items are replaced by
+-- glitched items once a player has TMTRAINER. However, glitched items can also "naturally" appear
+-- in secret rooms and I AM ERROR rooms if the "Corrupted Data" achievement is unlocked.
+function ____exports.isGlitchedCollectible(self, pickup)
+    return pickup.Variant == PickupVariant.COLLECTIBLE and pickup.SubType > GLITCHED_ITEM_THRESHOLD
+end
+--- Returns true if the collectible has the "Hidden" attribute in the item config.
+-- 
+-- Hidden collectibles will not show up in any pools and Eden will not start with them.
+function ____exports.isHiddenCollectible(self, collectibleType)
+    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
+    return itemConfigItem ~= nil and itemConfigItem.Hidden
+end
+function ____exports.isModdedCollectibleType(self, collectibleType)
+    return not ____exports.isVanillaCollectibleType(nil, 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, collectibleType)
+    local itemType = ____exports.getCollectibleItemType(nil, collectibleType)
+    return itemType == ItemType.PASSIVE or itemType == ItemType.FAMILIAR
+end
+--- Helper function to determine if a particular collectible will disappear from the player's
+-- inventory upon use. Note that this will not work will modded items, as there is no way to
+-- dynamically know if a modded item will disappear.
+function ____exports.isSingleUseCollectible(self, collectibleType)
+    return SINGLE_USE_ACTIVE_COLLECTIBLE_TYPES_SET:has(collectibleType)
+end
+function ____exports.isValidCollectibleType(self, collectibleType)
+    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
+    return itemConfigItem ~= nil
+end
+--- Helper function to generate a new sprite based on a collectible. If the provided collectible type
+-- is invalid, a sprite with a Curse of the Blind question mark will be returned.
+function ____exports.newCollectibleSprite(self, collectibleType)
+    local sprite = Sprite()
+    sprite:Load(COLLECTIBLE_ANM2_PATH, false)
+    clearSprite(nil, sprite)
+    local gfxFileName = ____exports.getCollectibleGfxFilename(nil, collectibleType)
+    sprite:ReplaceSpritesheet(CollectibleSpriteLayer.HEAD, gfxFileName)
+    sprite:LoadGraphics()
+    return sprite
+end
+--- Helper function to put a message in the log.txt file to let the Rebirth Item Tracker know that it
+-- should remove an item.
+-- 
+-- The "item tracker" in this function does not refer to the in-game item tracker, but rather to the
+-- Python program located at: https://github.com/Rchardon/RebirthItemTracker
+-- 
+-- This function is useful when you need to add a "fake" collectible to a player. Note that calling
+-- this function is not necessary when removing items from players. For example, when you remove a
+-- collectible with the `EntityPlayer.RemoveCollectible` method, a proper message is sent to the log
+-- the item tracker will automatically remove it.
+function ____exports.removeCollectibleFromItemTracker(self, collectibleType)
+    local collectibleName = ____exports.getCollectibleName(nil, collectibleType)
+    Isaac.DebugString(((("Removing collectible " .. tostring(collectibleType)) .. " (") .. collectibleName) .. ") on player 0 (Player)")
+end
+--- Helper function to remove all pickup delay on a collectible. By default, collectibles have a 20
+-- frame delay before they can be picked up by a player.
+function ____exports.removeCollectiblePickupDelay(self, collectible)
+    if not isCollectible(nil, collectible) then
+        local entityID = getEntityID(nil, collectible)
+        error("The \"removeCollectiblePickupDelay\" function was given a non-collectible: " .. entityID)
+    end
+    collectible.Wait = 0
+end
+--- Helper function to set a collectible sprite to a question mark (i.e. how collectibles look when
+-- the player has Curse of the Blind).
+function ____exports.setCollectibleBlind(self, collectible)
+    if not isCollectible(nil, collectible) then
+        local entityID = getEntityID(nil, collectible)
+        error("The \"setCollectibleBlind\" function was given a non-collectible: " .. entityID)
+    end
+    ____exports.setCollectibleSprite(nil, collectible, BLIND_ITEM_PNG_PATH)
+end
+--- Helper function to change a collectible into a "glitched" item (like the ones that appear when
+-- the player has TMTRAINER).
+function ____exports.setCollectibleGlitched(self, collectible)
+    if not isCollectible(nil, collectible) then
+        local entityID = getEntityID(nil, collectible)
+        error("The \"setCollectibleGlitched\" function was given a non-collectible: " .. entityID)
+    end
+    local player = Isaac.GetPlayer()
+    local hasTMTRAINER = player:HasCollectible(CollectibleType.TMTRAINER)
+    if not hasTMTRAINER then
+        player:AddCollectible(CollectibleType.TMTRAINER, 0, false)
+    end
+    local itemPool = game:GetItemPool()
+    local collectibleType = itemPool:GetCollectible(DEFAULT_ITEM_POOL_TYPE)
+    ____exports.setCollectibleSubType(nil, collectible, collectibleType)
+    if not hasTMTRAINER then
+        player:RemoveCollectible(CollectibleType.TMTRAINER)
+    end
+end
+--- Helper function to put a message in the log.txt file to let the Rebirth Item Tracker know that
+-- the build has been rerolled.
+function ____exports.setCollectiblesRerolledForItemTracker(self)
+    Isaac.DebugString("Added 3 Collectibles")
+end
+return ____exports

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

@@ -0,0 +1 @@
+{"version":3,"file":"color.d.ts","sourceRoot":"","sources":["../../../src/functions/color.ts"],"names":[],"mappings":";;;;AAOA,oBAAY,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IACtD,QAAQ,CAAC,sBAAsB,EAAE,MAAM,CAAC;CACzC,CAAC;AAKF,wBAAgB,WAAW,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,GAAG,OAAO,CAEjE;AAED,yDAAyD;AACzD,wBAAgB,SAAS,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK,CAgB7C;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,eAAe,GAAG,KAAK,CA8B9D;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAC5B,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,KAAK,SAAI,GACR,KAAK,CAQP;AAED,+EAA+E;AAC/E,wBAAgB,OAAO,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,KAAK,CAExD;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,eAAe,CAM5E;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,KAAK,GAAG,eAAe,CAW5D"}

package/dist/src/functions/color.lua

@@ -0,0 +1,124 @@
+local ____exports = {}
+local OBJECT_NAME
+local ____SerializationBrand = require("src.enums.private.SerializationBrand")
+local SerializationBrand = ____SerializationBrand.SerializationBrand
+local ____isaacAPIClass = require("src.functions.isaacAPIClass")
+local isaacAPIClassEquals = ____isaacAPIClass.isaacAPIClassEquals
+local isIsaacAPIClassOfType = ____isaacAPIClass.isIsaacAPIClassOfType
+local ____random = require("src.functions.random")
+local getRandom = ____random.getRandom
+local ____rng = require("src.functions.rng")
+local getRandomSeed = ____rng.getRandomSeed
+local isRNG = ____rng.isRNG
+local newRNG = ____rng.newRNG
+local ____table = require("src.functions.table")
+local copyValuesToTable = ____table.copyValuesToTable
+local getNumbersFromTable = ____table.getNumbersFromTable
+local tableHasKeys = ____table.tableHasKeys
+local ____types = require("src.functions.types")
+local isTable = ____types.isTable
+--- Helper function to check if something is an instantiated `Color` object.
+function ____exports.isColor(self, object)
+    return isIsaacAPIClassOfType(nil, object, OBJECT_NAME)
+end
+OBJECT_NAME = "Color"
+local KEYS = {
+    "R",
+    "G",
+    "B",
+    "A",
+    "RO",
+    "GO",
+    "BO"
+}
+function ____exports.colorEquals(self, color1, color2)
+    return isaacAPIClassEquals(nil, color1, color2, KEYS)
+end
+--- Helper function to copy a `Color` Isaac API class.
+function ____exports.copyColor(self, color)
+    if not ____exports.isColor(nil, color) then
+        error(((("Failed to copy a " .. OBJECT_NAME) .. " object since the provided object was not a userdata ") .. OBJECT_NAME) .. " class.")
+    end
+    return Color(
+        color.R,
+        color.G,
+        color.B,
+        color.A,
+        color.RO,
+        color.GO,
+        color.BO
+    )
+end
+--- Helper function to convert a `SerializedColor` object to a normal `Color` object. (This is used
+-- by the save data manager when reading data from the "save#.dat" file.)
+function ____exports.deserializeColor(self, color)
+    if not isTable(nil, color) then
+        error(("Failed to deserialize a " .. OBJECT_NAME) .. " object since the provided object was not a Lua table.")
+    end
+    local r, g, b, a, ro, go, bo = table.unpack(getNumbersFromTable(
+        nil,
+        color,
+        OBJECT_NAME,
+        table.unpack(KEYS)
+    ))
+    if r == nil then
+        error(("Failed to deserialize a " .. OBJECT_NAME) .. " object since the provided object did not have a value for: R")
+    end
+    if g == nil then
+        error(("Failed to deserialize a " .. OBJECT_NAME) .. " object since the provided object did not have a value for: G")
+    end
+    if b == nil then
+        error(("Failed to deserialize a " .. OBJECT_NAME) .. " object since the provided object did not have a value for: B")
+    end
+    return Color(
+        r,
+        g,
+        b,
+        a,
+        ro,
+        go,
+        bo
+    )
+end
+--- Helper function to get a random color.
+-- 
+-- @param seedOrRNG Optional. The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
+-- `RNG.Next` method will be called. Default is `getRandomSeed()`.
+-- @param alpha Optional. The alpha value to use. Default is 1.
+function ____exports.getRandomColor(self, seedOrRNG, alpha)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
+    end
+    if alpha == nil then
+        alpha = 1
+    end
+    local rng = isRNG(nil, seedOrRNG) and seedOrRNG or newRNG(nil, seedOrRNG)
+    local r = getRandom(nil, rng)
+    local g = getRandom(nil, rng)
+    local b = getRandom(nil, rng)
+    return Color(r, g, b, alpha)
+end
+--- Used to determine is the given table is a serialized `Color` object created by the save data
+-- manager and/or the `deepCopy` function.
+function ____exports.isSerializedColor(self, object)
+    if not isTable(nil, object) then
+        return false
+    end
+    return tableHasKeys(
+        nil,
+        object,
+        table.unpack(KEYS)
+    ) and object[SerializationBrand.COLOR] ~= nil
+end
+--- Helper function to convert a `Color` object to a `SerializedColor` object. (This is used by the
+-- save data manager when writing data from the "save#.dat" file.)
+function ____exports.serializeColor(self, color)
+    if not ____exports.isColor(nil, color) then
+        error(((("Failed to serialize a " .. OBJECT_NAME) .. " object since the provided object was not a userdata ") .. OBJECT_NAME) .. " class.")
+    end
+    local colorTable = {}
+    copyValuesToTable(nil, color, KEYS, colorTable)
+    colorTable[SerializationBrand.COLOR] = ""
+    return colorTable
+end
+return ____exports

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

@@ -0,0 +1 @@
+{"version":3,"file":"curses.d.ts","sourceRoot":"","sources":["../../../src/functions/curses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAI1D;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,CAWzD;AAED,wBAAgB,QAAQ,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAInD"}

package/dist/src/functions/curses.lua

@@ -0,0 +1,24 @@
+local ____exports = {}
+local ____cachedClasses = require("src.core.cachedClasses")
+local game = ____cachedClasses.game
+local ____flag = require("src.functions.flag")
+local hasFlag = ____flag.hasFlag
+--- Helper function to get the actual bit flag for modded curses.
+-- 
+-- Will throw a runtime error if the provided curse does not exist.
+-- 
+-- Use this over the `Isaac.GetCurseIdByName` method because that will return an integer instead of
+-- a bit flag.
+function ____exports.getCurseIDByName(self, name)
+    local curseID = Isaac.GetCurseIdByName(name)
+    if curseID == -1 then
+        error(("Failed to get the curse ID corresponding to the curse name of \"" .. tostring(curseID)) .. "\". Does this name match what you put in the \"content/curses.xml\" file?")
+    end
+    return 1 << curseID - 1
+end
+function ____exports.hasCurse(self, curse)
+    local level = game:GetLevel()
+    local curses = level:GetCurses()
+    return hasFlag(nil, curses, curse)
+end
+return ____exports