isaacscript-common 1.2.174 → 1.2.177

package/dist/functions/rooms.lua

@@ -1,4 +1,3 @@
---[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____lualib = require("lualib_bundle")
 local __TS__ArrayMap = ____lualib.__TS__ArrayMap
 local Set = ____lualib.Set
@@ -30,38 +29,13 @@ local getEntityPositions = ____positionVelocity.getEntityPositions
 local getEntityVelocities = ____positionVelocity.getEntityVelocities
 local setEntityPositions = ____positionVelocity.setEntityPositions
 local setEntityVelocities = ____positionVelocity.setEntityVelocities
-function ____exports.getCurrentRoomDescriptorReadOnly(self)
-    local level = game:GetLevel()
-    return level:GetCurrentRoomDesc()
-end
-function ____exports.getRoomData(self, roomGridIndex)
-    local roomDescriptor = ____exports.getRoomDescriptor(nil, roomGridIndex)
-    return roomDescriptor.Data
-end
-function ____exports.getRoomDescriptor(self, roomGridIndex)
-    local level = game:GetLevel()
-    if roomGridIndex == nil then
-        roomGridIndex = ____exports.getRoomGridIndex(nil)
-    end
-    return level:GetRoomByIdx(roomGridIndex)
-end
-function ____exports.getRoomGridIndex(self)
-    local level = game:GetLevel()
-    local currentRoomIndex = level:GetCurrentRoomIndex()
-    if currentRoomIndex < 0 then
-        return currentRoomIndex
-    end
-    local roomDescriptor = ____exports.getCurrentRoomDescriptorReadOnly(nil)
-    return roomDescriptor.SafeGridIndex
-end
-function ____exports.getRoomStageID(self, roomGridIndex)
-    local roomData = ____exports.getRoomData(nil, roomGridIndex)
-    return roomData == nil and -1 or roomData.StageID
-end
-function ____exports.getRoomSubType(self, roomGridIndex)
-    local roomData = ____exports.getRoomData(nil, roomGridIndex)
-    return roomData == nil and -1 or roomData.Subtype
-end
+local ____roomData = require("functions.roomData")
+local getCurrentRoomDescriptorReadOnly = ____roomData.getCurrentRoomDescriptorReadOnly
+local getRoomData = ____roomData.getRoomData
+local getRoomDescriptor = ____roomData.getRoomDescriptor
+local getRoomGridIndex = ____roomData.getRoomGridIndex
+local getRoomStageID = ____roomData.getRoomStageID
+local getRoomSubType = ____roomData.getRoomSubType
 function ____exports.getRooms(self, includeExtraDimensionalRooms)
     if includeExtraDimensionalRooms == nil then
         includeExtraDimensionalRooms = false
@@ -95,13 +69,13 @@ function ____exports.getRooms(self, includeExtraDimensionalRooms)
     return rooms
 end
 function ____exports.inDeathCertificateArea(self)
-    local roomStageID = ____exports.getRoomStageID(nil)
-    local roomSubType = ____exports.getRoomSubType(nil)
+    local roomStageID = getRoomStageID(nil)
+    local roomSubType = getRoomSubType(nil)
     return roomStageID == 35 and (roomSubType == 33 or roomSubType == 34)
 end
 function ____exports.changeRoom(self, roomGridIndex)
     local level = game:GetLevel()
-    local roomData = ____exports.getRoomData(nil, roomGridIndex)
+    local roomData = getRoomData(nil, roomGridIndex)
     if roomData == nil then
         error(("Failed to change the room to grid index " .. tostring(roomGridIndex)) .. " because that room does not exist.")
     end
@@ -132,10 +106,6 @@ function ____exports.getCurrentDimension(self)
     end
     return error("Failed to get the current dimension using the starting room index of: " .. tostring(startingRoomGridIndex))
 end
-function ____exports.getRoomType(self, roomGridIndex)
-    local roomData = ____exports.getRoomData(nil, roomGridIndex)
-    return roomData == nil and -1 or roomData.Type
-end
 function ____exports.getRoomGridIndexesForType(self, ...)
     local roomTypesSet = __TS__New(Set, {...})
     local rooms = ____exports.getRooms(nil)
@@ -155,22 +125,6 @@ function ____exports.getRoomItemPoolType(self)
     local roomSeed = room:GetSpawnSeed()
     return itemPool:GetPoolForRoom(roomType, roomSeed)
 end
-function ____exports.getRoomListIndex(self, roomGridIndex)
-    local roomDescriptor = ____exports.getRoomDescriptor(nil, roomGridIndex)
-    return roomDescriptor.ListIndex
-end
-function ____exports.getRoomName(self, roomGridIndex)
-    local roomData = ____exports.getRoomData(nil, roomGridIndex)
-    return roomData == nil and "Unknown" or roomData.Name
-end
-function ____exports.getRoomVariant(self, roomGridIndex)
-    local roomData = ____exports.getRoomData(nil, roomGridIndex)
-    return roomData == nil and -1 or roomData.Variant
-end
-function ____exports.getRoomVisitedCount(self, roomGridIndex)
-    local roomDescriptor = ____exports.getRoomDescriptor(nil, roomGridIndex)
-    return roomDescriptor.VisitedCount
-end
 function ____exports.gridToPos(self, x, y)
     local room = game:GetRoom()
     x = x + 1
@@ -186,63 +140,63 @@ end
 function ____exports.inAngelShop(self)
     local room = game:GetRoom()
     local roomType = room:GetType()
-    local roomSubType = ____exports.getRoomSubType(nil)
+    local roomSubType = getRoomSubType(nil)
     return roomType == RoomType.ROOM_ANGEL and roomSubType == 1
 end
 function ____exports.inBeastRoom(self)
     local room = game:GetRoom()
     local roomType = room:GetType()
-    local roomSubType = ____exports.getRoomSubType(nil)
+    local roomSubType = getRoomSubType(nil)
     return roomType == RoomType.ROOM_DUNGEON and roomSubType == 4
 end
 function ____exports.inBossRoomOf(self, bossID)
     local room = game:GetRoom()
     local roomType = room:GetType()
-    local roomStageID = ____exports.getRoomStageID(nil)
-    local roomSubType = ____exports.getRoomSubType(nil)
+    local roomStageID = getRoomStageID(nil)
+    local roomSubType = getRoomSubType(nil)
     return roomType == RoomType.ROOM_BOSS and roomStageID == 0 and roomSubType == bossID
 end
 function ____exports.inCrawlspace(self)
     local room = game:GetRoom()
     local roomType = room:GetType()
-    local roomSubType = ____exports.getRoomSubType(nil)
+    local roomSubType = getRoomSubType(nil)
     return roomType == RoomType.ROOM_DUNGEON and roomSubType == 0
 end
 function ____exports.inDevilsCrownTreasureRoom(self)
-    local roomDescriptor = ____exports.getCurrentRoomDescriptorReadOnly(nil)
+    local roomDescriptor = getCurrentRoomDescriptorReadOnly(nil)
     return hasFlag(nil, roomDescriptor.Flags, 2048)
 end
 function ____exports.inDimension(self, dimension)
     return dimension == ____exports.getCurrentDimension(nil)
 end
+function ____exports.inGenesisRoom(self)
+    local roomGridIndex = getRoomGridIndex(nil)
+    return roomGridIndex == GridRooms.ROOM_GENESIS_IDX
+end
 function ____exports.inLRoom(self)
     local room = game:GetRoom()
     local roomShape = room:GetRoomShape()
     return roomShape == RoomShape.ROOMSHAPE_LTL or roomShape == RoomShape.ROOMSHAPE_LTR or roomShape == RoomShape.ROOMSHAPE_LBL or roomShape == RoomShape.ROOMSHAPE_LBR
 end
-function ____exports.inGenesisRoom(self)
-    local roomGridIndex = ____exports.getRoomGridIndex(nil)
-    return roomGridIndex == GridRooms.ROOM_GENESIS_IDX
-end
 function ____exports.inMegaSatanRoom(self)
-    local roomGridIndex = ____exports.getRoomGridIndex(nil)
+    local roomGridIndex = getRoomGridIndex(nil)
     return roomGridIndex == GridRooms.ROOM_MEGA_SATAN_IDX
 end
 function ____exports.inMinibossRoomOf(self, minibossID)
     local room = game:GetRoom()
     local roomType = room:GetType()
-    local roomStageID = ____exports.getRoomStageID(nil)
-    local roomSubType = ____exports.getRoomSubType(nil)
+    local roomStageID = getRoomStageID(nil)
+    local roomSubType = getRoomSubType(nil)
     return roomType == RoomType.ROOM_MINIBOSS and roomStageID == 0 and roomSubType == minibossID
 end
 function ____exports.inSecretShop(self)
-    local roomGridIndex = ____exports.getRoomGridIndex(nil)
+    local roomGridIndex = getRoomGridIndex(nil)
     return roomGridIndex == GridRooms.ROOM_SECRET_SHOP_IDX
 end
 function ____exports.inStartingRoom(self)
     local level = game:GetLevel()
     local startingRoomGridIndex = level:GetStartingRoomIndex()
-    local roomGridIndex = ____exports.getRoomGridIndex(nil)
+    local roomGridIndex = getRoomGridIndex(nil)
     return roomGridIndex == startingRoomGridIndex and ____exports.inDimension(nil, 0)
 end
 function ____exports.isAllRoomsClear(self, onlyCheckRoomTypes)
@@ -264,12 +218,12 @@ function ____exports.isAllRoomsClear(self, onlyCheckRoomTypes)
     )
 end
 function ____exports.isRedKeyRoom(self, roomGridIndex)
-    local roomDescriptor = ____exports.getRoomDescriptor(nil, roomGridIndex)
+    local roomDescriptor = getRoomDescriptor(nil, roomGridIndex)
     return hasFlag(nil, roomDescriptor.Flags, 1024)
 end
 function ____exports.isRoomInsideMap(self, roomGridIndex)
     if roomGridIndex == nil then
-        roomGridIndex = ____exports.getRoomGridIndex(nil)
+        roomGridIndex = getRoomGridIndex(nil)
     end
     return roomGridIndex >= 0
 end
@@ -292,12 +246,12 @@ function ____exports.setRoomCleared(self)
     for ____, door in ipairs(getDoors(nil)) do
         do
             if isHiddenSecretRoomDoor(nil, door) then
-                goto __continue59
+                goto __continue46
             end
             openDoorFast(nil, door)
             door.ExtraVisible = false
         end
-        ::__continue59::
+        ::__continue46::
     end
     sfxManager:Stop(SoundEffect.SOUND_DOOR_HEAVY_OPEN)
     game:ShakeScreen(0)
@@ -315,7 +269,7 @@ function ____exports.teleport(self, roomGridIndex, direction, roomTransitionAnim
         roomTransitionAnim = RoomTransitionAnim.TELEPORT
     end
     local level = game:GetLevel()
-    local roomData = ____exports.getRoomData(nil, roomGridIndex)
+    local roomData = getRoomData(nil, roomGridIndex)
     if roomData == nil then
         error(("Failed to change the room to grid index " .. tostring(roomGridIndex)) .. " because that room does not exist.")
     end

package/dist/functions/set.d.ts

@@ -6,14 +6,14 @@
  * This function is variadic, meaning that you can specify N sets to add to the first set.
  */
 export declare function addSetsToSet<T>(mainSet: Set<T>, ...setsToAdd: Array<Set<T> | ReadonlySet<T>>): void;
-/** Helper function to copy a set. (You can also use a Set constructor to accomplish this task.) */
-export declare function copySet<T>(oldSet: Set<T> | ReadonlySet<T>): Set<T>;
 /**
  * Helper function to create a new set that is the composition of two or more sets.
  *
  * This function is variadic, meaning that you can specify N sets.
  */
 export declare function combineSets<T>(...sets: Array<Set<T> | ReadonlySet<T>>): Set<T>;
+/** Helper function to copy a set. (You can also use a Set constructor to accomplish this task.) */
+export declare function copySet<T>(oldSet: Set<T> | ReadonlySet<T>): Set<T>;
 /**
  * Helper function to delete all of the values in one set from another set. The first set passed
  * will be modified in place.

package/dist/functions/set.lua

@@ -1,4 +1,3 @@
---[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____lualib = require("lualib_bundle")
 local Set = ____lualib.Set
 local __TS__Iterator = ____lualib.__TS__Iterator
@@ -22,13 +21,6 @@ function ____exports.addSetsToSet(self, mainSet, ...)
         end
     end
 end
-function ____exports.copySet(self, oldSet)
-    local newSet = __TS__New(Set)
-    for ____, value in __TS__Iterator(oldSet:values()) do
-        newSet:add(value)
-    end
-    return newSet
-end
 function ____exports.combineSets(self, ...)
     local sets = {...}
     local newSet = __TS__New(Set)
@@ -39,6 +31,13 @@ function ____exports.combineSets(self, ...)
     end
     return newSet
 end
+function ____exports.copySet(self, oldSet)
+    local newSet = __TS__New(Set)
+    for ____, value in __TS__Iterator(oldSet:values()) do
+        newSet:add(value)
+    end
+    return newSet
+end
 function ____exports.deleteSetsFromSet(self, mainSet, ...)
     local setsToRemove = {...}
     for ____, set in ipairs(setsToRemove) do

package/dist/functions/string.lua

@@ -1,4 +1,3 @@
---[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____lualib = require("lualib_bundle")
 local __TS__StringStartsWith = ____lualib.__TS__StringStartsWith
 local __TS__StringSlice = ____lualib.__TS__StringSlice

package/dist/functions/transformations.lua

@@ -1,4 +1,3 @@
---[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____lualib = require("lualib_bundle")
 local Map = ____lualib.Map
 local __TS__New = ____lualib.__TS__New

package/dist/functions/trinketCacheFlag.d.ts

@@ -1,10 +1,10 @@
 /// <reference types="isaac-typescript-definitions" />
-/**
- * Returns a set containing every trinket type with the given cache flag, including modded trinkets.
- */
-export declare function getTrinketsForCacheFlag(cacheFlag: CacheFlag): Set<TrinketType | int>;
 /**
  * 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, int>;
+/**
+ * Returns a set containing every trinket type with the given cache flag, including modded trinkets.
+ */
+export declare function getTrinketsForCacheFlag(cacheFlag: CacheFlag): Set<TrinketType | int>;

package/dist/functions/trinketCacheFlag.lua

@@ -1,10 +1,10 @@
---[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____lualib = require("lualib_bundle")
 local Map = ____lualib.Map
 local __TS__New = ____lualib.__TS__New
 local Set = ____lualib.Set
 local __TS__Iterator = ____lualib.__TS__Iterator
 local ____exports = {}
+local initCacheFlagMap, CACHE_FLAG_TO_TRINKETS_MAP
 local ____math = require("functions.math")
 local range = ____math.range
 local ____set = require("functions.set")
@@ -14,8 +14,7 @@ local getMaxTrinketType = ____trinkets.getMaxTrinketType
 local trinketHasCacheFlag = ____trinkets.trinketHasCacheFlag
 local ____utils = require("functions.utils")
 local getEnumValues = ____utils.getEnumValues
-local CACHE_FLAG_TO_TRINKETS_MAP = __TS__New(Map)
-local function initCacheFlagMap(self)
+function initCacheFlagMap(self)
     local maxTrinketID = getMaxTrinketType(nil)
     for ____, cacheFlag in ipairs(getEnumValues(nil, CacheFlag)) do
         local trinketsSet = __TS__New(Set)
@@ -37,6 +36,7 @@ function ____exports.getTrinketsForCacheFlag(self, cacheFlag)
     end
     return copySet(nil, trinketsSet)
 end
+CACHE_FLAG_TO_TRINKETS_MAP = __TS__New(Map)
 function ____exports.getPlayerTrinketsForCacheFlag(self, player, cacheFlag)
     local trinketsForCacheFlag = ____exports.getTrinketsForCacheFlag(nil, cacheFlag)
     local playerTrinkets = __TS__New(Map)

package/dist/functions/trinketGive.d.ts

@@ -1,12 +1,18 @@
 /// <reference types="isaac-typescript-definitions" />
 import { TrinketSituation } from "../types/TrinketSituation";
+/**
+ * Helper function to restore the player's trinkets back to the way they were before the
+ * `temporarilyRemoveTrinket` function was used. It will re-smelt any smelted trinkets that were
+ * removed.
+ */
+export declare function giveTrinketsBack(player: EntityPlayer, trinketSituation: TrinketSituation | undefined): void;
 /**
  * Helper function to temporarily remove a specific kind of trinket from the player. Use this in
  * combination with the `giveTrinketBack` function to take away and give back a trinket on the same
  * frame. This function correctly handles multiple trinket slots and ensures that all copies of the
  * trinket are removed, including smelted trinkets.
  *
- * Note that for simplicity, this function assumes that all smelted trinkets are non-golden.
+ * Note that one smelted golden trinket is the same as two smelted normal trinkets.
  *
  * @returns Undefined if the player does not have the trinket, or TrinketSituation if they do.
  */
@@ -19,9 +25,3 @@ export declare function temporarilyRemoveTrinket(player: EntityPlayer, trinketTy
  * @returns Undefined if the player does not have any trinkets, or TrinketSituation if they do.
  */
 export declare function temporarilyRemoveTrinkets(player: EntityPlayer): TrinketSituation | undefined;
-/**
- * Helper function to restore the player's trinkets back to the way they were before the
- * `temporarilyRemoveTrinket` function was used. It will re-smelt any smelted trinkets that were
- * removed.
- */
-export declare function giveTrinketsBack(player: EntityPlayer, trinketSituation: TrinketSituation | undefined): void;

package/dist/functions/trinketGive.lua

@@ -6,6 +6,33 @@ local ____player = require("functions.player")
 local useActiveItemTemp = ____player.useActiveItemTemp
 local ____utils = require("functions.utils")
 local ____repeat = ____utils["repeat"]
+function ____exports.giveTrinketsBack(self, player, trinketSituation)
+    if trinketSituation == nil then
+        return
+    end
+    local trinket1 = player:GetTrinket(0)
+    local trinket2 = player:GetTrinket(1)
+    if trinket1 ~= TrinketType.TRINKET_NULL then
+        player:TryRemoveTrinket(trinket1)
+    end
+    if trinket2 ~= TrinketType.TRINKET_NULL then
+        player:TryRemoveTrinket(trinket2)
+    end
+    ____repeat(
+        nil,
+        trinketSituation.numSmeltedTrinkets,
+        function()
+            player:AddTrinket(trinketSituation.trinketTypeRemoved, false)
+            useActiveItemTemp(nil, player, CollectibleType.COLLECTIBLE_SMELTER)
+        end
+    )
+    if trinketSituation.trinket1 ~= TrinketType.TRINKET_NULL then
+        player:AddTrinket(trinketSituation.trinket1, false)
+    end
+    if trinketSituation.trinket2 ~= TrinketType.TRINKET_NULL then
+        player:AddTrinket(trinketSituation.trinket2, false)
+    end
+end
 function ____exports.temporarilyRemoveTrinket(self, player, trinketType)
     if not player:HasTrinket(trinketType) then
         return nil
@@ -42,31 +69,4 @@ function ____exports.temporarilyRemoveTrinkets(self, player)
     end
     return {trinketTypeRemoved = TrinketType.TRINKET_NULL, trinket1 = trinket1, trinket2 = trinket2, numSmeltedTrinkets = 0}
 end
-function ____exports.giveTrinketsBack(self, player, trinketSituation)
-    if trinketSituation == nil then
-        return
-    end
-    local trinket1 = player:GetTrinket(0)
-    local trinket2 = player:GetTrinket(1)
-    if trinket1 ~= TrinketType.TRINKET_NULL then
-        player:TryRemoveTrinket(trinket1)
-    end
-    if trinket2 ~= TrinketType.TRINKET_NULL then
-        player:TryRemoveTrinket(trinket2)
-    end
-    ____repeat(
-        nil,
-        trinketSituation.numSmeltedTrinkets,
-        function()
-            player:AddTrinket(trinketSituation.trinketTypeRemoved, false)
-            useActiveItemTemp(nil, player, CollectibleType.COLLECTIBLE_SMELTER)
-        end
-    )
-    if trinketSituation.trinket1 ~= TrinketType.TRINKET_NULL then
-        player:AddTrinket(trinketSituation.trinket1, false)
-    end
-    if trinketSituation.trinket2 ~= TrinketType.TRINKET_NULL then
-        player:AddTrinket(trinketSituation.trinket2, false)
-    end
-end
 return ____exports

package/dist/functions/trinketSet.lua

@@ -1,4 +1,3 @@
---[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____lualib = require("lualib_bundle")
 local Set = ____lualib.Set
 local __TS__New = ____lualib.__TS__New

package/dist/functions/trinkets.d.ts

@@ -18,8 +18,6 @@ export declare function getMaxTrinketType(): int;
  * ```
  */
 export declare function getOpenTrinketSlot(player: EntityPlayer): int | undefined;
-/** Helper function to get all of the trinket entities in the room. */
-export declare function getTrinkets(matchingSubType?: number): EntityPickup[];
 /**
  * Helper function to get the in-game description for a trinket. Returns "Unknown" if the provided
  * trinket type was not valid.
@@ -36,6 +34,8 @@ export declare function getTrinketDescription(trinketType: TrinketType | int): s
  * ```
  */
 export declare function getTrinketName(trinketType: TrinketType | int): string;
+/** Helper function to get all of the trinket entities in the room. */
+export declare function getTrinkets(matchingSubType?: number): EntityPickup[];
 /**
  * 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.

package/dist/functions/trinkets.lua

@@ -42,12 +42,6 @@ function ____exports.getOpenTrinketSlot(self, player)
     end
     return error("The player has an unknown number of trinket slots: " .. tostring(maxTrinkets))
 end
-function ____exports.getTrinkets(self, matchingSubType)
-    if matchingSubType == nil then
-        matchingSubType = -1
-    end
-    return getPickups(nil, PickupVariant.PICKUP_TRINKET, matchingSubType)
-end
 function ____exports.getTrinketDescription(self, trinketType)
     local trinketDescription = TRINKET_DESCRIPTION_MAP:get(trinketType)
     if trinketDescription ~= nil then
@@ -70,6 +64,12 @@ function ____exports.getTrinketName(self, trinketType)
     end
     return DEFAULT_TRINKET_NAME
 end
+function ____exports.getTrinkets(self, matchingSubType)
+    if matchingSubType == nil then
+        matchingSubType = -1
+    end
+    return getPickups(nil, PickupVariant.PICKUP_TRINKET, matchingSubType)
+end
 function ____exports.hasOpenTrinketSlot(self, player)
     local character = player:GetPlayerType()
     if character == PlayerType.PLAYER_THESOUL_B then

package/dist/functions/ui.d.ts

@@ -1,15 +1,4 @@
 /// <reference types="isaac-typescript-definitions" />
-/**
- * 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;
-/**
- * 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;
 /**
  * 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
@@ -21,11 +10,22 @@ export declare function getHeartRowLength(player: EntityPlayer): int;
  * a HUD offset that should be added to the position of a UI element.
  */
 export declare function getHUDOffsetVector(): Vector;
-export declare function getScreenTopLeftPos(): Vector;
-export declare function getScreenTopRightPos(): 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.
  *

package/dist/functions/ui.lua

@@ -4,6 +4,27 @@ local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
 local ____constants = require("constants")
 local UI_HEART_WIDTH = ____constants.UI_HEART_WIDTH
+function ____exports.getScreenBottomRightPos(self)
+    local screenWidth = Isaac.GetScreenWidth()
+    local screenHeight = Isaac.GetScreenHeight()
+    return Vector(screenWidth, screenHeight)
+end
+function ____exports.getHUDOffsetVector(self)
+    local defaultVector = Vector.Zero
+    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
 function ____exports.getHeartRowLength(self, player)
     local maxHearts = player:GetMaxHearts()
     local soulHearts = player:GetSoulHearts()
@@ -12,11 +33,6 @@ function ____exports.getHeartRowLength(self, player)
     local heartRowLength = combinedHearts / 2
     return math.min(heartRowLength, 6)
 end
-function ____exports.getScreenBottomRightPos(self)
-    local screenWidth = Isaac.GetScreenWidth()
-    local screenHeight = Isaac.GetScreenHeight()
-    return Vector(screenWidth, screenHeight)
-end
 function ____exports.getHeartsUIWidth(self)
     local level = game:GetLevel()
     local curses = level:GetCurses()
@@ -45,29 +61,6 @@ function ____exports.getHeartsUIWidth(self)
     end
     return width
 end
-function ____exports.getHUDOffsetVector(self)
-    local defaultVector = Vector.Zero
-    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
-function ____exports.getScreenTopLeftPos(self)
-    return Vector.Zero
-end
-function ____exports.getScreenTopRightPos(self)
-    local bottomRight = ____exports.getScreenBottomRightPos(nil)
-    return Vector(bottomRight.X, 0)
-end
 function ____exports.getScreenBottomLeftPos(self)
     local bottomRight = ____exports.getScreenBottomRightPos(nil)
     return Vector(0, bottomRight.Y)
@@ -76,6 +69,13 @@ function ____exports.getScreenCenterPos(self)
     local bottomRight = ____exports.getScreenBottomRightPos(nil)
     return bottomRight / 2
 end
+function ____exports.getScreenTopLeftPos(self)
+    return Vector.Zero
+end
+function ____exports.getScreenTopRightPos(self)
+    local bottomRight = ____exports.getScreenBottomRightPos(nil)
+    return Vector(bottomRight.X, 0)
+end
 function ____exports.getVisibleHearts(self, player)
     local effectiveMaxHearts = player:GetEffectiveMaxHearts()
     local soulHearts = player:GetSoulHearts()

package/dist/functions/utils.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="typescript-to-lua/language-extensions" />
 /// <reference types="isaac-typescript-definitions" />
 /**
  * Helper function to get type safety on a switch statement.
@@ -53,6 +54,11 @@ export declare const ensureAllCases: (obj: never) => never;
  * `pairs` or `Object.values`.
  */
 export declare function getEnumValues<T>(transpiledEnum: T): Array<T[keyof T]>;
+/**
+ * Helper function to log what is happening in functions that recursively move through nested data
+ * structures.
+ */
+export declare function getTraversalDescription(key: AnyNotNil, traversalDescription: string): string;
 /**
  * Converts a hex string like "#33aa33" to a KColor object.
  *

package/dist/functions/utils.lua

@@ -1,4 +1,3 @@
---[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____lualib = require("lualib_bundle")
 local __TS__ArrayPush = ____lualib.__TS__ArrayPush
 local __TS__ArraySort = ____lualib.__TS__ArraySort
@@ -17,6 +16,13 @@ function ____exports.getEnumValues(self, transpiledEnum)
     __TS__ArraySort(enumValues)
     return enumValues
 end
+function ____exports.getTraversalDescription(self, key, traversalDescription)
+    if traversalDescription ~= "" then
+        traversalDescription = traversalDescription .. " --> "
+    end
+    traversalDescription = traversalDescription .. tostring(key)
+    return traversalDescription
+end
 function ____exports.hexToKColor(self, hexString, alpha)
     hexString = __TS__StringReplace(hexString, "#", "")
     if #hexString ~= HEX_STRING_LENGTH then

package/dist/functions/vector.d.ts

@@ -1,5 +1,7 @@
 /// <reference types="isaac-typescript-definitions" />
+/// <reference types="typescript-to-lua/language-extensions" />
 export declare function copyVector(vector: Vector): Vector;
+export declare function deserializeVector(vectorTable: LuaTable): Vector;
 export declare function directionToVector(direction: Direction): Vector;
 /**
  * Helper function to get a new vector of length 1. Using this is safer than using the `Vector.One`

package/dist/functions/vector.lua

@@ -5,6 +5,19 @@ local DIRECTION_TO_VECTOR = ____directionToVector.DIRECTION_TO_VECTOR
 function ____exports.copyVector(self, vector)
     return Vector(vector.X, vector.Y)
 end
+function ____exports.deserializeVector(self, vectorTable)
+    local xString = vectorTable.X
+    local x = tonumber(xString)
+    if x == nil then
+        error("Failed to read the X value of a serialized vector.")
+    end
+    local yString = vectorTable.Y
+    local y = tonumber(yString)
+    if y == nil then
+        error("Failed to read the Y value of a serialized vector.")
+    end
+    return Vector(x, y)
+end
 function ____exports.directionToVector(self, direction)
     return DIRECTION_TO_VECTOR[direction]
 end