isaacscript-common 73.1.0 → 74.0.0

package/dist/functions/trinkets.lua

@@ -0,0 +1,176 @@
+local ____exports = {}
+local GOLDEN_TRINKET_ADJUSTMENT
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local TrinketType = ____isaac_2Dtypescript_2Ddefinitions.TrinketType
+local ____cachedClasses = require("core.cachedClasses")
+local itemConfig = ____cachedClasses.itemConfig
+local ____constants = require("core.constants")
+local BLIND_ITEM_PNG_PATH = ____constants.BLIND_ITEM_PNG_PATH
+local ____constantsFirstLast = require("core.constantsFirstLast")
+local LAST_VANILLA_TRINKET_TYPE = ____constantsFirstLast.LAST_VANILLA_TRINKET_TYPE
+local ____MysteriousPaperEffect = require("enums.MysteriousPaperEffect")
+local MysteriousPaperEffect = ____MysteriousPaperEffect.MysteriousPaperEffect
+local ____trinketDescriptions = require("objects.trinketDescriptions")
+local DEFAULT_TRINKET_DESCRIPTION = ____trinketDescriptions.DEFAULT_TRINKET_DESCRIPTION
+local TRINKET_DESCRIPTIONS = ____trinketDescriptions.TRINKET_DESCRIPTIONS
+local ____trinketNames = require("objects.trinketNames")
+local DEFAULT_TRINKET_NAME = ____trinketNames.DEFAULT_TRINKET_NAME
+local TRINKET_NAMES = ____trinketNames.TRINKET_NAMES
+local ____entities = require("functions.entities")
+local getEntityID = ____entities.getEntityID
+local ____enums = require("functions.enums")
+local getEnumLength = ____enums.getEnumLength
+local ____flag = require("functions.flag")
+local hasFlag = ____flag.hasFlag
+local ____pickupVariants = require("functions.pickupVariants")
+local isTrinket = ____pickupVariants.isTrinket
+local ____sprites = require("functions.sprites")
+local clearSprite = ____sprites.clearSprite
+local ____types = require("functions.types")
+local asNumber = ____types.asNumber
+function ____exports.isGoldenTrinketType(self, trinketType)
+    return asNumber(nil, trinketType) > GOLDEN_TRINKET_ADJUSTMENT
+end
+function ____exports.isVanillaTrinketType(self, trinketType)
+    return trinketType <= LAST_VANILLA_TRINKET_TYPE
+end
+GOLDEN_TRINKET_ADJUSTMENT = 32768
+local NUM_MYSTERIOUS_PAPER_EFFECTS = getEnumLength(nil, MysteriousPaperEffect)
+local TRINKET_ANM2_PATH = "gfx/005.350_trinket.anm2"
+local TRINKET_SPRITE_LAYER = 0
+--- Helper function to get the corresponding golden trinket type from a normal trinket type.
+-- 
+-- If the provided trinket type is already a golden trinket type, then the trinket type will be
+-- returned unmodified.
+-- 
+-- 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 ____exports.isGoldenTrinketType(nil, trinketType) and trinketType or asNumber(nil, trinketType) + GOLDEN_TRINKET_ADJUSTMENT
+end
+--- Helper function to get the current effect that the Mysterious Paper trinket is providing to the
+-- player. Returns undefined if the player does not have the Mysterious Paper trinket.
+-- 
+-- The Mysterious Paper trinket has four different effects:
+-- 
+-- - The Polaroid (collectible)
+-- - The Negative (collectible)
+-- - A Missing Page (trinket)
+-- - Missing Poster (trinket)
+-- 
+-- It rotates between these four effects on every frame. Note that Mysterious Paper will cause the
+-- `EntityPlayer.HasCollectible` and `EntityPlayer.HasTrinket` methods to return true for the
+-- respective items on the particular frame, with the exception of the Missing Poster. (The player
+-- will never "have" the Missing Poster, even on the correct corresponding frame.)
+-- 
+-- @param player The player to look at.
+-- @param frameCount Optional. The frame count that corresponds to time the effect will be active.
+-- Default is the current frame.
+function ____exports.getMysteriousPaperEffectForFrame(self, player, frameCount)
+    if frameCount == nil then
+        frameCount = player.FrameCount
+    end
+    if not player:HasTrinket(TrinketType.MYSTERIOUS_PAPER) then
+        return nil
+    end
+    return frameCount % NUM_MYSTERIOUS_PAPER_EFFECTS
+end
+--- Helper function to get the corresponding normal trinket type from a golden trinket type.
+-- 
+-- If the provided trinket type is already a normal trinket type, then the trinket type will be
+-- returned unmodified.
+function ____exports.getNormalTrinketType(self, trinketType)
+    return ____exports.isGoldenTrinketType(nil, trinketType) and asNumber(nil, trinketType) - GOLDEN_TRINKET_ADJUSTMENT or trinketType
+end
+--- Helper function to get the in-game description for a trinket. Returns "Unknown" if the provided
+-- trinket type was not valid.
+-- 
+-- This function works for both vanilla and modded trinkets.
+function ____exports.getTrinketDescription(self, trinketType)
+    local trinketDescription = TRINKET_DESCRIPTIONS[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 path to a trinket PNG file. Returns the path to the question mark
+-- sprite (i.e. from Curse of the Blind) if the provided trinket type was not valid.
+-- 
+-- Note that this does not return the file name, but the full path to the trinket's PNG file. The
+-- function is named "GfxFilename" to correspond to the associated `ItemConfigItem.GfxFileName`
+-- field.
+function ____exports.getTrinketGfxFilename(self, trinketType)
+    local itemConfigItem = itemConfig:GetTrinket(trinketType)
+    if itemConfigItem == nil then
+        return BLIND_ITEM_PNG_PATH
+    end
+    return itemConfigItem.GfxFileName
+end
+--- Helper function to get the name of a trinket. Returns "Unknown" if the provided trinket type is
+-- not valid.
+-- 
+-- This function works for both vanilla and modded trinkets.
+-- 
+-- For example, `getTrinketName(TrinketType.SWALLOWED_PENNY)` would return "Swallowed Penny".
+function ____exports.getTrinketName(self, trinketType)
+    local trinketName = TRINKET_NAMES[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
+function ____exports.isModdedTrinketType(self, trinketType)
+    return not ____exports.isVanillaTrinketType(nil, trinketType)
+end
+--- Helper function to generate a new sprite based on a collectible. If the provided collectible type
+-- is invalid, a sprite with a Curse of the Blind question mark will be returned.
+function ____exports.newTrinketSprite(self, trinketType)
+    local sprite = Sprite()
+    sprite:Load(TRINKET_ANM2_PATH, false)
+    local gfxFileName = ____exports.getTrinketGfxFilename(nil, trinketType)
+    sprite:ReplaceSpritesheet(TRINKET_SPRITE_LAYER, gfxFileName)
+    sprite:LoadGraphics()
+    local defaultAnimation = sprite:GetDefaultAnimation()
+    sprite:Play(defaultAnimation, true)
+    return sprite
+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 the trinket effectively invisible (except for
+-- the shadow underneath it).
+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)
+    else
+        sprite:ReplaceSpritesheet(TRINKET_SPRITE_LAYER, pngPath)
+        sprite:LoadGraphics()
+    end
+end
+--- Helper function to check in the item config if a given trinket has a given cache flag.
+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/dist/functions/tstlClass.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tstlClass.d.ts","sourceRoot":"","sources":["../../src/functions/tstlClass.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AAC3E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAIpD;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,OAAO,GACd,kBAAkB,CAAC,aAAa,CAAC,GAAG,SAAS,CAW/C;AAED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAOpE;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAC1B,MAAM,EAAE,OAAO,GACd,MAAM,IAAI,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,CAG1C;AAED,6FAA6F;AAC7F,wBAAgB,WAAW,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,SAAS,CAGhE;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAG5E;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,GAAG,CAAC,SAAS,CAAC,CAGnE;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,SAAS,GAAG,SAAS,CAgB3D"}

package/dist/functions/tstlClass.lua

@@ -0,0 +1,78 @@
+local ____exports = {}
+local ____types = require("functions.types")
+local isTable = ____types.isTable
+local ____utils = require("functions.utils")
+local assertDefined = ____utils.assertDefined
+--- Helper function to get the constructor from an instantiated TypeScriptToLua class, which is
+-- located on the metatable.
+-- 
+-- Returns undefined if passed a non-table or if the provided table does not have a metatable.
+function ____exports.getTSTLClassConstructor(self, object)
+    if not isTable(nil, object) then
+        return nil
+    end
+    local metatable = getmetatable(object)
+    if metatable == nil then
+        return nil
+    end
+    return metatable.constructor
+end
+--- Helper function to get the name of a TypeScriptToLua class from the instantiated class object.
+-- 
+-- TSTL classes are Lua tables created with the `__TS__Class` Lua function from the TSTL lualib.
+-- Their name is contained within "constructor.name" metatable key.
+-- 
+-- For example, a `Map` class is has a name of "Map".
+-- 
+-- Returns undefined if passed a non-table or if the provided table does not have a metatable.
+function ____exports.getTSTLClassName(self, object)
+    local constructor = ____exports.getTSTLClassConstructor(nil, object)
+    if constructor == nil then
+        return nil
+    end
+    return constructor.name
+end
+--- Helper function to determine if a given object is a TypeScriptToLua `Map`.
+-- 
+-- It is not reliable to use the `instanceof` operator to determine this because each Lua module has
+-- their own copies of the entire lualib and thus their own instantiated version of a `Map`.
+function ____exports.isDefaultMap(self, object)
+    local className = ____exports.getTSTLClassName(nil, object)
+    return className == "DefaultMap"
+end
+--- Helper function to check if a given table is a class table created by TypeScriptToLua.
+function ____exports.isTSTLClass(self, object)
+    local tstlClassName = ____exports.getTSTLClassName(nil, object)
+    return tstlClassName ~= nil
+end
+--- Helper function to determine if a given object is a TypeScriptToLua `Map`.
+-- 
+-- It is not reliable to use the `instanceof` operator to determine this because each Lua module
+-- might have their own copy of the entire lualib and thus their own instantiated version of a
+-- `Map`.
+function ____exports.isTSTLMap(self, object)
+    local className = ____exports.getTSTLClassName(nil, object)
+    return className == "Map"
+end
+--- Helper function to determine if a given object is a TypeScriptToLua `Set`.
+-- 
+-- It is not reliable to use the `instanceof` operator to determine this because each Lua module
+-- might have their own copy of the entire lualib and thus their own instantiated version of a
+-- `Set`.
+function ____exports.isTSTLSet(self, object)
+    local className = ____exports.getTSTLClassName(nil, object)
+    return className == "Set"
+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 constructor = ____exports.getTSTLClassConstructor(nil, oldClass)
+    assertDefined(nil, constructor, "Failed to instantiate a new TypeScriptToLua class since the provided old class does not have a metatable/constructor.")
+    local newClass = {}
+    local newClassMetatable = setmetatable(newClass, constructor.prototype)
+    newClassMetatable:____constructor()
+    return newClass
+end
+return ____exports

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/functions/types.ts"],"names":[],"mappings":";;AAAA,OAAO,KAAK,EACV,QAAQ,EACR,eAAe,EACf,UAAU,EACV,QAAQ,EACR,SAAS,EACT,UAAU,EACV,UAAU,EACV,QAAQ,EACR,WAAW,EACZ,MAAM,8BAA8B,CAAC;AAEtC;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,GAAG,QAAQ,CAE7C;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,GAAG,GAAG,eAAe,CAE3D;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAE1C;AAED;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAEtC;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,UAAU,CAEjD;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,GAAG,QAAQ,CAE7C;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE5C;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,GAAG,GAAG,SAAS,CAE/C;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,UAAU,CAEjD;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,UAAU,CAEjD;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,GAAG,QAAQ,CAE7C;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE5C;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,GAAG,GAAG,WAAW,CAEnD;AAED,wBAAgB,SAAS,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,OAAO,CAEhE;AAGD,wBAAgB,UAAU,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,QAAQ,CAElE;AAED,wBAAgB,SAAS,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,GAAG,CAM5D;AAED,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,MAAM,CAE9D;AAED,+EAA+E;AAC/E,wBAAgB,WAAW,CACzB,QAAQ,EAAE,OAAO,GAChB,QAAQ,IAAI,OAAO,GAAG,MAAM,GAAG,MAAM,CAOvC;AAED,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,MAAM,CAE9D;AAED,wBAAgB,OAAO,CACrB,QAAQ,EAAE,OAAO,GAChB,QAAQ,IAAI,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,CAExC;AAED,wBAAgB,UAAU,CAAC,QAAQ,EAAE,OAAO,GAAG,QAAQ,IAAI,WAAW,CAErE"}

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

@@ -0,0 +1 @@
+{"version":3,"file":"ui.d.ts","sourceRoot":"","sources":["../../src/functions/ui.ts"],"names":[],"mappings":";;;AAKA;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,IAAI,QAAQ,CAAC,MAAM,CAAC,CAmBrD;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,YAAY,GAAG,GAAG,CAa3D;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,IAAI,GAAG,CAgCtC;AAED,wBAAgB,wBAAwB,IAAI,QAAQ,CAAC,MAAM,CAAC,CAG3D;AAED,wBAAgB,sBAAsB,IAAI,QAAQ,CAAC,MAAM,CAAC,CAGzD;AAED,wBAAgB,uBAAuB,IAAI,QAAQ,CAAC,MAAM,CAAC,CAK1D;AAED,wBAAgB,gBAAgB,IAAI,KAAK,CAGxC;AAED,wBAAgB,kBAAkB,IAAI,QAAQ,CAAC,MAAM,CAAC,CAGrD;AAED,wBAAgB,eAAe,IAAI,KAAK,CAGvC;AAED,wBAAgB,qBAAqB,IAAI,QAAQ,CAAC,MAAM,CAAC,CAGxD;AAED,wBAAgB,mBAAmB,IAAI,QAAQ,CAAC,MAAM,CAAC,CAEtD;AAED,wBAAgB,oBAAoB,IAAI,QAAQ,CAAC,MAAM,CAAC,CAGvD;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,YAAY,GAAG,GAAG,CAa1D"}

package/dist/functions/ui.lua

@@ -0,0 +1,127 @@
+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("core.cachedClasses")
+local game = ____cachedClasses.game
+local ____constants = require("core.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 (which gets written to the
+-- `HudOffset` attribute in the "options.ini" file). This function uses the current HUD offset to
+-- generate a vector that should be added to the corresponding position that you want to draw a UI
+-- element at.
+-- 
+-- For example:
+-- - If the user does not have a HUD offset configured, this function will return `Vector(0, 0)`.
+-- - If the user has a HUD offset of 1.0 configured, this function will return `Vector(20, 12)`.
+function ____exports.getHUDOffsetVector(self)
+    local hudOffset = math.floor(Options.HUDOffset * 10)
+    if hudOffset < 1 or hudOffset > 10 then
+        return copyVector(nil, VectorZero)
+    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 brokenHearts = player:GetBrokenHearts()
+    local combinedHearts = maxHearts + soulHearts + boneHearts * 2 + brokenHearts * 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 `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.getScreenBottomCenterPos(self)
+    local bottomRightPos = ____exports.getScreenBottomRightPos(nil)
+    return Vector(bottomRightPos.X / 2, bottomRightPos.Y)
+end
+function ____exports.getScreenBottomLeftPos(self)
+    local bottomRightPos = ____exports.getScreenBottomRightPos(nil)
+    return Vector(0, bottomRightPos.Y)
+end
+function ____exports.getScreenBottomY(self)
+    local bottomRightPos = ____exports.getScreenBottomRightPos(nil)
+    return bottomRightPos.Y
+end
+function ____exports.getScreenCenterPos(self)
+    local bottomRightPos = ____exports.getScreenBottomRightPos(nil)
+    return bottomRightPos / 2
+end
+function ____exports.getScreenRightX(self)
+    local bottomRightPos = ____exports.getScreenBottomRightPos(nil)
+    return bottomRightPos.X
+end
+function ____exports.getScreenTopCenterPos(self)
+    local bottomRightPos = ____exports.getScreenBottomRightPos(nil)
+    return Vector(bottomRightPos.X / 2, 0)
+end
+function ____exports.getScreenTopLeftPos(self)
+    return copyVector(nil, VectorZero)
+end
+function ____exports.getScreenTopRightPos(self)
+    local bottomRightPos = ____exports.getScreenBottomRightPos(nil)
+    return Vector(bottomRightPos.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/dist/functions/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/functions/utils.ts"],"names":[],"mappings":";AAIA;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAC7B,KAAK,EAAE,CAAC,EACR,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,GAC7B,CAAC,MAAM,CAAC,GACR;IACE,iFAAiF;CAClF,GACJ,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,CAAC,EAAE,SAAS,CAAC,CAIxC;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAC7B,KAAK,EAAE,CAAC,EACR,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,GACxB,CAAC,MAAM,CAAC,GACR;IACE,4EAA4E;CAC7E,GACJ,OAAO,CAAC,KAAK,IAAI,OAAO,CAAC,CAAC,EAAE,IAAI,CAAC,CAInC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,GAAG,EAAE,SAAS,SAAI,GAAG,GAAG,EAAE,CAkBlE;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CACrC,GAAG,EAAE,OAAO,EACZ,oBAAoB,EAAE,MAAM,GAC3B,MAAM,CAQR;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,GAAG,EAAE,SAAS,SAAI,GAAG,GAAG,EAAE,CAQlE;AAED;;;;;;;;;GASG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,GAAG,OAAO,CAE/D;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,IAAI,OAAO,CAMvC;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,IAAI,OAAO,CAiBtC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAI7D;AAED;;;;;;;;;;;;;;GAcG;AAEH,wBAAgB,IAAI,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAG"}

package/dist/functions/utils.lua

@@ -0,0 +1,202 @@
+local ____lualib = require("lualib_bundle")
+local __TS__ArrayMap = ____lualib.__TS__ArrayMap
+local __TS__New = ____lualib.__TS__New
+local ____exports = {}
+local ____ReadonlySet = require("types.ReadonlySet")
+local ReadonlySet = ____ReadonlySet.ReadonlySet
+local ____playerIndex = require("functions.playerIndex")
+local getAllPlayers = ____playerIndex.getAllPlayers
+local ____types = require("functions.types")
+local isFunction = ____types.isFunction
+--- Helper function to throw an error (using the `error` Lua function) if the provided value is equal
+-- to `undefined`.
+-- 
+-- This is useful to have TypeScript narrow a `T | undefined` value to `T` in a concise way.
+function ____exports.assertDefined(self, value, ...)
+    local ____bindingPattern0 = {...}
+    local msg
+    msg = ____bindingPattern0[1]
+    if value == nil then
+        error(msg)
+    end
+end
+--- Helper function to throw an error (using the `error` Lua function) if the provided value is equal
+-- to `null`.
+-- 
+-- This is useful to have TypeScript narrow a `T | null` value to `T` in a concise way.
+function ____exports.assertNotNull(self, value, ...)
+    local ____bindingPattern0 = {...}
+    local msg
+    msg = ____bindingPattern0[1]
+    if value == nil then
+        error(msg)
+    end
+end
+--- Helper function to return an array of integers with the specified range, inclusive on the lower
+-- end and exclusive on the high end. (The "e" in the function name stands for exclusive.) Thus,
+-- this function works in a similar way as the built-in `range` function from Python.
+-- 
+-- If the end is lower than the start, then the range will be reversed.
+-- 
+-- For example:
+-- 
+-- - `eRange(2)` returns `[0, 1]`.
+-- - `eRange(3)` returns `[0, 1, 2]`.
+-- - `eRange(-3)` returns `[0, -1, -2]`.
+-- - `eRange(1, 3)` returns `[1, 2]`.
+-- - `eRange(2, 5)` returns `[2, 3, 4]`.
+-- - `eRange(5, 2)` returns `[5, 4, 3]`.
+-- 
+-- @param start The integer to start at.
+-- @param end Optional. The integer to end at. If not specified, then the start will be 0 and the
+-- first argument will be the end.
+-- @param increment Optional. The increment to use. Default is 1.
+function ____exports.eRange(self, start, ____end, increment)
+    if increment == nil then
+        increment = 1
+    end
+    if ____end == nil then
+        return ____exports.eRange(nil, 0, start, increment)
+    end
+    local array = {}
+    if start < ____end then
+        do
+            local i = start
+            while i < ____end do
+                array[#array + 1] = i
+                i = i + increment
+            end
+        end
+    else
+        do
+            local i = start
+            while i > ____end do
+                array[#array + 1] = i
+                i = i - increment
+            end
+        end
+    end
+    return array
+end
+--- Helper function to log what is happening in functions that recursively move through nested data
+-- structures.
+function ____exports.getTraversalDescription(self, key, traversalDescription)
+    if traversalDescription ~= "" then
+        traversalDescription = traversalDescription .. " --> "
+    end
+    traversalDescription = traversalDescription .. tostring(key)
+    return traversalDescription
+end
+--- Helper function to return an array of integers with the specified range, inclusive on both ends.
+-- (The "i" in the function name stands for inclusive.)
+-- 
+-- If the end is lower than the start, then the range will be reversed.
+-- 
+-- For example:
+-- 
+-- - `iRange(2)` returns `[0, 1, 2]`.
+-- - `iRange(3)` returns `[0, 1, 2, 3]`.
+-- - `iRange(-3)` returns `[0, -1, -2, -3]`.
+-- - `iRange(1, 3)` returns `[1, 2, 3]`.
+-- - `iRange(2, 5)` returns `[2, 3, 4, 5]`.
+-- - `iRange(5, 2)` returns `[5, 4, 3, 2]`.
+-- 
+-- @param start The integer to start at.
+-- @param end Optional. The integer to end at. If not specified, then the start will be 0 and the
+-- first argument will be the end.
+-- @param increment Optional. The increment to use. Default is 1.
+function ____exports.iRange(self, start, ____end, increment)
+    if increment == nil then
+        increment = 1
+    end
+    if ____end == nil then
+        return ____exports.iRange(nil, 0, start, increment)
+    end
+    local rangeIncreasing = start <= ____end
+    local exclusiveEnd = rangeIncreasing and ____end + 1 or ____end - 1
+    return ____exports.eRange(nil, start, exclusiveEnd, increment)
+end
+--- Helper function to check if a variable is within a certain range, inclusive on both ends.
+-- 
+-- - For example, `inRange(1, 1, 3)` will return `true`.
+-- - For example, `inRange(0, 1, 3)` will return `false`.
+-- 
+-- @param num The number to check.
+-- @param start The start of the range to check.
+-- @param end The end of the range to check.
+function ____exports.inRange(self, num, start, ____end)
+    return num >= start and num <= ____end
+end
+--- Helper function to detect if there is two or more players currently playing.
+-- 
+-- Specifically, this function looks for unique `ControllerIndex` values across all players.
+-- 
+-- This function is not safe to use in the `POST_PLAYER_INIT` callback, because the
+-- `ControllerIndex` will not be set properly. As a workaround, you can use it in the
+-- `POST_PLAYER_INIT_FIRST` callback (or some other callback like `POST_UPDATE`).
+function ____exports.isMultiplayer(self)
+    local players = getAllPlayers(nil)
+    local controllerIndexes = __TS__ArrayMap(
+        players,
+        function(____, player) return player.ControllerIndex end
+    )
+    local controllerIndexesSet = __TS__New(ReadonlySet, controllerIndexes)
+    return controllerIndexesSet.size > 1
+end
+--- Helper function to check if the player is using Afterbirth+ or Repentance.
+-- 
+-- This function should always be used over the `REPENTANCE` constant, since the latter is not safe.
+-- 
+-- Specifically, this function checks for the `Sprite.GetAnimation` method:
+-- https://bindingofisaacrebirth.fandom.com/wiki/V1.06.J818#Lua_Changes
+function ____exports.isRepentance(self)
+    local metatable = getmetatable(Sprite)
+    ____exports.assertDefined(nil, metatable, "Failed to get the metatable of the Sprite global table.")
+    local classTable = metatable.__class
+    ____exports.assertDefined(nil, classTable, "Failed to get the \"__class\" key of the Sprite metatable.")
+    local getAnimation = classTable.GetAnimation
+    return isFunction(nil, getAnimation)
+end
+--- 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"
+-- });
+-- ```
+____exports["repeat"] = function(self, num, func)
+    do
+        local i = 0
+        while i < num do
+            func(nil, i)
+            i = i + 1
+        end
+    end
+end
+--- 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
+-- unused variables or 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 is variadic, meaning that you can pass as many arguments as you want. (This is
+-- useful as a means to prevent unused variables.)
+-- 
+-- This function does not actually do anything. (It is an "empty" function.)
+-- 
+-- @allowEmptyVariadic
+function ____exports.todo(self, ...)
+end
+return ____exports

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

@@ -0,0 +1 @@
+{"version":3,"file":"vector.d.ts","sourceRoot":"","sources":["../../src/functions/vector.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EACV,yBAAyB,EACzB,SAAS,EACV,MAAM,8BAA8B,CAAC;AActC,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IACvD,QAAQ,CAAC,uBAAuB,EAAE,MAAM,CAAC;IACzC,QAAQ,CAAC,MAAM,EAAE,yBAAyB,CAAC,MAAM,CAAC;CACnD,CAAC;AAKF,0DAA0D;AAC1D,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAQjD;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,gBAAgB,GAAG,MAAM,CAmBlE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,MAAM,EACd,SAAS,SAAO,GACf,OAAO,CAET;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAChC,eAAe,EAAE,MAAM,EACvB,OAAO,EAAE,MAAM,EAAE,GAChB,MAAM,GAAG,SAAS,CAapB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,eAAe,CAC7B,SAAS,EAAE,IAAI,GAAG,GAAG,GAAG,SAAS,GAChC,QAAQ,CAAC,MAAM,CAAC,CAOlB;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,OAAO,GACd,MAAM,IAAI,gBAAgB,CAM5B;AAED,gFAAgF;AAChF,wBAAgB,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,MAAM,CAE1D;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAWhE;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAEtE;AAED,sEAAsE;AACtE,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAG3D;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,UAAQ,GAAG,MAAM,CAIpE"}