isaacscript-common 2.3.1 → 3.1.0

package/functions/utils.lua

@@ -1,13 +1,54 @@
 local ____lualib = require("lualib_bundle")
 local __TS__StringReplace = ____lualib.__TS__StringReplace
 local __TS__StringSubstr = ____lualib.__TS__StringSubstr
+local __TS__TypeOf = ____lualib.__TS__TypeOf
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local RenderMode = ____isaac_2Dtypescript_2Ddefinitions.RenderMode
 local ____cachedClasses = require("cachedClasses")
 local game = ____cachedClasses.game
 local HEX_STRING_LENGTH = 6
+--- Helper function to get type safety on a switch statement.
+-- 
+-- Very useful to be future-safe against people adding values to a type or an enum.
+-- 
+-- For example:
+-- 
+-- ```ts
+-- enum Situation {
+--   ONE,
+--   TWO,
+--   THREE,
+--   // FOUR, // If we uncomment this line, the program will no longer compile
+-- }
+-- 
+-- function handleSituation(situation: Situation) {
+--   switch (situation) {
+--     case Situation.ONE: {
+--       return 41;
+--     }
+-- 
+--     case Situation.TWO: {
+--       return 68;
+--     }
+-- 
+--     case Situation.THREE: {
+--       return 12;
+--     }
+-- 
+--     default: {
+--       return ensureAllCases(situation);
+--     }
+--   }
+-- }
+-- ```
 ____exports.ensureAllCases = function(____, obj) return obj end
+--- Helper function to return an array with the elements from start to end. It is inclusive at the
+-- start and exclusive at the end. (The "e" stands for exclusive.)
+-- 
+-- For example, `erange(1, 3)` will return `[1, 2]`.
+-- 
+-- If only one argument is specified, then it will assume that the start is 0.
 function ____exports.erange(self, start, ____end)
     if ____end == nil then
         ____end = start
@@ -23,6 +64,8 @@ function ____exports.erange(self, start, ____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 .. " --> "
@@ -30,6 +73,9 @@ function ____exports.getTraversalDescription(self, key, traversalDescription)
     traversalDescription = traversalDescription .. tostring(key)
     return traversalDescription
 end
+--- Converts a hex string like "#33aa33" to a KColor object.
+-- 
+-- @param hexString A hex string like "#ffffff" or "ffffff". (The "#" character is optional.)
 function ____exports.hexToKColor(self, hexString, alpha)
     hexString = __TS__StringReplace(hexString, "#", "")
     if #hexString ~= HEX_STRING_LENGTH then
@@ -53,6 +99,12 @@ function ____exports.hexToKColor(self, hexString, alpha)
     local base = 255
     return KColor(R / base, G / base, B / base, alpha)
 end
+--- Helper function to return an array with the elements from start to end, inclusive. (The "i"
+-- stands for inclusive.)
+-- 
+-- For example, `irange(1, 3)` will return `[1, 2, 3]`.
+-- 
+-- If only one argument is specified, then it will assume that the start is 0.
 function ____exports.irange(self, start, ____end)
     if ____end == nil then
         ____end = start
@@ -68,18 +120,46 @@ function ____exports.irange(self, start, ____end)
     end
     return array
 end
+function ____exports.isPrimitive(self, variable)
+    local ____type = __TS__TypeOf(variable)
+    return ____type == "boolean" or ____type == "number" or ____type == "string"
+end
+--- Since this is a UI element, we do not want to draw it in water reflections. `renderOffset` will
+-- be a non-zero value in reflections.
 function ____exports.isReflectionRender(self)
     local room = game:GetRoom()
     local renderMode = room:GetRenderMode()
     return renderMode == RenderMode.WATER_REFLECT
 end
+--- Helper function to print something to the in-game console. Use this instead of invoking the
+-- `Isaac.ConsoleOutput` method directly because it will automatically insert a newline at the end
+-- of the message (which `Isaac.ConsoleOutput` does not do by default).
 function ____exports.printConsole(self, msg)
     Isaac.ConsoleOutput(msg .. "\n")
 end
+--- Helper function to print whether something was enabled or disabled to the in-game console.
 function ____exports.printEnabled(self, enabled, description)
     local enabledText = enabled and "Enabled" or "Disabled"
     ____exports.printConsole(nil, ((enabledText .. " ") .. description) .. ".")
 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, n, func)
     do
         local i = 0
@@ -89,6 +169,34 @@ ____exports["repeat"] = function(self, n, func)
         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
+-- early returns.
+-- 
+-- When you see this function, it simply means that the programmer intends to add in more code to
+-- this spot later.
+-- 
+-- This function does not actually do anything. (It is an "empty" function.)
 function ____exports.todo(self)
 end
+--- Helper function to sort a two-dimensional array by the first element.
+-- 
+-- For example:
+-- 
+-- ```ts
+-- const myArray = [[1, 2], [2, 3], [3, 4]];
+-- myArray.sort(twoDimensionalSort);
+-- ```
+-- 
+-- From:
+-- https://stackoverflow.com/questions/16096872/how-to-sort-2-dimensional-array-by-column-value
+function ____exports.twoDimensionalSort(self, a, b)
+    if a[1] == nil or b[1] == nil then
+        error("Failed to two-dimensional sort since the first element of the array was undefined.")
+    end
+    if a[1] == b[1] then
+        return 0
+    end
+    return a[1] < b[1] and -1 or 1
+end
 return ____exports

package/functions/vector.lua

@@ -1,11 +1,11 @@
 local ____exports = {}
 local OBJECT_NAME
-local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
-local Direction = ____isaac_2Dtypescript_2Ddefinitions.Direction
 local ____SerializationBrand = require("enums.private.SerializationBrand")
 local SerializationBrand = ____SerializationBrand.SerializationBrand
 local ____SerializationType = require("enums.SerializationType")
 local SerializationType = ____SerializationType.SerializationType
+local ____direction = require("functions.direction")
+local angleToDirection = ____direction.angleToDirection
 local ____isaacAPIClass = require("functions.isaacAPIClass")
 local isaacAPIClassEquals = ____isaacAPIClass.isaacAPIClassEquals
 local isIsaacAPIClassOfType = ____isaacAPIClass.isIsaacAPIClassOfType
@@ -15,11 +15,17 @@ local getNumbersFromTable = ____table.getNumbersFromTable
 local tableHasKeys = ____table.tableHasKeys
 local ____utils = require("functions.utils")
 local ensureAllCases = ____utils.ensureAllCases
+--- Helper function to check if something is an instantiated Vector object.
 function ____exports.isVector(self, object)
     return isIsaacAPIClassOfType(nil, object, OBJECT_NAME)
 end
 local KEYS = {"X", "Y"}
 OBJECT_NAME = "Vector"
+--- Helper function to copy a `Vector` object.
+-- 
+-- @param vector The vector to copy. In the case of deserialization, this will actually be a Lua
+-- table instead of an instantiated Vector class.
+-- @param serializationType Default is `SerializationType.NONE`.
 function ____exports.copyVector(self, vector, serializationType)
     if serializationType == nil then
         serializationType = SerializationType.NONE
@@ -76,6 +82,8 @@ function ____exports.copyVector(self, vector, serializationType)
         end
     until true
 end
+--- Used to determine is the given table is a serialized `Vector` object created by the save data
+-- manager and/or the `deepCopy` function.
 function ____exports.isSerializedVector(self, object)
     local objectType = type(object)
     if objectType ~= "table" then
@@ -91,21 +99,10 @@ end
 function ____exports.vectorEquals(self, vector1, vector2)
     return isaacAPIClassEquals(nil, vector1, vector2, KEYS)
 end
+--- Helper function for finding out which way a vector is pointing.
 function ____exports.vectorToDirection(self, vector)
-    local degrees = vector:GetAngleDegrees()
-    if degrees > -45 and degrees < 45 then
-        return Direction.RIGHT
-    end
-    if degrees >= 45 and degrees <= 135 then
-        return Direction.DOWN
-    end
-    if degrees <= -45 and degrees >= -135 then
-        return Direction.UP
-    end
-    if degrees > 135 or degrees < -135 then
-        return Direction.LEFT
-    end
-    return Direction.NO_DIRECTION
+    local angleDegrees = vector:GetAngleDegrees()
+    return angleToDirection(nil, angleDegrees)
 end
 function ____exports.vectorToString(self, vector, round)
     if round == nil then

package/index.d.ts

@@ -107,6 +107,7 @@ export * from "./functions/ui";
 export * from "./functions/utils";
 export * from "./functions/vector";
 export * from "./interfaces/AddCallbackParameterCustom";
+export * from "./interfaces/ChargeBarSprites";
 export * from "./interfaces/JSONDoor";
 export * from "./interfaces/JSONEntity";
 export * from "./interfaces/JSONRoom";

package/initCustomCallbacks.lua

@@ -89,6 +89,8 @@ local ____postRoomClearChanged = require("callbacks.postRoomClearChanged")
 local postRoomClearChangedCallbackInit = ____postRoomClearChanged.postRoomClearChangedCallbackInit
 local ____postSacrifice = require("callbacks.postSacrifice")
 local postSacrificeCallbackInit = ____postSacrifice.postSacrificeCallbackInit
+local ____postSlotDestroyed = require("callbacks.postSlotDestroyed")
+local postSlotDestroyedCallbacksInit = ____postSlotDestroyed.postSlotDestroyedCallbacksInit
 local ____postSlotInitUpdate = require("callbacks.postSlotInitUpdate")
 local postSlotInitUpdateCallbacksInit = ____postSlotInitUpdate.postSlotInitUpdateCallbacksInit
 local ____postSlotRender = require("callbacks.postSlotRender")
@@ -161,6 +163,7 @@ function ____exports.initCustomCallbacks(self, mod)
     postRockUpdateInit(nil, mod)
     postRoomClearChangedCallbackInit(nil, mod)
     postSacrificeCallbackInit(nil, mod)
+    postSlotDestroyedCallbacksInit(nil, mod)
     postSlotInitUpdateCallbacksInit(nil, mod)
     postSlotRenderCallbacksInit(nil, mod)
     postSpikesRenderInit(nil, mod)

package/interfaces/ChargeBarSprites.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="isaac-typescript-definitions" />
+/// <reference types="isaac-typescript-definitions" />
 /**
  * A collection of the four sprites necessary in order to render a charge bar.
  *

package/interfaces/private/TSTLClassMetatable.d.ts

@@ -1,4 +1,6 @@
 /// <reference types="lua-types/5.3" />
+/// <reference types="lua-types/5.3" />
+/// <reference types="lua-types/5.3" />
 /// <reference types="typescript-to-lua/language-extensions" />
 export interface TSTLClassMetatable {
     ____constructor: () => void;

package/lualib_bundle.lua

@@ -753,7 +753,7 @@ local function __TS__AsyncAwaiter(generator)
     return __TS__New(
         __TS__Promise,
         function(____, resolve, reject)
-            local adopt, fulfilled, rejected, step, asyncCoroutine
+            local adopt, fulfilled, step, resolved, asyncCoroutine
             function adopt(self, value)
                 local ____temp_0
                 if __TS__InstanceOf(value, __TS__Promise) then
@@ -764,57 +764,44 @@ local function __TS__AsyncAwaiter(generator)
                 return ____temp_0
             end
             function fulfilled(self, value)
-                local success, errorOrErrorHandler, resultOrError = coroutine.resume(asyncCoroutine, value)
+                local success, resultOrError = coroutine.resume(asyncCoroutine, value)
                 if success then
-                    step(nil, resultOrError, errorOrErrorHandler)
+                    step(nil, resultOrError)
                 else
-                    reject(nil, errorOrErrorHandler)
+                    reject(nil, resultOrError)
                 end
             end
-            function rejected(self, handler)
-                if handler then
-                    return function(____, value)
-                        local success, hasReturnedOrError, returnedValue = pcall(handler, value)
-                        if success then
-                            if hasReturnedOrError then
-                                resolve(nil, returnedValue)
-                            else
-                                step(nil, hasReturnedOrError, handler)
-                            end
-                        else
-                            reject(nil, hasReturnedOrError)
-                        end
-                    end
-                else
-                    return function(____, value)
-                        reject(nil, value)
-                    end
+            function step(self, result)
+                if resolved then
+                    return
                 end
-            end
-            function step(self, result, errorHandler)
                 if coroutine.status(asyncCoroutine) == "dead" then
                     resolve(nil, result)
                 else
                     local ____self_1 = adopt(nil, result)
-                    ____self_1["then"](
-                        ____self_1,
-                        fulfilled,
-                        rejected(nil, errorHandler)
-                    )
+                    ____self_1["then"](____self_1, fulfilled, reject)
                 end
             end
+            resolved = false
             asyncCoroutine = coroutine.create(generator)
-            local success, errorOrErrorHandler, resultOrError = coroutine.resume(asyncCoroutine)
+            local success, resultOrError = coroutine.resume(
+                asyncCoroutine,
+                function(____, v)
+                    resolved = true
+                    local ____self_2 = adopt(nil, v)
+                    ____self_2["then"](____self_2, resolve, reject)
+                end
+            )
             if success then
-                step(nil, resultOrError, errorOrErrorHandler)
+                step(nil, resultOrError)
             else
-                reject(nil, errorOrErrorHandler)
+                reject(nil, resultOrError)
             end
         end
     )
 end
-local function __TS__Await(errorHandler, thing)
-    return coroutine.yield(errorHandler, thing)
+local function __TS__Await(thing)
+    return coroutine.yield(thing)
 end
 
 local function __TS__ClassExtends(target, base)

package/maps/cardMap.lua

@@ -4,6 +4,7 @@ local __TS__New = ____lualib.__TS__New
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local Card = ____isaac_2Dtypescript_2Ddefinitions.Card
+--- Maps card names to card sub-types.
 ____exports.CARD_MAP = __TS__New(Map, {
     {"fool", Card.FOOL},
     {"magician", Card.MAGICIAN},

package/maps/characterMap.lua

@@ -2,6 +2,7 @@ local ____lualib = require("lualib_bundle")
 local Map = ____lualib.Map
 local __TS__New = ____lualib.__TS__New
 local ____exports = {}
+--- Maps character names to character sub-types.
 ____exports.CHARACTER_MAP = __TS__New(Map, {
     {"isaac", 0},
     {"magdalene", 1},

package/maps/defaultPlayerStatMap.lua

@@ -7,6 +7,7 @@ local CacheFlag = ____isaac_2Dtypescript_2Ddefinitions.CacheFlag
 local ____tears = require("functions.tears")
 local getTearsStat = ____tears.getTearsStat
 local DEFAULT_MAX_FIRE_DELAY = 10
+--- The default fire delay is represented in the tear stat, not the `MaxFireDelay` value.
 ____exports.DEFAULT_PLAYER_STAT_MAP = __TS__New(
     Map,
     {

package/maps/gridEntityXMLMap.lua

@@ -12,6 +12,8 @@ local PressurePlateVariant = ____isaac_2Dtypescript_2Ddefinitions.PressurePlateV
 local RockVariant = ____isaac_2Dtypescript_2Ddefinitions.RockVariant
 local StatueVariant = ____isaac_2Dtypescript_2Ddefinitions.StatueVariant
 local TrapdoorVariant = ____isaac_2Dtypescript_2Ddefinitions.TrapdoorVariant
+--- This maps the GridEntityXMLType (i.e. the type contained in the room XML/STB file) to the
+-- GridEntityType and the variant used by the game.
 ____exports.GRID_ENTITY_XML_MAP = __TS__New(Map, {
     {GridEntityXMLType.ROCK, {GridEntityType.ROCK, RockVariant.NORMAL}},
     {GridEntityXMLType.ROCK_BOMB, {GridEntityType.ROCK_BOMB, 0}},

package/maps/pillEffectMap.lua

@@ -4,6 +4,7 @@ local __TS__New = ____lualib.__TS__New
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local PillEffect = ____isaac_2Dtypescript_2Ddefinitions.PillEffect
+--- Maps pill effect names to the values of the `PillEffect` enum.
 ____exports.PILL_EFFECT_MAP = __TS__New(Map, {
     {"badGas", PillEffect.BAD_GAS},
     {"gas", PillEffect.BAD_GAS},

package/maps/roomShapeToTopLeftWallGridIndexMap.lua

@@ -5,6 +5,8 @@ local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local RoomShape = ____isaac_2Dtypescript_2Ddefinitions.RoomShape
 ____exports.DEFAULT_TOP_LEFT_WALL_GRID_INDEX = 0
+--- Only used for special room shapes where the top left wall grid index is not equal to
+-- `DEFAULT_TOP_LEFT_WALL_GRID_INDEX`.
 ____exports.ROOM_SHAPE_TO_TOP_LEFT_WALL_GRID_INDEX_MAP = __TS__New(Map, {
     {RoomShape.IH, 30},
     {RoomShape.IV, 4},

package/maps/roomTypeMap.lua

@@ -4,6 +4,7 @@ local __TS__New = ____lualib.__TS__New
 local ____exports = {}
 local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
 local RoomType = ____isaac_2Dtypescript_2Ddefinitions.RoomType
+--- Maps room type names to room types.
 ____exports.ROOM_TYPE_MAP = __TS__New(Map, {
     {"null", RoomType.NULL},
     {"default", RoomType.DEFAULT},

package/objects/LRoomShapeToRectangles.lua

@@ -4,6 +4,8 @@ local RoomShape = ____isaac_2Dtypescript_2Ddefinitions.RoomShape
 local ____constants = require("constants")
 local VectorZero = ____constants.VectorZero
 local TWO_BY_TWO_BOTTOM_RIGHT = Vector(25, 13)
+--- "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)".)
 ____exports.L_ROOM_SHAPE_TO_RECTANGLES = {
     [RoomShape.LTL] = {
         Vector(13, 0),

package/objects/colors.lua

@@ -1,4 +1,8 @@
 local ____exports = {}
+--- A collection of common colors that can be reused.
+-- 
+-- Note that if you want to further modify these colors, you should copy them first with the
+-- `copyColor` function.
 ____exports.COLORS = {
     Black = Color(1, 1, 1),
     Red = Color(1, 0, 0),

package/objects/oppositeDoorSlots.d.ts

@@ -0,0 +1,4 @@
+import { DoorSlot } from "isaac-typescript-definitions";
+export declare const OPPOSITE_DOOR_SLOTS: {
+    readonly [key in DoorSlot]: DoorSlot | undefined;
+};

package/objects/oppositeDoorSlots.lua

@@ -0,0 +1,15 @@
+local ____exports = {}
+local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitions")
+local DoorSlot = ____isaac_2Dtypescript_2Ddefinitions.DoorSlot
+____exports.OPPOSITE_DOOR_SLOTS = {
+    [DoorSlot.NO_DOOR_SLOT] = nil,
+    [DoorSlot.LEFT_0] = DoorSlot.RIGHT_0,
+    [DoorSlot.UP_0] = DoorSlot.DOWN_0,
+    [DoorSlot.RIGHT_0] = DoorSlot.LEFT_0,
+    [DoorSlot.LEFT_1] = DoorSlot.RIGHT_1,
+    [DoorSlot.DOWN_0] = DoorSlot.UP_0,
+    [DoorSlot.UP_1] = DoorSlot.DOWN_1,
+    [DoorSlot.RIGHT_1] = DoorSlot.LEFT_1,
+    [DoorSlot.DOWN_1] = DoorSlot.UP_1
+}
+return ____exports

package/objects/roomShapeBounds.lua

@@ -7,6 +7,8 @@ local NARROW_CONTENTS_WIDTH = ____roomShapeVolumes.NARROW_CONTENTS_WIDTH
 local ONE_BY_ONE_CONTENTS_HEIGHT = ____roomShapeVolumes.ONE_BY_ONE_CONTENTS_HEIGHT
 local ONE_BY_ONE_CONTENTS_WIDTH = ____roomShapeVolumes.ONE_BY_ONE_CONTENTS_WIDTH
 local TWO_BY_TWO_BOUNDS = Vector(ONE_BY_ONE_CONTENTS_WIDTH * 2, ONE_BY_ONE_CONTENTS_HEIGHT * 2)
+--- The size of a room shape's contents. This does not include the tiles that the walls are on. L
+-- rooms use the same bounds as a 2x2 room.
 ____exports.ROOM_SHAPE_BOUNDS = {
     [RoomShape.SHAPE_1x1] = Vector(ONE_BY_ONE_CONTENTS_WIDTH, ONE_BY_ONE_CONTENTS_HEIGHT),
     [RoomShape.IH] = Vector(ONE_BY_ONE_CONTENTS_WIDTH, NARROW_CONTENTS_HEIGHT),

package/objects/roomShapeLayoutSizes.lua

@@ -8,6 +8,10 @@ local ONE_BY_ONE_LAYOUT_SIZE = Vector(ONE_BY_ONE_CONTENTS_WIDTH, ONE_BY_ONE_CONT
 local TWO_BY_ONE_VERTICAL_LAYOUT_SIZE = Vector(ONE_BY_ONE_CONTENTS_WIDTH, ONE_BY_ONE_CONTENTS_HEIGHT * 2)
 local TWO_BY_ONE_HORIZONTAL_LAYOUT_SIZE = Vector(ONE_BY_ONE_CONTENTS_WIDTH * 2, ONE_BY_ONE_CONTENTS_HEIGHT)
 local TWO_BY_TWO_LAYOUT_SIZE = Vector(ONE_BY_ONE_CONTENTS_WIDTH * 2, ONE_BY_ONE_CONTENTS_HEIGHT * 2)
+--- The dimensions of a room shape's layout. This is NOT the size of the room's actual contents! For
+-- that, use `ROOM_SHAPE_BOUNDS`.
+-- 
+-- For example, a horizontal narrow room has a layout size of equal to that of a 1x1 room.
 ____exports.ROOM_SHAPE_LAYOUT_SIZES = {
     [RoomShape.SHAPE_1x1] = ONE_BY_ONE_LAYOUT_SIZE,
     [RoomShape.IH] = ONE_BY_ONE_LAYOUT_SIZE,

package/objects/roomShapeToBottomRightPosition.lua

@@ -3,6 +3,8 @@ local ____isaac_2Dtypescript_2Ddefinitions = require("isaac-typescript-definitio
 local RoomShape = ____isaac_2Dtypescript_2Ddefinitions.RoomShape
 local TWO_BY_TWO_BOTTOM_RIGHT_POSITION = Vector(25, 13)
 local ONE_BY_TWO_VERTICAL_BOTTOM_RIGHT_POSITION = Vector(12, 13)
+--- "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)".)
 ____exports.ROOM_SHAPE_TO_BOTTOM_RIGHT_POSITION = {
     [RoomShape.SHAPE_1x1] = Vector(12, 6),
     [RoomShape.IH] = Vector(12, 4),

package/objects/roomShapeToDoorSlotsToGridIndexDelta.lua

@@ -11,6 +11,8 @@ local LEFT = -1
 local UP = -LEVEL_GRID_ROW_WIDTH
 local RIGHT = 1
 local DOWN = LEVEL_GRID_ROW_WIDTH
+--- Deltas are considered to be from the safe grid index of the room (i.e. the top left corner, or
+-- top right corner in the case of `RoomShape.LTL`).
 ____exports.ROOM_SHAPE_TO_DOOR_SLOTS_TO_GRID_INDEX_DELTA = {
     [RoomShape.SHAPE_1x1] = __TS__New(Map, {{DoorSlot.LEFT_0, LEFT}, {DoorSlot.UP_0, UP}, {DoorSlot.RIGHT_0, RIGHT}, {DoorSlot.DOWN_0, DOWN}}),
     [RoomShape.IH] = __TS__New(Map, {{DoorSlot.LEFT_0, LEFT}, {DoorSlot.RIGHT_0, RIGHT}}),

package/objects/roomShapeToTopLeftPosition.lua

@@ -5,6 +5,8 @@ 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)
+--- "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)".)
 ____exports.ROOM_SHAPE_TO_TOP_LEFT_POSITION = {
     [RoomShape.SHAPE_1x1] = VectorZero,
     [RoomShape.IH] = NARROW_HORIZONTAL_TOP_LEFT_POSITION,

package/objects/roomShapeVolumes.lua

@@ -10,6 +10,9 @@ local NARROW_HORIZONTAL_VOLUME = ____exports.ONE_BY_ONE_CONTENTS_WIDTH * ____exp
 local NARROW_VERTICAL_VOLUME = ____exports.NARROW_CONTENTS_WIDTH * ____exports.ONE_BY_ONE_CONTENTS_HEIGHT
 local ONE_BY_TWO_VOLUME = ONE_BY_ONE_VOLUME * 2
 local L_ROOM_VOLUME = ONE_BY_ONE_VOLUME * 3
+--- Volume is the amount of tiles that are inside the room shape.
+-- 
+-- (This cannot be directly calculated from the bounds since L rooms are a special case.)
 ____exports.ROOM_SHAPE_VOLUMES = {
     [RoomShape.SHAPE_1x1] = ONE_BY_ONE_VOLUME,
     [RoomShape.IH] = NARROW_HORIZONTAL_VOLUME,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "2.3.1",
+  "version": "3.1.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",
@@ -22,6 +22,6 @@
   "main": "index",
   "types": "index.d.ts",
   "dependencies": {
-    "isaac-typescript-definitions": "^2.0.54"
+    "isaac-typescript-definitions": "^2.0.55"
   }
 }

package/patchErrorFunctions.lua

@@ -36,6 +36,14 @@ function removeLinesContaining(self, msg, containsMsg)
 end
 LINE_SEPARATOR = "\n"
 USELESS_TRACEBACK_MESSAGES = {"in upvalue 'getTraceback'", "in function 'sandbox.GetTraceback'", "in function 'error'"}
+--- In Lua, the `error` function will tell you the line number of the error, but not give you a full
+-- traceback of the parent functions, which is unlike how JavaScript works. This function monkey
+-- patches the `error` function to add this functionality.
+-- 
+-- Traceback functionality can only be added if the "--luadebug" flag is turned on, so this function
+-- does nothing if the "--luadebug" flag is disabled.
+-- 
+-- @internal
 function ____exports.patchErrorFunction(self)
     if not isLuaDebugEnabled(nil) then
         return