isaacscript-common 2.3.0 → 2.3.1

package/functions/spawnCollectible.d.ts

@@ -0,0 +1,31 @@
+import { CollectibleType } from "isaac-typescript-definitions";
+/**
+ * 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.
+ */
+export declare function spawnCollectible(collectibleType: CollectibleType, position: Vector, seedOrRNG?: Seed | RNG, options?: boolean, forceFreeItem?: boolean, spawner?: Entity): EntityPickupCollectible;
+/**
+ * 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()`.
+ */
+export declare function spawnEmptyCollectible(position: Vector, seedOrRNG?: Seed | RNG): EntityPickup;

package/functions/spawnCollectible.lua

@@ -0,0 +1,70 @@
+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("constants")
+local VectorZero = ____constants.VectorZero
+local ____preventCollectibleRotation = require("features.preventCollectibleRotation")
+local preventCollectibleRotation = ____preventCollectibleRotation.preventCollectibleRotation
+local ____featuresInitialized = require("featuresInitialized")
+local areFeaturesInitialized = ____featuresInitialized.areFeaturesInitialized
+local ____collectibles = require("functions.collectibles")
+local setCollectibleEmpty = ____collectibles.setCollectibleEmpty
+local ____collectibleTag = require("functions.collectibleTag")
+local isQuestCollectible = ____collectibleTag.isQuestCollectible
+local ____entitySpecific = require("functions.entitySpecific")
+local spawnPickupWithSeed = ____entitySpecific.spawnPickupWithSeed
+local ____player = require("functions.player")
+local anyPlayerIs = ____player.anyPlayerIs
+local ____rng = require("functions.rng")
+local getRandomSeed = ____rng.getRandomSeed
+local isRNG = ____rng.isRNG
+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
+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/functions/sprite.d.ts

@@ -0,0 +1,36 @@
+/// <reference types="isaac-typescript-definitions" />
+/**
+ * Helper function to clear a specific layer 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.
+ */
+export declare function clearSprite(sprite: Sprite, ...layerIDs: int[]): void;
+/**
+ * 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.
+ */
+export declare function getLastFrameOfAnimation(sprite: Sprite, animation?: string): int;
+/**
+ * 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.
+ */
+export declare function spriteEquals(sprite1: Sprite, sprite2: Sprite, layerID: int, xStart: int, xFinish: int, xIncrement: int, yStart: int, yFinish: int, yIncrement: int): boolean;
+/** Helper function to check if two texels on a sprite are equivalent to each other. */
+export declare function texelEquals(sprite1: Sprite, sprite2: Sprite, position: Vector, layerID: int): boolean;

package/functions/sprite.lua

@@ -0,0 +1,64 @@
+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
+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
+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
+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
+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/functions/stage.d.ts

@@ -0,0 +1,35 @@
+import { LevelStage, StageType } from "isaac-typescript-definitions";
+/**
+ * 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;
+/** 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 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;

package/functions/stage.lua

@@ -0,0 +1,70 @@
+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 ____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
+function ____exports.stageTypeToLetter(self, stageType)
+    return STAGE_TYPE_TO_LETTER[stageType]
+end
+function ____exports.getEffectiveStage(self)
+    local level = game:GetLevel()
+    local stage = level:GetStage()
+    if ____exports.onRepentanceStage(nil) then
+        return stage + 1
+    end
+    return stage
+end
+function ____exports.getStage(self)
+    local level = game:GetLevel()
+    return level:GetStage()
+end
+function ____exports.getStageType(self)
+    local level = game:GetLevel()
+    return level:GetStageType()
+end
+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
+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
+return ____exports

package/functions/string.d.ts

@@ -0,0 +1,13 @@
+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;

package/functions/string.lua

@@ -0,0 +1,36 @@
+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
+function ____exports.removeSubstring(self, ____string, ...)
+    local substrings = {...}
+    for ____, substring in ipairs(substrings) do
+        ____string = __TS__StringReplaceAll(____string, substring, "")
+    end
+    return ____string
+end
+function ____exports.trimPrefix(self, ____string, prefix)
+    if not __TS__StringStartsWith(____string, prefix) then
+        return ____string
+    end
+    return __TS__StringSlice(____string, #prefix)
+end
+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/functions/table.d.ts

@@ -0,0 +1,36 @@
+/// <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(table: LuaTable): void;
+/** Helper function to copy specific values from a object to a table. */
+export declare function copyValuesToTable(object: unknown, keys: string[], table: 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(table: 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(table: 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(table: LuaTable<string, unknown>, objectName: string, ...keys: string[]): string[];
+/**
+ * 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(table: LuaTable<AnyNotNil, unknown>, ...keys: string[]): boolean;

package/functions/table.lua

@@ -0,0 +1,79 @@
+local ____lualib = require("lualib_bundle")
+local __TS__TypeOf = ____lualib.__TS__TypeOf
+local __TS__ArrayEvery = ____lualib.__TS__ArrayEvery
+local ____exports = {}
+function ____exports.clearTable(self, ____table)
+    for key in pairs(____table) do
+        ____table[key] = nil
+    end
+end
+function ____exports.copyValuesToTable(self, object, keys, ____table)
+    local otherTable = object
+    for ____, key in ipairs(keys) do
+        local value = otherTable[key]
+        ____table[key] = value
+    end
+end
+function ____exports.getBooleansFromTable(self, ____table, objectName, ...)
+    local keys = {...}
+    local booleans = {}
+    for ____, key in ipairs(keys) do
+        local value = ____table[key]
+        if value == nil then
+            error(((("Failed to find a value for \"" .. key) .. "\" in a table representing a \"") .. objectName) .. "\" object.")
+        end
+        if type(value) == "boolean" 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
+function ____exports.getNumbersFromTable(self, ____table, objectName, ...)
+    local keys = {...}
+    local numbers = {}
+    for ____, key in ipairs(keys) do
+        local value = ____table[key]
+        if value == nil then
+            error(((("Failed to find a value for \"" .. key) .. "\" in a table representing a \"") .. objectName) .. "\" object.")
+        end
+        if type(value) == "number" then
+            numbers[#numbers + 1] = value
+        elseif type(value) == "string" 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
+function ____exports.getStringsFromTable(self, ____table, objectName, ...)
+    local keys = {...}
+    local strings = {}
+    for ____, key in ipairs(keys) do
+        local value = ____table[key]
+        if value == nil then
+            error(((("Failed to find a value for \"" .. key) .. "\" in a table representing a \"") .. objectName) .. "\" object.")
+        end
+        if type(value) == "string" then
+            strings[#strings + 1] = value
+        else
+            local ____string = tostring(value)
+            strings[#strings + 1] = ____string
+        end
+    end
+    return strings
+end
+function ____exports.tableHasKeys(self, ____table, ...)
+    local keys = {...}
+    return __TS__ArrayEvery(
+        keys,
+        function(____, key) return ____table[key] ~= nil end
+    )
+end
+return ____exports

package/functions/tears.d.ts

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

package/functions/tears.lua

@@ -0,0 +1,14 @@
+local ____exports = {}
+function ____exports.getFireDelay(self, tearsStat)
+    return math.max(30 / tearsStat - 1, -0.9999)
+end
+function ____exports.getTearsStat(self, fireDelay)
+    return 30 / (fireDelay + 1)
+end
+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/functions/transformations.d.ts

@@ -0,0 +1,30 @@
+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;

package/functions/transformations.lua

@@ -0,0 +1,96 @@
+local ____lualib = require("lualib_bundle")
+local Map = ____lualib.Map
+local __TS__New = ____lualib.__TS__New
+local Set = ____lualib.Set
+local __TS__Spread = ____lualib.__TS__Spread
+local __TS__Iterator = ____lualib.__TS__Iterator
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local ItemConfigTag = ____isaac_2Dtypescript_2Ddefinitions.ItemConfigTag
+local PlayerForm = ____isaac_2Dtypescript_2Ddefinitions.PlayerForm
+local ____transformationNames = require("objects.transformationNames")
+local DEFAULT_TRANSFORMATION_NAME = ____transformationNames.DEFAULT_TRANSFORMATION_NAME
+local TRANSFORMATION_NAMES = ____transformationNames.TRANSFORMATION_NAMES
+local ____collectibles = require("functions.collectibles")
+local getCollectibleTags = ____collectibles.getCollectibleTags
+local ____collectibleTag = require("functions.collectibleTag")
+local getCollectibleTypesWithTag = ____collectibleTag.getCollectibleTypesWithTag
+local ____enums = require("functions.enums")
+local getEnumValues = ____enums.getEnumValues
+local ____flag = require("functions.flag")
+local hasFlag = ____flag.hasFlag
+local ____player = require("functions.player")
+local getPlayerCollectibleCount = ____player.getPlayerCollectibleCount
+local TRANSFORMATION_TO_TAG_MAP = __TS__New(Map, {
+    {PlayerForm.GUPPY, ItemConfigTag.GUPPY},
+    {PlayerForm.BEELZEBUB, ItemConfigTag.FLY},
+    {PlayerForm.FUN_GUY, ItemConfigTag.MUSHROOM},
+    {PlayerForm.SERAPHIM, ItemConfigTag.ANGEL},
+    {PlayerForm.BOB, ItemConfigTag.BOB},
+    {PlayerForm.SPUN, ItemConfigTag.SYRINGE},
+    {PlayerForm.YES_MOTHER, ItemConfigTag.MOM},
+    {PlayerForm.CONJOINED, ItemConfigTag.BABY},
+    {PlayerForm.LEVIATHAN, ItemConfigTag.DEVIL},
+    {PlayerForm.OH_CRAP, ItemConfigTag.POOP},
+    {PlayerForm.BOOKWORM, ItemConfigTag.BOOK},
+    {PlayerForm.SPIDER_BABY, ItemConfigTag.SPIDER}
+})
+local TRANSFORMATIONS_THAT_GRANT_FLYING = __TS__New(Set, {PlayerForm.GUPPY, PlayerForm.BEELZEBUB, PlayerForm.SERAPHIM, PlayerForm.LEVIATHAN})
+function ____exports.getCollectibleTypesForTransformation(self, playerForm)
+    local itemConfigTag = TRANSFORMATION_TO_TAG_MAP:get(playerForm)
+    if itemConfigTag == nil then
+        error(("Failed to get the collectible types for the transformation of " .. tostring(playerForm)) .. " because that transformation is not based on collectibles.")
+    end
+    return getCollectibleTypesWithTag(nil, itemConfigTag)
+end
+function ____exports.getPlayerNumCollectiblesForTransformation(self, player, playerForm)
+    local collectibleTypes = ____exports.getCollectibleTypesForTransformation(nil, playerForm)
+    return getPlayerCollectibleCount(
+        nil,
+        player,
+        __TS__Spread(collectibleTypes:values())
+    )
+end
+function ____exports.getPlayerTransformations(self, player)
+    local transformations = __TS__New(Set)
+    for ____, playerForm in ipairs(getEnumValues(nil, PlayerForm)) do
+        if player:HasPlayerForm(playerForm) then
+            transformations:add(playerForm)
+        end
+    end
+    return transformations
+end
+function ____exports.getTransformationName(self, playerForm)
+    local transformationName = TRANSFORMATION_NAMES[playerForm]
+    return transformationName == nil and DEFAULT_TRANSFORMATION_NAME or transformationName
+end
+function ____exports.getTransformationsForCollectibleType(self, collectibleType)
+    local itemConfigTags = getCollectibleTags(nil, collectibleType)
+    local playerForms = getEnumValues(nil, PlayerForm)
+    local transformationSet = __TS__New(Set)
+    for ____, playerForm in ipairs(playerForms) do
+        do
+            local itemConfigTag = TRANSFORMATION_TO_TAG_MAP:get(playerForm)
+            if itemConfigTag == nil then
+                goto __continue11
+            end
+            if hasFlag(nil, itemConfigTags, itemConfigTag) then
+                transformationSet:add(playerForm)
+            end
+        end
+        ::__continue11::
+    end
+    return transformationSet
+end
+function ____exports.hasFlyingTransformation(self, player)
+    for ____, playerForm in __TS__Iterator(TRANSFORMATIONS_THAT_GRANT_FLYING:values()) do
+        if player:HasPlayerForm(playerForm) then
+            return true
+        end
+    end
+    return false
+end
+function ____exports.isTransformationFlying(self, playerForm)
+    return TRANSFORMATIONS_THAT_GRANT_FLYING:has(playerForm)
+end
+return ____exports

package/functions/trinketCacheFlag.d.ts

@@ -0,0 +1,10 @@
+import { CacheFlag, TrinketType } from "isaac-typescript-definitions";
+/**
+ * Returns a map containing every trinket type that the player has that matches the provided
+ * CacheFlag. The values of the map correspond to the multiplier for that trinket.
+ */
+export declare function getPlayerTrinketsForCacheFlag(player: EntityPlayer, cacheFlag: CacheFlag): Map<TrinketType, int>;
+/**
+ * Returns a set containing every trinket type with the given cache flag, including modded trinkets.
+ */
+export declare function getTrinketsForCacheFlag(cacheFlag: CacheFlag): Set<TrinketType>;