isaacscript-common 6.6.1-dev.2 → 6.6.1

package/dist/functions/sprite.lua

@@ -0,0 +1,89 @@
+local ____exports = {}
+local ____constants = require("constants")
+local EMPTY_PNG_PATH = ____constants.EMPTY_PNG_PATH
+local VectorZero = ____constants.VectorZero
+local ____kColor = require("functions.kColor")
+local kColorEquals = ____kColor.kColorEquals
+local ____utils = require("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` property 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/functions/stage.d.ts

@@ -0,0 +1,61 @@
+import { LevelStage, RoomType, StageType } from "isaac-typescript-definitions";
+/**
+ * Helper function that calculates what the stage type should be for the provided stage. This
+ * emulates what the game's internal code does.
+ */
+export declare function calculateStageType(stage: LevelStage): StageType;
+/**
+ * Helper function that calculates what the Repentance stage type should be for the provided stage.
+ * This emulates what the game's internal code does.
+ */
+export declare function calculateStageTypeRepentance(stage: LevelStage): StageType;
+/**
+ * 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.
+ */
+export declare function getEffectiveStage(): int;
+/**
+ * Helper function to get the corresponding "goto" console command that would correspond to the
+ * provided room type and room variant.
+ */
+export declare function getGotoCommand(roomType: RoomType, roomVariant: int): string;
+/** Alias for the `Level.GetStage` method. */
+export declare function getStage(): LevelStage;
+/** Alias for the `Level.GetStageType` method. */
+export declare function getStageType(): StageType;
+/** Helper function to directly warp to a specific stage using the "stage" console command. */
+export declare function goToStage(stage: LevelStage, stageType: StageType): void;
+export declare function isRepentanceStage(stageType: StageType): boolean;
+export declare function onCathedral(): boolean;
+export declare function onChest(): boolean;
+export declare function onDarkRoom(): boolean;
+/**
+ * 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.
+ */
+export declare function onFinalFloor(): boolean;
+export declare function onRepentanceStage(): boolean;
+export declare function onSheol(): boolean;
+/**
+ * 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).
+ */
+export declare function setStage(stage: LevelStage, stageType: StageType, reseed?: boolean): void;
+/**
+ * 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".
+ */
+export declare function stageTypeToLetter(stageType: StageType): string;
+//# sourceMappingURL=stage.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"stage.d.ts","sourceRoot":"","sources":["../../../../../packages/isaacscript-common/src/functions/stage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAM/E;;;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,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAI/D;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,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/functions/stage.lua

@@ -0,0 +1,142 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local LevelStage = ____isaac_2Dtypescript_2Ddefinitions.LevelStage
+local StageType = ____isaac_2Dtypescript_2Ddefinitions.StageType
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____roomTypeGotoPrefixes = require("objects.roomTypeGotoPrefixes")
+local ROOM_TYPE_GOTO_PREFIXES = ____roomTypeGotoPrefixes.ROOM_TYPE_GOTO_PREFIXES
+local ____stageTypeSuffixes = require("objects.stageTypeSuffixes")
+local STAGE_TYPE_SUFFIXES = ____stageTypeSuffixes.STAGE_TYPE_SUFFIXES
+local ____stageTypeToLetter = require("objects.stageTypeToLetter")
+local STAGE_TYPE_TO_LETTER = ____stageTypeToLetter.STAGE_TYPE_TO_LETTER
+function ____exports.isRepentanceStage(self, stageType)
+    return stageType == StageType.REPENTANCE or stageType == StageType.REPENTANCE_B
+end
+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 = 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 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.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
+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/functions/string.d.ts

@@ -0,0 +1,14 @@
+export declare function capitalizeFirstLetter(string: string): string;
+export declare function removeAllCharacters(string: string, character: string): string;
+/**
+ * Helper function to remove one or more substrings from a string, if they exist. Returns the
+ * modified string.
+ *
+ * This function is variadic, meaning that you can pass as many substrings as you want to remove.
+ */
+export declare function removeSubstring(string: string, ...substrings: string[]): string;
+/** Helper function to trim a prefix from a string, if it exists. Returns the trimmed string. */
+export declare function trimPrefix(string: string, prefix: string): string;
+/** Helper function to trim a suffix from a string, if it exists. Returns the trimmed string. */
+export declare function trimSuffix(string: string, prefix: string): string;
+//# sourceMappingURL=string.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../../../../../packages/isaacscript-common/src/functions/string.ts"],"names":[],"mappings":"AAAA,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAM5D;AAED,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAE7E;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,MAAM,EACd,GAAG,UAAU,EAAE,MAAM,EAAE,GACtB,MAAM,CAMR;AAED,gGAAgG;AAChG,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAMjE;AAED,gGAAgG;AAChG,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAOjE"}

package/dist/functions/string.lua

@@ -0,0 +1,42 @@
+local ____lualib = require("lualib_bundle")
+local __TS__StringReplaceAll = ____lualib.__TS__StringReplaceAll
+local __TS__StringStartsWith = ____lualib.__TS__StringStartsWith
+local __TS__StringSlice = ____lualib.__TS__StringSlice
+local __TS__StringEndsWith = ____lualib.__TS__StringEndsWith
+local ____exports = {}
+function ____exports.capitalizeFirstLetter(self, ____string)
+    local firstCharacter = string.sub(____string, 1, 1)
+    local capitalizedFirstLetter = string.upper(firstCharacter)
+    local restOfString = string.sub(____string, 2)
+    return capitalizedFirstLetter .. restOfString
+end
+function ____exports.removeAllCharacters(self, ____string, character)
+    return __TS__StringReplaceAll(____string, character, "")
+end
+--- Helper function to remove one or more substrings from a string, if they exist. Returns the
+-- modified string.
+-- 
+-- This function is variadic, meaning that you can pass as many substrings as you want to remove.
+function ____exports.removeSubstring(self, ____string, ...)
+    local substrings = {...}
+    for ____, substring in ipairs(substrings) do
+        ____string = __TS__StringReplaceAll(____string, substring, "")
+    end
+    return ____string
+end
+--- Helper function to trim a prefix from a string, if it exists. Returns the trimmed string.
+function ____exports.trimPrefix(self, ____string, prefix)
+    if not __TS__StringStartsWith(____string, prefix) then
+        return ____string
+    end
+    return __TS__StringSlice(____string, #prefix)
+end
+--- Helper function to trim a suffix from a string, if it exists. Returns the trimmed string.
+function ____exports.trimSuffix(self, ____string, prefix)
+    if not __TS__StringEndsWith(____string, prefix) then
+        return ____string
+    end
+    local endCharacter = #____string - #prefix
+    return __TS__StringSlice(____string, 0, endCharacter)
+end
+return ____exports

package/dist/functions/table.d.ts

@@ -0,0 +1,53 @@
+/// <reference types="typescript-to-lua/language-extensions" />
+/**
+ * In a Map, you can use the `clear` method to delete every element. However, in a LuaTable, the
+ * `clear` method does not exist. Use this helper function as a drop-in replacement for this.
+ */
+export declare function clearTable(luaTable: LuaTable): void;
+/** Helper function to copy specific values from a object to a table. */
+export declare function copyValuesToTable(object: unknown, keys: string[], luaTable: LuaTable<string, unknown>): void;
+/**
+ * Helper function to safely get boolean values from a Lua table. Will throw an error if the
+ * specific value does not exist on the table.
+ *
+ * This function is variadic, meaning that you can specify N arguments to get N values.
+ */
+export declare function getBooleansFromTable(luaTable: LuaTable<string, unknown>, objectName: string, ...keys: string[]): boolean[];
+/**
+ * Helper function to safely get number values from a Lua table. Will throw an error if the specific
+ * value does not exist on the table or if it cannot be converted to a number.
+ *
+ * This function is variadic, meaning that you can specify N arguments to get N values.
+ */
+export declare function getNumbersFromTable(luaTable: LuaTable<string, unknown>, objectName: string, ...keys: string[]): number[];
+/**
+ * Helper function to safely get string values from a Lua table. Will throw an error if the specific
+ * value does not exist on the table.
+ *
+ * This function is variadic, meaning that you can specify N arguments to get N values.
+ */
+export declare function getStringsFromTable(luaTable: LuaTable<string, unknown>, objectName: string, ...keys: string[]): string[];
+/**
+ * Helper function to iterate over a table deterministically. This is useful because by default, the
+ * `pairs` function will return the keys of a Lua table in a random order.
+ *
+ * This function will sort the table entries based on the value of the key.
+ *
+ * This function will only work on tables that have number keys or string keys. It will throw a
+ * runtime error if it encounters a key of another type.
+ *
+ * @param luaTable The table to iterate over.
+ * @param func The function to run for each iteration.
+ * @param inOrder Optional. Whether to iterate in order. True by default. You can dynamically set to
+ *                false in situations where iterating randomly would not matter and you need the
+ *                extra performance.
+ */
+export declare function iterateTableInOrder<K, V>(luaTable: LuaTable<K, V>, func: (key: K, value: V) => void, inOrder?: boolean): void;
+/**
+ * Helper function to check if a Lua table has all of the provided keys.
+ *
+ * This function is variadic, meaning that you can specify as many arguments as you want to check
+ * for.
+ */
+export declare function tableHasKeys(luaTable: LuaTable<AnyNotNil, unknown>, ...keys: string[]): boolean;
+//# sourceMappingURL=table.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"table.d.ts","sourceRoot":"","sources":["../../../../../packages/isaacscript-common/src/functions/table.ts"],"names":[],"mappings":";AAEA;;;GAGG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAInD;AAED,wEAAwE;AACxE,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,OAAO,EACf,IAAI,EAAE,MAAM,EAAE,EACd,QAAQ,EAAE,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,GAClC,IAAI,CAON;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,QAAQ,EAAE,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,EACnC,UAAU,EAAE,MAAM,EAClB,GAAG,IAAI,EAAE,MAAM,EAAE,GAChB,OAAO,EAAE,CAoBX;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,EACnC,UAAU,EAAE,MAAM,EAClB,GAAG,IAAI,EAAE,MAAM,EAAE,GAChB,MAAM,EAAE,CA4BV;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,EACnC,UAAU,EAAE,MAAM,EAClB,GAAG,IAAI,EAAE,MAAM,EAAE,GAChB,MAAM,EAAE,CAmBV;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,CAAC,EACtC,QAAQ,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,EACxB,IAAI,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,IAAI,EAChC,OAAO,UAAO,GACb,IAAI,CA2BN;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,EACtC,GAAG,IAAI,EAAE,MAAM,EAAE,GAChB,OAAO,CAET"}

package/dist/functions/table.lua

@@ -0,0 +1,149 @@
+local ____lualib = require("lualib_bundle")
+local __TS__TypeOf = ____lualib.__TS__TypeOf
+local __TS__ObjectKeys = ____lualib.__TS__ObjectKeys
+local __TS__ArrayEvery = ____lualib.__TS__ArrayEvery
+local __TS__ArraySort = ____lualib.__TS__ArraySort
+local ____exports = {}
+local ____types = require("functions.types")
+local isBoolean = ____types.isBoolean
+local isNumber = ____types.isNumber
+local isString = ____types.isString
+--- In a Map, you can use the `clear` method to delete every element. However, in a LuaTable, the
+-- `clear` method does not exist. Use this helper function as a drop-in replacement for this.
+function ____exports.clearTable(self, luaTable)
+    for key in pairs(luaTable) do
+        luaTable[key] = nil
+    end
+end
+--- Helper function to copy specific values from a object to a table.
+function ____exports.copyValuesToTable(self, object, keys, luaTable)
+    local otherTable = object
+    for ____, key in ipairs(keys) do
+        local value = otherTable[key]
+        luaTable[key] = value
+    end
+end
+--- Helper function to safely get boolean values from a Lua table. Will throw an error if the
+-- specific value does not exist on the table.
+-- 
+-- This function is variadic, meaning that you can specify N arguments to get N values.
+function ____exports.getBooleansFromTable(self, luaTable, objectName, ...)
+    local keys = {...}
+    local booleans = {}
+    for ____, key in ipairs(keys) do
+        local value = luaTable[key]
+        if value == nil then
+            error(((("Failed to find a value for \"" .. key) .. "\" in a table representing a \"") .. objectName) .. "\" object.")
+        end
+        if isBoolean(nil, value) then
+            booleans[#booleans + 1] = value
+        else
+            error((((("Failed to get the boolean for the \"" .. key) .. "\" value of a table representing a \"") .. objectName) .. "\" object because the type was: ") .. __TS__TypeOf(value))
+        end
+    end
+    return booleans
+end
+--- Helper function to safely get number values from a Lua table. Will throw an error if the specific
+-- value does not exist on the table or if it cannot be converted to a number.
+-- 
+-- This function is variadic, meaning that you can specify N arguments to get N values.
+function ____exports.getNumbersFromTable(self, luaTable, objectName, ...)
+    local keys = {...}
+    local numbers = {}
+    for ____, key in ipairs(keys) do
+        local value = luaTable[key]
+        if value == nil then
+            error(((("Failed to find a value for \"" .. key) .. "\" in a table representing a \"") .. objectName) .. "\" object.")
+        end
+        if isNumber(nil, value) then
+            numbers[#numbers + 1] = value
+        elseif isString(nil, value) then
+            local number = tonumber(value)
+            if number == nil then
+                error((((("Failed to convert the \"" .. key) .. "\" value of a table representing a \"") .. objectName) .. "\" object to a number: ") .. value)
+            end
+            numbers[#numbers + 1] = number
+        else
+            error((((("Failed to get the number for the \"" .. key) .. "\" value of a table representing a \"") .. objectName) .. "\" object because the type was: ") .. __TS__TypeOf(value))
+        end
+    end
+    return numbers
+end
+--- Helper function to safely get string values from a Lua table. Will throw an error if the specific
+-- value does not exist on the table.
+-- 
+-- This function is variadic, meaning that you can specify N arguments to get N values.
+function ____exports.getStringsFromTable(self, luaTable, objectName, ...)
+    local keys = {...}
+    local strings = {}
+    for ____, key in ipairs(keys) do
+        local value = luaTable[key]
+        if value == nil then
+            error(((("Failed to find a value for \"" .. key) .. "\" in a table representing a \"") .. objectName) .. "\" object.")
+        end
+        if isString(nil, value) then
+            strings[#strings + 1] = value
+        else
+            local ____string = tostring(value)
+            strings[#strings + 1] = ____string
+        end
+    end
+    return strings
+end
+--- Helper function to iterate over a table deterministically. This is useful because by default, the
+-- `pairs` function will return the keys of a Lua table in a random order.
+-- 
+-- This function will sort the table entries based on the value of the key.
+-- 
+-- This function will only work on tables that have number keys or string keys. It will throw a
+-- runtime error if it encounters a key of another type.
+-- 
+-- @param luaTable The table to iterate over.
+-- @param func The function to run for each iteration.
+-- @param inOrder Optional. Whether to iterate in order. True by default. You can dynamically set to
+-- false in situations where iterating randomly would not matter and you need the
+-- extra performance.
+function ____exports.iterateTableInOrder(self, luaTable, func, inOrder)
+    if inOrder == nil then
+        inOrder = true
+    end
+    if not inOrder then
+        for key, value in pairs(luaTable) do
+            func(nil, key, value)
+        end
+        return
+    end
+    local keys = __TS__ObjectKeys(luaTable)
+    local hasAllNumberKeys = __TS__ArrayEvery(
+        keys,
+        function(____, key) return isNumber(nil, key) end
+    )
+    local hasAllStringKeys = __TS__ArrayEvery(
+        keys,
+        function(____, key) return isString(nil, key) end
+    )
+    if not hasAllNumberKeys and not hasAllStringKeys then
+        for key, value in pairs(luaTable) do
+            func(nil, key, value)
+        end
+        return
+    end
+    __TS__ArraySort(keys)
+    for ____, key in ipairs(keys) do
+        local keyIndex = key
+        local value = luaTable[keyIndex]
+        func(nil, keyIndex, value)
+    end
+end
+--- Helper function to check if a Lua table has all of the provided keys.
+-- 
+-- This function is variadic, meaning that you can specify as many arguments as you want to check
+-- for.
+function ____exports.tableHasKeys(self, luaTable, ...)
+    local keys = {...}
+    return __TS__ArrayEvery(
+        keys,
+        function(____, key) return luaTable[key] ~= nil end
+    )
+end
+return ____exports

package/dist/functions/tears.d.ts

@@ -0,0 +1,24 @@
+/// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
+/**
+ * - Converts the specified amount of tears stat into MaxFireDelay and adds it to the player.
+ * - This function should only be used inside the EvaluateCache callback.
+ * - In this context, the "tears stat" represents what is shown on the in-game stat UI.
+ */
+export declare function addTearsStat(player: EntityPlayer, tearsStat: float): void;
+/**
+ * - The `EntityPlayer` object stores a player's tear rate in the `MaxFireDelay` attribute. This is
+ *   equivalent to how many tears the player can shoot per frame.
+ * - If you already have a "tears" stat and you want to convert it back to MaxFireDelay, then use
+ *   this function.
+ * - In this context, the "tears stat" represents what is shown on the in-game stat UI.
+ */
+export declare function getFireDelay(tearsStat: float): float;
+/**
+ * - The `EntityPlayer` object stores a player's tear rate in the `MaxFireDelay` attribute. This is
+ *   equivalent to how many tears the player can shoot per frame.
+ * - If you want to convert this to the "tears" stat that is shown on the in-game stat UI, then use
+ *   this function.
+ */
+export declare function getTearsStat(fireDelay: float): float;
+//# sourceMappingURL=tears.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"tears.d.ts","sourceRoot":"","sources":["../../../../../packages/isaacscript-common/src/functions/tears.ts"],"names":[],"mappings":";;AAAA;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,KAAK,GAAG,IAAI,CAKzE;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,SAAS,EAAE,KAAK,GAAG,KAAK,CAEpD;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,SAAS,EAAE,KAAK,GAAG,KAAK,CAEpD"}

package/dist/functions/tears.lua

@@ -0,0 +1,26 @@
+local ____exports = {}
+--- - The `EntityPlayer` object stores a player's tear rate in the `MaxFireDelay` attribute. This is
+--   equivalent to how many tears the player can shoot per frame.
+-- - If you already have a "tears" stat and you want to convert it back to MaxFireDelay, then use
+--   this function.
+-- - In this context, the "tears stat" represents what is shown on the in-game stat UI.
+function ____exports.getFireDelay(self, tearsStat)
+    return math.max(30 / tearsStat - 1, -0.9999)
+end
+--- - The `EntityPlayer` object stores a player's tear rate in the `MaxFireDelay` attribute. This is
+--   equivalent to how many tears the player can shoot per frame.
+-- - If you want to convert this to the "tears" stat that is shown on the in-game stat UI, then use
+--   this function.
+function ____exports.getTearsStat(self, fireDelay)
+    return 30 / (fireDelay + 1)
+end
+--- - Converts the specified amount of tears stat into MaxFireDelay and adds it to the player.
+-- - This function should only be used inside the EvaluateCache callback.
+-- - In this context, the "tears stat" represents what is shown on the in-game stat UI.
+function ____exports.addTearsStat(self, player, tearsStat)
+    local existingTearsStat = ____exports.getTearsStat(nil, player.MaxFireDelay)
+    local newTearsStat = existingTearsStat + tearsStat
+    local newMaxFireDelay = ____exports.getFireDelay(nil, newTearsStat)
+    player.MaxFireDelay = newMaxFireDelay
+end
+return ____exports

package/dist/functions/transformations.d.ts

@@ -0,0 +1,31 @@
+import { CollectibleType, PlayerForm } from "isaac-typescript-definitions";
+/**
+ * Helper function to get all of the collectible types in the game that count towards a particular
+ * transformation.
+ *
+ * For example, to get all of the collectible types that count towards Guppy:
+ *
+ * ```ts
+ * const guppyCollectibleTypes = getCollectibleTypesForTransformation(PlayerForm.GUPPY);
+ * ```
+ */
+export declare function getCollectibleTypesForTransformation(playerForm: PlayerForm): Set<CollectibleType>;
+/** Returns the number of items that a player has towards a particular transformation. */
+export declare function getPlayerNumCollectiblesForTransformation(player: EntityPlayer, playerForm: PlayerForm): int;
+/** Returns a set of the player's current transformations. */
+export declare function getPlayerTransformations(player: EntityPlayer): Set<PlayerForm>;
+/**
+ * Helper function to get a transformation name from a PlayerForm enum.
+ *
+ * For example:
+ *
+ * ```ts
+ * const transformationName = getTransformationName(PlayerForm.LORD_OF_THE_FLIES);
+ * // transformationName is "Beelzebub"
+ * ```
+ */
+export declare function getTransformationName(playerForm: PlayerForm): string;
+export declare function getTransformationsForCollectibleType(collectibleType: CollectibleType): Set<PlayerForm>;
+export declare function hasFlyingTransformation(player: EntityPlayer): boolean;
+export declare function isTransformationFlying(playerForm: PlayerForm): boolean;
+//# sourceMappingURL=transformations.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"transformations.d.ts","sourceRoot":"","sources":["../../../../../packages/isaacscript-common/src/functions/transformations.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EAEf,UAAU,EACX,MAAM,8BAA8B,CAAC;AAiCtC;;;;;;;;;GASG;AACH,wBAAgB,oCAAoC,CAClD,UAAU,EAAE,UAAU,GACrB,GAAG,CAAC,eAAe,CAAC,CAStB;AAED,yFAAyF;AACzF,wBAAgB,yCAAyC,CACvD,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,UAAU,GACrB,GAAG,CAGL;AAED,6DAA6D;AAC7D,wBAAgB,wBAAwB,CACtC,MAAM,EAAE,YAAY,GACnB,GAAG,CAAC,UAAU,CAAC,CASjB;AAED;;;;;;;;;GASG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM,CAEpE;AAED,wBAAgB,oCAAoC,CAClD,eAAe,EAAE,eAAe,GAC/B,GAAG,CAAC,UAAU,CAAC,CAiBjB;AAED,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAQrE;AAED,wBAAgB,sBAAsB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAEtE"}