isaacscript-common 2.0.34 → 2.3.0

package/functions/collectibles.lua

@@ -1,281 +0,0 @@
-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 ____constantsMax = require("constantsMax")
-local FIRST_COLLECTIBLE_TYPE = ____constantsMax.FIRST_COLLECTIBLE_TYPE
-local FIRST_MODDED_COLLECTIBLE_TYPE = ____constantsMax.FIRST_MODDED_COLLECTIBLE_TYPE
-local LAST_COLLECTIBLE_TYPE = ____constantsMax.LAST_COLLECTIBLE_TYPE
-local LAST_VANILLA_COLLECTIBLE_TYPE = ____constantsMax.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.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
-COLLECTIBLE_SPRITE_LAYER = 1
-COLLECTIBLE_SHADOW_LAYER = 4
-local GLITCHED_ITEM_THRESHOLD = 4000000000
-local questionMarkSprite = initQuestionMarkSprite(nil)
-function ____exports.clearCollectibleSprite(self, collectible)
-    ____exports.setCollectibleSprite(nil, collectible, nil)
-end
-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
-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
-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 defaultPickupPrice = PickupPrice.ONE_HEART
-    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
-    if itemConfigItem == nil then
-        return defaultPickupPrice
-    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
-function ____exports.getCollectibleGfxFilename(self, collectibleType)
-    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
-    if itemConfigItem == nil then
-        return BLIND_ITEM_PNG_PATH
-    end
-    return itemConfigItem.GfxFileName
-end
-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 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
-function ____exports.getCollectibleInitCharge(self, collectibleType)
-    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
-    if itemConfigItem == nil then
-        return 0
-    end
-    return itemConfigItem.InitCharge
-end
-function ____exports.getCollectibleItemType(self, collectibleType)
-    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
-    if itemConfigItem == nil then
-        return ItemType.NULL
-    end
-    return itemConfigItem.Type
-end
-function ____exports.getCollectibleMaxCharges(self, collectibleType)
-    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
-    if itemConfigItem == nil then
-        return 0
-    end
-    return itemConfigItem.MaxCharges
-end
-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
-function ____exports.getCollectibleQuality(self, collectibleType)
-    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
-    if itemConfigItem == nil then
-        return 0
-    end
-    return itemConfigItem.Quality
-end
-function ____exports.getCollectibleTags(self, collectibleType)
-    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
-    return itemConfigItem == nil and ItemConfigTagZero or itemConfigItem.Tags
-end
-function ____exports.getCollectibleTypeRange(self)
-    return irange(nil, FIRST_COLLECTIBLE_TYPE, LAST_COLLECTIBLE_TYPE)
-end
-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
-function ____exports.getVanillaCollectibleTypeRange(self)
-    return irange(nil, FIRST_COLLECTIBLE_TYPE, LAST_VANILLA_COLLECTIBLE_TYPE)
-end
-function ____exports.isActiveCollectible(self, collectibleType)
-    local itemType = ____exports.getCollectibleItemType(nil, collectibleType)
-    return itemType == ItemType.ACTIVE
-end
-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
-function ____exports.isGlitchedCollectible(self, pickup)
-    return pickup.Variant == PickupVariant.COLLECTIBLE and pickup.SubType > GLITCHED_ITEM_THRESHOLD
-end
-function ____exports.isHiddenCollectible(self, collectibleType)
-    local itemConfigItem = itemConfig:GetCollectible(collectibleType)
-    return itemConfigItem ~= nil and itemConfigItem.Hidden
-end
-function ____exports.isPassiveCollectible(self, collectibleType)
-    local itemType = ____exports.getCollectibleItemType(nil, collectibleType)
-    return itemType == ItemType.PASSIVE or itemType == ItemType.FAMILIAR
-end
-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
-function ____exports.removeCollectibleFromItemTracker(self, collectibleType)
-    local collectibleName = ____exports.getCollectibleName(nil, collectibleType)
-    Isaac.DebugString(((("Removing collectible " .. tostring(collectibleType)) .. " (") .. collectibleName) .. ") on player 0 (Player)")
-end
-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
-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
-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
-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
-function ____exports.setCollectiblesRerolledForItemTracker(self)
-    Isaac.DebugString("Added 3 Collectibles")
-end
-return ____exports

package/functions/color.d.ts

@@ -1,31 +0,0 @@
-/// <reference types="isaac-typescript-definitions" />
-/// <reference types="typescript-to-lua/language-extensions" />
-import { SerializationType } from "../enums/SerializationType";
-declare type SerializedColor = LuaTable<string, unknown> & {
-    __serializedColorBrand: unknown;
-};
-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];
-/** Returns `Color(1, 1, 1)`. */
-export declare function getDefaultColor(): Color;
-/** 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 {};

package/functions/color.lua

@@ -1,122 +0,0 @@
-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 ____utils = require("functions.utils")
-local ensureAllCases = ____utils.ensureAllCases
-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
-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
-                local colorType = type(color)
-                if ____exports.isColor(nil, color) or colorType ~= "table" 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
-        do
-            do
-                return ensureAllCases(nil, serializationType)
-            end
-        end
-    until true
-end
-function ____exports.getDefaultColor(self)
-    return Color(1, 1, 1)
-end
-function ____exports.isSerializedColor(self, object)
-    local objectType = type(object)
-    if objectType ~= "table" then
-        return false
-    end
-    local ____table = object
-    return tableHasKeys(
-        nil,
-        ____table,
-        table.unpack(KEYS)
-    ) and ____table[SerializationBrand.COLOR] ~= nil
-end
-return ____exports

package/functions/debug.d.ts

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

package/functions/debug.lua

@@ -1,31 +0,0 @@
-local ____exports = {}
-local ____log = require("functions.log")
-local log = ____log.log
-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
-function ____exports.isLuaDebugEnabled(self)
-    return package ~= nil
-end
-function ____exports.traceback(self)
-    local tracebackOutput = ____exports.getTraceback(nil)
-    log(tracebackOutput)
-end
-local function setDebugFunctionsGlobal(self)
-    if 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

package/functions/deepCopy.d.ts

@@ -1,29 +0,0 @@
-import { SerializationType } from "../enums/SerializationType";
-/**
- * `deepCopy` is a semi-generic deep cloner. It will recursively copy all of the values so that none
- * of the nested references remain.
- *
- * It supports the following object types:
- *
- * - Primitives (i.e. strings, numbers, and booleans)
- * - `LuaTable` / basic TSTL objects
- * - TSTL `Map`
- * - TSTL `Set`
- * - TSTL classes
- * - `DefaultMap`
- * - Isaac `Color` objects
- * - Isaac `KColor` objects
- * - Isaac `RNG` objects
- * - Isaac `Vector` objects
- *
- * It does not support:
- * - objects with values of `null` (since that transpiles to `nil`)
- * - other Isaac API objects such as `EntityPtr` (that have a type of "userdata")
- *
- * @param value The primitive or object to copy.
- * @param serializationType Has 3 possible values. Can leave objects as-is, or can serialize objects
- *                          to Lua tables, or can deserialize Lua tables to objects. Default is
- *                          `SerializationType.NONE`.
- * @param traversalDescription Used to track the current key that we are operating on.
- */
-export declare function deepCopy(value: unknown, serializationType?: SerializationType, traversalDescription?: string): unknown;