isaacscript-common 9.18.4 → 9.19.2

package/dist/src/functions/serialization.lua

@@ -0,0 +1,100 @@
+local ____lualib = require("lualib_bundle")
+local __TS__TypeOf = ____lualib.__TS__TypeOf
+local __TS__ObjectEntries = ____lualib.__TS__ObjectEntries
+local __TS__ObjectValues = ____lualib.__TS__ObjectValues
+local __TS__ArrayMap = ____lualib.__TS__ArrayMap
+local __TS__ArraySome = ____lualib.__TS__ArraySome
+local ____exports = {}
+local getSerializedTableType
+local ____isaacAPIClassTypeToBrand = require("src.objects.isaacAPIClassTypeToBrand")
+local ISAAC_API_CLASS_TYPE_TO_BRAND = ____isaacAPIClassTypeToBrand.ISAAC_API_CLASS_TYPE_TO_BRAND
+local ____isaacAPIClassTypeToFunctions = require("src.objects.isaacAPIClassTypeToFunctions")
+local ISAAC_API_CLASS_TYPE_TO_FUNCTIONS = ____isaacAPIClassTypeToFunctions.ISAAC_API_CLASS_TYPE_TO_FUNCTIONS
+local ____isaacAPIClass = require("src.functions.isaacAPIClass")
+local getIsaacAPIClassName = ____isaacAPIClass.getIsaacAPIClassName
+local ____types = require("src.functions.types")
+local isTable = ____types.isTable
+local isUserdata = ____types.isUserdata
+function getSerializedTableType(self, serializedIsaacAPIClass)
+    for ____, ____value in ipairs(__TS__ObjectEntries(ISAAC_API_CLASS_TYPE_TO_BRAND)) do
+        local copyableIsaacAPIClassType = ____value[1]
+        local serializationBrand = ____value[2]
+        if serializedIsaacAPIClass[serializationBrand] ~= nil then
+            return copyableIsaacAPIClassType
+        end
+    end
+    return nil
+end
+--- Helper function to generically copy an Isaac API class without knowing what specific type of
+-- class it is. (This is used by the save data manager.)
+-- 
+-- For the list of supported classes, see the `CopyableIsaacAPIClassType` enum.
+function ____exports.copyIsaacAPIClass(self, isaacAPIClass)
+    if not isUserdata(nil, isaacAPIClass) then
+        error("Failed to copy an Isaac API class since the provided object was of type: " .. __TS__TypeOf(isaacAPIClass))
+    end
+    local isaacAPIClassType = getIsaacAPIClassName(nil, isaacAPIClass)
+    if isaacAPIClassType == nil then
+        error("Failed to copy an Isaac API class since it does not have a class type.")
+    end
+    local copyableIsaacAPIClassType = isaacAPIClassType
+    local functions = ISAAC_API_CLASS_TYPE_TO_FUNCTIONS[copyableIsaacAPIClassType]
+    if functions == nil then
+        error("Failed to copy an Isaac API class since the associated functions were not found for Isaac API class type: " .. copyableIsaacAPIClassType)
+    end
+    return functions:copy(isaacAPIClass)
+end
+--- Helper function to generically deserialize an Isaac API class without knowing what specific type
+-- of class it is. (This is used by the save data manager when reading data from the "save#.dat"
+-- file.)
+-- 
+-- For the list of supported classes, see the `CopyableIsaacAPIClassType` enum.
+function ____exports.deserializeIsaacAPIClass(self, serializedIsaacAPIClass)
+    if not isTable(nil, serializedIsaacAPIClass) then
+        error("Failed to deserialize an Isaac API class since the provided object was of type: " .. __TS__TypeOf(serializedIsaacAPIClass))
+    end
+    local copyableIsaacAPIClassType = getSerializedTableType(nil, serializedIsaacAPIClass)
+    if copyableIsaacAPIClassType == nil then
+        error("Failed to deserialize an Isaac API class since a valid class type brand was not found.")
+    end
+    local functions = ISAAC_API_CLASS_TYPE_TO_FUNCTIONS[copyableIsaacAPIClassType]
+    if functions == nil then
+        error("Failed to deserialize an Isaac API class since the associated functions were not found for class type: " .. copyableIsaacAPIClassType)
+    end
+    return functions:deserialize(serializedIsaacAPIClass)
+end
+--- Helper function to generically check if a given Lua table is a serialized Isaac API class. (This
+-- is used by the save data manager when reading data from the "save#.dat" file.)
+-- 
+-- For the list of supported classes, see the `CopyableIsaacAPIClassType` enum.
+function ____exports.isSerializedIsaacAPIClass(self, object)
+    local allFunctions = __TS__ObjectValues(ISAAC_API_CLASS_TYPE_TO_FUNCTIONS)
+    local isSerializedFunctions = __TS__ArrayMap(
+        allFunctions,
+        function(____, functions) return functions.isSerialized end
+    )
+    return __TS__ArraySome(
+        isSerializedFunctions,
+        function(____, identityFunction) return identityFunction(nil, object) end
+    )
+end
+--- Helper function to generically serialize an Isaac API class without knowing what specific type of
+-- class it is. (This is used by the save data manager when writing data to the "save#.dat" file.)
+-- 
+-- For the list of supported classes, see the `CopyableIsaacAPIClassType` enum.
+function ____exports.serializeIsaacAPIClass(self, isaacAPIClass)
+    if not isUserdata(nil, isaacAPIClass) then
+        error("Failed to serialize an Isaac API class since the provided object was of type: " .. __TS__TypeOf(isaacAPIClass))
+    end
+    local isaacAPIClassType = getIsaacAPIClassName(nil, isaacAPIClass)
+    if isaacAPIClassType == nil then
+        error("Failed to serialize an Isaac API class since it does not have a class type.")
+    end
+    local copyableIsaacAPIClassType = isaacAPIClassType
+    local functions = ISAAC_API_CLASS_TYPE_TO_FUNCTIONS[copyableIsaacAPIClassType]
+    if functions == nil then
+        error("Failed to serialize an Isaac API class since the associated functions were not found for class type: " .. copyableIsaacAPIClassType)
+    end
+    return functions:serialize(isaacAPIClass)
+end
+return ____exports

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

@@ -0,0 +1 @@
+{"version":3,"file":"set.d.ts","sourceRoot":"","sources":["../../../src/functions/set.ts"],"names":[],"mappings":";;AAIA;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAC5B,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC,EACf,GAAG,SAAS,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,GAC3C,IAAI,CAMN;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAC3B,GAAG,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,GACtC,GAAG,CAAC,CAAC,CAAC,CASR;AAED,mGAAmG;AACnG,wBAAgB,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAOlE;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EACjC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC,EACf,GAAG,YAAY,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,GAC9C,IAAI,CAMN;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EACnC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,EAC5B,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,UAAU,GAAE,CAAC,EAAE,GAAG,SAAS,CAAC,EAAO,GAClC,CAAC,CAGH;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAClC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,EAC5B,iBAAiB,EAAE,OAAO,GACzB,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAK/B;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAkBvE;AAED,4DAA4D;AAC5D,wBAAgB,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM,CAGrE"}

package/dist/src/functions/set.lua

@@ -0,0 +1,125 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__Iterator = ____lualib.__TS__Iterator
+local __TS__New = ____lualib.__TS__New
+local __TS__ArrayMap = ____lualib.__TS__ArrayMap
+local __TS__Spread = ____lualib.__TS__Spread
+local __TS__ArraySort = ____lualib.__TS__ArraySort
+local ____exports = {}
+local ____array = require("src.functions.array")
+local getArrayCombinations = ____array.getArrayCombinations
+local getRandomArrayElement = ____array.getRandomArrayElement
+local sumArray = ____array.sumArray
+local ____rng = require("src.functions.rng")
+local getRandomSeed = ____rng.getRandomSeed
+local ____types = require("src.functions.types")
+local isPrimitive = ____types.isPrimitive
+--- Helper function to get a sorted array based on the contents of a set.
+-- 
+-- Normally, set values are returned in a random order, so use this function when the ordering of
+-- the contents is important.
+function ____exports.getSortedSetValues(self, set)
+    local values = set:values()
+    local array = {__TS__Spread(values)}
+    local firstElement = array[1]
+    if firstElement ~= nil then
+        local arrayType = type(firstElement)
+        if not isPrimitive(nil, arrayType) then
+            error(("Failed to get the sorted set values because the provided set was of type \"" .. tostring(arrayType)) .. "\". Having sets with non-primitive types doesn't make much sense in general, so you might need to rethink what you are doing.")
+        end
+    end
+    __TS__ArraySort(array)
+    return array
+end
+--- Helper function to add all of the values in one set to another set. The first set passed will be
+-- modified in place.
+-- 
+-- This function is variadic, meaning that you can specify N sets to add to the first set.
+function ____exports.addSetsToSet(self, mainSet, ...)
+    local setsToAdd = {...}
+    for ____, set in ipairs(setsToAdd) do
+        for ____, value in __TS__Iterator(set:values()) do
+            mainSet:add(value)
+        end
+    end
+end
+--- Helper function to create a new set that is the composition of two or more sets.
+-- 
+-- This function is variadic, meaning that you can specify N sets.
+function ____exports.combineSets(self, ...)
+    local sets = {...}
+    local newSet = __TS__New(Set)
+    for ____, set in ipairs(sets) do
+        for ____, value in __TS__Iterator(set:values()) do
+            newSet:add(value)
+        end
+    end
+    return newSet
+end
+--- Helper function to copy a set. (You can also use a Set constructor to accomplish this task.)
+function ____exports.copySet(self, oldSet)
+    local newSet = __TS__New(Set)
+    for ____, value in __TS__Iterator(oldSet:values()) do
+        newSet:add(value)
+    end
+    return newSet
+end
+--- Helper function to delete all of the values in one set from another set. The first set passed
+-- will be modified in place.
+-- 
+-- This function is variadic, meaning that you can specify N sets to remove from the first set.
+function ____exports.deleteSetsFromSet(self, mainSet, ...)
+    local setsToRemove = {...}
+    for ____, set in ipairs(setsToRemove) do
+        for ____, value in __TS__Iterator(set:values()) do
+            mainSet:delete(value)
+        end
+    end
+end
+--- Helper function to get a random element from the provided set.
+-- 
+-- @param set The set to get an element from.
+-- @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 exceptions Optional. An array of elements to skip over if selected.
+function ____exports.getRandomSetElement(self, set, seedOrRNG, exceptions)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
+    end
+    if exceptions == nil then
+        exceptions = {}
+    end
+    local array = ____exports.getSortedSetValues(nil, set)
+    return getRandomArrayElement(nil, array, seedOrRNG, exceptions)
+end
+--- Helper function to get all possible combinations of the given set. This includes the combination
+-- of an empty set.
+-- 
+-- For example, if this function is provided a set containing 1, 2, and 3, then it will return an
+-- array containing the following sets:
+-- 
+-- - [] (if `includeEmptyArray` is set to true)
+-- - [1]
+-- - [2]
+-- - [3]
+-- - [1, 2]
+-- - [1, 3]
+-- - [2, 3]
+-- - [1, 2, 3]
+-- 
+-- @param set The set to get the combinations of.
+-- @param includeEmptyArray Whether or not to include an empty array in the combinations.
+function ____exports.getSetCombinations(self, set, includeEmptyArray)
+    local values = ____exports.getSortedSetValues(nil, set)
+    local combinations = getArrayCombinations(nil, values, includeEmptyArray)
+    return __TS__ArrayMap(
+        combinations,
+        function(____, array) return __TS__New(Set, array) end
+    )
+end
+--- Helper function to sum every value in a set together.
+function ____exports.sumSet(self, set)
+    local values = {__TS__Spread(set:values())}
+    return sumArray(nil, values)
+end
+return ____exports

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

@@ -0,0 +1 @@
+{"version":3,"file":"sound.d.ts","sourceRoot":"","sources":["../../../src/functions/sound.ts"],"names":[],"mappings":"AAIA,wBAAgB,mBAAmB,IAAI,IAAI,CAI1C"}

package/dist/src/functions/sound.lua

@@ -0,0 +1,13 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local SoundEffect = ____isaac_2Dtypescript_2Ddefinitions.SoundEffect
+local ____cachedClasses = require("src.core.cachedClasses")
+local sfxManager = ____cachedClasses.sfxManager
+local ____enums = require("src.functions.enums")
+local getEnumValues = ____enums.getEnumValues
+function ____exports.stopAllSoundEffects(self)
+    for ____, soundEffect in ipairs(getEnumValues(nil, SoundEffect)) do
+        sfxManager:Stop(soundEffect)
+    end
+end
+return ____exports

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

@@ -0,0 +1 @@
+{"version":3,"file":"spawnCollectible.d.ts","sourceRoot":"","sources":["../../../src/functions/spawnCollectible.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EAGhB,MAAM,8BAA8B,CAAC;AAUtC;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,gBAAgB,CAC9B,eAAe,EAAE,eAAe,EAChC,QAAQ,EAAE,MAAM,EAChB,SAAS,GAAE,IAAI,GAAG,GAAqB,EACvC,OAAO,UAAQ,EACf,aAAa,UAAQ,EACrB,OAAO,CAAC,EAAE,MAAM,GACf,uBAAuB,CAqCzB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,qBAAqB,CACnC,QAAQ,EAAE,MAAM,EAChB,SAAS,GAAE,IAAI,GAAG,GAAqB,GACtC,YAAY,CAWd"}

package/dist/src/functions/spawnCollectible.lua

@@ -0,0 +1,94 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
+local PickupVariant = ____isaac_2Dtypescript_2Ddefinitions.PickupVariant
+local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
+local ____constants = require("src.core.constants")
+local VectorZero = ____constants.VectorZero
+local ____preventCollectibleRotation = require("src.features.preventCollectibleRotation")
+local preventCollectibleRotation = ____preventCollectibleRotation.preventCollectibleRotation
+local ____featuresInitialized = require("src.featuresInitialized")
+local areFeaturesInitialized = ____featuresInitialized.areFeaturesInitialized
+local ____collectibles = require("src.functions.collectibles")
+local setCollectibleEmpty = ____collectibles.setCollectibleEmpty
+local ____collectibleTag = require("src.functions.collectibleTag")
+local isQuestCollectible = ____collectibleTag.isQuestCollectible
+local ____entitiesSpecific = require("src.functions.entitiesSpecific")
+local spawnPickupWithSeed = ____entitiesSpecific.spawnPickupWithSeed
+local ____players = require("src.functions.players")
+local anyPlayerIs = ____players.anyPlayerIs
+local ____rng = require("src.functions.rng")
+local getRandomSeed = ____rng.getRandomSeed
+local isRNG = ____rng.isRNG
+--- Helper function to spawn a collectible. Use this instead of the `Game.Spawn` method because it
+-- handles the cases of Tainted Keeper collectibles costing coins and preventing quest items from
+-- being rotated by Tainted Isaac's rotation mechanic. (Rotation prevention will only occur in
+-- upgraded mods.)
+-- 
+-- @param collectibleType The collectible type to spawn.
+-- @param position The position to spawn the collectible at.
+-- @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 options Optional. Set to true to make the collectible a "There's Options" style
+-- collectible. Default is false.
+-- @param forceFreeItem Optional. Set to true to disable the logic that gives the item a price for
+-- Tainted Keeper. Default is false.
+-- @param spawner Optional.
+function ____exports.spawnCollectible(self, collectibleType, position, seedOrRNG, options, forceFreeItem, spawner)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
+    end
+    if options == nil then
+        options = false
+    end
+    if forceFreeItem == nil then
+        forceFreeItem = false
+    end
+    local seed = isRNG(nil, seedOrRNG) and seedOrRNG:Next() or seedOrRNG
+    local collectible = spawnPickupWithSeed(
+        nil,
+        PickupVariant.COLLECTIBLE,
+        collectibleType,
+        position,
+        seed,
+        VectorZero,
+        spawner
+    )
+    if options then
+        collectible.OptionsPickupIndex = 1
+    end
+    if anyPlayerIs(nil, PlayerType.KEEPER_B) and not isQuestCollectible(nil, collectibleType) and not forceFreeItem then
+        collectible.ShopItemId = -1
+        collectible.Price = 15
+    end
+    if isQuestCollectible(nil, collectibleType) and areFeaturesInitialized(nil) then
+        preventCollectibleRotation(nil, collectible, collectibleType)
+    end
+    return collectible
+end
+--- Helper function to spawn an empty collectible. Doing this is tricky since spawning a collectible
+-- with `CollectibleType.NULL` will result in spawning a collectible with a random type from the
+-- current room's item pool.
+-- 
+-- Instead, this function arbitrarily spawns a collectible with `CollectibleType.SAD_ONION`, and
+-- then converts it to an empty pedestal afterward.
+-- 
+-- @param position The position to spawn the empty collectible at.
+-- @param seedOrRNG The `Seed` or `RNG` object to use. If an `RNG` object is provided, the
+-- `RNG.Next` method will be called. Default is `getRandomSeed()`.
+function ____exports.spawnEmptyCollectible(self, position, seedOrRNG)
+    if seedOrRNG == nil then
+        seedOrRNG = getRandomSeed(nil)
+    end
+    local collectible = ____exports.spawnCollectible(
+        nil,
+        CollectibleType.SAD_ONION,
+        position,
+        seedOrRNG,
+        false,
+        true
+    )
+    setCollectibleEmpty(nil, collectible)
+    return collectible
+end
+return ____exports

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

@@ -0,0 +1 @@
+{"version":3,"file":"sprites.d.ts","sourceRoot":"","sources":["../../../src/functions/sprites.ts"],"names":[],"mappings":";;;AAIA;;;;;;;;;;;GAWG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,QAAQ,EAAE,GAAG,EAAE,GAAG,IAAI,CAWpE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,MAAM,EACd,SAAS,CAAC,EAAE,MAAM,GACjB,GAAG,CAmBL;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAC1B,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,GAAG,EACZ,MAAM,EAAE,GAAG,EACX,OAAO,EAAE,GAAG,EACZ,UAAU,EAAE,GAAG,EACf,MAAM,EAAE,GAAG,EACX,OAAO,EAAE,GAAG,EACZ,UAAU,EAAE,GAAG,GACd,OAAO,CAaT;AAED,uFAAuF;AACvF,wBAAgB,WAAW,CACzB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,GAAG,GACX,OAAO,CAIT"}

package/dist/src/functions/sprites.lua

@@ -0,0 +1,89 @@
+local ____exports = {}
+local ____constants = require("src.core.constants")
+local EMPTY_PNG_PATH = ____constants.EMPTY_PNG_PATH
+local VectorZero = ____constants.VectorZero
+local ____kColor = require("src.functions.kColor")
+local kColorEquals = ____kColor.kColorEquals
+local ____utils = require("src.functions.utils")
+local erange = ____utils.erange
+--- Helper function to check if two texels on a sprite are equivalent to each other.
+function ____exports.texelEquals(self, sprite1, sprite2, position, layerID)
+    local kColor1 = sprite1:GetTexel(position, VectorZero, 1, layerID)
+    local kColor2 = sprite2:GetTexel(position, VectorZero, 1, layerID)
+    return kColorEquals(nil, kColor1, kColor2)
+end
+--- Helper function to clear all layers or specific layers from a sprite.
+-- 
+-- This function is variadic, so pass as many layer IDs as you want to clear. If no specific layers
+-- are passed, it will clear every layer.
+-- 
+-- Since there is no official API method to "clear" a sprite, we can work around it by setting the
+-- spritesheet to a non-existent or completely transparent file. If the path to the spritesheet does
+-- not exist, then this function might cause spurious errors to appear in the "log.txt file". To
+-- silence these errors, create a transparent 1 pixel PNG file in your mod's resources folder at the
+-- path corresponding to the "EMPTY_PNG_PATH" constant.
+function ____exports.clearSprite(self, sprite, ...)
+    local layerIDs = {...}
+    if #layerIDs == 0 then
+        local numLayers = sprite:GetLayerCount()
+        layerIDs = erange(nil, numLayers)
+    end
+    for ____, layerID in ipairs(layerIDs) do
+        sprite:ReplaceSpritesheet(layerID, EMPTY_PNG_PATH)
+    end
+    sprite:LoadGraphics()
+end
+--- Helper function that returns the number of the final frame in a particular animation for a
+-- sprite. By default, it will use the currently playing animation, but you can also specify a
+-- specific animation to check.
+-- 
+-- Note that this function is bugged with the Stop Watch or the Broken Watch, since using the
+-- `Sprite.SetFrame` method will reset the internal accumulator used to slow down the playback speed
+-- of the animation. (The `PlaybackSpeed` field of the sprite is not used.) Thus, it is only safe to
+-- use this function on animations that are not slowed down by Stop Watch or Broken Watch, such as
+-- player animations.
+function ____exports.getLastFrameOfAnimation(self, sprite, animation)
+    local currentAnimation = sprite:GetAnimation()
+    local currentFrame = sprite:GetFrame()
+    if animation ~= nil and animation ~= currentAnimation then
+        sprite:SetAnimation(animation)
+    end
+    sprite:SetLastFrame()
+    local finalFrame = sprite:GetFrame()
+    if animation ~= nil and animation ~= currentAnimation then
+        sprite:Play(currentAnimation, true)
+    end
+    sprite:SetFrame(currentFrame)
+    return finalFrame
+end
+--- Helper function to check if two sprite layers have the same sprite sheet by using the
+-- `Sprite.GetTexel` method.
+-- 
+-- Since checking every single texel in the entire sprite is very expensive, this function requires
+-- that you provide a range of specific texels to check.
+function ____exports.spriteEquals(self, sprite1, sprite2, layerID, xStart, xFinish, xIncrement, yStart, yFinish, yIncrement)
+    do
+        local x = xStart
+        while x <= xFinish do
+            do
+                local y = yStart
+                while y <= yFinish do
+                    local position = Vector(x, y)
+                    if not ____exports.texelEquals(
+                        nil,
+                        sprite1,
+                        sprite2,
+                        position,
+                        layerID
+                    ) then
+                        return false
+                    end
+                    y = y + yIncrement
+                end
+            end
+            x = x + xIncrement
+        end
+    end
+    return true
+end
+return ____exports

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

@@ -0,0 +1 @@
+{"version":3,"file":"stage.d.ts","sourceRoot":"","sources":["../../../src/functions/stage.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,UAAU,EACV,QAAQ,EACR,SAAS,EACV,MAAM,8BAA8B,CAAC;AAOtC;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CA6B/D;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CAmBzE;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,IAAI,GAAG,CASvC;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,GAAG,MAAM,CAG3E;AAED,6CAA6C;AAC7C,wBAAgB,QAAQ,IAAI,UAAU,CAIrC;AAED,iDAAiD;AACjD,wBAAgB,YAAY,IAAI,SAAS,CAIxC;AAED,8FAA8F;AAC9F,wBAAgB,SAAS,CAAC,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,GAAG,IAAI,CAIvE;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAI/D;AAED,wBAAgB,QAAQ,IAAI,OAAO,CAElC;AAED,wBAAgB,WAAW,IAAI,OAAO,CASrC;AAED,wBAAgB,OAAO,IAAI,OAAO,CASjC;AAED,wBAAgB,UAAU,IAAI,OAAO,CAQpC;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAUtC;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAKtC;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,IAAI,OAAO,CAK3C;AAED,wBAAgB,OAAO,IAAI,OAAO,CAQjC;AAED;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,UAAU,EACjB,SAAS,EAAE,SAAS,EACpB,MAAM,UAAQ,GACb,IAAI,CAUN;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,CAE9D"}

package/dist/src/functions/stage.lua

@@ -0,0 +1,165 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local GameStateFlag = ____isaac_2Dtypescript_2Ddefinitions.GameStateFlag
+local LevelStage = ____isaac_2Dtypescript_2Ddefinitions.LevelStage
+local StageType = ____isaac_2Dtypescript_2Ddefinitions.StageType
+local ____cachedClasses = require("src.core.cachedClasses")
+local game = ____cachedClasses.game
+local ____roomTypeGotoPrefixes = require("src.objects.roomTypeGotoPrefixes")
+local ROOM_TYPE_GOTO_PREFIXES = ____roomTypeGotoPrefixes.ROOM_TYPE_GOTO_PREFIXES
+local ____stageTypeSuffixes = require("src.objects.stageTypeSuffixes")
+local STAGE_TYPE_SUFFIXES = ____stageTypeSuffixes.STAGE_TYPE_SUFFIXES
+local ____stageTypeToLetter = require("src.objects.stageTypeToLetter")
+local STAGE_TYPE_TO_LETTER = ____stageTypeToLetter.STAGE_TYPE_TO_LETTER
+local ____types = require("src.functions.types")
+local asLevelStage = ____types.asLevelStage
+local asNumber = ____types.asNumber
+--- Helper function to check if the provided stage type is equal to `StageType.REPENTANCE` or
+-- `StageType.REPENTANCE_B`.
+function ____exports.isRepentanceStage(self, stageType)
+    return stageType == StageType.REPENTANCE or stageType == StageType.REPENTANCE_B
+end
+--- Helper function to check if the current stage type is equal to `StageType.REPENTANCE` or
+-- `StageType.REPENTANCE_B`.
+function ____exports.onRepentanceStage(self)
+    local level = game:GetLevel()
+    local stageType = level:GetStageType()
+    return ____exports.isRepentanceStage(nil, stageType)
+end
+--- Helper function to convert a numerical `StageType` into the letter suffix supplied to the "stage"
+-- console command. For example, `StageType.REPENTANCE` is the stage type for Downpour, and the
+-- console command to go to Downpour is "stage 1c", so this function converts `StageType.REPENTANCE`
+-- to "c".
+function ____exports.stageTypeToLetter(self, stageType)
+    return STAGE_TYPE_TO_LETTER[stageType]
+end
+--- Helper function that calculates what the stage type should be for the provided stage. This
+-- emulates what the game's internal code does.
+function ____exports.calculateStageType(self, stage)
+    local seeds = game:GetSeeds()
+    local stageSeed = seeds:GetStageSeed(stage)
+    if stageSeed % 2 == 0 then
+        return StageType.WRATH_OF_THE_LAMB
+    end
+    if stageSeed % 3 == 0 then
+        return StageType.AFTERBIRTH
+    end
+    return StageType.ORIGINAL
+end
+--- Helper function that calculates what the Repentance stage type should be for the provided stage.
+-- This emulates what the game's internal code does.
+function ____exports.calculateStageTypeRepentance(self, stage)
+    if stage == LevelStage.WOMB_1 or stage == LevelStage.WOMB_2 then
+        return StageType.REPENTANCE
+    end
+    local seeds = game:GetSeeds()
+    local adjustedStage = asLevelStage(
+        nil,
+        asNumber(nil, stage) + 1
+    )
+    local stageSeed = seeds:GetStageSeed(adjustedStage)
+    local halfStageSeed = math.floor(stageSeed / 2)
+    if halfStageSeed % 2 == 0 then
+        return StageType.REPENTANCE_B
+    end
+    return StageType.REPENTANCE
+end
+--- Helper function to account for Repentance floors being offset by 1. For example, Downpour 2 is
+-- the third level of the run, but the game considers it to have a stage of 2. This function will
+-- consider Downpour 2 to have a stage of 3.
+function ____exports.getEffectiveStage(self)
+    local level = game:GetLevel()
+    local stage = level:GetStage()
+    if ____exports.onRepentanceStage(nil) then
+        return asNumber(nil, stage) + 1
+    end
+    return stage
+end
+--- Helper function to get the corresponding "goto" console command that would correspond to the
+-- provided room type and room variant.
+function ____exports.getGotoCommand(self, roomType, roomVariant)
+    local prefix = ROOM_TYPE_GOTO_PREFIXES[roomType]
+    return (("goto " .. prefix) .. ".") .. tostring(roomVariant)
+end
+--- Alias for the `Level.GetStage` method.
+function ____exports.getStage(self)
+    local level = game:GetLevel()
+    return level:GetStage()
+end
+--- Alias for the `Level.GetStageType` method.
+function ____exports.getStageType(self)
+    local level = game:GetLevel()
+    return level:GetStageType()
+end
+--- Helper function to directly warp to a specific stage using the "stage" console command.
+function ____exports.goToStage(self, stage, stageType)
+    local stageTypeLetterSuffix = ____exports.stageTypeToLetter(nil, stageType)
+    local command = ("stage " .. tostring(stage)) .. stageTypeLetterSuffix
+    Isaac.ExecuteCommand(command)
+end
+function ____exports.onAscent(self)
+    return game:GetStateFlag(GameStateFlag.BACKWARDS_PATH)
+end
+function ____exports.onCathedral(self)
+    local level = game:GetLevel()
+    local stage = level:GetStage()
+    local stageType = level:GetStageType()
+    return stage == LevelStage.SHEOL_CATHEDRAL and stageType == StageType.WRATH_OF_THE_LAMB
+end
+function ____exports.onChest(self)
+    local level = game:GetLevel()
+    local stage = level:GetStage()
+    local stageType = level:GetStageType()
+    return stage == LevelStage.DARK_ROOM_CHEST and stageType == StageType.WRATH_OF_THE_LAMB
+end
+function ____exports.onDarkRoom(self)
+    local level = game:GetLevel()
+    local stage = level:GetStage()
+    local stageType = level:GetStageType()
+    return stage == LevelStage.DARK_ROOM_CHEST and stageType == StageType.ORIGINAL
+end
+--- Returns whether or not the player is on the "final floor" of the particular run. The final floor
+-- is defined as one that prevents the player from entering the I AM ERROR room on.
+-- 
+-- For example, when using Undefined on The Chest, it has a 50% chance of teleporting the player to
+-- the Secret Room and a 50% chance of teleporting the player to the Super Secret Room, because the
+-- I AM ERROR room is never entered into the list of possibilities.
+function ____exports.onFinalFloor(self)
+    local level = game:GetLevel()
+    local stage = level:GetStage()
+    return stage == LevelStage.DARK_ROOM_CHEST or stage == LevelStage.THE_VOID or stage == LevelStage.HOME or stage == LevelStage.WOMB_2 and ____exports.onRepentanceStage(nil)
+end
+--- Returns whether or not the player is on the first floor of the particular run.
+-- 
+-- This is tricky to determine because we have to handle the cases of Downpour/Dross 1 not being the
+-- first floor and The Ascent.
+function ____exports.onFirstFloor(self)
+    local effectiveStage = ____exports.getEffectiveStage(nil)
+    local isOnAscent = ____exports.onAscent(nil)
+    return effectiveStage == 1 and not isOnAscent
+end
+function ____exports.onSheol(self)
+    local level = game:GetLevel()
+    local stage = level:GetStage()
+    local stageType = level:GetStageType()
+    return stage == LevelStage.SHEOL_CATHEDRAL and stageType == StageType.ORIGINAL
+end
+--- Helper function to warp to a new stage/level.
+-- 
+-- @param stage The stage number to warp to.
+-- @param stageType The stage type to warp to.
+-- @param reseed Optional. Whether or not to reseed the floor upon arrival. Default is false. Set
+-- this to true if you are warping to the same stage but a different stage type (or
+-- else the floor layout will be identical to the old floor).
+function ____exports.setStage(self, stage, stageType, reseed)
+    if reseed == nil then
+        reseed = false
+    end
+    local stageTypeSuffix = STAGE_TYPE_SUFFIXES[stageType]
+    local command = ("stage " .. tostring(stage)) .. stageTypeSuffix
+    Isaac.ExecuteCommand(command)
+    if reseed then
+        Isaac.ExecuteCommand("reseed")
+    end
+end
+return ____exports

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

@@ -0,0 +1 @@
+{"version":3,"file":"stats.d.ts","sourceRoot":"","sources":["../../../src/functions/stats.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAazD;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,OAAO,CACrB,MAAM,EAAE,YAAY,EACpB,SAAS,EAAE,SAAS,EACpB,MAAM,EAAE,MAAM,GACb,IAAI,CA4CN;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS,CAE7E"}