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

package/dist/functions/collectibles.lua

@@ -0,0 +1,436 @@
+local ____exports = {}
+local initQuestionMarkSprite, COLLECTIBLE_SPRITE_LAYER, COLLECTIBLE_SHADOW_LAYER
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
+local EntityType = ____isaac_2Dtypescript_2Ddefinitions.EntityType
+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("cachedClasses")
+local game = ____cachedClasses.game
+local itemConfig = ____cachedClasses.itemConfig
+local ____constants = require("constants")
+local BLIND_ITEM_PNG_PATH = ____constants.BLIND_ITEM_PNG_PATH
+local DEFAULT_ITEM_POOL_TYPE = ____constants.DEFAULT_ITEM_POOL_TYPE
+local ____constantsFirstLast = require("constantsFirstLast")
+local FIRST_COLLECTIBLE_TYPE = ____constantsFirstLast.FIRST_COLLECTIBLE_TYPE
+local FIRST_MODDED_COLLECTIBLE_TYPE = ____constantsFirstLast.FIRST_MODDED_COLLECTIBLE_TYPE
+local LAST_COLLECTIBLE_TYPE = ____constantsFirstLast.LAST_COLLECTIBLE_TYPE
+local LAST_VANILLA_COLLECTIBLE_TYPE = ____constantsFirstLast.LAST_VANILLA_COLLECTIBLE_TYPE
+local ____collectibleDescriptionMap = require("maps.collectibleDescriptionMap")
+local COLLECTIBLE_DESCRIPTION_MAP = ____collectibleDescriptionMap.COLLECTIBLE_DESCRIPTION_MAP
+local DEFAULT_COLLECTIBLE_DESCRIPTION = ____collectibleDescriptionMap.DEFAULT_COLLECTIBLE_DESCRIPTION
+local ____collectibleNameMap = require("maps.collectibleNameMap")
+local COLLECTIBLE_NAME_MAP = ____collectibleNameMap.COLLECTIBLE_NAME_MAP
+local DEFAULT_COLLECTIBLE_NAME = ____collectibleNameMap.DEFAULT_COLLECTIBLE_NAME
+local ____singleUseActiveCollectibleTypesSet = require("sets.singleUseActiveCollectibleTypesSet")
+local SINGLE_USE_ACTIVE_COLLECTIBLE_TYPES_SET = ____singleUseActiveCollectibleTypesSet.SINGLE_USE_ACTIVE_COLLECTIBLE_TYPES_SET
+local ____entity = require("functions.entity")
+local getEntityID = ____entity.getEntityID
+local ____pickupVariants = require("functions.pickupVariants")
+local isCollectible = ____pickupVariants.isCollectible
+local ____roomData = require("functions.roomData")
+local getRoomListIndex = ____roomData.getRoomListIndex
+local ____sprite = require("functions.sprite")
+local clearSprite = ____sprite.clearSprite
+local spriteEquals = ____sprite.spriteEquals
+local ____utils = require("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
+--- 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, COLLECTIBLE_SPRITE_LAYER, COLLECTIBLE_SHADOW_LAYER)
+    else
+        sprite:ReplaceSpritesheet(COLLECTIBLE_SPRITE_LAYER, pngPath)
+        sprite:LoadGraphics()
+    end
+end
+--- Helper function to change the collectible on a pedestal. Simply updating the `SubType` property
+-- 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
+COLLECTIBLE_SPRITE_LAYER = 1
+COLLECTIBLE_SHADOW_LAYER = 4
+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,
+        COLLECTIBLE_SPRITE_LAYER,
+        xStart,
+        xFinish,
+        xIncrement,
+        yStart,
+        yFinish,
+        yIncrement
+    )
+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's sprite. Returns the path to the question mark
+-- sprite (i.e. from Curse of the Blind) if the provided collectible type was not valid.
+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 often have to track variables 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, so the `PtrHash` will change. Instead, 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.)
+-- 
+-- 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.
+-- - 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
+--   different InitSeeds, 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:
+-- 
+-- ```ts
+-- const collectibleType = CollectibleType.SAD_ONION;
+-- const collectibleName = getCollectibleName(collectibleType); // collectibleName is "Sad Onion"
+-- ```
+function ____exports.getCollectibleName(self, collectibleType)
+    local collectibleName = COLLECTIBLE_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
+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 the path to a collectible's quality. 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 all modded collectible types.
+-- 
+-- This function is only useful when building collectible type objects. For most purposes, you
+-- should use the `getModdedCollectibleSet` helper function instead.
+-- 
+-- Returns an empty array if there are no modded collectible types.
+-- 
+-- (This function is named differently from the `getVanillaCollectibleTypeRange` function because
+-- all modded collectible types are contiguous. Thus, each value represents a real
+-- `CollectibleType`.)
+function ____exports.getModdedCollectibleTypes(self)
+    if LAST_VANILLA_COLLECTIBLE_TYPE == LAST_COLLECTIBLE_TYPE then
+        return {}
+    end
+    return irange(nil, FIRST_MODDED_COLLECTIBLE_TYPE, LAST_COLLECTIBLE_TYPE)
+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 `getVanillaCollectibleSet` helper function 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
+--- 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 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
+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/functions/color.d.ts

@@ -0,0 +1,30 @@
+/// <reference types="typescript-to-lua/language-extensions" />
+/// <reference types="isaac-typescript-definitions" />
+import { SerializationType } from "../enums/SerializationType";
+declare type SerializedColor = LuaTable<string, unknown> & {
+    readonly __serializedColorBrand: symbol;
+};
+interface CopyColorReturn {
+    [SerializationType.NONE]: Color;
+    [SerializationType.SERIALIZE]: SerializedColor;
+    [SerializationType.DESERIALIZE]: Color;
+}
+export declare function colorEquals(color1: Color, color2: Color): boolean;
+/**
+ * Helper function to copy a `Color` object.
+ *
+ * @param color The Color object to copy. In the case of deserialization, this will actually be a
+ *              Lua table instead of an instantiated Color class.
+ * @param serializationType Default is `SerializationType.NONE`.
+ */
+export declare function copyColor<C extends Color | SerializedColor, S extends SerializationType>(color: C, serializationType: S): CopyColorReturn[S];
+export declare function copyColor<C extends Color | SerializedColor>(color: C): CopyColorReturn[SerializationType.NONE];
+/** Helper function to check if something is an instantiated Color object. */
+export declare function isColor(object: unknown): object is Color;
+/**
+ * Used to determine is the given table is a serialized `Color` object created by the save data
+ * manager and/or the `deepCopy` function.
+ */
+export declare function isSerializedColor(object: unknown): object is SerializedColor;
+export {};
+//# sourceMappingURL=color.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"color.d.ts","sourceRoot":"","sources":["../../../../../packages/isaacscript-common/src/functions/color.ts"],"names":[],"mappings":";;AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAK/D,aAAK,eAAe,GAAG,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IACjD,QAAQ,CAAC,sBAAsB,EAAE,MAAM,CAAC;CACzC,CAAC;AAEF,UAAU,eAAe;IACvB,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC;IAChC,CAAC,iBAAiB,CAAC,SAAS,CAAC,EAAE,eAAe,CAAC;IAC/C,CAAC,iBAAiB,CAAC,WAAW,CAAC,EAAE,KAAK,CAAC;CACxC;AAKD,wBAAgB,WAAW,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,GAAG,OAAO,CAEjE;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,CACvB,CAAC,SAAS,KAAK,GAAG,eAAe,EACjC,CAAC,SAAS,iBAAiB,EAC3B,KAAK,EAAE,CAAC,EAAE,iBAAiB,EAAE,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC;AACtD,wBAAgB,SAAS,CAAC,CAAC,SAAS,KAAK,GAAG,eAAe,EACzD,KAAK,EAAE,CAAC,GACP,eAAe,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;AAuE3C,6EAA6E;AAC7E,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"}

package/dist/functions/color.lua

@@ -0,0 +1,119 @@
+local ____exports = {}
+local OBJECT_NAME
+local ____SerializationBrand = require("enums.private.SerializationBrand")
+local SerializationBrand = ____SerializationBrand.SerializationBrand
+local ____SerializationType = require("enums.SerializationType")
+local SerializationType = ____SerializationType.SerializationType
+local ____isaacAPIClass = require("functions.isaacAPIClass")
+local isaacAPIClassEquals = ____isaacAPIClass.isaacAPIClassEquals
+local isIsaacAPIClassOfType = ____isaacAPIClass.isIsaacAPIClassOfType
+local ____table = require("functions.table")
+local copyValuesToTable = ____table.copyValuesToTable
+local getNumbersFromTable = ____table.getNumbersFromTable
+local tableHasKeys = ____table.tableHasKeys
+local ____types = require("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
+local KEYS = {
+    "R",
+    "G",
+    "B",
+    "A",
+    "RO",
+    "GO",
+    "BO"
+}
+OBJECT_NAME = "Color"
+function ____exports.colorEquals(self, color1, color2)
+    return isaacAPIClassEquals(nil, color1, color2, KEYS)
+end
+--- Helper function to copy a `Color` object.
+-- 
+-- @param color The Color object to copy. In the case of deserialization, this will actually be a
+-- Lua table instead of an instantiated Color class.
+-- @param serializationType Default is `SerializationType.NONE`.
+function ____exports.copyColor(self, color, serializationType)
+    if serializationType == nil then
+        serializationType = SerializationType.NONE
+    end
+    repeat
+        local ____switch4 = serializationType
+        local ____cond4 = ____switch4 == SerializationType.NONE
+        if ____cond4 then
+            do
+                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
+        end
+        ____cond4 = ____cond4 or ____switch4 == SerializationType.SERIALIZE
+        if ____cond4 then
+            do
+                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
+        end
+        ____cond4 = ____cond4 or ____switch4 == SerializationType.DESERIALIZE
+        if ____cond4 then
+            do
+                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
+        end
+    until true
+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
+return ____exports

package/dist/functions/debug.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Helper function to get a stack trace.
+ *
+ * This will only work if the `--luadebug` launch option is enabled or the Racing+ sandbox is
+ * enabled.
+ */
+export declare function getTraceback(): string;
+/**
+ * Players can boot the game with an launch option called "--luadebug", which will enable additional
+ * functionality that is considered to be unsafe. For more information about this flag, see the
+ * wiki: https://bindingofisaacrebirth.fandom.com/wiki/Launch_Options
+ *
+ * When this flag is enabled, the global environment will be slightly different. The differences are
+ * documented here: https://wofsauge.github.io/IsaacDocs/rep/Globals.html
+ *
+ * This function uses the `package` global variable as a proxy to determine if the "--luadebug" flag
+ * is enabled or not.
+ */
+export declare function isLuaDebugEnabled(): boolean;
+/**
+ * Helper function to print a stack trace to the "log.txt" file, similar to JavaScript's
+ * `console.trace` function.
+ *
+ * This will only work if the `--luadebug` launch option is enabled or the Racing+ sandbox is
+ * enabled.
+ */
+export declare function traceback(): void;
+//# sourceMappingURL=debug.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"debug.d.ts","sourceRoot":"","sources":["../../../../../packages/isaacscript-common/src/functions/debug.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,wBAAgB,YAAY,IAAI,MAAM,CAYrC;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,iBAAiB,IAAI,OAAO,CAI3C;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,IAAI,IAAI,CAGhC"}

package/dist/functions/debug.lua

@@ -0,0 +1,49 @@
+local ____exports = {}
+local ____log = require("functions.log")
+local log = ____log.log
+--- Helper function to get a stack trace.
+-- 
+-- This will only work if the `--luadebug` launch option is enabled or the Racing+ sandbox is
+-- enabled.
+function ____exports.getTraceback(self)
+    if debug ~= nil then
+        return debug.traceback()
+    end
+    if sandboxGetTraceback ~= nil then
+        return sandboxGetTraceback()
+    end
+    return "stack traceback:\n(the \"--luadebug\" flag is not enabled)"
+end
+--- Players can boot the game with an launch option called "--luadebug", which will enable additional
+-- functionality that is considered to be unsafe. For more information about this flag, see the
+-- wiki: https://bindingofisaacrebirth.fandom.com/wiki/Launch_Options
+-- 
+-- When this flag is enabled, the global environment will be slightly different. The differences are
+-- documented here: https://wofsauge.github.io/IsaacDocs/rep/Globals.html
+-- 
+-- This function uses the `package` global variable as a proxy to determine if the "--luadebug" flag
+-- is enabled or not.
+function ____exports.isLuaDebugEnabled(self)
+    return _G.package ~= nil
+end
+--- Helper function to print a stack trace to the "log.txt" file, similar to JavaScript's
+-- `console.trace` function.
+-- 
+-- This will only work if the `--luadebug` launch option is enabled or the Racing+ sandbox is
+-- enabled.
+function ____exports.traceback(self)
+    local tracebackOutput = ____exports.getTraceback(nil)
+    log(tracebackOutput)
+end
+local function setDebugFunctionsGlobal(self)
+    if _G.debug == nil and sandboxGetTraceback == nil then
+        return
+    end
+    local globals = _G
+    globals.getTraceback = ____exports.getTraceback
+    globals.traceback = ____exports.traceback
+end
+if ____exports.isLuaDebugEnabled(nil) or sandboxGetTraceback ~= nil then
+    setDebugFunctionsGlobal(nil)
+end
+return ____exports