isaacscript-common 2.3.0 → 3.0.0

package/functions/trinkets.lua

@@ -0,0 +1,167 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local PlayerType = ____isaac_2Dtypescript_2Ddefinitions.PlayerType
+local TrinketSlot = ____isaac_2Dtypescript_2Ddefinitions.TrinketSlot
+local TrinketType = ____isaac_2Dtypescript_2Ddefinitions.TrinketType
+local ____cachedClasses = require("cachedClasses")
+local itemConfig = ____cachedClasses.itemConfig
+local ____constantsFirstLast = require("constantsFirstLast")
+local FIRST_MODDED_TRINKET_TYPE = ____constantsFirstLast.FIRST_MODDED_TRINKET_TYPE
+local FIRST_TRINKET_TYPE = ____constantsFirstLast.FIRST_TRINKET_TYPE
+local LAST_TRINKET_TYPE = ____constantsFirstLast.LAST_TRINKET_TYPE
+local LAST_VANILLA_TRINKET_TYPE = ____constantsFirstLast.LAST_VANILLA_TRINKET_TYPE
+local ____trinketDescriptionMap = require("maps.trinketDescriptionMap")
+local DEFAULT_TRINKET_DESCRIPTION = ____trinketDescriptionMap.DEFAULT_TRINKET_DESCRIPTION
+local TRINKET_DESCRIPTION_MAP = ____trinketDescriptionMap.TRINKET_DESCRIPTION_MAP
+local ____trinketNameMap = require("maps.trinketNameMap")
+local DEFAULT_TRINKET_NAME = ____trinketNameMap.DEFAULT_TRINKET_NAME
+local TRINKET_NAME_MAP = ____trinketNameMap.TRINKET_NAME_MAP
+local ____entity = require("functions.entity")
+local getEntityID = ____entity.getEntityID
+local ____flag = require("functions.flag")
+local hasFlag = ____flag.hasFlag
+local ____pickupVariants = require("functions.pickupVariants")
+local isTrinket = ____pickupVariants.isTrinket
+local ____player = require("functions.player")
+local isCharacter = ____player.isCharacter
+local ____sprite = require("functions.sprite")
+local clearSprite = ____sprite.clearSprite
+local ____utils = require("functions.utils")
+local irange = ____utils.irange
+--- Add this to a `TrinketType` to get the corresponding golden trinket type.
+-- 
+-- Corresponds to the vanilla `PillColor.TRINKET_GOLDEN_FLAG` value.
+-- 
+-- 1 << 15
+local GOLDEN_TRINKET_ADJUSTMENT = 32768
+local TRINKET_SPRITE_LAYER = 0
+--- Helper function to get the corresponding golden trinket type from a normal trinket type.
+-- 
+-- For example, passing `TrinketType.SWALLOWED_PENNY` would result in 32769, which is the value that
+-- corresponds to the golden trinket sub-type for Swallowed Penny.
+function ____exports.getGoldenTrinketType(self, trinketType)
+    return trinketType + GOLDEN_TRINKET_ADJUSTMENT
+end
+--- Helper function to get an array that represents every modded trinket type.
+-- 
+-- Returns an empty array if there are no modded trinket types.
+function ____exports.getModdedTrinketTypes(self)
+    if LAST_VANILLA_TRINKET_TYPE == LAST_TRINKET_TYPE then
+        return {}
+    end
+    return irange(nil, FIRST_MODDED_TRINKET_TYPE, LAST_TRINKET_TYPE)
+end
+--- Returns the slot number corresponding to where a trinket can be safely inserted.
+-- 
+-- For example:
+-- 
+-- ```ts
+-- const player = Isaac.GetPlayer();
+-- const trinketSlot = getOpenTrinketSlotNum(player);
+-- if (trinketSlot !== undefined) {
+--   // They have one or more open trinket slots
+--   player.AddTrinket(TrinketType.SWALLOWED_PENNY);
+-- }
+-- ```
+function ____exports.getOpenTrinketSlot(self, player)
+    local maxTrinkets = player:GetMaxTrinkets()
+    local trinketType1 = player:GetTrinket(TrinketSlot.SLOT_1)
+    local trinketType2 = player:GetTrinket(TrinketSlot.SLOT_2)
+    if maxTrinkets == 1 then
+        return trinketType1 == TrinketType.NULL and 0 or nil
+    end
+    if maxTrinkets == 2 then
+        if trinketType1 == TrinketType.NULL then
+            return 0
+        end
+        return trinketType2 == TrinketType.NULL and 1 or nil
+    end
+    return error("The player has an unknown number of trinket slots: " .. tostring(maxTrinkets))
+end
+--- Helper function to get the in-game description for a trinket. Returns "Unknown" if the provided
+-- trinket type was not valid.
+function ____exports.getTrinketDescription(self, trinketType)
+    local trinketDescription = TRINKET_DESCRIPTION_MAP:get(trinketType)
+    if trinketDescription ~= nil then
+        return trinketDescription
+    end
+    local itemConfigItem = itemConfig:GetTrinket(trinketType)
+    if itemConfigItem ~= nil then
+        return itemConfigItem.Description
+    end
+    return DEFAULT_TRINKET_DESCRIPTION
+end
+--- Helper function to get the name of a trinket. Returns "Unknown" if the provided trinket type is
+-- not valid.
+-- 
+-- For example:
+-- 
+-- ```ts
+-- const trinketType = TrinketType.SWALLOWED_PENNY;
+-- const trinketName = getTrinketName(trinketType); // trinketName is "Swallowed Penny"
+-- ```
+function ____exports.getTrinketName(self, trinketType)
+    local trinketName = TRINKET_NAME_MAP:get(trinketType)
+    if trinketName ~= nil then
+        return trinketName
+    end
+    local itemConfigItem = itemConfig:GetTrinket(trinketType)
+    if itemConfigItem ~= nil then
+        return itemConfigItem.Name
+    end
+    return DEFAULT_TRINKET_NAME
+end
+--- Helper function to get an array that contains every trinket type.
+function ____exports.getTrinketTypes(self)
+    return irange(nil, FIRST_TRINKET_TYPE, LAST_TRINKET_TYPE)
+end
+--- Helper function to get an array that represents every vanilla trinket type.
+function ____exports.getVanillaTrinketTypes(self)
+    return irange(nil, FIRST_TRINKET_TYPE, LAST_VANILLA_TRINKET_TYPE)
+end
+--- Returns whether or not the player can hold an additional trinket, beyond what they are currently
+-- carrying. This takes into account items that modify the max number of trinkets, like Mom's Purse.
+-- 
+-- If the player is the Tainted Soul, this always returns false, since that character cannot pick up
+-- items. (Only Tainted Forgotten can pick up items.)
+function ____exports.hasOpenTrinketSlot(self, player)
+    if isCharacter(nil, player, PlayerType.THE_SOUL_B) then
+        return false
+    end
+    local openTrinketSlot = ____exports.getOpenTrinketSlot(nil, player)
+    return openTrinketSlot ~= nil
+end
+function ____exports.isGoldenTrinket(self, trinketType)
+    return trinketType > GOLDEN_TRINKET_ADJUSTMENT
+end
+--- Helper function to change the sprite of a trinket entity.
+-- 
+-- For more information about removing the trinket sprite, see the documentation for the
+-- "clearSprite" helper function.
+-- 
+-- @param trinket The trinket whose sprite you want to modify.
+-- @param pngPath Equal to either the spritesheet path to load (e.g.
+-- "gfx/items/trinkets/trinket_001_swallowedpenny.png") or undefined. If undefined,
+-- the sprite will be removed, making it appear like the collectible has already been
+-- taken by the player.
+function ____exports.setTrinketSprite(self, trinket, pngPath)
+    if not isTrinket(nil, trinket) then
+        local entityID = getEntityID(nil, trinket)
+        error("The \"setTrinketSprite\" function was given a non-trinket: " .. entityID)
+    end
+    local sprite = trinket:GetSprite()
+    if pngPath == nil then
+        clearSprite(nil, sprite, TRINKET_SPRITE_LAYER)
+    else
+        sprite:ReplaceSpritesheet(TRINKET_SPRITE_LAYER, pngPath)
+        sprite:LoadGraphics()
+    end
+end
+function ____exports.trinketHasCacheFlag(self, trinketType, cacheFlag)
+    local itemConfigItem = itemConfig:GetTrinket(trinketType)
+    if itemConfigItem == nil then
+        return false
+    end
+    return hasFlag(nil, itemConfigItem.CacheFlags, cacheFlag)
+end
+return ____exports

package/functions/tstlClass.d.ts

@@ -0,0 +1,20 @@
+import { TSTLClass } from "../types/private/TSTLClass";
+/**
+ * Returns whether or not this is a class that is provided by the `isaacscript-common` library, such
+ * as a `DefaultMap`.
+ */
+export declare function isIsaacScriptCommonClass(object: unknown): boolean;
+/** TypeScriptToLua classes are Lua tables that have a metatable with a certain amount of keys. */
+export declare function isUserDefinedTSTLClass(object: unknown): object is TSTLClass;
+/**
+ * Returns whether or not this is a class that is provided as part of the TypeScriptToLua
+ * transpiler, such as a `Map` or a `Set`.
+ */
+export declare function isVanillaTSTLClass(object: unknown): boolean;
+/**
+ * Initializes a new TypeScriptToLua class in the situation where you do not know what kind of class
+ * it is. This function requires that you provide an instantiated class of the same type, as it will
+ * use the class constructor that is present on the other object's metatable to initialize the new
+ * class.
+ */
+export declare function newTSTLClass(oldClass: TSTLClass): TSTLClass;

package/functions/tstlClass.lua

@@ -0,0 +1,65 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local __TS__InstanceOf = ____lualib.__TS__InstanceOf
+local Map = ____lualib.Map
+local WeakMap = ____lualib.WeakMap
+local WeakSet = ____lualib.WeakSet
+local ____exports = {}
+local newTSTLClassFromMetatable
+local ____DefaultMap = require("classes.DefaultMap")
+local DefaultMap = ____DefaultMap.DefaultMap
+--- Returns whether or not this is a class that is provided as part of the TypeScriptToLua
+-- transpiler, such as a `Map` or a `Set`.
+function ____exports.isVanillaTSTLClass(self, object)
+    return __TS__InstanceOf(object, Map) or __TS__InstanceOf(object, Set) or __TS__InstanceOf(object, WeakMap) or __TS__InstanceOf(object, WeakSet)
+end
+function newTSTLClassFromMetatable(self, metatable)
+    local newClass = {}
+    local newClassMetatable = setmetatable(newClass, metatable.constructor.prototype)
+    newClassMetatable:____constructor()
+    return newClass
+end
+local TSTL_CLASS_METATABLE_KEYS = __TS__New(Set, {"____constructor", "__index", "constructor"})
+--- Returns whether or not this is a class that is provided by the `isaacscript-common` library, such
+-- as a `DefaultMap`.
+function ____exports.isIsaacScriptCommonClass(self, object)
+    return __TS__InstanceOf(object, DefaultMap)
+end
+--- TypeScriptToLua classes are Lua tables that have a metatable with a certain amount of keys.
+function ____exports.isUserDefinedTSTLClass(self, object)
+    if ____exports.isVanillaTSTLClass(nil, object) or ____exports.isIsaacScriptCommonClass(nil, object) then
+        return false
+    end
+    local objectType = type(object)
+    if objectType ~= "table" then
+        return false
+    end
+    local metatable = getmetatable(object)
+    if metatable == nil then
+        return false
+    end
+    local numKeys = 0
+    for key in pairs(metatable) do
+        numKeys = numKeys + 1
+        if type(key) ~= "string" then
+            return false
+        end
+        if not TSTL_CLASS_METATABLE_KEYS:has(key) then
+            return false
+        end
+    end
+    return numKeys == TSTL_CLASS_METATABLE_KEYS.size
+end
+--- Initializes a new TypeScriptToLua class in the situation where you do not know what kind of class
+-- it is. This function requires that you provide an instantiated class of the same type, as it will
+-- use the class constructor that is present on the other object's metatable to initialize the new
+-- class.
+function ____exports.newTSTLClass(self, oldClass)
+    local metatable = getmetatable(oldClass)
+    if metatable == nil then
+        error("Failed to instantiate a new TypeScriptToLua class since the provided old class does not have a metatable.")
+    end
+    return newTSTLClassFromMetatable(nil, metatable)
+end
+return ____exports

package/functions/ui.d.ts

@@ -0,0 +1,34 @@
+/// <reference types="isaac-typescript-definitions" />
+/**
+ * In the options menu, players have the ability to set a HUD offset. However, mods do not have
+ * access to this value. To get around this, Mod Config Menu provides a separate HUD offset setting
+ * on the first page of the menu. This is intended to be set by end-users to match their vanilla HUD
+ * offset setting so that mods can render UI elements to the screen in the correct position.
+ *
+ * @returns If the user does not have Mod Config Menu enabled, or does not have this option set,
+ *          then this function will return `Vector.Zero.` Otherwise, it will return a Vector that
+ *          represents a HUD offset that should be added to the position of a UI element.
+ */
+export declare function getHUDOffsetVector(): Vector;
+/**
+ * Returns how many hearts are in the heart UI row. If the player has more than 6 hearts, this
+ * function will return 6.
+ */
+export declare function getHeartRowLength(player: EntityPlayer): int;
+/**
+ * Helper function to get the width of the first player's hearts on the UI. This is useful for
+ * drawing UI elements to the right of where the player's hearts are. Make sure to use this in
+ * combination with the the `getHUDOffsetVector` helper function.
+ */
+export declare function getHeartsUIWidth(): int;
+export declare function getScreenBottomLeftPos(): Vector;
+export declare function getScreenBottomRightPos(): Vector;
+export declare function getScreenCenterPos(): Vector;
+export declare function getScreenTopLeftPos(): Vector;
+export declare function getScreenTopRightPos(): Vector;
+/**
+ * Get how many hearts are currently being shown on the hearts UI.
+ *
+ * This function is originally from piber20 Helper.
+ */
+export declare function getVisibleHearts(player: EntityPlayer): int;

package/functions/ui.lua

@@ -0,0 +1,111 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local CollectibleType = ____isaac_2Dtypescript_2Ddefinitions.CollectibleType
+local LevelCurse = ____isaac_2Dtypescript_2Ddefinitions.LevelCurse
+local ____cachedClasses = require("cachedClasses")
+local game = ____cachedClasses.game
+local ____constants = require("constants")
+local UI_HEART_WIDTH = ____constants.UI_HEART_WIDTH
+local VectorZero = ____constants.VectorZero
+local ____vector = require("functions.vector")
+local copyVector = ____vector.copyVector
+function ____exports.getScreenBottomRightPos(self)
+    local screenWidth = Isaac.GetScreenWidth()
+    local screenHeight = Isaac.GetScreenHeight()
+    return Vector(screenWidth, screenHeight)
+end
+--- In the options menu, players have the ability to set a HUD offset. However, mods do not have
+-- access to this value. To get around this, Mod Config Menu provides a separate HUD offset setting
+-- on the first page of the menu. This is intended to be set by end-users to match their vanilla HUD
+-- offset setting so that mods can render UI elements to the screen in the correct position.
+-- 
+-- @returns If the user does not have Mod Config Menu enabled, or does not have this option set,
+-- then this function will return `Vector.Zero.` Otherwise, it will return a Vector that
+-- represents a HUD offset that should be added to the position of a UI element.
+function ____exports.getHUDOffsetVector(self)
+    local defaultVector = copyVector(nil, VectorZero)
+    local hudOffset = math.floor(Options.HUDOffset * 10)
+    if hudOffset < 1 or hudOffset > 10 then
+        return defaultVector
+    end
+    local x = hudOffset * 2
+    local y = hudOffset
+    if y >= 4 then
+        y = y + 1
+    end
+    if y >= 9 then
+        y = y + 1
+    end
+    return Vector(x, y)
+end
+--- Returns how many hearts are in the heart UI row. If the player has more than 6 hearts, this
+-- function will return 6.
+function ____exports.getHeartRowLength(self, player)
+    local maxHearts = player:GetMaxHearts()
+    local soulHearts = player:GetSoulHearts()
+    local boneHearts = player:GetBoneHearts()
+    local combinedHearts = maxHearts + soulHearts + boneHearts * 2
+    local heartRowLength = combinedHearts / 2
+    return math.min(heartRowLength, 6)
+end
+--- Helper function to get the width of the first player's hearts on the UI. This is useful for
+-- drawing UI elements to the right of where the player's hearts are. Make sure to use this in
+-- combination with the the `getHUDOffsetVector` helper function.
+function ____exports.getHeartsUIWidth(self)
+    local level = game:GetLevel()
+    local curses = level:GetCurses()
+    local player = Isaac.GetPlayer()
+    local extraLives = player:GetExtraLives()
+    local effects = player:GetEffects()
+    local hasHolyMantleEffect = effects:HasCollectibleEffect(CollectibleType.HOLY_MANTLE)
+    local heartRowLength = ____exports.getHeartRowLength(nil, player)
+    if hasHolyMantleEffect then
+        heartRowLength = heartRowLength + 1
+    end
+    if curses == LevelCurse.UNKNOWN then
+        heartRowLength = 1
+    end
+    local width = heartRowLength * UI_HEART_WIDTH
+    if extraLives > 9 then
+        width = width + 20
+        if player:HasCollectible(CollectibleType.GUPPYS_COLLAR) then
+            width = width + 6
+        end
+    elseif extraLives > 0 then
+        width = width + 16
+        if player:HasCollectible(CollectibleType.GUPPYS_COLLAR) then
+            width = width + 4
+        end
+    end
+    return width
+end
+function ____exports.getScreenBottomLeftPos(self)
+    local bottomRight = ____exports.getScreenBottomRightPos(nil)
+    return Vector(0, bottomRight.Y)
+end
+function ____exports.getScreenCenterPos(self)
+    local bottomRight = ____exports.getScreenBottomRightPos(nil)
+    return bottomRight / 2
+end
+function ____exports.getScreenTopLeftPos(self)
+    return copyVector(nil, VectorZero)
+end
+function ____exports.getScreenTopRightPos(self)
+    local bottomRight = ____exports.getScreenBottomRightPos(nil)
+    return Vector(bottomRight.X, 0)
+end
+--- Get how many hearts are currently being shown on the hearts UI.
+-- 
+-- This function is originally from piber20 Helper.
+function ____exports.getVisibleHearts(self, player)
+    local effectiveMaxHearts = player:GetEffectiveMaxHearts()
+    local soulHearts = player:GetSoulHearts()
+    local boneHearts = player:GetBoneHearts()
+    local maxHearts = math.max(effectiveMaxHearts, boneHearts * 2)
+    local visibleHearts = math.ceil((maxHearts + soulHearts) / 2)
+    if visibleHearts < 1 then
+        visibleHearts = 1
+    end
+    return visibleHearts
+end
+return ____exports

package/functions/utils.d.ts

@@ -0,0 +1,113 @@
+/// <reference types="isaac-typescript-definitions" />
+/**
+ * Helper function to get type safety on a switch statement.
+ *
+ * Very useful to be future-safe against people adding values to a type or an enum.
+ *
+ * For example:
+ *
+ * ```ts
+ * enum Situation {
+ *   ONE,
+ *   TWO,
+ *   THREE,
+ *   // FOUR, // If we uncomment this line, the program will no longer compile
+ * }
+ *
+ * function handleSituation(situation: Situation) {
+ *   switch (situation) {
+ *     case Situation.ONE: {
+ *       return 41;
+ *     }
+ *
+ *     case Situation.TWO: {
+ *       return 68;
+ *     }
+ *
+ *     case Situation.THREE: {
+ *       return 12;
+ *     }
+ *
+ *     default: {
+ *       return ensureAllCases(situation);
+ *     }
+ *   }
+ * }
+ * ```
+ */
+export declare const ensureAllCases: (obj: never) => never;
+/**
+ * Helper function to return an array with the elements from start to end. It is inclusive at the
+ * start and exclusive at the end. (The "e" stands for exclusive.)
+ *
+ * For example, `erange(1, 3)` will return `[1, 2]`.
+ *
+ * If only one argument is specified, then it will assume that the start is 0.
+ */
+export declare function erange(start: int, end?: int): int[];
+/**
+ * Helper function to log what is happening in functions that recursively move through nested data
+ * structures.
+ */
+export declare function getTraversalDescription(key: unknown, traversalDescription: string): string;
+/**
+ * Converts a hex string like "#33aa33" to a KColor object.
+ *
+ * @param hexString A hex string like "#ffffff" or "ffffff". (The "#" character is optional.)
+ */
+export declare function hexToKColor(hexString: string, alpha: float): KColor;
+/**
+ * Helper function to return an array with the elements from start to end, inclusive. (The "i"
+ * stands for inclusive.)
+ *
+ * For example, `irange(1, 3)` will return `[1, 2, 3]`.
+ *
+ * If only one argument is specified, then it will assume that the start is 0.
+ */
+export declare function irange(start: int, end?: int): int[];
+export declare function isPrimitive(variable: unknown): boolean;
+/**
+ * Since this is a UI element, we do not want to draw it in water reflections. `renderOffset` will
+ * be a non-zero value in reflections.
+ */
+export declare function isReflectionRender(): boolean;
+/**
+ * Helper function to print something to the in-game console. Use this instead of invoking the
+ * `Isaac.ConsoleOutput` method directly because it will automatically insert a newline at the end
+ * of the message (which `Isaac.ConsoleOutput` does not do by default).
+ */
+export declare function printConsole(msg: string): void;
+/** Helper function to print whether something was enabled or disabled to the in-game console. */
+export declare function printEnabled(enabled: boolean, description: string): void;
+/**
+ * Helper function to repeat code N times. This is faster to type and cleaner than using a for loop.
+ *
+ * For example:
+ *
+ * ```ts
+ * const player = Isaac.GetPlayer();
+ * repeat(10, () => {
+ *   player.AddCollectible(CollectibleType.STEVEN);
+ * });
+ * ```
+ *
+ * The repeated function is passed the index of the iteration, if needed:
+ *
+ * ```ts
+ * repeat(3, (i) => {
+ *   print(i); // Prints "0", "1", "2"
+ * });
+ * ```
+ */
+export declare function repeat(n: int, func: (i: int) => void): void;
+/**
+ * Helper function to signify that the enclosing code block is not yet complete. Using this function
+ * is similar to writing a "TODO" comment, but it has the benefit of preventing ESLint errors due to
+ * early returns.
+ *
+ * When you see this function, it simply means that the programmer intends to add in more code to
+ * this spot later.
+ *
+ * This function does not actually do anything. (It is an "empty" function.)
+ */
+export declare function todo(): void;