isaacscript-common 1.2.230 → 1.2.233

package/dist/callbacks/postCustomDoorEnter.lua

@@ -6,6 +6,8 @@ local ____exports = {}
 local hasSubscriptions, postEffectUpdaterCustomEntity, doorChangedState, getAnimationForCustomDoor, postEffectRenderCustomEntity, isPlayerPastDoorThreshold, roomClearChange, getPositionOffset, POSITION_OFFSET_MULTIPLIER, v
 local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
+local ____constants = require("constants")
+local VectorZero = ____constants.VectorZero
 local ____ModCallbacksCustom = require("enums.ModCallbacksCustom")
 local ModCallbacksCustom = ____ModCallbacksCustom.ModCallbacksCustom
 local ____exports = require("features.saveDataManager.exports")
@@ -185,7 +187,7 @@ function ____exports.spawnCustomDoor(self, effectVariant, doorSlot)
         effectVariant,
         0,
         position,
-        Vector.Zero,
+        VectorZero,
         nil
     ):ToEffect()
     if effect == nil then

package/dist/constants.d.ts

@@ -116,3 +116,5 @@ export declare const TRINKET_ID_MASK = 32767;
  * corner.
  */
 export declare const UI_HEART_WIDTH = 12;
+export declare const VectorOne: ReadonlyVector;
+export declare const VectorZero: ReadonlyVector;

package/dist/constants.lua

@@ -37,4 +37,6 @@ ____exports.TAINTED_SAMSON_BERSERK_CHARGE_FROM_TAKING_DAMAGE = 10000
 ____exports.TRINKET_GOLDEN_FLAG = 32768
 ____exports.TRINKET_ID_MASK = 32767
 ____exports.UI_HEART_WIDTH = 12
+____exports.VectorOne = Vector(1, 1)
+____exports.VectorZero = Vector(0, 0)
 return ____exports

package/dist/features/deployJSONRoom.lua

@@ -10,6 +10,8 @@ local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
 local ____DefaultMap = require("classes.DefaultMap")
 local DefaultMap = ____DefaultMap.DefaultMap
+local ____constants = require("constants")
+local VectorZero = ____constants.VectorZero
 local ____featuresInitialized = require("featuresInitialized")
 local errorIfFeaturesNotInitialized = ____featuresInitialized.errorIfFeaturesNotInitialized
 local ____entity = require("functions.entity")
@@ -39,7 +41,7 @@ local newRNG = ____rng.newRNG
 local ____roomData = require("functions.roomData")
 local getRoomListIndex = ____roomData.getRoomListIndex
 local ____roomGrid = require("functions.roomGrid")
-local gridToPos = ____roomGrid.gridToPos
+local gridCoordinatesToWorldPosition = ____roomGrid.gridCoordinatesToWorldPosition
 local ____rooms = require("functions.rooms")
 local setRoomCleared = ____rooms.setRoomCleared
 local setRoomUncleared = ____rooms.setRoomUncleared
@@ -77,7 +79,7 @@ function respawnPersistentEntities(self)
             persistentEntity.variant,
             persistentEntity.subType,
             position,
-            Vector.Zero,
+            VectorZero,
             nil
         )
     end
@@ -123,7 +125,7 @@ function fillRoomWithDecorations(self)
     local gridSize = room:GetGridSize()
     local roomListIndex = getRoomListIndex(nil)
     local decorationGridIndexes = v.level.roomToDecorationGridIndexesMap:getAndSetDefault(roomListIndex)
-    for ____, gridIndex in ipairs(range(nil, 0, gridSize - 1)) do
+    for ____, gridIndex in ipairs(range(nil, gridSize - 1)) do
         do
             local existingGridEntity = room:GetGridEntity(gridIndex)
             if existingGridEntity ~= nil then
@@ -220,7 +222,7 @@ function spawnGridEntityForJSONRoom(self, xmlEntityType, xmlEntityVariant, x, y)
         return nil
     end
     local gridEntityType, variant = table.unpack(gridEntityTuple)
-    local position = gridToPos(nil, x, y)
+    local position = gridCoordinatesToWorldPosition(nil, x, y)
     local gridIndex = room:GetGridIndex(position)
     local gridEntity = spawnGridEntityWithVariant(nil, gridEntityType, variant, gridIndex)
     if gridEntity == nil then
@@ -236,7 +238,7 @@ end
 function spawnNormalEntityForJSONRoom(self, entityType, variant, subType, x, y, rng)
     local room = game:GetRoom()
     local roomType = room:GetType()
-    local position = gridToPos(nil, x, y)
+    local position = gridCoordinatesToWorldPosition(nil, x, y)
     local seed = rng:Next()
     local entity
     if entityType == EntityType.ENTITY_PICKUP and variant == 100 then
@@ -253,7 +255,7 @@ function spawnNormalEntityForJSONRoom(self, entityType, variant, subType, x, y,
             entityType,
             variant,
             position,
-            Vector.Zero,
+            VectorZero,
             nil,
             subType,
             seed

package/dist/features/extraConsoleCommands/commands.lua

@@ -10,6 +10,7 @@ local sfxManager = ____cachedClasses.sfxManager
 local ____constants = require("constants")
 local PILL_GIANT_FLAG = ____constants.PILL_GIANT_FLAG
 local TRINKET_GOLDEN_FLAG = ____constants.TRINKET_GOLDEN_FLAG
+local VectorZero = ____constants.VectorZero
 local ____HealthType = require("enums.HealthType")
 local HealthType = ____HealthType.HealthType
 local ____cards = require("functions.cards")
@@ -42,7 +43,7 @@ local ____roomData = require("functions.roomData")
 local getRoomData = ____roomData.getRoomData
 local getRoomDescriptor = ____roomData.getRoomDescriptor
 local ____roomGrid = require("functions.roomGrid")
-local gridToPos = ____roomGrid.gridToPos
+local gridCoordinatesToWorldPosition = ____roomGrid.gridCoordinatesToWorldPosition
 local ____rooms = require("functions.rooms")
 local changeRoom = ____rooms.changeRoom
 local getRoomGridIndexesForType = ____rooms.getRoomGridIndexesForType
@@ -374,13 +375,13 @@ function ____exports.cards(self)
                     if cardType == Card.NUM_CARDS then
                         return
                     end
-                    local position = gridToPos(nil, x, y)
+                    local position = gridCoordinatesToWorldPosition(nil, x, y)
                     Isaac.Spawn(
                         EntityType.ENTITY_PICKUP,
                         300,
                         cardType,
                         position,
-                        Vector.Zero,
+                        VectorZero,
                         nil
                     )
                     cardType = cardType + 1
@@ -656,13 +657,13 @@ function ____exports.pills(self)
                     end
                     local horsePillColor = pillColor + PILL_GIANT_FLAG
                     local subType = horse and horsePillColor or pillColor
-                    local position = gridToPos(nil, x, y)
+                    local position = gridCoordinatesToWorldPosition(nil, x, y)
                     Isaac.Spawn(
                         EntityType.ENTITY_PICKUP,
                         70,
                         subType,
                         position,
-                        Vector.Zero,
+                        VectorZero,
                         nil
                     )
                     pillColor = pillColor + 1
@@ -885,7 +886,7 @@ function ____exports.spawnGoldenTrinket(self, params)
         350,
         goldenTrinketType,
         centerPos,
-        Vector.Zero,
+        VectorZero,
         nil
     )
 end

package/dist/features/playerInventory.d.ts

@@ -16,5 +16,8 @@ export declare function getPlayerInventory(player: EntityPlayer, includeActiveCo
  * Helper function to add a collectible to a player. Use this instead of the
  * `EntityPlayer.AddCollectible` method if you want the collectible that is added to be
  * automatically tracked by the player inventory tracker feature.
+ *
+ * You only need to use this function if you are using the inventory feature from the standard
+ * library.
  */
 export declare function addCollectible(player: EntityPlayer, collectibleType: CollectibleType, charge?: int, firstTimePickingUp?: boolean, activeSlot?: ActiveSlot, varData?: int): void;

package/dist/functions/benchmark.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="isaac-typescript-definitions" />
+/**
+ * Helper function to benchmark the performance of a function.
+ *
+ * This function is variadic, which means that you can supply as many as you want to benchmark.
+ *
+ * @returns An array containing the average time in milliseconds for each function. (This will also
+ * be printed to the log.)
+ */
+export declare function benchmark(numTrials: int, ...functions: Array<() => void>): int[];

package/dist/functions/benchmark.lua

@@ -0,0 +1,33 @@
+local ____lualib = require("lualib_bundle")
+local __TS__ArrayPush = ____lualib.__TS__ArrayPush
+local __TS__ArrayForEach = ____lualib.__TS__ArrayForEach
+local ____exports = {}
+local ____log = require("functions.log")
+local log = ____log.log
+function ____exports.benchmark(self, numTrials, ...)
+    local functions = {...}
+    log(((("Benchmarking " .. tostring(#functions)) .. " function(s) with ") .. tostring(numTrials)) .. " trials.")
+    local averages = {}
+    __TS__ArrayForEach(
+        functions,
+        function(____, func, i)
+            local totalTimeMilliseconds = 0
+            do
+                local j = 0
+                while j < numTrials do
+                    local startTimeMilliseconds = Isaac.GetTime()
+                    func(nil)
+                    local endTimeMilliseconds = Isaac.GetTime()
+                    local elapsedTimeMilliseconds = endTimeMilliseconds - startTimeMilliseconds
+                    totalTimeMilliseconds = totalTimeMilliseconds + elapsedTimeMilliseconds
+                    j = j + 1
+                end
+            end
+            local averageTimeMilliseconds = totalTimeMilliseconds / numTrials
+            log(((("The average time of function " .. tostring(i)) .. " is: ") .. tostring(averageTimeMilliseconds)) .. " milliseconds")
+            __TS__ArrayPush(averages, averageTimeMilliseconds)
+        end
+    )
+    return averages
+end
+return ____exports

package/dist/functions/chargeBar.lua

@@ -1,6 +1,8 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____exports = {}
 local getChargeBarClamp
+local ____constants = require("constants")
+local VectorZero = ____constants.VectorZero
 function getChargeBarClamp(self, charges, maxCharges)
     local meterMultiplier = 24 / maxCharges
     local meterClip = 26 - charges * meterMultiplier
@@ -32,11 +34,11 @@ function ____exports.newChargeBarSprites(self, maxCharges)
     }
 end
 function ____exports.renderChargeBar(self, sprites, position, normalCharges, batteryCharges)
-    sprites.back:Render(position, Vector.Zero, Vector.Zero)
+    sprites.back:Render(position, VectorZero, VectorZero)
     local normalChargesClamp = getChargeBarClamp(nil, normalCharges, sprites.maxCharges)
-    sprites.meter:Render(position, normalChargesClamp, Vector.Zero)
+    sprites.meter:Render(position, normalChargesClamp, VectorZero)
     local batteryChargesClamp = getChargeBarClamp(nil, batteryCharges, sprites.maxCharges)
-    sprites.meterBattery:Render(position, batteryChargesClamp, Vector.Zero)
-    sprites.lines:Render(position, Vector.Zero, Vector.Zero)
+    sprites.meterBattery:Render(position, batteryChargesClamp, VectorZero)
+    sprites.lines:Render(position, VectorZero, VectorZero)
 end
 return ____exports

package/dist/functions/familiars.lua

@@ -4,6 +4,8 @@ local __TS__ArrayPush = ____lualib.__TS__ArrayPush
 local ____exports = {}
 local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
+local ____constants = require("constants")
+local VectorZero = ____constants.VectorZero
 local ____familiarsThatShootPlayerTearsSet = require("sets.familiarsThatShootPlayerTearsSet")
 local FAMILIARS_THAT_SHOOT_PLAYER_TEARS_SET = ____familiarsThatShootPlayerTearsSet.FAMILIARS_THAT_SHOOT_PLAYER_TEARS_SET
 local ____array = require("functions.array")
@@ -59,7 +61,7 @@ function ____exports.checkFamiliar(self, player, collectibleType, numTargetFamil
                 EntityType.ENTITY_FAMILIAR,
                 familiarVariant,
                 player.Position,
-                Vector.Zero,
+                VectorZero,
                 player,
                 familiarSubTypeToUse,
                 seed

package/dist/functions/gridEntity.lua

@@ -29,7 +29,7 @@ function getAllGridEntities(self)
     local room = game:GetRoom()
     local gridSize = room:GetGridSize()
     local gridEntities = {}
-    for ____, gridIndex in ipairs(range(nil, 0, gridSize - 1)) do
+    for ____, gridIndex in ipairs(range(nil, gridSize - 1)) do
         local gridEntity = room:GetGridEntity(gridIndex)
         if gridEntity ~= nil then
             __TS__ArrayPush(gridEntities, gridEntity)

package/dist/functions/input.lua

@@ -84,14 +84,14 @@ function ____exports.getShootActions(self)
     return copySet(nil, SHOOTING_ACTIONS_SET)
 end
 function ____exports.isActionPressedOnAnyInput(self, buttonAction)
-    local validInputs = range(nil, 0, MAX_NUM_INPUTS - 1)
+    local validInputs = range(nil, MAX_NUM_INPUTS - 1)
     return __TS__ArraySome(
         validInputs,
         function(____, input) return Input.IsActionPressed(buttonAction, input) end
     )
 end
 function ____exports.isActionTriggeredOnAnyInput(self, buttonAction)
-    local validInputs = range(nil, 0, MAX_NUM_INPUTS - 1)
+    local validInputs = range(nil, MAX_NUM_INPUTS - 1)
     return __TS__ArraySome(
         validInputs,
         function(____, input) return Input.IsActionTriggered(buttonAction, input) end

package/dist/functions/log.d.ts

@@ -64,7 +64,7 @@ export declare function logUseFlags(this: void, flags: int): void;
  * the Isaac API).
  */
 export declare function logUserdata(this: void, userdata: unknown): void;
-export declare function logVector(this: void, vector: Vector): void;
+export declare function logVector(this: void, vector: Vector, round?: boolean): void;
 /**
  * Converts every `isaacscript-common` function that begins with "log" to a global function.
  * This is useful for printing out variables from the in-game debug console.

package/dist/functions/log.lua

@@ -39,6 +39,8 @@ local ____trinkets = require("functions.trinkets")
 local getTrinketName = ____trinkets.getTrinketName
 local ____utils = require("functions.utils")
 local printConsole = ____utils.printConsole
+local ____vector = require("functions.vector")
+local vectorToString = ____vector.vectorToString
 function ____exports.getDebugPrependString(self, msg, numParentFunctions)
     if numParentFunctions == nil then
         numParentFunctions = 3
@@ -380,7 +382,7 @@ function ____exports.logSet(set)
     ____exports.log("The size of the set was: " .. tostring(set.size))
 end
 function ____exports.logSounds()
-    for ____, soundEffect in ipairs(range(nil, 0, SoundEffect.NUM_SOUND_EFFECTS - 1)) do
+    for ____, soundEffect in ipairs(range(nil, SoundEffect.NUM_SOUND_EFFECTS - 1)) do
         if sfxManager:IsPlaying(soundEffect) then
             ____exports.log("Currently playing sound effect: " .. tostring(soundEffect))
         end
@@ -442,8 +444,12 @@ function ____exports.logUserdata(userdata)
     end
     ____exports.logTable(metatable)
 end
-function ____exports.logVector(vector)
-    ____exports.log(((("Vector: (" .. tostring(vector.X)) .. ", ") .. tostring(vector.Y)) .. ")")
+function ____exports.logVector(vector, round)
+    if round == nil then
+        round = false
+    end
+    local vectorString = vectorToString(nil, vector, round)
+    ____exports.log("Vector: " .. vectorString)
 end
 function ____exports.setLogFunctionsGlobal(self)
     local globals = _G

package/dist/functions/math.d.ts

@@ -15,8 +15,10 @@ export declare function getAngleDifference(angle1: float, angle2: float): float;
  */
 export declare function getCircleDiscretizedPoints(centerPos: Vector, radius: float, numPoints: int, xMultiplier?: number, yMultiplier?: number, initialDirection?: Direction): Vector[];
 /**
- * Helper function to check if a given position is within a given rectangle. This is an inclusive
- * check, meaning that it will return true if the position is on the border of the rectangle.
+ * Helper function to check if a given position is within a given rectangle.
+ *
+ * This is an inclusive check, meaning that it will return true if the position is on the border of
+ * the rectangle.
  */
 export declare function inRectangle(position: Vector, topLeft: Vector, bottomRight: Vector): boolean;
 /**
@@ -27,8 +29,12 @@ export declare function isEven(num: int): boolean;
 export declare function isOdd(num: int): boolean;
 export declare function lerp(a: number, b: number, pos: float): number;
 export declare function lerpAngleDegrees(aStart: number, aEnd: number, percent: float): number;
-/** Helper function to return an array with the elements from start to end, inclusive. */
-export declare function range(start: int, end: int): int[];
+/**
+ * Helper function to return an array with the elements from start to end, inclusive.
+ *
+ * If only one argument is specified, then it will assume that the start is 0.
+ */
+export declare function range(start: int, end?: int): int[];
 /**
  * If rounding fails, this function returns 0.
  * From: http://lua-users.org/wiki/SimpleRound

package/dist/functions/math.lua

@@ -39,7 +39,7 @@ function ____exports.getCircleDiscretizedPoints(self, centerPos, radius, numPoin
     return positions
 end
 function ____exports.inRectangle(self, position, topLeft, bottomRight)
-    return position.X >= topLeft.X and position.X <= bottomRight.X and position.Y <= topLeft.Y and position.Y >= bottomRight.Y
+    return position.X >= topLeft.X and position.X <= bottomRight.X and position.Y >= topLeft.Y and position.Y <= bottomRight.Y
 end
 function ____exports.isCircleIntersectingRectangle(self, circleCenter, circleRadius, rectangleTopLeft, rectangleBottomRight)
     local nearestX = math.max(
@@ -67,6 +67,10 @@ function ____exports.lerpAngleDegrees(self, aStart, aEnd, percent)
     return aStart + ____exports.getAngleDifference(nil, aStart, aEnd) * percent
 end
 function ____exports.range(self, start, ____end)
+    if ____end == nil then
+        ____end = start
+        start = 0
+    end
     local array = {}
     do
         local i = start

package/dist/functions/pocketItems.lua

@@ -20,7 +20,7 @@ function ____exports.getPocketItems(self, player)
     local pocketItems = {}
     local pocketItemIdentified = false
     local pocketItem2Identified = false
-    for ____, slot in ipairs(range(nil, 0, MAX_PLAYER_POCKET_ITEM_SLOTS - 1)) do
+    for ____, slot in ipairs(range(nil, MAX_PLAYER_POCKET_ITEM_SLOTS - 1)) do
         local card = player:GetCard(slot)
         local pillColor = player:GetPill(slot)
         if card ~= Card.CARD_NULL then

package/dist/functions/roomData.d.ts

@@ -3,7 +3,7 @@
  * Alias for the `Level.GetCurrentRoomDesc` method. Use this to make it more clear what type of
  * `RoomDescriptor` object that you are retrieving.
  */
-export declare function getCurrentRoomDescriptorReadOnly(): RoomDescriptorReadOnly;
+export declare function getCurrentRoomDescriptorReadOnly(): ReadonlyRoomDescriptor;
 /**
  * Helper function to get the set of allowed door slots for the room at the supplied grid index.
  * This corresponds to the doors that are enabled in the STB/XML file for the room.

package/dist/functions/roomGrid.d.ts

@@ -1,20 +1,40 @@
 /// <reference types="isaac-typescript-definitions" />
 /**
- * Helper function to convert a room X and Y coordinate to a position.
+ * Helper function to convert grid coordinates to a world position `Vector`.
  *
- * For example, the coordinates of 0, 0 are equal to `Vector(80, 160)`.
+ * For example, the coordinates of (0, 0) are equal to `Vector(80, 160)`.
+ */
+export declare function gridCoordinatesToWorldPosition(x: int, y: int): Vector;
+/**
+ * Helper function to convert a grid index to a grid position.
  *
- * This function will crash the game if it is called in the menu, because it needs to access the
- * current room's grid width.
+ * For example, in a 1x1 room, grid index 0 is equal to "Vector(-1, -1) and grid index 16 is equal
+ * to "Vector(0, 0)".
  */
-export declare function gridToPos(x: int, y: int): Vector;
-/** Helper function to convert a grid position `Vector` to a world position `Vector`. */
-export declare function gridToWorldPos(gridPos: Vector): Vector;
-/** Helper function to convert a world position `Vector` to a grid position `Vector`. */
-export declare function worldToGridPos(worldPos: Vector): Vector;
+export declare function gridIndexToGridPosition(gridIndex: int, roomShape: RoomShape): Vector;
+/**
+ * Helper function to convert a grid position `Vector` to a world position `Vector`.
+ *
+ * For example, the coordinates of (0, 0) are equal to `Vector(80, 160)`.
+ */
+export declare function gridPositionToWorldPosition(gridPosition: Vector): Vector;
+/**
+ * Test if a grid position is actually in the given `RoomShape`
+ *
+ * In this context, the grid position of the top-left wall is "Vector(-1, -1)".
+ */
+export declare function isValidGridPosition(gridPosition: Vector, roomShape: RoomShape): boolean;
+/**
+ * Helper function to convert a world position `Vector` to a grid position `Vector`.
+ *
+ * In this context, the grid position of the top-left wall is "Vector(-1, -1)".
+ */
+export declare function worldPositionToGridPosition(worldPos: Vector): Vector;
 /**
  * Helper function to convert a world position `Vector` to a grid position `Vector`.
  *
- * This is similar to the `worldToGridPos` position, but the values are not rounded.
+ * In this context, the grid position of the top-left wall is "Vector(-1, -1)".
+ *
+ * This is similar to the `worldPositionToGridPosition` function, but the values are not rounded.
  */
-export declare function worldToGridPosFast(worldPos: Vector): Vector;
+export declare function worldPositionToGridPositionFast(worldPos: Vector): Vector;

package/dist/functions/roomGrid.lua

@@ -1,26 +1,58 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____exports = {}
-local ____cachedClasses = require("cachedClasses")
-local game = ____cachedClasses.game
-function ____exports.gridToPos(self, x, y)
-    local room = game:GetRoom()
-    local gridWidth = room:GetGridWidth()
-    x = x + 1
-    y = y + 1
-    local gridIndex = y * gridWidth + x
-    return room:GetGridPosition(gridIndex)
-end
-function ____exports.gridToWorldPos(self, gridPos)
-    local x = (gridPos.X + 2) * 40
-    local y = (gridPos.Y + 4) * 40
+local isValidGridPositionNormal, isValidGridPositionLRoom
+local ____LRoomShapeToRectangles = require("objects.LRoomShapeToRectangles")
+local L_ROOM_SHAPE_TO_RECTANGLES = ____LRoomShapeToRectangles.L_ROOM_SHAPE_TO_RECTANGLES
+local ____math = require("functions.math")
+local inRectangle = ____math.inRectangle
+local ____roomShape = require("functions.roomShape")
+local getRoomShapeBottomRightPosition = ____roomShape.getRoomShapeBottomRightPosition
+local getRoomShapeTopLeftPosition = ____roomShape.getRoomShapeTopLeftPosition
+local getRoomShapeWidth = ____roomShape.getRoomShapeWidth
+local isLRoom = ____roomShape.isLRoom
+function ____exports.gridPositionToWorldPosition(self, gridPosition)
+    local x = (gridPosition.X + 2) * 40
+    local y = (gridPosition.Y + 4) * 40
     return Vector(x, y)
 end
-function ____exports.worldToGridPos(self, worldPos)
+function isValidGridPositionNormal(self, gridPosition, roomShape)
+    local topLeft = getRoomShapeTopLeftPosition(nil, roomShape)
+    local bottomRight = getRoomShapeBottomRightPosition(nil, roomShape)
+    return inRectangle(nil, gridPosition, topLeft, bottomRight)
+end
+function isValidGridPositionLRoom(self, gridPosition, roomShape)
+    local rectangles = L_ROOM_SHAPE_TO_RECTANGLES[roomShape]
+    if rectangles == nil then
+        return false
+    end
+    local verticalTopLeft, verticalBottomRight, horizontalTopLeft, horizontalBottomRight = table.unpack(rectangles)
+    return inRectangle(nil, gridPosition, verticalTopLeft, verticalBottomRight) and inRectangle(nil, gridPosition, horizontalTopLeft, horizontalBottomRight)
+end
+function ____exports.gridCoordinatesToWorldPosition(self, x, y)
+    local gridPosition = Vector(x, y)
+    return ____exports.gridPositionToWorldPosition(nil, gridPosition)
+end
+function ____exports.gridIndexToGridPosition(self, gridIndex, roomShape)
+    local gridWidth = getRoomShapeWidth(nil, roomShape)
+    local x = gridIndex % gridWidth - 1
+    local y = math.floor(gridIndex / gridWidth) - 1
+    return Vector(x, y)
+end
+function ____exports.isValidGridPosition(self, gridPosition, roomShape)
+    local ____isLRoom_result_0
+    if isLRoom(nil, roomShape) then
+        ____isLRoom_result_0 = isValidGridPositionLRoom(nil, gridPosition, roomShape)
+    else
+        ____isLRoom_result_0 = isValidGridPositionNormal(nil, gridPosition, roomShape)
+    end
+    return ____isLRoom_result_0
+end
+function ____exports.worldPositionToGridPosition(self, worldPos)
     local x = math.floor(worldPos.X / 40 - 2 + 0.5)
     local y = math.floor(worldPos.Y / 40 - 4 + 0.5)
     return Vector(x, y)
 end
-function ____exports.worldToGridPosFast(self, worldPos)
+function ____exports.worldPositionToGridPositionFast(self, worldPos)
     local x = worldPos.X / 40 - 2
     local y = worldPos.Y / 40 - 4
     return Vector(x, y)

package/dist/functions/roomShape.d.ts

@@ -39,3 +39,5 @@ export declare function getRoomShapeTopLeftPosition(roomShape: RoomShape): Vecto
  * (This cannot be directly calculated from the bounds since L rooms are a special case.)
  */
 export declare function getRoomShapeVolume(roomShape: RoomShape): int;
+export declare function getRoomShapeWidth(roomShape: RoomShape): int;
+export declare function isLRoom(roomShape: RoomShape): boolean;

package/dist/functions/roomShape.lua

@@ -9,10 +9,14 @@ local ____roomShapeToBottomRightPosition = require("objects.roomShapeToBottomRig
 local ROOM_SHAPE_TO_BOTTOM_RIGHT_POSITION = ____roomShapeToBottomRightPosition.ROOM_SHAPE_TO_BOTTOM_RIGHT_POSITION
 local ____roomShapeToDoorSlotsToGridIndexDelta = require("objects.roomShapeToDoorSlotsToGridIndexDelta")
 local ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA = ____roomShapeToDoorSlotsToGridIndexDelta.ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA
+local ____roomShapeToGridWidth = require("objects.roomShapeToGridWidth")
+local ROOM_SHAPE_TO_GRID_WIDTH = ____roomShapeToGridWidth.ROOM_SHAPE_TO_GRID_WIDTH
 local ____roomShapeToTopLeftPosition = require("objects.roomShapeToTopLeftPosition")
 local ROOM_SHAPE_TO_TOP_LEFT_POSITION = ____roomShapeToTopLeftPosition.ROOM_SHAPE_TO_TOP_LEFT_POSITION
 local ____roomShapeVolumes = require("objects.roomShapeVolumes")
 local ROOM_SHAPE_VOLUMES = ____roomShapeVolumes.ROOM_SHAPE_VOLUMES
+local ____LRoomShapesSet = require("sets.LRoomShapesSet")
+local L_ROOM_SHAPES_SET = ____LRoomShapesSet.L_ROOM_SHAPES_SET
 function ____exports.getGridIndexDelta(self, roomShape, doorSlot)
     local doorSlotToGridIndexMap = ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA[roomShape]
     return doorSlotToGridIndexMap:get(doorSlot)
@@ -32,4 +36,10 @@ end
 function ____exports.getRoomShapeVolume(self, roomShape)
     return ROOM_SHAPE_VOLUMES[roomShape]
 end
+function ____exports.getRoomShapeWidth(self, roomShape)
+    return ROOM_SHAPE_TO_GRID_WIDTH[roomShape]
+end
+function ____exports.isLRoom(self, roomShape)
+    return L_ROOM_SHAPES_SET:has(roomShape)
+end
 return ____exports

package/dist/functions/rooms.lua

@@ -105,7 +105,7 @@ function ____exports.getCurrentDimension(self)
     local startingRoomGridIndex = level:GetStartingRoomIndex()
     local startingRoomDescription = level:GetRoomByIdx(startingRoomGridIndex, -1)
     local startingRoomHash = GetPtrHash(startingRoomDescription)
-    for ____, dimension in ipairs(range(nil, 0, NUM_DIMENSIONS - 1)) do
+    for ____, dimension in ipairs(range(nil, NUM_DIMENSIONS - 1)) do
         local dimensionRoomDescription = level:GetRoomByIdx(startingRoomGridIndex, dimension)
         local dimensionRoomHash = GetPtrHash(dimensionRoomDescription)
         if dimensionRoomHash == startingRoomHash then

package/dist/functions/spawnCollectible.lua

@@ -2,6 +2,8 @@
 local ____exports = {}
 local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
+local ____constants = require("constants")
+local VectorZero = ____constants.VectorZero
 local ____preventCollectibleRotate = require("features.preventCollectibleRotate")
 local preventCollectibleRotate = ____preventCollectibleRotate.preventCollectibleRotate
 local ____featuresInitialized = require("featuresInitialized")
@@ -29,7 +31,7 @@ function ____exports.spawnCollectible(self, collectibleType, position, seedOrRNG
         EntityType.ENTITY_PICKUP,
         100,
         position,
-        Vector.Zero,
+        VectorZero,
         nil,
         collectibleType,
         seed

package/dist/functions/sprite.lua

@@ -2,20 +2,21 @@
 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 ____math = require("functions.math")
 local range = ____math.range
 function ____exports.texelEquals(self, sprite1, sprite2, position, layerID)
-    local kColor1 = sprite1:GetTexel(position, Vector.Zero, 1, layerID)
-    local kColor2 = sprite2:GetTexel(position, Vector.Zero, 1, 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 = range(nil, 0, numLayers - 1)
+        layerIDs = range(nil, numLayers - 1)
     end
     for ____, layerID in ipairs(layerIDs) do
         sprite:ReplaceSpritesheet(layerID, EMPTY_PNG_PATH)

package/dist/functions/ui.lua

@@ -4,13 +4,16 @@ 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
 function ____exports.getHUDOffsetVector(self)
-    local defaultVector = Vector.Zero
+    local defaultVector = copyVector(nil, VectorZero)
     local hudOffset = math.floor(Options.HUDOffset * 10)
     if hudOffset < 1 or hudOffset > 10 then
         return defaultVector
@@ -70,7 +73,7 @@ function ____exports.getScreenCenterPos(self)
     return bottomRight / 2
 end
 function ____exports.getScreenTopLeftPos(self)
-    return Vector.Zero
+    return copyVector(nil, VectorZero)
 end
 function ____exports.getScreenTopRightPos(self)
     local bottomRight = ____exports.getScreenBottomRightPos(nil)

package/dist/functions/vector.d.ts

@@ -19,16 +19,6 @@ interface CopyVectorReturn {
 export declare function copyVector<V extends Vector | SerializedVector, S extends SerializationType>(vector: V, serializationType: S): CopyVectorReturn[S];
 export declare function copyVector<V extends Vector | SerializedVector>(vector: V): CopyVectorReturn[SerializationType.NONE];
 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`
- * variable because the variable can be overwritten or modified.
- */
-export declare function getOneVector(): Vector;
-/**
- * Helper function to get a new vector of length 0. Using this is safer than using the `Vector.Zero`
- * variable because the variable can be overwritten or modified.
- */
-export declare function getZeroVector(): Vector;
 /**
  * Used to determine is the given table is a serialized `Vector` object created by the save data
  * manager and/or the `deepCopy` function.
@@ -37,6 +27,9 @@ export declare function isSerializedVector(object: unknown): object is Serialize
 /** Helper function to check if something is an instantiated Vector object. */
 export declare function isVector(object: unknown): object is Vector;
 export declare function vectorEquals(vector1: Vector, vector2: Vector): boolean;
+/** Helper function to get a new vector of length N. */
+export declare function vectorN(n: int): Vector;
 /** Helper function for finding out which way a vector is pointing. */
 export declare function vectorToDirection(vector: Vector): Direction;
+export declare function vectorToString(vector: Vector, round?: boolean): string;
 export {};

package/dist/functions/vector.lua

@@ -74,12 +74,6 @@ end
 function ____exports.directionToVector(self, direction)
     return DIRECTION_TO_VECTOR[direction]
 end
-function ____exports.getOneVector(self)
-    return Vector(1, 1)
-end
-function ____exports.getZeroVector(self)
-    return Vector(0, 0)
-end
 function ____exports.isSerializedVector(self, object)
     local objectType = type(object)
     if objectType ~= "table" then
@@ -95,6 +89,9 @@ end
 function ____exports.vectorEquals(self, vector1, vector2)
     return isaacAPIClassEquals(nil, vector1, vector2, KEYS)
 end
+function ____exports.vectorN(self, n)
+    return Vector(n, n)
+end
 function ____exports.vectorToDirection(self, vector)
     local degrees = vector:GetAngleDegrees()
     if degrees > -45 and degrees < 45 then
@@ -111,4 +108,12 @@ function ____exports.vectorToDirection(self, vector)
     end
     return Direction.NO_DIRECTION
 end
+function ____exports.vectorToString(self, vector, round)
+    if round == nil then
+        round = false
+    end
+    local x = round and math.floor(vector.X + 0.5) or vector.X
+    local y = round and math.floor(vector.Y + 0.5) or vector.Y
+    return ((("(" .. tostring(x)) .. ", ") .. tostring(y)) .. ")"
+end
 return ____exports

package/dist/index.d.ts

@@ -29,6 +29,7 @@ export * from "./features/saveDataManager/exports";
 export { hasSirenStolenFamiliar, setFamiliarNoSirenSteal, } from "./features/sirenHelpers";
 export { getTaintedLazarusSubPlayer } from "./features/taintedLazarusPlayers";
 export * from "./functions/array";
+export * from "./functions/benchmark";
 export * from "./functions/bitwise";
 export * from "./functions/cacheFlag";
 export * from "./functions/cards";

package/dist/index.lua

@@ -241,6 +241,14 @@ do
         end
     end
 end
+do
+    local ____export = require("functions.benchmark")
+    for ____exportKey, ____exportValue in pairs(____export) do
+        if ____exportKey ~= "default" then
+            ____exports[____exportKey] = ____exportValue
+        end
+    end
+end
 do
     local ____export = require("functions.bitwise")
     for ____exportKey, ____exportValue in pairs(____export) do

package/dist/objects/LRoomShapeToRectangles.d.ts

@@ -0,0 +1,13 @@
+/// <reference types="isaac-typescript-definitions" />
+/**
+ * "Vector(0, 0)" corresponds to the top left tile of a room, not including the walls. (The top-left
+ * wall would be at "Vector(-1, -1)".)
+ */
+export declare const L_ROOM_SHAPE_TO_RECTANGLES: {
+    [key in RoomShape]?: [
+        verticalTopLeft: Vector,
+        verticalBottomRight: Vector,
+        horizontalTopLeft: Vector,
+        horizontalBottomRight: Vector
+    ];
+};

package/dist/objects/LRoomShapeToRectangles.lua

@@ -0,0 +1,32 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____exports = {}
+local ____constants = require("constants")
+local VectorZero = ____constants.VectorZero
+local TWO_BY_TWO_BOTTOM_RIGHT = Vector(25, 13)
+____exports.L_ROOM_SHAPE_TO_RECTANGLES = {
+    [RoomShape.ROOMSHAPE_LTL] = {
+        Vector(13, 0),
+        Vector(25, 13),
+        Vector(0, 7),
+        TWO_BY_TWO_BOTTOM_RIGHT
+    },
+    [RoomShape.ROOMSHAPE_LTR] = {
+        VectorZero,
+        Vector(12, 13),
+        Vector(0, 7),
+        TWO_BY_TWO_BOTTOM_RIGHT
+    },
+    [RoomShape.ROOMSHAPE_LBL] = {
+        VectorZero,
+        Vector(25, 6),
+        Vector(13, 0),
+        TWO_BY_TWO_BOTTOM_RIGHT
+    },
+    [RoomShape.ROOMSHAPE_LBR] = {
+        VectorZero,
+        Vector(25, 6),
+        VectorZero,
+        Vector(12, 13)
+    }
+}
+return ____exports

package/dist/objects/directionToVector.lua

@@ -1,7 +1,9 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____exports = {}
+local ____constants = require("constants")
+local VectorZero = ____constants.VectorZero
 ____exports.DIRECTION_TO_VECTOR = {
-    [Direction.NO_DIRECTION] = Vector.Zero,
+    [Direction.NO_DIRECTION] = VectorZero,
     [Direction.LEFT] = Vector(-1, 0),
     [Direction.UP] = Vector(0, -1),
     [Direction.RIGHT] = Vector(1, 0),

package/dist/objects/roomShapeBounds.lua

@@ -1,5 +1,7 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____exports = {}
+local ____constants = require("constants")
+local VectorZero = ____constants.VectorZero
 local ____roomShapeVolumes = require("objects.roomShapeVolumes")
 local NARROW_CONTENTS_HEIGHT = ____roomShapeVolumes.NARROW_CONTENTS_HEIGHT
 local NARROW_CONTENTS_WIDTH = ____roomShapeVolumes.NARROW_CONTENTS_WIDTH
@@ -19,6 +21,6 @@ ____exports.ROOM_SHAPE_BOUNDS = {
     [RoomShape.ROOMSHAPE_LTR] = TWO_BY_TWO_BOUNDS,
     [RoomShape.ROOMSHAPE_LBL] = TWO_BY_TWO_BOUNDS,
     [RoomShape.ROOMSHAPE_LBR] = TWO_BY_TWO_BOUNDS,
-    [RoomShape.NUM_ROOMSHAPES] = Vector.Zero
+    [RoomShape.NUM_ROOMSHAPES] = VectorZero
 }
 return ____exports

package/dist/objects/roomShapeToBottomRightPosition.lua

@@ -1,5 +1,7 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____exports = {}
+local ____constants = require("constants")
+local VectorZero = ____constants.VectorZero
 local TWO_BY_TWO_BOTTOM_RIGHT_POSITION = Vector(25, 13)
 local ONE_BY_TWO_VERTICAL_BOTTOM_RIGHT_POSITION = Vector(12, 13)
 ____exports.ROOM_SHAPE_TO_BOTTOM_RIGHT_POSITION = {
@@ -15,6 +17,6 @@ ____exports.ROOM_SHAPE_TO_BOTTOM_RIGHT_POSITION = {
     [RoomShape.ROOMSHAPE_LTR] = TWO_BY_TWO_BOTTOM_RIGHT_POSITION,
     [RoomShape.ROOMSHAPE_LBL] = TWO_BY_TWO_BOTTOM_RIGHT_POSITION,
     [RoomShape.ROOMSHAPE_LBR] = ONE_BY_TWO_VERTICAL_BOTTOM_RIGHT_POSITION,
-    [RoomShape.NUM_ROOMSHAPES] = Vector.Zero
+    [RoomShape.NUM_ROOMSHAPES] = VectorZero
 }
 return ____exports

package/dist/objects/roomShapeToGridWidth.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="isaac-typescript-definitions" />
+export declare const ROOM_SHAPE_TO_GRID_WIDTH: {
+    readonly [key in RoomShape]: int;
+};

package/dist/objects/roomShapeToGridWidth.lua

@@ -0,0 +1,20 @@
+--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+local ____exports = {}
+local ONE_BY_ONE_WIDTH = 15
+local TWO_BY_ONE_WIDTH = 28
+____exports.ROOM_SHAPE_TO_GRID_WIDTH = {
+    [RoomShape.ROOMSHAPE_1x1] = ONE_BY_ONE_WIDTH,
+    [RoomShape.ROOMSHAPE_IH] = ONE_BY_ONE_WIDTH,
+    [RoomShape.ROOMSHAPE_IV] = ONE_BY_ONE_WIDTH,
+    [RoomShape.ROOMSHAPE_1x2] = ONE_BY_ONE_WIDTH,
+    [RoomShape.ROOMSHAPE_IIV] = ONE_BY_ONE_WIDTH,
+    [RoomShape.ROOMSHAPE_2x1] = TWO_BY_ONE_WIDTH,
+    [RoomShape.ROOMSHAPE_IIH] = TWO_BY_ONE_WIDTH,
+    [RoomShape.ROOMSHAPE_2x2] = TWO_BY_ONE_WIDTH,
+    [RoomShape.ROOMSHAPE_LTL] = TWO_BY_ONE_WIDTH,
+    [RoomShape.ROOMSHAPE_LTR] = TWO_BY_ONE_WIDTH,
+    [RoomShape.ROOMSHAPE_LBL] = TWO_BY_ONE_WIDTH,
+    [RoomShape.ROOMSHAPE_LBR] = TWO_BY_ONE_WIDTH,
+    [RoomShape.NUM_ROOMSHAPES] = 0
+}
+return ____exports

package/dist/objects/roomShapeToTopLeftPosition.lua

@@ -1,20 +1,22 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
 local ____exports = {}
+local ____constants = require("constants")
+local VectorZero = ____constants.VectorZero
 local NARROW_HORIZONTAL_TOP_LEFT_POSITION = Vector(0, 2)
 local NARROW_VERTICAL_TOP_LEFT_POSITION = Vector(4, 0)
 ____exports.ROOM_SHAPE_TO_TOP_LEFT_POSITION = {
-    [RoomShape.ROOMSHAPE_1x1] = Vector.Zero,
+    [RoomShape.ROOMSHAPE_1x1] = VectorZero,
     [RoomShape.ROOMSHAPE_IH] = NARROW_HORIZONTAL_TOP_LEFT_POSITION,
     [RoomShape.ROOMSHAPE_IV] = NARROW_VERTICAL_TOP_LEFT_POSITION,
-    [RoomShape.ROOMSHAPE_1x2] = Vector.Zero,
+    [RoomShape.ROOMSHAPE_1x2] = VectorZero,
     [RoomShape.ROOMSHAPE_IIV] = NARROW_VERTICAL_TOP_LEFT_POSITION,
-    [RoomShape.ROOMSHAPE_2x1] = Vector.Zero,
+    [RoomShape.ROOMSHAPE_2x1] = VectorZero,
     [RoomShape.ROOMSHAPE_IIH] = NARROW_HORIZONTAL_TOP_LEFT_POSITION,
-    [RoomShape.ROOMSHAPE_2x2] = Vector.Zero,
+    [RoomShape.ROOMSHAPE_2x2] = VectorZero,
     [RoomShape.ROOMSHAPE_LTL] = Vector(13, 0),
-    [RoomShape.ROOMSHAPE_LTR] = Vector.Zero,
-    [RoomShape.ROOMSHAPE_LBL] = Vector.Zero,
-    [RoomShape.ROOMSHAPE_LBR] = Vector.Zero,
-    [RoomShape.NUM_ROOMSHAPES] = Vector.Zero
+    [RoomShape.ROOMSHAPE_LTR] = VectorZero,
+    [RoomShape.ROOMSHAPE_LBL] = VectorZero,
+    [RoomShape.ROOMSHAPE_LBR] = VectorZero,
+    [RoomShape.NUM_ROOMSHAPES] = VectorZero
 }
 return ____exports

package/dist/sets/LRoomShapesSet.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="isaac-typescript-definitions" />
+export declare const L_ROOM_SHAPES_SET: ReadonlySet<RoomShape>;

package/dist/sets/LRoomShapesSet.lua

@@ -0,0 +1,6 @@
+local ____lualib = require("lualib_bundle")
+local Set = ____lualib.Set
+local __TS__New = ____lualib.__TS__New
+local ____exports = {}
+____exports.L_ROOM_SHAPES_SET = __TS__New(Set, {RoomShape.ROOMSHAPE_LTL, RoomShape.ROOMSHAPE_LTR, RoomShape.ROOMSHAPE_LBL, RoomShape.ROOMSHAPE_LBR})
+return ____exports

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "1.2.230",
+  "version": "1.2.233",
   "description": "Helper functions for IsaacScript mods",
   "keywords": [
     "isaac",
@@ -25,7 +25,7 @@
     "dist/**/*.d.ts"
   ],
   "devDependencies": {
-    "isaac-typescript-definitions": "^1.0.385",
+    "isaac-typescript-definitions": "^1.0.386",
     "isaacscript-lint": "^1.0.95",
     "isaacscript-tsconfig": "^1.1.8",
     "typedoc": "^0.22.13",